2 * Copyright (C) 2005-2010 IBM Corporation
5 * Mimi Zohar <zohar@us.ibm.com>
6 * Kylene Hall <kjhall@us.ibm.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, version 2 of the License.
13 * implements evm_inode_setxattr, evm_inode_post_setxattr,
14 * evm_inode_removexattr, and evm_verifyxattr
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/module.h>
20 #include <linux/crypto.h>
21 #include <linux/audit.h>
22 #include <linux/xattr.h>
23 #include <linux/integrity.h>
24 #include <linux/evm.h>
25 #include <linux/magic.h>
27 #include <crypto/hash.h>
28 #include <crypto/algapi.h>
33 static char *integrity_status_msg
[] = {
34 "pass", "pass_immutable", "fail", "no_label", "no_xattrs", "unknown"
36 char *evm_hmac
= "hmac(sha1)";
37 char *evm_hash
= "sha1";
40 char *evm_config_xattrnames
[] = {
41 #ifdef CONFIG_SECURITY_SELINUX
44 #ifdef CONFIG_SECURITY_SMACK
46 #ifdef CONFIG_EVM_EXTRA_SMACK_XATTRS
48 XATTR_NAME_SMACKTRANSMUTE
,
52 #ifdef CONFIG_SECURITY_APPARMOR
55 #ifdef CONFIG_IMA_APPRAISE
62 static int evm_fixmode
;
63 static int __init
evm_set_fixmode(char *str
)
65 if (strncmp(str
, "fix", 3) == 0)
69 __setup("evm=", evm_set_fixmode
);
71 static void __init
evm_init_config(void)
73 #ifdef CONFIG_EVM_ATTR_FSUUID
74 evm_hmac_attrs
|= EVM_ATTR_FSUUID
;
76 pr_info("HMAC attrs: 0x%x\n", evm_hmac_attrs
);
79 static bool evm_key_loaded(void)
81 return (bool)(evm_initialized
& EVM_KEY_MASK
);
84 static int evm_find_protected_xattrs(struct dentry
*dentry
)
86 struct inode
*inode
= d_backing_inode(dentry
);
91 if (!(inode
->i_opflags
& IOP_XATTR
))
94 for (xattr
= evm_config_xattrnames
; *xattr
!= NULL
; xattr
++) {
95 error
= __vfs_getxattr(dentry
, inode
, *xattr
, NULL
, 0);
97 if (error
== -ENODATA
)
108 * evm_verify_hmac - calculate and compare the HMAC with the EVM xattr
110 * Compute the HMAC on the dentry's protected set of extended attributes
111 * and compare it against the stored security.evm xattr.
114 * - use the previoulsy retrieved xattr value and length to calculate the
116 * - cache the verification result in the iint, when available.
118 * Returns integrity status
120 static enum integrity_status
evm_verify_hmac(struct dentry
*dentry
,
121 const char *xattr_name
,
123 size_t xattr_value_len
,
124 struct integrity_iint_cache
*iint
)
126 struct evm_ima_xattr_data
*xattr_data
= NULL
;
127 struct evm_ima_xattr_data calc
;
128 enum integrity_status evm_status
= INTEGRITY_PASS
;
131 if (iint
&& (iint
->evm_status
== INTEGRITY_PASS
||
132 iint
->evm_status
== INTEGRITY_PASS_IMMUTABLE
))
133 return iint
->evm_status
;
135 /* if status is not PASS, try to check again - against -ENOMEM */
137 /* first need to know the sig type */
138 rc
= vfs_getxattr_alloc(dentry
, XATTR_NAME_EVM
, (char **)&xattr_data
, 0,
141 evm_status
= INTEGRITY_FAIL
;
142 if (rc
== -ENODATA
) {
143 rc
= evm_find_protected_xattrs(dentry
);
145 evm_status
= INTEGRITY_NOLABEL
;
147 evm_status
= INTEGRITY_NOXATTRS
; /* new file */
148 } else if (rc
== -EOPNOTSUPP
) {
149 evm_status
= INTEGRITY_UNKNOWN
;
156 /* check value type */
157 switch (xattr_data
->type
) {
159 if (xattr_len
!= sizeof(struct evm_ima_xattr_data
)) {
160 evm_status
= INTEGRITY_FAIL
;
163 rc
= evm_calc_hmac(dentry
, xattr_name
, xattr_value
,
164 xattr_value_len
, calc
.digest
);
167 rc
= crypto_memneq(xattr_data
->digest
, calc
.digest
,
168 sizeof(calc
.digest
));
172 case EVM_IMA_XATTR_DIGSIG
:
173 case EVM_XATTR_PORTABLE_DIGSIG
:
174 rc
= evm_calc_hash(dentry
, xattr_name
, xattr_value
,
175 xattr_value_len
, xattr_data
->type
,
179 rc
= integrity_digsig_verify(INTEGRITY_KEYRING_EVM
,
180 (const char *)xattr_data
, xattr_len
,
181 calc
.digest
, sizeof(calc
.digest
));
183 if (xattr_data
->type
== EVM_XATTR_PORTABLE_DIGSIG
) {
185 iint
->flags
|= EVM_IMMUTABLE_DIGSIG
;
186 evm_status
= INTEGRITY_PASS_IMMUTABLE
;
187 } else if (!IS_RDONLY(d_backing_inode(dentry
)) &&
188 !IS_IMMUTABLE(d_backing_inode(dentry
))) {
189 evm_update_evmxattr(dentry
, xattr_name
,
201 evm_status
= (rc
== -ENODATA
) ?
202 INTEGRITY_NOXATTRS
: INTEGRITY_FAIL
;
205 iint
->evm_status
= evm_status
;
210 static int evm_protected_xattr(const char *req_xattr_name
)
216 namelen
= strlen(req_xattr_name
);
217 for (xattrname
= evm_config_xattrnames
; *xattrname
!= NULL
; xattrname
++) {
218 if ((strlen(*xattrname
) == namelen
)
219 && (strncmp(req_xattr_name
, *xattrname
, namelen
) == 0)) {
223 if (strncmp(req_xattr_name
,
224 *xattrname
+ XATTR_SECURITY_PREFIX_LEN
,
225 strlen(req_xattr_name
)) == 0) {
234 * evm_verifyxattr - verify the integrity of the requested xattr
235 * @dentry: object of the verify xattr
236 * @xattr_name: requested xattr
237 * @xattr_value: requested xattr value
238 * @xattr_value_len: requested xattr value length
240 * Calculate the HMAC for the given dentry and verify it against the stored
241 * security.evm xattr. For performance, use the xattr value and length
242 * previously retrieved to calculate the HMAC.
244 * Returns the xattr integrity status.
246 * This function requires the caller to lock the inode's i_mutex before it
249 enum integrity_status
evm_verifyxattr(struct dentry
*dentry
,
250 const char *xattr_name
,
251 void *xattr_value
, size_t xattr_value_len
,
252 struct integrity_iint_cache
*iint
)
254 if (!evm_key_loaded() || !evm_protected_xattr(xattr_name
))
255 return INTEGRITY_UNKNOWN
;
258 iint
= integrity_iint_find(d_backing_inode(dentry
));
260 return INTEGRITY_UNKNOWN
;
262 return evm_verify_hmac(dentry
, xattr_name
, xattr_value
,
263 xattr_value_len
, iint
);
265 EXPORT_SYMBOL_GPL(evm_verifyxattr
);
268 * evm_verify_current_integrity - verify the dentry's metadata integrity
269 * @dentry: pointer to the affected dentry
271 * Verify and return the dentry's metadata integrity. The exceptions are
272 * before EVM is initialized or in 'fix' mode.
274 static enum integrity_status
evm_verify_current_integrity(struct dentry
*dentry
)
276 struct inode
*inode
= d_backing_inode(dentry
);
278 if (!evm_key_loaded() || !S_ISREG(inode
->i_mode
) || evm_fixmode
)
280 return evm_verify_hmac(dentry
, NULL
, NULL
, 0, NULL
);
284 * evm_protect_xattr - protect the EVM extended attribute
286 * Prevent security.evm from being modified or removed without the
287 * necessary permissions or when the existing value is invalid.
289 * The posix xattr acls are 'system' prefixed, which normally would not
290 * affect security.evm. An interesting side affect of writing posix xattr
291 * acls is their modifying of the i_mode, which is included in security.evm.
292 * For posix xattr acls only, permit security.evm, even if it currently
293 * doesn't exist, to be updated unless the EVM signature is immutable.
295 static int evm_protect_xattr(struct dentry
*dentry
, const char *xattr_name
,
296 const void *xattr_value
, size_t xattr_value_len
)
298 enum integrity_status evm_status
;
300 if (strcmp(xattr_name
, XATTR_NAME_EVM
) == 0) {
301 if (!capable(CAP_SYS_ADMIN
))
303 } else if (!evm_protected_xattr(xattr_name
)) {
304 if (!posix_xattr_acl(xattr_name
))
306 evm_status
= evm_verify_current_integrity(dentry
);
307 if ((evm_status
== INTEGRITY_PASS
) ||
308 (evm_status
== INTEGRITY_NOXATTRS
))
313 evm_status
= evm_verify_current_integrity(dentry
);
314 if (evm_status
== INTEGRITY_NOXATTRS
) {
315 struct integrity_iint_cache
*iint
;
317 iint
= integrity_iint_find(d_backing_inode(dentry
));
318 if (iint
&& (iint
->flags
& IMA_NEW_FILE
))
321 /* exception for pseudo filesystems */
322 if (dentry
->d_sb
->s_magic
== TMPFS_MAGIC
323 || dentry
->d_sb
->s_magic
== SYSFS_MAGIC
)
326 integrity_audit_msg(AUDIT_INTEGRITY_METADATA
,
327 dentry
->d_inode
, dentry
->d_name
.name
,
329 integrity_status_msg
[evm_status
],
333 if (evm_status
!= INTEGRITY_PASS
)
334 integrity_audit_msg(AUDIT_INTEGRITY_METADATA
, d_backing_inode(dentry
),
335 dentry
->d_name
.name
, "appraise_metadata",
336 integrity_status_msg
[evm_status
],
338 return evm_status
== INTEGRITY_PASS
? 0 : -EPERM
;
342 * evm_inode_setxattr - protect the EVM extended attribute
343 * @dentry: pointer to the affected dentry
344 * @xattr_name: pointer to the affected extended attribute name
345 * @xattr_value: pointer to the new extended attribute value
346 * @xattr_value_len: pointer to the new extended attribute value length
348 * Before allowing the 'security.evm' protected xattr to be updated,
349 * verify the existing value is valid. As only the kernel should have
350 * access to the EVM encrypted key needed to calculate the HMAC, prevent
351 * userspace from writing HMAC value. Writing 'security.evm' requires
352 * requires CAP_SYS_ADMIN privileges.
354 int evm_inode_setxattr(struct dentry
*dentry
, const char *xattr_name
,
355 const void *xattr_value
, size_t xattr_value_len
)
357 const struct evm_ima_xattr_data
*xattr_data
= xattr_value
;
359 /* Policy permits modification of the protected xattrs even though
360 * there's no HMAC key loaded
362 if (evm_initialized
& EVM_ALLOW_METADATA_WRITES
)
365 if (strcmp(xattr_name
, XATTR_NAME_EVM
) == 0) {
366 if (!xattr_value_len
)
368 if (xattr_data
->type
!= EVM_IMA_XATTR_DIGSIG
&&
369 xattr_data
->type
!= EVM_XATTR_PORTABLE_DIGSIG
)
372 return evm_protect_xattr(dentry
, xattr_name
, xattr_value
,
377 * evm_inode_removexattr - protect the EVM extended attribute
378 * @dentry: pointer to the affected dentry
379 * @xattr_name: pointer to the affected extended attribute name
381 * Removing 'security.evm' requires CAP_SYS_ADMIN privileges and that
382 * the current value is valid.
384 int evm_inode_removexattr(struct dentry
*dentry
, const char *xattr_name
)
386 /* Policy permits modification of the protected xattrs even though
387 * there's no HMAC key loaded
389 if (evm_initialized
& EVM_ALLOW_METADATA_WRITES
)
392 return evm_protect_xattr(dentry
, xattr_name
, NULL
, 0);
395 static void evm_reset_status(struct inode
*inode
)
397 struct integrity_iint_cache
*iint
;
399 iint
= integrity_iint_find(inode
);
401 iint
->evm_status
= INTEGRITY_UNKNOWN
;
405 * evm_inode_post_setxattr - update 'security.evm' to reflect the changes
406 * @dentry: pointer to the affected dentry
407 * @xattr_name: pointer to the affected extended attribute name
408 * @xattr_value: pointer to the new extended attribute value
409 * @xattr_value_len: pointer to the new extended attribute value length
411 * Update the HMAC stored in 'security.evm' to reflect the change.
413 * No need to take the i_mutex lock here, as this function is called from
414 * __vfs_setxattr_noperm(). The caller of which has taken the inode's
417 void evm_inode_post_setxattr(struct dentry
*dentry
, const char *xattr_name
,
418 const void *xattr_value
, size_t xattr_value_len
)
420 if (!evm_key_loaded() || (!evm_protected_xattr(xattr_name
)
421 && !posix_xattr_acl(xattr_name
)))
424 evm_reset_status(dentry
->d_inode
);
426 evm_update_evmxattr(dentry
, xattr_name
, xattr_value
, xattr_value_len
);
430 * evm_inode_post_removexattr - update 'security.evm' after removing the xattr
431 * @dentry: pointer to the affected dentry
432 * @xattr_name: pointer to the affected extended attribute name
434 * Update the HMAC stored in 'security.evm' to reflect removal of the xattr.
436 * No need to take the i_mutex lock here, as this function is called from
437 * vfs_removexattr() which takes the i_mutex.
439 void evm_inode_post_removexattr(struct dentry
*dentry
, const char *xattr_name
)
441 if (!evm_key_loaded() || !evm_protected_xattr(xattr_name
))
444 evm_reset_status(dentry
->d_inode
);
446 evm_update_evmxattr(dentry
, xattr_name
, NULL
, 0);
450 * evm_inode_setattr - prevent updating an invalid EVM extended attribute
451 * @dentry: pointer to the affected dentry
453 * Permit update of file attributes when files have a valid EVM signature,
454 * except in the case of them having an immutable portable signature.
456 int evm_inode_setattr(struct dentry
*dentry
, struct iattr
*attr
)
458 unsigned int ia_valid
= attr
->ia_valid
;
459 enum integrity_status evm_status
;
461 /* Policy permits modification of the protected attrs even though
462 * there's no HMAC key loaded
464 if (evm_initialized
& EVM_ALLOW_METADATA_WRITES
)
467 if (!(ia_valid
& (ATTR_MODE
| ATTR_UID
| ATTR_GID
)))
469 evm_status
= evm_verify_current_integrity(dentry
);
470 if ((evm_status
== INTEGRITY_PASS
) ||
471 (evm_status
== INTEGRITY_NOXATTRS
))
473 integrity_audit_msg(AUDIT_INTEGRITY_METADATA
, d_backing_inode(dentry
),
474 dentry
->d_name
.name
, "appraise_metadata",
475 integrity_status_msg
[evm_status
], -EPERM
, 0);
480 * evm_inode_post_setattr - update 'security.evm' after modifying metadata
481 * @dentry: pointer to the affected dentry
482 * @ia_valid: for the UID and GID status
484 * For now, update the HMAC stored in 'security.evm' to reflect UID/GID
487 * This function is called from notify_change(), which expects the caller
488 * to lock the inode's i_mutex.
490 void evm_inode_post_setattr(struct dentry
*dentry
, int ia_valid
)
492 if (!evm_key_loaded())
495 if (ia_valid
& (ATTR_MODE
| ATTR_UID
| ATTR_GID
))
496 evm_update_evmxattr(dentry
, NULL
, NULL
, 0);
500 * evm_inode_init_security - initializes security.evm
502 int evm_inode_init_security(struct inode
*inode
,
503 const struct xattr
*lsm_xattr
,
504 struct xattr
*evm_xattr
)
506 struct evm_ima_xattr_data
*xattr_data
;
509 if (!evm_key_loaded() || !evm_protected_xattr(lsm_xattr
->name
))
512 xattr_data
= kzalloc(sizeof(*xattr_data
), GFP_NOFS
);
516 xattr_data
->type
= EVM_XATTR_HMAC
;
517 rc
= evm_init_hmac(inode
, lsm_xattr
, xattr_data
->digest
);
521 evm_xattr
->value
= xattr_data
;
522 evm_xattr
->value_len
= sizeof(*xattr_data
);
523 evm_xattr
->name
= XATTR_EVM_SUFFIX
;
529 EXPORT_SYMBOL_GPL(evm_inode_init_security
);
531 #ifdef CONFIG_EVM_LOAD_X509
532 void __init
evm_load_x509(void)
536 rc
= integrity_load_x509(INTEGRITY_KEYRING_EVM
, CONFIG_EVM_X509_PATH
);
538 evm_initialized
|= EVM_INIT_X509
;
542 static int __init
init_evm(void)
548 error
= integrity_init_keyring(INTEGRITY_KEYRING_EVM
);
552 error
= evm_init_secfs();
554 pr_info("Error registering secfs\n");
562 * evm_display_config - list the EVM protected security extended attributes
564 static int __init
evm_display_config(void)
568 for (xattrname
= evm_config_xattrnames
; *xattrname
!= NULL
; xattrname
++)
569 pr_info("%s\n", *xattrname
);
573 pure_initcall(evm_display_config
);
574 late_initcall(init_evm
);
576 MODULE_DESCRIPTION("Extended Verification Module");
577 MODULE_LICENSE("GPL");