1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2005-2010 IBM Corporation
6 * Mimi Zohar <zohar@us.ibm.com>
7 * Kylene Hall <kjhall@us.ibm.com>
10 * Using root's kernel master key (kmk), calculate the HMAC
13 #define pr_fmt(fmt) "EVM: "fmt
15 #include <linux/export.h>
16 #include <linux/crypto.h>
17 #include <linux/xattr.h>
18 #include <linux/evm.h>
19 #include <keys/encrypted-type.h>
20 #include <crypto/hash.h>
21 #include <crypto/hash_info.h>
24 #define EVMKEY "evm-key"
25 #define MAX_KEY_SIZE 128
26 static unsigned char evmkey[MAX_KEY_SIZE];
27 static const int evmkey_len = MAX_KEY_SIZE;
29 static struct crypto_shash *hmac_tfm;
30 static struct crypto_shash *evm_tfm[HASH_ALGO__LAST];
32 static DEFINE_MUTEX(mutex);
34 #define EVM_SET_KEY_BUSY 0
36 static unsigned long evm_set_key_flags;
38 static const char evm_hmac[] = "hmac(sha1)";
41 * evm_set_key() - set EVM HMAC key from the kernel
42 * @key: pointer to a buffer with the key data
43 * @keylen: length of the key data
45 * This function allows setting the EVM HMAC key from the kernel
46 * without using the "encrypted" key subsystem keys. It can be used
47 * by the crypto HW kernel module which has its own way of managing
50 * key length should be between 32 and 128 bytes long
52 int evm_set_key(void *key, size_t keylen)
57 if (test_and_set_bit(EVM_SET_KEY_BUSY, &evm_set_key_flags))
60 if (keylen > MAX_KEY_SIZE)
62 memcpy(evmkey, key, keylen);
63 evm_initialized |= EVM_INIT_HMAC;
64 pr_info("key initialized\n");
67 clear_bit(EVM_SET_KEY_BUSY, &evm_set_key_flags);
69 pr_err("key initialization failed\n");
72 EXPORT_SYMBOL_GPL(evm_set_key);
74 static struct shash_desc *init_desc(char type, uint8_t hash_algo)
78 struct crypto_shash **tfm, *tmp_tfm;
79 struct shash_desc *desc;
81 if (type == EVM_XATTR_HMAC) {
82 if (!(evm_initialized & EVM_INIT_HMAC)) {
83 pr_err_once("HMAC key is not set\n");
84 return ERR_PTR(-ENOKEY);
89 if (hash_algo >= HASH_ALGO__LAST)
90 return ERR_PTR(-EINVAL);
92 tfm = &evm_tfm[hash_algo];
93 algo = hash_algo_name[hash_algo];
102 tmp_tfm = crypto_alloc_shash(algo, 0, CRYPTO_NOLOAD);
103 if (IS_ERR(tmp_tfm)) {
104 pr_err("Can not allocate %s (reason: %ld)\n", algo,
106 mutex_unlock(&mutex);
107 return ERR_CAST(tmp_tfm);
109 if (type == EVM_XATTR_HMAC) {
110 rc = crypto_shash_setkey(tmp_tfm, evmkey, evmkey_len);
112 crypto_free_shash(tmp_tfm);
113 mutex_unlock(&mutex);
119 mutex_unlock(&mutex);
121 desc = kmalloc(sizeof(*desc) + crypto_shash_descsize(*tfm),
124 return ERR_PTR(-ENOMEM);
128 rc = crypto_shash_init(desc);
136 /* Protect against 'cutting & pasting' security.evm xattr, include inode
139 * (Additional directory/file metadata needs to be added for more complete
142 static void hmac_add_misc(struct shash_desc *desc, struct inode *inode,
143 char type, char *digest)
153 memset(&hmac_misc, 0, sizeof(hmac_misc));
154 /* Don't include the inode or generation number in portable
157 if (type != EVM_XATTR_PORTABLE_DIGSIG) {
158 hmac_misc.ino = inode->i_ino;
159 hmac_misc.generation = inode->i_generation;
161 /* The hmac uid and gid must be encoded in the initial user
162 * namespace (not the filesystems user namespace) as encoding
163 * them in the filesystems user namespace allows an attack
164 * where first they are written in an unprivileged fuse mount
165 * of a filesystem and then the system is tricked to mount the
166 * filesystem for real on next boot and trust it because
167 * everything is signed.
169 hmac_misc.uid = from_kuid(&init_user_ns, inode->i_uid);
170 hmac_misc.gid = from_kgid(&init_user_ns, inode->i_gid);
171 hmac_misc.mode = inode->i_mode;
172 crypto_shash_update(desc, (const u8 *)&hmac_misc, sizeof(hmac_misc));
173 if ((evm_hmac_attrs & EVM_ATTR_FSUUID) &&
174 type != EVM_XATTR_PORTABLE_DIGSIG)
175 crypto_shash_update(desc, (u8 *)&inode->i_sb->s_uuid, UUID_SIZE);
176 crypto_shash_final(desc, digest);
178 pr_debug("hmac_misc: (%zu) [%*phN]\n", sizeof(struct h_misc),
179 (int)sizeof(struct h_misc), &hmac_misc);
183 * Dump large security xattr values as a continuous ascii hexademical string.
184 * (pr_debug is limited to 64 bytes.)
186 static void dump_security_xattr_l(const char *prefix, const void *src,
189 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
192 p = asciihex = kmalloc(count * 2 + 1, GFP_KERNEL);
196 p = bin2hex(p, src, count);
198 pr_debug("%s: (%zu) %.*s\n", prefix, count, (int)count * 2, asciihex);
203 static void dump_security_xattr(const char *name, const char *value,
207 pr_debug("%s: (%zu) [%*phN]\n", name, value_len,
208 (int)value_len, value);
210 dump_security_xattr_l(name, value, value_len);
214 * Calculate the HMAC value across the set of protected security xattrs.
216 * Instead of retrieving the requested xattr, for performance, calculate
217 * the hmac using the requested xattr value. Don't alloc/free memory for
218 * each xattr, but attempt to re-use the previously allocated memory.
220 static int evm_calc_hmac_or_hash(struct dentry *dentry,
221 const char *req_xattr_name,
222 const char *req_xattr_value,
223 size_t req_xattr_value_len,
224 uint8_t type, struct evm_digest *data)
226 struct inode *inode = d_backing_inode(dentry);
227 struct xattr_list *xattr;
228 struct shash_desc *desc;
229 size_t xattr_size = 0;
230 char *xattr_value = NULL;
232 int size, user_space_size;
233 bool ima_present = false;
235 if (!(inode->i_opflags & IOP_XATTR) ||
236 inode->i_sb->s_user_ns != &init_user_ns)
239 desc = init_desc(type, data->hdr.algo);
241 return PTR_ERR(desc);
243 data->hdr.length = crypto_shash_digestsize(desc->tfm);
246 list_for_each_entry_lockless(xattr, &evm_config_xattrnames, list) {
249 if (strcmp(xattr->name, XATTR_NAME_IMA) == 0)
253 * Skip non-enabled xattrs for locally calculated
256 if (type != EVM_XATTR_PORTABLE_DIGSIG && !xattr->enabled)
259 if ((req_xattr_name && req_xattr_value)
260 && !strcmp(xattr->name, req_xattr_name)) {
262 crypto_shash_update(desc, (const u8 *)req_xattr_value,
263 req_xattr_value_len);
267 dump_security_xattr(req_xattr_name,
269 req_xattr_value_len);
272 size = vfs_getxattr_alloc(&nop_mnt_idmap, dentry, xattr->name,
273 &xattr_value, xattr_size, GFP_NOFS);
274 if (size == -ENOMEM) {
281 user_space_size = vfs_getxattr(&nop_mnt_idmap, dentry,
282 xattr->name, NULL, 0);
283 if (user_space_size != size)
284 pr_debug("file %s: xattr %s size mismatch (kernel: %d, user: %d)\n",
285 dentry->d_name.name, xattr->name, size,
289 crypto_shash_update(desc, (const u8 *)xattr_value, xattr_size);
293 dump_security_xattr(xattr->name, xattr_value, xattr_size);
295 hmac_add_misc(desc, inode, type, data->digest);
297 /* Portable EVM signatures must include an IMA hash */
298 if (type == EVM_XATTR_PORTABLE_DIGSIG && !ima_present)
306 int evm_calc_hmac(struct dentry *dentry, const char *req_xattr_name,
307 const char *req_xattr_value, size_t req_xattr_value_len,
308 struct evm_digest *data)
310 return evm_calc_hmac_or_hash(dentry, req_xattr_name, req_xattr_value,
311 req_xattr_value_len, EVM_XATTR_HMAC, data);
314 int evm_calc_hash(struct dentry *dentry, const char *req_xattr_name,
315 const char *req_xattr_value, size_t req_xattr_value_len,
316 char type, struct evm_digest *data)
318 return evm_calc_hmac_or_hash(dentry, req_xattr_name, req_xattr_value,
319 req_xattr_value_len, type, data);
322 static int evm_is_immutable(struct dentry *dentry, struct inode *inode)
324 const struct evm_ima_xattr_data *xattr_data = NULL;
325 struct evm_iint_cache *iint;
328 iint = evm_iint_inode(inode);
329 if (iint && (iint->flags & EVM_IMMUTABLE_DIGSIG))
332 /* Do this the hard way */
333 rc = vfs_getxattr_alloc(&nop_mnt_idmap, dentry, XATTR_NAME_EVM,
334 (char **)&xattr_data, 0, GFP_NOFS);
340 if (xattr_data->type == EVM_XATTR_PORTABLE_DIGSIG)
352 * Calculate the hmac and update security.evm xattr
354 * Expects to be called with i_mutex locked.
356 int evm_update_evmxattr(struct dentry *dentry, const char *xattr_name,
357 const char *xattr_value, size_t xattr_value_len)
359 struct inode *inode = d_backing_inode(dentry);
360 struct evm_digest data;
364 * Don't permit any transformation of the EVM xattr if the signature
365 * is of an immutable type
367 rc = evm_is_immutable(dentry, inode);
373 data.hdr.algo = HASH_ALGO_SHA1;
374 rc = evm_calc_hmac(dentry, xattr_name, xattr_value,
375 xattr_value_len, &data);
377 data.hdr.xattr.sha1.type = EVM_XATTR_HMAC;
378 rc = __vfs_setxattr_noperm(&nop_mnt_idmap, dentry,
380 &data.hdr.xattr.data[1],
381 SHA1_DIGEST_SIZE + 1, 0);
382 } else if (rc == -ENODATA && (inode->i_opflags & IOP_XATTR)) {
383 rc = __vfs_removexattr(&nop_mnt_idmap, dentry, XATTR_NAME_EVM);
388 int evm_init_hmac(struct inode *inode, const struct xattr *xattrs,
391 struct shash_desc *desc;
392 const struct xattr *xattr;
394 desc = init_desc(EVM_XATTR_HMAC, HASH_ALGO_SHA1);
396 pr_info("init_desc failed\n");
397 return PTR_ERR(desc);
400 for (xattr = xattrs; xattr->name; xattr++) {
401 if (!evm_protected_xattr(xattr->name))
404 crypto_shash_update(desc, xattr->value, xattr->value_len);
407 hmac_add_misc(desc, inode, EVM_XATTR_HMAC, hmac_val);
413 * Get the key from the TPM for the SHA1-HMAC
415 int evm_init_key(void)
418 struct encrypted_key_payload *ekp;
421 evm_key = request_key(&key_type_encrypted, EVMKEY, NULL);
425 down_read(&evm_key->sem);
426 ekp = evm_key->payload.data[0];
428 rc = evm_set_key(ekp->decrypted_data, ekp->decrypted_datalen);
430 /* burn the original key contents */
431 memset(ekp->decrypted_data, 0, ekp->decrypted_datalen);
432 up_read(&evm_key->sem);