Merge branch 'next-integrity' of git://git.kernel.org/pub/scm/linux/kernel/git/zohar...
[linux-2.6-block.git] / security / integrity / ima / ima.h
CommitLineData
b886d83c 1/* SPDX-License-Identifier: GPL-2.0-only */
3323eec9
MZ
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 *
3323eec9
MZ
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>
cf222217 18#include <linux/fs.h>
3323eec9
MZ
19#include <linux/security.h>
20#include <linux/hash.h>
21#include <linux/tpm.h>
22#include <linux/audit.h>
1525b06d 23#include <crypto/hash_info.h>
3323eec9 24
f381c272
MZ
25#include "../integrity.h"
26
94c3aac5
MZ
27#ifdef CONFIG_HAVE_IMA_KEXEC
28#include <asm/ima.h>
29#endif
30
3e8e5503 31enum ima_show_type { IMA_SHOW_BINARY, IMA_SHOW_BINARY_NO_FIELD_LEN,
c019e307 32 IMA_SHOW_BINARY_OLD_STRING_FMT, IMA_SHOW_ASCII };
3323eec9
MZ
33enum tpm_pcrs { TPM_PCR0 = 0, TPM_PCR8 = 8 };
34
35/* digest size for IMA, fits SHA1 or MD5 */
f381c272 36#define IMA_DIGEST_SIZE SHA1_DIGEST_SIZE
3323eec9
MZ
37#define IMA_EVENT_NAME_LEN_MAX 255
38
39#define IMA_HASH_BITS 9
40#define IMA_MEASURE_HTABLE_SIZE (1 << IMA_HASH_BITS)
41
adf53a77
RS
42#define IMA_TEMPLATE_FIELD_ID_MAX_LEN 16
43#define IMA_TEMPLATE_NUM_FIELDS_MAX 15
44
3ce1217d
RS
45#define IMA_TEMPLATE_IMA_NAME "ima"
46#define IMA_TEMPLATE_IMA_FMT "d|n"
47
a756024e
RS
48/* current content of the policy */
49extern int ima_policy_flag;
50
3323eec9 51/* set during initialization */
c7c8bb23 52extern int ima_hash_algo;
2fe5d6de 53extern int ima_appraise;
5c2a640a 54extern struct tpm_chip *ima_tpm_chip;
3323eec9 55
23b57419
RS
56/* IMA event related data */
57struct ima_event_data {
58 struct integrity_iint_cache *iint;
59 struct file *file;
60 const unsigned char *filename;
61 struct evm_ima_xattr_data *xattr_value;
62 int xattr_len;
3878d505 63 const struct modsig *modsig;
8d94eb9b 64 const char *violation;
86b4da8c
PS
65 const void *buf;
66 int buf_len;
23b57419
RS
67};
68
adf53a77
RS
69/* IMA template field data definition */
70struct ima_field_data {
71 u8 *data;
72 u32 len;
73};
74
75/* IMA template field definition */
76struct ima_template_field {
77 const char field_id[IMA_TEMPLATE_FIELD_ID_MAX_LEN];
23b57419
RS
78 int (*field_init)(struct ima_event_data *event_data,
79 struct ima_field_data *field_data);
80 void (*field_show)(struct seq_file *m, enum ima_show_type show,
81 struct ima_field_data *field_data);
adf53a77
RS
82};
83
84/* IMA template descriptor definition */
85struct ima_template_desc {
3f23d624 86 struct list_head list;
adf53a77
RS
87 char *name;
88 char *fmt;
89 int num_fields;
b2724d58 90 const struct ima_template_field **fields;
adf53a77
RS
91};
92
3323eec9 93struct ima_template_entry {
14b1da85 94 int pcr;
140d8022 95 u8 digest[TPM_DIGEST_SIZE]; /* sha1 or md5 measurement hash */
a71dc65d
RS
96 struct ima_template_desc *template_desc; /* template descriptor */
97 u32 template_data_len;
98 struct ima_field_data template_data[0]; /* template related data */
3323eec9
MZ
99};
100
101struct ima_queue_entry {
102 struct hlist_node hnext; /* place in hash collision list */
103 struct list_head later; /* place in ima_measurements list */
104 struct ima_template_entry *entry;
105};
106extern struct list_head ima_measurements; /* list of all measurements */
107
94c3aac5
MZ
108/* Some details preceding the binary serialized measurement list */
109struct ima_kexec_hdr {
110 u16 version;
111 u16 _reserved0;
112 u32 _reserved1;
113 u64 buffer_size;
114 u64 count;
115};
116
117#ifdef CONFIG_HAVE_IMA_KEXEC
118void ima_load_kexec_buffer(void);
119#else
120static inline void ima_load_kexec_buffer(void) {}
121#endif /* CONFIG_HAVE_IMA_KEXEC */
122
d68a6fe9
MZ
123/*
124 * The default binary_runtime_measurements list format is defined as the
125 * platform native format. The canonical format is defined as little-endian.
126 */
127extern bool ima_canonical_fmt;
128
3323eec9 129/* Internal IMA function definitions */
3323eec9 130int ima_init(void);
bab73937 131int ima_fs_init(void);
3323eec9 132int ima_add_template_entry(struct ima_template_entry *entry, int violation,
9803d413
RS
133 const char *op, struct inode *inode,
134 const unsigned char *filename);
c7c8bb23 135int ima_calc_file_hash(struct file *file, struct ima_digest_data *hash);
11d7646d
DK
136int ima_calc_buffer_hash(const void *buf, loff_t len,
137 struct ima_digest_data *hash);
b6f8f16f
RS
138int ima_calc_field_array_hash(struct ima_field_data *field_data,
139 struct ima_template_desc *desc, int num_fields,
a71dc65d 140 struct ima_digest_data *hash);
09ef5435 141int __init ima_calc_boot_aggregate(struct ima_digest_data *hash);
7d802a22 142void ima_add_violation(struct file *file, const unsigned char *filename,
8d94eb9b 143 struct integrity_iint_cache *iint,
3323eec9 144 const char *op, const char *cause);
76bb28f6 145int ima_init_crypto(void);
3ce1217d 146void ima_putc(struct seq_file *m, void *data, int datalen);
45b26133 147void ima_print_digest(struct seq_file *m, u8 *digest, u32 size);
19453ce0
MG
148int template_desc_init_fields(const char *template_fmt,
149 const struct ima_template_field ***fields,
150 int *num_fields);
a71dc65d 151struct ima_template_desc *ima_template_desc_current(void);
19453ce0 152struct ima_template_desc *lookup_template_desc(const char *name);
e5092255 153bool ima_template_has_modsig(const struct ima_template_desc *ima_template);
94c3aac5
MZ
154int ima_restore_measurement_entry(struct ima_template_entry *entry);
155int ima_restore_measurement_list(loff_t bufsize, void *buf);
7b8589cc 156int ima_measurements_show(struct seq_file *m, void *v);
d158847a 157unsigned long ima_get_binary_runtime_size(void);
a71dc65d 158int ima_init_template(void);
3f23d624 159void ima_init_template_list(void);
0b6cf6b9 160int __init ima_init_digests(void);
b1694245
JK
161int ima_lsm_policy_change(struct notifier_block *nb, unsigned long event,
162 void *lsm_data);
3323eec9
MZ
163
164/*
165 * used to protect h_table and sha_table
166 */
167extern spinlock_t ima_queue_lock;
168
169struct ima_h_table {
170 atomic_long_t len; /* number of stored measurements in the list */
171 atomic_long_t violations;
172 struct hlist_head queue[IMA_MEASURE_HTABLE_SIZE];
173};
174extern struct ima_h_table ima_htable;
175
176static inline unsigned long ima_hash_key(u8 *digest)
177{
178 return hash_long(*digest, IMA_HASH_BITS);
179}
180
2663218b
TJB
181#define __ima_hooks(hook) \
182 hook(NONE) \
183 hook(FILE_CHECK) \
184 hook(MMAP_CHECK) \
185 hook(BPRM_CHECK) \
d906c10d 186 hook(CREDS_CHECK) \
2663218b
TJB
187 hook(POST_SETATTR) \
188 hook(MODULE_CHECK) \
189 hook(FIRMWARE_CHECK) \
190 hook(KEXEC_KERNEL_CHECK) \
191 hook(KEXEC_INITRAMFS_CHECK) \
192 hook(POLICY_CHECK) \
b0935123 193 hook(KEXEC_CMDLINE) \
2663218b
TJB
194 hook(MAX_CHECK)
195#define __ima_hook_enumify(ENUM) ENUM,
196
4ad87a3d 197enum ima_hooks {
2663218b 198 __ima_hooks(__ima_hook_enumify)
4ad87a3d
MZ
199};
200
39b07096
TJB
201extern const char *const func_tokens[];
202
203struct modsig;
204
3323eec9 205/* LIM API function definitions */
d906c10d 206int ima_get_action(struct inode *inode, const struct cred *cred, u32 secid,
19453ce0
MG
207 int mask, enum ima_hooks func, int *pcr,
208 struct ima_template_desc **template_desc);
4ad87a3d 209int ima_must_measure(struct inode *inode, int mask, enum ima_hooks func);
f381c272 210int ima_collect_measurement(struct integrity_iint_cache *iint,
cf222217 211 struct file *file, void *buf, loff_t size,
15588227 212 enum hash_algo algo, struct modsig *modsig);
f381c272 213void ima_store_measurement(struct integrity_iint_cache *iint, struct file *file,
bcbc9b0c
MZ
214 const unsigned char *filename,
215 struct evm_ima_xattr_data *xattr_value,
3878d505 216 int xattr_len, const struct modsig *modsig, int pcr,
19453ce0 217 struct ima_template_desc *template_desc);
e7c568e0
PM
218void ima_audit_measurement(struct integrity_iint_cache *iint,
219 const unsigned char *filename);
23b57419 220int ima_alloc_init_template(struct ima_event_data *event_data,
19453ce0
MG
221 struct ima_template_entry **entry,
222 struct ima_template_desc *template_desc);
3323eec9 223int ima_store_template(struct ima_template_entry *entry, int violation,
14b1da85
ER
224 struct inode *inode,
225 const unsigned char *filename, int pcr);
a7ed7c60 226void ima_free_template_entry(struct ima_template_entry *entry);
bc15ed66 227const char *ima_d_path(const struct path *path, char **pathbuf, char *filename);
3323eec9 228
3323eec9 229/* IMA policy related functions */
d906c10d 230int ima_match_policy(struct inode *inode, const struct cred *cred, u32 secid,
19453ce0
MG
231 enum ima_hooks func, int mask, int flags, int *pcr,
232 struct ima_template_desc **template_desc);
3323eec9
MZ
233void ima_init_policy(void);
234void ima_update_policy(void);
a756024e 235void ima_update_policy_flag(void);
6ccd0456 236ssize_t ima_parse_add_rule(char *);
4af4662f 237void ima_delete_rules(void);
0112721d 238int ima_check_policy(void);
80eae209
PM
239void *ima_policy_start(struct seq_file *m, loff_t *pos);
240void *ima_policy_next(struct seq_file *m, void *v, loff_t *pos);
241void ima_policy_stop(struct seq_file *m, void *v);
242int ima_policy_show(struct seq_file *m, void *v);
4af4662f 243
2fe5d6de
MZ
244/* Appraise integrity measurements */
245#define IMA_APPRAISE_ENFORCE 0x01
246#define IMA_APPRAISE_FIX 0x02
2faa6ef3
DK
247#define IMA_APPRAISE_LOG 0x04
248#define IMA_APPRAISE_MODULES 0x08
249#define IMA_APPRAISE_FIRMWARE 0x10
19f8a847 250#define IMA_APPRAISE_POLICY 0x20
16c267aa 251#define IMA_APPRAISE_KEXEC 0x40
2fe5d6de
MZ
252
253#ifdef CONFIG_IMA_APPRAISE
4ad87a3d
MZ
254int ima_appraise_measurement(enum ima_hooks func,
255 struct integrity_iint_cache *iint,
d3634d0f
DK
256 struct file *file, const unsigned char *filename,
257 struct evm_ima_xattr_data *xattr_value,
39b07096 258 int xattr_len, const struct modsig *modsig);
d26e1936 259int ima_must_appraise(struct inode *inode, int mask, enum ima_hooks func);
2fe5d6de 260void ima_update_xattr(struct integrity_iint_cache *iint, struct file *file);
d79d72e0 261enum integrity_status ima_get_cache_status(struct integrity_iint_cache *iint,
4ad87a3d 262 enum ima_hooks func);
1525b06d
DK
263enum hash_algo ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value,
264 int xattr_len);
d3634d0f
DK
265int ima_read_xattr(struct dentry *dentry,
266 struct evm_ima_xattr_data **xattr_value);
2fe5d6de
MZ
267
268#else
4ad87a3d 269static inline int ima_appraise_measurement(enum ima_hooks func,
d79d72e0 270 struct integrity_iint_cache *iint,
2fe5d6de 271 struct file *file,
d3634d0f
DK
272 const unsigned char *filename,
273 struct evm_ima_xattr_data *xattr_value,
39b07096
TJB
274 int xattr_len,
275 const struct modsig *modsig)
2fe5d6de
MZ
276{
277 return INTEGRITY_UNKNOWN;
278}
279
d26e1936
DK
280static inline int ima_must_appraise(struct inode *inode, int mask,
281 enum ima_hooks func)
2fe5d6de
MZ
282{
283 return 0;
284}
285
286static inline void ima_update_xattr(struct integrity_iint_cache *iint,
287 struct file *file)
288{
289}
d79d72e0
MZ
290
291static inline enum integrity_status ima_get_cache_status(struct integrity_iint_cache
4ad87a3d
MZ
292 *iint,
293 enum ima_hooks func)
d79d72e0
MZ
294{
295 return INTEGRITY_UNKNOWN;
296}
d3634d0f 297
1525b06d
DK
298static inline enum hash_algo
299ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value, int xattr_len)
d3634d0f 300{
1525b06d 301 return ima_hash_algo;
d3634d0f
DK
302}
303
304static inline int ima_read_xattr(struct dentry *dentry,
305 struct evm_ima_xattr_data **xattr_value)
306{
307 return 0;
308}
309
bb543e39 310#endif /* CONFIG_IMA_APPRAISE */
2fe5d6de 311
9044d627
TJB
312#ifdef CONFIG_IMA_APPRAISE_MODSIG
313bool ima_hook_supports_modsig(enum ima_hooks func);
39b07096
TJB
314int ima_read_modsig(enum ima_hooks func, const void *buf, loff_t buf_len,
315 struct modsig **modsig);
15588227 316void ima_collect_modsig(struct modsig *modsig, const void *buf, loff_t size);
3878d505
TJB
317int ima_get_modsig_digest(const struct modsig *modsig, enum hash_algo *algo,
318 const u8 **digest, u32 *digest_size);
319int ima_get_raw_modsig(const struct modsig *modsig, const void **data,
320 u32 *data_len);
39b07096 321void ima_free_modsig(struct modsig *modsig);
9044d627
TJB
322#else
323static inline bool ima_hook_supports_modsig(enum ima_hooks func)
324{
325 return false;
326}
39b07096
TJB
327
328static inline int ima_read_modsig(enum ima_hooks func, const void *buf,
329 loff_t buf_len, struct modsig **modsig)
330{
331 return -EOPNOTSUPP;
332}
333
15588227
TJB
334static inline void ima_collect_modsig(struct modsig *modsig, const void *buf,
335 loff_t size)
336{
337}
338
3878d505
TJB
339static inline int ima_get_modsig_digest(const struct modsig *modsig,
340 enum hash_algo *algo, const u8 **digest,
341 u32 *digest_size)
342{
343 return -EOPNOTSUPP;
344}
345
346static inline int ima_get_raw_modsig(const struct modsig *modsig,
347 const void **data, u32 *data_len)
348{
349 return -EOPNOTSUPP;
350}
351
39b07096
TJB
352static inline void ima_free_modsig(struct modsig *modsig)
353{
354}
9044d627
TJB
355#endif /* CONFIG_IMA_APPRAISE_MODSIG */
356
4af4662f
MZ
357/* LSM based policy rules require audit */
358#ifdef CONFIG_IMA_LSM_RULES
359
360#define security_filter_rule_init security_audit_rule_init
361#define security_filter_rule_match security_audit_rule_match
362
363#else
364
365static inline int security_filter_rule_init(u32 field, u32 op, char *rulestr,
366 void **lsmrule)
367{
368 return -EINVAL;
369}
370
371static inline int security_filter_rule_match(u32 secid, u32 field, u32 op,
90462a5b 372 void *lsmrule)
4af4662f
MZ
373{
374 return -EINVAL;
375}
5d659f28 376#endif /* CONFIG_IMA_LSM_RULES */
80eae209
PM
377
378#ifdef CONFIG_IMA_READ_POLICY
379#define POLICY_FILE_FLAGS (S_IWUSR | S_IRUSR)
380#else
381#define POLICY_FILE_FLAGS S_IWUSR
5d659f28 382#endif /* CONFIG_IMA_READ_POLICY */
80eae209
PM
383
384#endif /* __LINUX_IMA_H */