2 * Copyright (C) 2015 Google, Inc.
4 * This software is licensed under the terms of the GNU General Public
5 * License version 2, as published by the Free Software Foundation, and
6 * may be copied, distributed, and modified under those terms.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
15 #include <linux/buffer_head.h>
16 #include <linux/debugfs.h>
17 #include <linux/delay.h>
18 #include <linux/device.h>
19 #include <linux/device-mapper.h>
20 #include <linux/errno.h>
22 #include <linux/fcntl.h>
23 #include <linux/init.h>
24 #include <linux/kernel.h>
25 #include <linux/key.h>
26 #include <linux/module.h>
27 #include <linux/mount.h>
28 #include <linux/namei.h>
30 #include <linux/reboot.h>
31 #include <linux/string.h>
32 #include <linux/vmalloc.h>
34 #include <asm/setup.h>
35 #include <crypto/hash.h>
36 #include <crypto/public_key.h>
37 #include <crypto/sha.h>
38 #include <keys/asymmetric-type.h>
39 #include <keys/system_keyring.h>
41 #include "dm-verity.h"
42 #include "dm-android-verity.h"
44 static char verifiedbootstate[VERITY_COMMANDLINE_PARAM_LENGTH];
45 static char veritymode[VERITY_COMMANDLINE_PARAM_LENGTH];
46 static char veritykeyid[VERITY_DEFAULT_KEY_ID_LENGTH];
47 static char buildvariant[BUILD_VARIANT];
49 static bool target_added;
50 static bool verity_enabled = true;
51 struct dentry *debug_dir;
52 static int android_verity_ctr(struct dm_target *ti, unsigned argc, char **argv);
54 static struct target_type android_verity_target = {
55 .name = "android-verity",
57 .module = THIS_MODULE,
58 .ctr = android_verity_ctr,
61 .status = verity_status,
62 .ioctl = verity_ioctl,
63 .merge = verity_merge,
64 .iterate_devices = verity_iterate_devices,
65 .io_hints = verity_io_hints,
68 static int __init verified_boot_state_param(char *line)
70 strlcpy(verifiedbootstate, line, sizeof(verifiedbootstate));
74 __setup("androidboot.verifiedbootstate=", verified_boot_state_param);
76 static int __init verity_mode_param(char *line)
78 strlcpy(veritymode, line, sizeof(veritymode));
82 __setup("androidboot.veritymode=", verity_mode_param);
84 static int __init verity_keyid_param(char *line)
86 strlcpy(veritykeyid, line, sizeof(veritykeyid));
90 __setup("veritykeyid=", verity_keyid_param);
92 static int __init verity_buildvariant(char *line)
94 strlcpy(buildvariant, line, sizeof(buildvariant));
98 __setup("buildvariant=", verity_buildvariant);
100 static inline bool default_verity_key_id(void)
102 return veritykeyid[0] != '\0';
105 static inline bool is_eng(void)
107 static const char typeeng[] = "eng";
109 return !strncmp(buildvariant, typeeng, sizeof(typeeng));
112 static inline bool is_userdebug(void)
114 static const char typeuserdebug[] = "userdebug";
116 return !strncmp(buildvariant, typeuserdebug, sizeof(typeuserdebug));
120 static int table_extract_mpi_array(struct public_key_signature *pks,
121 const void *data, size_t len)
123 MPI mpi = mpi_read_raw_data(data, len);
126 DMERR("Error while allocating mpi array");
135 static struct public_key_signature *table_make_digest(
138 unsigned long table_len)
140 struct public_key_signature *pks = NULL;
141 struct crypto_shash *tfm;
142 struct shash_desc *desc;
143 size_t digest_size, desc_size;
146 /* Allocate the hashing algorithm we're going to need and find out how
147 * big the hash operational data will be.
149 tfm = crypto_alloc_shash(hash_algo_name[hash], 0, 0);
151 return ERR_CAST(tfm);
153 desc_size = crypto_shash_descsize(tfm) + sizeof(*desc);
154 digest_size = crypto_shash_digestsize(tfm);
156 /* We allocate the hash operational data storage on the end of out
157 * context data and the digest output buffer on the end of that.
160 pks = kzalloc(digest_size + sizeof(*pks) + desc_size, GFP_KERNEL);
164 pks->pkey_hash_algo = hash;
165 pks->digest = (u8 *)pks + sizeof(*pks) + desc_size;
166 pks->digest_size = digest_size;
168 desc = (struct shash_desc *)(pks + 1);
170 desc->flags = CRYPTO_TFM_REQ_MAY_SLEEP;
172 ret = crypto_shash_init(desc);
176 ret = crypto_shash_finup(desc, table, table_len, pks->digest);
180 crypto_free_shash(tfm);
185 crypto_free_shash(tfm);
189 static int read_block_dev(struct bio_read *payload, struct block_device *bdev,
190 sector_t offset, int length)
195 payload->number_of_pages = DIV_ROUND_UP(length, PAGE_SIZE);
197 bio = bio_alloc(GFP_KERNEL, payload->number_of_pages);
199 DMERR("Error while allocating bio");
204 bio->bi_iter.bi_sector = offset;
206 payload->page_io = kzalloc(sizeof(struct page *) *
207 payload->number_of_pages, GFP_KERNEL);
208 if (!payload->page_io) {
209 DMERR("page_io array alloc failed");
214 for (i = 0; i < payload->number_of_pages; i++) {
215 payload->page_io[i] = alloc_page(GFP_KERNEL);
216 if (!payload->page_io[i]) {
217 DMERR("alloc_page failed");
221 if (!bio_add_page(bio, payload->page_io[i], PAGE_SIZE, 0)) {
222 DMERR("bio_add_page error");
228 if (!submit_bio_wait(READ, bio))
231 DMERR("bio read failed");
235 for (i = 0; i < payload->number_of_pages; i++)
236 if (payload->page_io[i])
237 __free_page(payload->page_io[i]);
238 kfree(payload->page_io);
244 static inline u64 fec_div_round_up(u64 x, u64 y)
248 return div64_u64_rem(x, y, &remainder) +
249 (remainder > 0 ? 1 : 0);
252 static inline void populate_fec_metadata(struct fec_header *header,
253 struct fec_ecc_metadata *ecc)
255 ecc->blocks = fec_div_round_up(le64_to_cpu(header->inp_size),
257 ecc->roots = le32_to_cpu(header->roots);
258 ecc->start = le64_to_cpu(header->inp_size);
261 static inline int validate_fec_header(struct fec_header *header, u64 offset)
263 /* move offset to make the sanity check work for backup header
265 offset -= offset % FEC_BLOCK_SIZE;
266 if (le32_to_cpu(header->magic) != FEC_MAGIC ||
267 le32_to_cpu(header->version) != FEC_VERSION ||
268 le32_to_cpu(header->size) != sizeof(struct fec_header) ||
269 le32_to_cpu(header->roots) == 0 ||
270 le32_to_cpu(header->roots) >= FEC_RSM ||
271 offset < le32_to_cpu(header->fec_size) ||
272 offset - le32_to_cpu(header->fec_size) !=
273 le64_to_cpu(header->inp_size))
279 static int extract_fec_header(dev_t dev, struct fec_header *fec,
280 struct fec_ecc_metadata *ecc)
283 struct bio_read payload;
285 struct block_device *bdev;
287 bdev = blkdev_get_by_dev(dev, FMODE_READ, NULL);
289 if (IS_ERR_OR_NULL(bdev)) {
290 DMERR("bdev get error");
291 return PTR_ERR(bdev);
294 device_size = i_size_read(bdev->bd_inode);
296 /* fec metadata size is a power of 2 and PAGE_SIZE
297 * is a power of 2 as well.
299 BUG_ON(FEC_BLOCK_SIZE > PAGE_SIZE);
300 /* 512 byte sector alignment */
301 BUG_ON(((device_size - FEC_BLOCK_SIZE) % (1 << SECTOR_SHIFT)) != 0);
303 err = read_block_dev(&payload, bdev, (device_size -
304 FEC_BLOCK_SIZE) / (1 << SECTOR_SHIFT), FEC_BLOCK_SIZE);
306 DMERR("Error while reading verity metadata");
310 BUG_ON(sizeof(struct fec_header) > PAGE_SIZE);
311 memcpy(fec, page_address(payload.page_io[0]),
315 if (validate_fec_header(fec, device_size - FEC_BLOCK_SIZE)) {
316 /* Try the backup header */
317 memcpy(fec, page_address(payload.page_io[0]) + FEC_BLOCK_SIZE
320 if (validate_fec_header(fec, device_size -
321 sizeof(struct fec_header)))
326 populate_fec_metadata(fec, ecc);
328 for (i = 0; i < payload.number_of_pages; i++)
329 __free_page(payload.page_io[i]);
330 kfree(payload.page_io);
333 blkdev_put(bdev, FMODE_READ);
336 static void find_metadata_offset(struct fec_header *fec,
337 struct block_device *bdev, u64 *metadata_offset)
341 device_size = i_size_read(bdev->bd_inode);
343 if (le32_to_cpu(fec->magic) == FEC_MAGIC)
344 *metadata_offset = le64_to_cpu(fec->inp_size) -
345 VERITY_METADATA_SIZE;
347 *metadata_offset = device_size - VERITY_METADATA_SIZE;
350 static int find_size(dev_t dev, u64 *device_size)
352 struct block_device *bdev;
354 bdev = blkdev_get_by_dev(dev, FMODE_READ, NULL);
355 if (IS_ERR_OR_NULL(bdev)) {
356 DMERR("blkdev_get_by_dev failed");
357 return PTR_ERR(bdev);
360 *device_size = i_size_read(bdev->bd_inode);
361 *device_size >>= SECTOR_SHIFT;
363 DMINFO("blkdev size in sectors: %llu", *device_size);
364 blkdev_put(bdev, FMODE_READ);
368 static struct android_metadata *extract_metadata(dev_t dev,
369 struct fec_header *fec)
371 struct block_device *bdev;
372 struct android_metadata_header *header;
373 struct android_metadata *uninitialized_var(metadata);
375 u32 table_length, copy_length, offset;
377 struct bio_read payload;
380 bdev = blkdev_get_by_dev(dev, FMODE_READ, NULL);
382 if (IS_ERR_OR_NULL(bdev)) {
383 DMERR("blkdev_get_by_dev failed");
384 return ERR_CAST(bdev);
387 find_metadata_offset(fec, bdev, &metadata_offset);
389 /* Verity metadata size is a power of 2 and PAGE_SIZE
390 * is a power of 2 as well.
391 * PAGE_SIZE is also a multiple of 512 bytes.
393 if (VERITY_METADATA_SIZE > PAGE_SIZE)
394 BUG_ON(VERITY_METADATA_SIZE % PAGE_SIZE != 0);
395 /* 512 byte sector alignment */
396 BUG_ON(metadata_offset % (1 << SECTOR_SHIFT) != 0);
398 err = read_block_dev(&payload, bdev, metadata_offset /
399 (1 << SECTOR_SHIFT), VERITY_METADATA_SIZE);
401 DMERR("Error while reading verity metadata");
402 metadata = ERR_PTR(err);
406 header = kzalloc(sizeof(*header), GFP_KERNEL);
408 DMERR("kzalloc failed for header");
413 memcpy(header, page_address(payload.page_io[0]),
416 DMINFO("bio magic_number:%u protocol_version:%d table_length:%u",
417 le32_to_cpu(header->magic_number),
418 le32_to_cpu(header->protocol_version),
419 le32_to_cpu(header->table_length));
421 metadata = kzalloc(sizeof(*metadata), GFP_KERNEL);
423 DMERR("kzalloc for metadata failed");
428 metadata->header = header;
429 table_length = le32_to_cpu(header->table_length);
431 if (table_length == 0 ||
432 table_length > (VERITY_METADATA_SIZE -
433 sizeof(struct android_metadata_header)))
436 metadata->verity_table = kzalloc(table_length + 1, GFP_KERNEL);
438 if (!metadata->verity_table) {
439 DMERR("kzalloc verity_table failed");
444 if (sizeof(struct android_metadata_header) +
445 table_length <= PAGE_SIZE) {
446 memcpy(metadata->verity_table, page_address(payload.page_io[0])
447 + sizeof(struct android_metadata_header),
450 copy_length = PAGE_SIZE -
451 sizeof(struct android_metadata_header);
452 memcpy(metadata->verity_table, page_address(payload.page_io[0])
453 + sizeof(struct android_metadata_header),
455 table_length -= copy_length;
456 offset = copy_length;
458 while (table_length != 0) {
459 if (table_length > PAGE_SIZE) {
460 memcpy(metadata->verity_table + offset,
461 page_address(payload.page_io[i]),
464 table_length -= PAGE_SIZE;
466 memcpy(metadata->verity_table + offset,
467 page_address(payload.page_io[i]),
474 metadata->verity_table[table_length] = '\0';
482 metadata = ERR_PTR(err);
484 for (i = 0; i < payload.number_of_pages; i++)
485 if (payload.page_io[i])
486 __free_page(payload.page_io[i]);
487 kfree(payload.page_io);
489 DMINFO("verity_table: %s", metadata->verity_table);
491 blkdev_put(bdev, FMODE_READ);
495 /* helper functions to extract properties from dts */
496 const char *find_dt_value(const char *name)
498 struct device_node *firmware;
501 firmware = of_find_node_by_path("/firmware/android");
504 value = of_get_property(firmware, name, NULL);
505 of_node_put(firmware);
510 static int verity_mode(void)
512 static const char enforcing[] = "enforcing";
513 static const char verified_mode_prop[] = "veritymode";
516 value = find_dt_value(verified_mode_prop);
519 if (!strncmp(value, enforcing, sizeof(enforcing) - 1))
520 return DM_VERITY_MODE_RESTART;
522 return DM_VERITY_MODE_EIO;
525 static int verify_header(struct android_metadata_header *header)
527 int retval = -EINVAL;
529 if (is_userdebug() && le32_to_cpu(header->magic_number) ==
530 VERITY_METADATA_MAGIC_DISABLE) {
531 retval = VERITY_STATE_DISABLE;
535 if (!(le32_to_cpu(header->magic_number) ==
536 VERITY_METADATA_MAGIC_NUMBER) ||
537 (le32_to_cpu(header->magic_number) ==
538 VERITY_METADATA_MAGIC_DISABLE)) {
539 DMERR("Incorrect magic number");
543 if (le32_to_cpu(header->protocol_version) !=
544 VERITY_METADATA_VERSION) {
545 DMERR("Unsupported version %u",
546 le32_to_cpu(header->protocol_version));
553 static int verify_verity_signature(char *key_id,
554 struct android_metadata *metadata)
558 struct public_key_signature *pks = NULL;
559 int retval = -EINVAL;
561 key_ref = keyring_search(make_key_ref(system_trusted_keyring, 1),
562 &key_type_asymmetric, key_id);
564 if (IS_ERR(key_ref)) {
565 DMERR("keyring: key not found");
569 key = key_ref_to_ptr(key_ref);
571 pks = table_make_digest(HASH_ALGO_SHA256,
572 (const void *)metadata->verity_table,
573 le32_to_cpu(metadata->header->table_length));
576 DMERR("hashing failed");
580 retval = table_extract_mpi_array(pks, &metadata->header->signature[0],
583 DMERR("Error extracting mpi %d", retval);
587 retval = verify_signature(key, pks);
588 mpi_free(pks->rsa.s);
596 static void handle_error(void)
598 int mode = verity_mode();
599 if (mode == DM_VERITY_MODE_RESTART) {
600 DMERR("triggering restart");
601 kernel_restart("dm-verity device corrupted");
603 DMERR("Mounting verity root failed");
607 static inline bool test_mult_overflow(sector_t a, u32 b)
609 sector_t r = (sector_t)~0ULL;
615 static int add_as_linear_device(struct dm_target *ti, char *dev)
617 /*Move to linear mapping defines*/
618 char *linear_table_args[DM_LINEAR_ARGS] = {dev,
619 DM_LINEAR_TARGET_OFFSET};
622 android_verity_target.dtr = dm_linear_dtr,
623 android_verity_target.map = dm_linear_map,
624 android_verity_target.status = dm_linear_status,
625 android_verity_target.ioctl = dm_linear_ioctl,
626 android_verity_target.merge = dm_linear_merge,
627 android_verity_target.iterate_devices = dm_linear_iterate_devices,
628 android_verity_target.io_hints = NULL;
630 err = dm_linear_ctr(ti, DM_LINEAR_ARGS, linear_table_args);
633 DMINFO("Added android-verity as a linear target");
636 DMERR("Failed to add android-verity as linear target");
643 * <key id> Key id of the public key in the system keyring.
644 * Verity metadata's signature would be verified against
645 * this. If the key id contains spaces, replace them
647 * <block device> The block device for which dm-verity is being setup.
649 static int android_verity_ctr(struct dm_target *ti, unsigned argc, char **argv)
651 dev_t uninitialized_var(dev);
652 struct android_metadata *uninitialized_var(metadata);
653 int err = 0, i, mode;
654 char *key_id, *table_ptr, dummy, *target_device,
655 *verity_table_args[VERITY_TABLE_ARGS + 2 + VERITY_TABLE_OPT_FEC_ARGS];
656 /* One for specifying number of opt args and one for mode */
657 sector_t data_sectors;
659 unsigned int no_of_args = VERITY_TABLE_ARGS + 2 + VERITY_TABLE_OPT_FEC_ARGS;
660 struct fec_header uninitialized_var(fec);
661 struct fec_ecc_metadata uninitialized_var(ecc);
662 char buf[FEC_ARG_LENGTH], *buf_ptr;
663 unsigned long long tmpll;
667 /* Use the default keyid */
668 if (default_verity_key_id())
669 key_id = veritykeyid;
670 else if (!is_eng()) {
671 DMERR("veritykeyid= is not set");
675 } else if (argc == 2)
678 DMERR("Incorrect number of arguments");
683 target_device = argv[0];
685 dev = name_to_dev_t(target_device);
687 DMERR("no dev found for %s", target_device);
693 err = find_size(dev, &device_size);
695 DMERR("error finding bdev size");
700 ti->len = device_size;
701 err = add_as_linear_device(ti, target_device);
706 verity_enabled = false;
710 strreplace(key_id, '#', ' ');
712 DMINFO("key:%s dev:%s", key_id, target_device);
714 if (extract_fec_header(dev, &fec, &ecc)) {
715 DMERR("Error while extracting fec header");
720 metadata = extract_metadata(dev, &fec);
722 if (IS_ERR(metadata)) {
723 DMERR("Error while extracting metadata");
728 err = verify_header(metadata->header);
730 if (err == VERITY_STATE_DISABLE) {
731 DMERR("Mounting root with verity disabled");
732 verity_enabled = false;
733 /* we would still have to parse the args to figure out
734 * the data blocks size. Or may be could map the entire
735 * partition similar to mounting the device.
738 DMERR("Verity header handle error");
743 if (verity_enabled) {
744 err = verify_verity_signature(key_id, metadata);
747 DMERR("Signature verification failed");
751 DMINFO("Signature verification success");
754 table_ptr = metadata->verity_table;
756 for (i = 0; i < VERITY_TABLE_ARGS; i++) {
757 verity_table_args[i] = strsep(&table_ptr, " ");
758 if (verity_table_args[i] == NULL)
762 if (i != VERITY_TABLE_ARGS) {
763 DMERR("Verity table not in the expected format");
769 if (sscanf(verity_table_args[5], "%llu%c", &tmpll, &dummy)
771 DMERR("Verity table not in the expected format");
777 if (tmpll > ULONG_MAX) {
778 DMERR("<num_data_blocks> too large. Forgot to turn on CONFIG_LBDAF?");
784 data_sectors = tmpll;
786 if (sscanf(verity_table_args[3], "%u%c", &data_block_size, &dummy)
788 DMERR("Verity table not in the expected format");
794 if (test_mult_overflow(data_sectors, data_block_size >>
796 DMERR("data_sectors too large");
802 data_sectors *= data_block_size >> SECTOR_SHIFT;
803 DMINFO("Data sectors %llu", (unsigned long long)data_sectors);
805 /* update target length */
806 ti->len = data_sectors;
808 /* Setup linear target and free */
809 if (!verity_enabled) {
810 err = add_as_linear_device(ti, target_device);
814 /*substitute data_dev and hash_dev*/
815 verity_table_args[1] = target_device;
816 verity_table_args[2] = target_device;
818 mode = verity_mode();
820 if (ecc.valid && IS_BUILTIN(CONFIG_DM_VERITY_FEC)) {
822 err = snprintf(buf, FEC_ARG_LENGTH,
823 "%u %s " VERITY_TABLE_OPT_FEC_FORMAT,
824 1 + VERITY_TABLE_OPT_FEC_ARGS,
825 mode == DM_VERITY_MODE_RESTART ?
826 VERITY_TABLE_OPT_RESTART :
827 VERITY_TABLE_OPT_LOGGING,
829 ecc.start / FEC_BLOCK_SIZE, ecc.blocks,
832 err = snprintf(buf, FEC_ARG_LENGTH,
833 "%u " VERITY_TABLE_OPT_FEC_FORMAT,
834 VERITY_TABLE_OPT_FEC_ARGS, target_device,
835 ecc.start / FEC_BLOCK_SIZE, ecc.blocks,
839 err = snprintf(buf, FEC_ARG_LENGTH,
840 "2 " VERITY_TABLE_OPT_IGNZERO " %s",
841 mode == DM_VERITY_MODE_RESTART ?
842 VERITY_TABLE_OPT_RESTART : VERITY_TABLE_OPT_LOGGING);
844 err = snprintf(buf, FEC_ARG_LENGTH, "1 %s",
845 "ignore_zero_blocks");
848 if (err < 0 || err >= FEC_ARG_LENGTH)
853 for (i = VERITY_TABLE_ARGS; i < (VERITY_TABLE_ARGS +
854 VERITY_TABLE_OPT_FEC_ARGS + 2); i++) {
855 verity_table_args[i] = strsep(&buf_ptr, " ");
856 if (verity_table_args[i] == NULL) {
862 err = verity_ctr(ti, no_of_args, verity_table_args);
865 DMERR("android-verity failed to mount as verity target");
868 DMINFO("android-verity mounted as verity target");
872 kfree(metadata->header);
873 kfree(metadata->verity_table);
878 static int __init dm_android_verity_init(void)
883 r = dm_register_target(&android_verity_target);
885 DMERR("register failed %d", r);
887 /* Tracks the status of the last added target */
888 debug_dir = debugfs_create_dir("android_verity", NULL);
890 if (IS_ERR_OR_NULL(debug_dir)) {
891 DMERR("Cannot create android_verity debugfs directory: %ld",
896 file = debugfs_create_bool("target_added", S_IRUGO, debug_dir,
897 (u32 *)&target_added);
899 if (IS_ERR_OR_NULL(file)) {
900 DMERR("Cannot create android_verity debugfs directory: %ld",
902 debugfs_remove_recursive(debug_dir);
906 file = debugfs_create_bool("verity_enabled", S_IRUGO, debug_dir,
907 (u32 *)&verity_enabled);
909 if (IS_ERR_OR_NULL(file)) {
910 DMERR("Cannot create android_verity debugfs directory: %ld",
912 debugfs_remove_recursive(debug_dir);
919 static void __exit dm_android_verity_exit(void)
921 if (!IS_ERR_OR_NULL(debug_dir))
922 debugfs_remove_recursive(debug_dir);
924 dm_unregister_target(&android_verity_target);
927 module_init(dm_android_verity_init);
928 module_exit(dm_android_verity_exit);