diff options
| author | Eric Biggers <ebiggers@google.com> | 2023-09-24 22:54:47 -0700 |
|---|---|---|
| committer | Eric Biggers <ebiggers@google.com> | 2023-09-24 23:03:09 -0700 |
| commit | 5970fbad1036d1015abe45651628b39b5bcb8a22 (patch) | |
| tree | 1a57e1fb991838e1658d7087cb9515bc6446fb52 /include/linux/fscrypt.h | |
| parent | 6465e260f48790807eef06b583b38ca9789b6072 (diff) | |
fscrypt: make it clearer that key_prefix is deprecated
fscrypt_operations::key_prefix should not be set by any filesystems that
aren't setting it already. This is already documented, but apparently
it's not sufficiently clear, as both ceph and btrfs have tried to set
it. Rename the field to legacy_key_prefix and improve the documentation
to hopefully make it clearer.
Link: https://lore.kernel.org/r/20230925055451.59499-2-ebiggers@kernel.org
Signed-off-by: Eric Biggers <ebiggers@google.com>
Diffstat (limited to 'include/linux/fscrypt.h')
| -rw-r--r-- | include/linux/fscrypt.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/include/linux/fscrypt.h b/include/linux/fscrypt.h index c895b12737a1..b0037566ce30 100644 --- a/include/linux/fscrypt.h +++ b/include/linux/fscrypt.h @@ -73,12 +73,16 @@ struct fscrypt_operations { unsigned int flags; /* - * If set, this is a filesystem-specific key description prefix that - * will be accepted for "logon" keys for v1 fscrypt policies, in - * addition to the generic prefix "fscrypt:". This functionality is - * deprecated, so new filesystems shouldn't set this field. + * This field exists only for backwards compatibility reasons and should + * only be set by the filesystems that are setting it already. It + * contains the filesystem-specific key description prefix that is + * accepted for "logon" keys for v1 fscrypt policies. This + * functionality is deprecated in favor of the generic prefix + * "fscrypt:", which itself is deprecated in favor of the filesystem + * keyring ioctls such as FS_IOC_ADD_ENCRYPTION_KEY. Filesystems that + * are newly adding fscrypt support should not set this field. */ - const char *key_prefix; + const char *legacy_key_prefix; /* * Get the fscrypt context of the given inode. |