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