1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2012 Red Hat, Inc.
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>
21 #include <linux/scatterlist.h>
22 #include <linux/string.h>
23 #include <linux/jump_label.h>
25 #define DM_MSG_PREFIX "verity"
27 #define DM_VERITY_ENV_LENGTH 42
28 #define DM_VERITY_ENV_VAR_NAME "DM_VERITY_ERR_BLOCK_NR"
30 #define DM_VERITY_DEFAULT_PREFETCH_SIZE 262144
32 #define DM_VERITY_MAX_CORRUPTED_ERRS 100
34 #define DM_VERITY_OPT_LOGGING "ignore_corruption"
35 #define DM_VERITY_OPT_RESTART "restart_on_corruption"
36 #define DM_VERITY_OPT_PANIC "panic_on_corruption"
37 #define DM_VERITY_OPT_IGN_ZEROES "ignore_zero_blocks"
38 #define DM_VERITY_OPT_AT_MOST_ONCE "check_at_most_once"
39 #define DM_VERITY_OPT_TASKLET_VERIFY "try_verify_in_tasklet"
41 #define DM_VERITY_OPTS_MAX (4 + DM_VERITY_OPTS_FEC + \
42 DM_VERITY_ROOT_HASH_VERIFICATION_OPTS)
44 static unsigned dm_verity_prefetch_cluster = DM_VERITY_DEFAULT_PREFETCH_SIZE;
46 module_param_named(prefetch_cluster, dm_verity_prefetch_cluster, uint, S_IRUGO | S_IWUSR);
48 static DEFINE_STATIC_KEY_FALSE(use_tasklet_enabled);
50 struct dm_verity_prefetch_work {
51 struct work_struct work;
58 * Auxiliary structure appended to each dm-bufio buffer. If the value
59 * hash_verified is nonzero, hash of the block has been verified.
61 * The variable hash_verified is set to 0 when allocating the buffer, then
62 * it can be changed to 1 and it is never reset to 0 again.
64 * There is no lock around this value, a race condition can at worst cause
65 * that multiple processes verify the hash of the same buffer simultaneously
66 * and write 1 to hash_verified simultaneously.
67 * This condition is harmless, so we don't need locking.
74 * Initialize struct buffer_aux for a freshly created buffer.
76 static void dm_bufio_alloc_callback(struct dm_buffer *buf)
78 struct buffer_aux *aux = dm_bufio_get_aux_data(buf);
80 aux->hash_verified = 0;
84 * Translate input sector number to the sector number on the target device.
86 static sector_t verity_map_sector(struct dm_verity *v, sector_t bi_sector)
88 return v->data_start + dm_target_offset(v->ti, bi_sector);
92 * Return hash position of a specified block at a specified tree level
93 * (0 is the lowest level).
94 * The lowest "hash_per_block_bits"-bits of the result denote hash position
95 * inside a hash block. The remaining bits denote location of the hash block.
97 static sector_t verity_position_at_level(struct dm_verity *v, sector_t block,
100 return block >> (level * v->hash_per_block_bits);
103 static int verity_hash_update(struct dm_verity *v, struct ahash_request *req,
104 const u8 *data, size_t len,
105 struct crypto_wait *wait)
107 struct scatterlist sg;
109 if (likely(!is_vmalloc_addr(data))) {
110 sg_init_one(&sg, data, len);
111 ahash_request_set_crypt(req, &sg, NULL, len);
112 return crypto_wait_req(crypto_ahash_update(req), wait);
116 size_t this_step = min_t(size_t, len, PAGE_SIZE - offset_in_page(data));
117 flush_kernel_vmap_range((void *)data, this_step);
118 sg_init_table(&sg, 1);
119 sg_set_page(&sg, vmalloc_to_page(data), this_step, offset_in_page(data));
120 ahash_request_set_crypt(req, &sg, NULL, this_step);
121 r = crypto_wait_req(crypto_ahash_update(req), wait);
132 * Wrapper for crypto_ahash_init, which handles verity salting.
134 static int verity_hash_init(struct dm_verity *v, struct ahash_request *req,
135 struct crypto_wait *wait)
139 ahash_request_set_tfm(req, v->tfm);
140 ahash_request_set_callback(req, CRYPTO_TFM_REQ_MAY_SLEEP |
141 CRYPTO_TFM_REQ_MAY_BACKLOG,
142 crypto_req_done, (void *)wait);
143 crypto_init_wait(wait);
145 r = crypto_wait_req(crypto_ahash_init(req), wait);
147 if (unlikely(r < 0)) {
148 DMERR("crypto_ahash_init failed: %d", r);
152 if (likely(v->salt_size && (v->version >= 1)))
153 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
158 static int verity_hash_final(struct dm_verity *v, struct ahash_request *req,
159 u8 *digest, struct crypto_wait *wait)
163 if (unlikely(v->salt_size && (!v->version))) {
164 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
167 DMERR("verity_hash_final failed updating salt: %d", r);
172 ahash_request_set_crypt(req, NULL, digest, 0);
173 r = crypto_wait_req(crypto_ahash_final(req), wait);
178 int verity_hash(struct dm_verity *v, struct ahash_request *req,
179 const u8 *data, size_t len, u8 *digest)
182 struct crypto_wait wait;
184 r = verity_hash_init(v, req, &wait);
188 r = verity_hash_update(v, req, data, len, &wait);
192 r = verity_hash_final(v, req, digest, &wait);
198 static void verity_hash_at_level(struct dm_verity *v, sector_t block, int level,
199 sector_t *hash_block, unsigned *offset)
201 sector_t position = verity_position_at_level(v, block, level);
204 *hash_block = v->hash_level_block[level] + (position >> v->hash_per_block_bits);
209 idx = position & ((1 << v->hash_per_block_bits) - 1);
211 *offset = idx * v->digest_size;
213 *offset = idx << (v->hash_dev_block_bits - v->hash_per_block_bits);
217 * Handle verification errors.
219 static int verity_handle_err(struct dm_verity *v, enum verity_block_type type,
220 unsigned long long block)
222 char verity_env[DM_VERITY_ENV_LENGTH];
223 char *envp[] = { verity_env, NULL };
224 const char *type_str = "";
225 struct mapped_device *md = dm_table_get_md(v->ti->table);
227 /* Corruption should be visible in device status in all modes */
228 v->hash_failed = true;
230 if (v->corrupted_errs >= DM_VERITY_MAX_CORRUPTED_ERRS)
236 case DM_VERITY_BLOCK_TYPE_DATA:
239 case DM_VERITY_BLOCK_TYPE_METADATA:
240 type_str = "metadata";
246 DMERR_LIMIT("%s: %s block %llu is corrupted", v->data_dev->name,
249 if (v->corrupted_errs == DM_VERITY_MAX_CORRUPTED_ERRS)
250 DMERR("%s: reached maximum errors", v->data_dev->name);
252 snprintf(verity_env, DM_VERITY_ENV_LENGTH, "%s=%d,%llu",
253 DM_VERITY_ENV_VAR_NAME, type, block);
255 kobject_uevent_env(&disk_to_dev(dm_disk(md))->kobj, KOBJ_CHANGE, envp);
258 if (v->mode == DM_VERITY_MODE_LOGGING)
261 if (v->mode == DM_VERITY_MODE_RESTART)
262 kernel_restart("dm-verity device corrupted");
264 if (v->mode == DM_VERITY_MODE_PANIC)
265 panic("dm-verity device corrupted");
271 * Verify hash of a metadata block pertaining to the specified data block
272 * ("block" argument) at a specified level ("level" argument).
274 * On successful return, verity_io_want_digest(v, io) contains the hash value
275 * for a lower tree level or for the data block (if we're at the lowest level).
277 * If "skip_unverified" is true, unverified buffer is skipped and 1 is returned.
278 * If "skip_unverified" is false, unverified buffer is hashed and verified
279 * against current value of verity_io_want_digest(v, io).
281 static int verity_verify_level(struct dm_verity *v, struct dm_verity_io *io,
282 sector_t block, int level, bool skip_unverified,
285 struct dm_buffer *buf;
286 struct buffer_aux *aux;
292 verity_hash_at_level(v, block, level, &hash_block, &offset);
294 if (static_branch_unlikely(&use_tasklet_enabled) && io->in_tasklet) {
295 data = dm_bufio_get(v->bufio, hash_block, &buf);
298 * In tasklet and the hash was not in the bufio cache.
299 * Return early and resume execution from a work-queue
300 * to read the hash from disk.
305 data = dm_bufio_read(v->bufio, hash_block, &buf);
308 return PTR_ERR(data);
310 aux = dm_bufio_get_aux_data(buf);
312 if (!aux->hash_verified) {
313 if (skip_unverified) {
318 r = verity_hash(v, verity_io_hash_req(v, io),
319 data, 1 << v->hash_dev_block_bits,
320 verity_io_real_digest(v, io));
324 if (likely(memcmp(verity_io_real_digest(v, io), want_digest,
325 v->digest_size) == 0))
326 aux->hash_verified = 1;
327 else if (static_branch_unlikely(&use_tasklet_enabled) &&
330 * Error handling code (FEC included) cannot be run in a
331 * tasklet since it may sleep, so fallback to work-queue.
336 else if (verity_fec_decode(v, io,
337 DM_VERITY_BLOCK_TYPE_METADATA,
338 hash_block, data, NULL) == 0)
339 aux->hash_verified = 1;
340 else if (verity_handle_err(v,
341 DM_VERITY_BLOCK_TYPE_METADATA,
349 memcpy(want_digest, data, v->digest_size);
353 dm_bufio_release(buf);
358 * Find a hash for a given block, write it to digest and verify the integrity
359 * of the hash tree if necessary.
361 int verity_hash_for_block(struct dm_verity *v, struct dm_verity_io *io,
362 sector_t block, u8 *digest, bool *is_zero)
366 if (likely(v->levels)) {
368 * First, we try to get the requested hash for
369 * the current block. If the hash block itself is
370 * verified, zero is returned. If it isn't, this
371 * function returns 1 and we fall back to whole
372 * chain verification.
374 r = verity_verify_level(v, io, block, 0, true, digest);
379 memcpy(digest, v->root_digest, v->digest_size);
381 for (i = v->levels - 1; i >= 0; i--) {
382 r = verity_verify_level(v, io, block, i, false, digest);
387 if (!r && v->zero_digest)
388 *is_zero = !memcmp(v->zero_digest, digest, v->digest_size);
396 * Calculates the digest for the given bio
398 static int verity_for_io_block(struct dm_verity *v, struct dm_verity_io *io,
399 struct bvec_iter *iter, struct crypto_wait *wait)
401 unsigned int todo = 1 << v->data_dev_block_bits;
402 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
403 struct scatterlist sg;
404 struct ahash_request *req = verity_io_hash_req(v, io);
409 struct bio_vec bv = bio_iter_iovec(bio, *iter);
411 sg_init_table(&sg, 1);
415 if (likely(len >= todo))
418 * Operating on a single page at a time looks suboptimal
419 * until you consider the typical block size is 4,096B.
420 * Going through this loops twice should be very rare.
422 sg_set_page(&sg, bv.bv_page, len, bv.bv_offset);
423 ahash_request_set_crypt(req, &sg, NULL, len);
424 r = crypto_wait_req(crypto_ahash_update(req), wait);
426 if (unlikely(r < 0)) {
427 DMERR("verity_for_io_block crypto op failed: %d", r);
431 bio_advance_iter(bio, iter, len);
439 * Calls function process for 1 << v->data_dev_block_bits bytes in the bio_vec
440 * starting from iter.
442 int verity_for_bv_block(struct dm_verity *v, struct dm_verity_io *io,
443 struct bvec_iter *iter,
444 int (*process)(struct dm_verity *v,
445 struct dm_verity_io *io, u8 *data,
448 unsigned todo = 1 << v->data_dev_block_bits;
449 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
455 struct bio_vec bv = bio_iter_iovec(bio, *iter);
457 page = bvec_kmap_local(&bv);
460 if (likely(len >= todo))
463 r = process(v, io, page, len);
469 bio_advance_iter(bio, iter, len);
476 static int verity_bv_zero(struct dm_verity *v, struct dm_verity_io *io,
477 u8 *data, size_t len)
479 memset(data, 0, len);
484 * Moves the bio iter one data block forward.
486 static inline void verity_bv_skip_block(struct dm_verity *v,
487 struct dm_verity_io *io,
488 struct bvec_iter *iter)
490 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
492 bio_advance_iter(bio, iter, 1 << v->data_dev_block_bits);
496 * Verify one "dm_verity_io" structure.
498 static int verity_verify_io(struct dm_verity_io *io)
501 struct dm_verity *v = io->v;
502 #if defined(CONFIG_DM_VERITY_FEC)
503 struct bvec_iter start;
505 struct bvec_iter iter_copy;
506 struct bvec_iter *iter;
507 struct crypto_wait wait;
508 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
511 if (static_branch_unlikely(&use_tasklet_enabled) && io->in_tasklet) {
513 * Copy the iterator in case we need to restart
514 * verification in a work-queue.
516 iter_copy = io->iter;
521 for (b = 0; b < io->n_blocks; b++) {
523 sector_t cur_block = io->block + b;
524 struct ahash_request *req = verity_io_hash_req(v, io);
526 if (v->validated_blocks &&
527 likely(test_bit(cur_block, v->validated_blocks))) {
528 verity_bv_skip_block(v, io, iter);
532 r = verity_hash_for_block(v, io, cur_block,
533 verity_io_want_digest(v, io),
540 * If we expect a zero block, don't validate, just
543 r = verity_for_bv_block(v, io, iter,
551 r = verity_hash_init(v, req, &wait);
555 #if defined(CONFIG_DM_VERITY_FEC)
556 if (verity_fec_is_enabled(v))
559 r = verity_for_io_block(v, io, iter, &wait);
563 r = verity_hash_final(v, req, verity_io_real_digest(v, io),
568 if (likely(memcmp(verity_io_real_digest(v, io),
569 verity_io_want_digest(v, io), v->digest_size) == 0)) {
570 if (v->validated_blocks)
571 set_bit(cur_block, v->validated_blocks);
573 } else if (static_branch_unlikely(&use_tasklet_enabled) &&
576 * Error handling code (FEC included) cannot be run in a
577 * tasklet since it may sleep, so fallback to work-queue.
580 #if defined(CONFIG_DM_VERITY_FEC)
581 } else if (verity_fec_decode(v, io, DM_VERITY_BLOCK_TYPE_DATA,
582 cur_block, NULL, &start) == 0) {
586 if (bio->bi_status) {
588 * Error correction failed; Just return error
592 if (verity_handle_err(v, DM_VERITY_BLOCK_TYPE_DATA,
602 * Skip verity work in response to I/O error when system is shutting down.
604 static inline bool verity_is_system_shutting_down(void)
606 return system_state == SYSTEM_HALT || system_state == SYSTEM_POWER_OFF
607 || system_state == SYSTEM_RESTART;
611 * End one "io" structure with a given error.
613 static void verity_finish_io(struct dm_verity_io *io, blk_status_t status)
615 struct dm_verity *v = io->v;
616 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
618 bio->bi_end_io = io->orig_bi_end_io;
619 bio->bi_status = status;
621 if (!static_branch_unlikely(&use_tasklet_enabled) || !io->in_tasklet)
622 verity_fec_finish_io(io);
627 static void verity_work(struct work_struct *w)
629 struct dm_verity_io *io = container_of(w, struct dm_verity_io, work);
631 io->in_tasklet = false;
633 verity_fec_init_io(io);
634 verity_finish_io(io, errno_to_blk_status(verity_verify_io(io)));
637 static void verity_tasklet(unsigned long data)
639 struct dm_verity_io *io = (struct dm_verity_io *)data;
642 io->in_tasklet = true;
643 err = verity_verify_io(io);
644 if (err == -EAGAIN) {
645 /* fallback to retrying with work-queue */
646 INIT_WORK(&io->work, verity_work);
647 queue_work(io->v->verify_wq, &io->work);
651 verity_finish_io(io, errno_to_blk_status(err));
654 static void verity_end_io(struct bio *bio)
656 struct dm_verity_io *io = bio->bi_private;
658 if (bio->bi_status &&
659 (!verity_fec_is_enabled(io->v) || verity_is_system_shutting_down())) {
660 verity_finish_io(io, bio->bi_status);
664 if (static_branch_unlikely(&use_tasklet_enabled) && io->v->use_tasklet) {
665 tasklet_init(&io->tasklet, verity_tasklet, (unsigned long)io);
666 tasklet_schedule(&io->tasklet);
668 INIT_WORK(&io->work, verity_work);
669 queue_work(io->v->verify_wq, &io->work);
674 * Prefetch buffers for the specified io.
675 * The root buffer is not prefetched, it is assumed that it will be cached
678 static void verity_prefetch_io(struct work_struct *work)
680 struct dm_verity_prefetch_work *pw =
681 container_of(work, struct dm_verity_prefetch_work, work);
682 struct dm_verity *v = pw->v;
685 for (i = v->levels - 2; i >= 0; i--) {
686 sector_t hash_block_start;
687 sector_t hash_block_end;
688 verity_hash_at_level(v, pw->block, i, &hash_block_start, NULL);
689 verity_hash_at_level(v, pw->block + pw->n_blocks - 1, i, &hash_block_end, NULL);
691 unsigned cluster = READ_ONCE(dm_verity_prefetch_cluster);
693 cluster >>= v->data_dev_block_bits;
694 if (unlikely(!cluster))
695 goto no_prefetch_cluster;
697 if (unlikely(cluster & (cluster - 1)))
698 cluster = 1 << __fls(cluster);
700 hash_block_start &= ~(sector_t)(cluster - 1);
701 hash_block_end |= cluster - 1;
702 if (unlikely(hash_block_end >= v->hash_blocks))
703 hash_block_end = v->hash_blocks - 1;
706 dm_bufio_prefetch(v->bufio, hash_block_start,
707 hash_block_end - hash_block_start + 1);
713 static void verity_submit_prefetch(struct dm_verity *v, struct dm_verity_io *io)
715 sector_t block = io->block;
716 unsigned int n_blocks = io->n_blocks;
717 struct dm_verity_prefetch_work *pw;
719 if (v->validated_blocks) {
720 while (n_blocks && test_bit(block, v->validated_blocks)) {
724 while (n_blocks && test_bit(block + n_blocks - 1,
725 v->validated_blocks))
731 pw = kmalloc(sizeof(struct dm_verity_prefetch_work),
732 GFP_NOIO | __GFP_NORETRY | __GFP_NOMEMALLOC | __GFP_NOWARN);
737 INIT_WORK(&pw->work, verity_prefetch_io);
740 pw->n_blocks = n_blocks;
741 queue_work(v->verify_wq, &pw->work);
745 * Bio map function. It allocates dm_verity_io structure and bio vector and
746 * fills them. Then it issues prefetches and the I/O.
748 static int verity_map(struct dm_target *ti, struct bio *bio)
750 struct dm_verity *v = ti->private;
751 struct dm_verity_io *io;
753 bio_set_dev(bio, v->data_dev->bdev);
754 bio->bi_iter.bi_sector = verity_map_sector(v, bio->bi_iter.bi_sector);
756 if (((unsigned)bio->bi_iter.bi_sector | bio_sectors(bio)) &
757 ((1 << (v->data_dev_block_bits - SECTOR_SHIFT)) - 1)) {
758 DMERR_LIMIT("unaligned io");
759 return DM_MAPIO_KILL;
762 if (bio_end_sector(bio) >>
763 (v->data_dev_block_bits - SECTOR_SHIFT) > v->data_blocks) {
764 DMERR_LIMIT("io out of range");
765 return DM_MAPIO_KILL;
768 if (bio_data_dir(bio) == WRITE)
769 return DM_MAPIO_KILL;
771 io = dm_per_bio_data(bio, ti->per_io_data_size);
773 io->orig_bi_end_io = bio->bi_end_io;
774 io->block = bio->bi_iter.bi_sector >> (v->data_dev_block_bits - SECTOR_SHIFT);
775 io->n_blocks = bio->bi_iter.bi_size >> v->data_dev_block_bits;
777 bio->bi_end_io = verity_end_io;
778 bio->bi_private = io;
779 io->iter = bio->bi_iter;
781 verity_submit_prefetch(v, io);
783 submit_bio_noacct(bio);
785 return DM_MAPIO_SUBMITTED;
789 * Status: V (valid) or C (corruption found)
791 static void verity_status(struct dm_target *ti, status_type_t type,
792 unsigned status_flags, char *result, unsigned maxlen)
794 struct dm_verity *v = ti->private;
800 case STATUSTYPE_INFO:
801 DMEMIT("%c", v->hash_failed ? 'C' : 'V');
803 case STATUSTYPE_TABLE:
804 DMEMIT("%u %s %s %u %u %llu %llu %s ",
808 1 << v->data_dev_block_bits,
809 1 << v->hash_dev_block_bits,
810 (unsigned long long)v->data_blocks,
811 (unsigned long long)v->hash_start,
814 for (x = 0; x < v->digest_size; x++)
815 DMEMIT("%02x", v->root_digest[x]);
820 for (x = 0; x < v->salt_size; x++)
821 DMEMIT("%02x", v->salt[x]);
822 if (v->mode != DM_VERITY_MODE_EIO)
824 if (verity_fec_is_enabled(v))
825 args += DM_VERITY_OPTS_FEC;
828 if (v->validated_blocks)
832 if (v->signature_key_desc)
833 args += DM_VERITY_ROOT_HASH_VERIFICATION_OPTS;
837 if (v->mode != DM_VERITY_MODE_EIO) {
840 case DM_VERITY_MODE_LOGGING:
841 DMEMIT(DM_VERITY_OPT_LOGGING);
843 case DM_VERITY_MODE_RESTART:
844 DMEMIT(DM_VERITY_OPT_RESTART);
846 case DM_VERITY_MODE_PANIC:
847 DMEMIT(DM_VERITY_OPT_PANIC);
854 DMEMIT(" " DM_VERITY_OPT_IGN_ZEROES);
855 if (v->validated_blocks)
856 DMEMIT(" " DM_VERITY_OPT_AT_MOST_ONCE);
858 DMEMIT(" " DM_VERITY_OPT_TASKLET_VERIFY);
859 sz = verity_fec_status_table(v, sz, result, maxlen);
860 if (v->signature_key_desc)
861 DMEMIT(" " DM_VERITY_ROOT_HASH_VERIFICATION_OPT_SIG_KEY
862 " %s", v->signature_key_desc);
866 DMEMIT_TARGET_NAME_VERSION(ti->type);
867 DMEMIT(",hash_failed=%c", v->hash_failed ? 'C' : 'V');
868 DMEMIT(",verity_version=%u", v->version);
869 DMEMIT(",data_device_name=%s", v->data_dev->name);
870 DMEMIT(",hash_device_name=%s", v->hash_dev->name);
871 DMEMIT(",verity_algorithm=%s", v->alg_name);
873 DMEMIT(",root_digest=");
874 for (x = 0; x < v->digest_size; x++)
875 DMEMIT("%02x", v->root_digest[x]);
881 for (x = 0; x < v->salt_size; x++)
882 DMEMIT("%02x", v->salt[x]);
884 DMEMIT(",ignore_zero_blocks=%c", v->zero_digest ? 'y' : 'n');
885 DMEMIT(",check_at_most_once=%c", v->validated_blocks ? 'y' : 'n');
886 if (v->signature_key_desc)
887 DMEMIT(",root_hash_sig_key_desc=%s", v->signature_key_desc);
889 if (v->mode != DM_VERITY_MODE_EIO) {
890 DMEMIT(",verity_mode=");
892 case DM_VERITY_MODE_LOGGING:
893 DMEMIT(DM_VERITY_OPT_LOGGING);
895 case DM_VERITY_MODE_RESTART:
896 DMEMIT(DM_VERITY_OPT_RESTART);
898 case DM_VERITY_MODE_PANIC:
899 DMEMIT(DM_VERITY_OPT_PANIC);
910 static int verity_prepare_ioctl(struct dm_target *ti, struct block_device **bdev)
912 struct dm_verity *v = ti->private;
914 *bdev = v->data_dev->bdev;
916 if (v->data_start || ti->len != bdev_nr_sectors(v->data_dev->bdev))
921 static int verity_iterate_devices(struct dm_target *ti,
922 iterate_devices_callout_fn fn, void *data)
924 struct dm_verity *v = ti->private;
926 return fn(ti, v->data_dev, v->data_start, ti->len, data);
929 static void verity_io_hints(struct dm_target *ti, struct queue_limits *limits)
931 struct dm_verity *v = ti->private;
933 if (limits->logical_block_size < 1 << v->data_dev_block_bits)
934 limits->logical_block_size = 1 << v->data_dev_block_bits;
936 if (limits->physical_block_size < 1 << v->data_dev_block_bits)
937 limits->physical_block_size = 1 << v->data_dev_block_bits;
939 blk_limits_io_min(limits, limits->logical_block_size);
942 static void verity_dtr(struct dm_target *ti)
944 struct dm_verity *v = ti->private;
947 destroy_workqueue(v->verify_wq);
950 dm_bufio_client_destroy(v->bufio);
952 kvfree(v->validated_blocks);
954 kfree(v->root_digest);
955 kfree(v->zero_digest);
958 crypto_free_ahash(v->tfm);
963 dm_put_device(ti, v->hash_dev);
966 dm_put_device(ti, v->data_dev);
970 kfree(v->signature_key_desc);
973 static_branch_dec(&use_tasklet_enabled);
978 static int verity_alloc_most_once(struct dm_verity *v)
980 struct dm_target *ti = v->ti;
982 /* the bitset can only handle INT_MAX blocks */
983 if (v->data_blocks > INT_MAX) {
984 ti->error = "device too large to use check_at_most_once";
988 v->validated_blocks = kvcalloc(BITS_TO_LONGS(v->data_blocks),
989 sizeof(unsigned long),
991 if (!v->validated_blocks) {
992 ti->error = "failed to allocate bitset for check_at_most_once";
999 static int verity_alloc_zero_digest(struct dm_verity *v)
1002 struct ahash_request *req;
1005 v->zero_digest = kmalloc(v->digest_size, GFP_KERNEL);
1007 if (!v->zero_digest)
1010 req = kmalloc(v->ahash_reqsize, GFP_KERNEL);
1013 return r; /* verity_dtr will free zero_digest */
1015 zero_data = kzalloc(1 << v->data_dev_block_bits, GFP_KERNEL);
1020 r = verity_hash(v, req, zero_data, 1 << v->data_dev_block_bits,
1030 static inline bool verity_is_verity_mode(const char *arg_name)
1032 return (!strcasecmp(arg_name, DM_VERITY_OPT_LOGGING) ||
1033 !strcasecmp(arg_name, DM_VERITY_OPT_RESTART) ||
1034 !strcasecmp(arg_name, DM_VERITY_OPT_PANIC));
1037 static int verity_parse_verity_mode(struct dm_verity *v, const char *arg_name)
1042 if (!strcasecmp(arg_name, DM_VERITY_OPT_LOGGING))
1043 v->mode = DM_VERITY_MODE_LOGGING;
1044 else if (!strcasecmp(arg_name, DM_VERITY_OPT_RESTART))
1045 v->mode = DM_VERITY_MODE_RESTART;
1046 else if (!strcasecmp(arg_name, DM_VERITY_OPT_PANIC))
1047 v->mode = DM_VERITY_MODE_PANIC;
1052 static int verity_parse_opt_args(struct dm_arg_set *as, struct dm_verity *v,
1053 struct dm_verity_sig_opts *verify_args,
1054 bool only_modifier_opts)
1058 struct dm_target *ti = v->ti;
1059 const char *arg_name;
1061 static const struct dm_arg _args[] = {
1062 {0, DM_VERITY_OPTS_MAX, "Invalid number of feature args"},
1065 r = dm_read_arg_group(_args, as, &argc, &ti->error);
1073 arg_name = dm_shift_arg(as);
1076 if (verity_is_verity_mode(arg_name)) {
1077 if (only_modifier_opts)
1079 r = verity_parse_verity_mode(v, arg_name);
1081 ti->error = "Conflicting error handling parameters";
1086 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_IGN_ZEROES)) {
1087 if (only_modifier_opts)
1089 r = verity_alloc_zero_digest(v);
1091 ti->error = "Cannot allocate zero digest";
1096 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_AT_MOST_ONCE)) {
1097 if (only_modifier_opts)
1099 r = verity_alloc_most_once(v);
1104 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_TASKLET_VERIFY)) {
1105 v->use_tasklet = true;
1106 static_branch_inc(&use_tasklet_enabled);
1109 } else if (verity_is_fec_opt_arg(arg_name)) {
1110 if (only_modifier_opts)
1112 r = verity_fec_parse_opt_args(as, v, &argc, arg_name);
1117 } else if (verity_verify_is_sig_opt_arg(arg_name)) {
1118 if (only_modifier_opts)
1120 r = verity_verify_sig_parse_opt_args(as, v,
1127 } else if (only_modifier_opts) {
1129 * Ignore unrecognized opt, could easily be an extra
1130 * argument to an option whose parsing was skipped.
1131 * Normal parsing (@only_modifier_opts=false) will
1132 * properly parse all options (and their extra args).
1137 DMERR("Unrecognized verity feature request: %s", arg_name);
1138 ti->error = "Unrecognized verity feature request";
1140 } while (argc && !r);
1146 * Target parameters:
1147 * <version> The current format is version 1.
1148 * Vsn 0 is compatible with original Chromium OS releases.
1153 * <the number of data blocks>
1154 * <hash start block>
1157 * <salt> Hex string or "-" if no salt.
1159 static int verity_ctr(struct dm_target *ti, unsigned argc, char **argv)
1161 struct dm_verity *v;
1162 struct dm_verity_sig_opts verify_args = {0};
1163 struct dm_arg_set as;
1165 unsigned int wq_flags;
1166 unsigned long long num_ll;
1169 sector_t hash_position;
1171 char *root_hash_digest_to_validate;
1173 v = kzalloc(sizeof(struct dm_verity), GFP_KERNEL);
1175 ti->error = "Cannot allocate verity structure";
1181 r = verity_fec_ctr_alloc(v);
1185 if ((dm_table_get_mode(ti->table) & ~FMODE_READ)) {
1186 ti->error = "Device must be readonly";
1192 ti->error = "Not enough arguments";
1197 /* Parse optional parameters that modify primary args */
1199 as.argc = argc - 10;
1200 as.argv = argv + 10;
1201 r = verity_parse_opt_args(&as, v, &verify_args, true);
1206 if (sscanf(argv[0], "%u%c", &num, &dummy) != 1 ||
1208 ti->error = "Invalid version";
1214 r = dm_get_device(ti, argv[1], FMODE_READ, &v->data_dev);
1216 ti->error = "Data device lookup failed";
1220 r = dm_get_device(ti, argv[2], FMODE_READ, &v->hash_dev);
1222 ti->error = "Hash device lookup failed";
1226 if (sscanf(argv[3], "%u%c", &num, &dummy) != 1 ||
1227 !num || (num & (num - 1)) ||
1228 num < bdev_logical_block_size(v->data_dev->bdev) ||
1230 ti->error = "Invalid data device block size";
1234 v->data_dev_block_bits = __ffs(num);
1236 if (sscanf(argv[4], "%u%c", &num, &dummy) != 1 ||
1237 !num || (num & (num - 1)) ||
1238 num < bdev_logical_block_size(v->hash_dev->bdev) ||
1240 ti->error = "Invalid hash device block size";
1244 v->hash_dev_block_bits = __ffs(num);
1246 if (sscanf(argv[5], "%llu%c", &num_ll, &dummy) != 1 ||
1247 (sector_t)(num_ll << (v->data_dev_block_bits - SECTOR_SHIFT))
1248 >> (v->data_dev_block_bits - SECTOR_SHIFT) != num_ll) {
1249 ti->error = "Invalid data blocks";
1253 v->data_blocks = num_ll;
1255 if (ti->len > (v->data_blocks << (v->data_dev_block_bits - SECTOR_SHIFT))) {
1256 ti->error = "Data device is too small";
1261 if (sscanf(argv[6], "%llu%c", &num_ll, &dummy) != 1 ||
1262 (sector_t)(num_ll << (v->hash_dev_block_bits - SECTOR_SHIFT))
1263 >> (v->hash_dev_block_bits - SECTOR_SHIFT) != num_ll) {
1264 ti->error = "Invalid hash start";
1268 v->hash_start = num_ll;
1270 v->alg_name = kstrdup(argv[7], GFP_KERNEL);
1272 ti->error = "Cannot allocate algorithm name";
1277 v->tfm = crypto_alloc_ahash(v->alg_name, 0,
1278 v->use_tasklet ? CRYPTO_ALG_ASYNC : 0);
1279 if (IS_ERR(v->tfm)) {
1280 ti->error = "Cannot initialize hash function";
1281 r = PTR_ERR(v->tfm);
1287 * dm-verity performance can vary greatly depending on which hash
1288 * algorithm implementation is used. Help people debug performance
1289 * problems by logging the ->cra_driver_name.
1291 DMINFO("%s using implementation \"%s\"", v->alg_name,
1292 crypto_hash_alg_common(v->tfm)->base.cra_driver_name);
1294 v->digest_size = crypto_ahash_digestsize(v->tfm);
1295 if ((1 << v->hash_dev_block_bits) < v->digest_size * 2) {
1296 ti->error = "Digest size too big";
1300 v->ahash_reqsize = sizeof(struct ahash_request) +
1301 crypto_ahash_reqsize(v->tfm);
1303 v->root_digest = kmalloc(v->digest_size, GFP_KERNEL);
1304 if (!v->root_digest) {
1305 ti->error = "Cannot allocate root digest";
1309 if (strlen(argv[8]) != v->digest_size * 2 ||
1310 hex2bin(v->root_digest, argv[8], v->digest_size)) {
1311 ti->error = "Invalid root digest";
1315 root_hash_digest_to_validate = argv[8];
1317 if (strcmp(argv[9], "-")) {
1318 v->salt_size = strlen(argv[9]) / 2;
1319 v->salt = kmalloc(v->salt_size, GFP_KERNEL);
1321 ti->error = "Cannot allocate salt";
1325 if (strlen(argv[9]) != v->salt_size * 2 ||
1326 hex2bin(v->salt, argv[9], v->salt_size)) {
1327 ti->error = "Invalid salt";
1336 /* Optional parameters */
1340 r = verity_parse_opt_args(&as, v, &verify_args, false);
1345 /* Root hash signature is a optional parameter*/
1346 r = verity_verify_root_hash(root_hash_digest_to_validate,
1347 strlen(root_hash_digest_to_validate),
1349 verify_args.sig_size);
1351 ti->error = "Root hash verification failed";
1354 v->hash_per_block_bits =
1355 __fls((1 << v->hash_dev_block_bits) / v->digest_size);
1359 while (v->hash_per_block_bits * v->levels < 64 &&
1360 (unsigned long long)(v->data_blocks - 1) >>
1361 (v->hash_per_block_bits * v->levels))
1364 if (v->levels > DM_VERITY_MAX_LEVELS) {
1365 ti->error = "Too many tree levels";
1370 hash_position = v->hash_start;
1371 for (i = v->levels - 1; i >= 0; i--) {
1373 v->hash_level_block[i] = hash_position;
1374 s = (v->data_blocks + ((sector_t)1 << ((i + 1) * v->hash_per_block_bits)) - 1)
1375 >> ((i + 1) * v->hash_per_block_bits);
1376 if (hash_position + s < hash_position) {
1377 ti->error = "Hash device offset overflow";
1383 v->hash_blocks = hash_position;
1385 v->bufio = dm_bufio_client_create(v->hash_dev->bdev,
1386 1 << v->hash_dev_block_bits, 1, sizeof(struct buffer_aux),
1387 dm_bufio_alloc_callback, NULL,
1388 v->use_tasklet ? DM_BUFIO_CLIENT_NO_SLEEP : 0);
1389 if (IS_ERR(v->bufio)) {
1390 ti->error = "Cannot initialize dm-bufio";
1391 r = PTR_ERR(v->bufio);
1396 if (dm_bufio_get_device_size(v->bufio) < v->hash_blocks) {
1397 ti->error = "Hash device is too small";
1402 /* WQ_UNBOUND greatly improves performance when running on ramdisk */
1403 wq_flags = WQ_MEM_RECLAIM | WQ_UNBOUND;
1404 if (v->use_tasklet) {
1406 * Allow verify_wq to preempt softirq since verification in
1407 * tasklet will fall-back to using it for error handling
1408 * (or if the bufio cache doesn't have required hashes).
1410 wq_flags |= WQ_HIGHPRI;
1412 v->verify_wq = alloc_workqueue("kverityd", wq_flags, num_online_cpus());
1413 if (!v->verify_wq) {
1414 ti->error = "Cannot allocate workqueue";
1419 ti->per_io_data_size = sizeof(struct dm_verity_io) +
1420 v->ahash_reqsize + v->digest_size * 2;
1422 r = verity_fec_ctr(v);
1426 ti->per_io_data_size = roundup(ti->per_io_data_size,
1427 __alignof__(struct dm_verity_io));
1429 verity_verify_sig_opts_cleanup(&verify_args);
1435 verity_verify_sig_opts_cleanup(&verify_args);
1442 * Check whether a DM target is a verity target.
1444 bool dm_is_verity_target(struct dm_target *ti)
1446 return ti->type->module == THIS_MODULE;
1450 * Get the verity mode (error behavior) of a verity target.
1452 * Returns the verity mode of the target, or -EINVAL if 'ti' is not a verity
1455 int dm_verity_get_mode(struct dm_target *ti)
1457 struct dm_verity *v = ti->private;
1459 if (!dm_is_verity_target(ti))
1466 * Get the root digest of a verity target.
1468 * Returns a copy of the root digest, the caller is responsible for
1469 * freeing the memory of the digest.
1471 int dm_verity_get_root_digest(struct dm_target *ti, u8 **root_digest, unsigned int *digest_size)
1473 struct dm_verity *v = ti->private;
1475 if (!dm_is_verity_target(ti))
1478 *root_digest = kmemdup(v->root_digest, v->digest_size, GFP_KERNEL);
1479 if (*root_digest == NULL)
1482 *digest_size = v->digest_size;
1487 static struct target_type verity_target = {
1489 .features = DM_TARGET_IMMUTABLE,
1490 .version = {1, 9, 0},
1491 .module = THIS_MODULE,
1495 .status = verity_status,
1496 .prepare_ioctl = verity_prepare_ioctl,
1497 .iterate_devices = verity_iterate_devices,
1498 .io_hints = verity_io_hints,
1501 static int __init dm_verity_init(void)
1505 r = dm_register_target(&verity_target);
1507 DMERR("register failed %d", r);
1512 static void __exit dm_verity_exit(void)
1514 dm_unregister_target(&verity_target);
1517 module_init(dm_verity_init);
1518 module_exit(dm_verity_exit);
1523 MODULE_DESCRIPTION(DM_NAME " target for transparent disk integrity checking");
1524 MODULE_LICENSE("GPL");