fscrypt: add ioctl to get file's encryption nonce
Subsystems (8)
Eric Biggers
maintainercover fscrypt: add ioctl to get file's encryption nonce
This patchset adds an ioctl FS_IOC_GET_ENCRYPTION_NONCE which retrieves the nonce from an encrypted file or directory.
This is useful for automated ciphertext verification testing.
See patch #1 for more details.
Eric Biggers (4):
fscrypt: add FS_IOC_GET_ENCRYPTION_NONCE ioctl
ext4: wire up FS_IOC_GET_ENCRYPTION_NONCE
f2fs: wire up FS_IOC_GET_ENCRYPTION_NONCE
ubifs: wire up FS_IOC_GET_ENCRYPTION_NONCE
Documentation/filesystems/fscrypt.rst | 11 +++++++++++ fs/crypto/fscrypt_private.h | 20 ++++++++++++++++++++ fs/crypto/keysetup.c | 16 ++-------------- fs/crypto/policy.c | 21 ++++++++++++++++++++- fs/ext4/ioctl.c | 6 ++++++ fs/f2fs/file.c | 11 +++++++++++ fs/ubifs/ioctl.c | 4 ++++ include/linux/fscrypt.h | 6 ++++++ include/uapi/linux/fscrypt.h | 1 + 9 files changed, 81 insertions(+), 15 deletions(-)
base-commit: 98d54f81e36ba3bf92172791eba5ca5bd813989b
Signature · 8 lines
2.25.1 _______________________________________________ Linux-f2fs-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Eric Biggers
maintainerPATCH 1/4 fscrypt: add FS_IOC_GET_ENCRYPTION_NONCE ioctl
From: Eric Biggers <[email protected]>
Add an ioctl FS_IOC_GET_ENCRYPTION_NONCE which retrieves the nonce from an encrypted file or directory. The nonce is the 16-byte random value stored in the inode's encryption xattr. It is normally used together with the master key to derive the inode's actual encryption key.
The nonces are needed by automated tests that verify the correctness of the ciphertext on-disk. Except for the IV_INO_LBLK_64 case, there's no way to replicate a file's ciphertext without knowing that file's nonce.
The nonces aren't secret, and the existing ciphertext verification tests in xfstests retrieve them from disk using debugfs or dump.f2fs. But in environments that lack these debugging tools, getting the nonces by manually parsing the filesystem structure would be very hard.
To make this important type of testing much easier, let's just add an ioctl that retrieves the nonce.
--- Documentation/filesystems/fscrypt.rst | 11 +++++++++++ fs/crypto/fscrypt_private.h | 20 ++++++++++++++++++++ fs/crypto/keysetup.c | 16 ++-------------- fs/crypto/policy.c | 21 ++++++++++++++++++++- include/linux/fscrypt.h | 6 ++++++ include/uapi/linux/fscrypt.h | 1 + 6 files changed, 60 insertions(+), 15 deletions(-)
Documentation/filesystems/fscrypt.rst +11 -0
@@ -633,6 +633,17 @@ from a passphrase or other low-entropy user credential. FS_IOC_GET_ENCRYPTION_PWSALT is deprecated. Instead, prefer to generate and manage any needed salt(s) in userspace. +Getting a file's encryption nonce +--------------------------------- + +Since Linux v5.7, the ioctl FS_IOC_GET_ENCRYPTION_NONCE is supported. +On encrypted files and directories it gets the inode's 16-byte nonce. +On unencrypted files and directories, it fails with ENODATA. + +This ioctl can be useful for automated tests which verify that the +encryption is being done correctly. It is not needed for normal use +of fscrypt. + Adding keys -----------
fs/crypto/fscrypt_private.h +20 -0
@@ -76,6 +76,26 @@ static inline int fscrypt_context_size(const union fscrypt_context *ctx)return 0 ; } +/* Check whether an fscrypt_context has a recognized version number and size */ +static inline bool fscrypt_context_is_valid (const union fscrypt_context *ctx, +int ctx_size) +{ +return ctx_size >=1 && ctx_size ==fscrypt_context_size (ctx); +} + +/* Retrieve the context's nonce, assuming the context was already validated */ +static inline const u8 *fscrypt_context_nonce (const union fscrypt_context *ctx) +{ +switch (ctx->version) { +case FSCRYPT_CONTEXT_V1 : +return ctx->v1.nonce; +case FSCRYPT_CONTEXT_V2 : +return ctx->v2.nonce; + } +WARN_ON (1 ); +return NULL ; +} +#undef fscrypt_policyunion fscrypt_policy {u8 version;
fs/crypto/keysetup.c +2 -14
@@ -425,20 +425,8 @@ int fscrypt_get_encryption_info(struct inode *inode) goto out; } -switch (ctx.version) { -case FSCRYPT_CONTEXT_V1 : -memcpy (crypt_info->ci_nonce, ctx.v1.nonce, -FS_KEY_DERIVATION_NONCE_SIZE ); -break ; -case FSCRYPT_CONTEXT_V2 : -memcpy (crypt_info->ci_nonce, ctx.v2.nonce, -FS_KEY_DERIVATION_NONCE_SIZE ); -break ; -default : -WARN_ON (1 ); - res = -EINVAL ; - goto out; - } +memcpy (crypt_info->ci_nonce,fscrypt_context_nonce (&ctx), +FS_KEY_DERIVATION_NONCE_SIZE );if (!fscrypt_supported_policy (&crypt_info->ci_policy, inode)) { res = -EINVAL ;
fs/crypto/policy.c +20 -1
@@ -258,7 +258,7 @@ int fscrypt_policy_from_context(union fscrypt_policy *policy_u, {memset (policy_u,0 ,sizeof (*policy_u)); -if (ctx_size <=0 || ctx_size !=fscrypt_context_size (ctx_u)) +if (!fscrypt_context_is_valid (ctx_u, ctx_size))return -EINVAL ;switch (ctx_u->version) {
@@ -481,6 +481,25 @@ int fscrypt_ioctl_get_policy_ex(struct file *filp, void __user *uarg) }EXPORT_SYMBOL_GPL (fscrypt_ioctl_get_policy_ex); +/* FS_IOC_GET_ENCRYPTION_NONCE: retrieve file's encryption nonce for testing */ +int fscrypt_ioctl_get_nonce (struct file *filp,void __user *arg) +{ +struct inode *inode =file_inode (filp); +union fscrypt_context ctx; +int ret; + + ret = inode->i_sb->s_cop->get_context (inode, &ctx,sizeof (ctx)); +if (ret <0 ) +return ret; +if (!fscrypt_context_is_valid (&ctx, ret)) +return -EINVAL ; +if (copy_to_user (arg,fscrypt_context_nonce (&ctx), +FS_KEY_DERIVATION_NONCE_SIZE )) +return -EFAULT ; +return 0 ; +} +EXPORT_SYMBOL_GPL (fscrypt_ioctl_get_nonce); +/** * fscrypt_has_permitted_context() - is a file's encryption policy permitted * within its directory?
include/linux/fscrypt.h +6 -0
@@ -139,6 +139,7 @@ extern void fscrypt_free_bounce_page(struct page *bounce_page);extern int fscrypt_ioctl_set_policy (struct file *,const void __user *);extern int fscrypt_ioctl_get_policy (struct file *,void __user *);extern int fscrypt_ioctl_get_policy_ex (struct file *,void __user *); +extern int fscrypt_ioctl_get_nonce (struct file *filp,void __user *arg);extern int fscrypt_has_permitted_context (struct inode *,struct inode *);extern int fscrypt_inherit_context (struct inode *,struct inode *,void *,bool );
@@ -300,6 +301,11 @@ static inline int fscrypt_ioctl_get_policy_ex(struct file *filp,return -EOPNOTSUPP ; } +static inline int fscrypt_ioctl_get_nonce (struct file *filp,void __user *arg) +{ +return -EOPNOTSUPP ; +} +static inline int fscrypt_has_permitted_context (struct inode *parent,struct inode *child) {
include/uapi/linux/fscrypt.h +1 -0
@@ -163,6 +163,7 @@ struct fscrypt_get_key_status_arg {#define FS_IOC_REMOVE_ENCRYPTION_KEY _IOWR('f', 24, struct fscrypt_remove_key_arg)#define FS_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS _IOWR('f', 25, struct fscrypt_remove_key_arg)#define FS_IOC_GET_ENCRYPTION_KEY_STATUS _IOWR('f', 26, struct fscrypt_get_key_status_arg) +#define FS_IOC_GET_ENCRYPTION_NONCE _IOR('f', 27, __u8[16])/**********************************************************************/
Signature · 8 lines
2.25.1 _______________________________________________ Linux-f2fs-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Re: [PATCH 1/4] fscrypt: add FS_IOC_GET_ENCRYPTION_NONCE ioctl
Quoted 16 lines · Eric Biggers
From: Eric Biggers <[email protected]>
Add an ioctl
FS_IOC_GET_ENCRYPTION_NONCEwhich retrieves the nonce from an encrypted file or directory. The nonce is the 16-byte random value stored in the inode's encryption xattr. It is normally used together with the master key to derive the inode's actual encryption key.The nonces are needed by automated tests that verify the correctness of the ciphertext on-disk. Except for the
IV_INO_LBLK_64case, there's no way to replicate a file's ciphertext without knowing that file's nonce.The nonces aren't secret, and the existing ciphertext verification tests in xfstests retrieve them from disk using debugfs or dump.f2fs. But in environments that lack these debugging tools, getting the nonces by manually parsing the filesystem structure would be very hard.
Quoted 4 lines
To make this important type of testing much easier, let's just add an ioctl that retrieves the nonce.
Signed-off-by Eric Biggers <[email protected]>
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
Eric Biggers
maintainerPATCH 2/4 ext4: wire up FS_IOC_GET_ENCRYPTION_NONCE
In reply to Eric BiggersFrom: Eric Biggers <[email protected]>
This new ioctl retrieves a file's encryption nonce, which is useful for testing. See the corresponding fs/crypto/ patch for more details.
--- fs/ext4/ioctl.c | 6 ++++++ 1 file changed, 6 insertions(+)
fs/ext4/ioctl.c +6 -0
@@ -1210,6 +1210,11 @@ long ext4_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)return -EOPNOTSUPP ;return fscrypt_ioctl_get_key_status (filp, (void __user *)arg); +case FS_IOC_GET_ENCRYPTION_NONCE : +if (!ext4_has_feature_encrypt (sb)) +return -EOPNOTSUPP ; +return fscrypt_ioctl_get_nonce (filp, (void __user *)arg); +case EXT4_IOC_CLEAR_ES_CACHE : {if (!inode_owner_or_capable (inode))
@@ -1370,6 +1375,7 @@ long ext4_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)case FS_IOC_REMOVE_ENCRYPTION_KEY :case FS_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS :case FS_IOC_GET_ENCRYPTION_KEY_STATUS : +case FS_IOC_GET_ENCRYPTION_NONCE :case EXT4_IOC_SHUTDOWN :case FS_IOC_GETFSMAP :case FS_IOC_ENABLE_VERITY :
Signature · 8 lines
2.25.1 _______________________________________________ Linux-f2fs-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Re: [PATCH 2/4] ext4: wire up FS_IOC_GET_ENCRYPTION_NONCE
Quoted 6 lines · Eric Biggers
From: Eric Biggers <[email protected]>
This new ioctl retrieves a file's encryption nonce, which is useful for testing. See the corresponding
fs/crypto/patch for more details.Signed-off-by Eric Biggers <[email protected]>
_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Eric Biggers
maintainerPATCH 3/4 f2fs: wire up FS_IOC_GET_ENCRYPTION_NONCE
In reply to Eric BiggersFrom: Eric Biggers <[email protected]>
This new ioctl retrieves a file's encryption nonce, which is useful for testing. See the corresponding fs/crypto/ patch for more details.
--- fs/f2fs/file.c | 11 +++++++++++ 1 file changed, 11 insertions(+)
fs/f2fs/file.c +11 -0
@@ -2423,6 +2423,14 @@ static int f2fs_ioc_get_encryption_key_status(struct file *filp,return fscrypt_ioctl_get_key_status (filp, (void __user *)arg); } +static int f2fs_ioc_get_encryption_nonce (struct file *filp,unsigned long arg) +{ +if (!f2fs_sb_has_encrypt (F2FS_I_SB (file_inode (filp)))) +return -EOPNOTSUPP ; + +return fscrypt_ioctl_get_nonce (filp, (void __user *)arg); +} +static int f2fs_ioc_gc (struct file *filp,unsigned long arg) {struct inode *inode =file_inode (filp);
@@ -3437,6 +3445,8 @@ long f2fs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)return f2fs_ioc_remove_encryption_key_all_users (filp, arg);case FS_IOC_GET_ENCRYPTION_KEY_STATUS :return f2fs_ioc_get_encryption_key_status (filp, arg); +case FS_IOC_GET_ENCRYPTION_NONCE : +return f2fs_ioc_get_encryption_nonce (filp, arg);case F2FS_IOC_GARBAGE_COLLECT :return f2fs_ioc_gc (filp, arg);case F2FS_IOC_GARBAGE_COLLECT_RANGE :
@@ -3611,6 +3621,7 @@ long f2fs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)case FS_IOC_REMOVE_ENCRYPTION_KEY :case FS_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS :case FS_IOC_GET_ENCRYPTION_KEY_STATUS : +case FS_IOC_GET_ENCRYPTION_NONCE :case F2FS_IOC_GARBAGE_COLLECT :case F2FS_IOC_GARBAGE_COLLECT_RANGE :case F2FS_IOC_WRITE_CHECKPOINT :
Signature · 8 lines
2.25.1 _______________________________________________ Linux-f2fs-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Eric Biggers
maintainerPATCH 4/4 ubifs: wire up FS_IOC_GET_ENCRYPTION_NONCE
In reply to Eric BiggersFrom: Eric Biggers <[email protected]>
This new ioctl retrieves a file's encryption nonce, which is useful for testing. See the corresponding fs/crypto/ patch for more details.
--- fs/ubifs/ioctl.c | 4 ++++ 1 file changed, 4 insertions(+)
fs/ubifs/ioctl.c +4 -0
@@ -208,6 +208,9 @@ long ubifs_ioctl(struct file *file, unsigned int cmd, unsigned long arg)case FS_IOC_GET_ENCRYPTION_KEY_STATUS :return fscrypt_ioctl_get_key_status (file, (void __user *)arg); +case FS_IOC_GET_ENCRYPTION_NONCE : +return fscrypt_ioctl_get_nonce (file, (void __user *)arg); +default :return -ENOTTY ; }
@@ -230,6 +233,7 @@ long ubifs_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)case FS_IOC_REMOVE_ENCRYPTION_KEY :case FS_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS :case FS_IOC_GET_ENCRYPTION_KEY_STATUS : +case FS_IOC_GET_ENCRYPTION_NONCE :break ;default :return -ENOIOCTLCMD ;
Signature · 8 lines
2.25.1 _______________________________________________ Linux-f2fs-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Eric Biggers
maintainerQuoted 25 lines · Eric Biggers
This patchset adds an ioctl
FS_IOC_GET_ENCRYPTION_NONCEwhich retrieves the nonce from an encrypted file or directory.This is useful for automated ciphertext verification testing.
See patch #1 for more details.
Eric Biggers (4):
fscrypt: addFS_IOC_GET_ENCRYPTION_NONCEioctl
ext4: wire upFS_IOC_GET_ENCRYPTION_NONCE
f2fs: wire upFS_IOC_GET_ENCRYPTION_NONCE
ubifs: wire upFS_IOC_GET_ENCRYPTION_NONCEDocumentation/filesystems/fscrypt.rst | 11 +++++++++++ fs/crypto/fscrypt_private.h | 20 ++++++++++++++++++++ fs/crypto/keysetup.c | 16 ++-------------- fs/crypto/policy.c | 21 ++++++++++++++++++++- fs/ext4/ioctl.c | 6 ++++++ fs/f2fs/file.c | 11 +++++++++++ fs/ubifs/ioctl.c | 4 ++++ include/linux/fscrypt.h | 6 ++++++ include/uapi/linux/fscrypt.h | 1 + 9 files changed, 81 insertions(+), 15 deletions(-)
Quoted 1 line
base-commit:
98d54f81e36ba3bf92172791eba5ca5bd813989b
Any comments on this?
- Eric
Quoted 13 lines · Eric Biggers
This patchset adds an ioctl
FS_IOC_GET_ENCRYPTION_NONCEwhich retrieves the nonce from an encrypted file or directory.This is useful for automated ciphertext verification testing.
See patch #1 for more details.
Eric Biggers (4):
fscrypt: addFS_IOC_GET_ENCRYPTION_NONCEioctl
ext4: wire upFS_IOC_GET_ENCRYPTION_NONCE
f2fs: wire upFS_IOC_GET_ENCRYPTION_NONCE
ubifs: wire upFS_IOC_GET_ENCRYPTION_NONCE
Quoted 11 lines
Documentation/filesystems/fscrypt.rst | 11 +++++++++++ fs/crypto/fscrypt_private.h | 20 ++++++++++++++++++++ fs/crypto/keysetup.c | 16 ++-------------- fs/crypto/policy.c | 21 ++++++++++++++++++++- fs/ext4/ioctl.c | 6 ++++++ fs/f2fs/file.c | 11 +++++++++++ fs/ubifs/ioctl.c | 4 ++++ include/linux/fscrypt.h | 6 ++++++ include/uapi/linux/fscrypt.h | 1 + 9 files changed, 81 insertions(+), 15 deletions(-)
Applied to fscrypt.git#master for 5.7.
- Eric