[linux-block.git] / drivers / md / dm-verity.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2012 Red Hat, Inc.
 * Copyright (C) 2015 Google, Inc.
 *
 * Author: Mikulas Patocka <mpatocka@redhat.com>
 *
 * Based on Chromium dm-verity driver (C) 2011 The Chromium OS Authors
 */

#ifndef DM_VERITY_H
#define DM_VERITY_H

#include <linux/dm-bufio.h>
#include <linux/device-mapper.h>
#include <crypto/hash.h>

#define DM_VERITY_MAX_LEVELS		63

enum verity_mode {
	DM_VERITY_MODE_EIO,
	DM_VERITY_MODE_LOGGING,
	DM_VERITY_MODE_RESTART,
	DM_VERITY_MODE_PANIC
};

enum verity_block_type {
	DM_VERITY_BLOCK_TYPE_DATA,
	DM_VERITY_BLOCK_TYPE_METADATA
};

struct dm_verity_fec;

struct dm_verity {
	struct dm_dev *data_dev;
	struct dm_dev *hash_dev;
	struct dm_target *ti;
	struct dm_bufio_client *bufio;
	char *alg_name;
	struct crypto_ahash *tfm;
	u8 *root_digest;	/* digest of the root block */
	u8 *salt;		/* salt: its size is salt_size */
	u8 *zero_digest;	/* digest for a zero block */
	unsigned salt_size;
	sector_t data_start;	/* data offset in 512-byte sectors */
	sector_t hash_start;	/* hash start in blocks */
	sector_t data_blocks;	/* the number of data blocks */
	sector_t hash_blocks;	/* the number of hash blocks */
	unsigned char data_dev_block_bits;	/* log2(data blocksize) */
	unsigned char hash_dev_block_bits;	/* log2(hash blocksize) */
	unsigned char hash_per_block_bits;	/* log2(hashes in hash block) */
	unsigned char levels;	/* the number of tree levels */
	unsigned char version;
	unsigned digest_size;	/* digest size for the current hash algorithm */
	unsigned int ahash_reqsize;/* the size of temporary space for crypto */
	int hash_failed;	/* set to 1 if hash of any block failed */
	enum verity_mode mode;	/* mode for handling verification errors */
	unsigned corrupted_errs;/* Number of errors for corrupted blocks */

	struct workqueue_struct *verify_wq;

	/* starting blocks for each tree level. 0 is the lowest level. */
	sector_t hash_level_block[DM_VERITY_MAX_LEVELS];

	struct dm_verity_fec *fec;	/* forward error correction */
	unsigned long *validated_blocks; /* bitset blocks validated */

	char *signature_key_desc; /* signature keyring reference */
};

struct dm_verity_io {
	struct dm_verity *v;

	/* original value of bio->bi_end_io */
	bio_end_io_t *orig_bi_end_io;

	sector_t block;
	unsigned n_blocks;

	struct bvec_iter iter;

	struct work_struct work;

	/*
	 * Three variably-size fields follow this struct:
	 *
	 * u8 hash_req[v->ahash_reqsize];
	 * u8 real_digest[v->digest_size];
	 * u8 want_digest[v->digest_size];
	 *
	 * To access them use: verity_io_hash_req(), verity_io_real_digest()
	 * and verity_io_want_digest().
	 */
};

static inline struct ahash_request *verity_io_hash_req(struct dm_verity *v,
						     struct dm_verity_io *io)
{
	return (struct ahash_request *)(io + 1);
}

static inline u8 *verity_io_real_digest(struct dm_verity *v,
					struct dm_verity_io *io)
{
	return (u8 *)(io + 1) + v->ahash_reqsize;
}

static inline u8 *verity_io_want_digest(struct dm_verity *v,
					struct dm_verity_io *io)
{
	return (u8 *)(io + 1) + v->ahash_reqsize + v->digest_size;
}

static inline u8 *verity_io_digest_end(struct dm_verity *v,
				       struct dm_verity_io *io)
{
	return verity_io_want_digest(v, io) + v->digest_size;
}

extern int verity_for_bv_block(struct dm_verity *v, struct dm_verity_io *io,
			       struct bvec_iter *iter,
			       int (*process)(struct dm_verity *v,
					      struct dm_verity_io *io,
					      u8 *data, size_t len));

extern int verity_hash(struct dm_verity *v, struct ahash_request *req,
		       const u8 *data, size_t len, u8 *digest);

extern int verity_hash_for_block(struct dm_verity *v, struct dm_verity_io *io,
				 sector_t block, u8 *digest, bool *is_zero);

#endif /* DM_VERITY_H */
Commit	Line	Data
55716d26	1	/* SPDX-License-Identifier: GPL-2.0-only */
ffa39380 ST	2	/*
	3	* Copyright (C) 2012 Red Hat, Inc.
	4	* Copyright (C) 2015 Google, Inc.
	5	*
	6	* Author: Mikulas Patocka <mpatocka@redhat.com>
	7	*
	8	* Based on Chromium dm-verity driver (C) 2011 The Chromium OS Authors
ffa39380 ST	9	*/
	10
	11	#ifndef DM_VERITY_H
	12	#define DM_VERITY_H
	13
afa53df8	14	#include <linux/dm-bufio.h>
ffa39380 ST	15	#include <linux/device-mapper.h>
	16	#include <crypto/hash.h>
	17
	18	#define DM_VERITY_MAX_LEVELS 63
	19
	20	enum verity_mode {
	21	DM_VERITY_MODE_EIO,
	22	DM_VERITY_MODE_LOGGING,
e1fef0b0 JL	23	DM_VERITY_MODE_RESTART,
e1fef0b0 JL	24	DM_VERITY_MODE_PANIC
ffa39380 ST	25	};
	26
	27	enum verity_block_type {
	28	DM_VERITY_BLOCK_TYPE_DATA,
	29	DM_VERITY_BLOCK_TYPE_METADATA
	30	};
	31
a739ff3f ST	32	struct dm_verity_fec;
a739ff3f ST	33
ffa39380 ST	34	struct dm_verity {
	35	struct dm_dev *data_dev;
	36	struct dm_dev *hash_dev;
	37	struct dm_target *ti;
	38	struct dm_bufio_client *bufio;
	39	char *alg_name;
d1ac3ff0	40	struct crypto_ahash *tfm;
ffa39380 ST	41	u8 root_digest; / digest of the root block */
ffa39380 ST	42	u8 salt; / salt: its size is salt_size */
0cc37c2d	43	u8 zero_digest; / digest for a zero block */
ffa39380 ST	44	unsigned salt_size;
	45	sector_t data_start; /* data offset in 512-byte sectors */
	46	sector_t hash_start; /* hash start in blocks */
	47	sector_t data_blocks; /* the number of data blocks */
	48	sector_t hash_blocks; /* the number of hash blocks */
	49	unsigned char data_dev_block_bits; /* log2(data blocksize) */
	50	unsigned char hash_dev_block_bits; /* log2(hash blocksize) */
	51	unsigned char hash_per_block_bits; /* log2(hashes in hash block) */
	52	unsigned char levels; /* the number of tree levels */
	53	unsigned char version;
	54	unsigned digest_size; /* digest size for the current hash algorithm */
d1ac3ff0	55	unsigned int ahash_reqsize;/* the size of temporary space for crypto */
ffa39380 ST	56	int hash_failed; /* set to 1 if hash of any block failed */
	57	enum verity_mode mode; /* mode for handling verification errors */
	58	unsigned corrupted_errs;/* Number of errors for corrupted blocks */
	59
	60	struct workqueue_struct *verify_wq;
	61
	62	/* starting blocks for each tree level. 0 is the lowest level. */
	63	sector_t hash_level_block[DM_VERITY_MAX_LEVELS];
a739ff3f ST	64
a739ff3f ST	65	struct dm_verity_fec fec; / forward error correction */
843f38d3	66	unsigned long validated_blocks; / bitset blocks validated */
88cd3e6c JK	67
88cd3e6c JK	68	char signature_key_desc; / signature keyring reference */
ffa39380 ST	69	};
	70
	71	struct dm_verity_io {
	72	struct dm_verity *v;
	73
	74	/* original value of bio->bi_end_io */
	75	bio_end_io_t *orig_bi_end_io;
	76
	77	sector_t block;
	78	unsigned n_blocks;
	79
	80	struct bvec_iter iter;
	81
	82	struct work_struct work;
	83
	84	/*
	85	* Three variably-size fields follow this struct:
	86	*
d1ac3ff0	87	* u8 hash_req[v->ahash_reqsize];
ffa39380 ST	88	* u8 real_digest[v->digest_size];
	89	* u8 want_digest[v->digest_size];
	90	*
d1ac3ff0	91	* To access them use: verity_io_hash_req(), verity_io_real_digest()
ffa39380 ST	92	* and verity_io_want_digest().
	93	*/
	94	};
	95
d1ac3ff0	96	static inline struct ahash_request verity_io_hash_req(struct dm_verity v,
ffa39380 ST	97	struct dm_verity_io *io)
ffa39380 ST	98	{
d1ac3ff0	99	return (struct ahash_request *)(io + 1);
ffa39380 ST	100	}
	101
	102	static inline u8 verity_io_real_digest(struct dm_verity v,
	103	struct dm_verity_io *io)
	104	{
d1ac3ff0	105	return (u8 *)(io + 1) + v->ahash_reqsize;
ffa39380 ST	106	}
	107
	108	static inline u8 verity_io_want_digest(struct dm_verity v,
	109	struct dm_verity_io *io)
	110	{
d1ac3ff0	111	return (u8 *)(io + 1) + v->ahash_reqsize + v->digest_size;
ffa39380 ST	112	}
ffa39380 ST	113
a739ff3f ST	114	static inline u8 verity_io_digest_end(struct dm_verity v,
	115	struct dm_verity_io *io)
	116	{
	117	return verity_io_want_digest(v, io) + v->digest_size;
	118	}
	119
bb4d73ac ST	120	extern int verity_for_bv_block(struct dm_verity v, struct dm_verity_io io,
	121	struct bvec_iter *iter,
	122	int (process)(struct dm_verity v,
	123	struct dm_verity_io *io,
	124	u8 *data, size_t len));
	125
d1ac3ff0	126	extern int verity_hash(struct dm_verity v, struct ahash_request req,
ffa39380 ST	127	const u8 data, size_t len, u8 digest);
	128
	129	extern int verity_hash_for_block(struct dm_verity v, struct dm_verity_io io,
0cc37c2d	130	sector_t block, u8 digest, bool is_zero);
ffa39380 ST	131
ffa39380 ST	132	#endif /* DM_VERITY_H */