1 // SPDX-License-Identifier: GPL-2.0
3 * key management facility for FS encryption support.
5 * Copyright (C) 2015, Google, Inc.
7 * This contains encryption key functions.
9 * Written by Michael Halcrow, Ildar Muslukhov, and Uday Savagaonkar, 2015.
12 #include <keys/user-type.h>
13 #include <linux/hashtable.h>
14 #include <linux/scatterlist.h>
15 #include <linux/ratelimit.h>
16 #include <crypto/aes.h>
17 #include <crypto/algapi.h>
18 #include <crypto/sha.h>
19 #include <crypto/skcipher.h>
20 #include "fscrypt_private.h"
22 static struct crypto_shash *essiv_hash_tfm;
24 /* Table of keys referenced by FS_POLICY_FLAG_DIRECT_KEY policies */
25 static DEFINE_HASHTABLE(fscrypt_master_keys, 6); /* 6 bits = 64 buckets */
26 static DEFINE_SPINLOCK(fscrypt_master_keys_lock);
29 * Key derivation function. This generates the derived key by encrypting the
30 * master key with AES-128-ECB using the inode's nonce as the AES key.
32 * The master key must be at least as long as the derived key. If the master
33 * key is longer, then only the first 'derived_keysize' bytes are used.
35 static int derive_key_aes(const u8 *master_key,
36 const struct fscrypt_context *ctx,
37 u8 *derived_key, unsigned int derived_keysize)
40 struct skcipher_request *req = NULL;
41 DECLARE_CRYPTO_WAIT(wait);
42 struct scatterlist src_sg, dst_sg;
43 struct crypto_skcipher *tfm = crypto_alloc_skcipher("ecb(aes)", 0, 0);
50 crypto_skcipher_set_flags(tfm, CRYPTO_TFM_REQ_FORBID_WEAK_KEYS);
51 req = skcipher_request_alloc(tfm, GFP_NOFS);
56 skcipher_request_set_callback(req,
57 CRYPTO_TFM_REQ_MAY_BACKLOG | CRYPTO_TFM_REQ_MAY_SLEEP,
58 crypto_req_done, &wait);
59 res = crypto_skcipher_setkey(tfm, ctx->nonce, sizeof(ctx->nonce));
63 sg_init_one(&src_sg, master_key, derived_keysize);
64 sg_init_one(&dst_sg, derived_key, derived_keysize);
65 skcipher_request_set_crypt(req, &src_sg, &dst_sg, derived_keysize,
67 res = crypto_wait_req(crypto_skcipher_encrypt(req), &wait);
69 skcipher_request_free(req);
70 crypto_free_skcipher(tfm);
75 * Search the current task's subscribed keyrings for a "logon" key with
76 * description prefix:descriptor, and if found acquire a read lock on it and
77 * return a pointer to its validated payload in *payload_ret.
80 find_and_lock_process_key(const char *prefix,
81 const u8 descriptor[FS_KEY_DESCRIPTOR_SIZE],
82 unsigned int min_keysize,
83 const struct fscrypt_key **payload_ret)
87 const struct user_key_payload *ukp;
88 const struct fscrypt_key *payload;
90 description = kasprintf(GFP_NOFS, "%s%*phN", prefix,
91 FS_KEY_DESCRIPTOR_SIZE, descriptor);
93 return ERR_PTR(-ENOMEM);
95 key = request_key(&key_type_logon, description, NULL);
100 down_read(&key->sem);
101 ukp = user_key_payload_locked(key);
103 if (!ukp) /* was the key revoked before we acquired its semaphore? */
106 payload = (const struct fscrypt_key *)ukp->data;
108 if (ukp->datalen != sizeof(struct fscrypt_key) ||
109 payload->size < 1 || payload->size > FS_MAX_KEY_SIZE) {
111 "key with description '%s' has invalid payload",
116 if (payload->size < min_keysize) {
118 "key with description '%s' is too short (got %u bytes, need %u+ bytes)",
119 key->description, payload->size, min_keysize);
123 *payload_ret = payload;
129 return ERR_PTR(-ENOKEY);
132 static struct fscrypt_mode available_modes[] = {
133 [FS_ENCRYPTION_MODE_AES_256_XTS] = {
134 .friendly_name = "AES-256-XTS",
135 .cipher_str = "xts(aes)",
139 [FS_ENCRYPTION_MODE_AES_256_CTS] = {
140 .friendly_name = "AES-256-CTS-CBC",
141 .cipher_str = "cts(cbc(aes))",
145 [FS_ENCRYPTION_MODE_AES_128_CBC] = {
146 .friendly_name = "AES-128-CBC",
147 .cipher_str = "cbc(aes)",
152 [FS_ENCRYPTION_MODE_AES_128_CTS] = {
153 .friendly_name = "AES-128-CTS-CBC",
154 .cipher_str = "cts(cbc(aes))",
158 [FS_ENCRYPTION_MODE_ADIANTUM] = {
159 .friendly_name = "Adiantum",
160 .cipher_str = "adiantum(xchacha12,aes)",
166 static struct fscrypt_mode *
167 select_encryption_mode(const struct fscrypt_info *ci, const struct inode *inode)
169 if (!fscrypt_valid_enc_modes(ci->ci_data_mode, ci->ci_filename_mode)) {
170 fscrypt_warn(inode->i_sb,
171 "inode %lu uses unsupported encryption modes (contents mode %d, filenames mode %d)",
172 inode->i_ino, ci->ci_data_mode,
173 ci->ci_filename_mode);
174 return ERR_PTR(-EINVAL);
177 if (S_ISREG(inode->i_mode))
178 return &available_modes[ci->ci_data_mode];
180 if (S_ISDIR(inode->i_mode) || S_ISLNK(inode->i_mode))
181 return &available_modes[ci->ci_filename_mode];
183 WARN_ONCE(1, "fscrypt: filesystem tried to load encryption info for inode %lu, which is not encryptable (file type %d)\n",
184 inode->i_ino, (inode->i_mode & S_IFMT));
185 return ERR_PTR(-EINVAL);
188 /* Find the master key, then derive the inode's actual encryption key */
189 static int find_and_derive_key(const struct inode *inode,
190 const struct fscrypt_context *ctx,
191 u8 *derived_key, const struct fscrypt_mode *mode)
194 const struct fscrypt_key *payload;
197 key = find_and_lock_process_key(FS_KEY_DESC_PREFIX,
198 ctx->master_key_descriptor,
199 mode->keysize, &payload);
200 if (key == ERR_PTR(-ENOKEY) && inode->i_sb->s_cop->key_prefix) {
201 key = find_and_lock_process_key(inode->i_sb->s_cop->key_prefix,
202 ctx->master_key_descriptor,
203 mode->keysize, &payload);
208 if (ctx->flags & FS_POLICY_FLAG_DIRECT_KEY) {
209 if (mode->ivsize < offsetofend(union fscrypt_iv, nonce)) {
210 fscrypt_warn(inode->i_sb,
211 "direct key mode not allowed with %s",
212 mode->friendly_name);
214 } else if (ctx->contents_encryption_mode !=
215 ctx->filenames_encryption_mode) {
216 fscrypt_warn(inode->i_sb,
217 "direct key mode not allowed with different contents and filenames modes");
220 memcpy(derived_key, payload->raw, mode->keysize);
224 err = derive_key_aes(payload->raw, ctx, derived_key,
232 /* Allocate and key a symmetric cipher object for the given encryption mode */
233 static struct crypto_skcipher *
234 allocate_skcipher_for_mode(struct fscrypt_mode *mode, const u8 *raw_key,
235 const struct inode *inode)
237 struct crypto_skcipher *tfm;
240 tfm = crypto_alloc_skcipher(mode->cipher_str, 0, 0);
242 fscrypt_warn(inode->i_sb,
243 "error allocating '%s' transform for inode %lu: %ld",
244 mode->cipher_str, inode->i_ino, PTR_ERR(tfm));
247 if (unlikely(!mode->logged_impl_name)) {
249 * fscrypt performance can vary greatly depending on which
250 * crypto algorithm implementation is used. Help people debug
251 * performance problems by logging the ->cra_driver_name the
252 * first time a mode is used. Note that multiple threads can
253 * race here, but it doesn't really matter.
255 mode->logged_impl_name = true;
256 pr_info("fscrypt: %s using implementation \"%s\"\n",
258 crypto_skcipher_alg(tfm)->base.cra_driver_name);
260 crypto_skcipher_set_flags(tfm, CRYPTO_TFM_REQ_FORBID_WEAK_KEYS);
261 err = crypto_skcipher_setkey(tfm, raw_key, mode->keysize);
268 crypto_free_skcipher(tfm);
272 /* Master key referenced by FS_POLICY_FLAG_DIRECT_KEY policy */
273 struct fscrypt_master_key {
274 struct hlist_node mk_node;
275 refcount_t mk_refcount;
276 const struct fscrypt_mode *mk_mode;
277 struct crypto_skcipher *mk_ctfm;
278 u8 mk_descriptor[FS_KEY_DESCRIPTOR_SIZE];
279 u8 mk_raw[FS_MAX_KEY_SIZE];
282 static void free_master_key(struct fscrypt_master_key *mk)
285 crypto_free_skcipher(mk->mk_ctfm);
290 static void put_master_key(struct fscrypt_master_key *mk)
292 if (!refcount_dec_and_lock(&mk->mk_refcount, &fscrypt_master_keys_lock))
294 hash_del(&mk->mk_node);
295 spin_unlock(&fscrypt_master_keys_lock);
301 * Find/insert the given master key into the fscrypt_master_keys table. If
302 * found, it is returned with elevated refcount, and 'to_insert' is freed if
303 * non-NULL. If not found, 'to_insert' is inserted and returned if it's
304 * non-NULL; otherwise NULL is returned.
306 static struct fscrypt_master_key *
307 find_or_insert_master_key(struct fscrypt_master_key *to_insert,
308 const u8 *raw_key, const struct fscrypt_mode *mode,
309 const struct fscrypt_info *ci)
311 unsigned long hash_key;
312 struct fscrypt_master_key *mk;
315 * Careful: to avoid potentially leaking secret key bytes via timing
316 * information, we must key the hash table by descriptor rather than by
317 * raw key, and use crypto_memneq() when comparing raw keys.
320 BUILD_BUG_ON(sizeof(hash_key) > FS_KEY_DESCRIPTOR_SIZE);
321 memcpy(&hash_key, ci->ci_master_key_descriptor, sizeof(hash_key));
323 spin_lock(&fscrypt_master_keys_lock);
324 hash_for_each_possible(fscrypt_master_keys, mk, mk_node, hash_key) {
325 if (memcmp(ci->ci_master_key_descriptor, mk->mk_descriptor,
326 FS_KEY_DESCRIPTOR_SIZE) != 0)
328 if (mode != mk->mk_mode)
330 if (crypto_memneq(raw_key, mk->mk_raw, mode->keysize))
332 /* using existing tfm with same (descriptor, mode, raw_key) */
333 refcount_inc(&mk->mk_refcount);
334 spin_unlock(&fscrypt_master_keys_lock);
335 free_master_key(to_insert);
339 hash_add(fscrypt_master_keys, &to_insert->mk_node, hash_key);
340 spin_unlock(&fscrypt_master_keys_lock);
344 /* Prepare to encrypt directly using the master key in the given mode */
345 static struct fscrypt_master_key *
346 fscrypt_get_master_key(const struct fscrypt_info *ci, struct fscrypt_mode *mode,
347 const u8 *raw_key, const struct inode *inode)
349 struct fscrypt_master_key *mk;
352 /* Is there already a tfm for this key? */
353 mk = find_or_insert_master_key(NULL, raw_key, mode, ci);
357 /* Nope, allocate one. */
358 mk = kzalloc(sizeof(*mk), GFP_NOFS);
360 return ERR_PTR(-ENOMEM);
361 refcount_set(&mk->mk_refcount, 1);
363 mk->mk_ctfm = allocate_skcipher_for_mode(mode, raw_key, inode);
364 if (IS_ERR(mk->mk_ctfm)) {
365 err = PTR_ERR(mk->mk_ctfm);
369 memcpy(mk->mk_descriptor, ci->ci_master_key_descriptor,
370 FS_KEY_DESCRIPTOR_SIZE);
371 memcpy(mk->mk_raw, raw_key, mode->keysize);
373 return find_or_insert_master_key(mk, raw_key, mode, ci);
380 static int derive_essiv_salt(const u8 *key, int keysize, u8 *salt)
382 struct crypto_shash *tfm = READ_ONCE(essiv_hash_tfm);
384 /* init hash transform on demand */
385 if (unlikely(!tfm)) {
386 struct crypto_shash *prev_tfm;
388 tfm = crypto_alloc_shash("sha256", 0, 0);
391 "error allocating SHA-256 transform: %ld",
395 prev_tfm = cmpxchg(&essiv_hash_tfm, NULL, tfm);
397 crypto_free_shash(tfm);
403 SHASH_DESC_ON_STACK(desc, tfm);
407 return crypto_shash_digest(desc, key, keysize, salt);
411 static int init_essiv_generator(struct fscrypt_info *ci, const u8 *raw_key,
415 struct crypto_cipher *essiv_tfm;
416 u8 salt[SHA256_DIGEST_SIZE];
418 essiv_tfm = crypto_alloc_cipher("aes", 0, 0);
419 if (IS_ERR(essiv_tfm))
420 return PTR_ERR(essiv_tfm);
422 ci->ci_essiv_tfm = essiv_tfm;
424 err = derive_essiv_salt(raw_key, keysize, salt);
429 * Using SHA256 to derive the salt/key will result in AES-256 being
430 * used for IV generation. File contents encryption will still use the
431 * configured keysize (AES-128) nevertheless.
433 err = crypto_cipher_setkey(essiv_tfm, salt, sizeof(salt));
438 memzero_explicit(salt, sizeof(salt));
442 void __exit fscrypt_essiv_cleanup(void)
444 crypto_free_shash(essiv_hash_tfm);
448 * Given the encryption mode and key (normally the derived key, but for
449 * FS_POLICY_FLAG_DIRECT_KEY mode it's the master key), set up the inode's
450 * symmetric cipher transform object(s).
452 static int setup_crypto_transform(struct fscrypt_info *ci,
453 struct fscrypt_mode *mode,
454 const u8 *raw_key, const struct inode *inode)
456 struct fscrypt_master_key *mk;
457 struct crypto_skcipher *ctfm;
460 if (ci->ci_flags & FS_POLICY_FLAG_DIRECT_KEY) {
461 mk = fscrypt_get_master_key(ci, mode, raw_key, inode);
467 ctfm = allocate_skcipher_for_mode(mode, raw_key, inode);
469 return PTR_ERR(ctfm);
471 ci->ci_master_key = mk;
474 if (mode->needs_essiv) {
475 /* ESSIV implies 16-byte IVs which implies !DIRECT_KEY */
476 WARN_ON(mode->ivsize != AES_BLOCK_SIZE);
477 WARN_ON(ci->ci_flags & FS_POLICY_FLAG_DIRECT_KEY);
479 err = init_essiv_generator(ci, raw_key, mode->keysize);
481 fscrypt_warn(inode->i_sb,
482 "error initializing ESSIV generator for inode %lu: %d",
490 static void put_crypt_info(struct fscrypt_info *ci)
495 if (ci->ci_master_key) {
496 put_master_key(ci->ci_master_key);
498 crypto_free_skcipher(ci->ci_ctfm);
499 crypto_free_cipher(ci->ci_essiv_tfm);
501 kmem_cache_free(fscrypt_info_cachep, ci);
504 int fscrypt_get_encryption_info(struct inode *inode)
506 struct fscrypt_info *crypt_info;
507 struct fscrypt_context ctx;
508 struct fscrypt_mode *mode;
512 if (inode->i_crypt_info)
515 res = fscrypt_initialize(inode->i_sb->s_cop->flags);
519 res = inode->i_sb->s_cop->get_context(inode, &ctx, sizeof(ctx));
521 if (!fscrypt_dummy_context_enabled(inode) ||
524 /* Fake up a context for an unencrypted directory */
525 memset(&ctx, 0, sizeof(ctx));
526 ctx.format = FS_ENCRYPTION_CONTEXT_FORMAT_V1;
527 ctx.contents_encryption_mode = FS_ENCRYPTION_MODE_AES_256_XTS;
528 ctx.filenames_encryption_mode = FS_ENCRYPTION_MODE_AES_256_CTS;
529 memset(ctx.master_key_descriptor, 0x42, FS_KEY_DESCRIPTOR_SIZE);
530 } else if (res != sizeof(ctx)) {
534 if (ctx.format != FS_ENCRYPTION_CONTEXT_FORMAT_V1)
537 if (ctx.flags & ~FS_POLICY_FLAGS_VALID)
540 crypt_info = kmem_cache_zalloc(fscrypt_info_cachep, GFP_NOFS);
544 crypt_info->ci_flags = ctx.flags;
545 crypt_info->ci_data_mode = ctx.contents_encryption_mode;
546 crypt_info->ci_filename_mode = ctx.filenames_encryption_mode;
547 memcpy(crypt_info->ci_master_key_descriptor, ctx.master_key_descriptor,
548 FS_KEY_DESCRIPTOR_SIZE);
549 memcpy(crypt_info->ci_nonce, ctx.nonce, FS_KEY_DERIVATION_NONCE_SIZE);
551 mode = select_encryption_mode(crypt_info, inode);
556 WARN_ON(mode->ivsize > FSCRYPT_MAX_IV_SIZE);
557 crypt_info->ci_mode = mode;
560 * This cannot be a stack buffer because it may be passed to the
561 * scatterlist crypto API as part of key derivation.
564 raw_key = kmalloc(mode->keysize, GFP_NOFS);
568 res = find_and_derive_key(inode, &ctx, raw_key, mode);
572 res = setup_crypto_transform(crypt_info, mode, raw_key, inode);
576 if (cmpxchg(&inode->i_crypt_info, NULL, crypt_info) == NULL)
581 put_crypt_info(crypt_info);
585 EXPORT_SYMBOL(fscrypt_get_encryption_info);
587 void fscrypt_put_encryption_info(struct inode *inode)
589 put_crypt_info(inode->i_crypt_info);
590 inode->i_crypt_info = NULL;
592 EXPORT_SYMBOL(fscrypt_put_encryption_info);