[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)

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

/* 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);
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);

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