drivers/md/dm-crypt.c

   1 /*
   2  * Copyright (C) 2003 Christophe Saout <christophe@saout.de>
   3  * Copyright (C) 2004 Clemens Fruhwirth <clemens@endorphin.org>
   4  * Copyright (C) 2006-2008 Red Hat, Inc. All rights reserved.
   5  *
   6  * This file is released under the GPL.
   7  */
   8
   9 #include <linux/completion.h>
  10 #include <linux/err.h>
  11 #include <linux/module.h>
  12 #include <linux/init.h>
  13 #include <linux/kernel.h>
  14 #include <linux/bio.h>
  15 #include <linux/blkdev.h>
  16 #include <linux/mempool.h>
  17 #include <linux/slab.h>
  18 #include <linux/crypto.h>
  19 #include <linux/workqueue.h>
  20 #include <linux/backing-dev.h>
  21 #include <asm/atomic.h>
  22 #include <linux/scatterlist.h>
  23 #include <asm/page.h>
  24 #include <asm/unaligned.h>
  25
  26 #include "dm.h"
  27
  28 #define DM_MSG_PREFIX "crypt"
  29 #define MESG_STR(x) x, sizeof(x)
  30
  31 /*
  32  * context holding the current state of a multi-part conversion
  33  */
  34 struct convert_context {
  35         struct completion restart;
  36         struct bio *bio_in;
  37         struct bio *bio_out;
  38         unsigned int offset_in;
  39         unsigned int offset_out;
  40         unsigned int idx_in;
  41         unsigned int idx_out;
  42         sector_t sector;
  43         atomic_t pending;
  44 };
  45
  46 /*
  47  * per bio private data
  48  */
  49 struct dm_crypt_io {
  50         struct dm_target *target;
  51         struct bio *base_bio;
  52         struct work_struct work;
  53
  54         struct convert_context ctx;
  55
  56         atomic_t pending;
  57         int error;
  58         sector_t sector;
  59 };
  60
  61 struct dm_crypt_request {
  62         struct scatterlist sg_in;
  63         struct scatterlist sg_out;
  64 };
  65
  66 struct crypt_config;
  67
  68 struct crypt_iv_operations {
  69         int (*ctr)(struct crypt_config *cc, struct dm_target *ti,
  70                    const char *opts);
  71         void (*dtr)(struct crypt_config *cc);
  72         const char *(*status)(struct crypt_config *cc);
  73         int (*generator)(struct crypt_config *cc, u8 *iv, sector_t sector);
  74 };
  75
  76 /*
  77  * Crypt: maps a linear range of a block device
  78  * and encrypts / decrypts at the same time.
  79  */
  80 enum flags { DM_CRYPT_SUSPENDED, DM_CRYPT_KEY_VALID };
  81 struct crypt_config {
  82         struct dm_dev *dev;
  83         sector_t start;
  84
  85         /*
  86          * pool for per bio private data, crypto requests and
  87          * encryption requeusts/buffer pages
  88          */
  89         mempool_t *io_pool;
  90         mempool_t *req_pool;
  91         mempool_t *page_pool;
  92         struct bio_set *bs;
  93
  94         struct workqueue_struct *io_queue;
  95         struct workqueue_struct *crypt_queue;
  96         wait_queue_head_t writeq;
  97
  98         /*
  99          * crypto related data
 100          */
 101         struct crypt_iv_operations *iv_gen_ops;
 102         char *iv_mode;
 103         union {
 104                 struct crypto_cipher *essiv_tfm;
 105                 int benbi_shift;
 106         } iv_gen_private;
 107         sector_t iv_offset;
 108         unsigned int iv_size;
 109
 110         /*
 111          * Layout of each crypto request:
 112          *
 113          *   struct ablkcipher_request
 114          *      context
 115          *      padding
 116          *   struct dm_crypt_request
 117          *      padding
 118          *   IV
 119          *
 120          * The padding is added so that dm_crypt_request and the IV are
 121          * correctly aligned.
 122          */
 123         unsigned int dmreq_start;
 124         struct ablkcipher_request *req;
 125
 126         char cipher[CRYPTO_MAX_ALG_NAME];
 127         char chainmode[CRYPTO_MAX_ALG_NAME];
 128         struct crypto_ablkcipher *tfm;
 129         unsigned long flags;
 130         unsigned int key_size;
 131         u8 key[0];
 132 };
 133
 134 #define MIN_IOS        16
 135 #define MIN_POOL_PAGES 32
 136 #define MIN_BIO_PAGES  8
 137
 138 static struct kmem_cache *_crypt_io_pool;
 139
 140 static void clone_init(struct dm_crypt_io *, struct bio *);
 141 static void kcryptd_queue_crypt(struct dm_crypt_io *io);
 142
 143 /*
 144  * Different IV generation algorithms:
 145  *
 146  * plain: the initial vector is the 32-bit little-endian version of the sector
 147  *        number, padded with zeros if necessary.
 148  *
 149  * essiv: "encrypted sector|salt initial vector", the sector number is
 150  *        encrypted with the bulk cipher using a salt as key. The salt
 151  *        should be derived from the bulk cipher's key via hashing.
 152  *
 153  * benbi: the 64-bit "big-endian 'narrow block'-count", starting at 1
 154  *        (needed for LRW-32-AES and possible other narrow block modes)
 155  *
 156  * null: the initial vector is always zero.  Provides compatibility with
 157  *       obsolete loop_fish2 devices.  Do not use for new devices.
 158  *
 159  * plumb: unimplemented, see:
 160  * http://article.gmane.org/gmane.linux.kernel.device-mapper.dm-crypt/454
 161  */
 162
 163 static int crypt_iv_plain_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 164 {
 165         memset(iv, 0, cc->iv_size);
 166         *(u32 *)iv = cpu_to_le32(sector & 0xffffffff);
 167
 168         return 0;
 169 }
 170
 171 static int crypt_iv_essiv_ctr(struct crypt_config *cc, struct dm_target *ti,
 172                               const char *opts)
 173 {
 174         struct crypto_cipher *essiv_tfm;
 175         struct crypto_hash *hash_tfm;
 176         struct hash_desc desc;
 177         struct scatterlist sg;
 178         unsigned int saltsize;
 179         u8 *salt;
 180         int err;
 181
 182         if (opts == NULL) {
 183                 ti->error = "Digest algorithm missing for ESSIV mode";
 184                 return -EINVAL;
 185         }
 186
 187         /* Hash the cipher key with the given hash algorithm */
 188         hash_tfm = crypto_alloc_hash(opts, 0, CRYPTO_ALG_ASYNC);
 189         if (IS_ERR(hash_tfm)) {
 190                 ti->error = "Error initializing ESSIV hash";
 191                 return PTR_ERR(hash_tfm);
 192         }
 193
 194         saltsize = crypto_hash_digestsize(hash_tfm);
 195         salt = kmalloc(saltsize, GFP_KERNEL);
 196         if (salt == NULL) {
 197                 ti->error = "Error kmallocing salt storage in ESSIV";
 198                 crypto_free_hash(hash_tfm);
 199                 return -ENOMEM;
 200         }
 201
 202         sg_init_one(&sg, cc->key, cc->key_size);
 203         desc.tfm = hash_tfm;
 204         desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
 205         err = crypto_hash_digest(&desc, &sg, cc->key_size, salt);
 206         crypto_free_hash(hash_tfm);
 207
 208         if (err) {
 209                 ti->error = "Error calculating hash in ESSIV";
 210                 kfree(salt);
 211                 return err;
 212         }
 213
 214         /* Setup the essiv_tfm with the given salt */
 215         essiv_tfm = crypto_alloc_cipher(cc->cipher, 0, CRYPTO_ALG_ASYNC);
 216         if (IS_ERR(essiv_tfm)) {
 217                 ti->error = "Error allocating crypto tfm for ESSIV";
 218                 kfree(salt);
 219                 return PTR_ERR(essiv_tfm);
 220         }
 221         if (crypto_cipher_blocksize(essiv_tfm) !=
 222             crypto_ablkcipher_ivsize(cc->tfm)) {
 223                 ti->error = "Block size of ESSIV cipher does "
 224                             "not match IV size of block cipher";
 225                 crypto_free_cipher(essiv_tfm);
 226                 kfree(salt);
 227                 return -EINVAL;
 228         }
 229         err = crypto_cipher_setkey(essiv_tfm, salt, saltsize);
 230         if (err) {
 231                 ti->error = "Failed to set key for ESSIV cipher";
 232                 crypto_free_cipher(essiv_tfm);
 233                 kfree(salt);
 234                 return err;
 235         }
 236         kfree(salt);
 237
 238         cc->iv_gen_private.essiv_tfm = essiv_tfm;
 239         return 0;
 240 }
 241
 242 static void crypt_iv_essiv_dtr(struct crypt_config *cc)
 243 {
 244         crypto_free_cipher(cc->iv_gen_private.essiv_tfm);
 245         cc->iv_gen_private.essiv_tfm = NULL;
 246 }
 247
 248 static int crypt_iv_essiv_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 249 {
 250         memset(iv, 0, cc->iv_size);
 251         *(u64 *)iv = cpu_to_le64(sector);
 252         crypto_cipher_encrypt_one(cc->iv_gen_private.essiv_tfm, iv, iv);
 253         return 0;
 254 }
 255
 256 static int crypt_iv_benbi_ctr(struct crypt_config *cc, struct dm_target *ti,
 257                               const char *opts)
 258 {
 259         unsigned bs = crypto_ablkcipher_blocksize(cc->tfm);
 260         int log = ilog2(bs);
 261
 262         /* we need to calculate how far we must shift the sector count
 263          * to get the cipher block count, we use this shift in _gen */
 264
 265         if (1 << log != bs) {
 266                 ti->error = "cypher blocksize is not a power of 2";
 267                 return -EINVAL;
 268         }
 269
 270         if (log > 9) {
 271                 ti->error = "cypher blocksize is > 512";
 272                 return -EINVAL;
 273         }
 274
 275         cc->iv_gen_private.benbi_shift = 9 - log;
 276
 277         return 0;
 278 }
 279
 280 static void crypt_iv_benbi_dtr(struct crypt_config *cc)
 281 {
 282 }
 283
 284 static int crypt_iv_benbi_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 285 {
 286         __be64 val;
 287
 288         memset(iv, 0, cc->iv_size - sizeof(u64)); /* rest is cleared below */
 289
 290         val = cpu_to_be64(((u64)sector << cc->iv_gen_private.benbi_shift) + 1);
 291         put_unaligned(val, (__be64 *)(iv + cc->iv_size - sizeof(u64)));
 292
 293         return 0;
 294 }
 295
 296 static int crypt_iv_null_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 297 {
 298         memset(iv, 0, cc->iv_size);
 299
 300         return 0;
 301 }
 302
 303 static struct crypt_iv_operations crypt_iv_plain_ops = {
 304         .generator = crypt_iv_plain_gen
 305 };
 306
 307 static struct crypt_iv_operations crypt_iv_essiv_ops = {
 308         .ctr       = crypt_iv_essiv_ctr,
 309         .dtr       = crypt_iv_essiv_dtr,
 310         .generator = crypt_iv_essiv_gen
 311 };
 312
 313 static struct crypt_iv_operations crypt_iv_benbi_ops = {
 314         .ctr       = crypt_iv_benbi_ctr,
 315         .dtr       = crypt_iv_benbi_dtr,
 316         .generator = crypt_iv_benbi_gen
 317 };
 318
 319 static struct crypt_iv_operations crypt_iv_null_ops = {
 320         .generator = crypt_iv_null_gen
 321 };
 322
 323 static void crypt_convert_init(struct crypt_config *cc,
 324                                struct convert_context *ctx,
 325                                struct bio *bio_out, struct bio *bio_in,
 326                                sector_t sector)
 327 {
 328         ctx->bio_in = bio_in;
 329         ctx->bio_out = bio_out;
 330         ctx->offset_in = 0;
 331         ctx->offset_out = 0;
 332         ctx->idx_in = bio_in ? bio_in->bi_idx : 0;
 333         ctx->idx_out = bio_out ? bio_out->bi_idx : 0;
 334         ctx->sector = sector + cc->iv_offset;
 335         init_completion(&ctx->restart);
 336         atomic_set(&ctx->pending, 1);
 337 }
 338
 339 static int crypt_convert_block(struct crypt_config *cc,
 340                                struct convert_context *ctx,
 341                                struct ablkcipher_request *req)
 342 {
 343         struct bio_vec *bv_in = bio_iovec_idx(ctx->bio_in, ctx->idx_in);
 344         struct bio_vec *bv_out = bio_iovec_idx(ctx->bio_out, ctx->idx_out);
 345         struct dm_crypt_request *dmreq;
 346         u8 *iv;
 347         int r = 0;
 348
 349         dmreq = (struct dm_crypt_request *)((char *)req + cc->dmreq_start);
 350         iv = (u8 *)ALIGN((unsigned long)(dmreq + 1),
 351                          crypto_ablkcipher_alignmask(cc->tfm) + 1);
 352
 353         sg_init_table(&dmreq->sg_in, 1);
 354         sg_set_page(&dmreq->sg_in, bv_in->bv_page, 1 << SECTOR_SHIFT,
 355                     bv_in->bv_offset + ctx->offset_in);
 356
 357         sg_init_table(&dmreq->sg_out, 1);
 358         sg_set_page(&dmreq->sg_out, bv_out->bv_page, 1 << SECTOR_SHIFT,
 359                     bv_out->bv_offset + ctx->offset_out);
 360
 361         ctx->offset_in += 1 << SECTOR_SHIFT;
 362         if (ctx->offset_in >= bv_in->bv_len) {
 363                 ctx->offset_in = 0;
 364                 ctx->idx_in++;
 365         }
 366
 367         ctx->offset_out += 1 << SECTOR_SHIFT;
 368         if (ctx->offset_out >= bv_out->bv_len) {
 369                 ctx->offset_out = 0;
 370                 ctx->idx_out++;
 371         }
 372
 373         if (cc->iv_gen_ops) {
 374                 r = cc->iv_gen_ops->generator(cc, iv, ctx->sector);
 375                 if (r < 0)
 376                         return r;
 377         }
 378
 379         ablkcipher_request_set_crypt(req, &dmreq->sg_in, &dmreq->sg_out,
 380                                      1 << SECTOR_SHIFT, iv);
 381
 382         if (bio_data_dir(ctx->bio_in) == WRITE)
 383                 r = crypto_ablkcipher_encrypt(req);
 384         else
 385                 r = crypto_ablkcipher_decrypt(req);
 386
 387         return r;
 388 }
 389
 390 static void kcryptd_async_done(struct crypto_async_request *async_req,
 391                                int error);
 392 static void crypt_alloc_req(struct crypt_config *cc,
 393                             struct convert_context *ctx)
 394 {
 395         if (!cc->req)
 396                 cc->req = mempool_alloc(cc->req_pool, GFP_NOIO);
 397         ablkcipher_request_set_tfm(cc->req, cc->tfm);
 398         ablkcipher_request_set_callback(cc->req, CRYPTO_TFM_REQ_MAY_BACKLOG |
 399                                              CRYPTO_TFM_REQ_MAY_SLEEP,
 400                                              kcryptd_async_done, ctx);
 401 }
 402
 403 /*
 404  * Encrypt / decrypt data from one bio to another one (can be the same one)
 405  */
 406 static int crypt_convert(struct crypt_config *cc,
 407                          struct convert_context *ctx)
 408 {
 409         int r;
 410
 411         while(ctx->idx_in < ctx->bio_in->bi_vcnt &&
 412               ctx->idx_out < ctx->bio_out->bi_vcnt) {
 413
 414                 crypt_alloc_req(cc, ctx);
 415
 416                 atomic_inc(&ctx->pending);
 417
 418                 r = crypt_convert_block(cc, ctx, cc->req);
 419
 420                 switch (r) {
 421                 /* async */
 422                 case -EBUSY:
 423                         wait_for_completion(&ctx->restart);
 424                         INIT_COMPLETION(ctx->restart);
 425                         /* fall through*/
 426                 case -EINPROGRESS:
 427                         cc->req = NULL;
 428                         ctx->sector++;
 429                         continue;
 430
 431                 /* sync */
 432                 case 0:
 433                         atomic_dec(&ctx->pending);
 434                         ctx->sector++;
 435                         cond_resched();
 436                         continue;
 437
 438                 /* error */
 439                 default:
 440                         atomic_dec(&ctx->pending);
 441                         return r;
 442                 }
 443         }
 444
 445         return 0;
 446 }
 447
 448 static void dm_crypt_bio_destructor(struct bio *bio)
 449 {
 450         struct dm_crypt_io *io = bio->bi_private;
 451         struct crypt_config *cc = io->target->private;
 452
 453         bio_free(bio, cc->bs);
 454 }
 455
 456 /*
 457  * Generate a new unfragmented bio with the given size
 458  * This should never violate the device limitations
 459  * May return a smaller bio when running out of pages
 460  */
 461 static struct bio *crypt_alloc_buffer(struct dm_crypt_io *io, unsigned size)
 462 {
 463         struct crypt_config *cc = io->target->private;
 464         struct bio *clone;
 465         unsigned int nr_iovecs = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
 466         gfp_t gfp_mask = GFP_NOIO | __GFP_HIGHMEM;
 467         unsigned i, len;
 468         struct page *page;
 469
 470         clone = bio_alloc_bioset(GFP_NOIO, nr_iovecs, cc->bs);
 471         if (!clone)
 472                 return NULL;
 473
 474         clone_init(io, clone);
 475
 476         for (i = 0; i < nr_iovecs; i++) {
 477                 page = mempool_alloc(cc->page_pool, gfp_mask);
 478                 if (!page)
 479                         break;
 480
 481                 /*
 482                  * if additional pages cannot be allocated without waiting,
 483                  * return a partially allocated bio, the caller will then try
 484                  * to allocate additional bios while submitting this partial bio
 485                  */
 486                 if (i == (MIN_BIO_PAGES - 1))
 487                         gfp_mask = (gfp_mask | __GFP_NOWARN) & ~__GFP_WAIT;
 488
 489                 len = (size > PAGE_SIZE) ? PAGE_SIZE : size;
 490
 491                 if (!bio_add_page(clone, page, len, 0)) {
 492                         mempool_free(page, cc->page_pool);
 493                         break;
 494                 }
 495
 496                 size -= len;
 497         }
 498
 499         if (!clone->bi_size) {
 500                 bio_put(clone);
 501                 return NULL;
 502         }
 503
 504         return clone;
 505 }
 506
 507 static void crypt_free_buffer_pages(struct crypt_config *cc, struct bio *clone)
 508 {
 509         unsigned int i;
 510         struct bio_vec *bv;
 511
 512         for (i = 0; i < clone->bi_vcnt; i++) {
 513                 bv = bio_iovec_idx(clone, i);
 514                 BUG_ON(!bv->bv_page);
 515                 mempool_free(bv->bv_page, cc->page_pool);
 516                 bv->bv_page = NULL;
 517         }
 518 }
 519
 520 static void crypt_inc_pending(struct dm_crypt_io *io)
 521 {
 522         atomic_inc(&io->pending);
 523 }
 524
 525 /*
 526  * One of the bios was finished. Check for completion of
 527  * the whole request and correctly clean up the buffer.
 528  */
 529 static void crypt_dec_pending(struct dm_crypt_io *io)
 530 {
 531         struct crypt_config *cc = io->target->private;
 532
 533         if (!atomic_dec_and_test(&io->pending))
 534                 return;
 535
 536         bio_endio(io->base_bio, io->error);
 537         mempool_free(io, cc->io_pool);
 538 }
 539
 540 /*
 541  * kcryptd/kcryptd_io:
 542  *
 543  * Needed because it would be very unwise to do decryption in an
 544  * interrupt context.
 545  *
 546  * kcryptd performs the actual encryption or decryption.
 547  *
 548  * kcryptd_io performs the IO submission.
 549  *
 550  * They must be separated as otherwise the final stages could be
 551  * starved by new requests which can block in the first stages due
 552  * to memory allocation.
 553  */
 554 static void crypt_endio(struct bio *clone, int error)
 555 {
 556         struct dm_crypt_io *io = clone->bi_private;
 557         struct crypt_config *cc = io->target->private;
 558         unsigned rw = bio_data_dir(clone);
 559
 560         if (unlikely(!bio_flagged(clone, BIO_UPTODATE) && !error))
 561                 error = -EIO;
 562
 563         /*
 564          * free the processed pages
 565          */
 566         if (rw == WRITE)
 567                 crypt_free_buffer_pages(cc, clone);
 568
 569         bio_put(clone);
 570
 571         if (rw == READ && !error) {
 572                 kcryptd_queue_crypt(io);
 573                 return;
 574         }
 575
 576         if (unlikely(error))
 577                 io->error = error;
 578
 579         crypt_dec_pending(io);
 580 }
 581
 582 static void clone_init(struct dm_crypt_io *io, struct bio *clone)
 583 {
 584         struct crypt_config *cc = io->target->private;
 585
 586         clone->bi_private = io;
 587         clone->bi_end_io  = crypt_endio;
 588         clone->bi_bdev    = cc->dev->bdev;
 589         clone->bi_rw      = io->base_bio->bi_rw;
 590         clone->bi_destructor = dm_crypt_bio_destructor;
 591 }
 592
 593 static void kcryptd_io_read(struct dm_crypt_io *io)
 594 {
 595         struct crypt_config *cc = io->target->private;
 596         struct bio *base_bio = io->base_bio;
 597         struct bio *clone;
 598
 599         crypt_inc_pending(io);
 600
 601         /*
 602          * The block layer might modify the bvec array, so always
 603          * copy the required bvecs because we need the original
 604          * one in order to decrypt the whole bio data *afterwards*.
 605          */
 606         clone = bio_alloc_bioset(GFP_NOIO, bio_segments(base_bio), cc->bs);
 607         if (unlikely(!clone)) {
 608                 io->error = -ENOMEM;
 609                 crypt_dec_pending(io);
 610                 return;
 611         }
 612
 613         clone_init(io, clone);
 614         clone->bi_idx = 0;
 615         clone->bi_vcnt = bio_segments(base_bio);
 616         clone->bi_size = base_bio->bi_size;
 617         clone->bi_sector = cc->start + io->sector;
 618         memcpy(clone->bi_io_vec, bio_iovec(base_bio),
 619                sizeof(struct bio_vec) * clone->bi_vcnt);
 620
 621         generic_make_request(clone);
 622 }
 623
 624 static void kcryptd_io_write(struct dm_crypt_io *io)
 625 {
 626         struct bio *clone = io->ctx.bio_out;
 627         struct crypt_config *cc = io->target->private;
 628
 629         generic_make_request(clone);
 630         wake_up(&cc->writeq);
 631 }
 632
 633 static void kcryptd_io(struct work_struct *work)
 634 {
 635         struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work);
 636
 637         if (bio_data_dir(io->base_bio) == READ)
 638                 kcryptd_io_read(io);
 639         else
 640                 kcryptd_io_write(io);
 641 }
 642
 643 static void kcryptd_queue_io(struct dm_crypt_io *io)
 644 {
 645         struct crypt_config *cc = io->target->private;
 646
 647         INIT_WORK(&io->work, kcryptd_io);
 648         queue_work(cc->io_queue, &io->work);
 649 }
 650
 651 static void kcryptd_crypt_write_io_submit(struct dm_crypt_io *io,
 652                                           int error, int async)
 653 {
 654         struct bio *clone = io->ctx.bio_out;
 655         struct crypt_config *cc = io->target->private;
 656
 657         if (unlikely(error < 0)) {
 658                 crypt_free_buffer_pages(cc, clone);
 659                 bio_put(clone);
 660                 io->error = -EIO;
 661                 return;
 662         }
 663
 664         /* crypt_convert should have filled the clone bio */
 665         BUG_ON(io->ctx.idx_out < clone->bi_vcnt);
 666
 667         clone->bi_sector = cc->start + io->sector;
 668         io->sector += bio_sectors(clone);
 669
 670         if (async)
 671                 kcryptd_queue_io(io);
 672         else {
 673                 crypt_inc_pending(io);
 674                 generic_make_request(clone);
 675         }
 676 }
 677
 678 static void kcryptd_crypt_write_convert_loop(struct dm_crypt_io *io)
 679 {
 680         struct crypt_config *cc = io->target->private;
 681         struct bio *clone;
 682         unsigned remaining = io->base_bio->bi_size;
 683         int r;
 684
 685         /*
 686          * The allocated buffers can be smaller than the whole bio,
 687          * so repeat the whole process until all the data can be handled.
 688          */
 689         while (remaining) {
 690                 clone = crypt_alloc_buffer(io, remaining);
 691                 if (unlikely(!clone)) {
 692                         io->error = -ENOMEM;
 693                         return;
 694                 }
 695
 696                 io->ctx.bio_out = clone;
 697                 io->ctx.idx_out = 0;
 698
 699                 remaining -= clone->bi_size;
 700
 701                 r = crypt_convert(cc, &io->ctx);
 702
 703                 if (atomic_dec_and_test(&io->ctx.pending)) {
 704                         /* processed, no running async crypto  */
 705                         kcryptd_crypt_write_io_submit(io, r, 0);
 706                         if (unlikely(r < 0))
 707                                 return;
 708                 } else
 709                         crypt_inc_pending(io);
 710
 711                 /* out of memory -> run queues */
 712                 if (unlikely(remaining)) {
 713                         /* wait for async crypto then reinitialize pending */
 714                         wait_event(cc->writeq, !atomic_read(&io->ctx.pending));
 715                         atomic_set(&io->ctx.pending, 1);
 716                         congestion_wait(WRITE, HZ/100);
 717                 }
 718         }
 719 }
 720
 721 static void kcryptd_crypt_write_convert(struct dm_crypt_io *io)
 722 {
 723         struct crypt_config *cc = io->target->private;
 724
 725         /*
 726          * Prevent io from disappearing until this function completes.
 727          */
 728         crypt_inc_pending(io);
 729
 730         crypt_convert_init(cc, &io->ctx, NULL, io->base_bio, io->sector);
 731         kcryptd_crypt_write_convert_loop(io);
 732
 733         crypt_dec_pending(io);
 734 }
 735
 736 static void kcryptd_crypt_read_done(struct dm_crypt_io *io, int error)
 737 {
 738         if (unlikely(error < 0))
 739                 io->error = -EIO;
 740
 741         crypt_dec_pending(io);
 742 }
 743
 744 static void kcryptd_crypt_read_convert(struct dm_crypt_io *io)
 745 {
 746         struct crypt_config *cc = io->target->private;
 747         int r = 0;
 748
 749         crypt_inc_pending(io);
 750
 751         crypt_convert_init(cc, &io->ctx, io->base_bio, io->base_bio,
 752                            io->sector);
 753
 754         r = crypt_convert(cc, &io->ctx);
 755
 756         if (atomic_dec_and_test(&io->ctx.pending))
 757                 kcryptd_crypt_read_done(io, r);
 758
 759         crypt_dec_pending(io);
 760 }
 761
 762 static void kcryptd_async_done(struct crypto_async_request *async_req,
 763                                int error)
 764 {
 765         struct convert_context *ctx = async_req->data;
 766         struct dm_crypt_io *io = container_of(ctx, struct dm_crypt_io, ctx);
 767         struct crypt_config *cc = io->target->private;
 768
 769         if (error == -EINPROGRESS) {
 770                 complete(&ctx->restart);
 771                 return;
 772         }
 773
 774         mempool_free(ablkcipher_request_cast(async_req), cc->req_pool);
 775
 776         if (!atomic_dec_and_test(&ctx->pending))
 777                 return;
 778
 779         if (bio_data_dir(io->base_bio) == READ)
 780                 kcryptd_crypt_read_done(io, error);
 781         else
 782                 kcryptd_crypt_write_io_submit(io, error, 1);
 783 }
 784
 785 static void kcryptd_crypt(struct work_struct *work)
 786 {
 787         struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work);
 788
 789         if (bio_data_dir(io->base_bio) == READ)
 790                 kcryptd_crypt_read_convert(io);
 791         else
 792                 kcryptd_crypt_write_convert(io);
 793 }
 794
 795 static void kcryptd_queue_crypt(struct dm_crypt_io *io)
 796 {
 797         struct crypt_config *cc = io->target->private;
 798
 799         INIT_WORK(&io->work, kcryptd_crypt);
 800         queue_work(cc->crypt_queue, &io->work);
 801 }
 802
 803 /*
 804  * Decode key from its hex representation
 805  */
 806 static int crypt_decode_key(u8 *key, char *hex, unsigned int size)
 807 {
 808         char buffer[3];
 809         char *endp;
 810         unsigned int i;
 811
 812         buffer[2] = '\0';
 813
 814         for (i = 0; i < size; i++) {
 815                 buffer[0] = *hex++;
 816                 buffer[1] = *hex++;
 817
 818                 key[i] = (u8)simple_strtoul(buffer, &endp, 16);
 819
 820                 if (endp != &buffer[2])
 821                         return -EINVAL;
 822         }
 823
 824         if (*hex != '\0')
 825                 return -EINVAL;
 826
 827         return 0;
 828 }
 829
 830 /*
 831  * Encode key into its hex representation
 832  */
 833 static void crypt_encode_key(char *hex, u8 *key, unsigned int size)
 834 {
 835         unsigned int i;
 836
 837         for (i = 0; i < size; i++) {
 838                 sprintf(hex, "%02x", *key);
 839                 hex += 2;
 840                 key++;
 841         }
 842 }
 843
 844 static int crypt_set_key(struct crypt_config *cc, char *key)
 845 {
 846         unsigned key_size = strlen(key) >> 1;
 847
 848         if (cc->key_size && cc->key_size != key_size)
 849                 return -EINVAL;
 850
 851         cc->key_size = key_size; /* initial settings */
 852
 853         if ((!key_size && strcmp(key, "-")) ||
 854            (key_size && crypt_decode_key(cc->key, key, key_size) < 0))
 855                 return -EINVAL;
 856
 857         set_bit(DM_CRYPT_KEY_VALID, &cc->flags);
 858
 859         return 0;
 860 }
 861
 862 static int crypt_wipe_key(struct crypt_config *cc)
 863 {
 864         clear_bit(DM_CRYPT_KEY_VALID, &cc->flags);
 865         memset(&cc->key, 0, cc->key_size * sizeof(u8));
 866         return 0;
 867 }
 868
 869 /*
 870  * Construct an encryption mapping:
 871  * <cipher> <key> <iv_offset> <dev_path> <start>
 872  */
 873 static int crypt_ctr(struct dm_target *ti, unsigned int argc, char **argv)
 874 {
 875         struct crypt_config *cc;
 876         struct crypto_ablkcipher *tfm;
 877         char *tmp;
 878         char *cipher;
 879         char *chainmode;
 880         char *ivmode;
 881         char *ivopts;
 882         unsigned int key_size;
 883         unsigned long long tmpll;
 884
 885         if (argc != 5) {
 886                 ti->error = "Not enough arguments";
 887                 return -EINVAL;
 888         }
 889
 890         tmp = argv[0];
 891         cipher = strsep(&tmp, "-");
 892         chainmode = strsep(&tmp, "-");
 893         ivopts = strsep(&tmp, "-");
 894         ivmode = strsep(&ivopts, ":");
 895
 896         if (tmp)
 897                 DMWARN("Unexpected additional cipher options");
 898
 899         key_size = strlen(argv[1]) >> 1;
 900
 901         cc = kzalloc(sizeof(*cc) + key_size * sizeof(u8), GFP_KERNEL);
 902         if (cc == NULL) {
 903                 ti->error =
 904                         "Cannot allocate transparent encryption context";
 905                 return -ENOMEM;
 906         }
 907
 908         if (crypt_set_key(cc, argv[1])) {
 909                 ti->error = "Error decoding key";
 910                 goto bad_cipher;
 911         }
 912
 913         /* Compatiblity mode for old dm-crypt cipher strings */
 914         if (!chainmode || (strcmp(chainmode, "plain") == 0 && !ivmode)) {
 915                 chainmode = "cbc";
 916                 ivmode = "plain";
 917         }
 918
 919         if (strcmp(chainmode, "ecb") && !ivmode) {
 920                 ti->error = "This chaining mode requires an IV mechanism";
 921                 goto bad_cipher;
 922         }
 923
 924         if (snprintf(cc->cipher, CRYPTO_MAX_ALG_NAME, "%s(%s)",
 925                      chainmode, cipher) >= CRYPTO_MAX_ALG_NAME) {
 926                 ti->error = "Chain mode + cipher name is too long";
 927                 goto bad_cipher;
 928         }
 929
 930         tfm = crypto_alloc_ablkcipher(cc->cipher, 0, 0);
 931         if (IS_ERR(tfm)) {
 932                 ti->error = "Error allocating crypto tfm";
 933                 goto bad_cipher;
 934         }
 935
 936         strcpy(cc->cipher, cipher);
 937         strcpy(cc->chainmode, chainmode);
 938         cc->tfm = tfm;
 939
 940         /*
 941          * Choose ivmode. Valid modes: "plain", "essiv:<esshash>", "benbi".
 942          * See comments at iv code
 943          */
 944
 945         if (ivmode == NULL)
 946                 cc->iv_gen_ops = NULL;
 947         else if (strcmp(ivmode, "plain") == 0)
 948                 cc->iv_gen_ops = &crypt_iv_plain_ops;
 949         else if (strcmp(ivmode, "essiv") == 0)
 950                 cc->iv_gen_ops = &crypt_iv_essiv_ops;
 951         else if (strcmp(ivmode, "benbi") == 0)
 952                 cc->iv_gen_ops = &crypt_iv_benbi_ops;
 953         else if (strcmp(ivmode, "null") == 0)
 954                 cc->iv_gen_ops = &crypt_iv_null_ops;
 955         else {
 956                 ti->error = "Invalid IV mode";
 957                 goto bad_ivmode;
 958         }
 959
 960         if (cc->iv_gen_ops && cc->iv_gen_ops->ctr &&
 961             cc->iv_gen_ops->ctr(cc, ti, ivopts) < 0)
 962                 goto bad_ivmode;
 963
 964         cc->iv_size = crypto_ablkcipher_ivsize(tfm);
 965         if (cc->iv_size)
 966                 /* at least a 64 bit sector number should fit in our buffer */
 967                 cc->iv_size = max(cc->iv_size,
 968                                   (unsigned int)(sizeof(u64) / sizeof(u8)));
 969         else {
 970                 if (cc->iv_gen_ops) {
 971                         DMWARN("Selected cipher does not support IVs");
 972                         if (cc->iv_gen_ops->dtr)
 973                                 cc->iv_gen_ops->dtr(cc);
 974                         cc->iv_gen_ops = NULL;
 975                 }
 976         }
 977
 978         cc->io_pool = mempool_create_slab_pool(MIN_IOS, _crypt_io_pool);
 979         if (!cc->io_pool) {
 980                 ti->error = "Cannot allocate crypt io mempool";
 981                 goto bad_slab_pool;
 982         }
 983
 984         cc->dmreq_start = sizeof(struct ablkcipher_request);
 985         cc->dmreq_start += crypto_ablkcipher_reqsize(tfm);
 986         cc->dmreq_start = ALIGN(cc->dmreq_start, crypto_tfm_ctx_alignment());
 987         cc->dmreq_start += crypto_ablkcipher_alignmask(tfm) &
 988                            ~(crypto_tfm_ctx_alignment() - 1);
 989
 990         cc->req_pool = mempool_create_kmalloc_pool(MIN_IOS, cc->dmreq_start +
 991                         sizeof(struct dm_crypt_request) + cc->iv_size);
 992         if (!cc->req_pool) {
 993                 ti->error = "Cannot allocate crypt request mempool";
 994                 goto bad_req_pool;
 995         }
 996         cc->req = NULL;
 997
 998         cc->page_pool = mempool_create_page_pool(MIN_POOL_PAGES, 0);
 999         if (!cc->page_pool) {
1000                 ti->error = "Cannot allocate page mempool";
1001                 goto bad_page_pool;
1002         }
1003
1004         cc->bs = bioset_create(MIN_IOS, MIN_IOS);
1005         if (!cc->bs) {
1006                 ti->error = "Cannot allocate crypt bioset";
1007                 goto bad_bs;
1008         }
1009
1010         if (crypto_ablkcipher_setkey(tfm, cc->key, key_size) < 0) {
1011                 ti->error = "Error setting key";
1012                 goto bad_device;
1013         }
1014
1015         if (sscanf(argv[2], "%llu", &tmpll) != 1) {
1016                 ti->error = "Invalid iv_offset sector";
1017                 goto bad_device;
1018         }
1019         cc->iv_offset = tmpll;
1020
1021         if (sscanf(argv[4], "%llu", &tmpll) != 1) {
1022                 ti->error = "Invalid device sector";
1023                 goto bad_device;
1024         }
1025         cc->start = tmpll;
1026
1027         if (dm_get_device(ti, argv[3], cc->start, ti->len,
1028                           dm_table_get_mode(ti->table), &cc->dev)) {
1029                 ti->error = "Device lookup failed";
1030                 goto bad_device;
1031         }
1032
1033         if (ivmode && cc->iv_gen_ops) {
1034                 if (ivopts)
1035                         *(ivopts - 1) = ':';
1036                 cc->iv_mode = kmalloc(strlen(ivmode) + 1, GFP_KERNEL);
1037                 if (!cc->iv_mode) {
1038                         ti->error = "Error kmallocing iv_mode string";
1039                         goto bad_ivmode_string;
1040                 }
1041                 strcpy(cc->iv_mode, ivmode);
1042         } else
1043                 cc->iv_mode = NULL;
1044
1045         cc->io_queue = create_singlethread_workqueue("kcryptd_io");
1046         if (!cc->io_queue) {
1047                 ti->error = "Couldn't create kcryptd io queue";
1048                 goto bad_io_queue;
1049         }
1050
1051         cc->crypt_queue = create_singlethread_workqueue("kcryptd");
1052         if (!cc->crypt_queue) {
1053                 ti->error = "Couldn't create kcryptd queue";
1054                 goto bad_crypt_queue;
1055         }
1056
1057         init_waitqueue_head(&cc->writeq);
1058         ti->private = cc;
1059         return 0;
1060
1061 bad_crypt_queue:
1062         destroy_workqueue(cc->io_queue);
1063 bad_io_queue:
1064         kfree(cc->iv_mode);
1065 bad_ivmode_string:
1066         dm_put_device(ti, cc->dev);
1067 bad_device:
1068         bioset_free(cc->bs);
1069 bad_bs:
1070         mempool_destroy(cc->page_pool);
1071 bad_page_pool:
1072         mempool_destroy(cc->req_pool);
1073 bad_req_pool:
1074         mempool_destroy(cc->io_pool);
1075 bad_slab_pool:
1076         if (cc->iv_gen_ops && cc->iv_gen_ops->dtr)
1077                 cc->iv_gen_ops->dtr(cc);
1078 bad_ivmode:
1079         crypto_free_ablkcipher(tfm);
1080 bad_cipher:
1081         /* Must zero key material before freeing */
1082         memset(cc, 0, sizeof(*cc) + cc->key_size * sizeof(u8));
1083         kfree(cc);
1084         return -EINVAL;
1085 }
1086
1087 static void crypt_dtr(struct dm_target *ti)
1088 {
1089         struct crypt_config *cc = (struct crypt_config *) ti->private;
1090
1091         destroy_workqueue(cc->io_queue);
1092         destroy_workqueue(cc->crypt_queue);
1093
1094         if (cc->req)
1095                 mempool_free(cc->req, cc->req_pool);
1096
1097         bioset_free(cc->bs);
1098         mempool_destroy(cc->page_pool);
1099         mempool_destroy(cc->req_pool);
1100         mempool_destroy(cc->io_pool);
1101
1102         kfree(cc->iv_mode);
1103         if (cc->iv_gen_ops && cc->iv_gen_ops->dtr)
1104                 cc->iv_gen_ops->dtr(cc);
1105         crypto_free_ablkcipher(cc->tfm);
1106         dm_put_device(ti, cc->dev);
1107
1108         /* Must zero key material before freeing */
1109         memset(cc, 0, sizeof(*cc) + cc->key_size * sizeof(u8));
1110         kfree(cc);
1111 }
1112
1113 static int crypt_map(struct dm_target *ti, struct bio *bio,
1114                      union map_info *map_context)
1115 {
1116         struct crypt_config *cc = ti->private;
1117         struct dm_crypt_io *io;
1118
1119         io = mempool_alloc(cc->io_pool, GFP_NOIO);
1120         io->target = ti;
1121         io->base_bio = bio;
1122         io->sector = bio->bi_sector - ti->begin;
1123         io->error = 0;
1124         atomic_set(&io->pending, 0);
1125
1126         if (bio_data_dir(io->base_bio) == READ)
1127                 kcryptd_queue_io(io);
1128         else
1129                 kcryptd_queue_crypt(io);
1130
1131         return DM_MAPIO_SUBMITTED;
1132 }
1133
1134 static int crypt_status(struct dm_target *ti, status_type_t type,
1135                         char *result, unsigned int maxlen)
1136 {
1137         struct crypt_config *cc = (struct crypt_config *) ti->private;
1138         unsigned int sz = 0;
1139
1140         switch (type) {
1141         case STATUSTYPE_INFO:
1142                 result[0] = '\0';
1143                 break;
1144
1145         case STATUSTYPE_TABLE:
1146                 if (cc->iv_mode)
1147                         DMEMIT("%s-%s-%s ", cc->cipher, cc->chainmode,
1148                                cc->iv_mode);
1149                 else
1150                         DMEMIT("%s-%s ", cc->cipher, cc->chainmode);
1151
1152                 if (cc->key_size > 0) {
1153                         if ((maxlen - sz) < ((cc->key_size << 1) + 1))
1154                                 return -ENOMEM;
1155
1156                         crypt_encode_key(result + sz, cc->key, cc->key_size);
1157                         sz += cc->key_size << 1;
1158                 } else {
1159                         if (sz >= maxlen)
1160                                 return -ENOMEM;
1161                         result[sz++] = '-';
1162                 }
1163
1164                 DMEMIT(" %llu %s %llu", (unsigned long long)cc->iv_offset,
1165                                 cc->dev->name, (unsigned long long)cc->start);
1166                 break;
1167         }
1168         return 0;
1169 }
1170
1171 static void crypt_postsuspend(struct dm_target *ti)
1172 {
1173         struct crypt_config *cc = ti->private;
1174
1175         set_bit(DM_CRYPT_SUSPENDED, &cc->flags);
1176 }
1177
1178 static int crypt_preresume(struct dm_target *ti)
1179 {
1180         struct crypt_config *cc = ti->private;
1181
1182         if (!test_bit(DM_CRYPT_KEY_VALID, &cc->flags)) {
1183                 DMERR("aborting resume - crypt key is not set.");
1184                 return -EAGAIN;
1185         }
1186
1187         return 0;
1188 }
1189
1190 static void crypt_resume(struct dm_target *ti)
1191 {
1192         struct crypt_config *cc = ti->private;
1193
1194         clear_bit(DM_CRYPT_SUSPENDED, &cc->flags);
1195 }
1196
1197 /* Message interface
1198  *      key set <key>
1199  *      key wipe
1200  */
1201 static int crypt_message(struct dm_target *ti, unsigned argc, char **argv)
1202 {
1203         struct crypt_config *cc = ti->private;
1204
1205         if (argc < 2)
1206                 goto error;
1207
1208         if (!strnicmp(argv[0], MESG_STR("key"))) {
1209                 if (!test_bit(DM_CRYPT_SUSPENDED, &cc->flags)) {
1210                         DMWARN("not suspended during key manipulation.");
1211                         return -EINVAL;
1212                 }
1213                 if (argc == 3 && !strnicmp(argv[1], MESG_STR("set")))
1214                         return crypt_set_key(cc, argv[2]);
1215                 if (argc == 2 && !strnicmp(argv[1], MESG_STR("wipe")))
1216                         return crypt_wipe_key(cc);
1217         }
1218
1219 error:
1220         DMWARN("unrecognised message received.");
1221         return -EINVAL;
1222 }
1223
1224 static int crypt_merge(struct dm_target *ti, struct bvec_merge_data *bvm,
1225                        struct bio_vec *biovec, int max_size)
1226 {
1227         struct crypt_config *cc = ti->private;
1228         struct request_queue *q = bdev_get_queue(cc->dev->bdev);
1229
1230         if (!q->merge_bvec_fn)
1231                 return max_size;
1232
1233         bvm->bi_bdev = cc->dev->bdev;
1234         bvm->bi_sector = cc->start + bvm->bi_sector - ti->begin;
1235
1236         return min(max_size, q->merge_bvec_fn(q, bvm, biovec));
1237 }
1238
1239 static struct target_type crypt_target = {
1240         .name   = "crypt",
1241         .version= {1, 6, 0},
1242         .module = THIS_MODULE,
1243         .ctr    = crypt_ctr,
1244         .dtr    = crypt_dtr,
1245         .map    = crypt_map,
1246         .status = crypt_status,
1247         .postsuspend = crypt_postsuspend,
1248         .preresume = crypt_preresume,
1249         .resume = crypt_resume,
1250         .message = crypt_message,
1251         .merge  = crypt_merge,
1252 };
1253
1254 static int __init dm_crypt_init(void)
1255 {
1256         int r;
1257
1258         _crypt_io_pool = KMEM_CACHE(dm_crypt_io, 0);
1259         if (!_crypt_io_pool)
1260                 return -ENOMEM;
1261
1262         r = dm_register_target(&crypt_target);
1263         if (r < 0) {
1264                 DMERR("register failed %d", r);
1265                 kmem_cache_destroy(_crypt_io_pool);
1266         }
1267
1268         return r;
1269 }
1270
1271 static void __exit dm_crypt_exit(void)
1272 {
1273         int r = dm_unregister_target(&crypt_target);
1274
1275         if (r < 0)
1276                 DMERR("unregister failed %d", r);
1277
1278         kmem_cache_destroy(_crypt_io_pool);
1279 }
1280
1281 module_init(dm_crypt_init);
1282 module_exit(dm_crypt_exit);
1283
1284 MODULE_AUTHOR("Christophe Saout <christophe@saout.de>");
1285 MODULE_DESCRIPTION(DM_NAME " target for transparent encryption / decryption");
1286 MODULE_LICENSE("GPL");