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