2 * key management facility for FS encryption support.
4 * Copyright (C) 2015, Google, Inc.
6 * This contains encryption key functions.
8 * Written by Michael Halcrow, Ildar Muslukhov, and Uday Savagaonkar, 2015.
11 #include <keys/user-type.h>
12 #include <linux/scatterlist.h>
13 #include "fscrypt_private.h"
15 static void derive_crypt_complete(struct crypto_async_request *req, int rc)
17 struct fscrypt_completion_result *ecr = req->data;
19 if (rc == -EINPROGRESS)
23 complete(&ecr->completion);
27 * derive_key_aes() - Derive a key using AES-128-ECB
28 * @deriving_key: Encryption key used for derivation.
29 * @source_key: Source key to which to apply derivation.
30 * @derived_key: Derived key.
32 * Return: Zero on success; non-zero otherwise.
34 static int derive_key_aes(u8 deriving_key[FS_AES_128_ECB_KEY_SIZE],
35 u8 source_key[FS_AES_256_XTS_KEY_SIZE],
36 u8 derived_key[FS_AES_256_XTS_KEY_SIZE])
39 struct skcipher_request *req = NULL;
40 DECLARE_FS_COMPLETION_RESULT(ecr);
41 struct scatterlist src_sg, dst_sg;
42 struct crypto_skcipher *tfm = crypto_alloc_skcipher("ecb(aes)", 0, 0);
49 crypto_skcipher_set_flags(tfm, CRYPTO_TFM_REQ_WEAK_KEY);
50 req = skcipher_request_alloc(tfm, GFP_NOFS);
55 skcipher_request_set_callback(req,
56 CRYPTO_TFM_REQ_MAY_BACKLOG | CRYPTO_TFM_REQ_MAY_SLEEP,
57 derive_crypt_complete, &ecr);
58 res = crypto_skcipher_setkey(tfm, deriving_key,
59 FS_AES_128_ECB_KEY_SIZE);
63 sg_init_one(&src_sg, source_key, FS_AES_256_XTS_KEY_SIZE);
64 sg_init_one(&dst_sg, derived_key, FS_AES_256_XTS_KEY_SIZE);
65 skcipher_request_set_crypt(req, &src_sg, &dst_sg,
66 FS_AES_256_XTS_KEY_SIZE, NULL);
67 res = crypto_skcipher_encrypt(req);
68 if (res == -EINPROGRESS || res == -EBUSY) {
69 wait_for_completion(&ecr.completion);
73 skcipher_request_free(req);
74 crypto_free_skcipher(tfm);
78 static int validate_user_key(struct fscrypt_info *crypt_info,
79 struct fscrypt_context *ctx, u8 *raw_key,
83 struct key *keyring_key;
84 struct fscrypt_key *master_key;
85 const struct user_key_payload *ukp;
88 description = kasprintf(GFP_NOFS, "%s%*phN", prefix,
89 FS_KEY_DESCRIPTOR_SIZE,
90 ctx->master_key_descriptor);
94 keyring_key = request_key(&key_type_logon, description, NULL);
96 if (IS_ERR(keyring_key))
97 return PTR_ERR(keyring_key);
99 if (keyring_key->type != &key_type_logon) {
100 printk_once(KERN_WARNING
101 "%s: key type must be logon\n", __func__);
105 down_read(&keyring_key->sem);
106 ukp = user_key_payload_locked(keyring_key);
107 if (ukp->datalen != sizeof(struct fscrypt_key)) {
109 up_read(&keyring_key->sem);
112 master_key = (struct fscrypt_key *)ukp->data;
113 BUILD_BUG_ON(FS_AES_128_ECB_KEY_SIZE != FS_KEY_DERIVATION_NONCE_SIZE);
115 if (master_key->size != FS_AES_256_XTS_KEY_SIZE) {
116 printk_once(KERN_WARNING
117 "%s: key size incorrect: %d\n",
118 __func__, master_key->size);
120 up_read(&keyring_key->sem);
123 res = derive_key_aes(ctx->nonce, master_key->raw, raw_key);
124 up_read(&keyring_key->sem);
128 crypt_info->ci_keyring_key = keyring_key;
131 key_put(keyring_key);
135 static int determine_cipher_type(struct fscrypt_info *ci, struct inode *inode,
136 const char **cipher_str_ret, int *keysize_ret)
138 if (S_ISREG(inode->i_mode)) {
139 if (ci->ci_data_mode == FS_ENCRYPTION_MODE_AES_256_XTS) {
140 *cipher_str_ret = "xts(aes)";
141 *keysize_ret = FS_AES_256_XTS_KEY_SIZE;
144 pr_warn_once("fscrypto: unsupported contents encryption mode "
145 "%d for inode %lu\n",
146 ci->ci_data_mode, inode->i_ino);
150 if (S_ISDIR(inode->i_mode) || S_ISLNK(inode->i_mode)) {
151 if (ci->ci_filename_mode == FS_ENCRYPTION_MODE_AES_256_CTS) {
152 *cipher_str_ret = "cts(cbc(aes))";
153 *keysize_ret = FS_AES_256_CTS_KEY_SIZE;
156 pr_warn_once("fscrypto: unsupported filenames encryption mode "
157 "%d for inode %lu\n",
158 ci->ci_filename_mode, inode->i_ino);
162 pr_warn_once("fscrypto: unsupported file type %d for inode %lu\n",
163 (inode->i_mode & S_IFMT), inode->i_ino);
167 static void put_crypt_info(struct fscrypt_info *ci)
172 key_put(ci->ci_keyring_key);
173 crypto_free_skcipher(ci->ci_ctfm);
174 kmem_cache_free(fscrypt_info_cachep, ci);
177 int fscrypt_get_crypt_info(struct inode *inode)
179 struct fscrypt_info *crypt_info;
180 struct fscrypt_context ctx;
181 struct crypto_skcipher *ctfm;
182 const char *cipher_str;
187 res = fscrypt_initialize(inode->i_sb->s_cop->flags);
191 if (!inode->i_sb->s_cop->get_context)
194 crypt_info = ACCESS_ONCE(inode->i_crypt_info);
196 if (!crypt_info->ci_keyring_key ||
197 key_validate(crypt_info->ci_keyring_key) == 0)
199 fscrypt_put_encryption_info(inode, crypt_info);
203 res = inode->i_sb->s_cop->get_context(inode, &ctx, sizeof(ctx));
205 if (!fscrypt_dummy_context_enabled(inode) ||
206 inode->i_sb->s_cop->is_encrypted(inode))
208 /* Fake up a context for an unencrypted directory */
209 memset(&ctx, 0, sizeof(ctx));
210 ctx.format = FS_ENCRYPTION_CONTEXT_FORMAT_V1;
211 ctx.contents_encryption_mode = FS_ENCRYPTION_MODE_AES_256_XTS;
212 ctx.filenames_encryption_mode = FS_ENCRYPTION_MODE_AES_256_CTS;
213 memset(ctx.master_key_descriptor, 0x42, FS_KEY_DESCRIPTOR_SIZE);
214 } else if (res != sizeof(ctx)) {
218 if (ctx.format != FS_ENCRYPTION_CONTEXT_FORMAT_V1)
221 if (ctx.flags & ~FS_POLICY_FLAGS_VALID)
224 crypt_info = kmem_cache_alloc(fscrypt_info_cachep, GFP_NOFS);
228 crypt_info->ci_flags = ctx.flags;
229 crypt_info->ci_data_mode = ctx.contents_encryption_mode;
230 crypt_info->ci_filename_mode = ctx.filenames_encryption_mode;
231 crypt_info->ci_ctfm = NULL;
232 crypt_info->ci_keyring_key = NULL;
233 memcpy(crypt_info->ci_master_key, ctx.master_key_descriptor,
234 sizeof(crypt_info->ci_master_key));
236 res = determine_cipher_type(crypt_info, inode, &cipher_str, &keysize);
241 * This cannot be a stack buffer because it is passed to the scatterlist
242 * crypto API as part of key derivation.
245 raw_key = kmalloc(FS_MAX_KEY_SIZE, GFP_NOFS);
249 res = validate_user_key(crypt_info, &ctx, raw_key, FS_KEY_DESC_PREFIX);
250 if (res && inode->i_sb->s_cop->key_prefix) {
251 int res2 = validate_user_key(crypt_info, &ctx, raw_key,
252 inode->i_sb->s_cop->key_prefix);
261 ctfm = crypto_alloc_skcipher(cipher_str, 0, 0);
262 if (!ctfm || IS_ERR(ctfm)) {
263 res = ctfm ? PTR_ERR(ctfm) : -ENOMEM;
265 "%s: error %d (inode %u) allocating crypto tfm\n",
266 __func__, res, (unsigned) inode->i_ino);
269 crypt_info->ci_ctfm = ctfm;
270 crypto_skcipher_clear_flags(ctfm, ~0);
271 crypto_skcipher_set_flags(ctfm, CRYPTO_TFM_REQ_WEAK_KEY);
272 res = crypto_skcipher_setkey(ctfm, raw_key, keysize);
278 if (cmpxchg(&inode->i_crypt_info, NULL, crypt_info) != NULL) {
279 put_crypt_info(crypt_info);
287 put_crypt_info(crypt_info);
292 void fscrypt_put_encryption_info(struct inode *inode, struct fscrypt_info *ci)
294 struct fscrypt_info *prev;
297 ci = ACCESS_ONCE(inode->i_crypt_info);
301 prev = cmpxchg(&inode->i_crypt_info, ci, NULL);
307 EXPORT_SYMBOL(fscrypt_put_encryption_info);
309 int fscrypt_get_encryption_info(struct inode *inode)
311 struct fscrypt_info *ci = inode->i_crypt_info;
314 (ci->ci_keyring_key &&
315 (ci->ci_keyring_key->flags & ((1 << KEY_FLAG_INVALIDATED) |
316 (1 << KEY_FLAG_REVOKED) |
317 (1 << KEY_FLAG_DEAD)))))
318 return fscrypt_get_crypt_info(inode);
321 EXPORT_SYMBOL(fscrypt_get_encryption_info);