dm-crypt.c 24.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 * Copyright (C) 2003 Christophe Saout <christophe@saout.de>
 * Copyright (C) 2004 Clemens Fruhwirth <clemens@endorphin.org>
M
Milan Broz 已提交
4
 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
L
Linus Torvalds 已提交
5 6 7 8
 *
 * This file is released under the GPL.
 */

9
#include <linux/err.h>
L
Linus Torvalds 已提交
10 11 12 13 14 15 16 17 18
#include <linux/module.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/bio.h>
#include <linux/blkdev.h>
#include <linux/mempool.h>
#include <linux/slab.h>
#include <linux/crypto.h>
#include <linux/workqueue.h>
19
#include <linux/backing-dev.h>
L
Linus Torvalds 已提交
20
#include <asm/atomic.h>
21
#include <linux/scatterlist.h>
L
Linus Torvalds 已提交
22 23 24 25
#include <asm/page.h>

#include "dm.h"

26
#define DM_MSG_PREFIX "crypt"
M
Milan Broz 已提交
27
#define MESG_STR(x) x, sizeof(x)
L
Linus Torvalds 已提交
28 29 30 31 32 33

/*
 * per bio private data
 */
struct crypt_io {
	struct dm_target *target;
34
	struct bio *base_bio;
L
Linus Torvalds 已提交
35 36 37 38
	struct bio *first_clone;
	struct work_struct work;
	atomic_t pending;
	int error;
39
	int post_process;
L
Linus Torvalds 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
};

/*
 * context holding the current state of a multi-part conversion
 */
struct convert_context {
	struct bio *bio_in;
	struct bio *bio_out;
	unsigned int offset_in;
	unsigned int offset_out;
	unsigned int idx_in;
	unsigned int idx_out;
	sector_t sector;
	int write;
};

struct crypt_config;

struct crypt_iv_operations {
	int (*ctr)(struct crypt_config *cc, struct dm_target *ti,
	           const char *opts);
	void (*dtr)(struct crypt_config *cc);
	const char *(*status)(struct crypt_config *cc);
	int (*generator)(struct crypt_config *cc, u8 *iv, sector_t sector);
};

/*
 * Crypt: maps a linear range of a block device
 * and encrypts / decrypts at the same time.
 */
M
Milan Broz 已提交
70
enum flags { DM_CRYPT_SUSPENDED, DM_CRYPT_KEY_VALID };
L
Linus Torvalds 已提交
71 72 73 74 75 76 77 78 79 80
struct crypt_config {
	struct dm_dev *dev;
	sector_t start;

	/*
	 * pool for per bio private data and
	 * for encryption buffer pages
	 */
	mempool_t *io_pool;
	mempool_t *page_pool;
M
Milan Broz 已提交
81
	struct bio_set *bs;
L
Linus Torvalds 已提交
82 83 84 85 86 87

	/*
	 * crypto related data
	 */
	struct crypt_iv_operations *iv_gen_ops;
	char *iv_mode;
88
	struct crypto_cipher *iv_gen_private;
L
Linus Torvalds 已提交
89 90 91
	sector_t iv_offset;
	unsigned int iv_size;

92 93 94
	char cipher[CRYPTO_MAX_ALG_NAME];
	char chainmode[CRYPTO_MAX_ALG_NAME];
	struct crypto_blkcipher *tfm;
M
Milan Broz 已提交
95
	unsigned long flags;
L
Linus Torvalds 已提交
96 97 98 99
	unsigned int key_size;
	u8 key[0];
};

M
Milan Broz 已提交
100
#define MIN_IOS        16
L
Linus Torvalds 已提交
101 102 103 104 105 106 107 108
#define MIN_POOL_PAGES 32
#define MIN_BIO_PAGES  8

static kmem_cache_t *_crypt_io_pool;

/*
 * Different IV generation algorithms:
 *
109
 * plain: the initial vector is the 32-bit little-endian version of the sector
L
Linus Torvalds 已提交
110 111
 *        number, padded with zeros if neccessary.
 *
112 113 114
 * essiv: "encrypted sector|salt initial vector", the sector number is
 *        encrypted with the bulk cipher using a salt as key. The salt
 *        should be derived from the bulk cipher's key via hashing.
L
Linus Torvalds 已提交
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
 *
 * plumb: unimplemented, see:
 * http://article.gmane.org/gmane.linux.kernel.device-mapper.dm-crypt/454
 */

static int crypt_iv_plain_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
{
	memset(iv, 0, cc->iv_size);
	*(u32 *)iv = cpu_to_le32(sector & 0xffffffff);

	return 0;
}

static int crypt_iv_essiv_ctr(struct crypt_config *cc, struct dm_target *ti,
	                      const char *opts)
{
131
	struct crypto_cipher *essiv_tfm;
132 133
	struct crypto_hash *hash_tfm;
	struct hash_desc desc;
L
Linus Torvalds 已提交
134 135 136
	struct scatterlist sg;
	unsigned int saltsize;
	u8 *salt;
137
	int err;
L
Linus Torvalds 已提交
138 139

	if (opts == NULL) {
140
		ti->error = "Digest algorithm missing for ESSIV mode";
L
Linus Torvalds 已提交
141 142 143 144
		return -EINVAL;
	}

	/* Hash the cipher key with the given hash algorithm */
145 146
	hash_tfm = crypto_alloc_hash(opts, 0, CRYPTO_ALG_ASYNC);
	if (IS_ERR(hash_tfm)) {
147
		ti->error = "Error initializing ESSIV hash";
148
		return PTR_ERR(hash_tfm);
L
Linus Torvalds 已提交
149 150
	}

151
	saltsize = crypto_hash_digestsize(hash_tfm);
L
Linus Torvalds 已提交
152 153
	salt = kmalloc(saltsize, GFP_KERNEL);
	if (salt == NULL) {
154
		ti->error = "Error kmallocing salt storage in ESSIV";
155
		crypto_free_hash(hash_tfm);
L
Linus Torvalds 已提交
156 157 158
		return -ENOMEM;
	}

159
	sg_set_buf(&sg, cc->key, cc->key_size);
160 161 162 163 164 165 166 167 168
	desc.tfm = hash_tfm;
	desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
	err = crypto_hash_digest(&desc, &sg, cc->key_size, salt);
	crypto_free_hash(hash_tfm);

	if (err) {
		ti->error = "Error calculating hash in ESSIV";
		return err;
	}
L
Linus Torvalds 已提交
169 170

	/* Setup the essiv_tfm with the given salt */
171 172
	essiv_tfm = crypto_alloc_cipher(cc->cipher, 0, CRYPTO_ALG_ASYNC);
	if (IS_ERR(essiv_tfm)) {
173
		ti->error = "Error allocating crypto tfm for ESSIV";
L
Linus Torvalds 已提交
174
		kfree(salt);
175
		return PTR_ERR(essiv_tfm);
L
Linus Torvalds 已提交
176
	}
177 178
	if (crypto_cipher_blocksize(essiv_tfm) !=
	    crypto_blkcipher_ivsize(cc->tfm)) {
179
		ti->error = "Block size of ESSIV cipher does "
L
Linus Torvalds 已提交
180
			        "not match IV size of block cipher";
181
		crypto_free_cipher(essiv_tfm);
L
Linus Torvalds 已提交
182 183 184
		kfree(salt);
		return -EINVAL;
	}
185 186
	err = crypto_cipher_setkey(essiv_tfm, salt, saltsize);
	if (err) {
187
		ti->error = "Failed to set key for ESSIV cipher";
188
		crypto_free_cipher(essiv_tfm);
L
Linus Torvalds 已提交
189
		kfree(salt);
190
		return err;
L
Linus Torvalds 已提交
191 192 193
	}
	kfree(salt);

194
	cc->iv_gen_private = essiv_tfm;
L
Linus Torvalds 已提交
195 196 197 198 199
	return 0;
}

static void crypt_iv_essiv_dtr(struct crypt_config *cc)
{
200
	crypto_free_cipher(cc->iv_gen_private);
L
Linus Torvalds 已提交
201 202 203 204 205 206 207
	cc->iv_gen_private = NULL;
}

static int crypt_iv_essiv_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
{
	memset(iv, 0, cc->iv_size);
	*(u64 *)iv = cpu_to_le64(sector);
208
	crypto_cipher_encrypt_one(cc->iv_gen_private, iv, iv);
L
Linus Torvalds 已提交
209 210 211 212 213 214 215 216 217 218 219 220 221 222
	return 0;
}

static struct crypt_iv_operations crypt_iv_plain_ops = {
	.generator = crypt_iv_plain_gen
};

static struct crypt_iv_operations crypt_iv_essiv_ops = {
	.ctr       = crypt_iv_essiv_ctr,
	.dtr       = crypt_iv_essiv_dtr,
	.generator = crypt_iv_essiv_gen
};


223
static int
L
Linus Torvalds 已提交
224 225 226 227 228
crypt_convert_scatterlist(struct crypt_config *cc, struct scatterlist *out,
                          struct scatterlist *in, unsigned int length,
                          int write, sector_t sector)
{
	u8 iv[cc->iv_size];
229 230 231 232 233
	struct blkcipher_desc desc = {
		.tfm = cc->tfm,
		.info = iv,
		.flags = CRYPTO_TFM_REQ_MAY_SLEEP,
	};
L
Linus Torvalds 已提交
234 235 236 237 238 239 240 241
	int r;

	if (cc->iv_gen_ops) {
		r = cc->iv_gen_ops->generator(cc, iv, sector);
		if (r < 0)
			return r;

		if (write)
242
			r = crypto_blkcipher_encrypt_iv(&desc, out, in, length);
L
Linus Torvalds 已提交
243
		else
244
			r = crypto_blkcipher_decrypt_iv(&desc, out, in, length);
L
Linus Torvalds 已提交
245 246
	} else {
		if (write)
247
			r = crypto_blkcipher_encrypt(&desc, out, in, length);
L
Linus Torvalds 已提交
248
		else
249
			r = crypto_blkcipher_decrypt(&desc, out, in, length);
L
Linus Torvalds 已提交
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
	}

	return r;
}

static void
crypt_convert_init(struct crypt_config *cc, struct convert_context *ctx,
                   struct bio *bio_out, struct bio *bio_in,
                   sector_t sector, int write)
{
	ctx->bio_in = bio_in;
	ctx->bio_out = bio_out;
	ctx->offset_in = 0;
	ctx->offset_out = 0;
	ctx->idx_in = bio_in ? bio_in->bi_idx : 0;
	ctx->idx_out = bio_out ? bio_out->bi_idx : 0;
	ctx->sector = sector + cc->iv_offset;
	ctx->write = write;
}

/*
 * Encrypt / decrypt data from one bio to another one (can be the same one)
 */
static int crypt_convert(struct crypt_config *cc,
                         struct convert_context *ctx)
{
	int r = 0;

	while(ctx->idx_in < ctx->bio_in->bi_vcnt &&
	      ctx->idx_out < ctx->bio_out->bi_vcnt) {
		struct bio_vec *bv_in = bio_iovec_idx(ctx->bio_in, ctx->idx_in);
		struct bio_vec *bv_out = bio_iovec_idx(ctx->bio_out, ctx->idx_out);
		struct scatterlist sg_in = {
			.page = bv_in->bv_page,
			.offset = bv_in->bv_offset + ctx->offset_in,
			.length = 1 << SECTOR_SHIFT
		};
		struct scatterlist sg_out = {
			.page = bv_out->bv_page,
			.offset = bv_out->bv_offset + ctx->offset_out,
			.length = 1 << SECTOR_SHIFT
		};

		ctx->offset_in += sg_in.length;
		if (ctx->offset_in >= bv_in->bv_len) {
			ctx->offset_in = 0;
			ctx->idx_in++;
		}

		ctx->offset_out += sg_out.length;
		if (ctx->offset_out >= bv_out->bv_len) {
			ctx->offset_out = 0;
			ctx->idx_out++;
		}

		r = crypt_convert_scatterlist(cc, &sg_out, &sg_in, sg_in.length,
		                              ctx->write, ctx->sector);
		if (r < 0)
			break;

		ctx->sector++;
	}

	return r;
}

M
Milan Broz 已提交
316 317 318 319 320 321 322 323
 static void dm_crypt_bio_destructor(struct bio *bio)
 {
	struct crypt_io *io = bio->bi_private;
	struct crypt_config *cc = io->target->private;

	bio_free(bio, cc->bs);
 }

L
Linus Torvalds 已提交
324 325 326 327 328 329 330 331 332
/*
 * Generate a new unfragmented bio with the given size
 * This should never violate the device limitations
 * May return a smaller bio when running out of pages
 */
static struct bio *
crypt_alloc_buffer(struct crypt_config *cc, unsigned int size,
                   struct bio *base_bio, unsigned int *bio_vec_idx)
{
333
	struct bio *clone;
L
Linus Torvalds 已提交
334
	unsigned int nr_iovecs = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
335
	gfp_t gfp_mask = GFP_NOIO | __GFP_HIGHMEM;
L
Linus Torvalds 已提交
336 337
	unsigned int i;

M
Milan Broz 已提交
338 339 340 341 342 343
	if (base_bio) {
		clone = bio_alloc_bioset(GFP_NOIO, base_bio->bi_max_vecs, cc->bs);
		__bio_clone(clone, base_bio);
	} else
		clone = bio_alloc_bioset(GFP_NOIO, nr_iovecs, cc->bs);

344
	if (!clone)
L
Linus Torvalds 已提交
345 346
		return NULL;

M
Milan Broz 已提交
347 348
	clone->bi_destructor = dm_crypt_bio_destructor;

L
Linus Torvalds 已提交
349
	/* if the last bio was not complete, continue where that one ended */
350 351 352 353
	clone->bi_idx = *bio_vec_idx;
	clone->bi_vcnt = *bio_vec_idx;
	clone->bi_size = 0;
	clone->bi_flags &= ~(1 << BIO_SEG_VALID);
L
Linus Torvalds 已提交
354

355 356
	/* clone->bi_idx pages have already been allocated */
	size -= clone->bi_idx * PAGE_SIZE;
L
Linus Torvalds 已提交
357

358 359
	for (i = clone->bi_idx; i < nr_iovecs; i++) {
		struct bio_vec *bv = bio_iovec_idx(clone, i);
L
Linus Torvalds 已提交
360 361 362 363 364 365 366 367 368 369

		bv->bv_page = mempool_alloc(cc->page_pool, gfp_mask);
		if (!bv->bv_page)
			break;

		/*
		 * if additional pages cannot be allocated without waiting,
		 * return a partially allocated bio, the caller will then try
		 * to allocate additional bios while submitting this partial bio
		 */
370
		if ((i - clone->bi_idx) == (MIN_BIO_PAGES - 1))
L
Linus Torvalds 已提交
371 372 373 374 375 376 377 378
			gfp_mask = (gfp_mask | __GFP_NOWARN) & ~__GFP_WAIT;

		bv->bv_offset = 0;
		if (size > PAGE_SIZE)
			bv->bv_len = PAGE_SIZE;
		else
			bv->bv_len = size;

379 380
		clone->bi_size += bv->bv_len;
		clone->bi_vcnt++;
L
Linus Torvalds 已提交
381 382 383
		size -= bv->bv_len;
	}

384 385
	if (!clone->bi_size) {
		bio_put(clone);
L
Linus Torvalds 已提交
386 387 388 389 390 391 392
		return NULL;
	}

	/*
	 * Remember the last bio_vec allocated to be able
	 * to correctly continue after the splitting.
	 */
393
	*bio_vec_idx = clone->bi_vcnt;
L
Linus Torvalds 已提交
394

395
	return clone;
L
Linus Torvalds 已提交
396 397 398
}

static void crypt_free_buffer_pages(struct crypt_config *cc,
399
                                    struct bio *clone, unsigned int bytes)
L
Linus Torvalds 已提交
400 401 402 403 404 405 406 407 408 409 410 411 412
{
	unsigned int i, start, end;
	struct bio_vec *bv;

	/*
	 * This is ugly, but Jens Axboe thinks that using bi_idx in the
	 * endio function is too dangerous at the moment, so I calculate the
	 * correct position using bi_vcnt and bi_size.
	 * The bv_offset and bv_len fields might already be modified but we
	 * know that we always allocated whole pages.
	 * A fix to the bi_idx issue in the kernel is in the works, so
	 * we will hopefully be able to revert to the cleaner solution soon.
	 */
413 414 415
	i = clone->bi_vcnt - 1;
	bv = bio_iovec_idx(clone, i);
	end = (i << PAGE_SHIFT) + (bv->bv_offset + bv->bv_len) - clone->bi_size;
L
Linus Torvalds 已提交
416 417 418
	start = end - bytes;

	start >>= PAGE_SHIFT;
419 420
	if (!clone->bi_size)
		end = clone->bi_vcnt;
L
Linus Torvalds 已提交
421 422 423
	else
		end >>= PAGE_SHIFT;

424 425
	for (i = start; i < end; i++) {
		bv = bio_iovec_idx(clone, i);
L
Linus Torvalds 已提交
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
		BUG_ON(!bv->bv_page);
		mempool_free(bv->bv_page, cc->page_pool);
		bv->bv_page = NULL;
	}
}

/*
 * One of the bios was finished. Check for completion of
 * the whole request and correctly clean up the buffer.
 */
static void dec_pending(struct crypt_io *io, int error)
{
	struct crypt_config *cc = (struct crypt_config *) io->target->private;

	if (error < 0)
		io->error = error;

	if (!atomic_dec_and_test(&io->pending))
		return;

	if (io->first_clone)
		bio_put(io->first_clone);

449
	bio_endio(io->base_bio, io->base_bio->bi_size, io->error);
L
Linus Torvalds 已提交
450 451 452 453 454 455 456 457

	mempool_free(io, cc->io_pool);
}

/*
 * kcryptd:
 *
 * Needed because it would be very unwise to do decryption in an
458
 * interrupt context.
L
Linus Torvalds 已提交
459 460
 */
static struct workqueue_struct *_kcryptd_workqueue;
D
David Howells 已提交
461
static void kcryptd_do_work(struct work_struct *work);
L
Linus Torvalds 已提交
462

463
static void kcryptd_queue_io(struct crypt_io *io)
L
Linus Torvalds 已提交
464
{
D
David Howells 已提交
465
	INIT_WORK(&io->work, kcryptd_do_work);
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
	queue_work(_kcryptd_workqueue, &io->work);
}

static int crypt_endio(struct bio *clone, unsigned int done, int error)
{
	struct crypt_io *io = clone->bi_private;
	struct crypt_config *cc = io->target->private;
	unsigned read_io = bio_data_dir(clone) == READ;

	/*
	 * free the processed pages, even if
	 * it's only a partially completed write
	 */
	if (!read_io)
		crypt_free_buffer_pages(cc, clone, done);

482
	/* keep going - not finished yet */
483 484 485 486 487 488 489 490 491 492 493 494
	if (unlikely(clone->bi_size))
		return 1;

	if (!read_io)
		goto out;

	if (unlikely(!bio_flagged(clone, BIO_UPTODATE))) {
		error = -EIO;
		goto out;
	}

	bio_put(clone);
495
	io->post_process = 1;
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
	kcryptd_queue_io(io);
	return 0;

out:
	bio_put(clone);
	dec_pending(io, error);
	return error;
}

static void clone_init(struct crypt_io *io, struct bio *clone)
{
	struct crypt_config *cc = io->target->private;

	clone->bi_private = io;
	clone->bi_end_io  = crypt_endio;
	clone->bi_bdev    = cc->dev->bdev;
	clone->bi_rw      = io->base_bio->bi_rw;
}

515
static void process_read(struct crypt_io *io)
516 517 518 519
{
	struct crypt_config *cc = io->target->private;
	struct bio *base_bio = io->base_bio;
	struct bio *clone;
520 521 522
	sector_t sector = base_bio->bi_sector - io->target->begin;

	atomic_inc(&io->pending);
523 524 525 526 527 528

	/*
	 * The block layer might modify the bvec array, so always
	 * copy the required bvecs because we need the original
	 * one in order to decrypt the whole bio data *afterwards*.
	 */
M
Milan Broz 已提交
529
	clone = bio_alloc_bioset(GFP_NOIO, bio_segments(base_bio), cc->bs);
530 531
	if (unlikely(!clone)) {
		dec_pending(io, -ENOMEM);
532
		return;
533
	}
534 535

	clone_init(io, clone);
M
Milan Broz 已提交
536
	clone->bi_destructor = dm_crypt_bio_destructor;
537 538 539
	clone->bi_idx = 0;
	clone->bi_vcnt = bio_segments(base_bio);
	clone->bi_size = base_bio->bi_size;
540
	clone->bi_sector = cc->start + sector;
541 542 543
	memcpy(clone->bi_io_vec, bio_iovec(base_bio),
	       sizeof(struct bio_vec) * clone->bi_vcnt);

544
	generic_make_request(clone);
545 546
}

547
static void process_write(struct crypt_io *io)
548 549 550 551
{
	struct crypt_config *cc = io->target->private;
	struct bio *base_bio = io->base_bio;
	struct bio *clone;
552 553 554 555
	struct convert_context ctx;
	unsigned remaining = base_bio->bi_size;
	sector_t sector = base_bio->bi_sector - io->target->begin;
	unsigned bvec_idx = 0;
556

557
	atomic_inc(&io->pending);
558

559
	crypt_convert_init(cc, &ctx, NULL, base_bio, sector, 1);
560

561 562 563 564 565 566 567
	/*
	 * The allocated buffers can be smaller than the whole bio,
	 * so repeat the whole process until all the data can be handled.
	 */
	while (remaining) {
		clone = crypt_alloc_buffer(cc, base_bio->bi_size,
					   io->first_clone, &bvec_idx);
568 569 570 571
		if (unlikely(!clone)) {
			dec_pending(io, -ENOMEM);
			return;
		}
572 573 574 575 576 577

		ctx.bio_out = clone;

		if (unlikely(crypt_convert(cc, &ctx) < 0)) {
			crypt_free_buffer_pages(cc, clone, clone->bi_size);
			bio_put(clone);
578 579
			dec_pending(io, -EIO);
			return;
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
		}

		clone_init(io, clone);
		clone->bi_sector = cc->start + sector;

		if (!io->first_clone) {
			/*
			 * hold a reference to the first clone, because it
			 * holds the bio_vec array and that can't be freed
			 * before all other clones are released
			 */
			bio_get(clone);
			io->first_clone = clone;
		}

		remaining -= clone->bi_size;
		sector += bio_sectors(clone);

598 599 600 601
		/* prevent bio_put of first_clone */
		if (remaining)
			atomic_inc(&io->pending);

602 603 604 605
		generic_make_request(clone);

		/* out of memory -> run queues */
		if (remaining)
606
			congestion_wait(bio_data_dir(clone), HZ/100);
607
	}
608 609 610 611 612
}

static void process_read_endio(struct crypt_io *io)
{
	struct crypt_config *cc = io->target->private;
L
Linus Torvalds 已提交
613 614
	struct convert_context ctx;

615 616
	crypt_convert_init(cc, &ctx, io->base_bio, io->base_bio,
			   io->base_bio->bi_sector - io->target->begin, 0);
L
Linus Torvalds 已提交
617

618
	dec_pending(io, crypt_convert(cc, &ctx));
L
Linus Torvalds 已提交
619 620
}

D
David Howells 已提交
621
static void kcryptd_do_work(struct work_struct *work)
L
Linus Torvalds 已提交
622
{
D
David Howells 已提交
623
	struct crypt_io *io = container_of(work, struct crypt_io, work);
624

625 626 627 628 629 630
	if (io->post_process)
		process_read_endio(io);
	else if (bio_data_dir(io->base_bio) == READ)
		process_read(io);
	else
		process_write(io);
L
Linus Torvalds 已提交
631 632 633 634 635 636 637 638 639 640 641 642 643
}

/*
 * Decode key from its hex representation
 */
static int crypt_decode_key(u8 *key, char *hex, unsigned int size)
{
	char buffer[3];
	char *endp;
	unsigned int i;

	buffer[2] = '\0';

644
	for (i = 0; i < size; i++) {
L
Linus Torvalds 已提交
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
		buffer[0] = *hex++;
		buffer[1] = *hex++;

		key[i] = (u8)simple_strtoul(buffer, &endp, 16);

		if (endp != &buffer[2])
			return -EINVAL;
	}

	if (*hex != '\0')
		return -EINVAL;

	return 0;
}

/*
 * Encode key into its hex representation
 */
static void crypt_encode_key(char *hex, u8 *key, unsigned int size)
{
	unsigned int i;

667
	for (i = 0; i < size; i++) {
L
Linus Torvalds 已提交
668 669 670 671 672 673
		sprintf(hex, "%02x", *key);
		hex += 2;
		key++;
	}
}

M
Milan Broz 已提交
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
static int crypt_set_key(struct crypt_config *cc, char *key)
{
	unsigned key_size = strlen(key) >> 1;

	if (cc->key_size && cc->key_size != key_size)
		return -EINVAL;

	cc->key_size = key_size; /* initial settings */

	if ((!key_size && strcmp(key, "-")) ||
	    (key_size && crypt_decode_key(cc->key, key, key_size) < 0))
		return -EINVAL;

	set_bit(DM_CRYPT_KEY_VALID, &cc->flags);

	return 0;
}

static int crypt_wipe_key(struct crypt_config *cc)
{
	clear_bit(DM_CRYPT_KEY_VALID, &cc->flags);
	memset(&cc->key, 0, cc->key_size * sizeof(u8));
	return 0;
}

L
Linus Torvalds 已提交
699 700 701 702 703 704 705
/*
 * Construct an encryption mapping:
 * <cipher> <key> <iv_offset> <dev_path> <start>
 */
static int crypt_ctr(struct dm_target *ti, unsigned int argc, char **argv)
{
	struct crypt_config *cc;
706
	struct crypto_blkcipher *tfm;
L
Linus Torvalds 已提交
707 708 709 710 711 712
	char *tmp;
	char *cipher;
	char *chainmode;
	char *ivmode;
	char *ivopts;
	unsigned int key_size;
A
Andrew Morton 已提交
713
	unsigned long long tmpll;
L
Linus Torvalds 已提交
714 715

	if (argc != 5) {
716
		ti->error = "Not enough arguments";
L
Linus Torvalds 已提交
717 718 719 720 721 722 723 724 725 726
		return -EINVAL;
	}

	tmp = argv[0];
	cipher = strsep(&tmp, "-");
	chainmode = strsep(&tmp, "-");
	ivopts = strsep(&tmp, "-");
	ivmode = strsep(&ivopts, ":");

	if (tmp)
727
		DMWARN("Unexpected additional cipher options");
L
Linus Torvalds 已提交
728 729 730

	key_size = strlen(argv[1]) >> 1;

M
Milan Broz 已提交
731
 	cc = kzalloc(sizeof(*cc) + key_size * sizeof(u8), GFP_KERNEL);
L
Linus Torvalds 已提交
732 733
	if (cc == NULL) {
		ti->error =
734
			"Cannot allocate transparent encryption context";
L
Linus Torvalds 已提交
735 736 737
		return -ENOMEM;
	}

M
Milan Broz 已提交
738
 	if (crypt_set_key(cc, argv[1])) {
739
		ti->error = "Error decoding key";
L
Linus Torvalds 已提交
740 741 742 743 744 745 746 747 748
		goto bad1;
	}

	/* Compatiblity mode for old dm-crypt cipher strings */
	if (!chainmode || (strcmp(chainmode, "plain") == 0 && !ivmode)) {
		chainmode = "cbc";
		ivmode = "plain";
	}

749 750
	if (strcmp(chainmode, "ecb") && !ivmode) {
		ti->error = "This chaining mode requires an IV mechanism";
L
Linus Torvalds 已提交
751 752 753
		goto bad1;
	}

754 755 756
	if (snprintf(cc->cipher, CRYPTO_MAX_ALG_NAME, "%s(%s)", chainmode, 
		     cipher) >= CRYPTO_MAX_ALG_NAME) {
		ti->error = "Chain mode + cipher name is too long";
L
Linus Torvalds 已提交
757 758 759
		goto bad1;
	}

760 761
	tfm = crypto_alloc_blkcipher(cc->cipher, 0, CRYPTO_ALG_ASYNC);
	if (IS_ERR(tfm)) {
762
		ti->error = "Error allocating crypto tfm";
L
Linus Torvalds 已提交
763 764 765
		goto bad1;
	}

766 767
	strcpy(cc->cipher, cipher);
	strcpy(cc->chainmode, chainmode);
L
Linus Torvalds 已提交
768 769 770 771 772 773 774 775 776 777 778 779 780 781
	cc->tfm = tfm;

	/*
	 * Choose ivmode. Valid modes: "plain", "essiv:<esshash>".
	 * See comments at iv code
	 */

	if (ivmode == NULL)
		cc->iv_gen_ops = NULL;
	else if (strcmp(ivmode, "plain") == 0)
		cc->iv_gen_ops = &crypt_iv_plain_ops;
	else if (strcmp(ivmode, "essiv") == 0)
		cc->iv_gen_ops = &crypt_iv_essiv_ops;
	else {
782
		ti->error = "Invalid IV mode";
L
Linus Torvalds 已提交
783 784 785 786 787 788 789
		goto bad2;
	}

	if (cc->iv_gen_ops && cc->iv_gen_ops->ctr &&
	    cc->iv_gen_ops->ctr(cc, ti, ivopts) < 0)
		goto bad2;

790 791
	cc->iv_size = crypto_blkcipher_ivsize(tfm);
	if (cc->iv_size)
L
Linus Torvalds 已提交
792
		/* at least a 64 bit sector number should fit in our buffer */
793
		cc->iv_size = max(cc->iv_size,
L
Linus Torvalds 已提交
794 795 796
		                  (unsigned int)(sizeof(u64) / sizeof(u8)));
	else {
		if (cc->iv_gen_ops) {
797
			DMWARN("Selected cipher does not support IVs");
L
Linus Torvalds 已提交
798 799 800 801 802 803
			if (cc->iv_gen_ops->dtr)
				cc->iv_gen_ops->dtr(cc);
			cc->iv_gen_ops = NULL;
		}
	}

804
	cc->io_pool = mempool_create_slab_pool(MIN_IOS, _crypt_io_pool);
L
Linus Torvalds 已提交
805
	if (!cc->io_pool) {
806
		ti->error = "Cannot allocate crypt io mempool";
L
Linus Torvalds 已提交
807 808 809
		goto bad3;
	}

810
	cc->page_pool = mempool_create_page_pool(MIN_POOL_PAGES, 0);
L
Linus Torvalds 已提交
811
	if (!cc->page_pool) {
812
		ti->error = "Cannot allocate page mempool";
L
Linus Torvalds 已提交
813 814 815
		goto bad4;
	}

M
Milan Broz 已提交
816 817 818 819 820 821
	cc->bs = bioset_create(MIN_IOS, MIN_IOS, 4);
	if (!cc->bs) {
		ti->error = "Cannot allocate crypt bioset";
		goto bad_bs;
	}

822
	if (crypto_blkcipher_setkey(tfm, cc->key, key_size) < 0) {
823
		ti->error = "Error setting key";
L
Linus Torvalds 已提交
824 825 826
		goto bad5;
	}

A
Andrew Morton 已提交
827
	if (sscanf(argv[2], "%llu", &tmpll) != 1) {
828
		ti->error = "Invalid iv_offset sector";
L
Linus Torvalds 已提交
829 830
		goto bad5;
	}
A
Andrew Morton 已提交
831
	cc->iv_offset = tmpll;
L
Linus Torvalds 已提交
832

A
Andrew Morton 已提交
833
	if (sscanf(argv[4], "%llu", &tmpll) != 1) {
834
		ti->error = "Invalid device sector";
L
Linus Torvalds 已提交
835 836
		goto bad5;
	}
A
Andrew Morton 已提交
837
	cc->start = tmpll;
L
Linus Torvalds 已提交
838 839 840

	if (dm_get_device(ti, argv[3], cc->start, ti->len,
	                  dm_table_get_mode(ti->table), &cc->dev)) {
841
		ti->error = "Device lookup failed";
L
Linus Torvalds 已提交
842 843 844 845 846 847 848 849
		goto bad5;
	}

	if (ivmode && cc->iv_gen_ops) {
		if (ivopts)
			*(ivopts - 1) = ':';
		cc->iv_mode = kmalloc(strlen(ivmode) + 1, GFP_KERNEL);
		if (!cc->iv_mode) {
850
			ti->error = "Error kmallocing iv_mode string";
L
Linus Torvalds 已提交
851 852 853 854 855 856 857 858 859 860
			goto bad5;
		}
		strcpy(cc->iv_mode, ivmode);
	} else
		cc->iv_mode = NULL;

	ti->private = cc;
	return 0;

bad5:
M
Milan Broz 已提交
861 862
	bioset_free(cc->bs);
bad_bs:
L
Linus Torvalds 已提交
863 864 865 866 867 868 869
	mempool_destroy(cc->page_pool);
bad4:
	mempool_destroy(cc->io_pool);
bad3:
	if (cc->iv_gen_ops && cc->iv_gen_ops->dtr)
		cc->iv_gen_ops->dtr(cc);
bad2:
870
	crypto_free_blkcipher(tfm);
L
Linus Torvalds 已提交
871
bad1:
872 873
	/* Must zero key material before freeing */
	memset(cc, 0, sizeof(*cc) + cc->key_size * sizeof(u8));
L
Linus Torvalds 已提交
874 875 876 877 878 879 880 881
	kfree(cc);
	return -EINVAL;
}

static void crypt_dtr(struct dm_target *ti)
{
	struct crypt_config *cc = (struct crypt_config *) ti->private;

M
Milan Broz 已提交
882
	bioset_free(cc->bs);
L
Linus Torvalds 已提交
883 884 885
	mempool_destroy(cc->page_pool);
	mempool_destroy(cc->io_pool);

886
	kfree(cc->iv_mode);
L
Linus Torvalds 已提交
887 888
	if (cc->iv_gen_ops && cc->iv_gen_ops->dtr)
		cc->iv_gen_ops->dtr(cc);
889
	crypto_free_blkcipher(cc->tfm);
L
Linus Torvalds 已提交
890
	dm_put_device(ti, cc->dev);
891 892 893

	/* Must zero key material before freeing */
	memset(cc, 0, sizeof(*cc) + cc->key_size * sizeof(u8));
L
Linus Torvalds 已提交
894 895 896 897 898 899
	kfree(cc);
}

static int crypt_map(struct dm_target *ti, struct bio *bio,
		     union map_info *map_context)
{
900
	struct crypt_config *cc = ti->private;
M
Milan Broz 已提交
901
	struct crypt_io *io;
L
Linus Torvalds 已提交
902

M
Milan Broz 已提交
903
	io = mempool_alloc(cc->io_pool, GFP_NOIO);
L
Linus Torvalds 已提交
904
	io->target = ti;
905
	io->base_bio = bio;
L
Linus Torvalds 已提交
906
	io->first_clone = NULL;
907
	io->error = io->post_process = 0;
908
	atomic_set(&io->pending, 0);
909
	kcryptd_queue_io(io);
L
Linus Torvalds 已提交
910

911
	return 0;
L
Linus Torvalds 已提交
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
}

static int crypt_status(struct dm_target *ti, status_type_t type,
			char *result, unsigned int maxlen)
{
	struct crypt_config *cc = (struct crypt_config *) ti->private;
	unsigned int sz = 0;

	switch (type) {
	case STATUSTYPE_INFO:
		result[0] = '\0';
		break;

	case STATUSTYPE_TABLE:
		if (cc->iv_mode)
927 928
			DMEMIT("%s-%s-%s ", cc->cipher, cc->chainmode,
			       cc->iv_mode);
L
Linus Torvalds 已提交
929
		else
930
			DMEMIT("%s-%s ", cc->cipher, cc->chainmode);
L
Linus Torvalds 已提交
931 932 933 934 935 936 937 938 939 940 941 942 943

		if (cc->key_size > 0) {
			if ((maxlen - sz) < ((cc->key_size << 1) + 1))
				return -ENOMEM;

			crypt_encode_key(result + sz, cc->key, cc->key_size);
			sz += cc->key_size << 1;
		} else {
			if (sz >= maxlen)
				return -ENOMEM;
			result[sz++] = '-';
		}

A
Andrew Morton 已提交
944 945
		DMEMIT(" %llu %s %llu", (unsigned long long)cc->iv_offset,
				cc->dev->name, (unsigned long long)cc->start);
L
Linus Torvalds 已提交
946 947 948 949 950
		break;
	}
	return 0;
}

M
Milan Broz 已提交
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
static void crypt_postsuspend(struct dm_target *ti)
{
	struct crypt_config *cc = ti->private;

	set_bit(DM_CRYPT_SUSPENDED, &cc->flags);
}

static int crypt_preresume(struct dm_target *ti)
{
	struct crypt_config *cc = ti->private;

	if (!test_bit(DM_CRYPT_KEY_VALID, &cc->flags)) {
		DMERR("aborting resume - crypt key is not set.");
		return -EAGAIN;
	}

	return 0;
}

static void crypt_resume(struct dm_target *ti)
{
	struct crypt_config *cc = ti->private;

	clear_bit(DM_CRYPT_SUSPENDED, &cc->flags);
}

/* Message interface
 *	key set <key>
 *	key wipe
 */
static int crypt_message(struct dm_target *ti, unsigned argc, char **argv)
{
	struct crypt_config *cc = ti->private;

	if (argc < 2)
		goto error;

	if (!strnicmp(argv[0], MESG_STR("key"))) {
		if (!test_bit(DM_CRYPT_SUSPENDED, &cc->flags)) {
			DMWARN("not suspended during key manipulation.");
			return -EINVAL;
		}
		if (argc == 3 && !strnicmp(argv[1], MESG_STR("set")))
			return crypt_set_key(cc, argv[2]);
		if (argc == 2 && !strnicmp(argv[1], MESG_STR("wipe")))
			return crypt_wipe_key(cc);
	}

error:
	DMWARN("unrecognised message received.");
	return -EINVAL;
}

L
Linus Torvalds 已提交
1004 1005
static struct target_type crypt_target = {
	.name   = "crypt",
1006
	.version= {1, 3, 0},
L
Linus Torvalds 已提交
1007 1008 1009 1010 1011
	.module = THIS_MODULE,
	.ctr    = crypt_ctr,
	.dtr    = crypt_dtr,
	.map    = crypt_map,
	.status = crypt_status,
M
Milan Broz 已提交
1012 1013 1014 1015
	.postsuspend = crypt_postsuspend,
	.preresume = crypt_preresume,
	.resume = crypt_resume,
	.message = crypt_message,
L
Linus Torvalds 已提交
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
};

static int __init dm_crypt_init(void)
{
	int r;

	_crypt_io_pool = kmem_cache_create("dm-crypt_io",
	                                   sizeof(struct crypt_io),
	                                   0, 0, NULL, NULL);
	if (!_crypt_io_pool)
		return -ENOMEM;

	_kcryptd_workqueue = create_workqueue("kcryptd");
	if (!_kcryptd_workqueue) {
		r = -ENOMEM;
1031
		DMERR("couldn't create kcryptd");
L
Linus Torvalds 已提交
1032 1033 1034 1035 1036
		goto bad1;
	}

	r = dm_register_target(&crypt_target);
	if (r < 0) {
1037
		DMERR("register failed %d", r);
L
Linus Torvalds 已提交
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
		goto bad2;
	}

	return 0;

bad2:
	destroy_workqueue(_kcryptd_workqueue);
bad1:
	kmem_cache_destroy(_crypt_io_pool);
	return r;
}

static void __exit dm_crypt_exit(void)
{
	int r = dm_unregister_target(&crypt_target);

	if (r < 0)
1055
		DMERR("unregister failed %d", r);
L
Linus Torvalds 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066

	destroy_workqueue(_kcryptd_workqueue);
	kmem_cache_destroy(_crypt_io_pool);
}

module_init(dm_crypt_init);
module_exit(dm_crypt_exit);

MODULE_AUTHOR("Christophe Saout <christophe@saout.de>");
MODULE_DESCRIPTION(DM_NAME " target for transparent encryption / decryption");
MODULE_LICENSE("GPL");