From: Eric Biggers <ebiggers@xxxxxxxxxx>
Add an 'enckey_status' command to xfs_io, to provide a command-line
interface to the FS_IOC_GET_ENCRYPTION_KEY_STATUS ioctl.
Signed-off-by: Eric Biggers <ebiggers@xxxxxxxxxx>
---
io/encrypt.c | 71 +++++++++++++++++++++++++++++++++++++++++++++++
man/man8/xfs_io.8 | 6 ++++
2 files changed, 77 insertions(+)
diff --git a/io/encrypt.c b/io/encrypt.c
index 213c9c53..19c74983 100644
--- a/io/encrypt.c
+++ b/io/encrypt.c
@@ -140,6 +140,7 @@ static cmdinfo_t get_encpolicy_cmd;
static cmdinfo_t set_encpolicy_cmd;
static cmdinfo_t add_enckey_cmd;
static cmdinfo_t rm_enckey_cmd;
+static cmdinfo_t enckey_status_cmd;
static void
get_encpolicy_help(void)
@@ -216,6 +217,19 @@ rm_enckey_help(void)
"\n"));
}
+static void
+enckey_status_help(void)
+{
+ printf(_(
+"\n"
+" get the status of a filesystem encryption key\n"
+"\n"
+" Examples:\n"
+" 'enckey_status 0000111122223333' - get status of v1 policy key\n"
+" 'enckey_status 00001111222233334444555566667777' - get status of v2 policy key\n"
+"\n"));
+}
+
static const struct {
__u8 mode;
const char *name;
@@ -757,6 +771,52 @@ rm_enckey_f(int argc, char **argv)
return 0;
}
+static int
+enckey_status_f(int argc, char **argv)
+{
+ struct fscrypt_get_key_status_arg arg;
+
+ memset(&arg, 0, sizeof(arg));
+
+ if (str2keyspec(argv[1], -1, &arg.key_spec) < 0)
+ return 0;
+
+ if (ioctl(file->fd, FS_IOC_GET_ENCRYPTION_KEY_STATUS, &arg) != 0) {
+ fprintf(stderr, "Error getting encryption key status: %s\n",
+ strerror(errno));
+ exitcode = 1;
+ return 0;
+ }
+
+ switch (arg.status) {
+ case FSCRYPT_KEY_STATUS_PRESENT:
+ printf("Present");
+ if (arg.user_count || arg.status_flags) {
+ printf(" (user_count=%u", arg.user_count);
+ if (arg.status_flags &
+ FSCRYPT_KEY_STATUS_FLAG_ADDED_BY_SELF)
+ printf(", added_by_self");
+ arg.status_flags &=
+ ~FSCRYPT_KEY_STATUS_FLAG_ADDED_BY_SELF;
+ if (arg.status_flags)
+ printf(", unknown_flags=0x%08x",
+ arg.status_flags);
+ printf(")");
+ }
+ printf("\n");
+ return 0;
+ case FSCRYPT_KEY_STATUS_ABSENT:
+ printf("Absent\n");
+ return 0;
+ case FSCRYPT_KEY_STATUS_INCOMPLETELY_REMOVED:
+ printf("Incompletely removed\n");
+ return 0;
+ default:
+ printf("Unknown status (%u)\n", arg.status);
+ return 0;
+ }
+}
+
void
encrypt_init(void)
{
@@ -800,8 +860,19 @@ encrypt_init(void)
_("remove an encryption key from the filesystem");
rm_enckey_cmd.help = rm_enckey_help;
+ enckey_status_cmd.name = "enckey_status";
+ enckey_status_cmd.cfunc = enckey_status_f;
+ enckey_status_cmd.args = _("keyspec");
+ enckey_status_cmd.argmin = 1;
+ enckey_status_cmd.argmax = 1;
+ enckey_status_cmd.flags = CMD_NOMAP_OK | CMD_FOREIGN_OK;
+ enckey_status_cmd.oneline =
+ _("get the status of a filesystem encryption key");
+ enckey_status_cmd.help = enckey_status_help;
+
add_command(&get_encpolicy_cmd);
add_command(&set_encpolicy_cmd);
add_command(&add_enckey_cmd);
add_command(&rm_enckey_cmd);
+ add_command(&enckey_status_cmd);
}
diff --git a/man/man8/xfs_io.8 b/man/man8/xfs_io.8
index a6894778..9af6e542 100644
--- a/man/man8/xfs_io.8
+++ b/man/man8/xfs_io.8
@@ -779,6 +779,12 @@ is a privileged operation.
.RE
.PD
.TP
+.BI "enckey_status " keyspec
+On filesystems that support encryption, display the status of an encryption key.
+.I keyspec
+is a hex string specifying the key for which to display the status, as a
+16-character "key descriptor" or a 32-character "key identifier".
+.TP
.BR lsattr " [ " \-R " | " \-D " | " \-a " | " \-v " ]"
List extended inode flags on the currently open file. If the
.B \-R
--
2.23.0.rc1.153.gdeed80330f-goog
