drivers/md/dm-verity-target.c

   1 /*
   2  * Copyright (C) 2012 Red Hat, Inc.
   3  *
   4  * Author: Mikulas Patocka <mpatocka@redhat.com>
   5  *
   6  * Based on Chromium dm-verity driver (C) 2011 The Chromium OS Authors
   7  *
   8  * This file is released under the GPLv2.
   9  *
  10  * In the file "/sys/module/dm_verity/parameters/prefetch_cluster" you can set
  11  * default prefetch value. Data are read in "prefetch_cluster" chunks from the
  12  * hash device. Setting this greatly improves performance when data and hash
  13  * are on the same disk on different partitions on devices with poor random
  14  * access behavior.
  15  */
  16
  17 #include "dm-verity.h"
  18 #include "dm-verity-fec.h"
  19
  20 #include <linux/module.h>
  21 #include <linux/reboot.h>
  22
  23 #define DM_MSG_PREFIX                   "verity"
  24
  25 #define DM_VERITY_ENV_LENGTH            42
  26 #define DM_VERITY_ENV_VAR_NAME          "DM_VERITY_ERR_BLOCK_NR"
  27
  28 #define DM_VERITY_DEFAULT_PREFETCH_SIZE 262144
  29
  30 #define DM_VERITY_MAX_CORRUPTED_ERRS    100
  31
  32 #define DM_VERITY_OPT_LOGGING           "ignore_corruption"
  33 #define DM_VERITY_OPT_RESTART           "restart_on_corruption"
  34 #define DM_VERITY_OPT_IGN_ZEROES        "ignore_zero_blocks"
  35 #define DM_VERITY_OPT_AT_MOST_ONCE      "check_at_most_once"
  36
  37 #define DM_VERITY_OPTS_MAX              (3 + DM_VERITY_OPTS_FEC)
  38
  39 static unsigned dm_verity_prefetch_cluster = DM_VERITY_DEFAULT_PREFETCH_SIZE;
  40
  41 module_param_named(prefetch_cluster, dm_verity_prefetch_cluster, uint, S_IRUGO | S_IWUSR);
  42
  43 struct dm_verity_prefetch_work {
  44         struct work_struct work;
  45         struct dm_verity *v;
  46         sector_t block;
  47         unsigned n_blocks;
  48 };
  49
  50 /*
  51  * Auxiliary structure appended to each dm-bufio buffer. If the value
  52  * hash_verified is nonzero, hash of the block has been verified.
  53  *
  54  * The variable hash_verified is set to 0 when allocating the buffer, then
  55  * it can be changed to 1 and it is never reset to 0 again.
  56  *
  57  * There is no lock around this value, a race condition can at worst cause
  58  * that multiple processes verify the hash of the same buffer simultaneously
  59  * and write 1 to hash_verified simultaneously.
  60  * This condition is harmless, so we don't need locking.
  61  */
  62 struct buffer_aux {
  63         int hash_verified;
  64 };
  65
  66 /*
  67  * Initialize struct buffer_aux for a freshly created buffer.
  68  */
  69 static void dm_bufio_alloc_callback(struct dm_buffer *buf)
  70 {
  71         struct buffer_aux *aux = dm_bufio_get_aux_data(buf);
  72
  73         aux->hash_verified = 0;
  74 }
  75
  76 /*
  77  * Translate input sector number to the sector number on the target device.
  78  */
  79 static sector_t verity_map_sector(struct dm_verity *v, sector_t bi_sector)
  80 {
  81         return v->data_start + dm_target_offset(v->ti, bi_sector);
  82 }
  83
  84 /*
  85  * Return hash position of a specified block at a specified tree level
  86  * (0 is the lowest level).
  87  * The lowest "hash_per_block_bits"-bits of the result denote hash position
  88  * inside a hash block. The remaining bits denote location of the hash block.
  89  */
  90 static sector_t verity_position_at_level(struct dm_verity *v, sector_t block,
  91                                          int level)
  92 {
  93         return block >> (level * v->hash_per_block_bits);
  94 }
  95
  96 static int verity_hash_update(struct dm_verity *v, struct ahash_request *req,
  97                                 const u8 *data, size_t len,
  98                                 struct crypto_wait *wait)
  99 {
 100         struct scatterlist sg;
 101
 102         if (likely(!is_vmalloc_addr(data))) {
 103                 sg_init_one(&sg, data, len);
 104                 ahash_request_set_crypt(req, &sg, NULL, len);
 105                 return crypto_wait_req(crypto_ahash_update(req), wait);
 106         } else {
 107                 do {
 108                         int r;
 109                         size_t this_step = min_t(size_t, len, PAGE_SIZE - offset_in_page(data));
 110                         flush_kernel_vmap_range((void *)data, this_step);
 111                         sg_init_table(&sg, 1);
 112                         sg_set_page(&sg, vmalloc_to_page(data), this_step, offset_in_page(data));
 113                         ahash_request_set_crypt(req, &sg, NULL, this_step);
 114                         r = crypto_wait_req(crypto_ahash_update(req), wait);
 115                         if (unlikely(r))
 116                                 return r;
 117                         data += this_step;
 118                         len -= this_step;
 119                 } while (len);
 120                 return 0;
 121         }
 122 }
 123
 124 /*
 125  * Wrapper for crypto_ahash_init, which handles verity salting.
 126  */
 127 static int verity_hash_init(struct dm_verity *v, struct ahash_request *req,
 128                                 struct crypto_wait *wait)
 129 {
 130         int r;
 131
 132         ahash_request_set_tfm(req, v->tfm);
 133         ahash_request_set_callback(req, CRYPTO_TFM_REQ_MAY_SLEEP |
 134                                         CRYPTO_TFM_REQ_MAY_BACKLOG,
 135                                         crypto_req_done, (void *)wait);
 136         crypto_init_wait(wait);
 137
 138         r = crypto_wait_req(crypto_ahash_init(req), wait);
 139
 140         if (unlikely(r < 0)) {
 141                 DMERR("crypto_ahash_init failed: %d", r);
 142                 return r;
 143         }
 144
 145         if (likely(v->salt_size && (v->version >= 1)))
 146                 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
 147
 148         return r;
 149 }
 150
 151 static int verity_hash_final(struct dm_verity *v, struct ahash_request *req,
 152                              u8 *digest, struct crypto_wait *wait)
 153 {
 154         int r;
 155
 156         if (unlikely(v->salt_size && (!v->version))) {
 157                 r = verity_hash_update(v, req, v->salt, v->salt_size, wait);
 158
 159                 if (r < 0) {
 160                         DMERR("verity_hash_final failed updating salt: %d", r);
 161                         goto out;
 162                 }
 163         }
 164
 165         ahash_request_set_crypt(req, NULL, digest, 0);
 166         r = crypto_wait_req(crypto_ahash_final(req), wait);
 167 out:
 168         return r;
 169 }
 170
 171 int verity_hash(struct dm_verity *v, struct ahash_request *req,
 172                 const u8 *data, size_t len, u8 *digest)
 173 {
 174         int r;
 175         struct crypto_wait wait;
 176
 177         r = verity_hash_init(v, req, &wait);
 178         if (unlikely(r < 0))
 179                 goto out;
 180
 181         r = verity_hash_update(v, req, data, len, &wait);
 182         if (unlikely(r < 0))
 183                 goto out;
 184
 185         r = verity_hash_final(v, req, digest, &wait);
 186
 187 out:
 188         return r;
 189 }
 190
 191 static void verity_hash_at_level(struct dm_verity *v, sector_t block, int level,
 192                                  sector_t *hash_block, unsigned *offset)
 193 {
 194         sector_t position = verity_position_at_level(v, block, level);
 195         unsigned idx;
 196
 197         *hash_block = v->hash_level_block[level] + (position >> v->hash_per_block_bits);
 198
 199         if (!offset)
 200                 return;
 201
 202         idx = position & ((1 << v->hash_per_block_bits) - 1);
 203         if (!v->version)
 204                 *offset = idx * v->digest_size;
 205         else
 206                 *offset = idx << (v->hash_dev_block_bits - v->hash_per_block_bits);
 207 }
 208
 209 /*
 210  * Handle verification errors.
 211  */
 212 static int verity_handle_err(struct dm_verity *v, enum verity_block_type type,
 213                              unsigned long long block)
 214 {
 215         char verity_env[DM_VERITY_ENV_LENGTH];
 216         char *envp[] = { verity_env, NULL };
 217         const char *type_str = "";
 218         struct mapped_device *md = dm_table_get_md(v->ti->table);
 219
 220         /* Corruption should be visible in device status in all modes */
 221         v->hash_failed = 1;
 222
 223         if (v->corrupted_errs >= DM_VERITY_MAX_CORRUPTED_ERRS)
 224                 goto out;
 225
 226         v->corrupted_errs++;
 227
 228         switch (type) {
 229         case DM_VERITY_BLOCK_TYPE_DATA:
 230                 type_str = "data";
 231                 break;
 232         case DM_VERITY_BLOCK_TYPE_METADATA:
 233                 type_str = "metadata";
 234                 break;
 235         default:
 236                 BUG();
 237         }
 238
 239         DMERR_LIMIT("%s: %s block %llu is corrupted", v->data_dev->name,
 240                     type_str, block);
 241
 242         if (v->corrupted_errs == DM_VERITY_MAX_CORRUPTED_ERRS)
 243                 DMERR("%s: reached maximum errors", v->data_dev->name);
 244
 245         snprintf(verity_env, DM_VERITY_ENV_LENGTH, "%s=%d,%llu",
 246                 DM_VERITY_ENV_VAR_NAME, type, block);
 247
 248         kobject_uevent_env(&disk_to_dev(dm_disk(md))->kobj, KOBJ_CHANGE, envp);
 249
 250 out:
 251         if (v->mode == DM_VERITY_MODE_LOGGING)
 252                 return 0;
 253
 254         if (v->mode == DM_VERITY_MODE_RESTART)
 255                 kernel_restart("dm-verity device corrupted");
 256
 257         return 1;
 258 }
 259
 260 /*
 261  * Verify hash of a metadata block pertaining to the specified data block
 262  * ("block" argument) at a specified level ("level" argument).
 263  *
 264  * On successful return, verity_io_want_digest(v, io) contains the hash value
 265  * for a lower tree level or for the data block (if we're at the lowest level).
 266  *
 267  * If "skip_unverified" is true, unverified buffer is skipped and 1 is returned.
 268  * If "skip_unverified" is false, unverified buffer is hashed and verified
 269  * against current value of verity_io_want_digest(v, io).
 270  */
 271 static int verity_verify_level(struct dm_verity *v, struct dm_verity_io *io,
 272                                sector_t block, int level, bool skip_unverified,
 273                                u8 *want_digest)
 274 {
 275         struct dm_buffer *buf;
 276         struct buffer_aux *aux;
 277         u8 *data;
 278         int r;
 279         sector_t hash_block;
 280         unsigned offset;
 281
 282         verity_hash_at_level(v, block, level, &hash_block, &offset);
 283
 284         data = dm_bufio_read(v->bufio, hash_block, &buf);
 285         if (IS_ERR(data))
 286                 return PTR_ERR(data);
 287
 288         aux = dm_bufio_get_aux_data(buf);
 289
 290         if (!aux->hash_verified) {
 291                 if (skip_unverified) {
 292                         r = 1;
 293                         goto release_ret_r;
 294                 }
 295
 296                 r = verity_hash(v, verity_io_hash_req(v, io),
 297                                 data, 1 << v->hash_dev_block_bits,
 298                                 verity_io_real_digest(v, io));
 299                 if (unlikely(r < 0))
 300                         goto release_ret_r;
 301
 302                 if (likely(memcmp(verity_io_real_digest(v, io), want_digest,
 303                                   v->digest_size) == 0))
 304                         aux->hash_verified = 1;
 305                 else if (verity_fec_decode(v, io,
 306                                            DM_VERITY_BLOCK_TYPE_METADATA,
 307                                            hash_block, data, NULL) == 0)
 308                         aux->hash_verified = 1;
 309                 else if (verity_handle_err(v,
 310                                            DM_VERITY_BLOCK_TYPE_METADATA,
 311                                            hash_block)) {
 312                         r = -EIO;
 313                         goto release_ret_r;
 314                 }
 315         }
 316
 317         data += offset;
 318         memcpy(want_digest, data, v->digest_size);
 319         r = 0;
 320
 321 release_ret_r:
 322         dm_bufio_release(buf);
 323         return r;
 324 }
 325
 326 /*
 327  * Find a hash for a given block, write it to digest and verify the integrity
 328  * of the hash tree if necessary.
 329  */
 330 int verity_hash_for_block(struct dm_verity *v, struct dm_verity_io *io,
 331                           sector_t block, u8 *digest, bool *is_zero)
 332 {
 333         int r = 0, i;
 334
 335         if (likely(v->levels)) {
 336                 /*
 337                  * First, we try to get the requested hash for
 338                  * the current block. If the hash block itself is
 339                  * verified, zero is returned. If it isn't, this
 340                  * function returns 1 and we fall back to whole
 341                  * chain verification.
 342                  */
 343                 r = verity_verify_level(v, io, block, 0, true, digest);
 344                 if (likely(r <= 0))
 345                         goto out;
 346         }
 347
 348         memcpy(digest, v->root_digest, v->digest_size);
 349
 350         for (i = v->levels - 1; i >= 0; i--) {
 351                 r = verity_verify_level(v, io, block, i, false, digest);
 352                 if (unlikely(r))
 353                         goto out;
 354         }
 355 out:
 356         if (!r && v->zero_digest)
 357                 *is_zero = !memcmp(v->zero_digest, digest, v->digest_size);
 358         else
 359                 *is_zero = false;
 360
 361         return r;
 362 }
 363
 364 /*
 365  * Calculates the digest for the given bio
 366  */
 367 static int verity_for_io_block(struct dm_verity *v, struct dm_verity_io *io,
 368                                struct bvec_iter *iter, struct crypto_wait *wait)
 369 {
 370         unsigned int todo = 1 << v->data_dev_block_bits;
 371         struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
 372         struct scatterlist sg;
 373         struct ahash_request *req = verity_io_hash_req(v, io);
 374
 375         do {
 376                 int r;
 377                 unsigned int len;
 378                 struct bio_vec bv = bio_iter_iovec(bio, *iter);
 379
 380                 sg_init_table(&sg, 1);
 381
 382                 len = bv.bv_len;
 383
 384                 if (likely(len >= todo))
 385                         len = todo;
 386                 /*
 387                  * Operating on a single page at a time looks suboptimal
 388                  * until you consider the typical block size is 4,096B.
 389                  * Going through this loops twice should be very rare.
 390                  */
 391                 sg_set_page(&sg, bv.bv_page, len, bv.bv_offset);
 392                 ahash_request_set_crypt(req, &sg, NULL, len);
 393                 r = crypto_wait_req(crypto_ahash_update(req), wait);
 394
 395                 if (unlikely(r < 0)) {
 396                         DMERR("verity_for_io_block crypto op failed: %d", r);
 397                         return r;
 398                 }
 399
 400                 bio_advance_iter(bio, iter, len);
 401                 todo -= len;
 402         } while (todo);
 403
 404         return 0;
 405 }
 406
 407 /*
 408  * Calls function process for 1 << v->data_dev_block_bits bytes in the bio_vec
 409  * starting from iter.
 410  */
 411 int verity_for_bv_block(struct dm_verity *v, struct dm_verity_io *io,
 412                         struct bvec_iter *iter,
 413                         int (*process)(struct dm_verity *v,
 414                                        struct dm_verity_io *io, u8 *data,
 415                                        size_t len))
 416 {
 417         unsigned todo = 1 << v->data_dev_block_bits;
 418         struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
 419
 420         do {
 421                 int r;
 422                 u8 *page;
 423                 unsigned len;
 424                 struct bio_vec bv = bio_iter_iovec(bio, *iter);
 425
 426                 page = kmap_atomic(bv.bv_page);
 427                 len = bv.bv_len;
 428
 429                 if (likely(len >= todo))
 430                         len = todo;
 431
 432                 r = process(v, io, page + bv.bv_offset, len);
 433                 kunmap_atomic(page);
 434
 435                 if (r < 0)
 436                         return r;
 437
 438                 bio_advance_iter(bio, iter, len);
 439                 todo -= len;
 440         } while (todo);
 441
 442         return 0;
 443 }
 444
 445 static int verity_bv_zero(struct dm_verity *v, struct dm_verity_io *io,
 446                           u8 *data, size_t len)
 447 {
 448         memset(data, 0, len);
 449         return 0;
 450 }
 451
 452 /*
 453  * Moves the bio iter one data block forward.
 454  */
 455 static inline void verity_bv_skip_block(struct dm_verity *v,
 456                                         struct dm_verity_io *io,
 457                                         struct bvec_iter *iter)
 458 {
 459         struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
 460
 461         bio_advance_iter(bio, iter, 1 << v->data_dev_block_bits);
 462 }
 463
 464 /*
 465  * Verify one "dm_verity_io" structure.
 466  */
 467 static int verity_verify_io(struct dm_verity_io *io)
 468 {
 469         bool is_zero;
 470         struct dm_verity *v = io->v;
 471         struct bvec_iter start;
 472         unsigned b;
 473         struct crypto_wait wait;
 474         struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
 475
 476         for (b = 0; b < io->n_blocks; b++) {
 477                 int r;
 478                 sector_t cur_block = io->block + b;
 479                 struct ahash_request *req = verity_io_hash_req(v, io);
 480
 481                 if (v->validated_blocks && bio->bi_status == BLK_STS_OK &&
 482                     likely(test_bit(cur_block, v->validated_blocks))) {
 483                         verity_bv_skip_block(v, io, &io->iter);
 484                         continue;
 485                 }
 486
 487                 r = verity_hash_for_block(v, io, cur_block,
 488                                           verity_io_want_digest(v, io),
 489                                           &is_zero);
 490                 if (unlikely(r < 0))
 491                         return r;
 492
 493                 if (is_zero) {
 494                         /*
 495                          * If we expect a zero block, don't validate, just
 496                          * return zeros.
 497                          */
 498                         r = verity_for_bv_block(v, io, &io->iter,
 499                                                 verity_bv_zero);
 500                         if (unlikely(r < 0))
 501                                 return r;
 502
 503                         continue;
 504                 }
 505
 506                 r = verity_hash_init(v, req, &wait);
 507                 if (unlikely(r < 0))
 508                         return r;
 509
 510                 start = io->iter;
 511                 r = verity_for_io_block(v, io, &io->iter, &wait);
 512                 if (unlikely(r < 0))
 513                         return r;
 514
 515                 r = verity_hash_final(v, req, verity_io_real_digest(v, io),
 516                                         &wait);
 517                 if (unlikely(r < 0))
 518                         return r;
 519
 520                 if (likely(memcmp(verity_io_real_digest(v, io),
 521                                   verity_io_want_digest(v, io), v->digest_size) == 0)) {
 522                         if (v->validated_blocks)
 523                                 set_bit(cur_block, v->validated_blocks);
 524                         continue;
 525                 }
 526                 else if (verity_fec_decode(v, io, DM_VERITY_BLOCK_TYPE_DATA,
 527                                            cur_block, NULL, &start) == 0)
 528                         continue;
 529                 else {
 530                         if (bio->bi_status) {
 531                                 /*
 532                                  * Error correction failed; Just return error
 533                                  */
 534                                 return -EIO;
 535                         }
 536                         if (verity_handle_err(v, DM_VERITY_BLOCK_TYPE_DATA,
 537                                               cur_block))
 538                                 return -EIO;
 539                 }
 540         }
 541
 542         return 0;
 543 }
 544
 545 /*
 546  * Skip verity work in response to I/O error when system is shutting down.
 547  */
 548 static inline bool verity_is_system_shutting_down(void)
 549 {
 550         return system_state == SYSTEM_HALT || system_state == SYSTEM_POWER_OFF
 551                 || system_state == SYSTEM_RESTART;
 552 }
 553
 554 /*
 555  * End one "io" structure with a given error.
 556  */
 557 static void verity_finish_io(struct dm_verity_io *io, blk_status_t status)
 558 {
 559         struct dm_verity *v = io->v;
 560         struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
 561
 562         bio->bi_end_io = io->orig_bi_end_io;
 563         bio->bi_status = status;
 564
 565         verity_fec_finish_io(io);
 566
 567         bio_endio(bio);
 568 }
 569
 570 static void verity_work(struct work_struct *w)
 571 {
 572         struct dm_verity_io *io = container_of(w, struct dm_verity_io, work);
 573
 574         verity_finish_io(io, errno_to_blk_status(verity_verify_io(io)));
 575 }
 576
 577 static void verity_end_io(struct bio *bio)
 578 {
 579         struct dm_verity_io *io = bio->bi_private;
 580
 581         if (bio->bi_status &&
 582             (!verity_fec_is_enabled(io->v) || verity_is_system_shutting_down())) {
 583                 verity_finish_io(io, bio->bi_status);
 584                 return;
 585         }
 586
 587         INIT_WORK(&io->work, verity_work);
 588         queue_work(io->v->verify_wq, &io->work);
 589 }
 590
 591 /*
 592  * Prefetch buffers for the specified io.
 593  * The root buffer is not prefetched, it is assumed that it will be cached
 594  * all the time.
 595  */
 596 static void verity_prefetch_io(struct work_struct *work)
 597 {
 598         struct dm_verity_prefetch_work *pw =
 599                 container_of(work, struct dm_verity_prefetch_work, work);
 600         struct dm_verity *v = pw->v;
 601         int i;
 602
 603         for (i = v->levels - 2; i >= 0; i--) {
 604                 sector_t hash_block_start;
 605                 sector_t hash_block_end;
 606                 verity_hash_at_level(v, pw->block, i, &hash_block_start, NULL);
 607                 verity_hash_at_level(v, pw->block + pw->n_blocks - 1, i, &hash_block_end, NULL);
 608                 if (!i) {
 609                         unsigned cluster = READ_ONCE(dm_verity_prefetch_cluster);
 610
 611                         cluster >>= v->data_dev_block_bits;
 612                         if (unlikely(!cluster))
 613                                 goto no_prefetch_cluster;
 614
 615                         if (unlikely(cluster & (cluster - 1)))
 616                                 cluster = 1 << __fls(cluster);
 617
 618                         hash_block_start &= ~(sector_t)(cluster - 1);
 619                         hash_block_end |= cluster - 1;
 620                         if (unlikely(hash_block_end >= v->hash_blocks))
 621                                 hash_block_end = v->hash_blocks - 1;
 622                 }
 623 no_prefetch_cluster:
 624                 dm_bufio_prefetch(v->bufio, hash_block_start,
 625                                   hash_block_end - hash_block_start + 1);
 626         }
 627
 628         kfree(pw);
 629 }
 630
 631 static void verity_submit_prefetch(struct dm_verity *v, struct dm_verity_io *io)
 632 {
 633         struct dm_verity_prefetch_work *pw;
 634
 635         pw = kmalloc(sizeof(struct dm_verity_prefetch_work),
 636                 GFP_NOIO | __GFP_NORETRY | __GFP_NOMEMALLOC | __GFP_NOWARN);
 637
 638         if (!pw)
 639                 return;
 640
 641         INIT_WORK(&pw->work, verity_prefetch_io);
 642         pw->v = v;
 643         pw->block = io->block;
 644         pw->n_blocks = io->n_blocks;
 645         queue_work(v->verify_wq, &pw->work);
 646 }
 647
 648 /*
 649  * Bio map function. It allocates dm_verity_io structure and bio vector and
 650  * fills them. Then it issues prefetches and the I/O.
 651  */
 652 static int verity_map(struct dm_target *ti, struct bio *bio)
 653 {
 654         struct dm_verity *v = ti->private;
 655         struct dm_verity_io *io;
 656
 657         bio_set_dev(bio, v->data_dev->bdev);
 658         bio->bi_iter.bi_sector = verity_map_sector(v, bio->bi_iter.bi_sector);
 659
 660         if (((unsigned)bio->bi_iter.bi_sector | bio_sectors(bio)) &
 661             ((1 << (v->data_dev_block_bits - SECTOR_SHIFT)) - 1)) {
 662                 DMERR_LIMIT("unaligned io");
 663                 return DM_MAPIO_KILL;
 664         }
 665
 666         if (bio_end_sector(bio) >>
 667             (v->data_dev_block_bits - SECTOR_SHIFT) > v->data_blocks) {
 668                 DMERR_LIMIT("io out of range");
 669                 return DM_MAPIO_KILL;
 670         }
 671
 672         if (bio_data_dir(bio) == WRITE)
 673                 return DM_MAPIO_KILL;
 674
 675         io = dm_per_bio_data(bio, ti->per_io_data_size);
 676         io->v = v;
 677         io->orig_bi_end_io = bio->bi_end_io;
 678         io->block = bio->bi_iter.bi_sector >> (v->data_dev_block_bits - SECTOR_SHIFT);
 679         io->n_blocks = bio->bi_iter.bi_size >> v->data_dev_block_bits;
 680
 681         bio->bi_end_io = verity_end_io;
 682         bio->bi_private = io;
 683         io->iter = bio->bi_iter;
 684
 685         verity_fec_init_io(io);
 686
 687         verity_submit_prefetch(v, io);
 688
 689         generic_make_request(bio);
 690
 691         return DM_MAPIO_SUBMITTED;
 692 }
 693
 694 /*
 695  * Status: V (valid) or C (corruption found)
 696  */
 697 static void verity_status(struct dm_target *ti, status_type_t type,
 698                           unsigned status_flags, char *result, unsigned maxlen)
 699 {
 700         struct dm_verity *v = ti->private;
 701         unsigned args = 0;
 702         unsigned sz = 0;
 703         unsigned x;
 704
 705         switch (type) {
 706         case STATUSTYPE_INFO:
 707                 DMEMIT("%c", v->hash_failed ? 'C' : 'V');
 708                 break;
 709         case STATUSTYPE_TABLE:
 710                 DMEMIT("%u %s %s %u %u %llu %llu %s ",
 711                         v->version,
 712                         v->data_dev->name,
 713                         v->hash_dev->name,
 714                         1 << v->data_dev_block_bits,
 715                         1 << v->hash_dev_block_bits,
 716                         (unsigned long long)v->data_blocks,
 717                         (unsigned long long)v->hash_start,
 718                         v->alg_name
 719                         );
 720                 for (x = 0; x < v->digest_size; x++)
 721                         DMEMIT("%02x", v->root_digest[x]);
 722                 DMEMIT(" ");
 723                 if (!v->salt_size)
 724                         DMEMIT("-");
 725                 else
 726                         for (x = 0; x < v->salt_size; x++)
 727                                 DMEMIT("%02x", v->salt[x]);
 728                 if (v->mode != DM_VERITY_MODE_EIO)
 729                         args++;
 730                 if (verity_fec_is_enabled(v))
 731                         args += DM_VERITY_OPTS_FEC;
 732                 if (v->zero_digest)
 733                         args++;
 734                 if (v->validated_blocks)
 735                         args++;
 736                 if (!args)
 737                         return;
 738                 DMEMIT(" %u", args);
 739                 if (v->mode != DM_VERITY_MODE_EIO) {
 740                         DMEMIT(" ");
 741                         switch (v->mode) {
 742                         case DM_VERITY_MODE_LOGGING:
 743                                 DMEMIT(DM_VERITY_OPT_LOGGING);
 744                                 break;
 745                         case DM_VERITY_MODE_RESTART:
 746                                 DMEMIT(DM_VERITY_OPT_RESTART);
 747                                 break;
 748                         default:
 749                                 BUG();
 750                         }
 751                 }
 752                 if (v->zero_digest)
 753                         DMEMIT(" " DM_VERITY_OPT_IGN_ZEROES);
 754                 if (v->validated_blocks)
 755                         DMEMIT(" " DM_VERITY_OPT_AT_MOST_ONCE);
 756                 sz = verity_fec_status_table(v, sz, result, maxlen);
 757                 break;
 758         }
 759 }
 760
 761 static int verity_prepare_ioctl(struct dm_target *ti, struct block_device **bdev)
 762 {
 763         struct dm_verity *v = ti->private;
 764
 765         *bdev = v->data_dev->bdev;
 766
 767         if (v->data_start ||
 768             ti->len != i_size_read(v->data_dev->bdev->bd_inode) >> SECTOR_SHIFT)
 769                 return 1;
 770         return 0;
 771 }
 772
 773 static int verity_iterate_devices(struct dm_target *ti,
 774                                   iterate_devices_callout_fn fn, void *data)
 775 {
 776         struct dm_verity *v = ti->private;
 777
 778         return fn(ti, v->data_dev, v->data_start, ti->len, data);
 779 }
 780
 781 static void verity_io_hints(struct dm_target *ti, struct queue_limits *limits)
 782 {
 783         struct dm_verity *v = ti->private;
 784
 785         if (limits->logical_block_size < 1 << v->data_dev_block_bits)
 786                 limits->logical_block_size = 1 << v->data_dev_block_bits;
 787
 788         if (limits->physical_block_size < 1 << v->data_dev_block_bits)
 789                 limits->physical_block_size = 1 << v->data_dev_block_bits;
 790
 791         blk_limits_io_min(limits, limits->logical_block_size);
 792 }
 793
 794 static void verity_dtr(struct dm_target *ti)
 795 {
 796         struct dm_verity *v = ti->private;
 797
 798         if (v->verify_wq)
 799                 destroy_workqueue(v->verify_wq);
 800
 801         if (v->bufio)
 802                 dm_bufio_client_destroy(v->bufio);
 803
 804         kvfree(v->validated_blocks);
 805         kfree(v->salt);
 806         kfree(v->root_digest);
 807         kfree(v->zero_digest);
 808
 809         if (v->tfm)
 810                 crypto_free_ahash(v->tfm);
 811
 812         kfree(v->alg_name);
 813
 814         if (v->hash_dev)
 815                 dm_put_device(ti, v->hash_dev);
 816
 817         if (v->data_dev)
 818                 dm_put_device(ti, v->data_dev);
 819
 820         verity_fec_dtr(v);
 821
 822         kfree(v);
 823 }
 824
 825 static int verity_alloc_most_once(struct dm_verity *v)
 826 {
 827         struct dm_target *ti = v->ti;
 828
 829         /* the bitset can only handle INT_MAX blocks */
 830         if (v->data_blocks > INT_MAX) {
 831                 ti->error = "device too large to use check_at_most_once";
 832                 return -E2BIG;
 833         }
 834
 835         v->validated_blocks = kvcalloc(BITS_TO_LONGS(v->data_blocks),
 836                                        sizeof(unsigned long),
 837                                        GFP_KERNEL);
 838         if (!v->validated_blocks) {
 839                 ti->error = "failed to allocate bitset for check_at_most_once";
 840                 return -ENOMEM;
 841         }
 842
 843         return 0;
 844 }
 845
 846 static int verity_alloc_zero_digest(struct dm_verity *v)
 847 {
 848         int r = -ENOMEM;
 849         struct ahash_request *req;
 850         u8 *zero_data;
 851
 852         v->zero_digest = kmalloc(v->digest_size, GFP_KERNEL);
 853
 854         if (!v->zero_digest)
 855                 return r;
 856
 857         req = kmalloc(v->ahash_reqsize, GFP_KERNEL);
 858
 859         if (!req)
 860                 return r; /* verity_dtr will free zero_digest */
 861
 862         zero_data = kzalloc(1 << v->data_dev_block_bits, GFP_KERNEL);
 863
 864         if (!zero_data)
 865                 goto out;
 866
 867         r = verity_hash(v, req, zero_data, 1 << v->data_dev_block_bits,
 868                         v->zero_digest);
 869
 870 out:
 871         kfree(req);
 872         kfree(zero_data);
 873
 874         return r;
 875 }
 876
 877 static int verity_parse_opt_args(struct dm_arg_set *as, struct dm_verity *v)
 878 {
 879         int r;
 880         unsigned argc;
 881         struct dm_target *ti = v->ti;
 882         const char *arg_name;
 883
 884         static const struct dm_arg _args[] = {
 885                 {0, DM_VERITY_OPTS_MAX, "Invalid number of feature args"},
 886         };
 887
 888         r = dm_read_arg_group(_args, as, &argc, &ti->error);
 889         if (r)
 890                 return -EINVAL;
 891
 892         if (!argc)
 893                 return 0;
 894
 895         do {
 896                 arg_name = dm_shift_arg(as);
 897                 argc--;
 898
 899                 if (!strcasecmp(arg_name, DM_VERITY_OPT_LOGGING)) {
 900                         v->mode = DM_VERITY_MODE_LOGGING;
 901                         continue;
 902
 903                 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_RESTART)) {
 904                         v->mode = DM_VERITY_MODE_RESTART;
 905                         continue;
 906
 907                 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_IGN_ZEROES)) {
 908                         r = verity_alloc_zero_digest(v);
 909                         if (r) {
 910                                 ti->error = "Cannot allocate zero digest";
 911                                 return r;
 912                         }
 913                         continue;
 914
 915                 } else if (!strcasecmp(arg_name, DM_VERITY_OPT_AT_MOST_ONCE)) {
 916                         r = verity_alloc_most_once(v);
 917                         if (r)
 918                                 return r;
 919                         continue;
 920
 921                 } else if (verity_is_fec_opt_arg(arg_name)) {
 922                         r = verity_fec_parse_opt_args(as, v, &argc, arg_name);
 923                         if (r)
 924                                 return r;
 925                         continue;
 926                 }
 927
 928                 ti->error = "Unrecognized verity feature request";
 929                 return -EINVAL;
 930         } while (argc && !r);
 931
 932         return r;
 933 }
 934
 935 /*
 936  * Target parameters:
 937  *      <version>       The current format is version 1.
 938  *                      Vsn 0 is compatible with original Chromium OS releases.
 939  *      <data device>
 940  *      <hash device>
 941  *      <data block size>
 942  *      <hash block size>
 943  *      <the number of data blocks>
 944  *      <hash start block>
 945  *      <algorithm>
 946  *      <digest>
 947  *      <salt>          Hex string or "-" if no salt.
 948  */
 949 static int verity_ctr(struct dm_target *ti, unsigned argc, char **argv)
 950 {
 951         struct dm_verity *v;
 952         struct dm_arg_set as;
 953         unsigned int num;
 954         unsigned long long num_ll;
 955         int r;
 956         int i;
 957         sector_t hash_position;
 958         char dummy;
 959
 960         v = kzalloc(sizeof(struct dm_verity), GFP_KERNEL);
 961         if (!v) {
 962                 ti->error = "Cannot allocate verity structure";
 963                 return -ENOMEM;
 964         }
 965         ti->private = v;
 966         v->ti = ti;
 967
 968         r = verity_fec_ctr_alloc(v);
 969         if (r)
 970                 goto bad;
 971
 972         if ((dm_table_get_mode(ti->table) & ~FMODE_READ)) {
 973                 ti->error = "Device must be readonly";
 974                 r = -EINVAL;
 975                 goto bad;
 976         }
 977
 978         if (argc < 10) {
 979                 ti->error = "Not enough arguments";
 980                 r = -EINVAL;
 981                 goto bad;
 982         }
 983
 984         if (sscanf(argv[0], "%u%c", &num, &dummy) != 1 ||
 985             num > 1) {
 986                 ti->error = "Invalid version";
 987                 r = -EINVAL;
 988                 goto bad;
 989         }
 990         v->version = num;
 991
 992         r = dm_get_device(ti, argv[1], FMODE_READ, &v->data_dev);
 993         if (r) {
 994                 ti->error = "Data device lookup failed";
 995                 goto bad;
 996         }
 997
 998         r = dm_get_device(ti, argv[2], FMODE_READ, &v->hash_dev);
 999         if (r) {
1000                 ti->error = "Hash device lookup failed";
1001                 goto bad;
1002         }
1003
1004         if (sscanf(argv[3], "%u%c", &num, &dummy) != 1 ||
1005             !num || (num & (num - 1)) ||
1006             num < bdev_logical_block_size(v->data_dev->bdev) ||
1007             num > PAGE_SIZE) {
1008                 ti->error = "Invalid data device block size";
1009                 r = -EINVAL;
1010                 goto bad;
1011         }
1012         v->data_dev_block_bits = __ffs(num);
1013
1014         if (sscanf(argv[4], "%u%c", &num, &dummy) != 1 ||
1015             !num || (num & (num - 1)) ||
1016             num < bdev_logical_block_size(v->hash_dev->bdev) ||
1017             num > INT_MAX) {
1018                 ti->error = "Invalid hash device block size";
1019                 r = -EINVAL;
1020                 goto bad;
1021         }
1022         v->hash_dev_block_bits = __ffs(num);
1023
1024         if (sscanf(argv[5], "%llu%c", &num_ll, &dummy) != 1 ||
1025             (sector_t)(num_ll << (v->data_dev_block_bits - SECTOR_SHIFT))
1026             >> (v->data_dev_block_bits - SECTOR_SHIFT) != num_ll) {
1027                 ti->error = "Invalid data blocks";
1028                 r = -EINVAL;
1029                 goto bad;
1030         }
1031         v->data_blocks = num_ll;
1032
1033         if (ti->len > (v->data_blocks << (v->data_dev_block_bits - SECTOR_SHIFT))) {
1034                 ti->error = "Data device is too small";
1035                 r = -EINVAL;
1036                 goto bad;
1037         }
1038
1039         if (sscanf(argv[6], "%llu%c", &num_ll, &dummy) != 1 ||
1040             (sector_t)(num_ll << (v->hash_dev_block_bits - SECTOR_SHIFT))
1041             >> (v->hash_dev_block_bits - SECTOR_SHIFT) != num_ll) {
1042                 ti->error = "Invalid hash start";
1043                 r = -EINVAL;
1044                 goto bad;
1045         }
1046         v->hash_start = num_ll;
1047
1048         v->alg_name = kstrdup(argv[7], GFP_KERNEL);
1049         if (!v->alg_name) {
1050                 ti->error = "Cannot allocate algorithm name";
1051                 r = -ENOMEM;
1052                 goto bad;
1053         }
1054
1055         v->tfm = crypto_alloc_ahash(v->alg_name, 0, 0);
1056         if (IS_ERR(v->tfm)) {
1057                 ti->error = "Cannot initialize hash function";
1058                 r = PTR_ERR(v->tfm);
1059                 v->tfm = NULL;
1060                 goto bad;
1061         }
1062         v->digest_size = crypto_ahash_digestsize(v->tfm);
1063         if ((1 << v->hash_dev_block_bits) < v->digest_size * 2) {
1064                 ti->error = "Digest size too big";
1065                 r = -EINVAL;
1066                 goto bad;
1067         }
1068         v->ahash_reqsize = sizeof(struct ahash_request) +
1069                 crypto_ahash_reqsize(v->tfm);
1070
1071         v->root_digest = kmalloc(v->digest_size, GFP_KERNEL);
1072         if (!v->root_digest) {
1073                 ti->error = "Cannot allocate root digest";
1074                 r = -ENOMEM;
1075                 goto bad;
1076         }
1077         if (strlen(argv[8]) != v->digest_size * 2 ||
1078             hex2bin(v->root_digest, argv[8], v->digest_size)) {
1079                 ti->error = "Invalid root digest";
1080                 r = -EINVAL;
1081                 goto bad;
1082         }
1083
1084         if (strcmp(argv[9], "-")) {
1085                 v->salt_size = strlen(argv[9]) / 2;
1086                 v->salt = kmalloc(v->salt_size, GFP_KERNEL);
1087                 if (!v->salt) {
1088                         ti->error = "Cannot allocate salt";
1089                         r = -ENOMEM;
1090                         goto bad;
1091                 }
1092                 if (strlen(argv[9]) != v->salt_size * 2 ||
1093                     hex2bin(v->salt, argv[9], v->salt_size)) {
1094                         ti->error = "Invalid salt";
1095                         r = -EINVAL;
1096                         goto bad;
1097                 }
1098         }
1099
1100         argv += 10;
1101         argc -= 10;
1102
1103         /* Optional parameters */
1104         if (argc) {
1105                 as.argc = argc;
1106                 as.argv = argv;
1107
1108                 r = verity_parse_opt_args(&as, v);
1109                 if (r < 0)
1110                         goto bad;
1111         }
1112
1113         v->hash_per_block_bits =
1114                 __fls((1 << v->hash_dev_block_bits) / v->digest_size);
1115
1116         v->levels = 0;
1117         if (v->data_blocks)
1118                 while (v->hash_per_block_bits * v->levels < 64 &&
1119                        (unsigned long long)(v->data_blocks - 1) >>
1120                        (v->hash_per_block_bits * v->levels))
1121                         v->levels++;
1122
1123         if (v->levels > DM_VERITY_MAX_LEVELS) {
1124                 ti->error = "Too many tree levels";
1125                 r = -E2BIG;
1126                 goto bad;
1127         }
1128
1129         hash_position = v->hash_start;
1130         for (i = v->levels - 1; i >= 0; i--) {
1131                 sector_t s;
1132                 v->hash_level_block[i] = hash_position;
1133                 s = (v->data_blocks + ((sector_t)1 << ((i + 1) * v->hash_per_block_bits)) - 1)
1134                                         >> ((i + 1) * v->hash_per_block_bits);
1135                 if (hash_position + s < hash_position) {
1136                         ti->error = "Hash device offset overflow";
1137                         r = -E2BIG;
1138                         goto bad;
1139                 }
1140                 hash_position += s;
1141         }
1142         v->hash_blocks = hash_position;
1143
1144         v->bufio = dm_bufio_client_create(v->hash_dev->bdev,
1145                 1 << v->hash_dev_block_bits, 1, sizeof(struct buffer_aux),
1146                 dm_bufio_alloc_callback, NULL);
1147         if (IS_ERR(v->bufio)) {
1148                 ti->error = "Cannot initialize dm-bufio";
1149                 r = PTR_ERR(v->bufio);
1150                 v->bufio = NULL;
1151                 goto bad;
1152         }
1153
1154         if (dm_bufio_get_device_size(v->bufio) < v->hash_blocks) {
1155                 ti->error = "Hash device is too small";
1156                 r = -E2BIG;
1157                 goto bad;
1158         }
1159
1160         /* WQ_UNBOUND greatly improves performance when running on ramdisk */
1161         v->verify_wq = alloc_workqueue("kverityd", WQ_CPU_INTENSIVE | WQ_MEM_RECLAIM | WQ_UNBOUND, num_online_cpus());
1162         if (!v->verify_wq) {
1163                 ti->error = "Cannot allocate workqueue";
1164                 r = -ENOMEM;
1165                 goto bad;
1166         }
1167
1168         ti->per_io_data_size = sizeof(struct dm_verity_io) +
1169                                 v->ahash_reqsize + v->digest_size * 2;
1170
1171         r = verity_fec_ctr(v);
1172         if (r)
1173                 goto bad;
1174
1175         ti->per_io_data_size = roundup(ti->per_io_data_size,
1176                                        __alignof__(struct dm_verity_io));
1177
1178         return 0;
1179
1180 bad:
1181         verity_dtr(ti);
1182
1183         return r;
1184 }
1185
1186 static struct target_type verity_target = {
1187         .name           = "verity",
1188         .features       = DM_TARGET_IMMUTABLE,
1189         .version        = {1, 4, 0},
1190         .module         = THIS_MODULE,
1191         .ctr            = verity_ctr,
1192         .dtr            = verity_dtr,
1193         .map            = verity_map,
1194         .status         = verity_status,
1195         .prepare_ioctl  = verity_prepare_ioctl,
1196         .iterate_devices = verity_iterate_devices,
1197         .io_hints       = verity_io_hints,
1198 };
1199
1200 static int __init dm_verity_init(void)
1201 {
1202         int r;
1203
1204         r = dm_register_target(&verity_target);
1205         if (r < 0)
1206                 DMERR("register failed %d", r);
1207
1208         return r;
1209 }
1210
1211 static void __exit dm_verity_exit(void)
1212 {
1213         dm_unregister_target(&verity_target);
1214 }
1215
1216 module_init(dm_verity_init);
1217 module_exit(dm_verity_exit);
1218
1219 MODULE_AUTHOR("Mikulas Patocka <mpatocka@redhat.com>");
1220 MODULE_AUTHOR("Mandeep Baines <msb@chromium.org>");
1221 MODULE_AUTHOR("Will Drewry <wad@chromium.org>");
1222 MODULE_DESCRIPTION(DM_NAME " target for transparent disk integrity checking");
1223 MODULE_LICENSE("GPL");