[deliverable/linux.git] / security / integrity / ima / ima.h

/*
 * Copyright (C) 2005,2006,2007,2008 IBM Corporation
 *
 * Authors:
 * Reiner Sailer <sailer@watson.ibm.com>
 * Mimi Zohar <zohar@us.ibm.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, version 2 of the
 * License.
 *
 * File: ima.h
 *	internal Integrity Measurement Architecture (IMA) definitions
 */

#ifndef __LINUX_IMA_H
#define __LINUX_IMA_H

#include <linux/types.h>
#include <linux/crypto.h>
#include <linux/security.h>
#include <linux/hash.h>
#include <linux/tpm.h>
#include <linux/audit.h>
#include <crypto/hash_info.h>

#include "../integrity.h"

enum ima_show_type { IMA_SHOW_BINARY, IMA_SHOW_BINARY_NO_FIELD_LEN,
		     IMA_SHOW_BINARY_OLD_STRING_FMT, IMA_SHOW_ASCII };
enum tpm_pcrs { TPM_PCR0 = 0, TPM_PCR8 = 8 };

/* digest size for IMA, fits SHA1 or MD5 */
#define IMA_DIGEST_SIZE		SHA1_DIGEST_SIZE
#define IMA_EVENT_NAME_LEN_MAX	255

#define IMA_HASH_BITS 9
#define IMA_MEASURE_HTABLE_SIZE (1 << IMA_HASH_BITS)

#define IMA_TEMPLATE_FIELD_ID_MAX_LEN	16
#define IMA_TEMPLATE_NUM_FIELDS_MAX	15

#define IMA_TEMPLATE_IMA_NAME "ima"
#define IMA_TEMPLATE_IMA_FMT "d|n"

/* current content of the policy */
extern int ima_policy_flag;

/* set during initialization */
extern int ima_initialized;
extern int ima_used_chip;
extern int ima_hash_algo;
extern int ima_appraise;

/* IMA event related data */
struct ima_event_data {
	struct integrity_iint_cache *iint;
	struct file *file;
	const unsigned char *filename;
	struct evm_ima_xattr_data *xattr_value;
	int xattr_len;
	const char *violation;
};

/* IMA template field data definition */
struct ima_field_data {
	u8 *data;
	u32 len;
};

/* IMA template field definition */
struct ima_template_field {
	const char field_id[IMA_TEMPLATE_FIELD_ID_MAX_LEN];
	int (*field_init)(struct ima_event_data *event_data,
			  struct ima_field_data *field_data);
	void (*field_show)(struct seq_file *m, enum ima_show_type show,
			   struct ima_field_data *field_data);
};

/* IMA template descriptor definition */
struct ima_template_desc {
	char *name;
	char *fmt;
	int num_fields;
	struct ima_template_field **fields;
};

struct ima_template_entry {
	u8 digest[TPM_DIGEST_SIZE];	/* sha1 or md5 measurement hash */
	struct ima_template_desc *template_desc; /* template descriptor */
	u32 template_data_len;
	struct ima_field_data template_data[0];	/* template related data */
};

struct ima_queue_entry {
	struct hlist_node hnext;	/* place in hash collision list */
	struct list_head later;		/* place in ima_measurements list */
	struct ima_template_entry *entry;
};
extern struct list_head ima_measurements;	/* list of all measurements */

/* Internal IMA function definitions */
int ima_init(void);
int ima_fs_init(void);
int ima_add_template_entry(struct ima_template_entry *entry, int violation,
			   const char *op, struct inode *inode,
			   const unsigned char *filename);
int ima_calc_file_hash(struct file *file, struct ima_digest_data *hash);
int ima_calc_buffer_hash(const void *buf, loff_t len,
			 struct ima_digest_data *hash);
int ima_calc_field_array_hash(struct ima_field_data *field_data,
			      struct ima_template_desc *desc, int num_fields,
			      struct ima_digest_data *hash);
int __init ima_calc_boot_aggregate(struct ima_digest_data *hash);
void ima_add_violation(struct file *file, const unsigned char *filename,
		       struct integrity_iint_cache *iint,
		       const char *op, const char *cause);
int ima_init_crypto(void);
void ima_putc(struct seq_file *m, void *data, int datalen);
void ima_print_digest(struct seq_file *m, u8 *digest, u32 size);
struct ima_template_desc *ima_template_desc_current(void);
int ima_init_template(void);

/*
 * used to protect h_table and sha_table
 */
extern spinlock_t ima_queue_lock;

struct ima_h_table {
	atomic_long_t len;	/* number of stored measurements in the list */
	atomic_long_t violations;
	struct hlist_head queue[IMA_MEASURE_HTABLE_SIZE];
};
extern struct ima_h_table ima_htable;

static inline unsigned long ima_hash_key(u8 *digest)
{
	return hash_long(*digest, IMA_HASH_BITS);
}

enum ima_hooks {
	FILE_CHECK = 1,
	MMAP_CHECK,
	BPRM_CHECK,
	MODULE_CHECK,
	FIRMWARE_CHECK,
	POST_SETATTR
};

/* LIM API function definitions */
int ima_get_action(struct inode *inode, int mask, enum ima_hooks func);
int ima_must_measure(struct inode *inode, int mask, enum ima_hooks func);
int ima_collect_measurement(struct integrity_iint_cache *iint,
			    struct file *file, enum hash_algo algo);
void ima_store_measurement(struct integrity_iint_cache *iint, struct file *file,
			   const unsigned char *filename,
			   struct evm_ima_xattr_data *xattr_value,
			   int xattr_len);
void ima_audit_measurement(struct integrity_iint_cache *iint,
			   const unsigned char *filename);
int ima_alloc_init_template(struct ima_event_data *event_data,
			    struct ima_template_entry **entry);
int ima_store_template(struct ima_template_entry *entry, int violation,
		       struct inode *inode, const unsigned char *filename);
void ima_free_template_entry(struct ima_template_entry *entry);
const char *ima_d_path(struct path *path, char **pathbuf);

/* IMA policy related functions */
int ima_match_policy(struct inode *inode, enum ima_hooks func, int mask,
		     int flags);
void ima_init_policy(void);
void ima_update_policy(void);
void ima_update_policy_flag(void);
ssize_t ima_parse_add_rule(char *);
void ima_delete_rules(void);
int ima_check_policy(void);
void *ima_policy_start(struct seq_file *m, loff_t *pos);
void *ima_policy_next(struct seq_file *m, void *v, loff_t *pos);
void ima_policy_stop(struct seq_file *m, void *v);
int ima_policy_show(struct seq_file *m, void *v);

/* Appraise integrity measurements */
#define IMA_APPRAISE_ENFORCE	0x01
#define IMA_APPRAISE_FIX	0x02
#define IMA_APPRAISE_LOG	0x04
#define IMA_APPRAISE_MODULES	0x08
#define IMA_APPRAISE_FIRMWARE	0x10

#ifdef CONFIG_IMA_APPRAISE
int ima_appraise_measurement(enum ima_hooks func,
			     struct integrity_iint_cache *iint,
			     struct file *file, const unsigned char *filename,
			     struct evm_ima_xattr_data *xattr_value,
			     int xattr_len, int opened);
int ima_must_appraise(struct inode *inode, int mask, enum ima_hooks func);
void ima_update_xattr(struct integrity_iint_cache *iint, struct file *file);
enum integrity_status ima_get_cache_status(struct integrity_iint_cache *iint,
					   enum ima_hooks func);
enum hash_algo ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value,
				 int xattr_len);
int ima_read_xattr(struct dentry *dentry,
		   struct evm_ima_xattr_data **xattr_value);

#else
static inline int ima_appraise_measurement(enum ima_hooks func,
					   struct integrity_iint_cache *iint,
					   struct file *file,
					   const unsigned char *filename,
					   struct evm_ima_xattr_data *xattr_value,
					   int xattr_len, int opened)
{
	return INTEGRITY_UNKNOWN;
}

static inline int ima_must_appraise(struct inode *inode, int mask,
				    enum ima_hooks func)
{
	return 0;
}

static inline void ima_update_xattr(struct integrity_iint_cache *iint,
				    struct file *file)
{
}

static inline enum integrity_status ima_get_cache_status(struct integrity_iint_cache
							 *iint,
							 enum ima_hooks func)
{
	return INTEGRITY_UNKNOWN;
}

static inline enum hash_algo
ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value, int xattr_len)
{
	return ima_hash_algo;
}

static inline int ima_read_xattr(struct dentry *dentry,
				 struct evm_ima_xattr_data **xattr_value)
{
	return 0;
}

#endif

/* LSM based policy rules require audit */
#ifdef CONFIG_IMA_LSM_RULES

#define security_filter_rule_init security_audit_rule_init
#define security_filter_rule_match security_audit_rule_match

#else

static inline int security_filter_rule_init(u32 field, u32 op, char *rulestr,
					    void **lsmrule)
{
	return -EINVAL;
}

static inline int security_filter_rule_match(u32 secid, u32 field, u32 op,
					     void *lsmrule,
					     struct audit_context *actx)
{
	return -EINVAL;
}
#endif /* CONFIG_IMA_TRUSTED_KEYRING */

#ifdef	CONFIG_IMA_READ_POLICY
#define	POLICY_FILE_FLAGS	(S_IWUSR | S_IRUSR)
#else
#define	POLICY_FILE_FLAGS	S_IWUSR
#endif /* CONFIG_IMA_WRITE_POLICY */

#endif /* __LINUX_IMA_H */
Commit	Line	Data
3323eec9 MZ	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/security.h>
	23	#include <linux/hash.h>
	24	#include <linux/tpm.h>
	25	#include <linux/audit.h>
1525b06d	26	#include <crypto/hash_info.h>
3323eec9	27
f381c272 MZ	28	#include "../integrity.h"
f381c272 MZ	29
3e8e5503	30	enum ima_show_type { IMA_SHOW_BINARY, IMA_SHOW_BINARY_NO_FIELD_LEN,
c019e307	31	IMA_SHOW_BINARY_OLD_STRING_FMT, IMA_SHOW_ASCII };
3323eec9 MZ	32	enum tpm_pcrs { TPM_PCR0 = 0, TPM_PCR8 = 8 };
	33
	34	/* digest size for IMA, fits SHA1 or MD5 */
f381c272	35	#define IMA_DIGEST_SIZE SHA1_DIGEST_SIZE
3323eec9 MZ	36	#define IMA_EVENT_NAME_LEN_MAX 255
	37
	38	#define IMA_HASH_BITS 9
	39	#define IMA_MEASURE_HTABLE_SIZE (1 << IMA_HASH_BITS)
	40
adf53a77 RS	41	#define IMA_TEMPLATE_FIELD_ID_MAX_LEN 16
	42	#define IMA_TEMPLATE_NUM_FIELDS_MAX 15
	43
3ce1217d RS	44	#define IMA_TEMPLATE_IMA_NAME "ima"
	45	#define IMA_TEMPLATE_IMA_FMT "d\|n"
	46
a756024e RS	47	/* current content of the policy */
	48	extern int ima_policy_flag;
	49
3323eec9 MZ	50	/* set during initialization */
	51	extern int ima_initialized;
	52	extern int ima_used_chip;
c7c8bb23	53	extern int ima_hash_algo;
2fe5d6de	54	extern int ima_appraise;
3323eec9	55
23b57419 RS	56	/* IMA event related data */
	57	struct 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;
8d94eb9b	63	const char *violation;
23b57419 RS	64	};
23b57419 RS	65
adf53a77 RS	66	/* IMA template field data definition */
	67	struct ima_field_data {
	68	u8 *data;
	69	u32 len;
	70	};
	71
	72	/* IMA template field definition */
	73	struct ima_template_field {
	74	const char field_id[IMA_TEMPLATE_FIELD_ID_MAX_LEN];
23b57419 RS	75	int (field_init)(struct ima_event_data event_data,
	76	struct ima_field_data *field_data);
	77	void (field_show)(struct seq_file m, enum ima_show_type show,
	78	struct ima_field_data *field_data);
adf53a77 RS	79	};
	80
	81	/* IMA template descriptor definition */
	82	struct ima_template_desc {
	83	char *name;
	84	char *fmt;
	85	int num_fields;
	86	struct ima_template_field **fields;
	87	};
	88
3323eec9	89	struct ima_template_entry {
140d8022	90	u8 digest[TPM_DIGEST_SIZE]; /* sha1 or md5 measurement hash */
a71dc65d RS	91	struct ima_template_desc template_desc; / template descriptor */
	92	u32 template_data_len;
	93	struct ima_field_data template_data[0]; /* template related data */
3323eec9 MZ	94	};
	95
	96	struct ima_queue_entry {
	97	struct hlist_node hnext; /* place in hash collision list */
	98	struct list_head later; /* place in ima_measurements list */
	99	struct ima_template_entry *entry;
	100	};
	101	extern struct list_head ima_measurements; /* list of all measurements */
	102
3323eec9	103	/* Internal IMA function definitions */
3323eec9	104	int ima_init(void);
bab73937	105	int ima_fs_init(void);
3323eec9	106	int ima_add_template_entry(struct ima_template_entry *entry, int violation,
9803d413 RS	107	const char op, struct inode inode,
9803d413 RS	108	const unsigned char *filename);
c7c8bb23	109	int ima_calc_file_hash(struct file file, struct ima_digest_data hash);
11d7646d DK	110	int ima_calc_buffer_hash(const void *buf, loff_t len,
11d7646d DK	111	struct ima_digest_data *hash);
b6f8f16f RS	112	int ima_calc_field_array_hash(struct ima_field_data *field_data,
b6f8f16f RS	113	struct ima_template_desc *desc, int num_fields,
a71dc65d	114	struct ima_digest_data *hash);
09ef5435	115	int __init ima_calc_boot_aggregate(struct ima_digest_data *hash);
7d802a22	116	void ima_add_violation(struct file file, const unsigned char filename,
8d94eb9b	117	struct integrity_iint_cache *iint,
3323eec9	118	const char op, const char cause);
76bb28f6	119	int ima_init_crypto(void);
3ce1217d	120	void ima_putc(struct seq_file m, void data, int datalen);
45b26133	121	void ima_print_digest(struct seq_file m, u8 digest, u32 size);
a71dc65d RS	122	struct ima_template_desc *ima_template_desc_current(void);
a71dc65d RS	123	int ima_init_template(void);
3323eec9 MZ	124
	125	/*
	126	* used to protect h_table and sha_table
	127	*/
	128	extern spinlock_t ima_queue_lock;
	129
	130	struct ima_h_table {
	131	atomic_long_t len; /* number of stored measurements in the list */
	132	atomic_long_t violations;
	133	struct hlist_head queue[IMA_MEASURE_HTABLE_SIZE];
	134	};
	135	extern struct ima_h_table ima_htable;
	136
	137	static inline unsigned long ima_hash_key(u8 *digest)
	138	{
	139	return hash_long(*digest, IMA_HASH_BITS);
	140	}
	141
4ad87a3d MZ	142	enum ima_hooks {
	143	FILE_CHECK = 1,
	144	MMAP_CHECK,
	145	BPRM_CHECK,
	146	MODULE_CHECK,
	147	FIRMWARE_CHECK,
	148	POST_SETATTR
	149	};
	150
3323eec9	151	/* LIM API function definitions */
4ad87a3d MZ	152	int ima_get_action(struct inode *inode, int mask, enum ima_hooks func);
4ad87a3d MZ	153	int ima_must_measure(struct inode *inode, int mask, enum ima_hooks func);
f381c272	154	int ima_collect_measurement(struct integrity_iint_cache *iint,
1525b06d	155	struct file *file, enum hash_algo algo);
f381c272	156	void ima_store_measurement(struct integrity_iint_cache iint, struct file file,
bcbc9b0c MZ	157	const unsigned char *filename,
	158	struct evm_ima_xattr_data *xattr_value,
	159	int xattr_len);
e7c568e0 PM	160	void ima_audit_measurement(struct integrity_iint_cache *iint,
e7c568e0 PM	161	const unsigned char *filename);
23b57419 RS	162	int ima_alloc_init_template(struct ima_event_data *event_data,
23b57419 RS	163	struct ima_template_entry **entry);
3323eec9	164	int ima_store_template(struct ima_template_entry *entry, int violation,
9803d413	165	struct inode inode, const unsigned char filename);
a7ed7c60	166	void ima_free_template_entry(struct ima_template_entry *entry);
ea1046d4	167	const char ima_d_path(struct path path, char **pathbuf);
3323eec9	168
3323eec9	169	/* IMA policy related functions */
2fe5d6de MZ	170	int ima_match_policy(struct inode *inode, enum ima_hooks func, int mask,
2fe5d6de MZ	171	int flags);
3323eec9 MZ	172	void ima_init_policy(void);
3323eec9 MZ	173	void ima_update_policy(void);
a756024e	174	void ima_update_policy_flag(void);
6ccd0456	175	ssize_t ima_parse_add_rule(char *);
4af4662f	176	void ima_delete_rules(void);
0112721d	177	int ima_check_policy(void);
80eae209 PM	178	void ima_policy_start(struct seq_file m, loff_t *pos);
	179	void ima_policy_next(struct seq_file m, void v, loff_t pos);
	180	void ima_policy_stop(struct seq_file m, void v);
	181	int ima_policy_show(struct seq_file m, void v);
4af4662f	182
2fe5d6de MZ	183	/* Appraise integrity measurements */
	184	#define IMA_APPRAISE_ENFORCE 0x01
	185	#define IMA_APPRAISE_FIX 0x02
2faa6ef3 DK	186	#define IMA_APPRAISE_LOG 0x04
	187	#define IMA_APPRAISE_MODULES 0x08
	188	#define IMA_APPRAISE_FIRMWARE 0x10
2fe5d6de MZ	189
2fe5d6de MZ	190	#ifdef CONFIG_IMA_APPRAISE
4ad87a3d MZ	191	int ima_appraise_measurement(enum ima_hooks func,
4ad87a3d MZ	192	struct integrity_iint_cache *iint,
d3634d0f DK	193	struct file file, const unsigned char filename,
d3634d0f DK	194	struct evm_ima_xattr_data *xattr_value,
3034a146	195	int xattr_len, int opened);
d26e1936	196	int ima_must_appraise(struct inode *inode, int mask, enum ima_hooks func);
2fe5d6de	197	void ima_update_xattr(struct integrity_iint_cache iint, struct file file);
d79d72e0	198	enum integrity_status ima_get_cache_status(struct integrity_iint_cache *iint,
4ad87a3d	199	enum ima_hooks func);
1525b06d DK	200	enum hash_algo ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value,
1525b06d DK	201	int xattr_len);
d3634d0f DK	202	int ima_read_xattr(struct dentry *dentry,
d3634d0f DK	203	struct evm_ima_xattr_data **xattr_value);
2fe5d6de MZ	204
2fe5d6de MZ	205	#else
4ad87a3d	206	static inline int ima_appraise_measurement(enum ima_hooks func,
d79d72e0	207	struct integrity_iint_cache *iint,
2fe5d6de	208	struct file *file,
d3634d0f DK	209	const unsigned char *filename,
d3634d0f DK	210	struct evm_ima_xattr_data *xattr_value,
3034a146	211	int xattr_len, int opened)
2fe5d6de MZ	212	{
	213	return INTEGRITY_UNKNOWN;
	214	}
	215
d26e1936 DK	216	static inline int ima_must_appraise(struct inode *inode, int mask,
d26e1936 DK	217	enum ima_hooks func)
2fe5d6de MZ	218	{
	219	return 0;
	220	}
	221
	222	static inline void ima_update_xattr(struct integrity_iint_cache *iint,
	223	struct file *file)
	224	{
	225	}
d79d72e0 MZ	226
d79d72e0 MZ	227	static inline enum integrity_status ima_get_cache_status(struct integrity_iint_cache
4ad87a3d MZ	228	*iint,
4ad87a3d MZ	229	enum ima_hooks func)
d79d72e0 MZ	230	{
	231	return INTEGRITY_UNKNOWN;
	232	}
d3634d0f	233
1525b06d DK	234	static inline enum hash_algo
1525b06d DK	235	ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value, int xattr_len)
d3634d0f	236	{
1525b06d	237	return ima_hash_algo;
d3634d0f DK	238	}
	239
	240	static inline int ima_read_xattr(struct dentry *dentry,
	241	struct evm_ima_xattr_data **xattr_value)
	242	{
	243	return 0;
	244	}
	245
2fe5d6de MZ	246	#endif
2fe5d6de MZ	247
4af4662f MZ	248	/* LSM based policy rules require audit */
	249	#ifdef CONFIG_IMA_LSM_RULES
	250
	251	#define security_filter_rule_init security_audit_rule_init
	252	#define security_filter_rule_match security_audit_rule_match
	253
	254	#else
	255
	256	static inline int security_filter_rule_init(u32 field, u32 op, char *rulestr,
	257	void **lsmrule)
	258	{
	259	return -EINVAL;
	260	}
	261
	262	static inline int security_filter_rule_match(u32 secid, u32 field, u32 op,
	263	void *lsmrule,
	264	struct audit_context *actx)
	265	{
	266	return -EINVAL;
	267	}
80eae209 PM	268	#endif /* CONFIG_IMA_TRUSTED_KEYRING */
	269
	270	#ifdef CONFIG_IMA_READ_POLICY
	271	#define POLICY_FILE_FLAGS (S_IWUSR \| S_IRUSR)
	272	#else
	273	#define POLICY_FILE_FLAGS S_IWUSR
	274	#endif /* CONFIG_IMA_WRITE_POLICY */
	275
	276	#endif /* __LINUX_IMA_H */