[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 "../integrity.h"

enum ima_show_type { IMA_SHOW_BINARY, 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

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

/* 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 integrity_iint_cache *iint, struct file *file,
			   const unsigned char *filename,
			   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;
};

/* IMA inode template definition */
struct ima_template_data {
	u8 digest[IMA_DIGEST_SIZE];	/* sha1/md5 measurement hash */
	char file_name[IMA_EVENT_NAME_LEN_MAX + 1];	/* name + \0 */
};

struct ima_template_entry {
	u8 digest[TPM_DIGEST_SIZE];	/* sha1 or md5 measurement hash */
	const char *template_name;
	int template_len;
	struct ima_template_data template;
};

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);
void ima_cleanup(void);
int ima_fs_init(void);
void ima_fs_cleanup(void);
int ima_inode_alloc(struct inode *inode);
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 *data, int len,
			 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,
		       const char *op, const char *cause);
int ima_init_crypto(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);
}

/* LIM API function definitions */
int ima_get_action(struct inode *inode, int mask, int function);
int ima_must_measure(struct inode *inode, int mask, int function);
int ima_collect_measurement(struct integrity_iint_cache *iint,
			    struct file *file,
			    struct evm_ima_xattr_data **xattr_value,
			    int *xattr_len);
void ima_store_measurement(struct integrity_iint_cache *iint, struct file *file,
			   const unsigned char *filename);
void ima_audit_measurement(struct integrity_iint_cache *iint,
			   const unsigned char *filename);
int ima_alloc_init_template(struct integrity_iint_cache *iint,
			    struct file *file, const unsigned char *filename,
			    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_template_show(struct seq_file *m, void *e, enum ima_show_type show);
const char *ima_d_path(struct path *path, char **pathbuf);

/* rbtree tree calls to lookup, insert, delete
 * integrity data associated with an inode.
 */
struct integrity_iint_cache *integrity_iint_insert(struct inode *inode);
struct integrity_iint_cache *integrity_iint_find(struct inode *inode);

/* IMA policy related functions */
enum ima_hooks { FILE_CHECK = 1, MMAP_CHECK, BPRM_CHECK, MODULE_CHECK, POST_SETATTR };

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);
ssize_t ima_parse_add_rule(char *);
void ima_delete_rules(void);

/* Appraise integrity measurements */
#define IMA_APPRAISE_ENFORCE	0x01
#define IMA_APPRAISE_FIX	0x02
#define IMA_APPRAISE_MODULES	0x04

#ifdef CONFIG_IMA_APPRAISE
int ima_appraise_measurement(int func, struct integrity_iint_cache *iint,
			     struct file *file, const unsigned char *filename,
			     struct evm_ima_xattr_data *xattr_value,
			     int xattr_len);
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,
					   int func);
void ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value, int xattr_len,
		       struct ima_digest_data *hash);
int ima_read_xattr(struct dentry *dentry,
		   struct evm_ima_xattr_data **xattr_value);

#else
static inline int ima_appraise_measurement(int func,
					   struct integrity_iint_cache *iint,
					   struct file *file,
					   const unsigned char *filename,
					   struct evm_ima_xattr_data *xattr_value,
					   int xattr_len)
{
	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, int func)
{
	return INTEGRITY_UNKNOWN;
}

static inline void ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value,
				     int xattr_len,
				     struct ima_digest_data *hash)
{
}

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_LSM_RULES */
#endif
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>
	26
f381c272 MZ	27	#include "../integrity.h"
f381c272 MZ	28
3323eec9 MZ	29	enum ima_show_type { IMA_SHOW_BINARY, IMA_SHOW_ASCII };
	30	enum tpm_pcrs { TPM_PCR0 = 0, TPM_PCR8 = 8 };
	31
	32	/* digest size for IMA, fits SHA1 or MD5 */
f381c272	33	#define IMA_DIGEST_SIZE SHA1_DIGEST_SIZE
3323eec9 MZ	34	#define IMA_EVENT_NAME_LEN_MAX 255
	35
	36	#define IMA_HASH_BITS 9
	37	#define IMA_MEASURE_HTABLE_SIZE (1 << IMA_HASH_BITS)
	38
adf53a77 RS	39	#define IMA_TEMPLATE_FIELD_ID_MAX_LEN 16
	40	#define IMA_TEMPLATE_NUM_FIELDS_MAX 15
	41
3323eec9 MZ	42	/* set during initialization */
	43	extern int ima_initialized;
	44	extern int ima_used_chip;
c7c8bb23	45	extern int ima_hash_algo;
2fe5d6de	46	extern int ima_appraise;
3323eec9	47
adf53a77 RS	48	/* IMA template field data definition */
	49	struct ima_field_data {
	50	u8 *data;
	51	u32 len;
	52	};
	53
	54	/* IMA template field definition */
	55	struct ima_template_field {
	56	const char field_id[IMA_TEMPLATE_FIELD_ID_MAX_LEN];
	57	int (field_init) (struct integrity_iint_cache iint, struct file *file,
	58	const unsigned char *filename,
	59	struct ima_field_data *field_data);
	60	void (field_show) (struct seq_file m, enum ima_show_type show,
	61	struct ima_field_data *field_data);
	62	};
	63
	64	/* IMA template descriptor definition */
	65	struct ima_template_desc {
	66	char *name;
	67	char *fmt;
	68	int num_fields;
	69	struct ima_template_field **fields;
	70	};
	71
3323eec9 MZ	72	/* IMA inode template definition */
	73	struct ima_template_data {
	74	u8 digest[IMA_DIGEST_SIZE]; /* sha1/md5 measurement hash */
	75	char file_name[IMA_EVENT_NAME_LEN_MAX + 1]; /* name + \0 */
	76	};
	77
	78	struct ima_template_entry {
140d8022	79	u8 digest[TPM_DIGEST_SIZE]; /* sha1 or md5 measurement hash */
523979ad	80	const char *template_name;
3323eec9 MZ	81	int template_len;
	82	struct ima_template_data template;
	83	};
	84
	85	struct ima_queue_entry {
	86	struct hlist_node hnext; /* place in hash collision list */
	87	struct list_head later; /* place in ima_measurements list */
	88	struct ima_template_entry *entry;
	89	};
	90	extern struct list_head ima_measurements; /* list of all measurements */
	91
3323eec9	92	/* Internal IMA function definitions */
3323eec9	93	int ima_init(void);
bab73937 MZ	94	void ima_cleanup(void);
	95	int ima_fs_init(void);
	96	void ima_fs_cleanup(void);
a178d202	97	int ima_inode_alloc(struct inode *inode);
3323eec9	98	int ima_add_template_entry(struct ima_template_entry *entry, int violation,
9803d413 RS	99	const char op, struct inode inode,
9803d413 RS	100	const unsigned char *filename);
c7c8bb23 DK	101	int ima_calc_file_hash(struct file file, struct ima_digest_data hash);
	102	int ima_calc_buffer_hash(const void *data, int len,
	103	struct ima_digest_data *hash);
09ef5435	104	int __init ima_calc_boot_aggregate(struct ima_digest_data *hash);
7d802a22	105	void ima_add_violation(struct file file, const unsigned char filename,
3323eec9	106	const char op, const char cause);
76bb28f6	107	int ima_init_crypto(void);
3323eec9	108
adf53a77 RS	109	int ima_init_template(void);
adf53a77 RS	110
3323eec9 MZ	111	/*
	112	* used to protect h_table and sha_table
	113	*/
	114	extern spinlock_t ima_queue_lock;
	115
	116	struct ima_h_table {
	117	atomic_long_t len; /* number of stored measurements in the list */
	118	atomic_long_t violations;
	119	struct hlist_head queue[IMA_MEASURE_HTABLE_SIZE];
	120	};
	121	extern struct ima_h_table ima_htable;
	122
	123	static inline unsigned long ima_hash_key(u8 *digest)
	124	{
	125	return hash_long(*digest, IMA_HASH_BITS);
	126	}
	127
3323eec9	128	/* LIM API function definitions */
d9d300cd	129	int ima_get_action(struct inode *inode, int mask, int function);
1adace9b	130	int ima_must_measure(struct inode *inode, int mask, int function);
f381c272	131	int ima_collect_measurement(struct integrity_iint_cache *iint,
d3634d0f DK	132	struct file *file,
	133	struct evm_ima_xattr_data **xattr_value,
	134	int *xattr_len);
f381c272	135	void ima_store_measurement(struct integrity_iint_cache iint, struct file file,
3323eec9	136	const unsigned char *filename);
e7c568e0 PM	137	void ima_audit_measurement(struct integrity_iint_cache *iint,
e7c568e0 PM	138	const unsigned char *filename);
7bc5f447 RS	139	int ima_alloc_init_template(struct integrity_iint_cache *iint,
	140	struct file file, const unsigned char filename,
	141	struct ima_template_entry **entry);
3323eec9	142	int ima_store_template(struct ima_template_entry *entry, int violation,
9803d413	143	struct inode inode, const unsigned char filename);
f381c272	144	void ima_template_show(struct seq_file m, void e, enum ima_show_type show);
ea1046d4	145	const char ima_d_path(struct path path, char **pathbuf);
3323eec9	146
85491641	147	/* rbtree tree calls to lookup, insert, delete
3323eec9 MZ	148	* integrity data associated with an inode.
3323eec9 MZ	149	*/
f381c272 MZ	150	struct integrity_iint_cache integrity_iint_insert(struct inode inode);
f381c272 MZ	151	struct integrity_iint_cache integrity_iint_find(struct inode inode);
3323eec9 MZ	152
3323eec9 MZ	153	/* IMA policy related functions */
16cac49f	154	enum ima_hooks { FILE_CHECK = 1, MMAP_CHECK, BPRM_CHECK, MODULE_CHECK, POST_SETATTR };
3323eec9	155
2fe5d6de MZ	156	int ima_match_policy(struct inode *inode, enum ima_hooks func, int mask,
2fe5d6de MZ	157	int flags);
3323eec9 MZ	158	void ima_init_policy(void);
3323eec9 MZ	159	void ima_update_policy(void);
6ccd0456	160	ssize_t ima_parse_add_rule(char *);
4af4662f MZ	161	void ima_delete_rules(void);
4af4662f MZ	162
2fe5d6de MZ	163	/* Appraise integrity measurements */
	164	#define IMA_APPRAISE_ENFORCE 0x01
	165	#define IMA_APPRAISE_FIX 0x02
a7f2a366	166	#define IMA_APPRAISE_MODULES 0x04
2fe5d6de MZ	167
2fe5d6de MZ	168	#ifdef CONFIG_IMA_APPRAISE
d79d72e0	169	int ima_appraise_measurement(int func, struct integrity_iint_cache *iint,
d3634d0f DK	170	struct file file, const unsigned char filename,
	171	struct evm_ima_xattr_data *xattr_value,
	172	int xattr_len);
d26e1936	173	int ima_must_appraise(struct inode *inode, int mask, enum ima_hooks func);
2fe5d6de	174	void ima_update_xattr(struct integrity_iint_cache iint, struct file file);
d79d72e0 MZ	175	enum integrity_status ima_get_cache_status(struct integrity_iint_cache *iint,
d79d72e0 MZ	176	int func);
d3634d0f DK	177	void ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value, int xattr_len,
	178	struct ima_digest_data *hash);
	179	int ima_read_xattr(struct dentry *dentry,
	180	struct evm_ima_xattr_data **xattr_value);
2fe5d6de MZ	181
2fe5d6de MZ	182	#else
d79d72e0 MZ	183	static inline int ima_appraise_measurement(int func,
d79d72e0 MZ	184	struct integrity_iint_cache *iint,
2fe5d6de	185	struct file *file,
d3634d0f DK	186	const unsigned char *filename,
	187	struct evm_ima_xattr_data *xattr_value,
	188	int xattr_len)
2fe5d6de MZ	189	{
	190	return INTEGRITY_UNKNOWN;
	191	}
	192
d26e1936 DK	193	static inline int ima_must_appraise(struct inode *inode, int mask,
d26e1936 DK	194	enum ima_hooks func)
2fe5d6de MZ	195	{
	196	return 0;
	197	}
	198
	199	static inline void ima_update_xattr(struct integrity_iint_cache *iint,
	200	struct file *file)
	201	{
	202	}
d79d72e0 MZ	203
	204	static inline enum integrity_status ima_get_cache_status(struct integrity_iint_cache
	205	*iint, int func)
	206	{
	207	return INTEGRITY_UNKNOWN;
	208	}
d3634d0f DK	209
	210	static inline void ima_get_hash_algo(struct evm_ima_xattr_data *xattr_value,
	211	int xattr_len,
	212	struct ima_digest_data *hash)
	213	{
	214	}
	215
	216	static inline int ima_read_xattr(struct dentry *dentry,
	217	struct evm_ima_xattr_data **xattr_value)
	218	{
	219	return 0;
	220	}
	221
2fe5d6de MZ	222	#endif
2fe5d6de MZ	223
4af4662f MZ	224	/* LSM based policy rules require audit */
	225	#ifdef CONFIG_IMA_LSM_RULES
	226
	227	#define security_filter_rule_init security_audit_rule_init
	228	#define security_filter_rule_match security_audit_rule_match
	229
	230	#else
	231
	232	static inline int security_filter_rule_init(u32 field, u32 op, char *rulestr,
	233	void **lsmrule)
	234	{
	235	return -EINVAL;
	236	}
	237
	238	static inline int security_filter_rule_match(u32 secid, u32 field, u32 op,
	239	void *lsmrule,
	240	struct audit_context *actx)
	241	{
	242	return -EINVAL;
	243	}
	244	#endif /* CONFIG_IMA_LSM_RULES */
3323eec9	245	#endif