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 * implements evm_inode_setxattr, evm_inode_post_setxattr,
11 * evm_inode_removexattr, and evm_verifyxattr
14 #include <linux/init.h>
15 #include <linux/crypto.h>
16 #include <linux/audit.h>
17 #include <linux/xattr.h>
18 #include <linux/integrity.h>
19 #include <linux/evm.h>
20 #include <linux/magic.h>
22 #include <crypto/hash.h>
23 #include <crypto/hash_info.h>
24 #include <crypto/algapi.h>
29 static const char * const integrity_status_msg[] = {
30 "pass", "pass_immutable", "fail", "no_label", "no_xattrs", "unknown"
34 static struct xattr_list evm_config_default_xattrnames[] = {
35 #ifdef CONFIG_SECURITY_SELINUX
36 {.name = XATTR_NAME_SELINUX},
38 #ifdef CONFIG_SECURITY_SMACK
39 {.name = XATTR_NAME_SMACK},
40 #ifdef CONFIG_EVM_EXTRA_SMACK_XATTRS
41 {.name = XATTR_NAME_SMACKEXEC},
42 {.name = XATTR_NAME_SMACKTRANSMUTE},
43 {.name = XATTR_NAME_SMACKMMAP},
46 #ifdef CONFIG_SECURITY_APPARMOR
47 {.name = XATTR_NAME_APPARMOR},
49 #ifdef CONFIG_IMA_APPRAISE
50 {.name = XATTR_NAME_IMA},
52 {.name = XATTR_NAME_CAPS},
55 LIST_HEAD(evm_config_xattrnames);
57 static int evm_fixmode __ro_after_init;
58 static int __init evm_set_fixmode(char *str)
60 if (strncmp(str, "fix", 3) == 0)
63 pr_err("invalid \"%s\" mode", str);
67 __setup("evm=", evm_set_fixmode);
69 static void __init evm_init_config(void)
73 xattrs = ARRAY_SIZE(evm_config_default_xattrnames);
75 pr_info("Initialising EVM extended attributes:\n");
76 for (i = 0; i < xattrs; i++) {
77 pr_info("%s\n", evm_config_default_xattrnames[i].name);
78 list_add_tail(&evm_config_default_xattrnames[i].list,
79 &evm_config_xattrnames);
82 #ifdef CONFIG_EVM_ATTR_FSUUID
83 evm_hmac_attrs |= EVM_ATTR_FSUUID;
85 pr_info("HMAC attrs: 0x%x\n", evm_hmac_attrs);
88 static bool evm_key_loaded(void)
90 return (bool)(evm_initialized & EVM_KEY_MASK);
93 static int evm_find_protected_xattrs(struct dentry *dentry)
95 struct inode *inode = d_backing_inode(dentry);
96 struct xattr_list *xattr;
100 if (!(inode->i_opflags & IOP_XATTR))
103 list_for_each_entry_lockless(xattr, &evm_config_xattrnames, list) {
104 error = __vfs_getxattr(dentry, inode, xattr->name, NULL, 0);
106 if (error == -ENODATA)
117 * evm_verify_hmac - calculate and compare the HMAC with the EVM xattr
119 * Compute the HMAC on the dentry's protected set of extended attributes
120 * and compare it against the stored security.evm xattr.
123 * - use the previoulsy retrieved xattr value and length to calculate the
125 * - cache the verification result in the iint, when available.
127 * Returns integrity status
129 static enum integrity_status evm_verify_hmac(struct dentry *dentry,
130 const char *xattr_name,
132 size_t xattr_value_len,
133 struct integrity_iint_cache *iint)
135 struct evm_ima_xattr_data *xattr_data = NULL;
136 struct signature_v2_hdr *hdr;
137 enum integrity_status evm_status = INTEGRITY_PASS;
138 struct evm_digest digest;
142 if (iint && (iint->evm_status == INTEGRITY_PASS ||
143 iint->evm_status == INTEGRITY_PASS_IMMUTABLE))
144 return iint->evm_status;
146 /* if status is not PASS, try to check again - against -ENOMEM */
148 /* first need to know the sig type */
149 rc = vfs_getxattr_alloc(dentry, XATTR_NAME_EVM, (char **)&xattr_data, 0,
152 evm_status = INTEGRITY_FAIL;
153 if (rc == -ENODATA) {
154 rc = evm_find_protected_xattrs(dentry);
156 evm_status = INTEGRITY_NOLABEL;
158 evm_status = INTEGRITY_NOXATTRS; /* new file */
159 } else if (rc == -EOPNOTSUPP) {
160 evm_status = INTEGRITY_UNKNOWN;
167 /* check value type */
168 switch (xattr_data->type) {
170 if (xattr_len != sizeof(struct evm_xattr)) {
171 evm_status = INTEGRITY_FAIL;
175 digest.hdr.algo = HASH_ALGO_SHA1;
176 rc = evm_calc_hmac(dentry, xattr_name, xattr_value,
177 xattr_value_len, &digest);
180 rc = crypto_memneq(xattr_data->data, digest.digest,
185 case EVM_IMA_XATTR_DIGSIG:
186 case EVM_XATTR_PORTABLE_DIGSIG:
187 /* accept xattr with non-empty signature field */
188 if (xattr_len <= sizeof(struct signature_v2_hdr)) {
189 evm_status = INTEGRITY_FAIL;
193 hdr = (struct signature_v2_hdr *)xattr_data;
194 digest.hdr.algo = hdr->hash_algo;
195 rc = evm_calc_hash(dentry, xattr_name, xattr_value,
196 xattr_value_len, xattr_data->type, &digest);
199 rc = integrity_digsig_verify(INTEGRITY_KEYRING_EVM,
200 (const char *)xattr_data, xattr_len,
201 digest.digest, digest.hdr.length);
203 inode = d_backing_inode(dentry);
205 if (xattr_data->type == EVM_XATTR_PORTABLE_DIGSIG) {
207 iint->flags |= EVM_IMMUTABLE_DIGSIG;
208 evm_status = INTEGRITY_PASS_IMMUTABLE;
209 } else if (!IS_RDONLY(inode) &&
210 !(inode->i_sb->s_readonly_remount) &&
211 !IS_IMMUTABLE(inode)) {
212 evm_update_evmxattr(dentry, xattr_name,
224 evm_status = (rc == -ENODATA) ?
225 INTEGRITY_NOXATTRS : INTEGRITY_FAIL;
228 iint->evm_status = evm_status;
233 static int evm_protected_xattr(const char *req_xattr_name)
237 struct xattr_list *xattr;
239 namelen = strlen(req_xattr_name);
240 list_for_each_entry_lockless(xattr, &evm_config_xattrnames, list) {
241 if ((strlen(xattr->name) == namelen)
242 && (strncmp(req_xattr_name, xattr->name, namelen) == 0)) {
246 if (strncmp(req_xattr_name,
247 xattr->name + XATTR_SECURITY_PREFIX_LEN,
248 strlen(req_xattr_name)) == 0) {
258 * evm_verifyxattr - verify the integrity of the requested xattr
259 * @dentry: object of the verify xattr
260 * @xattr_name: requested xattr
261 * @xattr_value: requested xattr value
262 * @xattr_value_len: requested xattr value length
264 * Calculate the HMAC for the given dentry and verify it against the stored
265 * security.evm xattr. For performance, use the xattr value and length
266 * previously retrieved to calculate the HMAC.
268 * Returns the xattr integrity status.
270 * This function requires the caller to lock the inode's i_mutex before it
273 enum integrity_status evm_verifyxattr(struct dentry *dentry,
274 const char *xattr_name,
275 void *xattr_value, size_t xattr_value_len,
276 struct integrity_iint_cache *iint)
278 if (!evm_key_loaded() || !evm_protected_xattr(xattr_name))
279 return INTEGRITY_UNKNOWN;
282 iint = integrity_iint_find(d_backing_inode(dentry));
284 return INTEGRITY_UNKNOWN;
286 return evm_verify_hmac(dentry, xattr_name, xattr_value,
287 xattr_value_len, iint);
289 EXPORT_SYMBOL_GPL(evm_verifyxattr);
292 * evm_verify_current_integrity - verify the dentry's metadata integrity
293 * @dentry: pointer to the affected dentry
295 * Verify and return the dentry's metadata integrity. The exceptions are
296 * before EVM is initialized or in 'fix' mode.
298 static enum integrity_status evm_verify_current_integrity(struct dentry *dentry)
300 struct inode *inode = d_backing_inode(dentry);
302 if (!evm_key_loaded() || !S_ISREG(inode->i_mode) || evm_fixmode)
304 return evm_verify_hmac(dentry, NULL, NULL, 0, NULL);
308 * evm_protect_xattr - protect the EVM extended attribute
310 * Prevent security.evm from being modified or removed without the
311 * necessary permissions or when the existing value is invalid.
313 * The posix xattr acls are 'system' prefixed, which normally would not
314 * affect security.evm. An interesting side affect of writing posix xattr
315 * acls is their modifying of the i_mode, which is included in security.evm.
316 * For posix xattr acls only, permit security.evm, even if it currently
317 * doesn't exist, to be updated unless the EVM signature is immutable.
319 static int evm_protect_xattr(struct dentry *dentry, const char *xattr_name,
320 const void *xattr_value, size_t xattr_value_len)
322 enum integrity_status evm_status;
324 if (strcmp(xattr_name, XATTR_NAME_EVM) == 0) {
325 if (!capable(CAP_SYS_ADMIN))
327 } else if (!evm_protected_xattr(xattr_name)) {
328 if (!posix_xattr_acl(xattr_name))
330 evm_status = evm_verify_current_integrity(dentry);
331 if ((evm_status == INTEGRITY_PASS) ||
332 (evm_status == INTEGRITY_NOXATTRS))
337 evm_status = evm_verify_current_integrity(dentry);
338 if (evm_status == INTEGRITY_NOXATTRS) {
339 struct integrity_iint_cache *iint;
341 iint = integrity_iint_find(d_backing_inode(dentry));
342 if (iint && (iint->flags & IMA_NEW_FILE))
345 /* exception for pseudo filesystems */
346 if (dentry->d_sb->s_magic == TMPFS_MAGIC
347 || dentry->d_sb->s_magic == SYSFS_MAGIC)
350 integrity_audit_msg(AUDIT_INTEGRITY_METADATA,
351 dentry->d_inode, dentry->d_name.name,
353 integrity_status_msg[evm_status],
357 if (evm_status != INTEGRITY_PASS)
358 integrity_audit_msg(AUDIT_INTEGRITY_METADATA, d_backing_inode(dentry),
359 dentry->d_name.name, "appraise_metadata",
360 integrity_status_msg[evm_status],
362 return evm_status == INTEGRITY_PASS ? 0 : -EPERM;
366 * evm_inode_setxattr - protect the EVM extended attribute
367 * @dentry: pointer to the affected dentry
368 * @xattr_name: pointer to the affected extended attribute name
369 * @xattr_value: pointer to the new extended attribute value
370 * @xattr_value_len: pointer to the new extended attribute value length
372 * Before allowing the 'security.evm' protected xattr to be updated,
373 * verify the existing value is valid. As only the kernel should have
374 * access to the EVM encrypted key needed to calculate the HMAC, prevent
375 * userspace from writing HMAC value. Writing 'security.evm' requires
376 * requires CAP_SYS_ADMIN privileges.
378 int evm_inode_setxattr(struct dentry *dentry, const char *xattr_name,
379 const void *xattr_value, size_t xattr_value_len)
381 const struct evm_ima_xattr_data *xattr_data = xattr_value;
383 /* Policy permits modification of the protected xattrs even though
384 * there's no HMAC key loaded
386 if (evm_initialized & EVM_ALLOW_METADATA_WRITES)
389 if (strcmp(xattr_name, XATTR_NAME_EVM) == 0) {
390 if (!xattr_value_len)
392 if (xattr_data->type != EVM_IMA_XATTR_DIGSIG &&
393 xattr_data->type != EVM_XATTR_PORTABLE_DIGSIG)
396 return evm_protect_xattr(dentry, xattr_name, xattr_value,
401 * evm_inode_removexattr - protect the EVM extended attribute
402 * @dentry: pointer to the affected dentry
403 * @xattr_name: pointer to the affected extended attribute name
405 * Removing 'security.evm' requires CAP_SYS_ADMIN privileges and that
406 * the current value is valid.
408 int evm_inode_removexattr(struct dentry *dentry, const char *xattr_name)
410 /* Policy permits modification of the protected xattrs even though
411 * there's no HMAC key loaded
413 if (evm_initialized & EVM_ALLOW_METADATA_WRITES)
416 return evm_protect_xattr(dentry, xattr_name, NULL, 0);
419 static void evm_reset_status(struct inode *inode)
421 struct integrity_iint_cache *iint;
423 iint = integrity_iint_find(inode);
425 iint->evm_status = INTEGRITY_UNKNOWN;
429 * evm_inode_post_setxattr - update 'security.evm' to reflect the changes
430 * @dentry: pointer to the affected dentry
431 * @xattr_name: pointer to the affected extended attribute name
432 * @xattr_value: pointer to the new extended attribute value
433 * @xattr_value_len: pointer to the new extended attribute value length
435 * Update the HMAC stored in 'security.evm' to reflect the change.
437 * No need to take the i_mutex lock here, as this function is called from
438 * __vfs_setxattr_noperm(). The caller of which has taken the inode's
441 void evm_inode_post_setxattr(struct dentry *dentry, const char *xattr_name,
442 const void *xattr_value, size_t xattr_value_len)
444 if (!evm_key_loaded() || (!evm_protected_xattr(xattr_name)
445 && !posix_xattr_acl(xattr_name)))
448 evm_reset_status(dentry->d_inode);
450 evm_update_evmxattr(dentry, xattr_name, xattr_value, xattr_value_len);
454 * evm_inode_post_removexattr - update 'security.evm' after removing the xattr
455 * @dentry: pointer to the affected dentry
456 * @xattr_name: pointer to the affected extended attribute name
458 * Update the HMAC stored in 'security.evm' to reflect removal of the xattr.
460 * No need to take the i_mutex lock here, as this function is called from
461 * vfs_removexattr() which takes the i_mutex.
463 void evm_inode_post_removexattr(struct dentry *dentry, const char *xattr_name)
465 if (!evm_key_loaded() || !evm_protected_xattr(xattr_name))
468 evm_reset_status(dentry->d_inode);
470 evm_update_evmxattr(dentry, xattr_name, NULL, 0);
474 * evm_inode_setattr - prevent updating an invalid EVM extended attribute
475 * @dentry: pointer to the affected dentry
477 * Permit update of file attributes when files have a valid EVM signature,
478 * except in the case of them having an immutable portable signature.
480 int evm_inode_setattr(struct dentry *dentry, struct iattr *attr)
482 unsigned int ia_valid = attr->ia_valid;
483 enum integrity_status evm_status;
485 /* Policy permits modification of the protected attrs even though
486 * there's no HMAC key loaded
488 if (evm_initialized & EVM_ALLOW_METADATA_WRITES)
491 if (!(ia_valid & (ATTR_MODE | ATTR_UID | ATTR_GID)))
493 evm_status = evm_verify_current_integrity(dentry);
494 if ((evm_status == INTEGRITY_PASS) ||
495 (evm_status == INTEGRITY_NOXATTRS))
497 integrity_audit_msg(AUDIT_INTEGRITY_METADATA, d_backing_inode(dentry),
498 dentry->d_name.name, "appraise_metadata",
499 integrity_status_msg[evm_status], -EPERM, 0);
504 * evm_inode_post_setattr - update 'security.evm' after modifying metadata
505 * @dentry: pointer to the affected dentry
506 * @ia_valid: for the UID and GID status
508 * For now, update the HMAC stored in 'security.evm' to reflect UID/GID
511 * This function is called from notify_change(), which expects the caller
512 * to lock the inode's i_mutex.
514 void evm_inode_post_setattr(struct dentry *dentry, int ia_valid)
516 if (!evm_key_loaded())
519 if (ia_valid & (ATTR_MODE | ATTR_UID | ATTR_GID))
520 evm_update_evmxattr(dentry, NULL, NULL, 0);
524 * evm_inode_init_security - initializes security.evm HMAC value
526 int evm_inode_init_security(struct inode *inode,
527 const struct xattr *lsm_xattr,
528 struct xattr *evm_xattr)
530 struct evm_xattr *xattr_data;
533 if (!(evm_initialized & EVM_INIT_HMAC) ||
534 !evm_protected_xattr(lsm_xattr->name))
537 xattr_data = kzalloc(sizeof(*xattr_data), GFP_NOFS);
541 xattr_data->data.type = EVM_XATTR_HMAC;
542 rc = evm_init_hmac(inode, lsm_xattr, xattr_data->digest);
546 evm_xattr->value = xattr_data;
547 evm_xattr->value_len = sizeof(*xattr_data);
548 evm_xattr->name = XATTR_EVM_SUFFIX;
554 EXPORT_SYMBOL_GPL(evm_inode_init_security);
556 #ifdef CONFIG_EVM_LOAD_X509
557 void __init evm_load_x509(void)
561 rc = integrity_load_x509(INTEGRITY_KEYRING_EVM, CONFIG_EVM_X509_PATH);
563 evm_initialized |= EVM_INIT_X509;
567 static int __init init_evm(void)
570 struct list_head *pos, *q;
574 error = integrity_init_keyring(INTEGRITY_KEYRING_EVM);
578 error = evm_init_secfs();
580 pr_info("Error registering secfs\n");
586 if (!list_empty(&evm_config_xattrnames)) {
587 list_for_each_safe(pos, q, &evm_config_xattrnames)
595 late_initcall(init_evm);