fscrypt: use HMAC-SHA512 library for HKDF
Subsystems (2)
Eric Biggers
maintainerPATCH 1/1 fscrypt: use HMAC-SHA512 library for HKDF
For the HKDF-SHA512 key derivation needed by fscrypt, just use the HMAC-SHA512 library functions directly. These functions were introduced in v6.17, and they provide simple and efficient direct support for HMAC-SHA512. This ends up being quite a bit simpler and more efficient than using crypto/hkdf.c, as it avoids the generic crypto layer:
- The HMAC library can't fail, so callers don't need to handle errors
- No inefficient indirect calls
- No inefficient and error-prone dynamic allocations
- No inefficient and error-prone loading of algorithm by name
- Less stack usage
Benchmarks on x86_64 show that deriving a per-file key gets about 30% faster, and FS_IOC_ADD_ENCRYPTION_KEY gets nearly twice as fast.
The only small downside is the HKDF-Expand logic gets duplicated again. Then again, even considering that, the new fscrypt_hkdf_expand() is only 7 lines longer than the version that called hkdf_expand(). Later we could add HKDF support to lib/crypto/, but for now let's just do this.
---
This patch is targeting fscrypt/for-next
fs/crypto/Kconfig | 5 +- fs/crypto/fname.c | 1 - fs/crypto/fscrypt_private.h | 26 ++++----- fs/crypto/hkdf.c | 109 +++++++++++++----------------------- fs/crypto/hooks.c | 2 +- fs/crypto/keyring.c | 30 +++------- fs/crypto/keysetup.c | 65 +++++++-------------- fs/crypto/policy.c | 4 +- 8 files changed, 82 insertions(+), 160 deletions(-)
fs/crypto/Kconfig +1 -4
@@ -1,13 +1,12 @@ # SPDX-License-Identifier: GPL-2.0-only config FS_ENCRYPTION bool "FS Encryption (Per-file encryption)" select CRYPTO - select CRYPTO_HASH - select CRYPTO_HKDF select CRYPTO_SKCIPHER select CRYPTO_LIB_SHA256 + select CRYPTO_LIB_SHA512 select KEYS help Enable encryption of files and directories. This feature is similar to ecryptfs, but it is more memory efficient since it avoids caching the encrypted and
@@ -30,12 +29,10 @@ config FS_ENCRYPTION_ALGS tristate select CRYPTO_AES select CRYPTO_CBC select CRYPTO_CTS select CRYPTO_ECB - select CRYPTO_HMAC - select CRYPTO_SHA512 select CRYPTO_XTS config FS_ENCRYPTION_INLINE_CRYPT bool "Enable fscrypt to use inline crypto" depends on FS_ENCRYPTION && BLK_INLINE_ENCRYPTION
fs/crypto/fname.c +0 -1
@@ -9,11 +9,10 @@* Modified by Jaegeuk Kim, 2015. * * This has not yet undergone a rigorous security audit. */ -#include <crypto/hash.h> #include <crypto/sha2.h> #include <crypto/skcipher.h> #include <linux/export.h> #include <linux/namei.h> #include <linux/scatterlist.h>
fs/crypto/fscrypt_private.h +10 -16
@@ -9,14 +9,14 @@*/ #ifndef _FSCRYPT_PRIVATE_H#define _FSCRYPT_PRIVATE_H +#include <crypto/sha2.h> #include <linux/fscrypt.h> #include <linux/minmax.h> #include <linux/siphash.h> -#include <crypto/hash.h> #include <linux/blk-crypto.h> #define CONST_STRLEN (str) (sizeof(str) - 1)#define FSCRYPT_FILE_NONCE_SIZE 16
@@ -379,16 +379,12 @@ fscrypt_max_file_dun_bits(const struct super_block *sb, int du_bits)bool __fscrypt_fname_encrypted_size (const union fscrypt_policy *policy,u32 orig_len,u32 max_len,u32 *encrypted_len_ret);/* hkdf.c */ -struct fscrypt_hkdf { -struct crypto_shash *hmac_tfm; -}; - -int fscrypt_init_hkdf (struct fscrypt_hkdf *hkdf,const u8 *master_key, -unsigned int master_key_size); +void fscrypt_init_hkdf (struct hmac_sha512_key *hkdf,const u8 *master_key, +unsigned int master_key_size);/* * The list of contexts in which fscrypt uses HKDF. These values are used as * the first byte of the HKDF application-specific info string to guarantee that * info strings are never repeated between contexts. This ensures that all HKDF
@@ -403,15 +399,13 @@ int fscrypt_init_hkdf(struct fscrypt_hkdf *hkdf, const u8 *master_key,#define HKDF_CONTEXT_IV_INO_LBLK_32_KEY 6/* info=mode_num||fs_uuid */ #define HKDF_CONTEXT_INODE_HASH_KEY 7/* info=<empty> */ #define HKDF_CONTEXT_KEY_IDENTIFIER_FOR_HW_WRAPPED_KEY \ 8/* info=<empty> */ -int fscrypt_hkdf_expand (const struct fscrypt_hkdf *hkdf,u8 context, -const u8 *info,unsigned int infolen, -u8 *okm,unsigned int okmlen); - -void fscrypt_destroy_hkdf (struct fscrypt_hkdf *hkdf); +void fscrypt_hkdf_expand (const struct hmac_sha512_key *hkdf,u8 context, +const u8 *info,unsigned int infolen, +u8 *okm,unsigned int okmlen);/* inline_crypt.c */ #ifdef CONFIG_FS_ENCRYPTION_INLINE_CRYPT int fscrypt_select_encryption_impl (struct fscrypt_inode_info *ci,bool is_hw_wrapped_key);
@@ -515,11 +509,11 @@ struct fscrypt_master_key_secret {* For v1 policy keys, this isn't applicable and won't be set. * Otherwise, this KDF will be keyed by this master key if * ->is_hw_wrapped=false, or by the "software secret" that hardware * derived from this master key if ->is_hw_wrapped=true. */ -struct fscrypt_hkdf hkdf; +struct hmac_sha512_key hkdf;/* * True if this key is a hardware-wrapped key; false if this key is a * raw key (i.e. a "software key"). For v1 policy keys this will always * be false, as v1 policy support is a legacy feature which doesn't
@@ -694,11 +688,11 @@ void fscrypt_put_master_key_activeref(struct super_block *sb,struct fscrypt_master_key *fscrypt_find_master_key (struct super_block *sb,const struct fscrypt_key_specifier *mk_spec); -int fscrypt_get_test_dummy_key_identifier ( +void fscrypt_get_test_dummy_key_identifier (u8 key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE ]);int fscrypt_add_test_dummy_key (struct super_block *sb,struct fscrypt_key_specifier *key_spec);
@@ -730,12 +724,12 @@ void fscrypt_destroy_prepared_key(struct super_block *sb, struct fscrypt_prepared_key *prep_key);int fscrypt_set_per_file_enc_key (struct fscrypt_inode_info *ci,const u8 *raw_key); -int fscrypt_derive_dirhash_key (struct fscrypt_inode_info *ci, -const struct fscrypt_master_key *mk); +void fscrypt_derive_dirhash_key (struct fscrypt_inode_info *ci, +const struct fscrypt_master_key *mk);void fscrypt_hash_inode_number (struct fscrypt_inode_info *ci,const struct fscrypt_master_key *mk);int fscrypt_get_encryption_info (struct inode *inode,bool allow_unsupported);
fs/crypto/hkdf.c +40 -69
157 lines not on this page · raw message
fs/crypto/hooks.c +1 -1
@@ -203,11 +203,11 @@ int fscrypt_prepare_setflags(struct inode *inode,if (ci->ci_policy.version !=FSCRYPT_POLICY_V2 )return -EINVAL ; mk = ci->ci_master_key;down_read (&mk->mk_sem);if (mk->mk_present) - err =fscrypt_derive_dirhash_key (ci, mk); +fscrypt_derive_dirhash_key (ci, mk);else err = -ENOKEY ;up_read (&mk->mk_sem);return err; }
fs/crypto/keyring.c +9 -21
@@ -40,11 +40,10 @@ struct fscrypt_keyring {struct hlist_head key_hashtable[128 ]; };static void wipe_master_key_secret (struct fscrypt_master_key_secret *secret) { -fscrypt_destroy_hkdf (&secret->hkdf);memzero_explicit (secret,sizeof (*secret)); }static void move_master_key_secret (struct fscrypt_master_key_secret *dst,struct fscrypt_master_key_secret *src)
@@ -585,25 +584,21 @@ static int add_master_key(struct super_block *sb,* identifiers using different KDF contexts. */ keyid_kdf_ctx =HKDF_CONTEXT_KEY_IDENTIFIER_FOR_HW_WRAPPED_KEY ; } - err =fscrypt_init_hkdf (&secret->hkdf, kdf_key, kdf_key_size); +fscrypt_init_hkdf (&secret->hkdf, kdf_key, kdf_key_size);/* * Now that the KDF context is initialized, the raw KDF key is * no longer needed. */ memzero_explicit (kdf_key, kdf_key_size); -if (err) -return err;/* Calculate the key identifier */ - err =fscrypt_hkdf_expand (&secret->hkdf, keyid_kdf_ctx,NULL ,0 , - key_spec->u.identifier, -FSCRYPT_KEY_IDENTIFIER_SIZE ); -if (err) -return err; +fscrypt_hkdf_expand (&secret->hkdf, keyid_kdf_ctx,NULL ,0 , + key_spec->u.identifier, +FSCRYPT_KEY_IDENTIFIER_SIZE ); }return do_add_master_key (sb, secret, key_spec); }/*
@@ -833,28 +828,21 @@ fscrypt_get_test_dummy_secret(struct fscrypt_master_key_secret *secret)memset (secret,0 ,sizeof (*secret)); secret->size =sizeof (test_key);memcpy (secret->bytes, test_key,sizeof (test_key)); } -int fscrypt_get_test_dummy_key_identifier ( +void fscrypt_get_test_dummy_key_identifier (u8 key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE ]) {struct fscrypt_master_key_secret secret; -int err;fscrypt_get_test_dummy_secret (&secret); - - err =fscrypt_init_hkdf (&secret.hkdf, secret.bytes, secret.size); -if (err) - goto out; - err =fscrypt_hkdf_expand (&secret.hkdf, -HKDF_CONTEXT_KEY_IDENTIFIER_FOR_RAW_KEY , -NULL ,0 , key_identifier, -FSCRYPT_KEY_IDENTIFIER_SIZE ); -out: +fscrypt_init_hkdf (&secret.hkdf, secret.bytes, secret.size); +fscrypt_hkdf_expand (&secret.hkdf, +HKDF_CONTEXT_KEY_IDENTIFIER_FOR_RAW_KEY ,NULL ,0 , + key_identifier,FSCRYPT_KEY_IDENTIFIER_SIZE );wipe_master_key_secret (&secret); -return err; }/** * fscrypt_add_test_dummy_key() - add the test dummy encryption key * @sb: the filesystem instance to add the key to
fs/crypto/keysetup.c +20 -45
125 lines not on this page · raw message
fs/crypto/policy.c +1 -3
@@ -824,14 +824,12 @@ int fscrypt_parse_test_dummy_encryption(const struct fs_parameter *param, FSCRYPT_KEY_DESCRIPTOR_SIZE); }else if (!strcmp (arg,"v2" )) { policy->version =FSCRYPT_POLICY_V2 ; policy->v2.contents_encryption_mode =FSCRYPT_MODE_AES_256_XTS ; policy->v2.filenames_encryption_mode =FSCRYPT_MODE_AES_256_CTS ; - err =fscrypt_get_test_dummy_key_identifier ( +fscrypt_get_test_dummy_key_identifier ( policy->v2.master_key_identifier); -if (err) - goto out; }else { err = -EINVAL ; goto out; }
base-commit: 0e6608d4938eb209616e8673c95364bb2a7d55bd
Signature · 1 line
2.50.1
Quoted 20 lines · Eric Biggers
For the HKDF-SHA512 key derivation needed by fscrypt, just use the HMAC-SHA512 library functions directly. These functions were introduced in v6.17, and they provide simple and efficient direct support for HMAC-SHA512. This ends up being quite a bit simpler and more efficient than using
crypto/hkdf.c, as it avoids the generic crypto layer:- The HMAC library can't fail, so callers don't need to handle errors
- No inefficient indirect calls
- No inefficient and error-prone dynamic allocations
- No inefficient and error-prone loading of algorithm by name
- Less stack usageBenchmarks on
x86_64show that deriving a per-file key gets about 30% faster, andFS_IOC_ADD_ENCRYPTION_KEYgets nearly twice as fast.The only small downside is the HKDF-Expand logic gets duplicated again. Then again, even considering that, the new
fscrypt_hkdf_expand()is only 7 lines longer than the version that calledhkdf_expand(). Later we could add HKDF support tolib/crypto/, but for now let's just do this.
Quoted 4 lines
Signed-off-by Eric Biggers <[email protected]>---
This patch is targeting fscrypt/for-next
Applied to https://git.kernel.org/pub/scm/fs/fscrypt/linux.git/log/?h=for-next
- Eric