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