1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2012 Red Hat, Inc.
5 * Author: Mikulas Patocka <mpatocka@redhat.com>
7 * Based on Chromium dm-verity driver (C) 2011 The Chromium OS Authors
9 * In the file "/sys/module/dm_verity/parameters/prefetch_cluster" you can set
10 * default prefetch value. Data are read in "prefetch_cluster" chunks from the
11 * hash device. Setting this greatly improves performance when data and hash
12 * are on the same disk on different partitions on devices with poor random
16 #include "dm-verity.h"
17 #include "dm-verity-fec.h"
18 #include "dm-verity-verify-sig.h"
19 #include <linux/module.h>
20 #include <linux/reboot.h>
22 #define DM_MSG_PREFIX "verity"
24 #define DM_VERITY_ENV_LENGTH 42
25 #define DM_VERITY_ENV_VAR_NAME "DM_VERITY_ERR_BLOCK_NR"
27 #define DM_VERITY_DEFAULT_PREFETCH_SIZE 262144
29 #define DM_VERITY_MAX_CORRUPTED_ERRS 100
31 #define DM_VERITY_OPT_LOGGING "ignore_corruption"
32 #define DM_VERITY_OPT_RESTART "restart_on_corruption"
33 #define DM_VERITY_OPT_PANIC "panic_on_corruption"
34 #define DM_VERITY_OPT_IGN_ZEROES "ignore_zero_blocks"
35 #define DM_VERITY_OPT_AT_MOST_ONCE "check_at_most_once"
37 #define DM_VERITY_OPTS_MAX (3 + DM_VERITY_OPTS_FEC + \
38 DM_VERITY_ROOT_HASH_VERIFICATION_OPTS)
40 static unsigned dm_verity_prefetch_cluster = DM_VERITY_DEFAULT_PREFETCH_SIZE;
42 module_param_named(prefetch_cluster, dm_verity_prefetch_cluster, uint, S_IRUGO | S_IWUSR);
44 struct dm_verity_prefetch_work {
45 struct work_struct work;
52 * Auxiliary structure appended to each dm-bufio buffer. If the value
53 * hash_verified is nonzero, hash of the block has been verified.
55 * The variable hash_verified is set to 0 when allocating the buffer, then
56 * it can be changed to 1 and it is never reset to 0 again.
58 * There is no lock around this value, a race condition can at worst cause
59 * that multiple processes verify the hash of the same buffer simultaneously
60 * and write 1 to hash_verified simultaneously.
61 * This condition is harmless, so we don't need locking.
68 * Initialize struct buffer_aux for a freshly created buffer.
70 static void dm_bufio_alloc_callback(struct dm_buffer *buf)
72 struct buffer_aux *aux = dm_bufio_get_aux_data(buf);
74 aux->hash_verified = 0;
78 * Translate input sector number to the sector number on the target device.
80 static sector_t verity_map_sector(struct dm_verity *v, sector_t bi_sector)
82 return v->data_start + dm_target_offset(v->ti, bi_sector);
86 * Return hash position of a specified block at a specified tree level
87 * (0 is the lowest level).
88 * The lowest "hash_per_block_bits"-bits of the result denote hash position
89 * inside a hash block. The remaining bits denote location of the hash block.
91 static sector_t verity_position_at_level(struct dm_verity *v, sector_t block,
94 return block >> (level * v->hash_per_block_bits);
97 static int verity_hash_update(struct dm_verity *v, struct ahash_request *req,
98 const u8 *data, size_t len,
99 struct crypto_wait *wait)
101 struct scatterlist sg;
103 if (likely(!is_vmalloc_addr(data))) {
104 sg_init_one(&sg, data, len);
105 ahash_request_set_crypt(req, &sg, NULL, len);
106 return crypto_wait_req(crypto_ahash_update(req), wait);
110 size_t this_step = min_t(size_t, len, PAGE_SIZE - offset_in_page(data));
111 flush_kernel_vmap_range((void *)data, this_step);
112 sg_init_table(&sg, 1);
113 sg_set_page(&sg, vmalloc_to_page(data), this_step, offset_in_page(data));
114 ahash_request_set_crypt(req, &sg, NULL, this_step);
115 r = crypto_wait_req(crypto_ahash_update(req), wait);
126 * Wrapper for crypto_ahash_init, which handles verity salting.
128 static int verity_hash_init(struct dm_verity *v, struct ahash_request *req,
129 struct crypto_wait *wait)
133 ahash_request_set_tfm(req, v->tfm);
134 ahash_request_set_callback(req, CRYPTO_TFM_REQ_MAY_SLEEP |
135 CRYPTO_TFM_REQ_MAY_BACKLOG,
136 crypto_req_done, (void *)wait);
137 crypto_init_wait(wait);
139 r = crypto_wait_req(crypto_ahash_init(req), wait);
141 if (unlikely(r < 0)) {
142 DMERR("crypto_ahash_init failed: %d", r);
146 if (likely(v->salt_size && (v->version >= 1)))
147 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
152 static int verity_hash_final(struct dm_verity *v, struct ahash_request *req,
153 u8 *digest, struct crypto_wait *wait)
157 if (unlikely(v->salt_size && (!v->version))) {
158 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
161 DMERR("verity_hash_final failed updating salt: %d", r);
166 ahash_request_set_crypt(req, NULL, digest, 0);
167 r = crypto_wait_req(crypto_ahash_final(req), wait);
172 int verity_hash(struct dm_verity *v, struct ahash_request *req,
173 const u8 *data, size_t len, u8 *digest)
176 struct crypto_wait wait;
178 r = verity_hash_init(v, req, &wait);
182 r = verity_hash_update(v, req, data, len, &wait);
186 r = verity_hash_final(v, req, digest, &wait);
192 static void verity_hash_at_level(struct dm_verity *v, sector_t block, int level,
193 sector_t *hash_block, unsigned *offset)
195 sector_t position = verity_position_at_level(v, block, level);
198 *hash_block = v->hash_level_block[level] + (position >> v->hash_per_block_bits);
203 idx = position & ((1 << v->hash_per_block_bits) - 1);
205 *offset = idx * v->digest_size;
207 *offset = idx << (v->hash_dev_block_bits - v->hash_per_block_bits);
211 * Handle verification errors.
213 static int verity_handle_err(struct dm_verity *v, enum verity_block_type type,
214 unsigned long long block)
216 char verity_env[DM_VERITY_ENV_LENGTH];
217 char *envp[] = { verity_env, NULL };
218 const char *type_str = "";
219 struct mapped_device *md = dm_table_get_md(v->ti->table);
221 /* Corruption should be visible in device status in all modes */
224 if (v->corrupted_errs >= DM_VERITY_MAX_CORRUPTED_ERRS)
230 case DM_VERITY_BLOCK_TYPE_DATA:
233 case DM_VERITY_BLOCK_TYPE_METADATA:
234 type_str = "metadata";
240 DMERR_LIMIT("%s: %s block %llu is corrupted", v->data_dev->name,
243 if (v->corrupted_errs == DM_VERITY_MAX_CORRUPTED_ERRS)
244 DMERR("%s: reached maximum errors", v->data_dev->name);
246 snprintf(verity_env, DM_VERITY_ENV_LENGTH, "%s=%d,%llu",
247 DM_VERITY_ENV_VAR_NAME, type, block);
249 kobject_uevent_env(&disk_to_dev(dm_disk(md))->kobj, KOBJ_CHANGE, envp);
252 if (v->mode == DM_VERITY_MODE_LOGGING)
255 if (v->mode == DM_VERITY_MODE_RESTART)
256 kernel_restart("dm-verity device corrupted");
258 if (v->mode == DM_VERITY_MODE_PANIC)
259 panic("dm-verity device corrupted");
265 * Verify hash of a metadata block pertaining to the specified data block
266 * ("block" argument) at a specified level ("level" argument).
268 * On successful return, verity_io_want_digest(v, io) contains the hash value
269 * for a lower tree level or for the data block (if we're at the lowest level).
271 * If "skip_unverified" is true, unverified buffer is skipped and 1 is returned.
272 * If "skip_unverified" is false, unverified buffer is hashed and verified
273 * against current value of verity_io_want_digest(v, io).
275 static int verity_verify_level(struct dm_verity *v, struct dm_verity_io *io,
276 sector_t block, int level, bool skip_unverified,
279 struct dm_buffer *buf;
280 struct buffer_aux *aux;
286 verity_hash_at_level(v, block, level, &hash_block, &offset);
288 data = dm_bufio_read(v->bufio, hash_block, &buf);
290 return PTR_ERR(data);
292 aux = dm_bufio_get_aux_data(buf);
294 if (!aux->hash_verified) {
295 if (skip_unverified) {
300 r = verity_hash(v, verity_io_hash_req(v, io),
301 data, 1 << v->hash_dev_block_bits,
302 verity_io_real_digest(v, io));
306 if (likely(memcmp(verity_io_real_digest(v, io), want_digest,
307 v->digest_size) == 0))
308 aux->hash_verified = 1;
309 else if (verity_fec_decode(v, io,
310 DM_VERITY_BLOCK_TYPE_METADATA,
311 hash_block, data, NULL) == 0)
312 aux->hash_verified = 1;
313 else if (verity_handle_err(v,
314 DM_VERITY_BLOCK_TYPE_METADATA,
322 memcpy(want_digest, data, v->digest_size);
326 dm_bufio_release(buf);
331 * Find a hash for a given block, write it to digest and verify the integrity
332 * of the hash tree if necessary.
334 int verity_hash_for_block(struct dm_verity *v, struct dm_verity_io *io,
335 sector_t block, u8 *digest, bool *is_zero)
339 if (likely(v->levels)) {
341 * First, we try to get the requested hash for
342 * the current block. If the hash block itself is
343 * verified, zero is returned. If it isn't, this
344 * function returns 1 and we fall back to whole
345 * chain verification.
347 r = verity_verify_level(v, io, block, 0, true, digest);
352 memcpy(digest, v->root_digest, v->digest_size);
354 for (i = v->levels - 1; i >= 0; i--) {
355 r = verity_verify_level(v, io, block, i, false, digest);
360 if (!r && v->zero_digest)
361 *is_zero = !memcmp(v->zero_digest, digest, v->digest_size);
369 * Calculates the digest for the given bio
371 static int verity_for_io_block(struct dm_verity *v, struct dm_verity_io *io,
372 struct bvec_iter *iter, struct crypto_wait *wait)
374 unsigned int todo = 1 << v->data_dev_block_bits;
375 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
376 struct scatterlist sg;
377 struct ahash_request *req = verity_io_hash_req(v, io);
382 struct bio_vec bv = bio_iter_iovec(bio, *iter);
384 sg_init_table(&sg, 1);
388 if (likely(len >= todo))
391 * Operating on a single page at a time looks suboptimal
392 * until you consider the typical block size is 4,096B.
393 * Going through this loops twice should be very rare.
395 sg_set_page(&sg, bv.bv_page, len, bv.bv_offset);
396 ahash_request_set_crypt(req, &sg, NULL, len);
397 r = crypto_wait_req(crypto_ahash_update(req), wait);
399 if (unlikely(r < 0)) {
400 DMERR("verity_for_io_block crypto op failed: %d", r);
404 bio_advance_iter(bio, iter, len);
412 * Calls function process for 1 << v->data_dev_block_bits bytes in the bio_vec
413 * starting from iter.
415 int verity_for_bv_block(struct dm_verity *v, struct dm_verity_io *io,
416 struct bvec_iter *iter,
417 int (*process)(struct dm_verity *v,
418 struct dm_verity_io *io, u8 *data,
421 unsigned todo = 1 << v->data_dev_block_bits;
422 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
428 struct bio_vec bv = bio_iter_iovec(bio, *iter);
430 page = kmap_atomic(bv.bv_page);
433 if (likely(len >= todo))
436 r = process(v, io, page + bv.bv_offset, len);
442 bio_advance_iter(bio, iter, len);
449 static int verity_bv_zero(struct dm_verity *v, struct dm_verity_io *io,
450 u8 *data, size_t len)
452 memset(data, 0, len);
457 * Moves the bio iter one data block forward.
459 static inline void verity_bv_skip_block(struct dm_verity *v,
460 struct dm_verity_io *io,
461 struct bvec_iter *iter)
463 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
465 bio_advance_iter(bio, iter, 1 << v->data_dev_block_bits);
469 * Verify one "dm_verity_io" structure.
471 static int verity_verify_io(struct dm_verity_io *io)
474 struct dm_verity *v = io->v;
475 struct bvec_iter start;
477 struct crypto_wait wait;
479 for (b = 0; b < io->n_blocks; b++) {
481 sector_t cur_block = io->block + b;
482 struct ahash_request *req = verity_io_hash_req(v, io);
484 if (v->validated_blocks &&
485 likely(test_bit(cur_block, v->validated_blocks))) {
486 verity_bv_skip_block(v, io, &io->iter);
490 r = verity_hash_for_block(v, io, cur_block,
491 verity_io_want_digest(v, io),
498 * If we expect a zero block, don't validate, just
501 r = verity_for_bv_block(v, io, &io->iter,
509 r = verity_hash_init(v, req, &wait);
514 r = verity_for_io_block(v, io, &io->iter, &wait);
518 r = verity_hash_final(v, req, verity_io_real_digest(v, io),
523 if (likely(memcmp(verity_io_real_digest(v, io),
524 verity_io_want_digest(v, io), v->digest_size) == 0)) {
525 if (v->validated_blocks)
526 set_bit(cur_block, v->validated_blocks);
529 else if (verity_fec_decode(v, io, DM_VERITY_BLOCK_TYPE_DATA,
530 cur_block, NULL, &start) == 0)
532 else if (verity_handle_err(v, DM_VERITY_BLOCK_TYPE_DATA,
541 * Skip verity work in response to I/O error when system is shutting down.
543 static inline bool verity_is_system_shutting_down(void)
545 return system_state == SYSTEM_HALT || system_state == SYSTEM_POWER_OFF
546 || system_state == SYSTEM_RESTART;
550 * End one "io" structure with a given error.
552 static void verity_finish_io(struct dm_verity_io *io, blk_status_t status)
554 struct dm_verity *v = io->v;
555 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
557 bio->bi_end_io = io->orig_bi_end_io;
558 bio->bi_status = status;
560 verity_fec_finish_io(io);
565 static void verity_work(struct work_struct *w)
567 struct dm_verity_io *io = container_of(w, struct dm_verity_io, work);
569 verity_finish_io(io, errno_to_blk_status(verity_verify_io(io)));
572 static void verity_end_io(struct bio *bio)
574 struct dm_verity_io *io = bio->bi_private;
576 if (bio->bi_status &&
577 (!verity_fec_is_enabled(io->v) || verity_is_system_shutting_down())) {
578 verity_finish_io(io, bio->bi_status);
582 INIT_WORK(&io->work, verity_work);
583 queue_work(io->v->verify_wq, &io->work);
587 * Prefetch buffers for the specified io.
588 * The root buffer is not prefetched, it is assumed that it will be cached
591 static void verity_prefetch_io(struct work_struct *work)
593 struct dm_verity_prefetch_work *pw =
594 container_of(work, struct dm_verity_prefetch_work, work);
595 struct dm_verity *v = pw->v;
598 for (i = v->levels - 2; i >= 0; i--) {
599 sector_t hash_block_start;
600 sector_t hash_block_end;
601 verity_hash_at_level(v, pw->block, i, &hash_block_start, NULL);
602 verity_hash_at_level(v, pw->block + pw->n_blocks - 1, i, &hash_block_end, NULL);
604 unsigned cluster = READ_ONCE(dm_verity_prefetch_cluster);
606 cluster >>= v->data_dev_block_bits;
607 if (unlikely(!cluster))
608 goto no_prefetch_cluster;
610 if (unlikely(cluster & (cluster - 1)))
611 cluster = 1 << __fls(cluster);
613 hash_block_start &= ~(sector_t)(cluster - 1);
614 hash_block_end |= cluster - 1;
615 if (unlikely(hash_block_end >= v->hash_blocks))
616 hash_block_end = v->hash_blocks - 1;
619 dm_bufio_prefetch(v->bufio, hash_block_start,
620 hash_block_end - hash_block_start + 1);
626 static void verity_submit_prefetch(struct dm_verity *v, struct dm_verity_io *io)
628 sector_t block = io->block;
629 unsigned int n_blocks = io->n_blocks;
630 struct dm_verity_prefetch_work *pw;
632 if (v->validated_blocks) {
633 while (n_blocks && test_bit(block, v->validated_blocks)) {
637 while (n_blocks && test_bit(block + n_blocks - 1,
638 v->validated_blocks))
644 pw = kmalloc(sizeof(struct dm_verity_prefetch_work),
645 GFP_NOIO | __GFP_NORETRY | __GFP_NOMEMALLOC | __GFP_NOWARN);
650 INIT_WORK(&pw->work, verity_prefetch_io);
653 pw->n_blocks = n_blocks;
654 queue_work(v->verify_wq, &pw->work);
658 * Bio map function. It allocates dm_verity_io structure and bio vector and
659 * fills them. Then it issues prefetches and the I/O.
661 static int verity_map(struct dm_target *ti, struct bio *bio)
663 struct dm_verity *v = ti->private;
664 struct dm_verity_io *io;
666 bio_set_dev(bio, v->data_dev->bdev);
667 bio->bi_iter.bi_sector = verity_map_sector(v, bio->bi_iter.bi_sector);
669 if (((unsigned)bio->bi_iter.bi_sector | bio_sectors(bio)) &
670 ((1 << (v->data_dev_block_bits - SECTOR_SHIFT)) - 1)) {
671 DMERR_LIMIT("unaligned io");
672 return DM_MAPIO_KILL;
675 if (bio_end_sector(bio) >>
676 (v->data_dev_block_bits - SECTOR_SHIFT) > v->data_blocks) {
677 DMERR_LIMIT("io out of range");
678 return DM_MAPIO_KILL;
681 if (bio_data_dir(bio) == WRITE)
682 return DM_MAPIO_KILL;
684 io = dm_per_bio_data(bio, ti->per_io_data_size);
686 io->orig_bi_end_io = bio->bi_end_io;
687 io->block = bio->bi_iter.bi_sector >> (v->data_dev_block_bits - SECTOR_SHIFT);
688 io->n_blocks = bio->bi_iter.bi_size >> v->data_dev_block_bits;
690 bio->bi_end_io = verity_end_io;
691 bio->bi_private = io;
692 io->iter = bio->bi_iter;
694 verity_fec_init_io(io);
696 verity_submit_prefetch(v, io);
698 submit_bio_noacct(bio);
700 return DM_MAPIO_SUBMITTED;
704 * Status: V (valid) or C (corruption found)
706 static void verity_status(struct dm_target *ti, status_type_t type,
707 unsigned status_flags, char *result, unsigned maxlen)
709 struct dm_verity *v = ti->private;
715 case STATUSTYPE_INFO:
716 DMEMIT("%c", v->hash_failed ? 'C' : 'V');
718 case STATUSTYPE_TABLE:
719 DMEMIT("%u %s %s %u %u %llu %llu %s ",
723 1 << v->data_dev_block_bits,
724 1 << v->hash_dev_block_bits,
725 (unsigned long long)v->data_blocks,
726 (unsigned long long)v->hash_start,
729 for (x = 0; x < v->digest_size; x++)
730 DMEMIT("%02x", v->root_digest[x]);
735 for (x = 0; x < v->salt_size; x++)
736 DMEMIT("%02x", v->salt[x]);
737 if (v->mode != DM_VERITY_MODE_EIO)
739 if (verity_fec_is_enabled(v))
740 args += DM_VERITY_OPTS_FEC;
743 if (v->validated_blocks)
745 if (v->signature_key_desc)
746 args += DM_VERITY_ROOT_HASH_VERIFICATION_OPTS;
750 if (v->mode != DM_VERITY_MODE_EIO) {
753 case DM_VERITY_MODE_LOGGING:
754 DMEMIT(DM_VERITY_OPT_LOGGING);
756 case DM_VERITY_MODE_RESTART:
757 DMEMIT(DM_VERITY_OPT_RESTART);
759 case DM_VERITY_MODE_PANIC:
760 DMEMIT(DM_VERITY_OPT_PANIC);
767 DMEMIT(" " DM_VERITY_OPT_IGN_ZEROES);
768 if (v->validated_blocks)
769 DMEMIT(" " DM_VERITY_OPT_AT_MOST_ONCE);
770 sz = verity_fec_status_table(v, sz, result, maxlen);
771 if (v->signature_key_desc)
772 DMEMIT(" " DM_VERITY_ROOT_HASH_VERIFICATION_OPT_SIG_KEY
773 " %s", v->signature_key_desc);
777 DMEMIT_TARGET_NAME_VERSION(ti->type);
778 DMEMIT(",hash_failed=%c", v->hash_failed ? 'C' : 'V');
779 DMEMIT(",verity_version=%u", v->version);
780 DMEMIT(",data_device_name=%s", v->data_dev->name);
781 DMEMIT(",hash_device_name=%s", v->hash_dev->name);
782 DMEMIT(",verity_algorithm=%s", v->alg_name);
784 DMEMIT(",root_digest=");
785 for (x = 0; x < v->digest_size; x++)
786 DMEMIT("%02x", v->root_digest[x]);
792 for (x = 0; x < v->salt_size; x++)
793 DMEMIT("%02x", v->salt[x]);
795 DMEMIT(",ignore_zero_blocks=%c", v->zero_digest ? 'y' : 'n');
796 DMEMIT(",check_at_most_once=%c", v->validated_blocks ? 'y' : 'n');
797 if (v->signature_key_desc)
798 DMEMIT(",root_hash_sig_key_desc=%s", v->signature_key_desc);
800 if (v->mode != DM_VERITY_MODE_EIO) {
801 DMEMIT(",verity_mode=");
803 case DM_VERITY_MODE_LOGGING:
804 DMEMIT(DM_VERITY_OPT_LOGGING);
806 case DM_VERITY_MODE_RESTART:
807 DMEMIT(DM_VERITY_OPT_RESTART);
809 case DM_VERITY_MODE_PANIC:
810 DMEMIT(DM_VERITY_OPT_PANIC);
821 static int verity_prepare_ioctl(struct dm_target *ti, struct block_device **bdev)
823 struct dm_verity *v = ti->private;
825 *bdev = v->data_dev->bdev;
828 ti->len != i_size_read(v->data_dev->bdev->bd_inode) >> SECTOR_SHIFT)
833 static int verity_iterate_devices(struct dm_target *ti,
834 iterate_devices_callout_fn fn, void *data)
836 struct dm_verity *v = ti->private;
838 return fn(ti, v->data_dev, v->data_start, ti->len, data);
841 static void verity_io_hints(struct dm_target *ti, struct queue_limits *limits)
843 struct dm_verity *v = ti->private;
845 if (limits->logical_block_size < 1 << v->data_dev_block_bits)
846 limits->logical_block_size = 1 << v->data_dev_block_bits;
848 if (limits->physical_block_size < 1 << v->data_dev_block_bits)
849 limits->physical_block_size = 1 << v->data_dev_block_bits;
851 blk_limits_io_min(limits, limits->logical_block_size);
854 static void verity_dtr(struct dm_target *ti)
856 struct dm_verity *v = ti->private;
859 destroy_workqueue(v->verify_wq);
862 dm_bufio_client_destroy(v->bufio);
864 kvfree(v->validated_blocks);
866 kfree(v->root_digest);
867 kfree(v->zero_digest);
870 crypto_free_ahash(v->tfm);
875 dm_put_device(ti, v->hash_dev);
878 dm_put_device(ti, v->data_dev);
882 kfree(v->signature_key_desc);
887 static int verity_alloc_most_once(struct dm_verity *v)
889 struct dm_target *ti = v->ti;
891 /* the bitset can only handle INT_MAX blocks */
892 if (v->data_blocks > INT_MAX) {
893 ti->error = "device too large to use check_at_most_once";
897 v->validated_blocks = kvcalloc(BITS_TO_LONGS(v->data_blocks),
898 sizeof(unsigned long),
900 if (!v->validated_blocks) {
901 ti->error = "failed to allocate bitset for check_at_most_once";
908 static int verity_alloc_zero_digest(struct dm_verity *v)
911 struct ahash_request *req;
914 v->zero_digest = kmalloc(v->digest_size, GFP_KERNEL);
919 req = kmalloc(v->ahash_reqsize, GFP_KERNEL);
922 return r; /* verity_dtr will free zero_digest */
924 zero_data = kzalloc(1 << v->data_dev_block_bits, GFP_KERNEL);
929 r = verity_hash(v, req, zero_data, 1 << v->data_dev_block_bits,
939 static inline bool verity_is_verity_mode(const char *arg_name)
941 return (!strcasecmp(arg_name, DM_VERITY_OPT_LOGGING) ||
942 !strcasecmp(arg_name, DM_VERITY_OPT_RESTART) ||
943 !strcasecmp(arg_name, DM_VERITY_OPT_PANIC));
946 static int verity_parse_verity_mode(struct dm_verity *v, const char *arg_name)
951 if (!strcasecmp(arg_name, DM_VERITY_OPT_LOGGING))
952 v->mode = DM_VERITY_MODE_LOGGING;
953 else if (!strcasecmp(arg_name, DM_VERITY_OPT_RESTART))
954 v->mode = DM_VERITY_MODE_RESTART;
955 else if (!strcasecmp(arg_name, DM_VERITY_OPT_PANIC))
956 v->mode = DM_VERITY_MODE_PANIC;
961 static int verity_parse_opt_args(struct dm_arg_set *as, struct dm_verity *v,
962 struct dm_verity_sig_opts *verify_args)
966 struct dm_target *ti = v->ti;
967 const char *arg_name;
969 static const struct dm_arg _args[] = {
970 {0, DM_VERITY_OPTS_MAX, "Invalid number of feature args"},
973 r = dm_read_arg_group(_args, as, &argc, &ti->error);
981 arg_name = dm_shift_arg(as);
984 if (verity_is_verity_mode(arg_name)) {
985 r = verity_parse_verity_mode(v, arg_name);
987 ti->error = "Conflicting error handling parameters";
992 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_IGN_ZEROES)) {
993 r = verity_alloc_zero_digest(v);
995 ti->error = "Cannot allocate zero digest";
1000 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_AT_MOST_ONCE)) {
1001 r = verity_alloc_most_once(v);
1006 } else if (verity_is_fec_opt_arg(arg_name)) {
1007 r = verity_fec_parse_opt_args(as, v, &argc, arg_name);
1011 } else if (verity_verify_is_sig_opt_arg(arg_name)) {
1012 r = verity_verify_sig_parse_opt_args(as, v,
1021 ti->error = "Unrecognized verity feature request";
1023 } while (argc && !r);
1029 * Target parameters:
1030 * <version> The current format is version 1.
1031 * Vsn 0 is compatible with original Chromium OS releases.
1036 * <the number of data blocks>
1037 * <hash start block>
1040 * <salt> Hex string or "-" if no salt.
1042 static int verity_ctr(struct dm_target *ti, unsigned argc, char **argv)
1044 struct dm_verity *v;
1045 struct dm_verity_sig_opts verify_args = {0};
1046 struct dm_arg_set as;
1048 unsigned long long num_ll;
1051 sector_t hash_position;
1053 char *root_hash_digest_to_validate;
1055 v = kzalloc(sizeof(struct dm_verity), GFP_KERNEL);
1057 ti->error = "Cannot allocate verity structure";
1063 r = verity_fec_ctr_alloc(v);
1067 if ((dm_table_get_mode(ti->table) & ~FMODE_READ)) {
1068 ti->error = "Device must be readonly";
1074 ti->error = "Not enough arguments";
1079 if (sscanf(argv[0], "%u%c", &num, &dummy) != 1 ||
1081 ti->error = "Invalid version";
1087 r = dm_get_device(ti, argv[1], FMODE_READ, &v->data_dev);
1089 ti->error = "Data device lookup failed";
1093 r = dm_get_device(ti, argv[2], FMODE_READ, &v->hash_dev);
1095 ti->error = "Hash device lookup failed";
1099 if (sscanf(argv[3], "%u%c", &num, &dummy) != 1 ||
1100 !num || (num & (num - 1)) ||
1101 num < bdev_logical_block_size(v->data_dev->bdev) ||
1103 ti->error = "Invalid data device block size";
1107 v->data_dev_block_bits = __ffs(num);
1109 if (sscanf(argv[4], "%u%c", &num, &dummy) != 1 ||
1110 !num || (num & (num - 1)) ||
1111 num < bdev_logical_block_size(v->hash_dev->bdev) ||
1113 ti->error = "Invalid hash device block size";
1117 v->hash_dev_block_bits = __ffs(num);
1119 if (sscanf(argv[5], "%llu%c", &num_ll, &dummy) != 1 ||
1120 (sector_t)(num_ll << (v->data_dev_block_bits - SECTOR_SHIFT))
1121 >> (v->data_dev_block_bits - SECTOR_SHIFT) != num_ll) {
1122 ti->error = "Invalid data blocks";
1126 v->data_blocks = num_ll;
1128 if (ti->len > (v->data_blocks << (v->data_dev_block_bits - SECTOR_SHIFT))) {
1129 ti->error = "Data device is too small";
1134 if (sscanf(argv[6], "%llu%c", &num_ll, &dummy) != 1 ||
1135 (sector_t)(num_ll << (v->hash_dev_block_bits - SECTOR_SHIFT))
1136 >> (v->hash_dev_block_bits - SECTOR_SHIFT) != num_ll) {
1137 ti->error = "Invalid hash start";
1141 v->hash_start = num_ll;
1143 v->alg_name = kstrdup(argv[7], GFP_KERNEL);
1145 ti->error = "Cannot allocate algorithm name";
1150 v->tfm = crypto_alloc_ahash(v->alg_name, 0, 0);
1151 if (IS_ERR(v->tfm)) {
1152 ti->error = "Cannot initialize hash function";
1153 r = PTR_ERR(v->tfm);
1159 * dm-verity performance can vary greatly depending on which hash
1160 * algorithm implementation is used. Help people debug performance
1161 * problems by logging the ->cra_driver_name.
1163 DMINFO("%s using implementation \"%s\"", v->alg_name,
1164 crypto_hash_alg_common(v->tfm)->base.cra_driver_name);
1166 v->digest_size = crypto_ahash_digestsize(v->tfm);
1167 if ((1 << v->hash_dev_block_bits) < v->digest_size * 2) {
1168 ti->error = "Digest size too big";
1172 v->ahash_reqsize = sizeof(struct ahash_request) +
1173 crypto_ahash_reqsize(v->tfm);
1175 v->root_digest = kmalloc(v->digest_size, GFP_KERNEL);
1176 if (!v->root_digest) {
1177 ti->error = "Cannot allocate root digest";
1181 if (strlen(argv[8]) != v->digest_size * 2 ||
1182 hex2bin(v->root_digest, argv[8], v->digest_size)) {
1183 ti->error = "Invalid root digest";
1187 root_hash_digest_to_validate = argv[8];
1189 if (strcmp(argv[9], "-")) {
1190 v->salt_size = strlen(argv[9]) / 2;
1191 v->salt = kmalloc(v->salt_size, GFP_KERNEL);
1193 ti->error = "Cannot allocate salt";
1197 if (strlen(argv[9]) != v->salt_size * 2 ||
1198 hex2bin(v->salt, argv[9], v->salt_size)) {
1199 ti->error = "Invalid salt";
1208 /* Optional parameters */
1213 r = verity_parse_opt_args(&as, v, &verify_args);
1218 /* Root hash signature is a optional parameter*/
1219 r = verity_verify_root_hash(root_hash_digest_to_validate,
1220 strlen(root_hash_digest_to_validate),
1222 verify_args.sig_size);
1224 ti->error = "Root hash verification failed";
1227 v->hash_per_block_bits =
1228 __fls((1 << v->hash_dev_block_bits) / v->digest_size);
1232 while (v->hash_per_block_bits * v->levels < 64 &&
1233 (unsigned long long)(v->data_blocks - 1) >>
1234 (v->hash_per_block_bits * v->levels))
1237 if (v->levels > DM_VERITY_MAX_LEVELS) {
1238 ti->error = "Too many tree levels";
1243 hash_position = v->hash_start;
1244 for (i = v->levels - 1; i >= 0; i--) {
1246 v->hash_level_block[i] = hash_position;
1247 s = (v->data_blocks + ((sector_t)1 << ((i + 1) * v->hash_per_block_bits)) - 1)
1248 >> ((i + 1) * v->hash_per_block_bits);
1249 if (hash_position + s < hash_position) {
1250 ti->error = "Hash device offset overflow";
1256 v->hash_blocks = hash_position;
1258 v->bufio = dm_bufio_client_create(v->hash_dev->bdev,
1259 1 << v->hash_dev_block_bits, 1, sizeof(struct buffer_aux),
1260 dm_bufio_alloc_callback, NULL);
1261 if (IS_ERR(v->bufio)) {
1262 ti->error = "Cannot initialize dm-bufio";
1263 r = PTR_ERR(v->bufio);
1268 if (dm_bufio_get_device_size(v->bufio) < v->hash_blocks) {
1269 ti->error = "Hash device is too small";
1274 /* WQ_UNBOUND greatly improves performance when running on ramdisk */
1275 v->verify_wq = alloc_workqueue("kverityd", WQ_CPU_INTENSIVE | WQ_MEM_RECLAIM | WQ_UNBOUND, num_online_cpus());
1276 if (!v->verify_wq) {
1277 ti->error = "Cannot allocate workqueue";
1282 ti->per_io_data_size = sizeof(struct dm_verity_io) +
1283 v->ahash_reqsize + v->digest_size * 2;
1285 r = verity_fec_ctr(v);
1289 ti->per_io_data_size = roundup(ti->per_io_data_size,
1290 __alignof__(struct dm_verity_io));
1292 verity_verify_sig_opts_cleanup(&verify_args);
1298 verity_verify_sig_opts_cleanup(&verify_args);
1304 static struct target_type verity_target = {
1306 .version = {1, 8, 0},
1307 .module = THIS_MODULE,
1311 .status = verity_status,
1312 .prepare_ioctl = verity_prepare_ioctl,
1313 .iterate_devices = verity_iterate_devices,
1314 .io_hints = verity_io_hints,
1317 static int __init dm_verity_init(void)
1321 r = dm_register_target(&verity_target);
1323 DMERR("register failed %d", r);
1328 static void __exit dm_verity_exit(void)
1330 dm_unregister_target(&verity_target);
1333 module_init(dm_verity_init);
1334 module_exit(dm_verity_exit);
1336 MODULE_AUTHOR("Mikulas Patocka <mpatocka@redhat.com>");
1337 MODULE_AUTHOR("Mandeep Baines <msb@chromium.org>");
1338 MODULE_AUTHOR("Will Drewry <wad@chromium.org>");
1339 MODULE_DESCRIPTION(DM_NAME " target for transparent disk integrity checking");
1340 MODULE_LICENSE("GPL");