drivers/md/dm-crypt.c

   1 /*
   2  * Copyright (C) 2003 Jana Saout <jana@saout.de>
   3  * Copyright (C) 2004 Clemens Fruhwirth <clemens@endorphin.org>
   4  * Copyright (C) 2006-2009 Red Hat, Inc. All rights reserved.
   5  * Copyright (C) 2013 Milan Broz <gmazyland@gmail.com>
   6  *
   7  * This file is released under the GPL.
   8  */
   9
  10 #include <linux/completion.h>
  11 #include <linux/err.h>
  12 #include <linux/module.h>
  13 #include <linux/init.h>
  14 #include <linux/kernel.h>
  15 #include <linux/bio.h>
  16 #include <linux/blkdev.h>
  17 #include <linux/mempool.h>
  18 #include <linux/slab.h>
  19 #include <linux/crypto.h>
  20 #include <linux/workqueue.h>
  21 #include <linux/backing-dev.h>
  22 #include <linux/atomic.h>
  23 #include <linux/scatterlist.h>
  24 #include <asm/page.h>
  25 #include <asm/unaligned.h>
  26 #include <crypto/hash.h>
  27 #include <crypto/md5.h>
  28 #include <crypto/algapi.h>
  29
  30 #include <linux/device-mapper.h>
  31
  32 #define DM_MSG_PREFIX "crypt"
  33
  34 /*
  35  * context holding the current state of a multi-part conversion
  36  */
  37 struct convert_context {
  38         struct completion restart;
  39         struct bio *bio_in;
  40         struct bio *bio_out;
  41         struct bvec_iter iter_in;
  42         struct bvec_iter iter_out;
  43         sector_t cc_sector;
  44         atomic_t cc_pending;
  45         struct ablkcipher_request *req;
  46 };
  47
  48 /*
  49  * per bio private data
  50  */
  51 struct dm_crypt_io {
  52         struct crypt_config *cc;
  53         struct bio *base_bio;
  54         struct work_struct work;
  55
  56         struct convert_context ctx;
  57
  58         atomic_t io_pending;
  59         int error;
  60         sector_t sector;
  61 } CRYPTO_MINALIGN_ATTR;
  62
  63 struct dm_crypt_request {
  64         struct convert_context *ctx;
  65         struct scatterlist sg_in;
  66         struct scatterlist sg_out;
  67         sector_t iv_sector;
  68 };
  69
  70 struct crypt_config;
  71
  72 struct crypt_iv_operations {
  73         int (*ctr)(struct crypt_config *cc, struct dm_target *ti,
  74                    const char *opts);
  75         void (*dtr)(struct crypt_config *cc);
  76         int (*init)(struct crypt_config *cc);
  77         int (*wipe)(struct crypt_config *cc);
  78         int (*generator)(struct crypt_config *cc, u8 *iv,
  79                          struct dm_crypt_request *dmreq);
  80         int (*post)(struct crypt_config *cc, u8 *iv,
  81                     struct dm_crypt_request *dmreq);
  82 };
  83
  84 struct iv_essiv_private {
  85         struct crypto_hash *hash_tfm;
  86         u8 *salt;
  87 };
  88
  89 struct iv_benbi_private {
  90         int shift;
  91 };
  92
  93 #define LMK_SEED_SIZE 64 /* hash + 0 */
  94 struct iv_lmk_private {
  95         struct crypto_shash *hash_tfm;
  96         u8 *seed;
  97 };
  98
  99 #define TCW_WHITENING_SIZE 16
 100 struct iv_tcw_private {
 101         struct crypto_shash *crc32_tfm;
 102         u8 *iv_seed;
 103         u8 *whitening;
 104 };
 105
 106 /*
 107  * Crypt: maps a linear range of a block device
 108  * and encrypts / decrypts at the same time.
 109  */
 110 enum flags { DM_CRYPT_SUSPENDED, DM_CRYPT_KEY_VALID, DM_CRYPT_SAME_CPU };
 111
 112 /*
 113  * The fields in here must be read only after initialization.
 114  */
 115 struct crypt_config {
 116         struct dm_dev *dev;
 117         sector_t start;
 118
 119         /*
 120          * pool for per bio private data, crypto requests and
 121          * encryption requeusts/buffer pages
 122          */
 123         mempool_t *io_pool;
 124         mempool_t *req_pool;
 125         mempool_t *page_pool;
 126         struct bio_set *bs;
 127
 128         struct workqueue_struct *io_queue;
 129         struct workqueue_struct *crypt_queue;
 130
 131         char *cipher;
 132         char *cipher_string;
 133
 134         struct crypt_iv_operations *iv_gen_ops;
 135         union {
 136                 struct iv_essiv_private essiv;
 137                 struct iv_benbi_private benbi;
 138                 struct iv_lmk_private lmk;
 139                 struct iv_tcw_private tcw;
 140         } iv_gen_private;
 141         sector_t iv_offset;
 142         unsigned int iv_size;
 143
 144         /* ESSIV: struct crypto_cipher *essiv_tfm */
 145         void *iv_private;
 146         struct crypto_ablkcipher **tfms;
 147         unsigned tfms_count;
 148
 149         /*
 150          * Layout of each crypto request:
 151          *
 152          *   struct ablkcipher_request
 153          *      context
 154          *      padding
 155          *   struct dm_crypt_request
 156          *      padding
 157          *   IV
 158          *
 159          * The padding is added so that dm_crypt_request and the IV are
 160          * correctly aligned.
 161          */
 162         unsigned int dmreq_start;
 163
 164         unsigned int per_bio_data_size;
 165
 166         unsigned long flags;
 167         unsigned int key_size;
 168         unsigned int key_parts;      /* independent parts in key buffer */
 169         unsigned int key_extra_size; /* additional keys length */
 170         u8 key[0];
 171 };
 172
 173 #define MIN_IOS        16
 174
 175 static struct kmem_cache *_crypt_io_pool;
 176
 177 static void clone_init(struct dm_crypt_io *, struct bio *);
 178 static void kcryptd_queue_crypt(struct dm_crypt_io *io);
 179 static u8 *iv_of_dmreq(struct crypt_config *cc, struct dm_crypt_request *dmreq);
 180
 181 /*
 182  * Use this to access cipher attributes that are the same for each CPU.
 183  */
 184 static struct crypto_ablkcipher *any_tfm(struct crypt_config *cc)
 185 {
 186         return cc->tfms[0];
 187 }
 188
 189 /*
 190  * Different IV generation algorithms:
 191  *
 192  * plain: the initial vector is the 32-bit little-endian version of the sector
 193  *        number, padded with zeros if necessary.
 194  *
 195  * plain64: the initial vector is the 64-bit little-endian version of the sector
 196  *        number, padded with zeros if necessary.
 197  *
 198  * essiv: "encrypted sector|salt initial vector", the sector number is
 199  *        encrypted with the bulk cipher using a salt as key. The salt
 200  *        should be derived from the bulk cipher's key via hashing.
 201  *
 202  * benbi: the 64-bit "big-endian 'narrow block'-count", starting at 1
 203  *        (needed for LRW-32-AES and possible other narrow block modes)
 204  *
 205  * null: the initial vector is always zero.  Provides compatibility with
 206  *       obsolete loop_fish2 devices.  Do not use for new devices.
 207  *
 208  * lmk:  Compatible implementation of the block chaining mode used
 209  *       by the Loop-AES block device encryption system
 210  *       designed by Jari Ruusu. See http://loop-aes.sourceforge.net/
 211  *       It operates on full 512 byte sectors and uses CBC
 212  *       with an IV derived from the sector number, the data and
 213  *       optionally extra IV seed.
 214  *       This means that after decryption the first block
 215  *       of sector must be tweaked according to decrypted data.
 216  *       Loop-AES can use three encryption schemes:
 217  *         version 1: is plain aes-cbc mode
 218  *         version 2: uses 64 multikey scheme with lmk IV generator
 219  *         version 3: the same as version 2 with additional IV seed
 220  *                   (it uses 65 keys, last key is used as IV seed)
 221  *
 222  * tcw:  Compatible implementation of the block chaining mode used
 223  *       by the TrueCrypt device encryption system (prior to version 4.1).
 224  *       For more info see: http://www.truecrypt.org
 225  *       It operates on full 512 byte sectors and uses CBC
 226  *       with an IV derived from initial key and the sector number.
 227  *       In addition, whitening value is applied on every sector, whitening
 228  *       is calculated from initial key, sector number and mixed using CRC32.
 229  *       Note that this encryption scheme is vulnerable to watermarking attacks
 230  *       and should be used for old compatible containers access only.
 231  *
 232  * plumb: unimplemented, see:
 233  * http://article.gmane.org/gmane.linux.kernel.device-mapper.dm-crypt/454
 234  */
 235
 236 static int crypt_iv_plain_gen(struct crypt_config *cc, u8 *iv,
 237                               struct dm_crypt_request *dmreq)
 238 {
 239         memset(iv, 0, cc->iv_size);
 240         *(__le32 *)iv = cpu_to_le32(dmreq->iv_sector & 0xffffffff);
 241
 242         return 0;
 243 }
 244
 245 static int crypt_iv_plain64_gen(struct crypt_config *cc, u8 *iv,
 246                                 struct dm_crypt_request *dmreq)
 247 {
 248         memset(iv, 0, cc->iv_size);
 249         *(__le64 *)iv = cpu_to_le64(dmreq->iv_sector);
 250
 251         return 0;
 252 }
 253
 254 /* Initialise ESSIV - compute salt but no local memory allocations */
 255 static int crypt_iv_essiv_init(struct crypt_config *cc)
 256 {
 257         struct iv_essiv_private *essiv = &cc->iv_gen_private.essiv;
 258         struct hash_desc desc;
 259         struct scatterlist sg;
 260         struct crypto_cipher *essiv_tfm;
 261         int err;
 262
 263         sg_init_one(&sg, cc->key, cc->key_size);
 264         desc.tfm = essiv->hash_tfm;
 265         desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
 266
 267         err = crypto_hash_digest(&desc, &sg, cc->key_size, essiv->salt);
 268         if (err)
 269                 return err;
 270
 271         essiv_tfm = cc->iv_private;
 272
 273         err = crypto_cipher_setkey(essiv_tfm, essiv->salt,
 274                             crypto_hash_digestsize(essiv->hash_tfm));
 275         if (err)
 276                 return err;
 277
 278         return 0;
 279 }
 280
 281 /* Wipe salt and reset key derived from volume key */
 282 static int crypt_iv_essiv_wipe(struct crypt_config *cc)
 283 {
 284         struct iv_essiv_private *essiv = &cc->iv_gen_private.essiv;
 285         unsigned salt_size = crypto_hash_digestsize(essiv->hash_tfm);
 286         struct crypto_cipher *essiv_tfm;
 287         int r, err = 0;
 288
 289         memset(essiv->salt, 0, salt_size);
 290
 291         essiv_tfm = cc->iv_private;
 292         r = crypto_cipher_setkey(essiv_tfm, essiv->salt, salt_size);
 293         if (r)
 294                 err = r;
 295
 296         return err;
 297 }
 298
 299 /* Set up per cpu cipher state */
 300 static struct crypto_cipher *setup_essiv_cpu(struct crypt_config *cc,
 301                                              struct dm_target *ti,
 302                                              u8 *salt, unsigned saltsize)
 303 {
 304         struct crypto_cipher *essiv_tfm;
 305         int err;
 306
 307         /* Setup the essiv_tfm with the given salt */
 308         essiv_tfm = crypto_alloc_cipher(cc->cipher, 0, CRYPTO_ALG_ASYNC);
 309         if (IS_ERR(essiv_tfm)) {
 310                 ti->error = "Error allocating crypto tfm for ESSIV";
 311                 return essiv_tfm;
 312         }
 313
 314         if (crypto_cipher_blocksize(essiv_tfm) !=
 315             crypto_ablkcipher_ivsize(any_tfm(cc))) {
 316                 ti->error = "Block size of ESSIV cipher does "
 317                             "not match IV size of block cipher";
 318                 crypto_free_cipher(essiv_tfm);
 319                 return ERR_PTR(-EINVAL);
 320         }
 321
 322         err = crypto_cipher_setkey(essiv_tfm, salt, saltsize);
 323         if (err) {
 324                 ti->error = "Failed to set key for ESSIV cipher";
 325                 crypto_free_cipher(essiv_tfm);
 326                 return ERR_PTR(err);
 327         }
 328
 329         return essiv_tfm;
 330 }
 331
 332 static void crypt_iv_essiv_dtr(struct crypt_config *cc)
 333 {
 334         struct crypto_cipher *essiv_tfm;
 335         struct iv_essiv_private *essiv = &cc->iv_gen_private.essiv;
 336
 337         crypto_free_hash(essiv->hash_tfm);
 338         essiv->hash_tfm = NULL;
 339
 340         kzfree(essiv->salt);
 341         essiv->salt = NULL;
 342
 343         essiv_tfm = cc->iv_private;
 344
 345         if (essiv_tfm)
 346                 crypto_free_cipher(essiv_tfm);
 347
 348         cc->iv_private = NULL;
 349 }
 350
 351 static int crypt_iv_essiv_ctr(struct crypt_config *cc, struct dm_target *ti,
 352                               const char *opts)
 353 {
 354         struct crypto_cipher *essiv_tfm = NULL;
 355         struct crypto_hash *hash_tfm = NULL;
 356         u8 *salt = NULL;
 357         int err;
 358
 359         if (!opts) {
 360                 ti->error = "Digest algorithm missing for ESSIV mode";
 361                 return -EINVAL;
 362         }
 363
 364         /* Allocate hash algorithm */
 365         hash_tfm = crypto_alloc_hash(opts, 0, CRYPTO_ALG_ASYNC);
 366         if (IS_ERR(hash_tfm)) {
 367                 ti->error = "Error initializing ESSIV hash";
 368                 err = PTR_ERR(hash_tfm);
 369                 goto bad;
 370         }
 371
 372         salt = kzalloc(crypto_hash_digestsize(hash_tfm), GFP_KERNEL);
 373         if (!salt) {
 374                 ti->error = "Error kmallocing salt storage in ESSIV";
 375                 err = -ENOMEM;
 376                 goto bad;
 377         }
 378
 379         cc->iv_gen_private.essiv.salt = salt;
 380         cc->iv_gen_private.essiv.hash_tfm = hash_tfm;
 381
 382         essiv_tfm = setup_essiv_cpu(cc, ti, salt,
 383                                 crypto_hash_digestsize(hash_tfm));
 384         if (IS_ERR(essiv_tfm)) {
 385                 crypt_iv_essiv_dtr(cc);
 386                 return PTR_ERR(essiv_tfm);
 387         }
 388         cc->iv_private = essiv_tfm;
 389
 390         return 0;
 391
 392 bad:
 393         if (hash_tfm && !IS_ERR(hash_tfm))
 394                 crypto_free_hash(hash_tfm);
 395         kfree(salt);
 396         return err;
 397 }
 398
 399 static int crypt_iv_essiv_gen(struct crypt_config *cc, u8 *iv,
 400                               struct dm_crypt_request *dmreq)
 401 {
 402         struct crypto_cipher *essiv_tfm = cc->iv_private;
 403
 404         memset(iv, 0, cc->iv_size);
 405         *(__le64 *)iv = cpu_to_le64(dmreq->iv_sector);
 406         crypto_cipher_encrypt_one(essiv_tfm, iv, iv);
 407
 408         return 0;
 409 }
 410
 411 static int crypt_iv_benbi_ctr(struct crypt_config *cc, struct dm_target *ti,
 412                               const char *opts)
 413 {
 414         unsigned bs = crypto_ablkcipher_blocksize(any_tfm(cc));
 415         int log = ilog2(bs);
 416
 417         /* we need to calculate how far we must shift the sector count
 418          * to get the cipher block count, we use this shift in _gen */
 419
 420         if (1 << log != bs) {
 421                 ti->error = "cypher blocksize is not a power of 2";
 422                 return -EINVAL;
 423         }
 424
 425         if (log > 9) {
 426                 ti->error = "cypher blocksize is > 512";
 427                 return -EINVAL;
 428         }
 429
 430         cc->iv_gen_private.benbi.shift = 9 - log;
 431
 432         return 0;
 433 }
 434
 435 static void crypt_iv_benbi_dtr(struct crypt_config *cc)
 436 {
 437 }
 438
 439 static int crypt_iv_benbi_gen(struct crypt_config *cc, u8 *iv,
 440                               struct dm_crypt_request *dmreq)
 441 {
 442         __be64 val;
 443
 444         memset(iv, 0, cc->iv_size - sizeof(u64)); /* rest is cleared below */
 445
 446         val = cpu_to_be64(((u64)dmreq->iv_sector << cc->iv_gen_private.benbi.shift) + 1);
 447         put_unaligned(val, (__be64 *)(iv + cc->iv_size - sizeof(u64)));
 448
 449         return 0;
 450 }
 451
 452 static int crypt_iv_null_gen(struct crypt_config *cc, u8 *iv,
 453                              struct dm_crypt_request *dmreq)
 454 {
 455         memset(iv, 0, cc->iv_size);
 456
 457         return 0;
 458 }
 459
 460 static void crypt_iv_lmk_dtr(struct crypt_config *cc)
 461 {
 462         struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk;
 463
 464         if (lmk->hash_tfm && !IS_ERR(lmk->hash_tfm))
 465                 crypto_free_shash(lmk->hash_tfm);
 466         lmk->hash_tfm = NULL;
 467
 468         kzfree(lmk->seed);
 469         lmk->seed = NULL;
 470 }
 471
 472 static int crypt_iv_lmk_ctr(struct crypt_config *cc, struct dm_target *ti,
 473                             const char *opts)
 474 {
 475         struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk;
 476
 477         lmk->hash_tfm = crypto_alloc_shash("md5", 0, 0);
 478         if (IS_ERR(lmk->hash_tfm)) {
 479                 ti->error = "Error initializing LMK hash";
 480                 return PTR_ERR(lmk->hash_tfm);
 481         }
 482
 483         /* No seed in LMK version 2 */
 484         if (cc->key_parts == cc->tfms_count) {
 485                 lmk->seed = NULL;
 486                 return 0;
 487         }
 488
 489         lmk->seed = kzalloc(LMK_SEED_SIZE, GFP_KERNEL);
 490         if (!lmk->seed) {
 491                 crypt_iv_lmk_dtr(cc);
 492                 ti->error = "Error kmallocing seed storage in LMK";
 493                 return -ENOMEM;
 494         }
 495
 496         return 0;
 497 }
 498
 499 static int crypt_iv_lmk_init(struct crypt_config *cc)
 500 {
 501         struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk;
 502         int subkey_size = cc->key_size / cc->key_parts;
 503
 504         /* LMK seed is on the position of LMK_KEYS + 1 key */
 505         if (lmk->seed)
 506                 memcpy(lmk->seed, cc->key + (cc->tfms_count * subkey_size),
 507                        crypto_shash_digestsize(lmk->hash_tfm));
 508
 509         return 0;
 510 }
 511
 512 static int crypt_iv_lmk_wipe(struct crypt_config *cc)
 513 {
 514         struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk;
 515
 516         if (lmk->seed)
 517                 memset(lmk->seed, 0, LMK_SEED_SIZE);
 518
 519         return 0;
 520 }
 521
 522 static int crypt_iv_lmk_one(struct crypt_config *cc, u8 *iv,
 523                             struct dm_crypt_request *dmreq,
 524                             u8 *data)
 525 {
 526         struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk;
 527         SHASH_DESC_ON_STACK(desc, lmk->hash_tfm);
 528         struct md5_state md5state;
 529         __le32 buf[4];
 530         int i, r;
 531
 532         desc->tfm = lmk->hash_tfm;
 533         desc->flags = CRYPTO_TFM_REQ_MAY_SLEEP;
 534
 535         r = crypto_shash_init(desc);
 536         if (r)
 537                 return r;
 538
 539         if (lmk->seed) {
 540                 r = crypto_shash_update(desc, lmk->seed, LMK_SEED_SIZE);
 541                 if (r)
 542                         return r;
 543         }
 544
 545         /* Sector is always 512B, block size 16, add data of blocks 1-31 */
 546         r = crypto_shash_update(desc, data + 16, 16 * 31);
 547         if (r)
 548                 return r;
 549
 550         /* Sector is cropped to 56 bits here */
 551         buf[0] = cpu_to_le32(dmreq->iv_sector & 0xFFFFFFFF);
 552         buf[1] = cpu_to_le32((((u64)dmreq->iv_sector >> 32) & 0x00FFFFFF) | 0x80000000);
 553         buf[2] = cpu_to_le32(4024);
 554         buf[3] = 0;
 555         r = crypto_shash_update(desc, (u8 *)buf, sizeof(buf));
 556         if (r)
 557                 return r;
 558
 559         /* No MD5 padding here */
 560         r = crypto_shash_export(desc, &md5state);
 561         if (r)
 562                 return r;
 563
 564         for (i = 0; i < MD5_HASH_WORDS; i++)
 565                 __cpu_to_le32s(&md5state.hash[i]);
 566         memcpy(iv, &md5state.hash, cc->iv_size);
 567
 568         return 0;
 569 }
 570
 571 static int crypt_iv_lmk_gen(struct crypt_config *cc, u8 *iv,
 572                             struct dm_crypt_request *dmreq)
 573 {
 574         u8 *src;
 575         int r = 0;
 576
 577         if (bio_data_dir(dmreq->ctx->bio_in) == WRITE) {
 578                 src = kmap_atomic(sg_page(&dmreq->sg_in));
 579                 r = crypt_iv_lmk_one(cc, iv, dmreq, src + dmreq->sg_in.offset);
 580                 kunmap_atomic(src);
 581         } else
 582                 memset(iv, 0, cc->iv_size);
 583
 584         return r;
 585 }
 586
 587 static int crypt_iv_lmk_post(struct crypt_config *cc, u8 *iv,
 588                              struct dm_crypt_request *dmreq)
 589 {
 590         u8 *dst;
 591         int r;
 592
 593         if (bio_data_dir(dmreq->ctx->bio_in) == WRITE)
 594                 return 0;
 595
 596         dst = kmap_atomic(sg_page(&dmreq->sg_out));
 597         r = crypt_iv_lmk_one(cc, iv, dmreq, dst + dmreq->sg_out.offset);
 598
 599         /* Tweak the first block of plaintext sector */
 600         if (!r)
 601                 crypto_xor(dst + dmreq->sg_out.offset, iv, cc->iv_size);
 602
 603         kunmap_atomic(dst);
 604         return r;
 605 }
 606
 607 static void crypt_iv_tcw_dtr(struct crypt_config *cc)
 608 {
 609         struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw;
 610
 611         kzfree(tcw->iv_seed);
 612         tcw->iv_seed = NULL;
 613         kzfree(tcw->whitening);
 614         tcw->whitening = NULL;
 615
 616         if (tcw->crc32_tfm && !IS_ERR(tcw->crc32_tfm))
 617                 crypto_free_shash(tcw->crc32_tfm);
 618         tcw->crc32_tfm = NULL;
 619 }
 620
 621 static int crypt_iv_tcw_ctr(struct crypt_config *cc, struct dm_target *ti,
 622                             const char *opts)
 623 {
 624         struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw;
 625
 626         if (cc->key_size <= (cc->iv_size + TCW_WHITENING_SIZE)) {
 627                 ti->error = "Wrong key size for TCW";
 628                 return -EINVAL;
 629         }
 630
 631         tcw->crc32_tfm = crypto_alloc_shash("crc32", 0, 0);
 632         if (IS_ERR(tcw->crc32_tfm)) {
 633                 ti->error = "Error initializing CRC32 in TCW";
 634                 return PTR_ERR(tcw->crc32_tfm);
 635         }
 636
 637         tcw->iv_seed = kzalloc(cc->iv_size, GFP_KERNEL);
 638         tcw->whitening = kzalloc(TCW_WHITENING_SIZE, GFP_KERNEL);
 639         if (!tcw->iv_seed || !tcw->whitening) {
 640                 crypt_iv_tcw_dtr(cc);
 641                 ti->error = "Error allocating seed storage in TCW";
 642                 return -ENOMEM;
 643         }
 644
 645         return 0;
 646 }
 647
 648 static int crypt_iv_tcw_init(struct crypt_config *cc)
 649 {
 650         struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw;
 651         int key_offset = cc->key_size - cc->iv_size - TCW_WHITENING_SIZE;
 652
 653         memcpy(tcw->iv_seed, &cc->key[key_offset], cc->iv_size);
 654         memcpy(tcw->whitening, &cc->key[key_offset + cc->iv_size],
 655                TCW_WHITENING_SIZE);
 656
 657         return 0;
 658 }
 659
 660 static int crypt_iv_tcw_wipe(struct crypt_config *cc)
 661 {
 662         struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw;
 663
 664         memset(tcw->iv_seed, 0, cc->iv_size);
 665         memset(tcw->whitening, 0, TCW_WHITENING_SIZE);
 666
 667         return 0;
 668 }
 669
 670 static int crypt_iv_tcw_whitening(struct crypt_config *cc,
 671                                   struct dm_crypt_request *dmreq,
 672                                   u8 *data)
 673 {
 674         struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw;
 675         u64 sector = cpu_to_le64((u64)dmreq->iv_sector);
 676         u8 buf[TCW_WHITENING_SIZE];
 677         SHASH_DESC_ON_STACK(desc, tcw->crc32_tfm);
 678         int i, r;
 679
 680         /* xor whitening with sector number */
 681         memcpy(buf, tcw->whitening, TCW_WHITENING_SIZE);
 682         crypto_xor(buf, (u8 *)&sector, 8);
 683         crypto_xor(&buf[8], (u8 *)&sector, 8);
 684
 685         /* calculate crc32 for every 32bit part and xor it */
 686         desc->tfm = tcw->crc32_tfm;
 687         desc->flags = CRYPTO_TFM_REQ_MAY_SLEEP;
 688         for (i = 0; i < 4; i++) {
 689                 r = crypto_shash_init(desc);
 690                 if (r)
 691                         goto out;
 692                 r = crypto_shash_update(desc, &buf[i * 4], 4);
 693                 if (r)
 694                         goto out;
 695                 r = crypto_shash_final(desc, &buf[i * 4]);
 696                 if (r)
 697                         goto out;
 698         }
 699         crypto_xor(&buf[0], &buf[12], 4);
 700         crypto_xor(&buf[4], &buf[8], 4);
 701
 702         /* apply whitening (8 bytes) to whole sector */
 703         for (i = 0; i < ((1 << SECTOR_SHIFT) / 8); i++)
 704                 crypto_xor(data + i * 8, buf, 8);
 705 out:
 706         memzero_explicit(buf, sizeof(buf));
 707         return r;
 708 }
 709
 710 static int crypt_iv_tcw_gen(struct crypt_config *cc, u8 *iv,
 711                             struct dm_crypt_request *dmreq)
 712 {
 713         struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw;
 714         u64 sector = cpu_to_le64((u64)dmreq->iv_sector);
 715         u8 *src;
 716         int r = 0;
 717
 718         /* Remove whitening from ciphertext */
 719         if (bio_data_dir(dmreq->ctx->bio_in) != WRITE) {
 720                 src = kmap_atomic(sg_page(&dmreq->sg_in));
 721                 r = crypt_iv_tcw_whitening(cc, dmreq, src + dmreq->sg_in.offset);
 722                 kunmap_atomic(src);
 723         }
 724
 725         /* Calculate IV */
 726         memcpy(iv, tcw->iv_seed, cc->iv_size);
 727         crypto_xor(iv, (u8 *)&sector, 8);
 728         if (cc->iv_size > 8)
 729                 crypto_xor(&iv[8], (u8 *)&sector, cc->iv_size - 8);
 730
 731         return r;
 732 }
 733
 734 static int crypt_iv_tcw_post(struct crypt_config *cc, u8 *iv,
 735                              struct dm_crypt_request *dmreq)
 736 {
 737         u8 *dst;
 738         int r;
 739
 740         if (bio_data_dir(dmreq->ctx->bio_in) != WRITE)
 741                 return 0;
 742
 743         /* Apply whitening on ciphertext */
 744         dst = kmap_atomic(sg_page(&dmreq->sg_out));
 745         r = crypt_iv_tcw_whitening(cc, dmreq, dst + dmreq->sg_out.offset);
 746         kunmap_atomic(dst);
 747
 748         return r;
 749 }
 750
 751 static struct crypt_iv_operations crypt_iv_plain_ops = {
 752         .generator = crypt_iv_plain_gen
 753 };
 754
 755 static struct crypt_iv_operations crypt_iv_plain64_ops = {
 756         .generator = crypt_iv_plain64_gen
 757 };
 758
 759 static struct crypt_iv_operations crypt_iv_essiv_ops = {
 760         .ctr       = crypt_iv_essiv_ctr,
 761         .dtr       = crypt_iv_essiv_dtr,
 762         .init      = crypt_iv_essiv_init,
 763         .wipe      = crypt_iv_essiv_wipe,
 764         .generator = crypt_iv_essiv_gen
 765 };
 766
 767 static struct crypt_iv_operations crypt_iv_benbi_ops = {
 768         .ctr       = crypt_iv_benbi_ctr,
 769         .dtr       = crypt_iv_benbi_dtr,
 770         .generator = crypt_iv_benbi_gen
 771 };
 772
 773 static struct crypt_iv_operations crypt_iv_null_ops = {
 774         .generator = crypt_iv_null_gen
 775 };
 776
 777 static struct crypt_iv_operations crypt_iv_lmk_ops = {
 778         .ctr       = crypt_iv_lmk_ctr,
 779         .dtr       = crypt_iv_lmk_dtr,
 780         .init      = crypt_iv_lmk_init,
 781         .wipe      = crypt_iv_lmk_wipe,
 782         .generator = crypt_iv_lmk_gen,
 783         .post      = crypt_iv_lmk_post
 784 };
 785
 786 static struct crypt_iv_operations crypt_iv_tcw_ops = {
 787         .ctr       = crypt_iv_tcw_ctr,
 788         .dtr       = crypt_iv_tcw_dtr,
 789         .init      = crypt_iv_tcw_init,
 790         .wipe      = crypt_iv_tcw_wipe,
 791         .generator = crypt_iv_tcw_gen,
 792         .post      = crypt_iv_tcw_post
 793 };
 794
 795 static void crypt_convert_init(struct crypt_config *cc,
 796                                struct convert_context *ctx,
 797                                struct bio *bio_out, struct bio *bio_in,
 798                                sector_t sector)
 799 {
 800         ctx->bio_in = bio_in;
 801         ctx->bio_out = bio_out;
 802         if (bio_in)
 803                 ctx->iter_in = bio_in->bi_iter;
 804         if (bio_out)
 805                 ctx->iter_out = bio_out->bi_iter;
 806         ctx->cc_sector = sector + cc->iv_offset;
 807         init_completion(&ctx->restart);
 808 }
 809
 810 static struct dm_crypt_request *dmreq_of_req(struct crypt_config *cc,
 811                                              struct ablkcipher_request *req)
 812 {
 813         return (struct dm_crypt_request *)((char *)req + cc->dmreq_start);
 814 }
 815
 816 static struct ablkcipher_request *req_of_dmreq(struct crypt_config *cc,
 817                                                struct dm_crypt_request *dmreq)
 818 {
 819         return (struct ablkcipher_request *)((char *)dmreq - cc->dmreq_start);
 820 }
 821
 822 static u8 *iv_of_dmreq(struct crypt_config *cc,
 823                        struct dm_crypt_request *dmreq)
 824 {
 825         return (u8 *)ALIGN((unsigned long)(dmreq + 1),
 826                 crypto_ablkcipher_alignmask(any_tfm(cc)) + 1);
 827 }
 828
 829 static int crypt_convert_block(struct crypt_config *cc,
 830                                struct convert_context *ctx,
 831                                struct ablkcipher_request *req)
 832 {
 833         struct bio_vec bv_in = bio_iter_iovec(ctx->bio_in, ctx->iter_in);
 834         struct bio_vec bv_out = bio_iter_iovec(ctx->bio_out, ctx->iter_out);
 835         struct dm_crypt_request *dmreq;
 836         u8 *iv;
 837         int r;
 838
 839         dmreq = dmreq_of_req(cc, req);
 840         iv = iv_of_dmreq(cc, dmreq);
 841
 842         dmreq->iv_sector = ctx->cc_sector;
 843         dmreq->ctx = ctx;
 844         sg_init_table(&dmreq->sg_in, 1);
 845         sg_set_page(&dmreq->sg_in, bv_in.bv_page, 1 << SECTOR_SHIFT,
 846                     bv_in.bv_offset);
 847
 848         sg_init_table(&dmreq->sg_out, 1);
 849         sg_set_page(&dmreq->sg_out, bv_out.bv_page, 1 << SECTOR_SHIFT,
 850                     bv_out.bv_offset);
 851
 852         bio_advance_iter(ctx->bio_in, &ctx->iter_in, 1 << SECTOR_SHIFT);
 853         bio_advance_iter(ctx->bio_out, &ctx->iter_out, 1 << SECTOR_SHIFT);
 854
 855         if (cc->iv_gen_ops) {
 856                 r = cc->iv_gen_ops->generator(cc, iv, dmreq);
 857                 if (r < 0)
 858                         return r;
 859         }
 860
 861         ablkcipher_request_set_crypt(req, &dmreq->sg_in, &dmreq->sg_out,
 862                                      1 << SECTOR_SHIFT, iv);
 863
 864         if (bio_data_dir(ctx->bio_in) == WRITE)
 865                 r = crypto_ablkcipher_encrypt(req);
 866         else
 867                 r = crypto_ablkcipher_decrypt(req);
 868
 869         if (!r && cc->iv_gen_ops && cc->iv_gen_ops->post)
 870                 r = cc->iv_gen_ops->post(cc, iv, dmreq);
 871
 872         return r;
 873 }
 874
 875 static void kcryptd_async_done(struct crypto_async_request *async_req,
 876                                int error);
 877
 878 static void crypt_alloc_req(struct crypt_config *cc,
 879                             struct convert_context *ctx)
 880 {
 881         unsigned key_index = ctx->cc_sector & (cc->tfms_count - 1);
 882
 883         if (!ctx->req)
 884                 ctx->req = mempool_alloc(cc->req_pool, GFP_NOIO);
 885
 886         ablkcipher_request_set_tfm(ctx->req, cc->tfms[key_index]);
 887         ablkcipher_request_set_callback(ctx->req,
 888             CRYPTO_TFM_REQ_MAY_BACKLOG | CRYPTO_TFM_REQ_MAY_SLEEP,
 889             kcryptd_async_done, dmreq_of_req(cc, ctx->req));
 890 }
 891
 892 static void crypt_free_req(struct crypt_config *cc,
 893                            struct ablkcipher_request *req, struct bio *base_bio)
 894 {
 895         struct dm_crypt_io *io = dm_per_bio_data(base_bio, cc->per_bio_data_size);
 896
 897         if ((struct ablkcipher_request *)(io + 1) != req)
 898                 mempool_free(req, cc->req_pool);
 899 }
 900
 901 /*
 902  * Encrypt / decrypt data from one bio to another one (can be the same one)
 903  */
 904 static int crypt_convert(struct crypt_config *cc,
 905                          struct convert_context *ctx)
 906 {
 907         int r;
 908
 909         atomic_set(&ctx->cc_pending, 1);
 910
 911         while (ctx->iter_in.bi_size && ctx->iter_out.bi_size) {
 912
 913                 crypt_alloc_req(cc, ctx);
 914
 915                 atomic_inc(&ctx->cc_pending);
 916
 917                 r = crypt_convert_block(cc, ctx, ctx->req);
 918
 919                 switch (r) {
 920                 /* async */
 921                 case -EBUSY:
 922                         wait_for_completion(&ctx->restart);
 923                         reinit_completion(&ctx->restart);
 924                         /* fall through*/
 925                 case -EINPROGRESS:
 926                         ctx->req = NULL;
 927                         ctx->cc_sector++;
 928                         continue;
 929
 930                 /* sync */
 931                 case 0:
 932                         atomic_dec(&ctx->cc_pending);
 933                         ctx->cc_sector++;
 934                         cond_resched();
 935                         continue;
 936
 937                 /* error */
 938                 default:
 939                         atomic_dec(&ctx->cc_pending);
 940                         return r;
 941                 }
 942         }
 943
 944         return 0;
 945 }
 946
 947 static void crypt_free_buffer_pages(struct crypt_config *cc, struct bio *clone);
 948
 949 /*
 950  * Generate a new unfragmented bio with the given size
 951  * This should never violate the device limitations
 952  */
 953 static struct bio *crypt_alloc_buffer(struct dm_crypt_io *io, unsigned size)
 954 {
 955         struct crypt_config *cc = io->cc;
 956         struct bio *clone;
 957         unsigned int nr_iovecs = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
 958         gfp_t gfp_mask = GFP_NOIO | __GFP_HIGHMEM;
 959         unsigned i, len;
 960         struct page *page;
 961         struct bio_vec *bvec;
 962
 963         clone = bio_alloc_bioset(GFP_NOIO, nr_iovecs, cc->bs);
 964         if (!clone)
 965                 return NULL;
 966
 967         clone_init(io, clone);
 968
 969         for (i = 0; i < nr_iovecs; i++) {
 970                 page = mempool_alloc(cc->page_pool, gfp_mask);
 971
 972                 len = (size > PAGE_SIZE) ? PAGE_SIZE : size;
 973
 974                 bvec = &clone->bi_io_vec[clone->bi_vcnt++];
 975                 bvec->bv_page = page;
 976                 bvec->bv_len = len;
 977                 bvec->bv_offset = 0;
 978
 979                 clone->bi_iter.bi_size += len;
 980
 981                 size -= len;
 982         }
 983
 984         return clone;
 985 }
 986
 987 static void crypt_free_buffer_pages(struct crypt_config *cc, struct bio *clone)
 988 {
 989         unsigned int i;
 990         struct bio_vec *bv;
 991
 992         bio_for_each_segment_all(bv, clone, i) {
 993                 BUG_ON(!bv->bv_page);
 994                 mempool_free(bv->bv_page, cc->page_pool);
 995                 bv->bv_page = NULL;
 996         }
 997 }
 998
 999 static void crypt_io_init(struct dm_crypt_io *io, struct crypt_config *cc,
1000                           struct bio *bio, sector_t sector)
1001 {
1002         io->cc = cc;
1003         io->base_bio = bio;
1004         io->sector = sector;
1005         io->error = 0;
1006         io->ctx.req = NULL;
1007         atomic_set(&io->io_pending, 0);
1008 }
1009
1010 static void crypt_inc_pending(struct dm_crypt_io *io)
1011 {
1012         atomic_inc(&io->io_pending);
1013 }
1014
1015 /*
1016  * One of the bios was finished. Check for completion of
1017  * the whole request and correctly clean up the buffer.
1018  */
1019 static void crypt_dec_pending(struct dm_crypt_io *io)
1020 {
1021         struct crypt_config *cc = io->cc;
1022         struct bio *base_bio = io->base_bio;
1023         int error = io->error;
1024
1025         if (!atomic_dec_and_test(&io->io_pending))
1026                 return;
1027
1028         if (io->ctx.req)
1029                 crypt_free_req(cc, io->ctx.req, base_bio);
1030         if (io != dm_per_bio_data(base_bio, cc->per_bio_data_size))
1031                 mempool_free(io, cc->io_pool);
1032
1033         bio_endio(base_bio, error);
1034 }
1035
1036 /*
1037  * kcryptd/kcryptd_io:
1038  *
1039  * Needed because it would be very unwise to do decryption in an
1040  * interrupt context.
1041  *
1042  * kcryptd performs the actual encryption or decryption.
1043  *
1044  * kcryptd_io performs the IO submission.
1045  *
1046  * They must be separated as otherwise the final stages could be
1047  * starved by new requests which can block in the first stages due
1048  * to memory allocation.
1049  *
1050  * The work is done per CPU global for all dm-crypt instances.
1051  * They should not depend on each other and do not block.
1052  */
1053 static void crypt_endio(struct bio *clone, int error)
1054 {
1055         struct dm_crypt_io *io = clone->bi_private;
1056         struct crypt_config *cc = io->cc;
1057         unsigned rw = bio_data_dir(clone);
1058
1059         if (unlikely(!bio_flagged(clone, BIO_UPTODATE) && !error))
1060                 error = -EIO;
1061
1062         /*
1063          * free the processed pages
1064          */
1065         if (rw == WRITE)
1066                 crypt_free_buffer_pages(cc, clone);
1067
1068         bio_put(clone);
1069
1070         if (rw == READ && !error) {
1071                 kcryptd_queue_crypt(io);
1072                 return;
1073         }
1074
1075         if (unlikely(error))
1076                 io->error = error;
1077
1078         crypt_dec_pending(io);
1079 }
1080
1081 static void clone_init(struct dm_crypt_io *io, struct bio *clone)
1082 {
1083         struct crypt_config *cc = io->cc;
1084
1085         clone->bi_private = io;
1086         clone->bi_end_io  = crypt_endio;
1087         clone->bi_bdev    = cc->dev->bdev;
1088         clone->bi_rw      = io->base_bio->bi_rw;
1089 }
1090
1091 static int kcryptd_io_read(struct dm_crypt_io *io, gfp_t gfp)
1092 {
1093         struct crypt_config *cc = io->cc;
1094         struct bio *base_bio = io->base_bio;
1095         struct bio *clone;
1096
1097         /*
1098          * The block layer might modify the bvec array, so always
1099          * copy the required bvecs because we need the original
1100          * one in order to decrypt the whole bio data *afterwards*.
1101          */
1102         clone = bio_clone_bioset(base_bio, gfp, cc->bs);
1103         if (!clone)
1104                 return 1;
1105
1106         crypt_inc_pending(io);
1107
1108         clone_init(io, clone);
1109         clone->bi_iter.bi_sector = cc->start + io->sector;
1110
1111         generic_make_request(clone);
1112         return 0;
1113 }
1114
1115 static void kcryptd_io_write(struct dm_crypt_io *io)
1116 {
1117         struct bio *clone = io->ctx.bio_out;
1118         generic_make_request(clone);
1119 }
1120
1121 static void kcryptd_io(struct work_struct *work)
1122 {
1123         struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work);
1124
1125         if (bio_data_dir(io->base_bio) == READ) {
1126                 crypt_inc_pending(io);
1127                 if (kcryptd_io_read(io, GFP_NOIO))
1128                         io->error = -ENOMEM;
1129                 crypt_dec_pending(io);
1130         } else
1131                 kcryptd_io_write(io);
1132 }
1133
1134 static void kcryptd_queue_io(struct dm_crypt_io *io)
1135 {
1136         struct crypt_config *cc = io->cc;
1137
1138         INIT_WORK(&io->work, kcryptd_io);
1139         queue_work(cc->io_queue, &io->work);
1140 }
1141
1142 static void kcryptd_crypt_write_io_submit(struct dm_crypt_io *io, int async)
1143 {
1144         struct bio *clone = io->ctx.bio_out;
1145         struct crypt_config *cc = io->cc;
1146
1147         if (unlikely(io->error < 0)) {
1148                 crypt_free_buffer_pages(cc, clone);
1149                 bio_put(clone);
1150                 crypt_dec_pending(io);
1151                 return;
1152         }
1153
1154         /* crypt_convert should have filled the clone bio */
1155         BUG_ON(io->ctx.iter_out.bi_size);
1156
1157         clone->bi_iter.bi_sector = cc->start + io->sector;
1158
1159         if (async)
1160                 kcryptd_queue_io(io);
1161         else
1162                 generic_make_request(clone);
1163 }
1164
1165 static void kcryptd_crypt_write_convert(struct dm_crypt_io *io)
1166 {
1167         struct crypt_config *cc = io->cc;
1168         struct bio *clone;
1169         int crypt_finished;
1170         sector_t sector = io->sector;
1171         int r;
1172
1173         /*
1174          * Prevent io from disappearing until this function completes.
1175          */
1176         crypt_inc_pending(io);
1177         crypt_convert_init(cc, &io->ctx, NULL, io->base_bio, sector);
1178
1179         clone = crypt_alloc_buffer(io, io->base_bio->bi_iter.bi_size);
1180         if (unlikely(!clone)) {
1181                 io->error = -EIO;
1182                 goto dec;
1183         }
1184
1185         io->ctx.bio_out = clone;
1186         io->ctx.iter_out = clone->bi_iter;
1187
1188         sector += bio_sectors(clone);
1189
1190         crypt_inc_pending(io);
1191         r = crypt_convert(cc, &io->ctx);
1192         if (r)
1193                 io->error = -EIO;
1194         crypt_finished = atomic_dec_and_test(&io->ctx.cc_pending);
1195
1196         /* Encryption was already finished, submit io now */
1197         if (crypt_finished) {
1198                 kcryptd_crypt_write_io_submit(io, 0);
1199                 io->sector = sector;
1200         }
1201
1202 dec:
1203         crypt_dec_pending(io);
1204 }
1205
1206 static void kcryptd_crypt_read_done(struct dm_crypt_io *io)
1207 {
1208         crypt_dec_pending(io);
1209 }
1210
1211 static void kcryptd_crypt_read_convert(struct dm_crypt_io *io)
1212 {
1213         struct crypt_config *cc = io->cc;
1214         int r = 0;
1215
1216         crypt_inc_pending(io);
1217
1218         crypt_convert_init(cc, &io->ctx, io->base_bio, io->base_bio,
1219                            io->sector);
1220
1221         r = crypt_convert(cc, &io->ctx);
1222         if (r < 0)
1223                 io->error = -EIO;
1224
1225         if (atomic_dec_and_test(&io->ctx.cc_pending))
1226                 kcryptd_crypt_read_done(io);
1227
1228         crypt_dec_pending(io);
1229 }
1230
1231 static void kcryptd_async_done(struct crypto_async_request *async_req,
1232                                int error)
1233 {
1234         struct dm_crypt_request *dmreq = async_req->data;
1235         struct convert_context *ctx = dmreq->ctx;
1236         struct dm_crypt_io *io = container_of(ctx, struct dm_crypt_io, ctx);
1237         struct crypt_config *cc = io->cc;
1238
1239         if (error == -EINPROGRESS) {
1240                 complete(&ctx->restart);
1241                 return;
1242         }
1243
1244         if (!error && cc->iv_gen_ops && cc->iv_gen_ops->post)
1245                 error = cc->iv_gen_ops->post(cc, iv_of_dmreq(cc, dmreq), dmreq);
1246
1247         if (error < 0)
1248                 io->error = -EIO;
1249
1250         crypt_free_req(cc, req_of_dmreq(cc, dmreq), io->base_bio);
1251
1252         if (!atomic_dec_and_test(&ctx->cc_pending))
1253                 return;
1254
1255         if (bio_data_dir(io->base_bio) == READ)
1256                 kcryptd_crypt_read_done(io);
1257         else
1258                 kcryptd_crypt_write_io_submit(io, 1);
1259 }
1260
1261 static void kcryptd_crypt(struct work_struct *work)
1262 {
1263         struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work);
1264
1265         if (bio_data_dir(io->base_bio) == READ)
1266                 kcryptd_crypt_read_convert(io);
1267         else
1268                 kcryptd_crypt_write_convert(io);
1269 }
1270
1271 static void kcryptd_queue_crypt(struct dm_crypt_io *io)
1272 {
1273         struct crypt_config *cc = io->cc;
1274
1275         INIT_WORK(&io->work, kcryptd_crypt);
1276         queue_work(cc->crypt_queue, &io->work);
1277 }
1278
1279 /*
1280  * Decode key from its hex representation
1281  */
1282 static int crypt_decode_key(u8 *key, char *hex, unsigned int size)
1283 {
1284         char buffer[3];
1285         unsigned int i;
1286
1287         buffer[2] = '\0';
1288
1289         for (i = 0; i < size; i++) {
1290                 buffer[0] = *hex++;
1291                 buffer[1] = *hex++;
1292
1293                 if (kstrtou8(buffer, 16, &key[i]))
1294                         return -EINVAL;
1295         }
1296
1297         if (*hex != '\0')
1298                 return -EINVAL;
1299
1300         return 0;
1301 }
1302
1303 static void crypt_free_tfms(struct crypt_config *cc)
1304 {
1305         unsigned i;
1306
1307         if (!cc->tfms)
1308                 return;
1309
1310         for (i = 0; i < cc->tfms_count; i++)
1311                 if (cc->tfms[i] && !IS_ERR(cc->tfms[i])) {
1312                         crypto_free_ablkcipher(cc->tfms[i]);
1313                         cc->tfms[i] = NULL;
1314                 }
1315
1316         kfree(cc->tfms);
1317         cc->tfms = NULL;
1318 }
1319
1320 static int crypt_alloc_tfms(struct crypt_config *cc, char *ciphermode)
1321 {
1322         unsigned i;
1323         int err;
1324
1325         cc->tfms = kmalloc(cc->tfms_count * sizeof(struct crypto_ablkcipher *),
1326                            GFP_KERNEL);
1327         if (!cc->tfms)
1328                 return -ENOMEM;
1329
1330         for (i = 0; i < cc->tfms_count; i++) {
1331                 cc->tfms[i] = crypto_alloc_ablkcipher(ciphermode, 0, 0);
1332                 if (IS_ERR(cc->tfms[i])) {
1333                         err = PTR_ERR(cc->tfms[i]);
1334                         crypt_free_tfms(cc);
1335                         return err;
1336                 }
1337         }
1338
1339         return 0;
1340 }
1341
1342 static int crypt_setkey_allcpus(struct crypt_config *cc)
1343 {
1344         unsigned subkey_size;
1345         int err = 0, i, r;
1346
1347         /* Ignore extra keys (which are used for IV etc) */
1348         subkey_size = (cc->key_size - cc->key_extra_size) >> ilog2(cc->tfms_count);
1349
1350         for (i = 0; i < cc->tfms_count; i++) {
1351                 r = crypto_ablkcipher_setkey(cc->tfms[i],
1352                                              cc->key + (i * subkey_size),
1353                                              subkey_size);
1354                 if (r)
1355                         err = r;
1356         }
1357
1358         return err;
1359 }
1360
1361 static int crypt_set_key(struct crypt_config *cc, char *key)
1362 {
1363         int r = -EINVAL;
1364         int key_string_len = strlen(key);
1365
1366         /* The key size may not be changed. */
1367         if (cc->key_size != (key_string_len >> 1))
1368                 goto out;
1369
1370         /* Hyphen (which gives a key_size of zero) means there is no key. */
1371         if (!cc->key_size && strcmp(key, "-"))
1372                 goto out;
1373
1374         if (cc->key_size && crypt_decode_key(cc->key, key, cc->key_size) < 0)
1375                 goto out;
1376
1377         set_bit(DM_CRYPT_KEY_VALID, &cc->flags);
1378
1379         r = crypt_setkey_allcpus(cc);
1380
1381 out:
1382         /* Hex key string not needed after here, so wipe it. */
1383         memset(key, '0', key_string_len);
1384
1385         return r;
1386 }
1387
1388 static int crypt_wipe_key(struct crypt_config *cc)
1389 {
1390         clear_bit(DM_CRYPT_KEY_VALID, &cc->flags);
1391         memset(&cc->key, 0, cc->key_size * sizeof(u8));
1392
1393         return crypt_setkey_allcpus(cc);
1394 }
1395
1396 static void crypt_dtr(struct dm_target *ti)
1397 {
1398         struct crypt_config *cc = ti->private;
1399
1400         ti->private = NULL;
1401
1402         if (!cc)
1403                 return;
1404
1405         if (cc->io_queue)
1406                 destroy_workqueue(cc->io_queue);
1407         if (cc->crypt_queue)
1408                 destroy_workqueue(cc->crypt_queue);
1409
1410         crypt_free_tfms(cc);
1411
1412         if (cc->bs)
1413                 bioset_free(cc->bs);
1414
1415         if (cc->page_pool)
1416                 mempool_destroy(cc->page_pool);
1417         if (cc->req_pool)
1418                 mempool_destroy(cc->req_pool);
1419         if (cc->io_pool)
1420                 mempool_destroy(cc->io_pool);
1421
1422         if (cc->iv_gen_ops && cc->iv_gen_ops->dtr)
1423                 cc->iv_gen_ops->dtr(cc);
1424
1425         if (cc->dev)
1426                 dm_put_device(ti, cc->dev);
1427
1428         kzfree(cc->cipher);
1429         kzfree(cc->cipher_string);
1430
1431         /* Must zero key material before freeing */
1432         kzfree(cc);
1433 }
1434
1435 static int crypt_ctr_cipher(struct dm_target *ti,
1436                             char *cipher_in, char *key)
1437 {
1438         struct crypt_config *cc = ti->private;
1439         char *tmp, *cipher, *chainmode, *ivmode, *ivopts, *keycount;
1440         char *cipher_api = NULL;
1441         int ret = -EINVAL;
1442         char dummy;
1443
1444         /* Convert to crypto api definition? */
1445         if (strchr(cipher_in, '(')) {
1446                 ti->error = "Bad cipher specification";
1447                 return -EINVAL;
1448         }
1449
1450         cc->cipher_string = kstrdup(cipher_in, GFP_KERNEL);
1451         if (!cc->cipher_string)
1452                 goto bad_mem;
1453
1454         /*
1455          * Legacy dm-crypt cipher specification
1456          * cipher[:keycount]-mode-iv:ivopts
1457          */
1458         tmp = cipher_in;
1459         keycount = strsep(&tmp, "-");
1460         cipher = strsep(&keycount, ":");
1461
1462         if (!keycount)
1463                 cc->tfms_count = 1;
1464         else if (sscanf(keycount, "%u%c", &cc->tfms_count, &dummy) != 1 ||
1465                  !is_power_of_2(cc->tfms_count)) {
1466                 ti->error = "Bad cipher key count specification";
1467                 return -EINVAL;
1468         }
1469         cc->key_parts = cc->tfms_count;
1470         cc->key_extra_size = 0;
1471
1472         cc->cipher = kstrdup(cipher, GFP_KERNEL);
1473         if (!cc->cipher)
1474                 goto bad_mem;
1475
1476         chainmode = strsep(&tmp, "-");
1477         ivopts = strsep(&tmp, "-");
1478         ivmode = strsep(&ivopts, ":");
1479
1480         if (tmp)
1481                 DMWARN("Ignoring unexpected additional cipher options");
1482
1483         /*
1484          * For compatibility with the original dm-crypt mapping format, if
1485          * only the cipher name is supplied, use cbc-plain.
1486          */
1487         if (!chainmode || (!strcmp(chainmode, "plain") && !ivmode)) {
1488                 chainmode = "cbc";
1489                 ivmode = "plain";
1490         }
1491
1492         if (strcmp(chainmode, "ecb") && !ivmode) {
1493                 ti->error = "IV mechanism required";
1494                 return -EINVAL;
1495         }
1496
1497         cipher_api = kmalloc(CRYPTO_MAX_ALG_NAME, GFP_KERNEL);
1498         if (!cipher_api)
1499                 goto bad_mem;
1500
1501         ret = snprintf(cipher_api, CRYPTO_MAX_ALG_NAME,
1502                        "%s(%s)", chainmode, cipher);
1503         if (ret < 0) {
1504                 kfree(cipher_api);
1505                 goto bad_mem;
1506         }
1507
1508         /* Allocate cipher */
1509         ret = crypt_alloc_tfms(cc, cipher_api);
1510         if (ret < 0) {
1511                 ti->error = "Error allocating crypto tfm";
1512                 goto bad;
1513         }
1514
1515         /* Initialize IV */
1516         cc->iv_size = crypto_ablkcipher_ivsize(any_tfm(cc));
1517         if (cc->iv_size)
1518                 /* at least a 64 bit sector number should fit in our buffer */
1519                 cc->iv_size = max(cc->iv_size,
1520                                   (unsigned int)(sizeof(u64) / sizeof(u8)));
1521         else if (ivmode) {
1522                 DMWARN("Selected cipher does not support IVs");
1523                 ivmode = NULL;
1524         }
1525
1526         /* Choose ivmode, see comments at iv code. */
1527         if (ivmode == NULL)
1528                 cc->iv_gen_ops = NULL;
1529         else if (strcmp(ivmode, "plain") == 0)
1530                 cc->iv_gen_ops = &crypt_iv_plain_ops;
1531         else if (strcmp(ivmode, "plain64") == 0)
1532                 cc->iv_gen_ops = &crypt_iv_plain64_ops;
1533         else if (strcmp(ivmode, "essiv") == 0)
1534                 cc->iv_gen_ops = &crypt_iv_essiv_ops;
1535         else if (strcmp(ivmode, "benbi") == 0)
1536                 cc->iv_gen_ops = &crypt_iv_benbi_ops;
1537         else if (strcmp(ivmode, "null") == 0)
1538                 cc->iv_gen_ops = &crypt_iv_null_ops;
1539         else if (strcmp(ivmode, "lmk") == 0) {
1540                 cc->iv_gen_ops = &crypt_iv_lmk_ops;
1541                 /*
1542                  * Version 2 and 3 is recognised according
1543                  * to length of provided multi-key string.
1544                  * If present (version 3), last key is used as IV seed.
1545                  * All keys (including IV seed) are always the same size.
1546                  */
1547                 if (cc->key_size % cc->key_parts) {
1548                         cc->key_parts++;
1549                         cc->key_extra_size = cc->key_size / cc->key_parts;
1550                 }
1551         } else if (strcmp(ivmode, "tcw") == 0) {
1552                 cc->iv_gen_ops = &crypt_iv_tcw_ops;
1553                 cc->key_parts += 2; /* IV + whitening */
1554                 cc->key_extra_size = cc->iv_size + TCW_WHITENING_SIZE;
1555         } else {
1556                 ret = -EINVAL;
1557                 ti->error = "Invalid IV mode";
1558                 goto bad;
1559         }
1560
1561         /* Initialize and set key */
1562         ret = crypt_set_key(cc, key);
1563         if (ret < 0) {
1564                 ti->error = "Error decoding and setting key";
1565                 goto bad;
1566         }
1567
1568         /* Allocate IV */
1569         if (cc->iv_gen_ops && cc->iv_gen_ops->ctr) {
1570                 ret = cc->iv_gen_ops->ctr(cc, ti, ivopts);
1571                 if (ret < 0) {
1572                         ti->error = "Error creating IV";
1573                         goto bad;
1574                 }
1575         }
1576
1577         /* Initialize IV (set keys for ESSIV etc) */
1578         if (cc->iv_gen_ops && cc->iv_gen_ops->init) {
1579                 ret = cc->iv_gen_ops->init(cc);
1580                 if (ret < 0) {
1581                         ti->error = "Error initialising IV";
1582                         goto bad;
1583                 }
1584         }
1585
1586         ret = 0;
1587 bad:
1588         kfree(cipher_api);
1589         return ret;
1590
1591 bad_mem:
1592         ti->error = "Cannot allocate cipher strings";
1593         return -ENOMEM;
1594 }
1595
1596 /*
1597  * Construct an encryption mapping:
1598  * <cipher> <key> <iv_offset> <dev_path> <start>
1599  */
1600 static int crypt_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1601 {
1602         struct crypt_config *cc;
1603         unsigned int key_size, opt_params;
1604         unsigned long long tmpll;
1605         int ret;
1606         size_t iv_size_padding;
1607         struct dm_arg_set as;
1608         const char *opt_string;
1609         char dummy;
1610
1611         static struct dm_arg _args[] = {
1612                 {0, 2, "Invalid number of feature args"},
1613         };
1614
1615         if (argc < 5) {
1616                 ti->error = "Not enough arguments";
1617                 return -EINVAL;
1618         }
1619
1620         key_size = strlen(argv[1]) >> 1;
1621
1622         cc = kzalloc(sizeof(*cc) + key_size * sizeof(u8), GFP_KERNEL);
1623         if (!cc) {
1624                 ti->error = "Cannot allocate encryption context";
1625                 return -ENOMEM;
1626         }
1627         cc->key_size = key_size;
1628
1629         ti->private = cc;
1630         ret = crypt_ctr_cipher(ti, argv[0], argv[1]);
1631         if (ret < 0)
1632                 goto bad;
1633
1634         ret = -ENOMEM;
1635         cc->io_pool = mempool_create_slab_pool(MIN_IOS, _crypt_io_pool);
1636         if (!cc->io_pool) {
1637                 ti->error = "Cannot allocate crypt io mempool";
1638                 goto bad;
1639         }
1640
1641         cc->dmreq_start = sizeof(struct ablkcipher_request);
1642         cc->dmreq_start += crypto_ablkcipher_reqsize(any_tfm(cc));
1643         cc->dmreq_start = ALIGN(cc->dmreq_start, __alignof__(struct dm_crypt_request));
1644
1645         if (crypto_ablkcipher_alignmask(any_tfm(cc)) < CRYPTO_MINALIGN) {
1646                 /* Allocate the padding exactly */
1647                 iv_size_padding = -(cc->dmreq_start + sizeof(struct dm_crypt_request))
1648                                 & crypto_ablkcipher_alignmask(any_tfm(cc));
1649         } else {
1650                 /*
1651                  * If the cipher requires greater alignment than kmalloc
1652                  * alignment, we don't know the exact position of the
1653                  * initialization vector. We must assume worst case.
1654                  */
1655                 iv_size_padding = crypto_ablkcipher_alignmask(any_tfm(cc));
1656         }
1657
1658         cc->req_pool = mempool_create_kmalloc_pool(MIN_IOS, cc->dmreq_start +
1659                         sizeof(struct dm_crypt_request) + iv_size_padding + cc->iv_size);
1660         if (!cc->req_pool) {
1661                 ti->error = "Cannot allocate crypt request mempool";
1662                 goto bad;
1663         }
1664
1665         cc->per_bio_data_size = ti->per_bio_data_size =
1666                 ALIGN(sizeof(struct dm_crypt_io) + cc->dmreq_start +
1667                       sizeof(struct dm_crypt_request) + iv_size_padding + cc->iv_size,
1668                       ARCH_KMALLOC_MINALIGN);
1669
1670         cc->page_pool = mempool_create_page_pool(BIO_MAX_PAGES, 0);
1671         if (!cc->page_pool) {
1672                 ti->error = "Cannot allocate page mempool";
1673                 goto bad;
1674         }
1675
1676         cc->bs = bioset_create(MIN_IOS, 0);
1677         if (!cc->bs) {
1678                 ti->error = "Cannot allocate crypt bioset";
1679                 goto bad;
1680         }
1681
1682         ret = -EINVAL;
1683         if (sscanf(argv[2], "%llu%c", &tmpll, &dummy) != 1) {
1684                 ti->error = "Invalid iv_offset sector";
1685                 goto bad;
1686         }
1687         cc->iv_offset = tmpll;
1688
1689         if (dm_get_device(ti, argv[3], dm_table_get_mode(ti->table), &cc->dev)) {
1690                 ti->error = "Device lookup failed";
1691                 goto bad;
1692         }
1693
1694         if (sscanf(argv[4], "%llu%c", &tmpll, &dummy) != 1) {
1695                 ti->error = "Invalid device sector";
1696                 goto bad;
1697         }
1698         cc->start = tmpll;
1699
1700         argv += 5;
1701         argc -= 5;
1702
1703         /* Optional parameters */
1704         if (argc) {
1705                 as.argc = argc;
1706                 as.argv = argv;
1707
1708                 ret = dm_read_arg_group(_args, &as, &opt_params, &ti->error);
1709                 if (ret)
1710                         goto bad;
1711
1712                 while (opt_params--) {
1713                         opt_string = dm_shift_arg(&as);
1714                         if (!opt_string) {
1715                                 ti->error = "Not enough feature arguments";
1716                                 goto bad;
1717                         }
1718
1719                         if (!strcasecmp(opt_string, "allow_discards"))
1720                                 ti->num_discard_bios = 1;
1721
1722                         else if (!strcasecmp(opt_string, "same_cpu_crypt"))
1723                                 set_bit(DM_CRYPT_SAME_CPU, &cc->flags);
1724
1725                         else {
1726                                 ti->error = "Invalid feature arguments";
1727                                 goto bad;
1728                         }
1729                 }
1730         }
1731
1732         ret = -ENOMEM;
1733         cc->io_queue = alloc_workqueue("kcryptd_io", WQ_MEM_RECLAIM, 1);
1734         if (!cc->io_queue) {
1735                 ti->error = "Couldn't create kcryptd io queue";
1736                 goto bad;
1737         }
1738
1739         if (test_bit(DM_CRYPT_SAME_CPU, &cc->flags))
1740                 cc->crypt_queue = alloc_workqueue("kcryptd", WQ_CPU_INTENSIVE | WQ_MEM_RECLAIM, 1);
1741         else
1742                 cc->crypt_queue = alloc_workqueue("kcryptd", WQ_CPU_INTENSIVE | WQ_MEM_RECLAIM | WQ_UNBOUND,
1743                                                   num_online_cpus());
1744         if (!cc->crypt_queue) {
1745                 ti->error = "Couldn't create kcryptd queue";
1746                 goto bad;
1747         }
1748
1749         ti->num_flush_bios = 1;
1750         ti->discard_zeroes_data_unsupported = true;
1751
1752         return 0;
1753
1754 bad:
1755         crypt_dtr(ti);
1756         return ret;
1757 }
1758
1759 static int crypt_map(struct dm_target *ti, struct bio *bio)
1760 {
1761         struct dm_crypt_io *io;
1762         struct crypt_config *cc = ti->private;
1763
1764         /*
1765          * If bio is REQ_FLUSH or REQ_DISCARD, just bypass crypt queues.
1766          * - for REQ_FLUSH device-mapper core ensures that no IO is in-flight
1767          * - for REQ_DISCARD caller must use flush if IO ordering matters
1768          */
1769         if (unlikely(bio->bi_rw & (REQ_FLUSH | REQ_DISCARD))) {
1770                 bio->bi_bdev = cc->dev->bdev;
1771                 if (bio_sectors(bio))
1772                         bio->bi_iter.bi_sector = cc->start +
1773                                 dm_target_offset(ti, bio->bi_iter.bi_sector);
1774                 return DM_MAPIO_REMAPPED;
1775         }
1776
1777         io = dm_per_bio_data(bio, cc->per_bio_data_size);
1778         crypt_io_init(io, cc, bio, dm_target_offset(ti, bio->bi_iter.bi_sector));
1779         io->ctx.req = (struct ablkcipher_request *)(io + 1);
1780
1781         if (bio_data_dir(io->base_bio) == READ) {
1782                 if (kcryptd_io_read(io, GFP_NOWAIT))
1783                         kcryptd_queue_io(io);
1784         } else
1785                 kcryptd_queue_crypt(io);
1786
1787         return DM_MAPIO_SUBMITTED;
1788 }
1789
1790 static void crypt_status(struct dm_target *ti, status_type_t type,
1791                          unsigned status_flags, char *result, unsigned maxlen)
1792 {
1793         struct crypt_config *cc = ti->private;
1794         unsigned i, sz = 0;
1795         int num_feature_args = 0;
1796
1797         switch (type) {
1798         case STATUSTYPE_INFO:
1799                 result[0] = '\0';
1800                 break;
1801
1802         case STATUSTYPE_TABLE:
1803                 DMEMIT("%s ", cc->cipher_string);
1804
1805                 if (cc->key_size > 0)
1806                         for (i = 0; i < cc->key_size; i++)
1807                                 DMEMIT("%02x", cc->key[i]);
1808                 else
1809                         DMEMIT("-");
1810
1811                 DMEMIT(" %llu %s %llu", (unsigned long long)cc->iv_offset,
1812                                 cc->dev->name, (unsigned long long)cc->start);
1813
1814                 num_feature_args += !!ti->num_discard_bios;
1815                 num_feature_args += test_bit(DM_CRYPT_SAME_CPU, &cc->flags);
1816                 if (num_feature_args) {
1817                         DMEMIT(" %d", num_feature_args);
1818                         if (ti->num_discard_bios)
1819                                 DMEMIT(" allow_discards");
1820                         if (test_bit(DM_CRYPT_SAME_CPU, &cc->flags))
1821                                 DMEMIT(" same_cpu_crypt");
1822                 }
1823
1824                 break;
1825         }
1826 }
1827
1828 static void crypt_postsuspend(struct dm_target *ti)
1829 {
1830         struct crypt_config *cc = ti->private;
1831
1832         set_bit(DM_CRYPT_SUSPENDED, &cc->flags);
1833 }
1834
1835 static int crypt_preresume(struct dm_target *ti)
1836 {
1837         struct crypt_config *cc = ti->private;
1838
1839         if (!test_bit(DM_CRYPT_KEY_VALID, &cc->flags)) {
1840                 DMERR("aborting resume - crypt key is not set.");
1841                 return -EAGAIN;
1842         }
1843
1844         return 0;
1845 }
1846
1847 static void crypt_resume(struct dm_target *ti)
1848 {
1849         struct crypt_config *cc = ti->private;
1850
1851         clear_bit(DM_CRYPT_SUSPENDED, &cc->flags);
1852 }
1853
1854 /* Message interface
1855  *      key set <key>
1856  *      key wipe
1857  */
1858 static int crypt_message(struct dm_target *ti, unsigned argc, char **argv)
1859 {
1860         struct crypt_config *cc = ti->private;
1861         int ret = -EINVAL;
1862
1863         if (argc < 2)
1864                 goto error;
1865
1866         if (!strcasecmp(argv[0], "key")) {
1867                 if (!test_bit(DM_CRYPT_SUSPENDED, &cc->flags)) {
1868                         DMWARN("not suspended during key manipulation.");
1869                         return -EINVAL;
1870                 }
1871                 if (argc == 3 && !strcasecmp(argv[1], "set")) {
1872                         ret = crypt_set_key(cc, argv[2]);
1873                         if (ret)
1874                                 return ret;
1875                         if (cc->iv_gen_ops && cc->iv_gen_ops->init)
1876                                 ret = cc->iv_gen_ops->init(cc);
1877                         return ret;
1878                 }
1879                 if (argc == 2 && !strcasecmp(argv[1], "wipe")) {
1880                         if (cc->iv_gen_ops && cc->iv_gen_ops->wipe) {
1881                                 ret = cc->iv_gen_ops->wipe(cc);
1882                                 if (ret)
1883                                         return ret;
1884                         }
1885                         return crypt_wipe_key(cc);
1886                 }
1887         }
1888
1889 error:
1890         DMWARN("unrecognised message received.");
1891         return -EINVAL;
1892 }
1893
1894 static int crypt_merge(struct dm_target *ti, struct bvec_merge_data *bvm,
1895                        struct bio_vec *biovec, int max_size)
1896 {
1897         struct crypt_config *cc = ti->private;
1898         struct request_queue *q = bdev_get_queue(cc->dev->bdev);
1899
1900         if (!q->merge_bvec_fn)
1901                 return max_size;
1902
1903         bvm->bi_bdev = cc->dev->bdev;
1904         bvm->bi_sector = cc->start + dm_target_offset(ti, bvm->bi_sector);
1905
1906         return min(max_size, q->merge_bvec_fn(q, bvm, biovec));
1907 }
1908
1909 static int crypt_iterate_devices(struct dm_target *ti,
1910                                  iterate_devices_callout_fn fn, void *data)
1911 {
1912         struct crypt_config *cc = ti->private;
1913
1914         return fn(ti, cc->dev, cc->start, ti->len, data);
1915 }
1916
1917 static struct target_type crypt_target = {
1918         .name   = "crypt",
1919         .version = {1, 14, 0},
1920         .module = THIS_MODULE,
1921         .ctr    = crypt_ctr,
1922         .dtr    = crypt_dtr,
1923         .map    = crypt_map,
1924         .status = crypt_status,
1925         .postsuspend = crypt_postsuspend,
1926         .preresume = crypt_preresume,
1927         .resume = crypt_resume,
1928         .message = crypt_message,
1929         .merge  = crypt_merge,
1930         .iterate_devices = crypt_iterate_devices,
1931 };
1932
1933 static int __init dm_crypt_init(void)
1934 {
1935         int r;
1936
1937         _crypt_io_pool = KMEM_CACHE(dm_crypt_io, 0);
1938         if (!_crypt_io_pool)
1939                 return -ENOMEM;
1940
1941         r = dm_register_target(&crypt_target);
1942         if (r < 0) {
1943                 DMERR("register failed %d", r);
1944                 kmem_cache_destroy(_crypt_io_pool);
1945         }
1946
1947         return r;
1948 }
1949
1950 static void __exit dm_crypt_exit(void)
1951 {
1952         dm_unregister_target(&crypt_target);
1953         kmem_cache_destroy(_crypt_io_pool);
1954 }
1955
1956 module_init(dm_crypt_init);
1957 module_exit(dm_crypt_exit);
1958
1959 MODULE_AUTHOR("Jana Saout <jana@saout.de>");
1960 MODULE_DESCRIPTION(DM_NAME " target for transparent encryption / decryption");
1961 MODULE_LICENSE("GPL");