[mirror_ubuntu-focal-kernel.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>
 */

#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_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[0];
} __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[0];		/* 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);

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