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