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