[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_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"

/* 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 evm_ima_xattr_data *xattr_value,
			   int xattr_len, 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_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,
		       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, int 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);
}

/* 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,
			   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 integrity_iint_cache *iint,
			    struct file *file, const unsigned char *filename,
			    struct evm_ima_xattr_data *xattr_value,
			    int xattr_len, 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 */
enum ima_hooks { FILE_CHECK = 1, MMAP_CHECK, BPRM_CHECK, MODULE_CHECK, FIRMWARE_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_LOG	0x04
#define IMA_APPRAISE_MODULES	0x08
#define IMA_APPRAISE_FIRMWARE	0x10

#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 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,
					   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, 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, 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 */

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