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>
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 int 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;
54 unsigned int n_blocks;
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));
118 flush_kernel_vmap_range((void *)data, this_step);
119 sg_init_table(&sg, 1);
120 sg_set_page(&sg, vmalloc_to_page(data), this_step, offset_in_page(data));
121 ahash_request_set_crypt(req, &sg, NULL, this_step);
122 r = crypto_wait_req(crypto_ahash_update(req), wait);
133 * Wrapper for crypto_ahash_init, which handles verity salting.
135 static int verity_hash_init(struct dm_verity *v, struct ahash_request *req,
136 struct crypto_wait *wait)
140 ahash_request_set_tfm(req, v->tfm);
141 ahash_request_set_callback(req, CRYPTO_TFM_REQ_MAY_SLEEP |
142 CRYPTO_TFM_REQ_MAY_BACKLOG,
143 crypto_req_done, (void *)wait);
144 crypto_init_wait(wait);
146 r = crypto_wait_req(crypto_ahash_init(req), wait);
148 if (unlikely(r < 0)) {
149 DMERR("crypto_ahash_init failed: %d", r);
153 if (likely(v->salt_size && (v->version >= 1)))
154 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
159 static int verity_hash_final(struct dm_verity *v, struct ahash_request *req,
160 u8 *digest, struct crypto_wait *wait)
164 if (unlikely(v->salt_size && (!v->version))) {
165 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
168 DMERR("%s failed updating salt: %d", __func__, r);
173 ahash_request_set_crypt(req, NULL, digest, 0);
174 r = crypto_wait_req(crypto_ahash_final(req), wait);
179 int verity_hash(struct dm_verity *v, struct ahash_request *req,
180 const u8 *data, size_t len, u8 *digest)
183 struct crypto_wait wait;
185 r = verity_hash_init(v, req, &wait);
189 r = verity_hash_update(v, req, data, len, &wait);
193 r = verity_hash_final(v, req, digest, &wait);
199 static void verity_hash_at_level(struct dm_verity *v, sector_t block, int level,
200 sector_t *hash_block, unsigned int *offset)
202 sector_t position = verity_position_at_level(v, block, level);
205 *hash_block = v->hash_level_block[level] + (position >> v->hash_per_block_bits);
210 idx = position & ((1 << v->hash_per_block_bits) - 1);
212 *offset = idx * v->digest_size;
214 *offset = idx << (v->hash_dev_block_bits - v->hash_per_block_bits);
218 * Handle verification errors.
220 static int verity_handle_err(struct dm_verity *v, enum verity_block_type type,
221 unsigned long long block)
223 char verity_env[DM_VERITY_ENV_LENGTH];
224 char *envp[] = { verity_env, NULL };
225 const char *type_str = "";
226 struct mapped_device *md = dm_table_get_md(v->ti->table);
228 /* Corruption should be visible in device status in all modes */
229 v->hash_failed = true;
231 if (v->corrupted_errs >= DM_VERITY_MAX_CORRUPTED_ERRS)
237 case DM_VERITY_BLOCK_TYPE_DATA:
240 case DM_VERITY_BLOCK_TYPE_METADATA:
241 type_str = "metadata";
247 DMERR_LIMIT("%s: %s block %llu is corrupted", v->data_dev->name,
250 if (v->corrupted_errs == DM_VERITY_MAX_CORRUPTED_ERRS)
251 DMERR("%s: reached maximum errors", v->data_dev->name);
253 snprintf(verity_env, DM_VERITY_ENV_LENGTH, "%s=%d,%llu",
254 DM_VERITY_ENV_VAR_NAME, type, block);
256 kobject_uevent_env(&disk_to_dev(dm_disk(md))->kobj, KOBJ_CHANGE, envp);
259 if (v->mode == DM_VERITY_MODE_LOGGING)
262 if (v->mode == DM_VERITY_MODE_RESTART)
263 kernel_restart("dm-verity device corrupted");
265 if (v->mode == DM_VERITY_MODE_PANIC)
266 panic("dm-verity device corrupted");
272 * Verify hash of a metadata block pertaining to the specified data block
273 * ("block" argument) at a specified level ("level" argument).
275 * On successful return, verity_io_want_digest(v, io) contains the hash value
276 * for a lower tree level or for the data block (if we're at the lowest level).
278 * If "skip_unverified" is true, unverified buffer is skipped and 1 is returned.
279 * If "skip_unverified" is false, unverified buffer is hashed and verified
280 * against current value of verity_io_want_digest(v, io).
282 static int verity_verify_level(struct dm_verity *v, struct dm_verity_io *io,
283 sector_t block, int level, bool skip_unverified,
286 struct dm_buffer *buf;
287 struct buffer_aux *aux;
293 verity_hash_at_level(v, block, level, &hash_block, &offset);
295 if (static_branch_unlikely(&use_tasklet_enabled) && io->in_tasklet) {
296 data = dm_bufio_get(v->bufio, hash_block, &buf);
299 * In tasklet and the hash was not in the bufio cache.
300 * Return early and resume execution from a work-queue
301 * to read the hash from disk.
306 data = dm_bufio_read(v->bufio, hash_block, &buf);
309 return PTR_ERR(data);
311 aux = dm_bufio_get_aux_data(buf);
313 if (!aux->hash_verified) {
314 if (skip_unverified) {
319 r = verity_hash(v, verity_io_hash_req(v, io),
320 data, 1 << v->hash_dev_block_bits,
321 verity_io_real_digest(v, io));
325 if (likely(memcmp(verity_io_real_digest(v, io), want_digest,
326 v->digest_size) == 0))
327 aux->hash_verified = 1;
328 else if (static_branch_unlikely(&use_tasklet_enabled) &&
331 * Error handling code (FEC included) cannot be run in a
332 * tasklet since it may sleep, so fallback to work-queue.
336 } else if (verity_fec_decode(v, io, DM_VERITY_BLOCK_TYPE_METADATA,
337 hash_block, data, NULL) == 0)
338 aux->hash_verified = 1;
339 else if (verity_handle_err(v,
340 DM_VERITY_BLOCK_TYPE_METADATA,
348 memcpy(want_digest, data, v->digest_size);
352 dm_bufio_release(buf);
357 * Find a hash for a given block, write it to digest and verify the integrity
358 * of the hash tree if necessary.
360 int verity_hash_for_block(struct dm_verity *v, struct dm_verity_io *io,
361 sector_t block, u8 *digest, bool *is_zero)
365 if (likely(v->levels)) {
367 * First, we try to get the requested hash for
368 * the current block. If the hash block itself is
369 * verified, zero is returned. If it isn't, this
370 * function returns 1 and we fall back to whole
371 * chain verification.
373 r = verity_verify_level(v, io, block, 0, true, digest);
378 memcpy(digest, v->root_digest, v->digest_size);
380 for (i = v->levels - 1; i >= 0; i--) {
381 r = verity_verify_level(v, io, block, i, false, digest);
386 if (!r && v->zero_digest)
387 *is_zero = !memcmp(v->zero_digest, digest, v->digest_size);
395 * Calculates the digest for the given bio
397 static int verity_for_io_block(struct dm_verity *v, struct dm_verity_io *io,
398 struct bvec_iter *iter, struct crypto_wait *wait)
400 unsigned int todo = 1 << v->data_dev_block_bits;
401 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
402 struct scatterlist sg;
403 struct ahash_request *req = verity_io_hash_req(v, io);
408 struct bio_vec bv = bio_iter_iovec(bio, *iter);
410 sg_init_table(&sg, 1);
414 if (likely(len >= todo))
417 * Operating on a single page at a time looks suboptimal
418 * until you consider the typical block size is 4,096B.
419 * Going through this loops twice should be very rare.
421 sg_set_page(&sg, bv.bv_page, len, bv.bv_offset);
422 ahash_request_set_crypt(req, &sg, NULL, len);
423 r = crypto_wait_req(crypto_ahash_update(req), wait);
425 if (unlikely(r < 0)) {
426 DMERR("%s crypto op failed: %d", __func__, r);
430 bio_advance_iter(bio, iter, len);
438 * Calls function process for 1 << v->data_dev_block_bits bytes in the bio_vec
439 * starting from iter.
441 int verity_for_bv_block(struct dm_verity *v, struct dm_verity_io *io,
442 struct bvec_iter *iter,
443 int (*process)(struct dm_verity *v,
444 struct dm_verity_io *io, u8 *data,
447 unsigned int todo = 1 << v->data_dev_block_bits;
448 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
454 struct bio_vec bv = bio_iter_iovec(bio, *iter);
456 page = bvec_kmap_local(&bv);
459 if (likely(len >= todo))
462 r = process(v, io, page, len);
468 bio_advance_iter(bio, iter, len);
475 static int verity_bv_zero(struct dm_verity *v, struct dm_verity_io *io,
476 u8 *data, size_t len)
478 memset(data, 0, len);
483 * Moves the bio iter one data block forward.
485 static inline void verity_bv_skip_block(struct dm_verity *v,
486 struct dm_verity_io *io,
487 struct bvec_iter *iter)
489 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
491 bio_advance_iter(bio, iter, 1 << v->data_dev_block_bits);
495 * Verify one "dm_verity_io" structure.
497 static int verity_verify_io(struct dm_verity_io *io)
500 struct dm_verity *v = io->v;
501 #if defined(CONFIG_DM_VERITY_FEC)
502 struct bvec_iter start;
504 struct bvec_iter iter_copy;
505 struct bvec_iter *iter;
506 struct crypto_wait wait;
507 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
510 if (static_branch_unlikely(&use_tasklet_enabled) && io->in_tasklet) {
512 * Copy the iterator in case we need to restart
513 * verification in a work-queue.
515 iter_copy = io->iter;
520 for (b = 0; b < io->n_blocks; b++) {
522 sector_t cur_block = io->block + b;
523 struct ahash_request *req = verity_io_hash_req(v, io);
525 if (v->validated_blocks &&
526 likely(test_bit(cur_block, v->validated_blocks))) {
527 verity_bv_skip_block(v, io, iter);
531 r = verity_hash_for_block(v, io, cur_block,
532 verity_io_want_digest(v, io),
539 * If we expect a zero block, don't validate, just
542 r = verity_for_bv_block(v, io, iter,
550 r = verity_hash_init(v, req, &wait);
554 #if defined(CONFIG_DM_VERITY_FEC)
555 if (verity_fec_is_enabled(v))
558 r = verity_for_io_block(v, io, iter, &wait);
562 r = verity_hash_final(v, req, verity_io_real_digest(v, io),
567 if (likely(memcmp(verity_io_real_digest(v, io),
568 verity_io_want_digest(v, io), v->digest_size) == 0)) {
569 if (v->validated_blocks)
570 set_bit(cur_block, v->validated_blocks);
572 } else if (static_branch_unlikely(&use_tasklet_enabled) &&
575 * Error handling code (FEC included) cannot be run in a
576 * tasklet since it may sleep, so fallback to work-queue.
579 #if defined(CONFIG_DM_VERITY_FEC)
580 } else if (verity_fec_decode(v, io, DM_VERITY_BLOCK_TYPE_DATA,
581 cur_block, NULL, &start) == 0) {
585 if (bio->bi_status) {
587 * Error correction failed; Just return error
591 if (verity_handle_err(v, DM_VERITY_BLOCK_TYPE_DATA,
601 * Skip verity work in response to I/O error when system is shutting down.
603 static inline bool verity_is_system_shutting_down(void)
605 return system_state == SYSTEM_HALT || system_state == SYSTEM_POWER_OFF
606 || system_state == SYSTEM_RESTART;
610 * End one "io" structure with a given error.
612 static void verity_finish_io(struct dm_verity_io *io, blk_status_t status)
614 struct dm_verity *v = io->v;
615 struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
617 bio->bi_end_io = io->orig_bi_end_io;
618 bio->bi_status = status;
620 if (!static_branch_unlikely(&use_tasklet_enabled) || !io->in_tasklet)
621 verity_fec_finish_io(io);
626 static void verity_work(struct work_struct *w)
628 struct dm_verity_io *io = container_of(w, struct dm_verity_io, work);
630 io->in_tasklet = false;
632 verity_fec_init_io(io);
633 verity_finish_io(io, errno_to_blk_status(verity_verify_io(io)));
636 static void verity_tasklet(unsigned long data)
638 struct dm_verity_io *io = (struct dm_verity_io *)data;
641 io->in_tasklet = true;
642 err = verity_verify_io(io);
643 if (err == -EAGAIN) {
644 /* fallback to retrying with work-queue */
645 INIT_WORK(&io->work, verity_work);
646 queue_work(io->v->verify_wq, &io->work);
650 verity_finish_io(io, errno_to_blk_status(err));
653 static void verity_end_io(struct bio *bio)
655 struct dm_verity_io *io = bio->bi_private;
657 if (bio->bi_status &&
658 (!verity_fec_is_enabled(io->v) || verity_is_system_shutting_down())) {
659 verity_finish_io(io, bio->bi_status);
663 if (static_branch_unlikely(&use_tasklet_enabled) && io->v->use_tasklet) {
664 tasklet_init(&io->tasklet, verity_tasklet, (unsigned long)io);
665 tasklet_schedule(&io->tasklet);
667 INIT_WORK(&io->work, verity_work);
668 queue_work(io->v->verify_wq, &io->work);
673 * Prefetch buffers for the specified io.
674 * The root buffer is not prefetched, it is assumed that it will be cached
677 static void verity_prefetch_io(struct work_struct *work)
679 struct dm_verity_prefetch_work *pw =
680 container_of(work, struct dm_verity_prefetch_work, work);
681 struct dm_verity *v = pw->v;
684 for (i = v->levels - 2; i >= 0; i--) {
685 sector_t hash_block_start;
686 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);
692 unsigned int cluster = READ_ONCE(dm_verity_prefetch_cluster);
694 cluster >>= v->data_dev_block_bits;
695 if (unlikely(!cluster))
696 goto no_prefetch_cluster;
698 if (unlikely(cluster & (cluster - 1)))
699 cluster = 1 << __fls(cluster);
701 hash_block_start &= ~(sector_t)(cluster - 1);
702 hash_block_end |= cluster - 1;
703 if (unlikely(hash_block_end >= v->hash_blocks))
704 hash_block_end = v->hash_blocks - 1;
707 dm_bufio_prefetch(v->bufio, hash_block_start,
708 hash_block_end - hash_block_start + 1);
714 static void verity_submit_prefetch(struct dm_verity *v, struct dm_verity_io *io)
716 sector_t block = io->block;
717 unsigned int n_blocks = io->n_blocks;
718 struct dm_verity_prefetch_work *pw;
720 if (v->validated_blocks) {
721 while (n_blocks && test_bit(block, v->validated_blocks)) {
725 while (n_blocks && test_bit(block + n_blocks - 1,
726 v->validated_blocks))
732 pw = kmalloc(sizeof(struct dm_verity_prefetch_work),
733 GFP_NOIO | __GFP_NORETRY | __GFP_NOMEMALLOC | __GFP_NOWARN);
738 INIT_WORK(&pw->work, verity_prefetch_io);
741 pw->n_blocks = n_blocks;
742 queue_work(v->verify_wq, &pw->work);
746 * Bio map function. It allocates dm_verity_io structure and bio vector and
747 * fills them. Then it issues prefetches and the I/O.
749 static int verity_map(struct dm_target *ti, struct bio *bio)
751 struct dm_verity *v = ti->private;
752 struct dm_verity_io *io;
754 bio_set_dev(bio, v->data_dev->bdev);
755 bio->bi_iter.bi_sector = verity_map_sector(v, bio->bi_iter.bi_sector);
757 if (((unsigned int)bio->bi_iter.bi_sector | bio_sectors(bio)) &
758 ((1 << (v->data_dev_block_bits - SECTOR_SHIFT)) - 1)) {
759 DMERR_LIMIT("unaligned io");
760 return DM_MAPIO_KILL;
763 if (bio_end_sector(bio) >>
764 (v->data_dev_block_bits - SECTOR_SHIFT) > v->data_blocks) {
765 DMERR_LIMIT("io out of range");
766 return DM_MAPIO_KILL;
769 if (bio_data_dir(bio) == WRITE)
770 return DM_MAPIO_KILL;
772 io = dm_per_bio_data(bio, ti->per_io_data_size);
774 io->orig_bi_end_io = bio->bi_end_io;
775 io->block = bio->bi_iter.bi_sector >> (v->data_dev_block_bits - SECTOR_SHIFT);
776 io->n_blocks = bio->bi_iter.bi_size >> v->data_dev_block_bits;
778 bio->bi_end_io = verity_end_io;
779 bio->bi_private = io;
780 io->iter = bio->bi_iter;
782 verity_submit_prefetch(v, io);
784 submit_bio_noacct(bio);
786 return DM_MAPIO_SUBMITTED;
790 * Status: V (valid) or C (corruption found)
792 static void verity_status(struct dm_target *ti, status_type_t type,
793 unsigned int status_flags, char *result, unsigned int maxlen)
795 struct dm_verity *v = ti->private;
796 unsigned int args = 0;
801 case STATUSTYPE_INFO:
802 DMEMIT("%c", v->hash_failed ? 'C' : 'V');
804 case STATUSTYPE_TABLE:
805 DMEMIT("%u %s %s %u %u %llu %llu %s ",
809 1 << v->data_dev_block_bits,
810 1 << v->hash_dev_block_bits,
811 (unsigned long long)v->data_blocks,
812 (unsigned long long)v->hash_start,
815 for (x = 0; x < v->digest_size; x++)
816 DMEMIT("%02x", v->root_digest[x]);
821 for (x = 0; x < v->salt_size; x++)
822 DMEMIT("%02x", v->salt[x]);
823 if (v->mode != DM_VERITY_MODE_EIO)
825 if (verity_fec_is_enabled(v))
826 args += DM_VERITY_OPTS_FEC;
829 if (v->validated_blocks)
833 if (v->signature_key_desc)
834 args += DM_VERITY_ROOT_HASH_VERIFICATION_OPTS;
838 if (v->mode != DM_VERITY_MODE_EIO) {
841 case DM_VERITY_MODE_LOGGING:
842 DMEMIT(DM_VERITY_OPT_LOGGING);
844 case DM_VERITY_MODE_RESTART:
845 DMEMIT(DM_VERITY_OPT_RESTART);
847 case DM_VERITY_MODE_PANIC:
848 DMEMIT(DM_VERITY_OPT_PANIC);
855 DMEMIT(" " DM_VERITY_OPT_IGN_ZEROES);
856 if (v->validated_blocks)
857 DMEMIT(" " DM_VERITY_OPT_AT_MOST_ONCE);
859 DMEMIT(" " DM_VERITY_OPT_TASKLET_VERIFY);
860 sz = verity_fec_status_table(v, sz, result, maxlen);
861 if (v->signature_key_desc)
862 DMEMIT(" " DM_VERITY_ROOT_HASH_VERIFICATION_OPT_SIG_KEY
863 " %s", v->signature_key_desc);
867 DMEMIT_TARGET_NAME_VERSION(ti->type);
868 DMEMIT(",hash_failed=%c", v->hash_failed ? 'C' : 'V');
869 DMEMIT(",verity_version=%u", v->version);
870 DMEMIT(",data_device_name=%s", v->data_dev->name);
871 DMEMIT(",hash_device_name=%s", v->hash_dev->name);
872 DMEMIT(",verity_algorithm=%s", v->alg_name);
874 DMEMIT(",root_digest=");
875 for (x = 0; x < v->digest_size; x++)
876 DMEMIT("%02x", v->root_digest[x]);
882 for (x = 0; x < v->salt_size; x++)
883 DMEMIT("%02x", v->salt[x]);
885 DMEMIT(",ignore_zero_blocks=%c", v->zero_digest ? 'y' : 'n');
886 DMEMIT(",check_at_most_once=%c", v->validated_blocks ? 'y' : 'n');
887 if (v->signature_key_desc)
888 DMEMIT(",root_hash_sig_key_desc=%s", v->signature_key_desc);
890 if (v->mode != DM_VERITY_MODE_EIO) {
891 DMEMIT(",verity_mode=");
893 case DM_VERITY_MODE_LOGGING:
894 DMEMIT(DM_VERITY_OPT_LOGGING);
896 case DM_VERITY_MODE_RESTART:
897 DMEMIT(DM_VERITY_OPT_RESTART);
899 case DM_VERITY_MODE_PANIC:
900 DMEMIT(DM_VERITY_OPT_PANIC);
911 static int verity_prepare_ioctl(struct dm_target *ti, struct block_device **bdev)
913 struct dm_verity *v = ti->private;
915 *bdev = v->data_dev->bdev;
917 if (v->data_start || ti->len != bdev_nr_sectors(v->data_dev->bdev))
922 static int verity_iterate_devices(struct dm_target *ti,
923 iterate_devices_callout_fn fn, void *data)
925 struct dm_verity *v = ti->private;
927 return fn(ti, v->data_dev, v->data_start, ti->len, data);
930 static void verity_io_hints(struct dm_target *ti, struct queue_limits *limits)
932 struct dm_verity *v = ti->private;
934 if (limits->logical_block_size < 1 << v->data_dev_block_bits)
935 limits->logical_block_size = 1 << v->data_dev_block_bits;
937 if (limits->physical_block_size < 1 << v->data_dev_block_bits)
938 limits->physical_block_size = 1 << v->data_dev_block_bits;
940 blk_limits_io_min(limits, limits->logical_block_size);
943 static void verity_dtr(struct dm_target *ti)
945 struct dm_verity *v = ti->private;
948 destroy_workqueue(v->verify_wq);
951 dm_bufio_client_destroy(v->bufio);
953 kvfree(v->validated_blocks);
955 kfree(v->root_digest);
956 kfree(v->zero_digest);
959 crypto_free_ahash(v->tfm);
964 dm_put_device(ti, v->hash_dev);
967 dm_put_device(ti, v->data_dev);
971 kfree(v->signature_key_desc);
974 static_branch_dec(&use_tasklet_enabled);
979 static int verity_alloc_most_once(struct dm_verity *v)
981 struct dm_target *ti = v->ti;
983 /* the bitset can only handle INT_MAX blocks */
984 if (v->data_blocks > INT_MAX) {
985 ti->error = "device too large to use check_at_most_once";
989 v->validated_blocks = kvcalloc(BITS_TO_LONGS(v->data_blocks),
990 sizeof(unsigned long),
992 if (!v->validated_blocks) {
993 ti->error = "failed to allocate bitset for check_at_most_once";
1000 static int verity_alloc_zero_digest(struct dm_verity *v)
1003 struct ahash_request *req;
1006 v->zero_digest = kmalloc(v->digest_size, GFP_KERNEL);
1008 if (!v->zero_digest)
1011 req = kmalloc(v->ahash_reqsize, GFP_KERNEL);
1014 return r; /* verity_dtr will free zero_digest */
1016 zero_data = kzalloc(1 << v->data_dev_block_bits, GFP_KERNEL);
1021 r = verity_hash(v, req, zero_data, 1 << v->data_dev_block_bits,
1031 static inline bool verity_is_verity_mode(const char *arg_name)
1033 return (!strcasecmp(arg_name, DM_VERITY_OPT_LOGGING) ||
1034 !strcasecmp(arg_name, DM_VERITY_OPT_RESTART) ||
1035 !strcasecmp(arg_name, DM_VERITY_OPT_PANIC));
1038 static int verity_parse_verity_mode(struct dm_verity *v, const char *arg_name)
1043 if (!strcasecmp(arg_name, DM_VERITY_OPT_LOGGING))
1044 v->mode = DM_VERITY_MODE_LOGGING;
1045 else if (!strcasecmp(arg_name, DM_VERITY_OPT_RESTART))
1046 v->mode = DM_VERITY_MODE_RESTART;
1047 else if (!strcasecmp(arg_name, DM_VERITY_OPT_PANIC))
1048 v->mode = DM_VERITY_MODE_PANIC;
1053 static int verity_parse_opt_args(struct dm_arg_set *as, struct dm_verity *v,
1054 struct dm_verity_sig_opts *verify_args,
1055 bool only_modifier_opts)
1059 struct dm_target *ti = v->ti;
1060 const char *arg_name;
1062 static const struct dm_arg _args[] = {
1063 {0, DM_VERITY_OPTS_MAX, "Invalid number of feature args"},
1066 r = dm_read_arg_group(_args, as, &argc, &ti->error);
1074 arg_name = dm_shift_arg(as);
1077 if (verity_is_verity_mode(arg_name)) {
1078 if (only_modifier_opts)
1080 r = verity_parse_verity_mode(v, arg_name);
1082 ti->error = "Conflicting error handling parameters";
1087 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_IGN_ZEROES)) {
1088 if (only_modifier_opts)
1090 r = verity_alloc_zero_digest(v);
1092 ti->error = "Cannot allocate zero digest";
1097 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_AT_MOST_ONCE)) {
1098 if (only_modifier_opts)
1100 r = verity_alloc_most_once(v);
1105 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_TASKLET_VERIFY)) {
1106 v->use_tasklet = true;
1107 static_branch_inc(&use_tasklet_enabled);
1110 } else if (verity_is_fec_opt_arg(arg_name)) {
1111 if (only_modifier_opts)
1113 r = verity_fec_parse_opt_args(as, v, &argc, arg_name);
1118 } else if (verity_verify_is_sig_opt_arg(arg_name)) {
1119 if (only_modifier_opts)
1121 r = verity_verify_sig_parse_opt_args(as, v,
1128 } else if (only_modifier_opts) {
1130 * Ignore unrecognized opt, could easily be an extra
1131 * argument to an option whose parsing was skipped.
1132 * Normal parsing (@only_modifier_opts=false) will
1133 * properly parse all options (and their extra args).
1138 DMERR("Unrecognized verity feature request: %s", arg_name);
1139 ti->error = "Unrecognized verity feature request";
1141 } while (argc && !r);
1147 * Target parameters:
1148 * <version> The current format is version 1.
1149 * Vsn 0 is compatible with original Chromium OS releases.
1154 * <the number of data blocks>
1155 * <hash start block>
1158 * <salt> Hex string or "-" if no salt.
1160 static int verity_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1162 struct dm_verity *v;
1163 struct dm_verity_sig_opts verify_args = {0};
1164 struct dm_arg_set as;
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--) {
1374 v->hash_level_block[i] = hash_position;
1375 s = (v->data_blocks + ((sector_t)1 << ((i + 1) * v->hash_per_block_bits)) - 1)
1376 >> ((i + 1) * v->hash_per_block_bits);
1377 if (hash_position + s < hash_position) {
1378 ti->error = "Hash device offset overflow";
1384 v->hash_blocks = hash_position;
1386 v->bufio = dm_bufio_client_create(v->hash_dev->bdev,
1387 1 << v->hash_dev_block_bits, 1, sizeof(struct buffer_aux),
1388 dm_bufio_alloc_callback, NULL,
1389 v->use_tasklet ? DM_BUFIO_CLIENT_NO_SLEEP : 0);
1390 if (IS_ERR(v->bufio)) {
1391 ti->error = "Cannot initialize dm-bufio";
1392 r = PTR_ERR(v->bufio);
1397 if (dm_bufio_get_device_size(v->bufio) < v->hash_blocks) {
1398 ti->error = "Hash device is too small";
1404 * Using WQ_HIGHPRI improves throughput and completion latency by
1405 * reducing wait times when reading from a dm-verity device.
1407 * Also as required for the "try_verify_in_tasklet" feature: WQ_HIGHPRI
1408 * allows verify_wq to preempt softirq since verification in tasklet
1409 * will fall-back to using it for error handling (or if the bufio cache
1410 * doesn't have required hashes).
1412 v->verify_wq = alloc_workqueue("kverityd", WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
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);
1520 MODULE_AUTHOR("Mikulas Patocka <mpatocka@redhat.com>");
1521 MODULE_AUTHOR("Mandeep Baines <msb@chromium.org>");
1522 MODULE_AUTHOR("Will Drewry <wad@chromium.org>");
1523 MODULE_DESCRIPTION(DM_NAME " target for transparent disk integrity checking");
1524 MODULE_LICENSE("GPL");