@@ -50,7 +50,8 @@ man1_MANS = \
ndctl-monitor.1 \
ndctl-update-security.1 \
ndctl-disable-security.1 \
- ndctl-freeze-security.1
+ ndctl-freeze-security.1 \
+ ndctl-sanitize.1
CLEANFILES = $(man1_MANS)
new file mode 100644
@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: GPL-2.0
+
+ndctl-sanitize(1)
+=================
+
+NAME
+----
+ndctl-sanitize - sanitize the data on the NVDIMM
+
+SYNOPSIS
+--------
+[verse]
+'ndctl sanitize' <dimm> [<options>]
+
+OPTIONS
+-------
+<dimm>::
+include::xable-dimm-options.txt[]
+
+-m::
+--method::
+ The method for sanitizing the dimm content.
+
+ crypto-erase: replaces encryption keys. This does not change label data.
+
+DESCRIPTION
+-----------
+Provide a generic interface to crypto erase a NVDIMM.
+The use of this depends on support from the underlying
+libndctl, kernel, as well as the platform itself.
+
+include::../copyright.txt[]
@@ -51,4 +51,5 @@ int cmd_inject_smart(int argc, const char **argv, void *ctx);
int cmd_key_update(int argc, const char **argv, void *ctx);
int cmd_disable_security(int argc, const char **argv, void *ctx);
int cmd_freeze_security(int argc, const char **argv, void *ctx);
+int cmd_sanitize(int argc, const char **argv, void *ctx);
#endif /* _NDCTL_BUILTIN_H_ */
@@ -46,6 +46,7 @@ static struct parameters {
const char *infile;
const char *labelversion;
const char *key_exec;
+ const char *sanitize_method;
bool force;
bool json;
bool verbose;
@@ -903,6 +904,29 @@ static int action_security_freeze(struct ndctl_dimm *dimm,
return rc;
}
+static int action_sanitize(struct ndctl_dimm *dimm,
+ struct action_context *actx)
+{
+ int rc;
+
+ if (!param.sanitize_method) {
+ error("No sanitize_method passed in\n");
+ return -EINVAL;
+ }
+
+ if (strcmp(param.sanitize_method, "crypto-erase") == 0) {
+ rc = ndctl_dimm_secure_erase(dimm);
+ if (rc < 0)
+ error("Failed to secure erase for %s\n",
+ ndctl_dimm_get_devname(dimm));
+ } else {
+ error("Incorrect sanitize method passed in.\n");
+ return -EINVAL;
+ }
+
+ return rc;
+}
+
static int __action_init(struct ndctl_dimm *dimm,
enum ndctl_namespace_version version, int chk_only)
{
@@ -998,6 +1022,10 @@ OPT_BOOLEAN('i', "insecure", ¶m.key_insecure, \
OPT_STRING('e', "exec", ¶m.key_exec, "external-exec", \
"external exec module for passphrase update")
+#define SANITIZE_OPTIONS() \
+OPT_STRING('m', "method", ¶m.sanitize_method, "sanitize-method", \
+ "method for sanitize a dimm")
+
static const struct option read_options[] = {
BASE_OPTIONS(),
READ_OPTIONS(),
@@ -1033,6 +1061,12 @@ static const struct option key_options[] = {
OPT_END(),
};
+static const struct option sanitize_options[] = {
+ BASE_OPTIONS(),
+ SANITIZE_OPTIONS(),
+ OPT_END(),
+};
+
static int dimm_action(int argc, const char **argv, void *ctx,
int (*action)(struct ndctl_dimm *dimm, struct action_context *actx),
const struct option *options, const char *usage)
@@ -1295,3 +1329,13 @@ int cmd_freeze_security(int argc, const char **argv, void *ctx)
count > 1 ? "s" : "");
return count >= 0 ? 0 : EXIT_FAILURE;
}
+
+int cmd_sanitize(int argc, const char **argv, void *ctx)
+{
+ int count = dimm_action(argc, argv, ctx, action_sanitize, sanitize_options,
+ "ndctl sanitize <nmem0> [<nmem1>..<nmemN>] [<options>]");
+
+ fprintf(stderr, "sanitized %d nmem%s.\n", count >= 0 ? count : 0,
+ count > 1 ? "s" : "");
+ return count >= 0 ? 0 : EXIT_FAILURE;
+}
@@ -629,3 +629,8 @@ NDCTL_EXPORT int ndctl_dimm_freeze_security(struct ndctl_dimm *dimm)
{
return ndctl_dimm_write_security(dimm, "freeze");
}
+
+NDCTL_EXPORT int ndctl_dimm_secure_erase(struct ndctl_dimm *dimm)
+{
+ return ndctl_dimm_write_security(dimm, "erase");
+}
@@ -387,4 +387,5 @@ global:
ndctl_dimm_set_change_key;
ndctl_dimm_disable_security;
ndctl_dimm_freeze_security;
+ ndctl_dimm_secure_erase;
} LIBNDCTL_17;
@@ -683,6 +683,7 @@ int ndctl_dimm_add_key(struct ndctl_dimm *dimm, const char *passphrase,
int ndctl_dimm_get_current_key(struct ndctl_dimm *dimm, key_serial_t *key);
int ndctl_dimm_disable_security(struct ndctl_dimm *dimm);
int ndctl_dimm_freeze_security(struct ndctl_dimm *dimm);
+int ndctl_dimm_secure_erase(struct ndctl_dimm *dimm);
#ifdef __cplusplus
} /* extern "C" */
@@ -91,6 +91,7 @@ static struct cmd_struct commands[] = {
{ "update-security", cmd_key_update },
{ "disable-security", cmd_disable_security },
{ "freeze-security", cmd_freeze_security },
+ { "sanitize", cmd_sanitize },
{ "list", cmd_list },
{ "monitor", cmd_monitor},
{ "help", cmd_help },
Add support to secure erase to libndctl and also command line option of "sanitize" for ndctl. This will initiate the request to crypto erase a DIMM. ndctl does not actually handle the verification of the security. That is handled by the kernel and the key upcall mechanism. Signed-off-by: Dave Jiang <dave.jiang@intel.com> --- Documentation/ndctl/Makefile.am | 3 +- Documentation/ndctl/ndctl-sanitize.txt | 32 +++++++++++++++++++++++ builtin.h | 1 + ndctl/dimm.c | 44 ++++++++++++++++++++++++++++++++ ndctl/lib/dimm.c | 5 ++++ ndctl/lib/libndctl.sym | 1 + ndctl/libndctl.h | 1 + ndctl/ndctl.c | 1 + 8 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 Documentation/ndctl/ndctl-sanitize.txt