[linux-block.git] / fs / verity / fsverity_private.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * fs-verity: read-only file-based authenticity protection
 *
 * Copyright 2019 Google LLC
 */

#ifndef _FSVERITY_PRIVATE_H
#define _FSVERITY_PRIVATE_H

#define pr_fmt(fmt) "fs-verity: " fmt

#include <linux/fsverity.h>
#include <linux/mempool.h>

struct ahash_request;

/*
 * Implementation limit: maximum depth of the Merkle tree.  For now 8 is plenty;
 * it's enough for over U64_MAX bytes of data using SHA-256 and 4K blocks.
 */
#define FS_VERITY_MAX_LEVELS		8

/* A hash algorithm supported by fs-verity */
struct fsverity_hash_alg {
	struct crypto_ahash *tfm; /* hash tfm, allocated on demand */
	const char *name;	  /* crypto API name, e.g. sha256 */
	unsigned int digest_size; /* digest size in bytes, e.g. 32 for SHA-256 */
	unsigned int block_size;  /* block size in bytes, e.g. 64 for SHA-256 */
	mempool_t req_pool;	  /* mempool with a preallocated hash request */
	/*
	 * The HASH_ALGO_* constant for this algorithm.  This is different from
	 * FS_VERITY_HASH_ALG_*, which uses a different numbering scheme.
	 */
	enum hash_algo algo_id;
};

/* Merkle tree parameters: hash algorithm, initial hash state, and topology */
struct merkle_tree_params {
	struct fsverity_hash_alg *hash_alg; /* the hash algorithm */
	const u8 *hashstate;		/* initial hash state or NULL */
	unsigned int digest_size;	/* same as hash_alg->digest_size */
	unsigned int block_size;	/* size of data and tree blocks */
	unsigned int hashes_per_block;	/* number of hashes per tree block */
	unsigned int blocks_per_page;	/* PAGE_SIZE / block_size */
	u8 log_digestsize;		/* log2(digest_size) */
	u8 log_blocksize;		/* log2(block_size) */
	u8 log_arity;			/* log2(hashes_per_block) */
	u8 log_blocks_per_page;		/* log2(blocks_per_page) */
	unsigned int num_levels;	/* number of levels in Merkle tree */
	u64 tree_size;			/* Merkle tree size in bytes */
	unsigned long tree_pages;	/* Merkle tree size in pages */

	/*
	 * Starting block index for each tree level, ordered from leaf level (0)
	 * to root level ('num_levels - 1')
	 */
	unsigned long level_start[FS_VERITY_MAX_LEVELS];
};

/*
 * fsverity_info - cached verity metadata for an inode
 *
 * When a verity file is first opened, an instance of this struct is allocated
 * and stored in ->i_verity_info; it remains until the inode is evicted.  It
 * caches information about the Merkle tree that's needed to efficiently verify
 * data read from the file.  It also caches the file digest.  The Merkle tree
 * pages themselves are not cached here, but the filesystem may cache them.
 */
struct fsverity_info {
	struct merkle_tree_params tree_params;
	u8 root_hash[FS_VERITY_MAX_DIGEST_SIZE];
	u8 file_digest[FS_VERITY_MAX_DIGEST_SIZE];
	const struct inode *inode;
	unsigned long *hash_block_verified;
	spinlock_t hash_page_init_lock;
};

#define FS_VERITY_MAX_SIGNATURE_SIZE	(FS_VERITY_MAX_DESCRIPTOR_SIZE - \
					 sizeof(struct fsverity_descriptor))

/* hash_algs.c */

extern struct fsverity_hash_alg fsverity_hash_algs[];

struct fsverity_hash_alg *fsverity_get_hash_alg(const struct inode *inode,
						unsigned int num);
struct ahash_request *fsverity_alloc_hash_request(struct fsverity_hash_alg *alg,
						  gfp_t gfp_flags);
void fsverity_free_hash_request(struct fsverity_hash_alg *alg,
				struct ahash_request *req);
const u8 *fsverity_prepare_hash_state(struct fsverity_hash_alg *alg,
				      const u8 *salt, size_t salt_size);
int fsverity_hash_block(const struct merkle_tree_params *params,
			const struct inode *inode, struct ahash_request *req,
			struct page *page, unsigned int offset, u8 *out);
int fsverity_hash_buffer(struct fsverity_hash_alg *alg,
			 const void *data, size_t size, u8 *out);
void __init fsverity_check_hash_algs(void);

/* init.c */

void __printf(3, 4) __cold
fsverity_msg(const struct inode *inode, const char *level,
	     const char *fmt, ...);

#define fsverity_warn(inode, fmt, ...)		\
	fsverity_msg((inode), KERN_WARNING, fmt, ##__VA_ARGS__)
#define fsverity_err(inode, fmt, ...)		\
	fsverity_msg((inode), KERN_ERR, fmt, ##__VA_ARGS__)

/* open.c */

int fsverity_init_merkle_tree_params(struct merkle_tree_params *params,
				     const struct inode *inode,
				     unsigned int hash_algorithm,
				     unsigned int log_blocksize,
				     const u8 *salt, size_t salt_size);

struct fsverity_info *fsverity_create_info(const struct inode *inode,
					   struct fsverity_descriptor *desc);

void fsverity_set_info(struct inode *inode, struct fsverity_info *vi);

void fsverity_free_info(struct fsverity_info *vi);

int fsverity_get_descriptor(struct inode *inode,
			    struct fsverity_descriptor **desc_ret);

int __init fsverity_init_info_cache(void);
void __init fsverity_exit_info_cache(void);

/* signature.c */

#ifdef CONFIG_FS_VERITY_BUILTIN_SIGNATURES
int fsverity_verify_signature(const struct fsverity_info *vi,
			      const u8 *signature, size_t sig_size);

int __init fsverity_init_signature(void);
#else /* !CONFIG_FS_VERITY_BUILTIN_SIGNATURES */
static inline int
fsverity_verify_signature(const struct fsverity_info *vi,
			  const u8 *signature, size_t sig_size)
{
	return 0;
}

static inline int fsverity_init_signature(void)
{
	return 0;
}
#endif /* !CONFIG_FS_VERITY_BUILTIN_SIGNATURES */

/* verify.c */

int __init fsverity_init_workqueue(void);
void __init fsverity_exit_workqueue(void);

#endif /* _FSVERITY_PRIVATE_H */
Commit	Line	Data
671e67b4 EB	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/*
	3	* fs-verity: read-only file-based authenticity protection
	4	*
	5	* Copyright 2019 Google LLC
	6	*/
	7
	8	#ifndef _FSVERITY_PRIVATE_H
	9	#define _FSVERITY_PRIVATE_H
	10
671e67b4 EB	11	#define pr_fmt(fmt) "fs-verity: " fmt
671e67b4 EB	12
fd2d1acf	13	#include <linux/fsverity.h>
439bea10	14	#include <linux/mempool.h>
671e67b4 EB	15
	16	struct ahash_request;
	17
	18	/*
	19	* Implementation limit: maximum depth of the Merkle tree. For now 8 is plenty;
	20	* it's enough for over U64_MAX bytes of data using SHA-256 and 4K blocks.
	21	*/
	22	#define FS_VERITY_MAX_LEVELS 8
	23
671e67b4 EB	24	/* A hash algorithm supported by fs-verity */
	25	struct fsverity_hash_alg {
	26	struct crypto_ahash tfm; / hash tfm, allocated on demand */
	27	const char name; / crypto API name, e.g. sha256 */
	28	unsigned int digest_size; /* digest size in bytes, e.g. 32 for SHA-256 */
	29	unsigned int block_size; /* block size in bytes, e.g. 64 for SHA-256 */
439bea10	30	mempool_t req_pool; /* mempool with a preallocated hash request */
a4bbf53d EB	31	/*
	32	* The HASH_ALGO_* constant for this algorithm. This is different from
	33	* FS_VERITY_HASH_ALG_*, which uses a different numbering scheme.
	34	*/
	35	enum hash_algo algo_id;
671e67b4 EB	36	};
	37
	38	/* Merkle tree parameters: hash algorithm, initial hash state, and topology */
	39	struct merkle_tree_params {
439bea10	40	struct fsverity_hash_alg hash_alg; / the hash algorithm */
671e67b4 EB	41	const u8 hashstate; / initial hash state or NULL */
	42	unsigned int digest_size; /* same as hash_alg->digest_size */
	43	unsigned int block_size; /* size of data and tree blocks */
	44	unsigned int hashes_per_block; /* number of hashes per tree block */
5306892a	45	unsigned int blocks_per_page; /* PAGE_SIZE / block_size */
579a12f7 EB	46	u8 log_digestsize; /* log2(digest_size) */
	47	u8 log_blocksize; /* log2(block_size) */
	48	u8 log_arity; /* log2(hashes_per_block) */
5306892a	49	u8 log_blocks_per_page; /* log2(blocks_per_page) */
671e67b4 EB	50	unsigned int num_levels; /* number of levels in Merkle tree */
671e67b4 EB	51	u64 tree_size; /* Merkle tree size in bytes */
9098f36b	52	unsigned long tree_pages; /* Merkle tree size in pages */
671e67b4 EB	53
	54	/*
	55	* Starting block index for each tree level, ordered from leaf level (0)
	56	* to root level ('num_levels - 1')
	57	*/
284d5db5	58	unsigned long level_start[FS_VERITY_MAX_LEVELS];
671e67b4 EB	59	};
671e67b4 EB	60
6377a38b	61	/*
fd2d1acf EB	62	* fsverity_info - cached verity metadata for an inode
	63	*
	64	* When a verity file is first opened, an instance of this struct is allocated
	65	* and stored in ->i_verity_info; it remains until the inode is evicted. It
	66	* caches information about the Merkle tree that's needed to efficiently verify
ed45e201 EB	67	* data read from the file. It also caches the file digest. The Merkle tree
ed45e201 EB	68	* pages themselves are not cached here, but the filesystem may cache them.
fd2d1acf EB	69	*/
	70	struct fsverity_info {
	71	struct merkle_tree_params tree_params;
	72	u8 root_hash[FS_VERITY_MAX_DIGEST_SIZE];
ed45e201	73	u8 file_digest[FS_VERITY_MAX_DIGEST_SIZE];
fd2d1acf	74	const struct inode *inode;
5306892a EB	75	unsigned long *hash_block_verified;
5306892a EB	76	spinlock_t hash_page_init_lock;
fd2d1acf EB	77	};
fd2d1acf EB	78
432434c9 EB	79	#define FS_VERITY_MAX_SIGNATURE_SIZE (FS_VERITY_MAX_DESCRIPTOR_SIZE - \
	80	sizeof(struct fsverity_descriptor))
	81
671e67b4 EB	82	/* hash_algs.c */
	83
	84	extern struct fsverity_hash_alg fsverity_hash_algs[];
	85
439bea10 EB	86	struct fsverity_hash_alg fsverity_get_hash_alg(const struct inode inode,
	87	unsigned int num);
	88	struct ahash_request fsverity_alloc_hash_request(struct fsverity_hash_alg alg,
	89	gfp_t gfp_flags);
	90	void fsverity_free_hash_request(struct fsverity_hash_alg *alg,
	91	struct ahash_request *req);
	92	const u8 fsverity_prepare_hash_state(struct fsverity_hash_alg alg,
671e67b4	93	const u8 *salt, size_t salt_size);
f45555bf EB	94	int fsverity_hash_block(const struct merkle_tree_params *params,
	95	const struct inode inode, struct ahash_request req,
	96	struct page page, unsigned int offset, u8 out);
439bea10	97	int fsverity_hash_buffer(struct fsverity_hash_alg *alg,
671e67b4 EB	98	const void data, size_t size, u8 out);
	99	void __init fsverity_check_hash_algs(void);
	100
	101	/* init.c */
	102
9cd6b593	103	void __printf(3, 4) __cold
671e67b4 EB	104	fsverity_msg(const struct inode inode, const char level,
	105	const char *fmt, ...);
	106
	107	#define fsverity_warn(inode, fmt, ...) \
	108	fsverity_msg((inode), KERN_WARNING, fmt, ##__VA_ARGS__)
	109	#define fsverity_err(inode, fmt, ...) \
	110	fsverity_msg((inode), KERN_ERR, fmt, ##__VA_ARGS__)
	111
fd2d1acf EB	112	/* open.c */
	113
	114	int fsverity_init_merkle_tree_params(struct merkle_tree_params *params,
	115	const struct inode *inode,
	116	unsigned int hash_algorithm,
	117	unsigned int log_blocksize,
	118	const u8 *salt, size_t salt_size);
	119
	120	struct fsverity_info fsverity_create_info(const struct inode inode,
b0487ede	121	struct fsverity_descriptor *desc);
fd2d1acf EB	122
	123	void fsverity_set_info(struct inode inode, struct fsverity_info vi);
	124
	125	void fsverity_free_info(struct fsverity_info *vi);
	126
c2c82611	127	int fsverity_get_descriptor(struct inode *inode,
b0487ede	128	struct fsverity_descriptor **desc_ret);
c2c82611	129
fd2d1acf	130	int __init fsverity_init_info_cache(void);
8a1d0f9c EB	131	void __init fsverity_exit_info_cache(void);
8a1d0f9c EB	132
432434c9 EB	133	/* signature.c */
	134
	135	#ifdef CONFIG_FS_VERITY_BUILTIN_SIGNATURES
	136	int fsverity_verify_signature(const struct fsverity_info *vi,
fab634c4	137	const u8 *signature, size_t sig_size);
432434c9 EB	138
	139	int __init fsverity_init_signature(void);
	140	#else /* !CONFIG_FS_VERITY_BUILTIN_SIGNATURES */
	141	static inline int
	142	fsverity_verify_signature(const struct fsverity_info *vi,
fab634c4	143	const u8 *signature, size_t sig_size)
432434c9 EB	144	{
	145	return 0;
	146	}
	147
	148	static inline int fsverity_init_signature(void)
	149	{
	150	return 0;
	151	}
	152	#endif /* !CONFIG_FS_VERITY_BUILTIN_SIGNATURES */
	153
8a1d0f9c EB	154	/* verify.c */
	155
	156	int __init fsverity_init_workqueue(void);
432434c9	157	void __init fsverity_exit_workqueue(void);
fd2d1acf	158
671e67b4	159	#endif /* _FSVERITY_PRIVATE_H */