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 int evm_find_protected_xattrs(struct dentry
*dentry
)
81 struct inode
*inode
= d_backing_inode(dentry
);
86 if (!(inode
->i_opflags
& IOP_XATTR
))
89 for (xattr
= evm_config_xattrnames
; *xattr
!= NULL
; xattr
++) {
90 error
= __vfs_getxattr(dentry
, inode
, *xattr
, NULL
, 0);
92 if (error
== -ENODATA
)
103 * evm_verify_hmac - calculate and compare the HMAC with the EVM xattr
105 * Compute the HMAC on the dentry's protected set of extended attributes
106 * and compare it against the stored security.evm xattr.
109 * - use the previoulsy retrieved xattr value and length to calculate the
111 * - cache the verification result in the iint, when available.
113 * Returns integrity status
115 static enum integrity_status
evm_verify_hmac(struct dentry
*dentry
,
116 const char *xattr_name
,
118 size_t xattr_value_len
,
119 struct integrity_iint_cache
*iint
)
121 struct evm_ima_xattr_data
*xattr_data
= NULL
;
122 struct evm_ima_xattr_data calc
;
123 enum integrity_status evm_status
= INTEGRITY_PASS
;
126 if (iint
&& (iint
->evm_status
== INTEGRITY_PASS
||
127 iint
->evm_status
== INTEGRITY_PASS_IMMUTABLE
))
128 return iint
->evm_status
;
130 /* if status is not PASS, try to check again - against -ENOMEM */
132 /* first need to know the sig type */
133 rc
= vfs_getxattr_alloc(dentry
, XATTR_NAME_EVM
, (char **)&xattr_data
, 0,
136 evm_status
= INTEGRITY_FAIL
;
137 if (rc
== -ENODATA
) {
138 rc
= evm_find_protected_xattrs(dentry
);
140 evm_status
= INTEGRITY_NOLABEL
;
142 evm_status
= INTEGRITY_NOXATTRS
; /* new file */
143 } else if (rc
== -EOPNOTSUPP
) {
144 evm_status
= INTEGRITY_UNKNOWN
;
151 /* check value type */
152 switch (xattr_data
->type
) {
154 if (xattr_len
!= sizeof(struct evm_ima_xattr_data
)) {
155 evm_status
= INTEGRITY_FAIL
;
158 rc
= evm_calc_hmac(dentry
, xattr_name
, xattr_value
,
159 xattr_value_len
, calc
.digest
);
162 rc
= crypto_memneq(xattr_data
->digest
, calc
.digest
,
163 sizeof(calc
.digest
));
167 case EVM_IMA_XATTR_DIGSIG
:
168 case EVM_XATTR_PORTABLE_DIGSIG
:
169 rc
= evm_calc_hash(dentry
, xattr_name
, xattr_value
,
170 xattr_value_len
, xattr_data
->type
,
174 rc
= integrity_digsig_verify(INTEGRITY_KEYRING_EVM
,
175 (const char *)xattr_data
, xattr_len
,
176 calc
.digest
, sizeof(calc
.digest
));
178 if (xattr_data
->type
== EVM_XATTR_PORTABLE_DIGSIG
) {
180 iint
->flags
|= EVM_IMMUTABLE_DIGSIG
;
181 evm_status
= INTEGRITY_PASS_IMMUTABLE
;
182 } else if (!IS_RDONLY(d_backing_inode(dentry
)) &&
183 !IS_IMMUTABLE(d_backing_inode(dentry
))) {
184 evm_update_evmxattr(dentry
, xattr_name
,
196 evm_status
= (rc
== -ENODATA
) ?
197 INTEGRITY_NOXATTRS
: INTEGRITY_FAIL
;
200 iint
->evm_status
= evm_status
;
205 static int evm_protected_xattr(const char *req_xattr_name
)
211 namelen
= strlen(req_xattr_name
);
212 for (xattrname
= evm_config_xattrnames
; *xattrname
!= NULL
; xattrname
++) {
213 if ((strlen(*xattrname
) == namelen
)
214 && (strncmp(req_xattr_name
, *xattrname
, namelen
) == 0)) {
218 if (strncmp(req_xattr_name
,
219 *xattrname
+ XATTR_SECURITY_PREFIX_LEN
,
220 strlen(req_xattr_name
)) == 0) {
229 * evm_verifyxattr - verify the integrity of the requested xattr
230 * @dentry: object of the verify xattr
231 * @xattr_name: requested xattr
232 * @xattr_value: requested xattr value
233 * @xattr_value_len: requested xattr value length
235 * Calculate the HMAC for the given dentry and verify it against the stored
236 * security.evm xattr. For performance, use the xattr value and length
237 * previously retrieved to calculate the HMAC.
239 * Returns the xattr integrity status.
241 * This function requires the caller to lock the inode's i_mutex before it
244 enum integrity_status
evm_verifyxattr(struct dentry
*dentry
,
245 const char *xattr_name
,
246 void *xattr_value
, size_t xattr_value_len
,
247 struct integrity_iint_cache
*iint
)
249 if (!evm_initialized
|| !evm_protected_xattr(xattr_name
))
250 return INTEGRITY_UNKNOWN
;
253 iint
= integrity_iint_find(d_backing_inode(dentry
));
255 return INTEGRITY_UNKNOWN
;
257 return evm_verify_hmac(dentry
, xattr_name
, xattr_value
,
258 xattr_value_len
, iint
);
260 EXPORT_SYMBOL_GPL(evm_verifyxattr
);
263 * evm_verify_current_integrity - verify the dentry's metadata integrity
264 * @dentry: pointer to the affected dentry
266 * Verify and return the dentry's metadata integrity. The exceptions are
267 * before EVM is initialized or in 'fix' mode.
269 static enum integrity_status
evm_verify_current_integrity(struct dentry
*dentry
)
271 struct inode
*inode
= d_backing_inode(dentry
);
273 if (!evm_initialized
|| !S_ISREG(inode
->i_mode
) || evm_fixmode
)
275 return evm_verify_hmac(dentry
, NULL
, NULL
, 0, NULL
);
279 * evm_protect_xattr - protect the EVM extended attribute
281 * Prevent security.evm from being modified or removed without the
282 * necessary permissions or when the existing value is invalid.
284 * The posix xattr acls are 'system' prefixed, which normally would not
285 * affect security.evm. An interesting side affect of writing posix xattr
286 * acls is their modifying of the i_mode, which is included in security.evm.
287 * For posix xattr acls only, permit security.evm, even if it currently
288 * doesn't exist, to be updated unless the EVM signature is immutable.
290 static int evm_protect_xattr(struct dentry
*dentry
, const char *xattr_name
,
291 const void *xattr_value
, size_t xattr_value_len
)
293 enum integrity_status evm_status
;
295 if (strcmp(xattr_name
, XATTR_NAME_EVM
) == 0) {
296 if (!capable(CAP_SYS_ADMIN
))
298 } else if (!evm_protected_xattr(xattr_name
)) {
299 if (!posix_xattr_acl(xattr_name
))
301 evm_status
= evm_verify_current_integrity(dentry
);
302 if ((evm_status
== INTEGRITY_PASS
) ||
303 (evm_status
== INTEGRITY_NOXATTRS
))
307 evm_status
= evm_verify_current_integrity(dentry
);
308 if (evm_status
== INTEGRITY_NOXATTRS
) {
309 struct integrity_iint_cache
*iint
;
311 iint
= integrity_iint_find(d_backing_inode(dentry
));
312 if (iint
&& (iint
->flags
& IMA_NEW_FILE
))
315 /* exception for pseudo filesystems */
316 if (dentry
->d_sb
->s_magic
== TMPFS_MAGIC
317 || dentry
->d_sb
->s_magic
== SYSFS_MAGIC
)
320 integrity_audit_msg(AUDIT_INTEGRITY_METADATA
,
321 dentry
->d_inode
, dentry
->d_name
.name
,
323 integrity_status_msg
[evm_status
],
327 if (evm_status
!= INTEGRITY_PASS
)
328 integrity_audit_msg(AUDIT_INTEGRITY_METADATA
, d_backing_inode(dentry
),
329 dentry
->d_name
.name
, "appraise_metadata",
330 integrity_status_msg
[evm_status
],
332 return evm_status
== INTEGRITY_PASS
? 0 : -EPERM
;
336 * evm_inode_setxattr - protect the EVM extended attribute
337 * @dentry: pointer to the affected dentry
338 * @xattr_name: pointer to the affected extended attribute name
339 * @xattr_value: pointer to the new extended attribute value
340 * @xattr_value_len: pointer to the new extended attribute value length
342 * Before allowing the 'security.evm' protected xattr to be updated,
343 * verify the existing value is valid. As only the kernel should have
344 * access to the EVM encrypted key needed to calculate the HMAC, prevent
345 * userspace from writing HMAC value. Writing 'security.evm' requires
346 * requires CAP_SYS_ADMIN privileges.
348 int evm_inode_setxattr(struct dentry
*dentry
, const char *xattr_name
,
349 const void *xattr_value
, size_t xattr_value_len
)
351 const struct evm_ima_xattr_data
*xattr_data
= xattr_value
;
353 if (strcmp(xattr_name
, XATTR_NAME_EVM
) == 0) {
354 if (!xattr_value_len
)
356 if (xattr_data
->type
!= EVM_IMA_XATTR_DIGSIG
&&
357 xattr_data
->type
!= EVM_XATTR_PORTABLE_DIGSIG
)
360 return evm_protect_xattr(dentry
, xattr_name
, xattr_value
,
365 * evm_inode_removexattr - protect the EVM extended attribute
366 * @dentry: pointer to the affected dentry
367 * @xattr_name: pointer to the affected extended attribute name
369 * Removing 'security.evm' requires CAP_SYS_ADMIN privileges and that
370 * the current value is valid.
372 int evm_inode_removexattr(struct dentry
*dentry
, const char *xattr_name
)
374 return evm_protect_xattr(dentry
, xattr_name
, NULL
, 0);
377 static void evm_reset_status(struct inode
*inode
)
379 struct integrity_iint_cache
*iint
;
381 iint
= integrity_iint_find(inode
);
383 iint
->evm_status
= INTEGRITY_UNKNOWN
;
387 * evm_inode_post_setxattr - update 'security.evm' to reflect the changes
388 * @dentry: pointer to the affected dentry
389 * @xattr_name: pointer to the affected extended attribute name
390 * @xattr_value: pointer to the new extended attribute value
391 * @xattr_value_len: pointer to the new extended attribute value length
393 * Update the HMAC stored in 'security.evm' to reflect the change.
395 * No need to take the i_mutex lock here, as this function is called from
396 * __vfs_setxattr_noperm(). The caller of which has taken the inode's
399 void evm_inode_post_setxattr(struct dentry
*dentry
, const char *xattr_name
,
400 const void *xattr_value
, size_t xattr_value_len
)
402 if (!evm_initialized
|| (!evm_protected_xattr(xattr_name
)
403 && !posix_xattr_acl(xattr_name
)))
406 evm_reset_status(dentry
->d_inode
);
408 evm_update_evmxattr(dentry
, xattr_name
, xattr_value
, xattr_value_len
);
412 * evm_inode_post_removexattr - update 'security.evm' after removing the xattr
413 * @dentry: pointer to the affected dentry
414 * @xattr_name: pointer to the affected extended attribute name
416 * Update the HMAC stored in 'security.evm' to reflect removal of the xattr.
418 * No need to take the i_mutex lock here, as this function is called from
419 * vfs_removexattr() which takes the i_mutex.
421 void evm_inode_post_removexattr(struct dentry
*dentry
, const char *xattr_name
)
423 if (!evm_initialized
|| !evm_protected_xattr(xattr_name
))
426 evm_reset_status(dentry
->d_inode
);
428 evm_update_evmxattr(dentry
, xattr_name
, NULL
, 0);
432 * evm_inode_setattr - prevent updating an invalid EVM extended attribute
433 * @dentry: pointer to the affected dentry
435 * Permit update of file attributes when files have a valid EVM signature,
436 * except in the case of them having an immutable portable signature.
438 int evm_inode_setattr(struct dentry
*dentry
, struct iattr
*attr
)
440 unsigned int ia_valid
= attr
->ia_valid
;
441 enum integrity_status evm_status
;
443 if (!(ia_valid
& (ATTR_MODE
| ATTR_UID
| ATTR_GID
)))
445 evm_status
= evm_verify_current_integrity(dentry
);
446 if ((evm_status
== INTEGRITY_PASS
) ||
447 (evm_status
== INTEGRITY_NOXATTRS
))
449 integrity_audit_msg(AUDIT_INTEGRITY_METADATA
, d_backing_inode(dentry
),
450 dentry
->d_name
.name
, "appraise_metadata",
451 integrity_status_msg
[evm_status
], -EPERM
, 0);
456 * evm_inode_post_setattr - update 'security.evm' after modifying metadata
457 * @dentry: pointer to the affected dentry
458 * @ia_valid: for the UID and GID status
460 * For now, update the HMAC stored in 'security.evm' to reflect UID/GID
463 * This function is called from notify_change(), which expects the caller
464 * to lock the inode's i_mutex.
466 void evm_inode_post_setattr(struct dentry
*dentry
, int ia_valid
)
468 if (!evm_initialized
)
471 if (ia_valid
& (ATTR_MODE
| ATTR_UID
| ATTR_GID
))
472 evm_update_evmxattr(dentry
, NULL
, NULL
, 0);
476 * evm_inode_init_security - initializes security.evm
478 int evm_inode_init_security(struct inode
*inode
,
479 const struct xattr
*lsm_xattr
,
480 struct xattr
*evm_xattr
)
482 struct evm_ima_xattr_data
*xattr_data
;
485 if (!evm_initialized
|| !evm_protected_xattr(lsm_xattr
->name
))
488 xattr_data
= kzalloc(sizeof(*xattr_data
), GFP_NOFS
);
492 xattr_data
->type
= EVM_XATTR_HMAC
;
493 rc
= evm_init_hmac(inode
, lsm_xattr
, xattr_data
->digest
);
497 evm_xattr
->value
= xattr_data
;
498 evm_xattr
->value_len
= sizeof(*xattr_data
);
499 evm_xattr
->name
= XATTR_EVM_SUFFIX
;
505 EXPORT_SYMBOL_GPL(evm_inode_init_security
);
507 #ifdef CONFIG_EVM_LOAD_X509
508 void __init
evm_load_x509(void)
512 rc
= integrity_load_x509(INTEGRITY_KEYRING_EVM
, CONFIG_EVM_X509_PATH
);
514 evm_initialized
|= EVM_INIT_X509
;
518 static int __init
init_evm(void)
524 error
= integrity_init_keyring(INTEGRITY_KEYRING_EVM
);
528 error
= evm_init_secfs();
530 pr_info("Error registering secfs\n");
538 * evm_display_config - list the EVM protected security extended attributes
540 static int __init
evm_display_config(void)
544 for (xattrname
= evm_config_xattrnames
; *xattrname
!= NULL
; xattrname
++)
545 pr_info("%s\n", *xattrname
);
549 pure_initcall(evm_display_config
);
550 late_initcall(init_evm
);
552 MODULE_DESCRIPTION("Extended Verification Module");
553 MODULE_LICENSE("GPL");