1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (C) 2005,2006,2007,2008 IBM Corporation 4 * 5 * Authors: 6 * Reiner Sailer <sailer@watson.ibm.com> 7 * Mimi Zohar <zohar@us.ibm.com> 8 * 9 * File: ima.h 10 * internal Integrity Measurement Architecture (IMA) definitions 11 */ 12 13 #ifndef __LINUX_IMA_H 14 #define __LINUX_IMA_H 15 16 #include <linux/types.h> 17 #include <linux/crypto.h> 18 #include <linux/fs.h> 19 #include <linux/security.h> 20 #include <linux/hash.h> 21 #include <linux/tpm.h> 22 #include <linux/audit.h> 23 #include <crypto/hash_info.h> 24 25 #include "../integrity.h" 26 27 enum ima_show_type { IMA_SHOW_BINARY, IMA_SHOW_BINARY_NO_FIELD_LEN, 28 IMA_SHOW_BINARY_OLD_STRING_FMT, IMA_SHOW_ASCII }; 29 enum tpm_pcrs { TPM_PCR0 = 0, TPM_PCR8 = 8, TPM_PCR10 = 10 }; 30 31 /* digest size for IMA, fits SHA1 or MD5 */ 32 #define IMA_DIGEST_SIZE SHA1_DIGEST_SIZE 33 #define IMA_EVENT_NAME_LEN_MAX 255 34 35 #define IMA_HASH_BITS 10 36 #define IMA_MEASURE_HTABLE_SIZE (1 << IMA_HASH_BITS) 37 38 #define IMA_TEMPLATE_FIELD_ID_MAX_LEN 16 39 #define IMA_TEMPLATE_NUM_FIELDS_MAX 15 40 41 #define IMA_TEMPLATE_IMA_NAME "ima" 42 #define IMA_TEMPLATE_IMA_FMT "d|n" 43 44 #define NR_BANKS(chip) ((chip != NULL) ? chip->nr_allocated_banks : 0) 45 46 /* current content of the policy */ 47 extern int ima_policy_flag; 48 49 /* bitset of digests algorithms allowed in the setxattr hook */ 50 extern atomic_t ima_setxattr_allowed_hash_algorithms; 51 52 /* IMA hash algorithm description */ 53 struct ima_algo_desc { 54 struct crypto_shash *tfm; 55 enum hash_algo algo; 56 }; 57 58 /* set during initialization */ 59 extern int ima_hash_algo __ro_after_init; 60 extern int ima_sha1_idx __ro_after_init; 61 extern int ima_hash_algo_idx __ro_after_init; 62 extern int ima_extra_slots __ro_after_init; 63 extern struct ima_algo_desc *ima_algo_array __ro_after_init; 64 65 extern int ima_appraise; 66 extern struct tpm_chip *ima_tpm_chip; 67 extern const char boot_aggregate_name[]; 68 69 /* IMA event related data */ 70 struct ima_event_data { 71 struct ima_iint_cache *iint; 72 struct file *file; 73 const unsigned char *filename; 74 struct evm_ima_xattr_data *xattr_value; 75 int xattr_len; 76 const struct modsig *modsig; 77 const char *violation; 78 const void *buf; 79 int buf_len; 80 }; 81 82 /* IMA template field data definition */ 83 struct ima_field_data { 84 u8 *data; 85 u32 len; 86 }; 87 88 /* IMA template field definition */ 89 struct ima_template_field { 90 const char field_id[IMA_TEMPLATE_FIELD_ID_MAX_LEN]; 91 int (*field_init)(struct ima_event_data *event_data, 92 struct ima_field_data *field_data); 93 void (*field_show)(struct seq_file *m, enum ima_show_type show, 94 struct ima_field_data *field_data); 95 }; 96 97 /* IMA template descriptor definition */ 98 struct ima_template_desc { 99 struct list_head list; 100 char *name; 101 char *fmt; 102 int num_fields; 103 const struct ima_template_field **fields; 104 }; 105 106 struct ima_template_entry { 107 int pcr; 108 struct tpm_digest *digests; 109 struct ima_template_desc *template_desc; /* template descriptor */ 110 u32 template_data_len; 111 struct ima_field_data template_data[]; /* template related data */ 112 }; 113 114 struct ima_queue_entry { 115 struct hlist_node hnext; /* place in hash collision list */ 116 struct list_head later; /* place in ima_measurements list */ 117 struct ima_template_entry *entry; 118 }; 119 extern struct list_head ima_measurements; /* list of all measurements */ 120 121 /* Some details preceding the binary serialized measurement list */ 122 struct ima_kexec_hdr { 123 u16 version; 124 u16 _reserved0; 125 u32 _reserved1; 126 u64 buffer_size; 127 u64 count; 128 }; 129 130 /* IMA iint action cache flags */ 131 #define IMA_MEASURE 0x00000001 132 #define IMA_MEASURED 0x00000002 133 #define IMA_APPRAISE 0x00000004 134 #define IMA_APPRAISED 0x00000008 135 /*#define IMA_COLLECT 0x00000010 do not use this flag */ 136 #define IMA_COLLECTED 0x00000020 137 #define IMA_AUDIT 0x00000040 138 #define IMA_AUDITED 0x00000080 139 #define IMA_HASH 0x00000100 140 #define IMA_HASHED 0x00000200 141 142 /* IMA iint policy rule cache flags */ 143 #define IMA_NONACTION_FLAGS 0xff000000 144 #define IMA_DIGSIG_REQUIRED 0x01000000 145 #define IMA_PERMIT_DIRECTIO 0x02000000 146 #define IMA_NEW_FILE 0x04000000 147 #define IMA_FAIL_UNVERIFIABLE_SIGS 0x10000000 148 #define IMA_MODSIG_ALLOWED 0x20000000 149 #define IMA_CHECK_BLACKLIST 0x40000000 150 #define IMA_VERITY_REQUIRED 0x80000000 151 152 #define IMA_DO_MASK (IMA_MEASURE | IMA_APPRAISE | IMA_AUDIT | \ 153 IMA_HASH | IMA_APPRAISE_SUBMASK) 154 #define IMA_DONE_MASK (IMA_MEASURED | IMA_APPRAISED | IMA_AUDITED | \ 155 IMA_HASHED | IMA_COLLECTED | \ 156 IMA_APPRAISED_SUBMASK) 157 158 /* IMA iint subaction appraise cache flags */ 159 #define IMA_FILE_APPRAISE 0x00001000 160 #define IMA_FILE_APPRAISED 0x00002000 161 #define IMA_MMAP_APPRAISE 0x00004000 162 #define IMA_MMAP_APPRAISED 0x00008000 163 #define IMA_BPRM_APPRAISE 0x00010000 164 #define IMA_BPRM_APPRAISED 0x00020000 165 #define IMA_READ_APPRAISE 0x00040000 166 #define IMA_READ_APPRAISED 0x00080000 167 #define IMA_CREDS_APPRAISE 0x00100000 168 #define IMA_CREDS_APPRAISED 0x00200000 169 #define IMA_APPRAISE_SUBMASK (IMA_FILE_APPRAISE | IMA_MMAP_APPRAISE | \ 170 IMA_BPRM_APPRAISE | IMA_READ_APPRAISE | \ 171 IMA_CREDS_APPRAISE) 172 #define IMA_APPRAISED_SUBMASK (IMA_FILE_APPRAISED | IMA_MMAP_APPRAISED | \ 173 IMA_BPRM_APPRAISED | IMA_READ_APPRAISED | \ 174 IMA_CREDS_APPRAISED) 175 176 /* IMA iint cache atomic_flags */ 177 #define IMA_CHANGE_XATTR 0 178 #define IMA_UPDATE_XATTR 1 179 #define IMA_CHANGE_ATTR 2 180 #define IMA_DIGSIG 3 181 #define IMA_MUST_MEASURE 4 182 183 /* IMA integrity metadata associated with an inode */ 184 struct ima_iint_cache { 185 struct mutex mutex; /* protects: version, flags, digest */ 186 struct integrity_inode_attributes real_inode; 187 unsigned long flags; 188 unsigned long measured_pcrs; 189 unsigned long atomic_flags; 190 enum integrity_status ima_file_status:4; 191 enum integrity_status ima_mmap_status:4; 192 enum integrity_status ima_bprm_status:4; 193 enum integrity_status ima_read_status:4; 194 enum integrity_status ima_creds_status:4; 195 struct ima_digest_data *ima_hash; 196 }; 197 198 extern struct lsm_blob_sizes ima_blob_sizes; 199 200 static inline struct ima_iint_cache * 201 ima_inode_get_iint(const struct inode *inode) 202 { 203 struct ima_iint_cache **iint_sec; 204 205 if (unlikely(!inode->i_security)) 206 return NULL; 207 208 iint_sec = inode->i_security + ima_blob_sizes.lbs_inode; 209 return *iint_sec; 210 } 211 212 static inline void ima_inode_set_iint(const struct inode *inode, 213 struct ima_iint_cache *iint) 214 { 215 struct ima_iint_cache **iint_sec; 216 217 if (unlikely(!inode->i_security)) 218 return; 219 220 iint_sec = inode->i_security + ima_blob_sizes.lbs_inode; 221 *iint_sec = iint; 222 } 223 224 struct ima_iint_cache *ima_iint_find(struct inode *inode); 225 struct ima_iint_cache *ima_inode_get(struct inode *inode); 226 void ima_inode_free_rcu(void *inode_security); 227 void __init ima_iintcache_init(void); 228 229 extern const int read_idmap[]; 230 231 #ifdef CONFIG_HAVE_IMA_KEXEC 232 void ima_load_kexec_buffer(void); 233 #else 234 static inline void ima_load_kexec_buffer(void) {} 235 #endif /* CONFIG_HAVE_IMA_KEXEC */ 236 237 #ifdef CONFIG_IMA_MEASURE_ASYMMETRIC_KEYS 238 void ima_post_key_create_or_update(struct key *keyring, struct key *key, 239 const void *payload, size_t plen, 240 unsigned long flags, bool create); 241 #endif 242 243 /* 244 * The default binary_runtime_measurements list format is defined as the 245 * platform native format. The canonical format is defined as little-endian. 246 */ 247 extern bool ima_canonical_fmt; 248 249 /* Internal IMA function definitions */ 250 int ima_init(void); 251 int ima_fs_init(void); 252 int ima_add_template_entry(struct ima_template_entry *entry, int violation, 253 const char *op, struct inode *inode, 254 const unsigned char *filename); 255 int ima_calc_file_hash(struct file *file, struct ima_digest_data *hash); 256 int ima_calc_buffer_hash(const void *buf, loff_t len, 257 struct ima_digest_data *hash); 258 int ima_calc_field_array_hash(struct ima_field_data *field_data, 259 struct ima_template_entry *entry); 260 int ima_calc_boot_aggregate(struct ima_digest_data *hash); 261 void ima_add_violation(struct file *file, const unsigned char *filename, 262 struct ima_iint_cache *iint, const char *op, 263 const char *cause); 264 int ima_init_crypto(void); 265 void ima_putc(struct seq_file *m, void *data, int datalen); 266 void ima_print_digest(struct seq_file *m, u8 *digest, u32 size); 267 int template_desc_init_fields(const char *template_fmt, 268 const struct ima_template_field ***fields, 269 int *num_fields); 270 struct ima_template_desc *ima_template_desc_current(void); 271 struct ima_template_desc *ima_template_desc_buf(void); 272 struct ima_template_desc *lookup_template_desc(const char *name); 273 bool ima_template_has_modsig(const struct ima_template_desc *ima_template); 274 int ima_restore_measurement_entry(struct ima_template_entry *entry); 275 int ima_restore_measurement_list(loff_t bufsize, void *buf); 276 int ima_measurements_show(struct seq_file *m, void *v); 277 unsigned long ima_get_binary_runtime_size(void); 278 int ima_init_template(void); 279 void ima_init_template_list(void); 280 int __init ima_init_digests(void); 281 void __init ima_init_reboot_notifier(void); 282 int ima_lsm_policy_change(struct notifier_block *nb, unsigned long event, 283 void *lsm_data); 284 285 /* 286 * used to protect h_table and sha_table 287 */ 288 extern spinlock_t ima_queue_lock; 289 290 struct ima_h_table { 291 atomic_long_t len; /* number of stored measurements in the list */ 292 atomic_long_t violations; 293 struct hlist_head queue[IMA_MEASURE_HTABLE_SIZE]; 294 }; 295 extern struct ima_h_table ima_htable; 296 297 static inline unsigned int ima_hash_key(u8 *digest) 298 { 299 /* there is no point in taking a hash of part of a digest */ 300 return (digest[0] | digest[1] << 8) % IMA_MEASURE_HTABLE_SIZE; 301 } 302 303 #define __ima_hooks(hook) \ 304 hook(NONE, none) \ 305 hook(FILE_CHECK, file) \ 306 hook(MMAP_CHECK, mmap) \ 307 hook(MMAP_CHECK_REQPROT, mmap_reqprot) \ 308 hook(BPRM_CHECK, bprm) \ 309 hook(CREDS_CHECK, creds) \ 310 hook(POST_SETATTR, post_setattr) \ 311 hook(MODULE_CHECK, module) \ 312 hook(FIRMWARE_CHECK, firmware) \ 313 hook(KEXEC_KERNEL_CHECK, kexec_kernel) \ 314 hook(KEXEC_INITRAMFS_CHECK, kexec_initramfs) \ 315 hook(POLICY_CHECK, policy) \ 316 hook(KEXEC_CMDLINE, kexec_cmdline) \ 317 hook(KEY_CHECK, key) \ 318 hook(CRITICAL_DATA, critical_data) \ 319 hook(SETXATTR_CHECK, setxattr_check) \ 320 hook(MAX_CHECK, none) 321 322 #define __ima_hook_enumify(ENUM, str) ENUM, 323 #define __ima_stringify(arg) (#arg) 324 #define __ima_hook_measuring_stringify(ENUM, str) \ 325 (__ima_stringify(measuring_ ##str)), 326 327 enum ima_hooks { 328 __ima_hooks(__ima_hook_enumify) 329 }; 330 331 static const char * const ima_hooks_measure_str[] = { 332 __ima_hooks(__ima_hook_measuring_stringify) 333 }; 334 335 static inline const char *func_measure_str(enum ima_hooks func) 336 { 337 if (func >= MAX_CHECK) 338 return ima_hooks_measure_str[NONE]; 339 340 return ima_hooks_measure_str[func]; 341 } 342 343 extern const char *const func_tokens[]; 344 345 struct modsig; 346 347 #ifdef CONFIG_IMA_QUEUE_EARLY_BOOT_KEYS 348 /* 349 * To track keys that need to be measured. 350 */ 351 struct ima_key_entry { 352 struct list_head list; 353 void *payload; 354 size_t payload_len; 355 char *keyring_name; 356 }; 357 void ima_init_key_queue(void); 358 bool ima_should_queue_key(void); 359 bool ima_queue_key(struct key *keyring, const void *payload, 360 size_t payload_len); 361 void ima_process_queued_keys(void); 362 #else 363 static inline void ima_init_key_queue(void) {} 364 static inline bool ima_should_queue_key(void) { return false; } 365 static inline bool ima_queue_key(struct key *keyring, 366 const void *payload, 367 size_t payload_len) { return false; } 368 static inline void ima_process_queued_keys(void) {} 369 #endif /* CONFIG_IMA_QUEUE_EARLY_BOOT_KEYS */ 370 371 /* LIM API function definitions */ 372 int ima_get_action(struct mnt_idmap *idmap, struct inode *inode, 373 const struct cred *cred, struct lsm_prop *prop, int mask, 374 enum ima_hooks func, int *pcr, 375 struct ima_template_desc **template_desc, 376 const char *func_data, unsigned int *allowed_algos); 377 int ima_must_measure(struct inode *inode, int mask, enum ima_hooks func); 378 int ima_collect_measurement(struct ima_iint_cache *iint, struct file *file, 379 void *buf, loff_t size, enum hash_algo algo, 380 struct modsig *modsig); 381 void ima_store_measurement(struct ima_iint_cache *iint, struct file *file, 382 const unsigned char *filename, 383 struct evm_ima_xattr_data *xattr_value, 384 int xattr_len, const struct modsig *modsig, int pcr, 385 struct ima_template_desc *template_desc); 386 int process_buffer_measurement(struct mnt_idmap *idmap, 387 struct inode *inode, const void *buf, int size, 388 const char *eventname, enum ima_hooks func, 389 int pcr, const char *func_data, 390 bool buf_hash, u8 *digest, size_t digest_len); 391 void ima_audit_measurement(struct ima_iint_cache *iint, 392 const unsigned char *filename); 393 int ima_alloc_init_template(struct ima_event_data *event_data, 394 struct ima_template_entry **entry, 395 struct ima_template_desc *template_desc); 396 int ima_store_template(struct ima_template_entry *entry, int violation, 397 struct inode *inode, 398 const unsigned char *filename, int pcr); 399 void ima_free_template_entry(struct ima_template_entry *entry); 400 const char *ima_d_path(const struct path *path, char **pathbuf, char *filename); 401 402 /* IMA policy related functions */ 403 int ima_match_policy(struct mnt_idmap *idmap, struct inode *inode, 404 const struct cred *cred, struct lsm_prop *prop, 405 enum ima_hooks func, int mask, int flags, int *pcr, 406 struct ima_template_desc **template_desc, 407 const char *func_data, unsigned int *allowed_algos); 408 void ima_init_policy(void); 409 void ima_update_policy(void); 410 void ima_update_policy_flags(void); 411 ssize_t ima_parse_add_rule(char *); 412 void ima_delete_rules(void); 413 int ima_check_policy(void); 414 void *ima_policy_start(struct seq_file *m, loff_t *pos); 415 void *ima_policy_next(struct seq_file *m, void *v, loff_t *pos); 416 void ima_policy_stop(struct seq_file *m, void *v); 417 int ima_policy_show(struct seq_file *m, void *v); 418 419 /* Appraise integrity measurements */ 420 #define IMA_APPRAISE_ENFORCE 0x01 421 #define IMA_APPRAISE_FIX 0x02 422 #define IMA_APPRAISE_LOG 0x04 423 #define IMA_APPRAISE_MODULES 0x08 424 #define IMA_APPRAISE_FIRMWARE 0x10 425 #define IMA_APPRAISE_POLICY 0x20 426 #define IMA_APPRAISE_KEXEC 0x40 427 428 #ifdef CONFIG_IMA_APPRAISE 429 int ima_check_blacklist(struct ima_iint_cache *iint, 430 const struct modsig *modsig, int pcr); 431 int ima_appraise_measurement(enum ima_hooks func, struct ima_iint_cache *iint, 432 struct file *file, const unsigned char *filename, 433 struct evm_ima_xattr_data *xattr_value, 434 int xattr_len, const struct modsig *modsig); 435 int ima_must_appraise(struct mnt_idmap *idmap, struct inode *inode, 436 int mask, enum ima_hooks func); 437 void ima_update_xattr(struct ima_iint_cache *iint, struct file *file); 438 enum integrity_status ima_get_cache_status(struct ima_iint_cache *iint, 439 enum ima_hooks func); 440 enum hash_algo ima_get_hash_algo(const struct evm_ima_xattr_data *xattr_value, 441 int xattr_len); 442 int ima_read_xattr(struct dentry *dentry, 443 struct evm_ima_xattr_data **xattr_value, int xattr_len); 444 void __init init_ima_appraise_lsm(const struct lsm_id *lsmid); 445 446 #else 447 static inline int ima_check_blacklist(struct ima_iint_cache *iint, 448 const struct modsig *modsig, int pcr) 449 { 450 return 0; 451 } 452 453 static inline int ima_appraise_measurement(enum ima_hooks func, 454 struct ima_iint_cache *iint, 455 struct file *file, 456 const unsigned char *filename, 457 struct evm_ima_xattr_data *xattr_value, 458 int xattr_len, 459 const struct modsig *modsig) 460 { 461 return INTEGRITY_UNKNOWN; 462 } 463 464 static inline int ima_must_appraise(struct mnt_idmap *idmap, 465 struct inode *inode, int mask, 466 enum ima_hooks func) 467 { 468 return 0; 469 } 470 471 static inline void ima_update_xattr(struct ima_iint_cache *iint, 472 struct file *file) 473 { 474 } 475 476 static inline enum integrity_status 477 ima_get_cache_status(struct ima_iint_cache *iint, enum ima_hooks func) 478 { 479 return INTEGRITY_UNKNOWN; 480 } 481 482 static inline enum hash_algo 483 ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value, int xattr_len) 484 { 485 return ima_hash_algo; 486 } 487 488 static inline int ima_read_xattr(struct dentry *dentry, 489 struct evm_ima_xattr_data **xattr_value, 490 int xattr_len) 491 { 492 return 0; 493 } 494 495 static inline void __init init_ima_appraise_lsm(const struct lsm_id *lsmid) 496 { 497 } 498 499 #endif /* CONFIG_IMA_APPRAISE */ 500 501 #ifdef CONFIG_IMA_APPRAISE_MODSIG 502 int ima_read_modsig(enum ima_hooks func, const void *buf, loff_t buf_len, 503 struct modsig **modsig); 504 void ima_collect_modsig(struct modsig *modsig, const void *buf, loff_t size); 505 int ima_get_modsig_digest(const struct modsig *modsig, enum hash_algo *algo, 506 const u8 **digest, u32 *digest_size); 507 int ima_get_raw_modsig(const struct modsig *modsig, const void **data, 508 u32 *data_len); 509 void ima_free_modsig(struct modsig *modsig); 510 #else 511 static inline int ima_read_modsig(enum ima_hooks func, const void *buf, 512 loff_t buf_len, struct modsig **modsig) 513 { 514 return -EOPNOTSUPP; 515 } 516 517 static inline void ima_collect_modsig(struct modsig *modsig, const void *buf, 518 loff_t size) 519 { 520 } 521 522 static inline int ima_get_modsig_digest(const struct modsig *modsig, 523 enum hash_algo *algo, const u8 **digest, 524 u32 *digest_size) 525 { 526 return -EOPNOTSUPP; 527 } 528 529 static inline int ima_get_raw_modsig(const struct modsig *modsig, 530 const void **data, u32 *data_len) 531 { 532 return -EOPNOTSUPP; 533 } 534 535 static inline void ima_free_modsig(struct modsig *modsig) 536 { 537 } 538 #endif /* CONFIG_IMA_APPRAISE_MODSIG */ 539 540 /* LSM based policy rules require audit */ 541 #ifdef CONFIG_IMA_LSM_RULES 542 543 #define ima_filter_rule_init security_audit_rule_init 544 #define ima_filter_rule_free security_audit_rule_free 545 #define ima_filter_rule_match security_audit_rule_match 546 547 #else 548 549 static inline int ima_filter_rule_init(u32 field, u32 op, char *rulestr, 550 void **lsmrule, gfp_t gfp) 551 { 552 return -EINVAL; 553 } 554 555 static inline void ima_filter_rule_free(void *lsmrule) 556 { 557 } 558 559 static inline int ima_filter_rule_match(struct lsm_prop *prop, u32 field, u32 op, 560 void *lsmrule) 561 { 562 return -EINVAL; 563 } 564 #endif /* CONFIG_IMA_LSM_RULES */ 565 566 #ifdef CONFIG_IMA_READ_POLICY 567 #define POLICY_FILE_FLAGS (S_IWUSR | S_IRUSR) 568 #else 569 #define POLICY_FILE_FLAGS S_IWUSR 570 #endif /* CONFIG_IMA_READ_POLICY */ 571 572 #endif /* __LINUX_IMA_H */ 573