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