[linux-block.git] / security / integrity / integrity.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2009-2010 IBM Corporation
 *
 * Authors:
 * Mimi Zohar <zohar@us.ibm.com>
 */

#ifdef pr_fmt
#undef pr_fmt
#endif

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/types.h>
#include <linux/integrity.h>
#include <crypto/sha.h>
#include <linux/key.h>
#include <linux/audit.h>

/* iint action cache flags */
#define IMA_MEASURE		0x00000001
#define IMA_MEASURED		0x00000002
#define IMA_APPRAISE		0x00000004
#define IMA_APPRAISED		0x00000008
/*#define IMA_COLLECT		0x00000010  do not use this flag */
#define IMA_COLLECTED		0x00000020
#define IMA_AUDIT		0x00000040
#define IMA_AUDITED		0x00000080
#define IMA_HASH		0x00000100
#define IMA_HASHED		0x00000200

/* iint cache flags */
#define IMA_ACTION_FLAGS	0xff000000
#define IMA_DIGSIG_REQUIRED	0x01000000
#define IMA_PERMIT_DIRECTIO	0x02000000
#define IMA_NEW_FILE		0x04000000
#define EVM_IMMUTABLE_DIGSIG	0x08000000
#define IMA_FAIL_UNVERIFIABLE_SIGS	0x10000000
#define IMA_MODSIG_ALLOWED	0x20000000
#define IMA_CHECK_BLACKLIST	0x40000000

#define IMA_DO_MASK		(IMA_MEASURE | IMA_APPRAISE | IMA_AUDIT | \
				 IMA_HASH | IMA_APPRAISE_SUBMASK)
#define IMA_DONE_MASK		(IMA_MEASURED | IMA_APPRAISED | IMA_AUDITED | \
				 IMA_HASHED | IMA_COLLECTED | \
				 IMA_APPRAISED_SUBMASK)

/* iint subaction appraise cache flags */
#define IMA_FILE_APPRAISE	0x00001000
#define IMA_FILE_APPRAISED	0x00002000
#define IMA_MMAP_APPRAISE	0x00004000
#define IMA_MMAP_APPRAISED	0x00008000
#define IMA_BPRM_APPRAISE	0x00010000
#define IMA_BPRM_APPRAISED	0x00020000
#define IMA_READ_APPRAISE	0x00040000
#define IMA_READ_APPRAISED	0x00080000
#define IMA_CREDS_APPRAISE	0x00100000
#define IMA_CREDS_APPRAISED	0x00200000
#define IMA_APPRAISE_SUBMASK	(IMA_FILE_APPRAISE | IMA_MMAP_APPRAISE | \
				 IMA_BPRM_APPRAISE | IMA_READ_APPRAISE | \
				 IMA_CREDS_APPRAISE)
#define IMA_APPRAISED_SUBMASK	(IMA_FILE_APPRAISED | IMA_MMAP_APPRAISED | \
				 IMA_BPRM_APPRAISED | IMA_READ_APPRAISED | \
				 IMA_CREDS_APPRAISED)

/* iint cache atomic_flags */
#define IMA_CHANGE_XATTR	0
#define IMA_UPDATE_XATTR	1
#define IMA_CHANGE_ATTR		2
#define IMA_DIGSIG		3
#define IMA_MUST_MEASURE	4

enum evm_ima_xattr_type {
	IMA_XATTR_DIGEST = 0x01,
	EVM_XATTR_HMAC,
	EVM_IMA_XATTR_DIGSIG,
	IMA_XATTR_DIGEST_NG,
	EVM_XATTR_PORTABLE_DIGSIG,
	IMA_XATTR_LAST
};

struct evm_ima_xattr_data {
	u8 type;
	u8 data[];
} __packed;

/* Only used in the EVM HMAC code. */
struct evm_xattr {
	struct evm_ima_xattr_data data;
	u8 digest[SHA1_DIGEST_SIZE];
} __packed;

#define IMA_MAX_DIGEST_SIZE	64

struct ima_digest_data {
	u8 algo;
	u8 length;
	union {
		struct {
			u8 unused;
			u8 type;
		} sha1;
		struct {
			u8 type;
			u8 algo;
		} ng;
		u8 data[2];
	} xattr;
	u8 digest[];
} __packed;

/*
 * signature format v2 - for using with asymmetric keys
 */
struct signature_v2_hdr {
	uint8_t type;		/* xattr type */
	uint8_t version;	/* signature format version */
	uint8_t	hash_algo;	/* Digest algorithm [enum hash_algo] */
	__be32 keyid;		/* IMA key identifier - not X509/PGP specific */
	__be16 sig_size;	/* signature size */
	uint8_t sig[];		/* signature payload */
} __packed;

/* integrity data associated with an inode */
struct integrity_iint_cache {
	struct rb_node rb_node;	/* rooted in integrity_iint_tree */
	struct mutex mutex;	/* protects: version, flags, digest */
	struct inode *inode;	/* back pointer to inode in question */
	u64 version;		/* track inode changes */
	unsigned long flags;
	unsigned long measured_pcrs;
	unsigned long atomic_flags;
	enum integrity_status ima_file_status:4;
	enum integrity_status ima_mmap_status:4;
	enum integrity_status ima_bprm_status:4;
	enum integrity_status ima_read_status:4;
	enum integrity_status ima_creds_status:4;
	enum integrity_status evm_status:4;
	struct ima_digest_data *ima_hash;
};

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

int integrity_kernel_read(struct file *file, loff_t offset,
			  void *addr, unsigned long count);

#define INTEGRITY_KEYRING_EVM		0
#define INTEGRITY_KEYRING_IMA		1
#define INTEGRITY_KEYRING_PLATFORM	2
#define INTEGRITY_KEYRING_MAX		3

extern struct dentry *integrity_dir;

struct modsig;

#ifdef CONFIG_INTEGRITY_SIGNATURE

int integrity_digsig_verify(const unsigned int id, const char *sig, int siglen,
			    const char *digest, int digestlen);
int integrity_modsig_verify(unsigned int id, const struct modsig *modsig);

int __init integrity_init_keyring(const unsigned int id);
int __init integrity_load_x509(const unsigned int id, const char *path);
int __init integrity_load_cert(const unsigned int id, const char *source,
			       const void *data, size_t len, key_perm_t perm);
#else

static inline int integrity_digsig_verify(const unsigned int id,
					  const char *sig, int siglen,
					  const char *digest, int digestlen)
{
	return -EOPNOTSUPP;
}

static inline int integrity_modsig_verify(unsigned int id,
					  const struct modsig *modsig)
{
	return -EOPNOTSUPP;
}

static inline int integrity_init_keyring(const unsigned int id)
{
	return 0;
}

static inline int __init integrity_load_cert(const unsigned int id,
					     const char *source,
					     const void *data, size_t len,
					     key_perm_t perm)
{
	return 0;
}
#endif /* CONFIG_INTEGRITY_SIGNATURE */

#ifdef CONFIG_INTEGRITY_ASYMMETRIC_KEYS
int asymmetric_verify(struct key *keyring, const char *sig,
		      int siglen, const char *data, int datalen);
#else
static inline int asymmetric_verify(struct key *keyring, const char *sig,
				    int siglen, const char *data, int datalen)
{
	return -EOPNOTSUPP;
}
#endif

#ifdef CONFIG_IMA_APPRAISE_MODSIG
int ima_modsig_verify(struct key *keyring, const struct modsig *modsig);
#else
static inline int ima_modsig_verify(struct key *keyring,
				    const struct modsig *modsig)
{
	return -EOPNOTSUPP;
}
#endif

#ifdef CONFIG_IMA_LOAD_X509
void __init ima_load_x509(void);
#else
static inline void ima_load_x509(void)
{
}
#endif

#ifdef CONFIG_EVM_LOAD_X509
void __init evm_load_x509(void);
#else
static inline void evm_load_x509(void)
{
}
#endif

#ifdef CONFIG_INTEGRITY_AUDIT
/* declarations */
void integrity_audit_msg(int audit_msgno, struct inode *inode,
			 const unsigned char *fname, const char *op,
			 const char *cause, int result, int info);

void integrity_audit_message(int audit_msgno, struct inode *inode,
			     const unsigned char *fname, const char *op,
			     const char *cause, int result, int info,
			     int errno);

static inline struct audit_buffer *
integrity_audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type)
{
	return audit_log_start(ctx, gfp_mask, type);
}

#else
static inline void integrity_audit_msg(int audit_msgno, struct inode *inode,
				       const unsigned char *fname,
				       const char *op, const char *cause,
				       int result, int info)
{
}

static inline void integrity_audit_message(int audit_msgno,
					   struct inode *inode,
					   const unsigned char *fname,
					   const char *op, const char *cause,
					   int result, int info, int errno)
{
}

static inline struct audit_buffer *
integrity_audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type)
{
	return NULL;
}

#endif

#ifdef CONFIG_INTEGRITY_PLATFORM_KEYRING
void __init add_to_platform_keyring(const char *source, const void *data,
				    size_t len);
#else
static inline void __init add_to_platform_keyring(const char *source,
						  const void *data, size_t len)
{
}
#endif
Commit	Line	Data
b886d83c	1	/* SPDX-License-Identifier: GPL-2.0-only */
f381c272 MZ	2	/*
	3	* Copyright (C) 2009-2010 IBM Corporation
	4	*
	5	* Authors:
	6	* Mimi Zohar <zohar@us.ibm.com>
f381c272 MZ	7	*/
f381c272 MZ	8
555d6d71 TS	9	#ifdef pr_fmt
	10	#undef pr_fmt
	11	#endif
	12
	13	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	14
f381c272 MZ	15	#include <linux/types.h>
	16	#include <linux/integrity.h>
	17	#include <crypto/sha.h>
e0751257	18	#include <linux/key.h>
2afd020a	19	#include <linux/audit.h>
f381c272	20
45e2472e	21	/* iint action cache flags */
f578c08e MZ	22	#define IMA_MEASURE 0x00000001
	23	#define IMA_MEASURED 0x00000002
	24	#define IMA_APPRAISE 0x00000004
	25	#define IMA_APPRAISED 0x00000008
	26	/#define IMA_COLLECT 0x00000010 do not use this flag /
	27	#define IMA_COLLECTED 0x00000020
	28	#define IMA_AUDIT 0x00000040
	29	#define IMA_AUDITED 0x00000080
da1b0029 MZ	30	#define IMA_HASH 0x00000100
da1b0029 MZ	31	#define IMA_HASHED 0x00000200
45e2472e	32
f381c272	33	/* iint cache flags */
f578c08e	34	#define IMA_ACTION_FLAGS 0xff000000
0d73a552 DK	35	#define IMA_DIGSIG_REQUIRED 0x01000000
	36	#define IMA_PERMIT_DIRECTIO 0x02000000
	37	#define IMA_NEW_FILE 0x04000000
	38	#define EVM_IMMUTABLE_DIGSIG 0x08000000
9e67028e	39	#define IMA_FAIL_UNVERIFIABLE_SIGS 0x10000000
9044d627	40	#define IMA_MODSIG_ALLOWED 0x20000000
273df864	41	#define IMA_CHECK_BLACKLIST 0x40000000
45e2472e	42
d79d72e0	43	#define IMA_DO_MASK (IMA_MEASURE \| IMA_APPRAISE \| IMA_AUDIT \| \
da1b0029	44	IMA_HASH \| IMA_APPRAISE_SUBMASK)
d79d72e0	45	#define IMA_DONE_MASK (IMA_MEASURED \| IMA_APPRAISED \| IMA_AUDITED \| \
da1b0029 MZ	46	IMA_HASHED \| IMA_COLLECTED \| \
da1b0029 MZ	47	IMA_APPRAISED_SUBMASK)
d79d72e0 MZ	48
d79d72e0 MZ	49	/* iint subaction appraise cache flags */
da1b0029 MZ	50	#define IMA_FILE_APPRAISE 0x00001000
	51	#define IMA_FILE_APPRAISED 0x00002000
	52	#define IMA_MMAP_APPRAISE 0x00004000
	53	#define IMA_MMAP_APPRAISED 0x00008000
	54	#define IMA_BPRM_APPRAISE 0x00010000
	55	#define IMA_BPRM_APPRAISED 0x00020000
	56	#define IMA_READ_APPRAISE 0x00040000
	57	#define IMA_READ_APPRAISED 0x00080000
d906c10d MG	58	#define IMA_CREDS_APPRAISE 0x00100000
d906c10d MG	59	#define IMA_CREDS_APPRAISED 0x00200000
d79d72e0	60	#define IMA_APPRAISE_SUBMASK (IMA_FILE_APPRAISE \| IMA_MMAP_APPRAISE \| \
d906c10d MG	61	IMA_BPRM_APPRAISE \| IMA_READ_APPRAISE \| \
d906c10d MG	62	IMA_CREDS_APPRAISE)
d79d72e0	63	#define IMA_APPRAISED_SUBMASK (IMA_FILE_APPRAISED \| IMA_MMAP_APPRAISED \| \
d906c10d MG	64	IMA_BPRM_APPRAISED \| IMA_READ_APPRAISED \| \
d906c10d MG	65	IMA_CREDS_APPRAISED)
f381c272	66
0d73a552 DK	67	/* iint cache atomic_flags */
	68	#define IMA_CHANGE_XATTR 0
	69	#define IMA_UPDATE_XATTR 1
	70	#define IMA_CHANGE_ATTR 2
	71	#define IMA_DIGSIG 3
	72	#define IMA_MUST_MEASURE 4
	73
6be5cc52 DK	74	enum evm_ima_xattr_type {
	75	IMA_XATTR_DIGEST = 0x01,
	76	EVM_XATTR_HMAC,
	77	EVM_IMA_XATTR_DIGSIG,
3ea7a560	78	IMA_XATTR_DIGEST_NG,
50b97748	79	EVM_XATTR_PORTABLE_DIGSIG,
a48fda9d	80	IMA_XATTR_LAST
6be5cc52 DK	81	};
	82
	83	struct evm_ima_xattr_data {
	84	u8 type;
650b29db TJB	85	u8 data[];
	86	} __packed;
	87
	88	/* Only used in the EVM HMAC code. */
	89	struct evm_xattr {
	90	struct evm_ima_xattr_data data;
6be5cc52	91	u8 digest[SHA1_DIGEST_SIZE];
c7c8bb23 DK	92	} __packed;
	93
	94	#define IMA_MAX_DIGEST_SIZE 64
	95
	96	struct ima_digest_data {
	97	u8 algo;
	98	u8 length;
3ea7a560 DK	99	union {
	100	struct {
	101	u8 unused;
	102	u8 type;
	103	} sha1;
	104	struct {
	105	u8 type;
	106	u8 algo;
	107	} ng;
	108	u8 data[2];
	109	} xattr;
eb492c62	110	u8 digest[];
c7c8bb23	111	} __packed;
6be5cc52	112
d3634d0f DK	113	/*
	114	* signature format v2 - for using with asymmetric keys
	115	*/
	116	struct signature_v2_hdr {
b1aaab22	117	uint8_t type; /* xattr type */
d3634d0f	118	uint8_t version; /* signature format version */
4e8ae72a	119	uint8_t hash_algo; /* Digest algorithm [enum hash_algo] */
bb543e39 TJB	120	__be32 keyid; /* IMA key identifier - not X509/PGP specific */
bb543e39 TJB	121	__be16 sig_size; /* signature size */
eb492c62	122	uint8_t sig[]; /* signature payload */
d3634d0f DK	123	} __packed;
d3634d0f DK	124
f381c272 MZ	125	/* integrity data associated with an inode */
f381c272 MZ	126	struct integrity_iint_cache {
c7c8bb23	127	struct rb_node rb_node; /* rooted in integrity_iint_tree */
0d73a552	128	struct mutex mutex; /* protects: version, flags, digest */
f381c272 MZ	129	struct inode inode; / back pointer to inode in question */
f381c272 MZ	130	u64 version; /* track inode changes */
f578c08e	131	unsigned long flags;
96d450bb	132	unsigned long measured_pcrs;
0d73a552	133	unsigned long atomic_flags;
d79d72e0 MZ	134	enum integrity_status ima_file_status:4;
	135	enum integrity_status ima_mmap_status:4;
	136	enum integrity_status ima_bprm_status:4;
cf222217	137	enum integrity_status ima_read_status:4;
d906c10d	138	enum integrity_status ima_creds_status:4;
ee866331	139	enum integrity_status evm_status:4;
a35c3fb6	140	struct ima_digest_data *ima_hash;
f381c272 MZ	141	};
	142
	143	/* rbtree tree calls to lookup, insert, delete
	144	* integrity data associated with an inode.
	145	*/
f381c272	146	struct integrity_iint_cache integrity_iint_find(struct inode inode);
4892722e	147
e3c4abbf	148	int integrity_kernel_read(struct file *file, loff_t offset,
bb543e39 TJB	149	void *addr, unsigned long count);
bb543e39 TJB	150
8607c501	151	#define INTEGRITY_KEYRING_EVM 0
f4dc3778	152	#define INTEGRITY_KEYRING_IMA 1
c7f7e58f TJB	153	#define INTEGRITY_KEYRING_PLATFORM 2
c7f7e58f TJB	154	#define INTEGRITY_KEYRING_MAX 3
8607c501	155
0c343af8 MG	156	extern struct dentry *integrity_dir;
0c343af8 MG	157
39b07096 TJB	158	struct modsig;
39b07096 TJB	159
f1be242c	160	#ifdef CONFIG_INTEGRITY_SIGNATURE
8607c501 DK	161
8607c501 DK	162	int integrity_digsig_verify(const unsigned int id, const char *sig, int siglen,
089bc8e9	163	const char *digest, int digestlen);
39b07096	164	int integrity_modsig_verify(unsigned int id, const struct modsig *modsig);
8607c501	165
d16a8585	166	int __init integrity_init_keyring(const unsigned int id);
9d03a721	167	int __init integrity_load_x509(const unsigned int id, const char *path);
60740acc	168	int __init integrity_load_cert(const unsigned int id, const char *source,
028db3e2	169	const void *data, size_t len, key_perm_t perm);
8607c501 DK	170	#else
	171
	172	static inline int integrity_digsig_verify(const unsigned int id,
	173	const char *sig, int siglen,
	174	const char *digest, int digestlen)
	175	{
	176	return -EOPNOTSUPP;
	177	}
	178
39b07096 TJB	179	static inline int integrity_modsig_verify(unsigned int id,
	180	const struct modsig *modsig)
	181	{
	182	return -EOPNOTSUPP;
	183	}
	184
7d2ce232 MZ	185	static inline int integrity_init_keyring(const unsigned int id)
	186	{
	187	return 0;
	188	}
60740acc NJ	189
	190	static inline int __init integrity_load_cert(const unsigned int id,
	191	const char *source,
	192	const void *data, size_t len,
028db3e2	193	key_perm_t perm)
60740acc NJ	194	{
	195	return 0;
	196	}
f1be242c	197	#endif /* CONFIG_INTEGRITY_SIGNATURE */
8607c501	198
e0751257 DK	199	#ifdef CONFIG_INTEGRITY_ASYMMETRIC_KEYS
	200	int asymmetric_verify(struct key keyring, const char sig,
	201	int siglen, const char *data, int datalen);
	202	#else
	203	static inline int asymmetric_verify(struct key keyring, const char sig,
	204	int siglen, const char *data, int datalen)
	205	{
	206	return -EOPNOTSUPP;
	207	}
	208	#endif
	209
39b07096 TJB	210	#ifdef CONFIG_IMA_APPRAISE_MODSIG
	211	int ima_modsig_verify(struct key keyring, const struct modsig modsig);
	212	#else
	213	static inline int ima_modsig_verify(struct key *keyring,
	214	const struct modsig *modsig)
	215	{
	216	return -EOPNOTSUPP;
	217	}
	218	#endif
	219
fd5f4e90 DK	220	#ifdef CONFIG_IMA_LOAD_X509
	221	void __init ima_load_x509(void);
	222	#else
	223	static inline void ima_load_x509(void)
	224	{
	225	}
	226	#endif
	227
2ce523eb DK	228	#ifdef CONFIG_EVM_LOAD_X509
	229	void __init evm_load_x509(void);
	230	#else
	231	static inline void evm_load_x509(void)
	232	{
	233	}
	234	#endif
	235
d726d8d7 MZ	236	#ifdef CONFIG_INTEGRITY_AUDIT
	237	/* declarations */
	238	void integrity_audit_msg(int audit_msgno, struct inode *inode,
	239	const unsigned char fname, const char op,
	240	const char *cause, int result, int info);
2afd020a	241
2f845882 LR	242	void integrity_audit_message(int audit_msgno, struct inode *inode,
	243	const unsigned char fname, const char op,
	244	const char *cause, int result, int info,
	245	int errno);
	246
2afd020a SB	247	static inline struct audit_buffer *
	248	integrity_audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type)
	249	{
	250	return audit_log_start(ctx, gfp_mask, type);
	251	}
	252
d726d8d7 MZ	253	#else
	254	static inline void integrity_audit_msg(int audit_msgno, struct inode *inode,
	255	const unsigned char *fname,
	256	const char op, const char cause,
	257	int result, int info)
	258	{
	259	}
2afd020a	260
2f845882 LR	261	static inline void integrity_audit_message(int audit_msgno,
	262	struct inode *inode,
	263	const unsigned char *fname,
	264	const char op, const char cause,
	265	int result, int info, int errno)
	266	{
	267	}
	268
2afd020a SB	269	static inline struct audit_buffer *
	270	integrity_audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type)
	271	{
	272	return NULL;
	273	}
	274
d726d8d7	275	#endif
60740acc NJ	276
	277	#ifdef CONFIG_INTEGRITY_PLATFORM_KEYRING
	278	void __init add_to_platform_keyring(const char source, const void data,
	279	size_t len);
	280	#else
	281	static inline void __init add_to_platform_keyring(const char *source,
	282	const void *data, size_t len)
	283	{
	284	}
	285	#endif