security/integrity/ima/ima.h

   1 /*
   2  * Copyright (C) 2005,2006,2007,2008 IBM Corporation
   3  *
   4  * Authors:
   5  * Reiner Sailer <sailer@watson.ibm.com>
   6  * Mimi Zohar <zohar@us.ibm.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation, version 2 of the
  11  * License.
  12  *
  13  * File: ima.h
  14  *      internal Integrity Measurement Architecture (IMA) definitions
  15  */
  16
  17 #ifndef __LINUX_IMA_H
  18 #define __LINUX_IMA_H
  19
  20 #include <linux/types.h>
  21 #include <linux/crypto.h>
  22 #include <linux/fs.h>
  23 #include <linux/security.h>
  24 #include <linux/hash.h>
  25 #include <linux/tpm.h>
  26 #include <linux/audit.h>
  27 #include <crypto/hash_info.h>
  28
  29 #include "../integrity.h"
  30
  31 #ifdef CONFIG_HAVE_IMA_KEXEC
  32 #include <asm/ima.h>
  33 #endif
  34
  35 enum ima_show_type { IMA_SHOW_BINARY, IMA_SHOW_BINARY_NO_FIELD_LEN,
  36                      IMA_SHOW_BINARY_OLD_STRING_FMT, IMA_SHOW_ASCII };
  37 enum tpm_pcrs { TPM_PCR0 = 0, TPM_PCR8 = 8 };
  38
  39 /* digest size for IMA, fits SHA1 or MD5 */
  40 #define IMA_DIGEST_SIZE         SHA1_DIGEST_SIZE
  41 #define IMA_EVENT_NAME_LEN_MAX  255
  42
  43 #define IMA_HASH_BITS 9
  44 #define IMA_MEASURE_HTABLE_SIZE (1 << IMA_HASH_BITS)
  45
  46 #define IMA_TEMPLATE_FIELD_ID_MAX_LEN   16
  47 #define IMA_TEMPLATE_NUM_FIELDS_MAX     15
  48
  49 #define IMA_TEMPLATE_IMA_NAME "ima"
  50 #define IMA_TEMPLATE_IMA_FMT "d|n"
  51
  52 /* current content of the policy */
  53 extern int ima_policy_flag;
  54
  55 /* set during initialization */
  56 extern int ima_initialized;
  57 extern int ima_used_chip;
  58 extern int ima_hash_algo;
  59 extern int ima_appraise;
  60
  61 /* IMA event related data */
  62 struct ima_event_data {
  63         struct integrity_iint_cache *iint;
  64         struct file *file;
  65         const unsigned char *filename;
  66         struct evm_ima_xattr_data *xattr_value;
  67         int xattr_len;
  68         const char *violation;
  69 };
  70
  71 /* IMA template field data definition */
  72 struct ima_field_data {
  73         u8 *data;
  74         u32 len;
  75 };
  76
  77 /* IMA template field definition */
  78 struct ima_template_field {
  79         const char field_id[IMA_TEMPLATE_FIELD_ID_MAX_LEN];
  80         int (*field_init)(struct ima_event_data *event_data,
  81                           struct ima_field_data *field_data);
  82         void (*field_show)(struct seq_file *m, enum ima_show_type show,
  83                            struct ima_field_data *field_data);
  84 };
  85
  86 /* IMA template descriptor definition */
  87 struct ima_template_desc {
  88         char *name;
  89         char *fmt;
  90         int num_fields;
  91         struct ima_template_field **fields;
  92 };
  93
  94 struct ima_template_entry {
  95         int pcr;
  96         u8 digest[TPM_DIGEST_SIZE];     /* sha1 or md5 measurement hash */
  97         struct ima_template_desc *template_desc; /* template descriptor */
  98         u32 template_data_len;
  99         struct ima_field_data template_data[0]; /* template related data */
 100 };
 101
 102 struct ima_queue_entry {
 103         struct hlist_node hnext;        /* place in hash collision list */
 104         struct list_head later;         /* place in ima_measurements list */
 105         struct ima_template_entry *entry;
 106 };
 107 extern struct list_head ima_measurements;       /* list of all measurements */
 108
 109 /* Some details preceding the binary serialized measurement list */
 110 struct ima_kexec_hdr {
 111         u16 version;
 112         u16 _reserved0;
 113         u32 _reserved1;
 114         u64 buffer_size;
 115         u64 count;
 116 };
 117
 118 #ifdef CONFIG_HAVE_IMA_KEXEC
 119 void ima_load_kexec_buffer(void);
 120 #else
 121 static inline void ima_load_kexec_buffer(void) {}
 122 #endif /* CONFIG_HAVE_IMA_KEXEC */
 123
 124 /* Internal IMA function definitions */
 125 int ima_init(void);
 126 int ima_fs_init(void);
 127 int ima_add_template_entry(struct ima_template_entry *entry, int violation,
 128                            const char *op, struct inode *inode,
 129                            const unsigned char *filename);
 130 int ima_calc_file_hash(struct file *file, struct ima_digest_data *hash);
 131 int ima_calc_buffer_hash(const void *buf, loff_t len,
 132                          struct ima_digest_data *hash);
 133 int ima_calc_field_array_hash(struct ima_field_data *field_data,
 134                               struct ima_template_desc *desc, int num_fields,
 135                               struct ima_digest_data *hash);
 136 int __init ima_calc_boot_aggregate(struct ima_digest_data *hash);
 137 void ima_add_violation(struct file *file, const unsigned char *filename,
 138                        struct integrity_iint_cache *iint,
 139                        const char *op, const char *cause);
 140 int ima_init_crypto(void);
 141 void ima_putc(struct seq_file *m, void *data, int datalen);
 142 void ima_print_digest(struct seq_file *m, u8 *digest, u32 size);
 143 struct ima_template_desc *ima_template_desc_current(void);
 144 int ima_restore_measurement_entry(struct ima_template_entry *entry);
 145 int ima_restore_measurement_list(loff_t bufsize, void *buf);
 146 int ima_init_template(void);
 147
 148 /*
 149  * used to protect h_table and sha_table
 150  */
 151 extern spinlock_t ima_queue_lock;
 152
 153 struct ima_h_table {
 154         atomic_long_t len;      /* number of stored measurements in the list */
 155         atomic_long_t violations;
 156         struct hlist_head queue[IMA_MEASURE_HTABLE_SIZE];
 157 };
 158 extern struct ima_h_table ima_htable;
 159
 160 static inline unsigned long ima_hash_key(u8 *digest)
 161 {
 162         return hash_long(*digest, IMA_HASH_BITS);
 163 }
 164
 165 enum ima_hooks {
 166         FILE_CHECK = 1,
 167         MMAP_CHECK,
 168         BPRM_CHECK,
 169         POST_SETATTR,
 170         MODULE_CHECK,
 171         FIRMWARE_CHECK,
 172         KEXEC_KERNEL_CHECK,
 173         KEXEC_INITRAMFS_CHECK,
 174         POLICY_CHECK,
 175         MAX_CHECK
 176 };
 177
 178 /* LIM API function definitions */
 179 int ima_get_action(struct inode *inode, int mask,
 180                    enum ima_hooks func, int *pcr);
 181 int ima_must_measure(struct inode *inode, int mask, enum ima_hooks func);
 182 int ima_collect_measurement(struct integrity_iint_cache *iint,
 183                             struct file *file, void *buf, loff_t size,
 184                             enum hash_algo algo);
 185 void ima_store_measurement(struct integrity_iint_cache *iint, struct file *file,
 186                            const unsigned char *filename,
 187                            struct evm_ima_xattr_data *xattr_value,
 188                            int xattr_len, int pcr);
 189 void ima_audit_measurement(struct integrity_iint_cache *iint,
 190                            const unsigned char *filename);
 191 int ima_alloc_init_template(struct ima_event_data *event_data,
 192                             struct ima_template_entry **entry);
 193 int ima_store_template(struct ima_template_entry *entry, int violation,
 194                        struct inode *inode,
 195                        const unsigned char *filename, int pcr);
 196 void ima_free_template_entry(struct ima_template_entry *entry);
 197 const char *ima_d_path(const struct path *path, char **pathbuf);
 198
 199 /* IMA policy related functions */
 200 int ima_match_policy(struct inode *inode, enum ima_hooks func, int mask,
 201                      int flags, int *pcr);
 202 void ima_init_policy(void);
 203 void ima_update_policy(void);
 204 void ima_update_policy_flag(void);
 205 ssize_t ima_parse_add_rule(char *);
 206 void ima_delete_rules(void);
 207 int ima_check_policy(void);
 208 void *ima_policy_start(struct seq_file *m, loff_t *pos);
 209 void *ima_policy_next(struct seq_file *m, void *v, loff_t *pos);
 210 void ima_policy_stop(struct seq_file *m, void *v);
 211 int ima_policy_show(struct seq_file *m, void *v);
 212
 213 /* Appraise integrity measurements */
 214 #define IMA_APPRAISE_ENFORCE    0x01
 215 #define IMA_APPRAISE_FIX        0x02
 216 #define IMA_APPRAISE_LOG        0x04
 217 #define IMA_APPRAISE_MODULES    0x08
 218 #define IMA_APPRAISE_FIRMWARE   0x10
 219 #define IMA_APPRAISE_POLICY     0x20
 220
 221 #ifdef CONFIG_IMA_APPRAISE
 222 int ima_appraise_measurement(enum ima_hooks func,
 223                              struct integrity_iint_cache *iint,
 224                              struct file *file, const unsigned char *filename,
 225                              struct evm_ima_xattr_data *xattr_value,
 226                              int xattr_len, int opened);
 227 int ima_must_appraise(struct inode *inode, int mask, enum ima_hooks func);
 228 void ima_update_xattr(struct integrity_iint_cache *iint, struct file *file);
 229 enum integrity_status ima_get_cache_status(struct integrity_iint_cache *iint,
 230                                            enum ima_hooks func);
 231 enum hash_algo ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value,
 232                                  int xattr_len);
 233 int ima_read_xattr(struct dentry *dentry,
 234                    struct evm_ima_xattr_data **xattr_value);
 235
 236 #else
 237 static inline int ima_appraise_measurement(enum ima_hooks func,
 238                                            struct integrity_iint_cache *iint,
 239                                            struct file *file,
 240                                            const unsigned char *filename,
 241                                            struct evm_ima_xattr_data *xattr_value,
 242                                            int xattr_len, int opened)
 243 {
 244         return INTEGRITY_UNKNOWN;
 245 }
 246
 247 static inline int ima_must_appraise(struct inode *inode, int mask,
 248                                     enum ima_hooks func)
 249 {
 250         return 0;
 251 }
 252
 253 static inline void ima_update_xattr(struct integrity_iint_cache *iint,
 254                                     struct file *file)
 255 {
 256 }
 257
 258 static inline enum integrity_status ima_get_cache_status(struct integrity_iint_cache
 259                                                          *iint,
 260                                                          enum ima_hooks func)
 261 {
 262         return INTEGRITY_UNKNOWN;
 263 }
 264
 265 static inline enum hash_algo
 266 ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value, int xattr_len)
 267 {
 268         return ima_hash_algo;
 269 }
 270
 271 static inline int ima_read_xattr(struct dentry *dentry,
 272                                  struct evm_ima_xattr_data **xattr_value)
 273 {
 274         return 0;
 275 }
 276
 277 #endif
 278
 279 /* LSM based policy rules require audit */
 280 #ifdef CONFIG_IMA_LSM_RULES
 281
 282 #define security_filter_rule_init security_audit_rule_init
 283 #define security_filter_rule_match security_audit_rule_match
 284
 285 #else
 286
 287 static inline int security_filter_rule_init(u32 field, u32 op, char *rulestr,
 288                                             void **lsmrule)
 289 {
 290         return -EINVAL;
 291 }
 292
 293 static inline int security_filter_rule_match(u32 secid, u32 field, u32 op,
 294                                              void *lsmrule,
 295                                              struct audit_context *actx)
 296 {
 297         return -EINVAL;
 298 }
 299 #endif /* CONFIG_IMA_TRUSTED_KEYRING */
 300
 301 #ifdef  CONFIG_IMA_READ_POLICY
 302 #define POLICY_FILE_FLAGS       (S_IWUSR | S_IRUSR)
 303 #else
 304 #define POLICY_FILE_FLAGS       S_IWUSR
 305 #endif /* CONFIG_IMA_WRITE_POLICY */
 306
 307 #endif /* __LINUX_IMA_H */