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