drivers/md/dm-verity.h

   1 /*
   2  * Copyright (C) 2012 Red Hat, Inc.
   3  * Copyright (C) 2015 Google, Inc.
   4  *
   5  * Author: Mikulas Patocka <mpatocka@redhat.com>
   6  *
   7  * Based on Chromium dm-verity driver (C) 2011 The Chromium OS Authors
   8  *
   9  * This file is released under the GPLv2.
  10  */
  11
  12 #ifndef DM_VERITY_H
  13 #define DM_VERITY_H
  14
  15 #include "dm-bufio.h"
  16 #include <linux/device-mapper.h>
  17 #include <crypto/hash.h>
  18
  19 #define DM_VERITY_MAX_LEVELS            63
  20
  21 enum verity_mode {
  22         DM_VERITY_MODE_EIO,
  23         DM_VERITY_MODE_LOGGING,
  24         DM_VERITY_MODE_RESTART
  25 };
  26
  27 enum verity_block_type {
  28         DM_VERITY_BLOCK_TYPE_DATA,
  29         DM_VERITY_BLOCK_TYPE_METADATA
  30 };
  31
  32 struct dm_verity_fec;
  33
  34 struct dm_verity {
  35         struct dm_dev *data_dev;
  36         struct dm_dev *hash_dev;
  37         struct dm_target *ti;
  38         struct dm_bufio_client *bufio;
  39         char *alg_name;
  40         struct crypto_ahash *tfm;
  41         u8 *root_digest;        /* digest of the root block */
  42         u8 *salt;               /* salt: its size is salt_size */
  43         u8 *zero_digest;        /* digest for a zero block */
  44         unsigned salt_size;
  45         sector_t data_start;    /* data offset in 512-byte sectors */
  46         sector_t hash_start;    /* hash start in blocks */
  47         sector_t data_blocks;   /* the number of data blocks */
  48         sector_t hash_blocks;   /* the number of hash blocks */
  49         unsigned char data_dev_block_bits;      /* log2(data blocksize) */
  50         unsigned char hash_dev_block_bits;      /* log2(hash blocksize) */
  51         unsigned char hash_per_block_bits;      /* log2(hashes in hash block) */
  52         unsigned char levels;   /* the number of tree levels */
  53         unsigned char version;
  54         unsigned digest_size;   /* digest size for the current hash algorithm */
  55         unsigned int ahash_reqsize;/* the size of temporary space for crypto */
  56         int hash_failed;        /* set to 1 if hash of any block failed */
  57         enum verity_mode mode;  /* mode for handling verification errors */
  58         unsigned corrupted_errs;/* Number of errors for corrupted blocks */
  59
  60         struct workqueue_struct *verify_wq;
  61
  62         /* starting blocks for each tree level. 0 is the lowest level. */
  63         sector_t hash_level_block[DM_VERITY_MAX_LEVELS];
  64
  65         struct dm_verity_fec *fec;      /* forward error correction */
  66         unsigned long *validated_blocks; /* bitset blocks validated */
  67 };
  68
  69 struct dm_verity_io {
  70         struct dm_verity *v;
  71
  72         /* original value of bio->bi_end_io */
  73         bio_end_io_t *orig_bi_end_io;
  74
  75         sector_t block;
  76         unsigned n_blocks;
  77
  78         struct bvec_iter iter;
  79
  80         struct work_struct work;
  81
  82         /*
  83          * Three variably-size fields follow this struct:
  84          *
  85          * u8 hash_req[v->ahash_reqsize];
  86          * u8 real_digest[v->digest_size];
  87          * u8 want_digest[v->digest_size];
  88          *
  89          * To access them use: verity_io_hash_req(), verity_io_real_digest()
  90          * and verity_io_want_digest().
  91          */
  92 };
  93
  94 struct verity_result {
  95         struct completion completion;
  96         int err;
  97 };
  98
  99 static inline struct ahash_request *verity_io_hash_req(struct dm_verity *v,
 100                                                      struct dm_verity_io *io)
 101 {
 102         return (struct ahash_request *)(io + 1);
 103 }
 104
 105 static inline u8 *verity_io_real_digest(struct dm_verity *v,
 106                                         struct dm_verity_io *io)
 107 {
 108         return (u8 *)(io + 1) + v->ahash_reqsize;
 109 }
 110
 111 static inline u8 *verity_io_want_digest(struct dm_verity *v,
 112                                         struct dm_verity_io *io)
 113 {
 114         return (u8 *)(io + 1) + v->ahash_reqsize + v->digest_size;
 115 }
 116
 117 static inline u8 *verity_io_digest_end(struct dm_verity *v,
 118                                        struct dm_verity_io *io)
 119 {
 120         return verity_io_want_digest(v, io) + v->digest_size;
 121 }
 122
 123 extern int verity_for_bv_block(struct dm_verity *v, struct dm_verity_io *io,
 124                                struct bvec_iter *iter,
 125                                int (*process)(struct dm_verity *v,
 126                                               struct dm_verity_io *io,
 127                                               u8 *data, size_t len));
 128
 129 extern int verity_hash(struct dm_verity *v, struct ahash_request *req,
 130                        const u8 *data, size_t len, u8 *digest);
 131
 132 extern int verity_hash_for_block(struct dm_verity *v, struct dm_verity_io *io,
 133                                  sector_t block, u8 *digest, bool *is_zero);
 134
 135 extern void verity_status(struct dm_target *ti, status_type_t type,
 136                         unsigned status_flags, char *result, unsigned maxlen);
 137 extern int verity_prepare_ioctl(struct dm_target *ti,
 138                 struct block_device **bdev, fmode_t *mode);
 139 extern int verity_iterate_devices(struct dm_target *ti,
 140                                 iterate_devices_callout_fn fn, void *data);
 141 extern void verity_io_hints(struct dm_target *ti, struct queue_limits *limits);
 142 extern void verity_dtr(struct dm_target *ti);
 143 extern int verity_ctr(struct dm_target *ti, unsigned argc, char **argv);
 144 extern int verity_map(struct dm_target *ti, struct bio *bio);
 145 extern void dm_verity_avb_error_handler(void);
 146 #endif /* DM_VERITY_H */