1 /* 2 * Copyright (C) 2003 Jana Saout <jana@saout.de> 3 * Copyright (C) 2004 Clemens Fruhwirth <clemens@endorphin.org> 4 * Copyright (C) 2006-2020 Red Hat, Inc. All rights reserved. 5 * Copyright (C) 2013-2020 Milan Broz <gmazyland@gmail.com> 6 * 7 * This file is released under the GPL. 8 */ 9 10 #include <linux/completion.h> 11 #include <linux/err.h> 12 #include <linux/module.h> 13 #include <linux/init.h> 14 #include <linux/kernel.h> 15 #include <linux/key.h> 16 #include <linux/bio.h> 17 #include <linux/blkdev.h> 18 #include <linux/blk-integrity.h> 19 #include <linux/mempool.h> 20 #include <linux/slab.h> 21 #include <linux/crypto.h> 22 #include <linux/workqueue.h> 23 #include <linux/kthread.h> 24 #include <linux/backing-dev.h> 25 #include <linux/atomic.h> 26 #include <linux/scatterlist.h> 27 #include <linux/rbtree.h> 28 #include <linux/ctype.h> 29 #include <asm/page.h> 30 #include <asm/unaligned.h> 31 #include <crypto/hash.h> 32 #include <crypto/md5.h> 33 #include <crypto/algapi.h> 34 #include <crypto/skcipher.h> 35 #include <crypto/aead.h> 36 #include <crypto/authenc.h> 37 #include <linux/rtnetlink.h> /* for struct rtattr and RTA macros only */ 38 #include <linux/key-type.h> 39 #include <keys/user-type.h> 40 #include <keys/encrypted-type.h> 41 #include <keys/trusted-type.h> 42 43 #include <linux/device-mapper.h> 44 45 #include "dm-audit.h" 46 47 #define DM_MSG_PREFIX "crypt" 48 49 /* 50 * context holding the current state of a multi-part conversion 51 */ 52 struct convert_context { 53 struct completion restart; 54 struct bio *bio_in; 55 struct bio *bio_out; 56 struct bvec_iter iter_in; 57 struct bvec_iter iter_out; 58 u64 cc_sector; 59 atomic_t cc_pending; 60 union { 61 struct skcipher_request *req; 62 struct aead_request *req_aead; 63 } r; 64 65 }; 66 67 /* 68 * per bio private data 69 */ 70 struct dm_crypt_io { 71 struct crypt_config *cc; 72 struct bio *base_bio; 73 u8 *integrity_metadata; 74 bool integrity_metadata_from_pool; 75 struct work_struct work; 76 struct tasklet_struct tasklet; 77 78 struct convert_context ctx; 79 80 atomic_t io_pending; 81 blk_status_t error; 82 sector_t sector; 83 84 struct rb_node rb_node; 85 } CRYPTO_MINALIGN_ATTR; 86 87 struct dm_crypt_request { 88 struct convert_context *ctx; 89 struct scatterlist sg_in[4]; 90 struct scatterlist sg_out[4]; 91 u64 iv_sector; 92 }; 93 94 struct crypt_config; 95 96 struct crypt_iv_operations { 97 int (*ctr)(struct crypt_config *cc, struct dm_target *ti, 98 const char *opts); 99 void (*dtr)(struct crypt_config *cc); 100 int (*init)(struct crypt_config *cc); 101 int (*wipe)(struct crypt_config *cc); 102 int (*generator)(struct crypt_config *cc, u8 *iv, 103 struct dm_crypt_request *dmreq); 104 int (*post)(struct crypt_config *cc, u8 *iv, 105 struct dm_crypt_request *dmreq); 106 }; 107 108 struct iv_benbi_private { 109 int shift; 110 }; 111 112 #define LMK_SEED_SIZE 64 /* hash + 0 */ 113 struct iv_lmk_private { 114 struct crypto_shash *hash_tfm; 115 u8 *seed; 116 }; 117 118 #define TCW_WHITENING_SIZE 16 119 struct iv_tcw_private { 120 struct crypto_shash *crc32_tfm; 121 u8 *iv_seed; 122 u8 *whitening; 123 }; 124 125 #define ELEPHANT_MAX_KEY_SIZE 32 126 struct iv_elephant_private { 127 struct crypto_skcipher *tfm; 128 }; 129 130 /* 131 * Crypt: maps a linear range of a block device 132 * and encrypts / decrypts at the same time. 133 */ 134 enum flags { DM_CRYPT_SUSPENDED, DM_CRYPT_KEY_VALID, 135 DM_CRYPT_SAME_CPU, DM_CRYPT_NO_OFFLOAD, 136 DM_CRYPT_NO_READ_WORKQUEUE, DM_CRYPT_NO_WRITE_WORKQUEUE, 137 DM_CRYPT_WRITE_INLINE }; 138 139 enum cipher_flags { 140 CRYPT_MODE_INTEGRITY_AEAD, /* Use authenticated mode for cipher */ 141 CRYPT_IV_LARGE_SECTORS, /* Calculate IV from sector_size, not 512B sectors */ 142 CRYPT_ENCRYPT_PREPROCESS, /* Must preprocess data for encryption (elephant) */ 143 }; 144 145 /* 146 * The fields in here must be read only after initialization. 147 */ 148 struct crypt_config { 149 struct dm_dev *dev; 150 sector_t start; 151 152 struct percpu_counter n_allocated_pages; 153 154 struct workqueue_struct *io_queue; 155 struct workqueue_struct *crypt_queue; 156 157 spinlock_t write_thread_lock; 158 struct task_struct *write_thread; 159 struct rb_root write_tree; 160 161 char *cipher_string; 162 char *cipher_auth; 163 char *key_string; 164 165 const struct crypt_iv_operations *iv_gen_ops; 166 union { 167 struct iv_benbi_private benbi; 168 struct iv_lmk_private lmk; 169 struct iv_tcw_private tcw; 170 struct iv_elephant_private elephant; 171 } iv_gen_private; 172 u64 iv_offset; 173 unsigned int iv_size; 174 unsigned short int sector_size; 175 unsigned char sector_shift; 176 177 union { 178 struct crypto_skcipher **tfms; 179 struct crypto_aead **tfms_aead; 180 } cipher_tfm; 181 unsigned tfms_count; 182 unsigned long cipher_flags; 183 184 /* 185 * Layout of each crypto request: 186 * 187 * struct skcipher_request 188 * context 189 * padding 190 * struct dm_crypt_request 191 * padding 192 * IV 193 * 194 * The padding is added so that dm_crypt_request and the IV are 195 * correctly aligned. 196 */ 197 unsigned int dmreq_start; 198 199 unsigned int per_bio_data_size; 200 201 unsigned long flags; 202 unsigned int key_size; 203 unsigned int key_parts; /* independent parts in key buffer */ 204 unsigned int key_extra_size; /* additional keys length */ 205 unsigned int key_mac_size; /* MAC key size for authenc(...) */ 206 207 unsigned int integrity_tag_size; 208 unsigned int integrity_iv_size; 209 unsigned int on_disk_tag_size; 210 211 /* 212 * pool for per bio private data, crypto requests, 213 * encryption requeusts/buffer pages and integrity tags 214 */ 215 unsigned tag_pool_max_sectors; 216 mempool_t tag_pool; 217 mempool_t req_pool; 218 mempool_t page_pool; 219 220 struct bio_set bs; 221 struct mutex bio_alloc_lock; 222 223 u8 *authenc_key; /* space for keys in authenc() format (if used) */ 224 u8 key[]; 225 }; 226 227 #define MIN_IOS 64 228 #define MAX_TAG_SIZE 480 229 #define POOL_ENTRY_SIZE 512 230 231 static DEFINE_SPINLOCK(dm_crypt_clients_lock); 232 static unsigned dm_crypt_clients_n = 0; 233 static volatile unsigned long dm_crypt_pages_per_client; 234 #define DM_CRYPT_MEMORY_PERCENT 2 235 #define DM_CRYPT_MIN_PAGES_PER_CLIENT (BIO_MAX_VECS * 16) 236 237 static void crypt_endio(struct bio *clone); 238 static void kcryptd_queue_crypt(struct dm_crypt_io *io); 239 static struct scatterlist *crypt_get_sg_data(struct crypt_config *cc, 240 struct scatterlist *sg); 241 242 static bool crypt_integrity_aead(struct crypt_config *cc); 243 244 /* 245 * Use this to access cipher attributes that are independent of the key. 246 */ 247 static struct crypto_skcipher *any_tfm(struct crypt_config *cc) 248 { 249 return cc->cipher_tfm.tfms[0]; 250 } 251 252 static struct crypto_aead *any_tfm_aead(struct crypt_config *cc) 253 { 254 return cc->cipher_tfm.tfms_aead[0]; 255 } 256 257 /* 258 * Different IV generation algorithms: 259 * 260 * plain: the initial vector is the 32-bit little-endian version of the sector 261 * number, padded with zeros if necessary. 262 * 263 * plain64: the initial vector is the 64-bit little-endian version of the sector 264 * number, padded with zeros if necessary. 265 * 266 * plain64be: the initial vector is the 64-bit big-endian version of the sector 267 * number, padded with zeros if necessary. 268 * 269 * essiv: "encrypted sector|salt initial vector", the sector number is 270 * encrypted with the bulk cipher using a salt as key. The salt 271 * should be derived from the bulk cipher's key via hashing. 272 * 273 * benbi: the 64-bit "big-endian 'narrow block'-count", starting at 1 274 * (needed for LRW-32-AES and possible other narrow block modes) 275 * 276 * null: the initial vector is always zero. Provides compatibility with 277 * obsolete loop_fish2 devices. Do not use for new devices. 278 * 279 * lmk: Compatible implementation of the block chaining mode used 280 * by the Loop-AES block device encryption system 281 * designed by Jari Ruusu. See http://loop-aes.sourceforge.net/ 282 * It operates on full 512 byte sectors and uses CBC 283 * with an IV derived from the sector number, the data and 284 * optionally extra IV seed. 285 * This means that after decryption the first block 286 * of sector must be tweaked according to decrypted data. 287 * Loop-AES can use three encryption schemes: 288 * version 1: is plain aes-cbc mode 289 * version 2: uses 64 multikey scheme with lmk IV generator 290 * version 3: the same as version 2 with additional IV seed 291 * (it uses 65 keys, last key is used as IV seed) 292 * 293 * tcw: Compatible implementation of the block chaining mode used 294 * by the TrueCrypt device encryption system (prior to version 4.1). 295 * For more info see: https://gitlab.com/cryptsetup/cryptsetup/wikis/TrueCryptOnDiskFormat 296 * It operates on full 512 byte sectors and uses CBC 297 * with an IV derived from initial key and the sector number. 298 * In addition, whitening value is applied on every sector, whitening 299 * is calculated from initial key, sector number and mixed using CRC32. 300 * Note that this encryption scheme is vulnerable to watermarking attacks 301 * and should be used for old compatible containers access only. 302 * 303 * eboiv: Encrypted byte-offset IV (used in Bitlocker in CBC mode) 304 * The IV is encrypted little-endian byte-offset (with the same key 305 * and cipher as the volume). 306 * 307 * elephant: The extended version of eboiv with additional Elephant diffuser 308 * used with Bitlocker CBC mode. 309 * This mode was used in older Windows systems 310 * https://download.microsoft.com/download/0/2/3/0238acaf-d3bf-4a6d-b3d6-0a0be4bbb36e/bitlockercipher200608.pdf 311 */ 312 313 static int crypt_iv_plain_gen(struct crypt_config *cc, u8 *iv, 314 struct dm_crypt_request *dmreq) 315 { 316 memset(iv, 0, cc->iv_size); 317 *(__le32 *)iv = cpu_to_le32(dmreq->iv_sector & 0xffffffff); 318 319 return 0; 320 } 321 322 static int crypt_iv_plain64_gen(struct crypt_config *cc, u8 *iv, 323 struct dm_crypt_request *dmreq) 324 { 325 memset(iv, 0, cc->iv_size); 326 *(__le64 *)iv = cpu_to_le64(dmreq->iv_sector); 327 328 return 0; 329 } 330 331 static int crypt_iv_plain64be_gen(struct crypt_config *cc, u8 *iv, 332 struct dm_crypt_request *dmreq) 333 { 334 memset(iv, 0, cc->iv_size); 335 /* iv_size is at least of size u64; usually it is 16 bytes */ 336 *(__be64 *)&iv[cc->iv_size - sizeof(u64)] = cpu_to_be64(dmreq->iv_sector); 337 338 return 0; 339 } 340 341 static int crypt_iv_essiv_gen(struct crypt_config *cc, u8 *iv, 342 struct dm_crypt_request *dmreq) 343 { 344 /* 345 * ESSIV encryption of the IV is now handled by the crypto API, 346 * so just pass the plain sector number here. 347 */ 348 memset(iv, 0, cc->iv_size); 349 *(__le64 *)iv = cpu_to_le64(dmreq->iv_sector); 350 351 return 0; 352 } 353 354 static int crypt_iv_benbi_ctr(struct crypt_config *cc, struct dm_target *ti, 355 const char *opts) 356 { 357 unsigned bs; 358 int log; 359 360 if (crypt_integrity_aead(cc)) 361 bs = crypto_aead_blocksize(any_tfm_aead(cc)); 362 else 363 bs = crypto_skcipher_blocksize(any_tfm(cc)); 364 log = ilog2(bs); 365 366 /* we need to calculate how far we must shift the sector count 367 * to get the cipher block count, we use this shift in _gen */ 368 369 if (1 << log != bs) { 370 ti->error = "cypher blocksize is not a power of 2"; 371 return -EINVAL; 372 } 373 374 if (log > 9) { 375 ti->error = "cypher blocksize is > 512"; 376 return -EINVAL; 377 } 378 379 cc->iv_gen_private.benbi.shift = 9 - log; 380 381 return 0; 382 } 383 384 static void crypt_iv_benbi_dtr(struct crypt_config *cc) 385 { 386 } 387 388 static int crypt_iv_benbi_gen(struct crypt_config *cc, u8 *iv, 389 struct dm_crypt_request *dmreq) 390 { 391 __be64 val; 392 393 memset(iv, 0, cc->iv_size - sizeof(u64)); /* rest is cleared below */ 394 395 val = cpu_to_be64(((u64)dmreq->iv_sector << cc->iv_gen_private.benbi.shift) + 1); 396 put_unaligned(val, (__be64 *)(iv + cc->iv_size - sizeof(u64))); 397 398 return 0; 399 } 400 401 static int crypt_iv_null_gen(struct crypt_config *cc, u8 *iv, 402 struct dm_crypt_request *dmreq) 403 { 404 memset(iv, 0, cc->iv_size); 405 406 return 0; 407 } 408 409 static void crypt_iv_lmk_dtr(struct crypt_config *cc) 410 { 411 struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk; 412 413 if (lmk->hash_tfm && !IS_ERR(lmk->hash_tfm)) 414 crypto_free_shash(lmk->hash_tfm); 415 lmk->hash_tfm = NULL; 416 417 kfree_sensitive(lmk->seed); 418 lmk->seed = NULL; 419 } 420 421 static int crypt_iv_lmk_ctr(struct crypt_config *cc, struct dm_target *ti, 422 const char *opts) 423 { 424 struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk; 425 426 if (cc->sector_size != (1 << SECTOR_SHIFT)) { 427 ti->error = "Unsupported sector size for LMK"; 428 return -EINVAL; 429 } 430 431 lmk->hash_tfm = crypto_alloc_shash("md5", 0, 432 CRYPTO_ALG_ALLOCATES_MEMORY); 433 if (IS_ERR(lmk->hash_tfm)) { 434 ti->error = "Error initializing LMK hash"; 435 return PTR_ERR(lmk->hash_tfm); 436 } 437 438 /* No seed in LMK version 2 */ 439 if (cc->key_parts == cc->tfms_count) { 440 lmk->seed = NULL; 441 return 0; 442 } 443 444 lmk->seed = kzalloc(LMK_SEED_SIZE, GFP_KERNEL); 445 if (!lmk->seed) { 446 crypt_iv_lmk_dtr(cc); 447 ti->error = "Error kmallocing seed storage in LMK"; 448 return -ENOMEM; 449 } 450 451 return 0; 452 } 453 454 static int crypt_iv_lmk_init(struct crypt_config *cc) 455 { 456 struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk; 457 int subkey_size = cc->key_size / cc->key_parts; 458 459 /* LMK seed is on the position of LMK_KEYS + 1 key */ 460 if (lmk->seed) 461 memcpy(lmk->seed, cc->key + (cc->tfms_count * subkey_size), 462 crypto_shash_digestsize(lmk->hash_tfm)); 463 464 return 0; 465 } 466 467 static int crypt_iv_lmk_wipe(struct crypt_config *cc) 468 { 469 struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk; 470 471 if (lmk->seed) 472 memset(lmk->seed, 0, LMK_SEED_SIZE); 473 474 return 0; 475 } 476 477 static int crypt_iv_lmk_one(struct crypt_config *cc, u8 *iv, 478 struct dm_crypt_request *dmreq, 479 u8 *data) 480 { 481 struct iv_lmk_private *lmk = &cc->iv_gen_private.lmk; 482 SHASH_DESC_ON_STACK(desc, lmk->hash_tfm); 483 struct md5_state md5state; 484 __le32 buf[4]; 485 int i, r; 486 487 desc->tfm = lmk->hash_tfm; 488 489 r = crypto_shash_init(desc); 490 if (r) 491 return r; 492 493 if (lmk->seed) { 494 r = crypto_shash_update(desc, lmk->seed, LMK_SEED_SIZE); 495 if (r) 496 return r; 497 } 498 499 /* Sector is always 512B, block size 16, add data of blocks 1-31 */ 500 r = crypto_shash_update(desc, data + 16, 16 * 31); 501 if (r) 502 return r; 503 504 /* Sector is cropped to 56 bits here */ 505 buf[0] = cpu_to_le32(dmreq->iv_sector & 0xFFFFFFFF); 506 buf[1] = cpu_to_le32((((u64)dmreq->iv_sector >> 32) & 0x00FFFFFF) | 0x80000000); 507 buf[2] = cpu_to_le32(4024); 508 buf[3] = 0; 509 r = crypto_shash_update(desc, (u8 *)buf, sizeof(buf)); 510 if (r) 511 return r; 512 513 /* No MD5 padding here */ 514 r = crypto_shash_export(desc, &md5state); 515 if (r) 516 return r; 517 518 for (i = 0; i < MD5_HASH_WORDS; i++) 519 __cpu_to_le32s(&md5state.hash[i]); 520 memcpy(iv, &md5state.hash, cc->iv_size); 521 522 return 0; 523 } 524 525 static int crypt_iv_lmk_gen(struct crypt_config *cc, u8 *iv, 526 struct dm_crypt_request *dmreq) 527 { 528 struct scatterlist *sg; 529 u8 *src; 530 int r = 0; 531 532 if (bio_data_dir(dmreq->ctx->bio_in) == WRITE) { 533 sg = crypt_get_sg_data(cc, dmreq->sg_in); 534 src = kmap_atomic(sg_page(sg)); 535 r = crypt_iv_lmk_one(cc, iv, dmreq, src + sg->offset); 536 kunmap_atomic(src); 537 } else 538 memset(iv, 0, cc->iv_size); 539 540 return r; 541 } 542 543 static int crypt_iv_lmk_post(struct crypt_config *cc, u8 *iv, 544 struct dm_crypt_request *dmreq) 545 { 546 struct scatterlist *sg; 547 u8 *dst; 548 int r; 549 550 if (bio_data_dir(dmreq->ctx->bio_in) == WRITE) 551 return 0; 552 553 sg = crypt_get_sg_data(cc, dmreq->sg_out); 554 dst = kmap_atomic(sg_page(sg)); 555 r = crypt_iv_lmk_one(cc, iv, dmreq, dst + sg->offset); 556 557 /* Tweak the first block of plaintext sector */ 558 if (!r) 559 crypto_xor(dst + sg->offset, iv, cc->iv_size); 560 561 kunmap_atomic(dst); 562 return r; 563 } 564 565 static void crypt_iv_tcw_dtr(struct crypt_config *cc) 566 { 567 struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw; 568 569 kfree_sensitive(tcw->iv_seed); 570 tcw->iv_seed = NULL; 571 kfree_sensitive(tcw->whitening); 572 tcw->whitening = NULL; 573 574 if (tcw->crc32_tfm && !IS_ERR(tcw->crc32_tfm)) 575 crypto_free_shash(tcw->crc32_tfm); 576 tcw->crc32_tfm = NULL; 577 } 578 579 static int crypt_iv_tcw_ctr(struct crypt_config *cc, struct dm_target *ti, 580 const char *opts) 581 { 582 struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw; 583 584 if (cc->sector_size != (1 << SECTOR_SHIFT)) { 585 ti->error = "Unsupported sector size for TCW"; 586 return -EINVAL; 587 } 588 589 if (cc->key_size <= (cc->iv_size + TCW_WHITENING_SIZE)) { 590 ti->error = "Wrong key size for TCW"; 591 return -EINVAL; 592 } 593 594 tcw->crc32_tfm = crypto_alloc_shash("crc32", 0, 595 CRYPTO_ALG_ALLOCATES_MEMORY); 596 if (IS_ERR(tcw->crc32_tfm)) { 597 ti->error = "Error initializing CRC32 in TCW"; 598 return PTR_ERR(tcw->crc32_tfm); 599 } 600 601 tcw->iv_seed = kzalloc(cc->iv_size, GFP_KERNEL); 602 tcw->whitening = kzalloc(TCW_WHITENING_SIZE, GFP_KERNEL); 603 if (!tcw->iv_seed || !tcw->whitening) { 604 crypt_iv_tcw_dtr(cc); 605 ti->error = "Error allocating seed storage in TCW"; 606 return -ENOMEM; 607 } 608 609 return 0; 610 } 611 612 static int crypt_iv_tcw_init(struct crypt_config *cc) 613 { 614 struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw; 615 int key_offset = cc->key_size - cc->iv_size - TCW_WHITENING_SIZE; 616 617 memcpy(tcw->iv_seed, &cc->key[key_offset], cc->iv_size); 618 memcpy(tcw->whitening, &cc->key[key_offset + cc->iv_size], 619 TCW_WHITENING_SIZE); 620 621 return 0; 622 } 623 624 static int crypt_iv_tcw_wipe(struct crypt_config *cc) 625 { 626 struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw; 627 628 memset(tcw->iv_seed, 0, cc->iv_size); 629 memset(tcw->whitening, 0, TCW_WHITENING_SIZE); 630 631 return 0; 632 } 633 634 static int crypt_iv_tcw_whitening(struct crypt_config *cc, 635 struct dm_crypt_request *dmreq, 636 u8 *data) 637 { 638 struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw; 639 __le64 sector = cpu_to_le64(dmreq->iv_sector); 640 u8 buf[TCW_WHITENING_SIZE]; 641 SHASH_DESC_ON_STACK(desc, tcw->crc32_tfm); 642 int i, r; 643 644 /* xor whitening with sector number */ 645 crypto_xor_cpy(buf, tcw->whitening, (u8 *)§or, 8); 646 crypto_xor_cpy(&buf[8], tcw->whitening + 8, (u8 *)§or, 8); 647 648 /* calculate crc32 for every 32bit part and xor it */ 649 desc->tfm = tcw->crc32_tfm; 650 for (i = 0; i < 4; i++) { 651 r = crypto_shash_init(desc); 652 if (r) 653 goto out; 654 r = crypto_shash_update(desc, &buf[i * 4], 4); 655 if (r) 656 goto out; 657 r = crypto_shash_final(desc, &buf[i * 4]); 658 if (r) 659 goto out; 660 } 661 crypto_xor(&buf[0], &buf[12], 4); 662 crypto_xor(&buf[4], &buf[8], 4); 663 664 /* apply whitening (8 bytes) to whole sector */ 665 for (i = 0; i < ((1 << SECTOR_SHIFT) / 8); i++) 666 crypto_xor(data + i * 8, buf, 8); 667 out: 668 memzero_explicit(buf, sizeof(buf)); 669 return r; 670 } 671 672 static int crypt_iv_tcw_gen(struct crypt_config *cc, u8 *iv, 673 struct dm_crypt_request *dmreq) 674 { 675 struct scatterlist *sg; 676 struct iv_tcw_private *tcw = &cc->iv_gen_private.tcw; 677 __le64 sector = cpu_to_le64(dmreq->iv_sector); 678 u8 *src; 679 int r = 0; 680 681 /* Remove whitening from ciphertext */ 682 if (bio_data_dir(dmreq->ctx->bio_in) != WRITE) { 683 sg = crypt_get_sg_data(cc, dmreq->sg_in); 684 src = kmap_atomic(sg_page(sg)); 685 r = crypt_iv_tcw_whitening(cc, dmreq, src + sg->offset); 686 kunmap_atomic(src); 687 } 688 689 /* Calculate IV */ 690 crypto_xor_cpy(iv, tcw->iv_seed, (u8 *)§or, 8); 691 if (cc->iv_size > 8) 692 crypto_xor_cpy(&iv[8], tcw->iv_seed + 8, (u8 *)§or, 693 cc->iv_size - 8); 694 695 return r; 696 } 697 698 static int crypt_iv_tcw_post(struct crypt_config *cc, u8 *iv, 699 struct dm_crypt_request *dmreq) 700 { 701 struct scatterlist *sg; 702 u8 *dst; 703 int r; 704 705 if (bio_data_dir(dmreq->ctx->bio_in) != WRITE) 706 return 0; 707 708 /* Apply whitening on ciphertext */ 709 sg = crypt_get_sg_data(cc, dmreq->sg_out); 710 dst = kmap_atomic(sg_page(sg)); 711 r = crypt_iv_tcw_whitening(cc, dmreq, dst + sg->offset); 712 kunmap_atomic(dst); 713 714 return r; 715 } 716 717 static int crypt_iv_random_gen(struct crypt_config *cc, u8 *iv, 718 struct dm_crypt_request *dmreq) 719 { 720 /* Used only for writes, there must be an additional space to store IV */ 721 get_random_bytes(iv, cc->iv_size); 722 return 0; 723 } 724 725 static int crypt_iv_eboiv_ctr(struct crypt_config *cc, struct dm_target *ti, 726 const char *opts) 727 { 728 if (crypt_integrity_aead(cc)) { 729 ti->error = "AEAD transforms not supported for EBOIV"; 730 return -EINVAL; 731 } 732 733 if (crypto_skcipher_blocksize(any_tfm(cc)) != cc->iv_size) { 734 ti->error = "Block size of EBOIV cipher does " 735 "not match IV size of block cipher"; 736 return -EINVAL; 737 } 738 739 return 0; 740 } 741 742 static int crypt_iv_eboiv_gen(struct crypt_config *cc, u8 *iv, 743 struct dm_crypt_request *dmreq) 744 { 745 u8 buf[MAX_CIPHER_BLOCKSIZE] __aligned(__alignof__(__le64)); 746 struct skcipher_request *req; 747 struct scatterlist src, dst; 748 DECLARE_CRYPTO_WAIT(wait); 749 int err; 750 751 req = skcipher_request_alloc(any_tfm(cc), GFP_NOIO); 752 if (!req) 753 return -ENOMEM; 754 755 memset(buf, 0, cc->iv_size); 756 *(__le64 *)buf = cpu_to_le64(dmreq->iv_sector * cc->sector_size); 757 758 sg_init_one(&src, page_address(ZERO_PAGE(0)), cc->iv_size); 759 sg_init_one(&dst, iv, cc->iv_size); 760 skcipher_request_set_crypt(req, &src, &dst, cc->iv_size, buf); 761 skcipher_request_set_callback(req, 0, crypto_req_done, &wait); 762 err = crypto_wait_req(crypto_skcipher_encrypt(req), &wait); 763 skcipher_request_free(req); 764 765 return err; 766 } 767 768 static void crypt_iv_elephant_dtr(struct crypt_config *cc) 769 { 770 struct iv_elephant_private *elephant = &cc->iv_gen_private.elephant; 771 772 crypto_free_skcipher(elephant->tfm); 773 elephant->tfm = NULL; 774 } 775 776 static int crypt_iv_elephant_ctr(struct crypt_config *cc, struct dm_target *ti, 777 const char *opts) 778 { 779 struct iv_elephant_private *elephant = &cc->iv_gen_private.elephant; 780 int r; 781 782 elephant->tfm = crypto_alloc_skcipher("ecb(aes)", 0, 783 CRYPTO_ALG_ALLOCATES_MEMORY); 784 if (IS_ERR(elephant->tfm)) { 785 r = PTR_ERR(elephant->tfm); 786 elephant->tfm = NULL; 787 return r; 788 } 789 790 r = crypt_iv_eboiv_ctr(cc, ti, NULL); 791 if (r) 792 crypt_iv_elephant_dtr(cc); 793 return r; 794 } 795 796 static void diffuser_disk_to_cpu(u32 *d, size_t n) 797 { 798 #ifndef __LITTLE_ENDIAN 799 int i; 800 801 for (i = 0; i < n; i++) 802 d[i] = le32_to_cpu((__le32)d[i]); 803 #endif 804 } 805 806 static void diffuser_cpu_to_disk(__le32 *d, size_t n) 807 { 808 #ifndef __LITTLE_ENDIAN 809 int i; 810 811 for (i = 0; i < n; i++) 812 d[i] = cpu_to_le32((u32)d[i]); 813 #endif 814 } 815 816 static void diffuser_a_decrypt(u32 *d, size_t n) 817 { 818 int i, i1, i2, i3; 819 820 for (i = 0; i < 5; i++) { 821 i1 = 0; 822 i2 = n - 2; 823 i3 = n - 5; 824 825 while (i1 < (n - 1)) { 826 d[i1] += d[i2] ^ (d[i3] << 9 | d[i3] >> 23); 827 i1++; i2++; i3++; 828 829 if (i3 >= n) 830 i3 -= n; 831 832 d[i1] += d[i2] ^ d[i3]; 833 i1++; i2++; i3++; 834 835 if (i2 >= n) 836 i2 -= n; 837 838 d[i1] += d[i2] ^ (d[i3] << 13 | d[i3] >> 19); 839 i1++; i2++; i3++; 840 841 d[i1] += d[i2] ^ d[i3]; 842 i1++; i2++; i3++; 843 } 844 } 845 } 846 847 static void diffuser_a_encrypt(u32 *d, size_t n) 848 { 849 int i, i1, i2, i3; 850 851 for (i = 0; i < 5; i++) { 852 i1 = n - 1; 853 i2 = n - 2 - 1; 854 i3 = n - 5 - 1; 855 856 while (i1 > 0) { 857 d[i1] -= d[i2] ^ d[i3]; 858 i1--; i2--; i3--; 859 860 d[i1] -= d[i2] ^ (d[i3] << 13 | d[i3] >> 19); 861 i1--; i2--; i3--; 862 863 if (i2 < 0) 864 i2 += n; 865 866 d[i1] -= d[i2] ^ d[i3]; 867 i1--; i2--; i3--; 868 869 if (i3 < 0) 870 i3 += n; 871 872 d[i1] -= d[i2] ^ (d[i3] << 9 | d[i3] >> 23); 873 i1--; i2--; i3--; 874 } 875 } 876 } 877 878 static void diffuser_b_decrypt(u32 *d, size_t n) 879 { 880 int i, i1, i2, i3; 881 882 for (i = 0; i < 3; i++) { 883 i1 = 0; 884 i2 = 2; 885 i3 = 5; 886 887 while (i1 < (n - 1)) { 888 d[i1] += d[i2] ^ d[i3]; 889 i1++; i2++; i3++; 890 891 d[i1] += d[i2] ^ (d[i3] << 10 | d[i3] >> 22); 892 i1++; i2++; i3++; 893 894 if (i2 >= n) 895 i2 -= n; 896 897 d[i1] += d[i2] ^ d[i3]; 898 i1++; i2++; i3++; 899 900 if (i3 >= n) 901 i3 -= n; 902 903 d[i1] += d[i2] ^ (d[i3] << 25 | d[i3] >> 7); 904 i1++; i2++; i3++; 905 } 906 } 907 } 908 909 static void diffuser_b_encrypt(u32 *d, size_t n) 910 { 911 int i, i1, i2, i3; 912 913 for (i = 0; i < 3; i++) { 914 i1 = n - 1; 915 i2 = 2 - 1; 916 i3 = 5 - 1; 917 918 while (i1 > 0) { 919 d[i1] -= d[i2] ^ (d[i3] << 25 | d[i3] >> 7); 920 i1--; i2--; i3--; 921 922 if (i3 < 0) 923 i3 += n; 924 925 d[i1] -= d[i2] ^ d[i3]; 926 i1--; i2--; i3--; 927 928 if (i2 < 0) 929 i2 += n; 930 931 d[i1] -= d[i2] ^ (d[i3] << 10 | d[i3] >> 22); 932 i1--; i2--; i3--; 933 934 d[i1] -= d[i2] ^ d[i3]; 935 i1--; i2--; i3--; 936 } 937 } 938 } 939 940 static int crypt_iv_elephant(struct crypt_config *cc, struct dm_crypt_request *dmreq) 941 { 942 struct iv_elephant_private *elephant = &cc->iv_gen_private.elephant; 943 u8 *es, *ks, *data, *data2, *data_offset; 944 struct skcipher_request *req; 945 struct scatterlist *sg, *sg2, src, dst; 946 DECLARE_CRYPTO_WAIT(wait); 947 int i, r; 948 949 req = skcipher_request_alloc(elephant->tfm, GFP_NOIO); 950 es = kzalloc(16, GFP_NOIO); /* Key for AES */ 951 ks = kzalloc(32, GFP_NOIO); /* Elephant sector key */ 952 953 if (!req || !es || !ks) { 954 r = -ENOMEM; 955 goto out; 956 } 957 958 *(__le64 *)es = cpu_to_le64(dmreq->iv_sector * cc->sector_size); 959 960 /* E(Ks, e(s)) */ 961 sg_init_one(&src, es, 16); 962 sg_init_one(&dst, ks, 16); 963 skcipher_request_set_crypt(req, &src, &dst, 16, NULL); 964 skcipher_request_set_callback(req, 0, crypto_req_done, &wait); 965 r = crypto_wait_req(crypto_skcipher_encrypt(req), &wait); 966 if (r) 967 goto out; 968 969 /* E(Ks, e'(s)) */ 970 es[15] = 0x80; 971 sg_init_one(&dst, &ks[16], 16); 972 r = crypto_wait_req(crypto_skcipher_encrypt(req), &wait); 973 if (r) 974 goto out; 975 976 sg = crypt_get_sg_data(cc, dmreq->sg_out); 977 data = kmap_atomic(sg_page(sg)); 978 data_offset = data + sg->offset; 979 980 /* Cannot modify original bio, copy to sg_out and apply Elephant to it */ 981 if (bio_data_dir(dmreq->ctx->bio_in) == WRITE) { 982 sg2 = crypt_get_sg_data(cc, dmreq->sg_in); 983 data2 = kmap_atomic(sg_page(sg2)); 984 memcpy(data_offset, data2 + sg2->offset, cc->sector_size); 985 kunmap_atomic(data2); 986 } 987 988 if (bio_data_dir(dmreq->ctx->bio_in) != WRITE) { 989 diffuser_disk_to_cpu((u32*)data_offset, cc->sector_size / sizeof(u32)); 990 diffuser_b_decrypt((u32*)data_offset, cc->sector_size / sizeof(u32)); 991 diffuser_a_decrypt((u32*)data_offset, cc->sector_size / sizeof(u32)); 992 diffuser_cpu_to_disk((__le32*)data_offset, cc->sector_size / sizeof(u32)); 993 } 994 995 for (i = 0; i < (cc->sector_size / 32); i++) 996 crypto_xor(data_offset + i * 32, ks, 32); 997 998 if (bio_data_dir(dmreq->ctx->bio_in) == WRITE) { 999 diffuser_disk_to_cpu((u32*)data_offset, cc->sector_size / sizeof(u32)); 1000 diffuser_a_encrypt((u32*)data_offset, cc->sector_size / sizeof(u32)); 1001 diffuser_b_encrypt((u32*)data_offset, cc->sector_size / sizeof(u32)); 1002 diffuser_cpu_to_disk((__le32*)data_offset, cc->sector_size / sizeof(u32)); 1003 } 1004 1005 kunmap_atomic(data); 1006 out: 1007 kfree_sensitive(ks); 1008 kfree_sensitive(es); 1009 skcipher_request_free(req); 1010 return r; 1011 } 1012 1013 static int crypt_iv_elephant_gen(struct crypt_config *cc, u8 *iv, 1014 struct dm_crypt_request *dmreq) 1015 { 1016 int r; 1017 1018 if (bio_data_dir(dmreq->ctx->bio_in) == WRITE) { 1019 r = crypt_iv_elephant(cc, dmreq); 1020 if (r) 1021 return r; 1022 } 1023 1024 return crypt_iv_eboiv_gen(cc, iv, dmreq); 1025 } 1026 1027 static int crypt_iv_elephant_post(struct crypt_config *cc, u8 *iv, 1028 struct dm_crypt_request *dmreq) 1029 { 1030 if (bio_data_dir(dmreq->ctx->bio_in) != WRITE) 1031 return crypt_iv_elephant(cc, dmreq); 1032 1033 return 0; 1034 } 1035 1036 static int crypt_iv_elephant_init(struct crypt_config *cc) 1037 { 1038 struct iv_elephant_private *elephant = &cc->iv_gen_private.elephant; 1039 int key_offset = cc->key_size - cc->key_extra_size; 1040 1041 return crypto_skcipher_setkey(elephant->tfm, &cc->key[key_offset], cc->key_extra_size); 1042 } 1043 1044 static int crypt_iv_elephant_wipe(struct crypt_config *cc) 1045 { 1046 struct iv_elephant_private *elephant = &cc->iv_gen_private.elephant; 1047 u8 key[ELEPHANT_MAX_KEY_SIZE]; 1048 1049 memset(key, 0, cc->key_extra_size); 1050 return crypto_skcipher_setkey(elephant->tfm, key, cc->key_extra_size); 1051 } 1052 1053 static const struct crypt_iv_operations crypt_iv_plain_ops = { 1054 .generator = crypt_iv_plain_gen 1055 }; 1056 1057 static const struct crypt_iv_operations crypt_iv_plain64_ops = { 1058 .generator = crypt_iv_plain64_gen 1059 }; 1060 1061 static const struct crypt_iv_operations crypt_iv_plain64be_ops = { 1062 .generator = crypt_iv_plain64be_gen 1063 }; 1064 1065 static const struct crypt_iv_operations crypt_iv_essiv_ops = { 1066 .generator = crypt_iv_essiv_gen 1067 }; 1068 1069 static const struct crypt_iv_operations crypt_iv_benbi_ops = { 1070 .ctr = crypt_iv_benbi_ctr, 1071 .dtr = crypt_iv_benbi_dtr, 1072 .generator = crypt_iv_benbi_gen 1073 }; 1074 1075 static const struct crypt_iv_operations crypt_iv_null_ops = { 1076 .generator = crypt_iv_null_gen 1077 }; 1078 1079 static const struct crypt_iv_operations crypt_iv_lmk_ops = { 1080 .ctr = crypt_iv_lmk_ctr, 1081 .dtr = crypt_iv_lmk_dtr, 1082 .init = crypt_iv_lmk_init, 1083 .wipe = crypt_iv_lmk_wipe, 1084 .generator = crypt_iv_lmk_gen, 1085 .post = crypt_iv_lmk_post 1086 }; 1087 1088 static const struct crypt_iv_operations crypt_iv_tcw_ops = { 1089 .ctr = crypt_iv_tcw_ctr, 1090 .dtr = crypt_iv_tcw_dtr, 1091 .init = crypt_iv_tcw_init, 1092 .wipe = crypt_iv_tcw_wipe, 1093 .generator = crypt_iv_tcw_gen, 1094 .post = crypt_iv_tcw_post 1095 }; 1096 1097 static const struct crypt_iv_operations crypt_iv_random_ops = { 1098 .generator = crypt_iv_random_gen 1099 }; 1100 1101 static const struct crypt_iv_operations crypt_iv_eboiv_ops = { 1102 .ctr = crypt_iv_eboiv_ctr, 1103 .generator = crypt_iv_eboiv_gen 1104 }; 1105 1106 static const struct crypt_iv_operations crypt_iv_elephant_ops = { 1107 .ctr = crypt_iv_elephant_ctr, 1108 .dtr = crypt_iv_elephant_dtr, 1109 .init = crypt_iv_elephant_init, 1110 .wipe = crypt_iv_elephant_wipe, 1111 .generator = crypt_iv_elephant_gen, 1112 .post = crypt_iv_elephant_post 1113 }; 1114 1115 /* 1116 * Integrity extensions 1117 */ 1118 static bool crypt_integrity_aead(struct crypt_config *cc) 1119 { 1120 return test_bit(CRYPT_MODE_INTEGRITY_AEAD, &cc->cipher_flags); 1121 } 1122 1123 static bool crypt_integrity_hmac(struct crypt_config *cc) 1124 { 1125 return crypt_integrity_aead(cc) && cc->key_mac_size; 1126 } 1127 1128 /* Get sg containing data */ 1129 static struct scatterlist *crypt_get_sg_data(struct crypt_config *cc, 1130 struct scatterlist *sg) 1131 { 1132 if (unlikely(crypt_integrity_aead(cc))) 1133 return &sg[2]; 1134 1135 return sg; 1136 } 1137 1138 static int dm_crypt_integrity_io_alloc(struct dm_crypt_io *io, struct bio *bio) 1139 { 1140 struct bio_integrity_payload *bip; 1141 unsigned int tag_len; 1142 int ret; 1143 1144 if (!bio_sectors(bio) || !io->cc->on_disk_tag_size) 1145 return 0; 1146 1147 bip = bio_integrity_alloc(bio, GFP_NOIO, 1); 1148 if (IS_ERR(bip)) 1149 return PTR_ERR(bip); 1150 1151 tag_len = io->cc->on_disk_tag_size * (bio_sectors(bio) >> io->cc->sector_shift); 1152 1153 bip->bip_iter.bi_size = tag_len; 1154 bip->bip_iter.bi_sector = io->cc->start + io->sector; 1155 1156 ret = bio_integrity_add_page(bio, virt_to_page(io->integrity_metadata), 1157 tag_len, offset_in_page(io->integrity_metadata)); 1158 if (unlikely(ret != tag_len)) 1159 return -ENOMEM; 1160 1161 return 0; 1162 } 1163 1164 static int crypt_integrity_ctr(struct crypt_config *cc, struct dm_target *ti) 1165 { 1166 #ifdef CONFIG_BLK_DEV_INTEGRITY 1167 struct blk_integrity *bi = blk_get_integrity(cc->dev->bdev->bd_disk); 1168 struct mapped_device *md = dm_table_get_md(ti->table); 1169 1170 /* From now we require underlying device with our integrity profile */ 1171 if (!bi || strcasecmp(bi->profile->name, "DM-DIF-EXT-TAG")) { 1172 ti->error = "Integrity profile not supported."; 1173 return -EINVAL; 1174 } 1175 1176 if (bi->tag_size != cc->on_disk_tag_size || 1177 bi->tuple_size != cc->on_disk_tag_size) { 1178 ti->error = "Integrity profile tag size mismatch."; 1179 return -EINVAL; 1180 } 1181 if (1 << bi->interval_exp != cc->sector_size) { 1182 ti->error = "Integrity profile sector size mismatch."; 1183 return -EINVAL; 1184 } 1185 1186 if (crypt_integrity_aead(cc)) { 1187 cc->integrity_tag_size = cc->on_disk_tag_size - cc->integrity_iv_size; 1188 DMDEBUG("%s: Integrity AEAD, tag size %u, IV size %u.", dm_device_name(md), 1189 cc->integrity_tag_size, cc->integrity_iv_size); 1190 1191 if (crypto_aead_setauthsize(any_tfm_aead(cc), cc->integrity_tag_size)) { 1192 ti->error = "Integrity AEAD auth tag size is not supported."; 1193 return -EINVAL; 1194 } 1195 } else if (cc->integrity_iv_size) 1196 DMDEBUG("%s: Additional per-sector space %u bytes for IV.", dm_device_name(md), 1197 cc->integrity_iv_size); 1198 1199 if ((cc->integrity_tag_size + cc->integrity_iv_size) != bi->tag_size) { 1200 ti->error = "Not enough space for integrity tag in the profile."; 1201 return -EINVAL; 1202 } 1203 1204 return 0; 1205 #else 1206 ti->error = "Integrity profile not supported."; 1207 return -EINVAL; 1208 #endif 1209 } 1210 1211 static void crypt_convert_init(struct crypt_config *cc, 1212 struct convert_context *ctx, 1213 struct bio *bio_out, struct bio *bio_in, 1214 sector_t sector) 1215 { 1216 ctx->bio_in = bio_in; 1217 ctx->bio_out = bio_out; 1218 if (bio_in) 1219 ctx->iter_in = bio_in->bi_iter; 1220 if (bio_out) 1221 ctx->iter_out = bio_out->bi_iter; 1222 ctx->cc_sector = sector + cc->iv_offset; 1223 init_completion(&ctx->restart); 1224 } 1225 1226 static struct dm_crypt_request *dmreq_of_req(struct crypt_config *cc, 1227 void *req) 1228 { 1229 return (struct dm_crypt_request *)((char *)req + cc->dmreq_start); 1230 } 1231 1232 static void *req_of_dmreq(struct crypt_config *cc, struct dm_crypt_request *dmreq) 1233 { 1234 return (void *)((char *)dmreq - cc->dmreq_start); 1235 } 1236 1237 static u8 *iv_of_dmreq(struct crypt_config *cc, 1238 struct dm_crypt_request *dmreq) 1239 { 1240 if (crypt_integrity_aead(cc)) 1241 return (u8 *)ALIGN((unsigned long)(dmreq + 1), 1242 crypto_aead_alignmask(any_tfm_aead(cc)) + 1); 1243 else 1244 return (u8 *)ALIGN((unsigned long)(dmreq + 1), 1245 crypto_skcipher_alignmask(any_tfm(cc)) + 1); 1246 } 1247 1248 static u8 *org_iv_of_dmreq(struct crypt_config *cc, 1249 struct dm_crypt_request *dmreq) 1250 { 1251 return iv_of_dmreq(cc, dmreq) + cc->iv_size; 1252 } 1253 1254 static __le64 *org_sector_of_dmreq(struct crypt_config *cc, 1255 struct dm_crypt_request *dmreq) 1256 { 1257 u8 *ptr = iv_of_dmreq(cc, dmreq) + cc->iv_size + cc->iv_size; 1258 return (__le64 *) ptr; 1259 } 1260 1261 static unsigned int *org_tag_of_dmreq(struct crypt_config *cc, 1262 struct dm_crypt_request *dmreq) 1263 { 1264 u8 *ptr = iv_of_dmreq(cc, dmreq) + cc->iv_size + 1265 cc->iv_size + sizeof(uint64_t); 1266 return (unsigned int*)ptr; 1267 } 1268 1269 static void *tag_from_dmreq(struct crypt_config *cc, 1270 struct dm_crypt_request *dmreq) 1271 { 1272 struct convert_context *ctx = dmreq->ctx; 1273 struct dm_crypt_io *io = container_of(ctx, struct dm_crypt_io, ctx); 1274 1275 return &io->integrity_metadata[*org_tag_of_dmreq(cc, dmreq) * 1276 cc->on_disk_tag_size]; 1277 } 1278 1279 static void *iv_tag_from_dmreq(struct crypt_config *cc, 1280 struct dm_crypt_request *dmreq) 1281 { 1282 return tag_from_dmreq(cc, dmreq) + cc->integrity_tag_size; 1283 } 1284 1285 static int crypt_convert_block_aead(struct crypt_config *cc, 1286 struct convert_context *ctx, 1287 struct aead_request *req, 1288 unsigned int tag_offset) 1289 { 1290 struct bio_vec bv_in = bio_iter_iovec(ctx->bio_in, ctx->iter_in); 1291 struct bio_vec bv_out = bio_iter_iovec(ctx->bio_out, ctx->iter_out); 1292 struct dm_crypt_request *dmreq; 1293 u8 *iv, *org_iv, *tag_iv, *tag; 1294 __le64 *sector; 1295 int r = 0; 1296 1297 BUG_ON(cc->integrity_iv_size && cc->integrity_iv_size != cc->iv_size); 1298 1299 /* Reject unexpected unaligned bio. */ 1300 if (unlikely(bv_in.bv_len & (cc->sector_size - 1))) 1301 return -EIO; 1302 1303 dmreq = dmreq_of_req(cc, req); 1304 dmreq->iv_sector = ctx->cc_sector; 1305 if (test_bit(CRYPT_IV_LARGE_SECTORS, &cc->cipher_flags)) 1306 dmreq->iv_sector >>= cc->sector_shift; 1307 dmreq->ctx = ctx; 1308 1309 *org_tag_of_dmreq(cc, dmreq) = tag_offset; 1310 1311 sector = org_sector_of_dmreq(cc, dmreq); 1312 *sector = cpu_to_le64(ctx->cc_sector - cc->iv_offset); 1313 1314 iv = iv_of_dmreq(cc, dmreq); 1315 org_iv = org_iv_of_dmreq(cc, dmreq); 1316 tag = tag_from_dmreq(cc, dmreq); 1317 tag_iv = iv_tag_from_dmreq(cc, dmreq); 1318 1319 /* AEAD request: 1320 * |----- AAD -------|------ DATA -------|-- AUTH TAG --| 1321 * | (authenticated) | (auth+encryption) | | 1322 * | sector_LE | IV | sector in/out | tag in/out | 1323 */ 1324 sg_init_table(dmreq->sg_in, 4); 1325 sg_set_buf(&dmreq->sg_in[0], sector, sizeof(uint64_t)); 1326 sg_set_buf(&dmreq->sg_in[1], org_iv, cc->iv_size); 1327 sg_set_page(&dmreq->sg_in[2], bv_in.bv_page, cc->sector_size, bv_in.bv_offset); 1328 sg_set_buf(&dmreq->sg_in[3], tag, cc->integrity_tag_size); 1329 1330 sg_init_table(dmreq->sg_out, 4); 1331 sg_set_buf(&dmreq->sg_out[0], sector, sizeof(uint64_t)); 1332 sg_set_buf(&dmreq->sg_out[1], org_iv, cc->iv_size); 1333 sg_set_page(&dmreq->sg_out[2], bv_out.bv_page, cc->sector_size, bv_out.bv_offset); 1334 sg_set_buf(&dmreq->sg_out[3], tag, cc->integrity_tag_size); 1335 1336 if (cc->iv_gen_ops) { 1337 /* For READs use IV stored in integrity metadata */ 1338 if (cc->integrity_iv_size && bio_data_dir(ctx->bio_in) != WRITE) { 1339 memcpy(org_iv, tag_iv, cc->iv_size); 1340 } else { 1341 r = cc->iv_gen_ops->generator(cc, org_iv, dmreq); 1342 if (r < 0) 1343 return r; 1344 /* Store generated IV in integrity metadata */ 1345 if (cc->integrity_iv_size) 1346 memcpy(tag_iv, org_iv, cc->iv_size); 1347 } 1348 /* Working copy of IV, to be modified in crypto API */ 1349 memcpy(iv, org_iv, cc->iv_size); 1350 } 1351 1352 aead_request_set_ad(req, sizeof(uint64_t) + cc->iv_size); 1353 if (bio_data_dir(ctx->bio_in) == WRITE) { 1354 aead_request_set_crypt(req, dmreq->sg_in, dmreq->sg_out, 1355 cc->sector_size, iv); 1356 r = crypto_aead_encrypt(req); 1357 if (cc->integrity_tag_size + cc->integrity_iv_size != cc->on_disk_tag_size) 1358 memset(tag + cc->integrity_tag_size + cc->integrity_iv_size, 0, 1359 cc->on_disk_tag_size - (cc->integrity_tag_size + cc->integrity_iv_size)); 1360 } else { 1361 aead_request_set_crypt(req, dmreq->sg_in, dmreq->sg_out, 1362 cc->sector_size + cc->integrity_tag_size, iv); 1363 r = crypto_aead_decrypt(req); 1364 } 1365 1366 if (r == -EBADMSG) { 1367 sector_t s = le64_to_cpu(*sector); 1368 1369 DMERR_LIMIT("%pg: INTEGRITY AEAD ERROR, sector %llu", 1370 ctx->bio_in->bi_bdev, s); 1371 dm_audit_log_bio(DM_MSG_PREFIX, "integrity-aead", 1372 ctx->bio_in, s, 0); 1373 } 1374 1375 if (!r && cc->iv_gen_ops && cc->iv_gen_ops->post) 1376 r = cc->iv_gen_ops->post(cc, org_iv, dmreq); 1377 1378 bio_advance_iter(ctx->bio_in, &ctx->iter_in, cc->sector_size); 1379 bio_advance_iter(ctx->bio_out, &ctx->iter_out, cc->sector_size); 1380 1381 return r; 1382 } 1383 1384 static int crypt_convert_block_skcipher(struct crypt_config *cc, 1385 struct convert_context *ctx, 1386 struct skcipher_request *req, 1387 unsigned int tag_offset) 1388 { 1389 struct bio_vec bv_in = bio_iter_iovec(ctx->bio_in, ctx->iter_in); 1390 struct bio_vec bv_out = bio_iter_iovec(ctx->bio_out, ctx->iter_out); 1391 struct scatterlist *sg_in, *sg_out; 1392 struct dm_crypt_request *dmreq; 1393 u8 *iv, *org_iv, *tag_iv; 1394 __le64 *sector; 1395 int r = 0; 1396 1397 /* Reject unexpected unaligned bio. */ 1398 if (unlikely(bv_in.bv_len & (cc->sector_size - 1))) 1399 return -EIO; 1400 1401 dmreq = dmreq_of_req(cc, req); 1402 dmreq->iv_sector = ctx->cc_sector; 1403 if (test_bit(CRYPT_IV_LARGE_SECTORS, &cc->cipher_flags)) 1404 dmreq->iv_sector >>= cc->sector_shift; 1405 dmreq->ctx = ctx; 1406 1407 *org_tag_of_dmreq(cc, dmreq) = tag_offset; 1408 1409 iv = iv_of_dmreq(cc, dmreq); 1410 org_iv = org_iv_of_dmreq(cc, dmreq); 1411 tag_iv = iv_tag_from_dmreq(cc, dmreq); 1412 1413 sector = org_sector_of_dmreq(cc, dmreq); 1414 *sector = cpu_to_le64(ctx->cc_sector - cc->iv_offset); 1415 1416 /* For skcipher we use only the first sg item */ 1417 sg_in = &dmreq->sg_in[0]; 1418 sg_out = &dmreq->sg_out[0]; 1419 1420 sg_init_table(sg_in, 1); 1421 sg_set_page(sg_in, bv_in.bv_page, cc->sector_size, bv_in.bv_offset); 1422 1423 sg_init_table(sg_out, 1); 1424 sg_set_page(sg_out, bv_out.bv_page, cc->sector_size, bv_out.bv_offset); 1425 1426 if (cc->iv_gen_ops) { 1427 /* For READs use IV stored in integrity metadata */ 1428 if (cc->integrity_iv_size && bio_data_dir(ctx->bio_in) != WRITE) { 1429 memcpy(org_iv, tag_iv, cc->integrity_iv_size); 1430 } else { 1431 r = cc->iv_gen_ops->generator(cc, org_iv, dmreq); 1432 if (r < 0) 1433 return r; 1434 /* Data can be already preprocessed in generator */ 1435 if (test_bit(CRYPT_ENCRYPT_PREPROCESS, &cc->cipher_flags)) 1436 sg_in = sg_out; 1437 /* Store generated IV in integrity metadata */ 1438 if (cc->integrity_iv_size) 1439 memcpy(tag_iv, org_iv, cc->integrity_iv_size); 1440 } 1441 /* Working copy of IV, to be modified in crypto API */ 1442 memcpy(iv, org_iv, cc->iv_size); 1443 } 1444 1445 skcipher_request_set_crypt(req, sg_in, sg_out, cc->sector_size, iv); 1446 1447 if (bio_data_dir(ctx->bio_in) == WRITE) 1448 r = crypto_skcipher_encrypt(req); 1449 else 1450 r = crypto_skcipher_decrypt(req); 1451 1452 if (!r && cc->iv_gen_ops && cc->iv_gen_ops->post) 1453 r = cc->iv_gen_ops->post(cc, org_iv, dmreq); 1454 1455 bio_advance_iter(ctx->bio_in, &ctx->iter_in, cc->sector_size); 1456 bio_advance_iter(ctx->bio_out, &ctx->iter_out, cc->sector_size); 1457 1458 return r; 1459 } 1460 1461 static void kcryptd_async_done(crypto_completion_data_t *async_req, int error); 1462 1463 static int crypt_alloc_req_skcipher(struct crypt_config *cc, 1464 struct convert_context *ctx) 1465 { 1466 unsigned key_index = ctx->cc_sector & (cc->tfms_count - 1); 1467 1468 if (!ctx->r.req) { 1469 ctx->r.req = mempool_alloc(&cc->req_pool, in_interrupt() ? GFP_ATOMIC : GFP_NOIO); 1470 if (!ctx->r.req) 1471 return -ENOMEM; 1472 } 1473 1474 skcipher_request_set_tfm(ctx->r.req, cc->cipher_tfm.tfms[key_index]); 1475 1476 /* 1477 * Use REQ_MAY_BACKLOG so a cipher driver internally backlogs 1478 * requests if driver request queue is full. 1479 */ 1480 skcipher_request_set_callback(ctx->r.req, 1481 CRYPTO_TFM_REQ_MAY_BACKLOG, 1482 kcryptd_async_done, dmreq_of_req(cc, ctx->r.req)); 1483 1484 return 0; 1485 } 1486 1487 static int crypt_alloc_req_aead(struct crypt_config *cc, 1488 struct convert_context *ctx) 1489 { 1490 if (!ctx->r.req_aead) { 1491 ctx->r.req_aead = mempool_alloc(&cc->req_pool, in_interrupt() ? GFP_ATOMIC : GFP_NOIO); 1492 if (!ctx->r.req_aead) 1493 return -ENOMEM; 1494 } 1495 1496 aead_request_set_tfm(ctx->r.req_aead, cc->cipher_tfm.tfms_aead[0]); 1497 1498 /* 1499 * Use REQ_MAY_BACKLOG so a cipher driver internally backlogs 1500 * requests if driver request queue is full. 1501 */ 1502 aead_request_set_callback(ctx->r.req_aead, 1503 CRYPTO_TFM_REQ_MAY_BACKLOG, 1504 kcryptd_async_done, dmreq_of_req(cc, ctx->r.req_aead)); 1505 1506 return 0; 1507 } 1508 1509 static int crypt_alloc_req(struct crypt_config *cc, 1510 struct convert_context *ctx) 1511 { 1512 if (crypt_integrity_aead(cc)) 1513 return crypt_alloc_req_aead(cc, ctx); 1514 else 1515 return crypt_alloc_req_skcipher(cc, ctx); 1516 } 1517 1518 static void crypt_free_req_skcipher(struct crypt_config *cc, 1519 struct skcipher_request *req, struct bio *base_bio) 1520 { 1521 struct dm_crypt_io *io = dm_per_bio_data(base_bio, cc->per_bio_data_size); 1522 1523 if ((struct skcipher_request *)(io + 1) != req) 1524 mempool_free(req, &cc->req_pool); 1525 } 1526 1527 static void crypt_free_req_aead(struct crypt_config *cc, 1528 struct aead_request *req, struct bio *base_bio) 1529 { 1530 struct dm_crypt_io *io = dm_per_bio_data(base_bio, cc->per_bio_data_size); 1531 1532 if ((struct aead_request *)(io + 1) != req) 1533 mempool_free(req, &cc->req_pool); 1534 } 1535 1536 static void crypt_free_req(struct crypt_config *cc, void *req, struct bio *base_bio) 1537 { 1538 if (crypt_integrity_aead(cc)) 1539 crypt_free_req_aead(cc, req, base_bio); 1540 else 1541 crypt_free_req_skcipher(cc, req, base_bio); 1542 } 1543 1544 /* 1545 * Encrypt / decrypt data from one bio to another one (can be the same one) 1546 */ 1547 static blk_status_t crypt_convert(struct crypt_config *cc, 1548 struct convert_context *ctx, bool atomic, bool reset_pending) 1549 { 1550 unsigned int tag_offset = 0; 1551 unsigned int sector_step = cc->sector_size >> SECTOR_SHIFT; 1552 int r; 1553 1554 /* 1555 * if reset_pending is set we are dealing with the bio for the first time, 1556 * else we're continuing to work on the previous bio, so don't mess with 1557 * the cc_pending counter 1558 */ 1559 if (reset_pending) 1560 atomic_set(&ctx->cc_pending, 1); 1561 1562 while (ctx->iter_in.bi_size && ctx->iter_out.bi_size) { 1563 1564 r = crypt_alloc_req(cc, ctx); 1565 if (r) { 1566 complete(&ctx->restart); 1567 return BLK_STS_DEV_RESOURCE; 1568 } 1569 1570 atomic_inc(&ctx->cc_pending); 1571 1572 if (crypt_integrity_aead(cc)) 1573 r = crypt_convert_block_aead(cc, ctx, ctx->r.req_aead, tag_offset); 1574 else 1575 r = crypt_convert_block_skcipher(cc, ctx, ctx->r.req, tag_offset); 1576 1577 switch (r) { 1578 /* 1579 * The request was queued by a crypto driver 1580 * but the driver request queue is full, let's wait. 1581 */ 1582 case -EBUSY: 1583 if (in_interrupt()) { 1584 if (try_wait_for_completion(&ctx->restart)) { 1585 /* 1586 * we don't have to block to wait for completion, 1587 * so proceed 1588 */ 1589 } else { 1590 /* 1591 * we can't wait for completion without blocking 1592 * exit and continue processing in a workqueue 1593 */ 1594 ctx->r.req = NULL; 1595 ctx->cc_sector += sector_step; 1596 tag_offset++; 1597 return BLK_STS_DEV_RESOURCE; 1598 } 1599 } else { 1600 wait_for_completion(&ctx->restart); 1601 } 1602 reinit_completion(&ctx->restart); 1603 fallthrough; 1604 /* 1605 * The request is queued and processed asynchronously, 1606 * completion function kcryptd_async_done() will be called. 1607 */ 1608 case -EINPROGRESS: 1609 ctx->r.req = NULL; 1610 ctx->cc_sector += sector_step; 1611 tag_offset++; 1612 continue; 1613 /* 1614 * The request was already processed (synchronously). 1615 */ 1616 case 0: 1617 atomic_dec(&ctx->cc_pending); 1618 ctx->cc_sector += sector_step; 1619 tag_offset++; 1620 if (!atomic) 1621 cond_resched(); 1622 continue; 1623 /* 1624 * There was a data integrity error. 1625 */ 1626 case -EBADMSG: 1627 atomic_dec(&ctx->cc_pending); 1628 return BLK_STS_PROTECTION; 1629 /* 1630 * There was an error while processing the request. 1631 */ 1632 default: 1633 atomic_dec(&ctx->cc_pending); 1634 return BLK_STS_IOERR; 1635 } 1636 } 1637 1638 return 0; 1639 } 1640 1641 static void crypt_free_buffer_pages(struct crypt_config *cc, struct bio *clone); 1642 1643 /* 1644 * Generate a new unfragmented bio with the given size 1645 * This should never violate the device limitations (but only because 1646 * max_segment_size is being constrained to PAGE_SIZE). 1647 * 1648 * This function may be called concurrently. If we allocate from the mempool 1649 * concurrently, there is a possibility of deadlock. For example, if we have 1650 * mempool of 256 pages, two processes, each wanting 256, pages allocate from 1651 * the mempool concurrently, it may deadlock in a situation where both processes 1652 * have allocated 128 pages and the mempool is exhausted. 1653 * 1654 * In order to avoid this scenario we allocate the pages under a mutex. 1655 * 1656 * In order to not degrade performance with excessive locking, we try 1657 * non-blocking allocations without a mutex first but on failure we fallback 1658 * to blocking allocations with a mutex. 1659 */ 1660 static struct bio *crypt_alloc_buffer(struct dm_crypt_io *io, unsigned size) 1661 { 1662 struct crypt_config *cc = io->cc; 1663 struct bio *clone; 1664 unsigned int nr_iovecs = (size + PAGE_SIZE - 1) >> PAGE_SHIFT; 1665 gfp_t gfp_mask = GFP_NOWAIT | __GFP_HIGHMEM; 1666 unsigned i, len, remaining_size; 1667 struct page *page; 1668 1669 retry: 1670 if (unlikely(gfp_mask & __GFP_DIRECT_RECLAIM)) 1671 mutex_lock(&cc->bio_alloc_lock); 1672 1673 clone = bio_alloc_bioset(cc->dev->bdev, nr_iovecs, io->base_bio->bi_opf, 1674 GFP_NOIO, &cc->bs); 1675 clone->bi_private = io; 1676 clone->bi_end_io = crypt_endio; 1677 1678 remaining_size = size; 1679 1680 for (i = 0; i < nr_iovecs; i++) { 1681 page = mempool_alloc(&cc->page_pool, gfp_mask); 1682 if (!page) { 1683 crypt_free_buffer_pages(cc, clone); 1684 bio_put(clone); 1685 gfp_mask |= __GFP_DIRECT_RECLAIM; 1686 goto retry; 1687 } 1688 1689 len = (remaining_size > PAGE_SIZE) ? PAGE_SIZE : remaining_size; 1690 1691 bio_add_page(clone, page, len, 0); 1692 1693 remaining_size -= len; 1694 } 1695 1696 /* Allocate space for integrity tags */ 1697 if (dm_crypt_integrity_io_alloc(io, clone)) { 1698 crypt_free_buffer_pages(cc, clone); 1699 bio_put(clone); 1700 clone = NULL; 1701 } 1702 1703 if (unlikely(gfp_mask & __GFP_DIRECT_RECLAIM)) 1704 mutex_unlock(&cc->bio_alloc_lock); 1705 1706 return clone; 1707 } 1708 1709 static void crypt_free_buffer_pages(struct crypt_config *cc, struct bio *clone) 1710 { 1711 struct bio_vec *bv; 1712 struct bvec_iter_all iter_all; 1713 1714 bio_for_each_segment_all(bv, clone, iter_all) { 1715 BUG_ON(!bv->bv_page); 1716 mempool_free(bv->bv_page, &cc->page_pool); 1717 } 1718 } 1719 1720 static void crypt_io_init(struct dm_crypt_io *io, struct crypt_config *cc, 1721 struct bio *bio, sector_t sector) 1722 { 1723 io->cc = cc; 1724 io->base_bio = bio; 1725 io->sector = sector; 1726 io->error = 0; 1727 io->ctx.r.req = NULL; 1728 io->integrity_metadata = NULL; 1729 io->integrity_metadata_from_pool = false; 1730 atomic_set(&io->io_pending, 0); 1731 } 1732 1733 static void crypt_inc_pending(struct dm_crypt_io *io) 1734 { 1735 atomic_inc(&io->io_pending); 1736 } 1737 1738 static void kcryptd_io_bio_endio(struct work_struct *work) 1739 { 1740 struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work); 1741 bio_endio(io->base_bio); 1742 } 1743 1744 /* 1745 * One of the bios was finished. Check for completion of 1746 * the whole request and correctly clean up the buffer. 1747 */ 1748 static void crypt_dec_pending(struct dm_crypt_io *io) 1749 { 1750 struct crypt_config *cc = io->cc; 1751 struct bio *base_bio = io->base_bio; 1752 blk_status_t error = io->error; 1753 1754 if (!atomic_dec_and_test(&io->io_pending)) 1755 return; 1756 1757 if (io->ctx.r.req) 1758 crypt_free_req(cc, io->ctx.r.req, base_bio); 1759 1760 if (unlikely(io->integrity_metadata_from_pool)) 1761 mempool_free(io->integrity_metadata, &io->cc->tag_pool); 1762 else 1763 kfree(io->integrity_metadata); 1764 1765 base_bio->bi_status = error; 1766 1767 /* 1768 * If we are running this function from our tasklet, 1769 * we can't call bio_endio() here, because it will call 1770 * clone_endio() from dm.c, which in turn will 1771 * free the current struct dm_crypt_io structure with 1772 * our tasklet. In this case we need to delay bio_endio() 1773 * execution to after the tasklet is done and dequeued. 1774 */ 1775 if (tasklet_trylock(&io->tasklet)) { 1776 tasklet_unlock(&io->tasklet); 1777 bio_endio(base_bio); 1778 return; 1779 } 1780 1781 INIT_WORK(&io->work, kcryptd_io_bio_endio); 1782 queue_work(cc->io_queue, &io->work); 1783 } 1784 1785 /* 1786 * kcryptd/kcryptd_io: 1787 * 1788 * Needed because it would be very unwise to do decryption in an 1789 * interrupt context. 1790 * 1791 * kcryptd performs the actual encryption or decryption. 1792 * 1793 * kcryptd_io performs the IO submission. 1794 * 1795 * They must be separated as otherwise the final stages could be 1796 * starved by new requests which can block in the first stages due 1797 * to memory allocation. 1798 * 1799 * The work is done per CPU global for all dm-crypt instances. 1800 * They should not depend on each other and do not block. 1801 */ 1802 static void crypt_endio(struct bio *clone) 1803 { 1804 struct dm_crypt_io *io = clone->bi_private; 1805 struct crypt_config *cc = io->cc; 1806 unsigned rw = bio_data_dir(clone); 1807 blk_status_t error; 1808 1809 /* 1810 * free the processed pages 1811 */ 1812 if (rw == WRITE) 1813 crypt_free_buffer_pages(cc, clone); 1814 1815 error = clone->bi_status; 1816 bio_put(clone); 1817 1818 if (rw == READ && !error) { 1819 kcryptd_queue_crypt(io); 1820 return; 1821 } 1822 1823 if (unlikely(error)) 1824 io->error = error; 1825 1826 crypt_dec_pending(io); 1827 } 1828 1829 #define CRYPT_MAP_READ_GFP GFP_NOWAIT 1830 1831 static int kcryptd_io_read(struct dm_crypt_io *io, gfp_t gfp) 1832 { 1833 struct crypt_config *cc = io->cc; 1834 struct bio *clone; 1835 1836 /* 1837 * We need the original biovec array in order to decrypt the whole bio 1838 * data *afterwards* -- thanks to immutable biovecs we don't need to 1839 * worry about the block layer modifying the biovec array; so leverage 1840 * bio_alloc_clone(). 1841 */ 1842 clone = bio_alloc_clone(cc->dev->bdev, io->base_bio, gfp, &cc->bs); 1843 if (!clone) 1844 return 1; 1845 clone->bi_private = io; 1846 clone->bi_end_io = crypt_endio; 1847 1848 crypt_inc_pending(io); 1849 1850 clone->bi_iter.bi_sector = cc->start + io->sector; 1851 1852 if (dm_crypt_integrity_io_alloc(io, clone)) { 1853 crypt_dec_pending(io); 1854 bio_put(clone); 1855 return 1; 1856 } 1857 1858 dm_submit_bio_remap(io->base_bio, clone); 1859 return 0; 1860 } 1861 1862 static void kcryptd_io_read_work(struct work_struct *work) 1863 { 1864 struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work); 1865 1866 crypt_inc_pending(io); 1867 if (kcryptd_io_read(io, GFP_NOIO)) 1868 io->error = BLK_STS_RESOURCE; 1869 crypt_dec_pending(io); 1870 } 1871 1872 static void kcryptd_queue_read(struct dm_crypt_io *io) 1873 { 1874 struct crypt_config *cc = io->cc; 1875 1876 INIT_WORK(&io->work, kcryptd_io_read_work); 1877 queue_work(cc->io_queue, &io->work); 1878 } 1879 1880 static void kcryptd_io_write(struct dm_crypt_io *io) 1881 { 1882 struct bio *clone = io->ctx.bio_out; 1883 1884 dm_submit_bio_remap(io->base_bio, clone); 1885 } 1886 1887 #define crypt_io_from_node(node) rb_entry((node), struct dm_crypt_io, rb_node) 1888 1889 static int dmcrypt_write(void *data) 1890 { 1891 struct crypt_config *cc = data; 1892 struct dm_crypt_io *io; 1893 1894 while (1) { 1895 struct rb_root write_tree; 1896 struct blk_plug plug; 1897 1898 spin_lock_irq(&cc->write_thread_lock); 1899 continue_locked: 1900 1901 if (!RB_EMPTY_ROOT(&cc->write_tree)) 1902 goto pop_from_list; 1903 1904 set_current_state(TASK_INTERRUPTIBLE); 1905 1906 spin_unlock_irq(&cc->write_thread_lock); 1907 1908 if (unlikely(kthread_should_stop())) { 1909 set_current_state(TASK_RUNNING); 1910 break; 1911 } 1912 1913 schedule(); 1914 1915 set_current_state(TASK_RUNNING); 1916 spin_lock_irq(&cc->write_thread_lock); 1917 goto continue_locked; 1918 1919 pop_from_list: 1920 write_tree = cc->write_tree; 1921 cc->write_tree = RB_ROOT; 1922 spin_unlock_irq(&cc->write_thread_lock); 1923 1924 BUG_ON(rb_parent(write_tree.rb_node)); 1925 1926 /* 1927 * Note: we cannot walk the tree here with rb_next because 1928 * the structures may be freed when kcryptd_io_write is called. 1929 */ 1930 blk_start_plug(&plug); 1931 do { 1932 io = crypt_io_from_node(rb_first(&write_tree)); 1933 rb_erase(&io->rb_node, &write_tree); 1934 kcryptd_io_write(io); 1935 } while (!RB_EMPTY_ROOT(&write_tree)); 1936 blk_finish_plug(&plug); 1937 } 1938 return 0; 1939 } 1940 1941 static void kcryptd_crypt_write_io_submit(struct dm_crypt_io *io, int async) 1942 { 1943 struct bio *clone = io->ctx.bio_out; 1944 struct crypt_config *cc = io->cc; 1945 unsigned long flags; 1946 sector_t sector; 1947 struct rb_node **rbp, *parent; 1948 1949 if (unlikely(io->error)) { 1950 crypt_free_buffer_pages(cc, clone); 1951 bio_put(clone); 1952 crypt_dec_pending(io); 1953 return; 1954 } 1955 1956 /* crypt_convert should have filled the clone bio */ 1957 BUG_ON(io->ctx.iter_out.bi_size); 1958 1959 clone->bi_iter.bi_sector = cc->start + io->sector; 1960 1961 if ((likely(!async) && test_bit(DM_CRYPT_NO_OFFLOAD, &cc->flags)) || 1962 test_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags)) { 1963 dm_submit_bio_remap(io->base_bio, clone); 1964 return; 1965 } 1966 1967 spin_lock_irqsave(&cc->write_thread_lock, flags); 1968 if (RB_EMPTY_ROOT(&cc->write_tree)) 1969 wake_up_process(cc->write_thread); 1970 rbp = &cc->write_tree.rb_node; 1971 parent = NULL; 1972 sector = io->sector; 1973 while (*rbp) { 1974 parent = *rbp; 1975 if (sector < crypt_io_from_node(parent)->sector) 1976 rbp = &(*rbp)->rb_left; 1977 else 1978 rbp = &(*rbp)->rb_right; 1979 } 1980 rb_link_node(&io->rb_node, parent, rbp); 1981 rb_insert_color(&io->rb_node, &cc->write_tree); 1982 spin_unlock_irqrestore(&cc->write_thread_lock, flags); 1983 } 1984 1985 static bool kcryptd_crypt_write_inline(struct crypt_config *cc, 1986 struct convert_context *ctx) 1987 1988 { 1989 if (!test_bit(DM_CRYPT_WRITE_INLINE, &cc->flags)) 1990 return false; 1991 1992 /* 1993 * Note: zone append writes (REQ_OP_ZONE_APPEND) do not have ordering 1994 * constraints so they do not need to be issued inline by 1995 * kcryptd_crypt_write_convert(). 1996 */ 1997 switch (bio_op(ctx->bio_in)) { 1998 case REQ_OP_WRITE: 1999 case REQ_OP_WRITE_ZEROES: 2000 return true; 2001 default: 2002 return false; 2003 } 2004 } 2005 2006 static void kcryptd_crypt_write_continue(struct work_struct *work) 2007 { 2008 struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work); 2009 struct crypt_config *cc = io->cc; 2010 struct convert_context *ctx = &io->ctx; 2011 int crypt_finished; 2012 sector_t sector = io->sector; 2013 blk_status_t r; 2014 2015 wait_for_completion(&ctx->restart); 2016 reinit_completion(&ctx->restart); 2017 2018 r = crypt_convert(cc, &io->ctx, true, false); 2019 if (r) 2020 io->error = r; 2021 crypt_finished = atomic_dec_and_test(&ctx->cc_pending); 2022 if (!crypt_finished && kcryptd_crypt_write_inline(cc, ctx)) { 2023 /* Wait for completion signaled by kcryptd_async_done() */ 2024 wait_for_completion(&ctx->restart); 2025 crypt_finished = 1; 2026 } 2027 2028 /* Encryption was already finished, submit io now */ 2029 if (crypt_finished) { 2030 kcryptd_crypt_write_io_submit(io, 0); 2031 io->sector = sector; 2032 } 2033 2034 crypt_dec_pending(io); 2035 } 2036 2037 static void kcryptd_crypt_write_convert(struct dm_crypt_io *io) 2038 { 2039 struct crypt_config *cc = io->cc; 2040 struct convert_context *ctx = &io->ctx; 2041 struct bio *clone; 2042 int crypt_finished; 2043 sector_t sector = io->sector; 2044 blk_status_t r; 2045 2046 /* 2047 * Prevent io from disappearing until this function completes. 2048 */ 2049 crypt_inc_pending(io); 2050 crypt_convert_init(cc, ctx, NULL, io->base_bio, sector); 2051 2052 clone = crypt_alloc_buffer(io, io->base_bio->bi_iter.bi_size); 2053 if (unlikely(!clone)) { 2054 io->error = BLK_STS_IOERR; 2055 goto dec; 2056 } 2057 2058 io->ctx.bio_out = clone; 2059 io->ctx.iter_out = clone->bi_iter; 2060 2061 sector += bio_sectors(clone); 2062 2063 crypt_inc_pending(io); 2064 r = crypt_convert(cc, ctx, 2065 test_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags), true); 2066 /* 2067 * Crypto API backlogged the request, because its queue was full 2068 * and we're in softirq context, so continue from a workqueue 2069 * (TODO: is it actually possible to be in softirq in the write path?) 2070 */ 2071 if (r == BLK_STS_DEV_RESOURCE) { 2072 INIT_WORK(&io->work, kcryptd_crypt_write_continue); 2073 queue_work(cc->crypt_queue, &io->work); 2074 return; 2075 } 2076 if (r) 2077 io->error = r; 2078 crypt_finished = atomic_dec_and_test(&ctx->cc_pending); 2079 if (!crypt_finished && kcryptd_crypt_write_inline(cc, ctx)) { 2080 /* Wait for completion signaled by kcryptd_async_done() */ 2081 wait_for_completion(&ctx->restart); 2082 crypt_finished = 1; 2083 } 2084 2085 /* Encryption was already finished, submit io now */ 2086 if (crypt_finished) { 2087 kcryptd_crypt_write_io_submit(io, 0); 2088 io->sector = sector; 2089 } 2090 2091 dec: 2092 crypt_dec_pending(io); 2093 } 2094 2095 static void kcryptd_crypt_read_done(struct dm_crypt_io *io) 2096 { 2097 crypt_dec_pending(io); 2098 } 2099 2100 static void kcryptd_crypt_read_continue(struct work_struct *work) 2101 { 2102 struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work); 2103 struct crypt_config *cc = io->cc; 2104 blk_status_t r; 2105 2106 wait_for_completion(&io->ctx.restart); 2107 reinit_completion(&io->ctx.restart); 2108 2109 r = crypt_convert(cc, &io->ctx, true, false); 2110 if (r) 2111 io->error = r; 2112 2113 if (atomic_dec_and_test(&io->ctx.cc_pending)) 2114 kcryptd_crypt_read_done(io); 2115 2116 crypt_dec_pending(io); 2117 } 2118 2119 static void kcryptd_crypt_read_convert(struct dm_crypt_io *io) 2120 { 2121 struct crypt_config *cc = io->cc; 2122 blk_status_t r; 2123 2124 crypt_inc_pending(io); 2125 2126 crypt_convert_init(cc, &io->ctx, io->base_bio, io->base_bio, 2127 io->sector); 2128 2129 r = crypt_convert(cc, &io->ctx, 2130 test_bit(DM_CRYPT_NO_READ_WORKQUEUE, &cc->flags), true); 2131 /* 2132 * Crypto API backlogged the request, because its queue was full 2133 * and we're in softirq context, so continue from a workqueue 2134 */ 2135 if (r == BLK_STS_DEV_RESOURCE) { 2136 INIT_WORK(&io->work, kcryptd_crypt_read_continue); 2137 queue_work(cc->crypt_queue, &io->work); 2138 return; 2139 } 2140 if (r) 2141 io->error = r; 2142 2143 if (atomic_dec_and_test(&io->ctx.cc_pending)) 2144 kcryptd_crypt_read_done(io); 2145 2146 crypt_dec_pending(io); 2147 } 2148 2149 static void kcryptd_async_done(crypto_completion_data_t *data, int error) 2150 { 2151 struct dm_crypt_request *dmreq = crypto_get_completion_data(data); 2152 struct convert_context *ctx = dmreq->ctx; 2153 struct dm_crypt_io *io = container_of(ctx, struct dm_crypt_io, ctx); 2154 struct crypt_config *cc = io->cc; 2155 2156 /* 2157 * A request from crypto driver backlog is going to be processed now, 2158 * finish the completion and continue in crypt_convert(). 2159 * (Callback will be called for the second time for this request.) 2160 */ 2161 if (error == -EINPROGRESS) { 2162 complete(&ctx->restart); 2163 return; 2164 } 2165 2166 if (!error && cc->iv_gen_ops && cc->iv_gen_ops->post) 2167 error = cc->iv_gen_ops->post(cc, org_iv_of_dmreq(cc, dmreq), dmreq); 2168 2169 if (error == -EBADMSG) { 2170 sector_t s = le64_to_cpu(*org_sector_of_dmreq(cc, dmreq)); 2171 2172 DMERR_LIMIT("%pg: INTEGRITY AEAD ERROR, sector %llu", 2173 ctx->bio_in->bi_bdev, s); 2174 dm_audit_log_bio(DM_MSG_PREFIX, "integrity-aead", 2175 ctx->bio_in, s, 0); 2176 io->error = BLK_STS_PROTECTION; 2177 } else if (error < 0) 2178 io->error = BLK_STS_IOERR; 2179 2180 crypt_free_req(cc, req_of_dmreq(cc, dmreq), io->base_bio); 2181 2182 if (!atomic_dec_and_test(&ctx->cc_pending)) 2183 return; 2184 2185 /* 2186 * The request is fully completed: for inline writes, let 2187 * kcryptd_crypt_write_convert() do the IO submission. 2188 */ 2189 if (bio_data_dir(io->base_bio) == READ) { 2190 kcryptd_crypt_read_done(io); 2191 return; 2192 } 2193 2194 if (kcryptd_crypt_write_inline(cc, ctx)) { 2195 complete(&ctx->restart); 2196 return; 2197 } 2198 2199 kcryptd_crypt_write_io_submit(io, 1); 2200 } 2201 2202 static void kcryptd_crypt(struct work_struct *work) 2203 { 2204 struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work); 2205 2206 if (bio_data_dir(io->base_bio) == READ) 2207 kcryptd_crypt_read_convert(io); 2208 else 2209 kcryptd_crypt_write_convert(io); 2210 } 2211 2212 static void kcryptd_crypt_tasklet(unsigned long work) 2213 { 2214 kcryptd_crypt((struct work_struct *)work); 2215 } 2216 2217 static void kcryptd_queue_crypt(struct dm_crypt_io *io) 2218 { 2219 struct crypt_config *cc = io->cc; 2220 2221 if ((bio_data_dir(io->base_bio) == READ && test_bit(DM_CRYPT_NO_READ_WORKQUEUE, &cc->flags)) || 2222 (bio_data_dir(io->base_bio) == WRITE && test_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags))) { 2223 /* 2224 * in_hardirq(): Crypto API's skcipher_walk_first() refuses to work in hard IRQ context. 2225 * irqs_disabled(): the kernel may run some IO completion from the idle thread, but 2226 * it is being executed with irqs disabled. 2227 */ 2228 if (in_hardirq() || irqs_disabled()) { 2229 tasklet_init(&io->tasklet, kcryptd_crypt_tasklet, (unsigned long)&io->work); 2230 tasklet_schedule(&io->tasklet); 2231 return; 2232 } 2233 2234 kcryptd_crypt(&io->work); 2235 return; 2236 } 2237 2238 INIT_WORK(&io->work, kcryptd_crypt); 2239 queue_work(cc->crypt_queue, &io->work); 2240 } 2241 2242 static void crypt_free_tfms_aead(struct crypt_config *cc) 2243 { 2244 if (!cc->cipher_tfm.tfms_aead) 2245 return; 2246 2247 if (cc->cipher_tfm.tfms_aead[0] && !IS_ERR(cc->cipher_tfm.tfms_aead[0])) { 2248 crypto_free_aead(cc->cipher_tfm.tfms_aead[0]); 2249 cc->cipher_tfm.tfms_aead[0] = NULL; 2250 } 2251 2252 kfree(cc->cipher_tfm.tfms_aead); 2253 cc->cipher_tfm.tfms_aead = NULL; 2254 } 2255 2256 static void crypt_free_tfms_skcipher(struct crypt_config *cc) 2257 { 2258 unsigned i; 2259 2260 if (!cc->cipher_tfm.tfms) 2261 return; 2262 2263 for (i = 0; i < cc->tfms_count; i++) 2264 if (cc->cipher_tfm.tfms[i] && !IS_ERR(cc->cipher_tfm.tfms[i])) { 2265 crypto_free_skcipher(cc->cipher_tfm.tfms[i]); 2266 cc->cipher_tfm.tfms[i] = NULL; 2267 } 2268 2269 kfree(cc->cipher_tfm.tfms); 2270 cc->cipher_tfm.tfms = NULL; 2271 } 2272 2273 static void crypt_free_tfms(struct crypt_config *cc) 2274 { 2275 if (crypt_integrity_aead(cc)) 2276 crypt_free_tfms_aead(cc); 2277 else 2278 crypt_free_tfms_skcipher(cc); 2279 } 2280 2281 static int crypt_alloc_tfms_skcipher(struct crypt_config *cc, char *ciphermode) 2282 { 2283 unsigned i; 2284 int err; 2285 2286 cc->cipher_tfm.tfms = kcalloc(cc->tfms_count, 2287 sizeof(struct crypto_skcipher *), 2288 GFP_KERNEL); 2289 if (!cc->cipher_tfm.tfms) 2290 return -ENOMEM; 2291 2292 for (i = 0; i < cc->tfms_count; i++) { 2293 cc->cipher_tfm.tfms[i] = crypto_alloc_skcipher(ciphermode, 0, 2294 CRYPTO_ALG_ALLOCATES_MEMORY); 2295 if (IS_ERR(cc->cipher_tfm.tfms[i])) { 2296 err = PTR_ERR(cc->cipher_tfm.tfms[i]); 2297 crypt_free_tfms(cc); 2298 return err; 2299 } 2300 } 2301 2302 /* 2303 * dm-crypt performance can vary greatly depending on which crypto 2304 * algorithm implementation is used. Help people debug performance 2305 * problems by logging the ->cra_driver_name. 2306 */ 2307 DMDEBUG_LIMIT("%s using implementation \"%s\"", ciphermode, 2308 crypto_skcipher_alg(any_tfm(cc))->base.cra_driver_name); 2309 return 0; 2310 } 2311 2312 static int crypt_alloc_tfms_aead(struct crypt_config *cc, char *ciphermode) 2313 { 2314 int err; 2315 2316 cc->cipher_tfm.tfms = kmalloc(sizeof(struct crypto_aead *), GFP_KERNEL); 2317 if (!cc->cipher_tfm.tfms) 2318 return -ENOMEM; 2319 2320 cc->cipher_tfm.tfms_aead[0] = crypto_alloc_aead(ciphermode, 0, 2321 CRYPTO_ALG_ALLOCATES_MEMORY); 2322 if (IS_ERR(cc->cipher_tfm.tfms_aead[0])) { 2323 err = PTR_ERR(cc->cipher_tfm.tfms_aead[0]); 2324 crypt_free_tfms(cc); 2325 return err; 2326 } 2327 2328 DMDEBUG_LIMIT("%s using implementation \"%s\"", ciphermode, 2329 crypto_aead_alg(any_tfm_aead(cc))->base.cra_driver_name); 2330 return 0; 2331 } 2332 2333 static int crypt_alloc_tfms(struct crypt_config *cc, char *ciphermode) 2334 { 2335 if (crypt_integrity_aead(cc)) 2336 return crypt_alloc_tfms_aead(cc, ciphermode); 2337 else 2338 return crypt_alloc_tfms_skcipher(cc, ciphermode); 2339 } 2340 2341 static unsigned crypt_subkey_size(struct crypt_config *cc) 2342 { 2343 return (cc->key_size - cc->key_extra_size) >> ilog2(cc->tfms_count); 2344 } 2345 2346 static unsigned crypt_authenckey_size(struct crypt_config *cc) 2347 { 2348 return crypt_subkey_size(cc) + RTA_SPACE(sizeof(struct crypto_authenc_key_param)); 2349 } 2350 2351 /* 2352 * If AEAD is composed like authenc(hmac(sha256),xts(aes)), 2353 * the key must be for some reason in special format. 2354 * This funcion converts cc->key to this special format. 2355 */ 2356 static void crypt_copy_authenckey(char *p, const void *key, 2357 unsigned enckeylen, unsigned authkeylen) 2358 { 2359 struct crypto_authenc_key_param *param; 2360 struct rtattr *rta; 2361 2362 rta = (struct rtattr *)p; 2363 param = RTA_DATA(rta); 2364 param->enckeylen = cpu_to_be32(enckeylen); 2365 rta->rta_len = RTA_LENGTH(sizeof(*param)); 2366 rta->rta_type = CRYPTO_AUTHENC_KEYA_PARAM; 2367 p += RTA_SPACE(sizeof(*param)); 2368 memcpy(p, key + enckeylen, authkeylen); 2369 p += authkeylen; 2370 memcpy(p, key, enckeylen); 2371 } 2372 2373 static int crypt_setkey(struct crypt_config *cc) 2374 { 2375 unsigned subkey_size; 2376 int err = 0, i, r; 2377 2378 /* Ignore extra keys (which are used for IV etc) */ 2379 subkey_size = crypt_subkey_size(cc); 2380 2381 if (crypt_integrity_hmac(cc)) { 2382 if (subkey_size < cc->key_mac_size) 2383 return -EINVAL; 2384 2385 crypt_copy_authenckey(cc->authenc_key, cc->key, 2386 subkey_size - cc->key_mac_size, 2387 cc->key_mac_size); 2388 } 2389 2390 for (i = 0; i < cc->tfms_count; i++) { 2391 if (crypt_integrity_hmac(cc)) 2392 r = crypto_aead_setkey(cc->cipher_tfm.tfms_aead[i], 2393 cc->authenc_key, crypt_authenckey_size(cc)); 2394 else if (crypt_integrity_aead(cc)) 2395 r = crypto_aead_setkey(cc->cipher_tfm.tfms_aead[i], 2396 cc->key + (i * subkey_size), 2397 subkey_size); 2398 else 2399 r = crypto_skcipher_setkey(cc->cipher_tfm.tfms[i], 2400 cc->key + (i * subkey_size), 2401 subkey_size); 2402 if (r) 2403 err = r; 2404 } 2405 2406 if (crypt_integrity_hmac(cc)) 2407 memzero_explicit(cc->authenc_key, crypt_authenckey_size(cc)); 2408 2409 return err; 2410 } 2411 2412 #ifdef CONFIG_KEYS 2413 2414 static bool contains_whitespace(const char *str) 2415 { 2416 while (*str) 2417 if (isspace(*str++)) 2418 return true; 2419 return false; 2420 } 2421 2422 static int set_key_user(struct crypt_config *cc, struct key *key) 2423 { 2424 const struct user_key_payload *ukp; 2425 2426 ukp = user_key_payload_locked(key); 2427 if (!ukp) 2428 return -EKEYREVOKED; 2429 2430 if (cc->key_size != ukp->datalen) 2431 return -EINVAL; 2432 2433 memcpy(cc->key, ukp->data, cc->key_size); 2434 2435 return 0; 2436 } 2437 2438 static int set_key_encrypted(struct crypt_config *cc, struct key *key) 2439 { 2440 const struct encrypted_key_payload *ekp; 2441 2442 ekp = key->payload.data[0]; 2443 if (!ekp) 2444 return -EKEYREVOKED; 2445 2446 if (cc->key_size != ekp->decrypted_datalen) 2447 return -EINVAL; 2448 2449 memcpy(cc->key, ekp->decrypted_data, cc->key_size); 2450 2451 return 0; 2452 } 2453 2454 static int set_key_trusted(struct crypt_config *cc, struct key *key) 2455 { 2456 const struct trusted_key_payload *tkp; 2457 2458 tkp = key->payload.data[0]; 2459 if (!tkp) 2460 return -EKEYREVOKED; 2461 2462 if (cc->key_size != tkp->key_len) 2463 return -EINVAL; 2464 2465 memcpy(cc->key, tkp->key, cc->key_size); 2466 2467 return 0; 2468 } 2469 2470 static int crypt_set_keyring_key(struct crypt_config *cc, const char *key_string) 2471 { 2472 char *new_key_string, *key_desc; 2473 int ret; 2474 struct key_type *type; 2475 struct key *key; 2476 int (*set_key)(struct crypt_config *cc, struct key *key); 2477 2478 /* 2479 * Reject key_string with whitespace. dm core currently lacks code for 2480 * proper whitespace escaping in arguments on DM_TABLE_STATUS path. 2481 */ 2482 if (contains_whitespace(key_string)) { 2483 DMERR("whitespace chars not allowed in key string"); 2484 return -EINVAL; 2485 } 2486 2487 /* look for next ':' separating key_type from key_description */ 2488 key_desc = strpbrk(key_string, ":"); 2489 if (!key_desc || key_desc == key_string || !strlen(key_desc + 1)) 2490 return -EINVAL; 2491 2492 if (!strncmp(key_string, "logon:", key_desc - key_string + 1)) { 2493 type = &key_type_logon; 2494 set_key = set_key_user; 2495 } else if (!strncmp(key_string, "user:", key_desc - key_string + 1)) { 2496 type = &key_type_user; 2497 set_key = set_key_user; 2498 } else if (IS_ENABLED(CONFIG_ENCRYPTED_KEYS) && 2499 !strncmp(key_string, "encrypted:", key_desc - key_string + 1)) { 2500 type = &key_type_encrypted; 2501 set_key = set_key_encrypted; 2502 } else if (IS_ENABLED(CONFIG_TRUSTED_KEYS) && 2503 !strncmp(key_string, "trusted:", key_desc - key_string + 1)) { 2504 type = &key_type_trusted; 2505 set_key = set_key_trusted; 2506 } else { 2507 return -EINVAL; 2508 } 2509 2510 new_key_string = kstrdup(key_string, GFP_KERNEL); 2511 if (!new_key_string) 2512 return -ENOMEM; 2513 2514 key = request_key(type, key_desc + 1, NULL); 2515 if (IS_ERR(key)) { 2516 kfree_sensitive(new_key_string); 2517 return PTR_ERR(key); 2518 } 2519 2520 down_read(&key->sem); 2521 2522 ret = set_key(cc, key); 2523 if (ret < 0) { 2524 up_read(&key->sem); 2525 key_put(key); 2526 kfree_sensitive(new_key_string); 2527 return ret; 2528 } 2529 2530 up_read(&key->sem); 2531 key_put(key); 2532 2533 /* clear the flag since following operations may invalidate previously valid key */ 2534 clear_bit(DM_CRYPT_KEY_VALID, &cc->flags); 2535 2536 ret = crypt_setkey(cc); 2537 2538 if (!ret) { 2539 set_bit(DM_CRYPT_KEY_VALID, &cc->flags); 2540 kfree_sensitive(cc->key_string); 2541 cc->key_string = new_key_string; 2542 } else 2543 kfree_sensitive(new_key_string); 2544 2545 return ret; 2546 } 2547 2548 static int get_key_size(char **key_string) 2549 { 2550 char *colon, dummy; 2551 int ret; 2552 2553 if (*key_string[0] != ':') 2554 return strlen(*key_string) >> 1; 2555 2556 /* look for next ':' in key string */ 2557 colon = strpbrk(*key_string + 1, ":"); 2558 if (!colon) 2559 return -EINVAL; 2560 2561 if (sscanf(*key_string + 1, "%u%c", &ret, &dummy) != 2 || dummy != ':') 2562 return -EINVAL; 2563 2564 *key_string = colon; 2565 2566 /* remaining key string should be :<logon|user>:<key_desc> */ 2567 2568 return ret; 2569 } 2570 2571 #else 2572 2573 static int crypt_set_keyring_key(struct crypt_config *cc, const char *key_string) 2574 { 2575 return -EINVAL; 2576 } 2577 2578 static int get_key_size(char **key_string) 2579 { 2580 return (*key_string[0] == ':') ? -EINVAL : (int)(strlen(*key_string) >> 1); 2581 } 2582 2583 #endif /* CONFIG_KEYS */ 2584 2585 static int crypt_set_key(struct crypt_config *cc, char *key) 2586 { 2587 int r = -EINVAL; 2588 int key_string_len = strlen(key); 2589 2590 /* Hyphen (which gives a key_size of zero) means there is no key. */ 2591 if (!cc->key_size && strcmp(key, "-")) 2592 goto out; 2593 2594 /* ':' means the key is in kernel keyring, short-circuit normal key processing */ 2595 if (key[0] == ':') { 2596 r = crypt_set_keyring_key(cc, key + 1); 2597 goto out; 2598 } 2599 2600 /* clear the flag since following operations may invalidate previously valid key */ 2601 clear_bit(DM_CRYPT_KEY_VALID, &cc->flags); 2602 2603 /* wipe references to any kernel keyring key */ 2604 kfree_sensitive(cc->key_string); 2605 cc->key_string = NULL; 2606 2607 /* Decode key from its hex representation. */ 2608 if (cc->key_size && hex2bin(cc->key, key, cc->key_size) < 0) 2609 goto out; 2610 2611 r = crypt_setkey(cc); 2612 if (!r) 2613 set_bit(DM_CRYPT_KEY_VALID, &cc->flags); 2614 2615 out: 2616 /* Hex key string not needed after here, so wipe it. */ 2617 memset(key, '0', key_string_len); 2618 2619 return r; 2620 } 2621 2622 static int crypt_wipe_key(struct crypt_config *cc) 2623 { 2624 int r; 2625 2626 clear_bit(DM_CRYPT_KEY_VALID, &cc->flags); 2627 get_random_bytes(&cc->key, cc->key_size); 2628 2629 /* Wipe IV private keys */ 2630 if (cc->iv_gen_ops && cc->iv_gen_ops->wipe) { 2631 r = cc->iv_gen_ops->wipe(cc); 2632 if (r) 2633 return r; 2634 } 2635 2636 kfree_sensitive(cc->key_string); 2637 cc->key_string = NULL; 2638 r = crypt_setkey(cc); 2639 memset(&cc->key, 0, cc->key_size * sizeof(u8)); 2640 2641 return r; 2642 } 2643 2644 static void crypt_calculate_pages_per_client(void) 2645 { 2646 unsigned long pages = (totalram_pages() - totalhigh_pages()) * DM_CRYPT_MEMORY_PERCENT / 100; 2647 2648 if (!dm_crypt_clients_n) 2649 return; 2650 2651 pages /= dm_crypt_clients_n; 2652 if (pages < DM_CRYPT_MIN_PAGES_PER_CLIENT) 2653 pages = DM_CRYPT_MIN_PAGES_PER_CLIENT; 2654 dm_crypt_pages_per_client = pages; 2655 } 2656 2657 static void *crypt_page_alloc(gfp_t gfp_mask, void *pool_data) 2658 { 2659 struct crypt_config *cc = pool_data; 2660 struct page *page; 2661 2662 /* 2663 * Note, percpu_counter_read_positive() may over (and under) estimate 2664 * the current usage by at most (batch - 1) * num_online_cpus() pages, 2665 * but avoids potential spinlock contention of an exact result. 2666 */ 2667 if (unlikely(percpu_counter_read_positive(&cc->n_allocated_pages) >= dm_crypt_pages_per_client) && 2668 likely(gfp_mask & __GFP_NORETRY)) 2669 return NULL; 2670 2671 page = alloc_page(gfp_mask); 2672 if (likely(page != NULL)) 2673 percpu_counter_add(&cc->n_allocated_pages, 1); 2674 2675 return page; 2676 } 2677 2678 static void crypt_page_free(void *page, void *pool_data) 2679 { 2680 struct crypt_config *cc = pool_data; 2681 2682 __free_page(page); 2683 percpu_counter_sub(&cc->n_allocated_pages, 1); 2684 } 2685 2686 static void crypt_dtr(struct dm_target *ti) 2687 { 2688 struct crypt_config *cc = ti->private; 2689 2690 ti->private = NULL; 2691 2692 if (!cc) 2693 return; 2694 2695 if (cc->write_thread) 2696 kthread_stop(cc->write_thread); 2697 2698 if (cc->io_queue) 2699 destroy_workqueue(cc->io_queue); 2700 if (cc->crypt_queue) 2701 destroy_workqueue(cc->crypt_queue); 2702 2703 crypt_free_tfms(cc); 2704 2705 bioset_exit(&cc->bs); 2706 2707 mempool_exit(&cc->page_pool); 2708 mempool_exit(&cc->req_pool); 2709 mempool_exit(&cc->tag_pool); 2710 2711 WARN_ON(percpu_counter_sum(&cc->n_allocated_pages) != 0); 2712 percpu_counter_destroy(&cc->n_allocated_pages); 2713 2714 if (cc->iv_gen_ops && cc->iv_gen_ops->dtr) 2715 cc->iv_gen_ops->dtr(cc); 2716 2717 if (cc->dev) 2718 dm_put_device(ti, cc->dev); 2719 2720 kfree_sensitive(cc->cipher_string); 2721 kfree_sensitive(cc->key_string); 2722 kfree_sensitive(cc->cipher_auth); 2723 kfree_sensitive(cc->authenc_key); 2724 2725 mutex_destroy(&cc->bio_alloc_lock); 2726 2727 /* Must zero key material before freeing */ 2728 kfree_sensitive(cc); 2729 2730 spin_lock(&dm_crypt_clients_lock); 2731 WARN_ON(!dm_crypt_clients_n); 2732 dm_crypt_clients_n--; 2733 crypt_calculate_pages_per_client(); 2734 spin_unlock(&dm_crypt_clients_lock); 2735 2736 dm_audit_log_dtr(DM_MSG_PREFIX, ti, 1); 2737 } 2738 2739 static int crypt_ctr_ivmode(struct dm_target *ti, const char *ivmode) 2740 { 2741 struct crypt_config *cc = ti->private; 2742 2743 if (crypt_integrity_aead(cc)) 2744 cc->iv_size = crypto_aead_ivsize(any_tfm_aead(cc)); 2745 else 2746 cc->iv_size = crypto_skcipher_ivsize(any_tfm(cc)); 2747 2748 if (cc->iv_size) 2749 /* at least a 64 bit sector number should fit in our buffer */ 2750 cc->iv_size = max(cc->iv_size, 2751 (unsigned int)(sizeof(u64) / sizeof(u8))); 2752 else if (ivmode) { 2753 DMWARN("Selected cipher does not support IVs"); 2754 ivmode = NULL; 2755 } 2756 2757 /* Choose ivmode, see comments at iv code. */ 2758 if (ivmode == NULL) 2759 cc->iv_gen_ops = NULL; 2760 else if (strcmp(ivmode, "plain") == 0) 2761 cc->iv_gen_ops = &crypt_iv_plain_ops; 2762 else if (strcmp(ivmode, "plain64") == 0) 2763 cc->iv_gen_ops = &crypt_iv_plain64_ops; 2764 else if (strcmp(ivmode, "plain64be") == 0) 2765 cc->iv_gen_ops = &crypt_iv_plain64be_ops; 2766 else if (strcmp(ivmode, "essiv") == 0) 2767 cc->iv_gen_ops = &crypt_iv_essiv_ops; 2768 else if (strcmp(ivmode, "benbi") == 0) 2769 cc->iv_gen_ops = &crypt_iv_benbi_ops; 2770 else if (strcmp(ivmode, "null") == 0) 2771 cc->iv_gen_ops = &crypt_iv_null_ops; 2772 else if (strcmp(ivmode, "eboiv") == 0) 2773 cc->iv_gen_ops = &crypt_iv_eboiv_ops; 2774 else if (strcmp(ivmode, "elephant") == 0) { 2775 cc->iv_gen_ops = &crypt_iv_elephant_ops; 2776 cc->key_parts = 2; 2777 cc->key_extra_size = cc->key_size / 2; 2778 if (cc->key_extra_size > ELEPHANT_MAX_KEY_SIZE) 2779 return -EINVAL; 2780 set_bit(CRYPT_ENCRYPT_PREPROCESS, &cc->cipher_flags); 2781 } else if (strcmp(ivmode, "lmk") == 0) { 2782 cc->iv_gen_ops = &crypt_iv_lmk_ops; 2783 /* 2784 * Version 2 and 3 is recognised according 2785 * to length of provided multi-key string. 2786 * If present (version 3), last key is used as IV seed. 2787 * All keys (including IV seed) are always the same size. 2788 */ 2789 if (cc->key_size % cc->key_parts) { 2790 cc->key_parts++; 2791 cc->key_extra_size = cc->key_size / cc->key_parts; 2792 } 2793 } else if (strcmp(ivmode, "tcw") == 0) { 2794 cc->iv_gen_ops = &crypt_iv_tcw_ops; 2795 cc->key_parts += 2; /* IV + whitening */ 2796 cc->key_extra_size = cc->iv_size + TCW_WHITENING_SIZE; 2797 } else if (strcmp(ivmode, "random") == 0) { 2798 cc->iv_gen_ops = &crypt_iv_random_ops; 2799 /* Need storage space in integrity fields. */ 2800 cc->integrity_iv_size = cc->iv_size; 2801 } else { 2802 ti->error = "Invalid IV mode"; 2803 return -EINVAL; 2804 } 2805 2806 return 0; 2807 } 2808 2809 /* 2810 * Workaround to parse HMAC algorithm from AEAD crypto API spec. 2811 * The HMAC is needed to calculate tag size (HMAC digest size). 2812 * This should be probably done by crypto-api calls (once available...) 2813 */ 2814 static int crypt_ctr_auth_cipher(struct crypt_config *cc, char *cipher_api) 2815 { 2816 char *start, *end, *mac_alg = NULL; 2817 struct crypto_ahash *mac; 2818 2819 if (!strstarts(cipher_api, "authenc(")) 2820 return 0; 2821 2822 start = strchr(cipher_api, '('); 2823 end = strchr(cipher_api, ','); 2824 if (!start || !end || ++start > end) 2825 return -EINVAL; 2826 2827 mac_alg = kzalloc(end - start + 1, GFP_KERNEL); 2828 if (!mac_alg) 2829 return -ENOMEM; 2830 strncpy(mac_alg, start, end - start); 2831 2832 mac = crypto_alloc_ahash(mac_alg, 0, CRYPTO_ALG_ALLOCATES_MEMORY); 2833 kfree(mac_alg); 2834 2835 if (IS_ERR(mac)) 2836 return PTR_ERR(mac); 2837 2838 cc->key_mac_size = crypto_ahash_digestsize(mac); 2839 crypto_free_ahash(mac); 2840 2841 cc->authenc_key = kmalloc(crypt_authenckey_size(cc), GFP_KERNEL); 2842 if (!cc->authenc_key) 2843 return -ENOMEM; 2844 2845 return 0; 2846 } 2847 2848 static int crypt_ctr_cipher_new(struct dm_target *ti, char *cipher_in, char *key, 2849 char **ivmode, char **ivopts) 2850 { 2851 struct crypt_config *cc = ti->private; 2852 char *tmp, *cipher_api, buf[CRYPTO_MAX_ALG_NAME]; 2853 int ret = -EINVAL; 2854 2855 cc->tfms_count = 1; 2856 2857 /* 2858 * New format (capi: prefix) 2859 * capi:cipher_api_spec-iv:ivopts 2860 */ 2861 tmp = &cipher_in[strlen("capi:")]; 2862 2863 /* Separate IV options if present, it can contain another '-' in hash name */ 2864 *ivopts = strrchr(tmp, ':'); 2865 if (*ivopts) { 2866 **ivopts = '\0'; 2867 (*ivopts)++; 2868 } 2869 /* Parse IV mode */ 2870 *ivmode = strrchr(tmp, '-'); 2871 if (*ivmode) { 2872 **ivmode = '\0'; 2873 (*ivmode)++; 2874 } 2875 /* The rest is crypto API spec */ 2876 cipher_api = tmp; 2877 2878 /* Alloc AEAD, can be used only in new format. */ 2879 if (crypt_integrity_aead(cc)) { 2880 ret = crypt_ctr_auth_cipher(cc, cipher_api); 2881 if (ret < 0) { 2882 ti->error = "Invalid AEAD cipher spec"; 2883 return -ENOMEM; 2884 } 2885 } 2886 2887 if (*ivmode && !strcmp(*ivmode, "lmk")) 2888 cc->tfms_count = 64; 2889 2890 if (*ivmode && !strcmp(*ivmode, "essiv")) { 2891 if (!*ivopts) { 2892 ti->error = "Digest algorithm missing for ESSIV mode"; 2893 return -EINVAL; 2894 } 2895 ret = snprintf(buf, CRYPTO_MAX_ALG_NAME, "essiv(%s,%s)", 2896 cipher_api, *ivopts); 2897 if (ret < 0 || ret >= CRYPTO_MAX_ALG_NAME) { 2898 ti->error = "Cannot allocate cipher string"; 2899 return -ENOMEM; 2900 } 2901 cipher_api = buf; 2902 } 2903 2904 cc->key_parts = cc->tfms_count; 2905 2906 /* Allocate cipher */ 2907 ret = crypt_alloc_tfms(cc, cipher_api); 2908 if (ret < 0) { 2909 ti->error = "Error allocating crypto tfm"; 2910 return ret; 2911 } 2912 2913 if (crypt_integrity_aead(cc)) 2914 cc->iv_size = crypto_aead_ivsize(any_tfm_aead(cc)); 2915 else 2916 cc->iv_size = crypto_skcipher_ivsize(any_tfm(cc)); 2917 2918 return 0; 2919 } 2920 2921 static int crypt_ctr_cipher_old(struct dm_target *ti, char *cipher_in, char *key, 2922 char **ivmode, char **ivopts) 2923 { 2924 struct crypt_config *cc = ti->private; 2925 char *tmp, *cipher, *chainmode, *keycount; 2926 char *cipher_api = NULL; 2927 int ret = -EINVAL; 2928 char dummy; 2929 2930 if (strchr(cipher_in, '(') || crypt_integrity_aead(cc)) { 2931 ti->error = "Bad cipher specification"; 2932 return -EINVAL; 2933 } 2934 2935 /* 2936 * Legacy dm-crypt cipher specification 2937 * cipher[:keycount]-mode-iv:ivopts 2938 */ 2939 tmp = cipher_in; 2940 keycount = strsep(&tmp, "-"); 2941 cipher = strsep(&keycount, ":"); 2942 2943 if (!keycount) 2944 cc->tfms_count = 1; 2945 else if (sscanf(keycount, "%u%c", &cc->tfms_count, &dummy) != 1 || 2946 !is_power_of_2(cc->tfms_count)) { 2947 ti->error = "Bad cipher key count specification"; 2948 return -EINVAL; 2949 } 2950 cc->key_parts = cc->tfms_count; 2951 2952 chainmode = strsep(&tmp, "-"); 2953 *ivmode = strsep(&tmp, ":"); 2954 *ivopts = tmp; 2955 2956 /* 2957 * For compatibility with the original dm-crypt mapping format, if 2958 * only the cipher name is supplied, use cbc-plain. 2959 */ 2960 if (!chainmode || (!strcmp(chainmode, "plain") && !*ivmode)) { 2961 chainmode = "cbc"; 2962 *ivmode = "plain"; 2963 } 2964 2965 if (strcmp(chainmode, "ecb") && !*ivmode) { 2966 ti->error = "IV mechanism required"; 2967 return -EINVAL; 2968 } 2969 2970 cipher_api = kmalloc(CRYPTO_MAX_ALG_NAME, GFP_KERNEL); 2971 if (!cipher_api) 2972 goto bad_mem; 2973 2974 if (*ivmode && !strcmp(*ivmode, "essiv")) { 2975 if (!*ivopts) { 2976 ti->error = "Digest algorithm missing for ESSIV mode"; 2977 kfree(cipher_api); 2978 return -EINVAL; 2979 } 2980 ret = snprintf(cipher_api, CRYPTO_MAX_ALG_NAME, 2981 "essiv(%s(%s),%s)", chainmode, cipher, *ivopts); 2982 } else { 2983 ret = snprintf(cipher_api, CRYPTO_MAX_ALG_NAME, 2984 "%s(%s)", chainmode, cipher); 2985 } 2986 if (ret < 0 || ret >= CRYPTO_MAX_ALG_NAME) { 2987 kfree(cipher_api); 2988 goto bad_mem; 2989 } 2990 2991 /* Allocate cipher */ 2992 ret = crypt_alloc_tfms(cc, cipher_api); 2993 if (ret < 0) { 2994 ti->error = "Error allocating crypto tfm"; 2995 kfree(cipher_api); 2996 return ret; 2997 } 2998 kfree(cipher_api); 2999 3000 return 0; 3001 bad_mem: 3002 ti->error = "Cannot allocate cipher strings"; 3003 return -ENOMEM; 3004 } 3005 3006 static int crypt_ctr_cipher(struct dm_target *ti, char *cipher_in, char *key) 3007 { 3008 struct crypt_config *cc = ti->private; 3009 char *ivmode = NULL, *ivopts = NULL; 3010 int ret; 3011 3012 cc->cipher_string = kstrdup(cipher_in, GFP_KERNEL); 3013 if (!cc->cipher_string) { 3014 ti->error = "Cannot allocate cipher strings"; 3015 return -ENOMEM; 3016 } 3017 3018 if (strstarts(cipher_in, "capi:")) 3019 ret = crypt_ctr_cipher_new(ti, cipher_in, key, &ivmode, &ivopts); 3020 else 3021 ret = crypt_ctr_cipher_old(ti, cipher_in, key, &ivmode, &ivopts); 3022 if (ret) 3023 return ret; 3024 3025 /* Initialize IV */ 3026 ret = crypt_ctr_ivmode(ti, ivmode); 3027 if (ret < 0) 3028 return ret; 3029 3030 /* Initialize and set key */ 3031 ret = crypt_set_key(cc, key); 3032 if (ret < 0) { 3033 ti->error = "Error decoding and setting key"; 3034 return ret; 3035 } 3036 3037 /* Allocate IV */ 3038 if (cc->iv_gen_ops && cc->iv_gen_ops->ctr) { 3039 ret = cc->iv_gen_ops->ctr(cc, ti, ivopts); 3040 if (ret < 0) { 3041 ti->error = "Error creating IV"; 3042 return ret; 3043 } 3044 } 3045 3046 /* Initialize IV (set keys for ESSIV etc) */ 3047 if (cc->iv_gen_ops && cc->iv_gen_ops->init) { 3048 ret = cc->iv_gen_ops->init(cc); 3049 if (ret < 0) { 3050 ti->error = "Error initialising IV"; 3051 return ret; 3052 } 3053 } 3054 3055 /* wipe the kernel key payload copy */ 3056 if (cc->key_string) 3057 memset(cc->key, 0, cc->key_size * sizeof(u8)); 3058 3059 return ret; 3060 } 3061 3062 static int crypt_ctr_optional(struct dm_target *ti, unsigned int argc, char **argv) 3063 { 3064 struct crypt_config *cc = ti->private; 3065 struct dm_arg_set as; 3066 static const struct dm_arg _args[] = { 3067 {0, 8, "Invalid number of feature args"}, 3068 }; 3069 unsigned int opt_params, val; 3070 const char *opt_string, *sval; 3071 char dummy; 3072 int ret; 3073 3074 /* Optional parameters */ 3075 as.argc = argc; 3076 as.argv = argv; 3077 3078 ret = dm_read_arg_group(_args, &as, &opt_params, &ti->error); 3079 if (ret) 3080 return ret; 3081 3082 while (opt_params--) { 3083 opt_string = dm_shift_arg(&as); 3084 if (!opt_string) { 3085 ti->error = "Not enough feature arguments"; 3086 return -EINVAL; 3087 } 3088 3089 if (!strcasecmp(opt_string, "allow_discards")) 3090 ti->num_discard_bios = 1; 3091 3092 else if (!strcasecmp(opt_string, "same_cpu_crypt")) 3093 set_bit(DM_CRYPT_SAME_CPU, &cc->flags); 3094 3095 else if (!strcasecmp(opt_string, "submit_from_crypt_cpus")) 3096 set_bit(DM_CRYPT_NO_OFFLOAD, &cc->flags); 3097 else if (!strcasecmp(opt_string, "no_read_workqueue")) 3098 set_bit(DM_CRYPT_NO_READ_WORKQUEUE, &cc->flags); 3099 else if (!strcasecmp(opt_string, "no_write_workqueue")) 3100 set_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags); 3101 else if (sscanf(opt_string, "integrity:%u:", &val) == 1) { 3102 if (val == 0 || val > MAX_TAG_SIZE) { 3103 ti->error = "Invalid integrity arguments"; 3104 return -EINVAL; 3105 } 3106 cc->on_disk_tag_size = val; 3107 sval = strchr(opt_string + strlen("integrity:"), ':') + 1; 3108 if (!strcasecmp(sval, "aead")) { 3109 set_bit(CRYPT_MODE_INTEGRITY_AEAD, &cc->cipher_flags); 3110 } else if (strcasecmp(sval, "none")) { 3111 ti->error = "Unknown integrity profile"; 3112 return -EINVAL; 3113 } 3114 3115 cc->cipher_auth = kstrdup(sval, GFP_KERNEL); 3116 if (!cc->cipher_auth) 3117 return -ENOMEM; 3118 } else if (sscanf(opt_string, "sector_size:%hu%c", &cc->sector_size, &dummy) == 1) { 3119 if (cc->sector_size < (1 << SECTOR_SHIFT) || 3120 cc->sector_size > 4096 || 3121 (cc->sector_size & (cc->sector_size - 1))) { 3122 ti->error = "Invalid feature value for sector_size"; 3123 return -EINVAL; 3124 } 3125 if (ti->len & ((cc->sector_size >> SECTOR_SHIFT) - 1)) { 3126 ti->error = "Device size is not multiple of sector_size feature"; 3127 return -EINVAL; 3128 } 3129 cc->sector_shift = __ffs(cc->sector_size) - SECTOR_SHIFT; 3130 } else if (!strcasecmp(opt_string, "iv_large_sectors")) 3131 set_bit(CRYPT_IV_LARGE_SECTORS, &cc->cipher_flags); 3132 else { 3133 ti->error = "Invalid feature arguments"; 3134 return -EINVAL; 3135 } 3136 } 3137 3138 return 0; 3139 } 3140 3141 #ifdef CONFIG_BLK_DEV_ZONED 3142 static int crypt_report_zones(struct dm_target *ti, 3143 struct dm_report_zones_args *args, unsigned int nr_zones) 3144 { 3145 struct crypt_config *cc = ti->private; 3146 3147 return dm_report_zones(cc->dev->bdev, cc->start, 3148 cc->start + dm_target_offset(ti, args->next_sector), 3149 args, nr_zones); 3150 } 3151 #else 3152 #define crypt_report_zones NULL 3153 #endif 3154 3155 /* 3156 * Construct an encryption mapping: 3157 * <cipher> [<key>|:<key_size>:<user|logon>:<key_description>] <iv_offset> <dev_path> <start> 3158 */ 3159 static int crypt_ctr(struct dm_target *ti, unsigned int argc, char **argv) 3160 { 3161 struct crypt_config *cc; 3162 const char *devname = dm_table_device_name(ti->table); 3163 int key_size; 3164 unsigned int align_mask; 3165 unsigned long long tmpll; 3166 int ret; 3167 size_t iv_size_padding, additional_req_size; 3168 char dummy; 3169 3170 if (argc < 5) { 3171 ti->error = "Not enough arguments"; 3172 return -EINVAL; 3173 } 3174 3175 key_size = get_key_size(&argv[1]); 3176 if (key_size < 0) { 3177 ti->error = "Cannot parse key size"; 3178 return -EINVAL; 3179 } 3180 3181 cc = kzalloc(struct_size(cc, key, key_size), GFP_KERNEL); 3182 if (!cc) { 3183 ti->error = "Cannot allocate encryption context"; 3184 return -ENOMEM; 3185 } 3186 cc->key_size = key_size; 3187 cc->sector_size = (1 << SECTOR_SHIFT); 3188 cc->sector_shift = 0; 3189 3190 ti->private = cc; 3191 3192 spin_lock(&dm_crypt_clients_lock); 3193 dm_crypt_clients_n++; 3194 crypt_calculate_pages_per_client(); 3195 spin_unlock(&dm_crypt_clients_lock); 3196 3197 ret = percpu_counter_init(&cc->n_allocated_pages, 0, GFP_KERNEL); 3198 if (ret < 0) 3199 goto bad; 3200 3201 /* Optional parameters need to be read before cipher constructor */ 3202 if (argc > 5) { 3203 ret = crypt_ctr_optional(ti, argc - 5, &argv[5]); 3204 if (ret) 3205 goto bad; 3206 } 3207 3208 ret = crypt_ctr_cipher(ti, argv[0], argv[1]); 3209 if (ret < 0) 3210 goto bad; 3211 3212 if (crypt_integrity_aead(cc)) { 3213 cc->dmreq_start = sizeof(struct aead_request); 3214 cc->dmreq_start += crypto_aead_reqsize(any_tfm_aead(cc)); 3215 align_mask = crypto_aead_alignmask(any_tfm_aead(cc)); 3216 } else { 3217 cc->dmreq_start = sizeof(struct skcipher_request); 3218 cc->dmreq_start += crypto_skcipher_reqsize(any_tfm(cc)); 3219 align_mask = crypto_skcipher_alignmask(any_tfm(cc)); 3220 } 3221 cc->dmreq_start = ALIGN(cc->dmreq_start, __alignof__(struct dm_crypt_request)); 3222 3223 if (align_mask < CRYPTO_MINALIGN) { 3224 /* Allocate the padding exactly */ 3225 iv_size_padding = -(cc->dmreq_start + sizeof(struct dm_crypt_request)) 3226 & align_mask; 3227 } else { 3228 /* 3229 * If the cipher requires greater alignment than kmalloc 3230 * alignment, we don't know the exact position of the 3231 * initialization vector. We must assume worst case. 3232 */ 3233 iv_size_padding = align_mask; 3234 } 3235 3236 /* ...| IV + padding | original IV | original sec. number | bio tag offset | */ 3237 additional_req_size = sizeof(struct dm_crypt_request) + 3238 iv_size_padding + cc->iv_size + 3239 cc->iv_size + 3240 sizeof(uint64_t) + 3241 sizeof(unsigned int); 3242 3243 ret = mempool_init_kmalloc_pool(&cc->req_pool, MIN_IOS, cc->dmreq_start + additional_req_size); 3244 if (ret) { 3245 ti->error = "Cannot allocate crypt request mempool"; 3246 goto bad; 3247 } 3248 3249 cc->per_bio_data_size = ti->per_io_data_size = 3250 ALIGN(sizeof(struct dm_crypt_io) + cc->dmreq_start + additional_req_size, 3251 ARCH_KMALLOC_MINALIGN); 3252 3253 ret = mempool_init(&cc->page_pool, BIO_MAX_VECS, crypt_page_alloc, crypt_page_free, cc); 3254 if (ret) { 3255 ti->error = "Cannot allocate page mempool"; 3256 goto bad; 3257 } 3258 3259 ret = bioset_init(&cc->bs, MIN_IOS, 0, BIOSET_NEED_BVECS); 3260 if (ret) { 3261 ti->error = "Cannot allocate crypt bioset"; 3262 goto bad; 3263 } 3264 3265 mutex_init(&cc->bio_alloc_lock); 3266 3267 ret = -EINVAL; 3268 if ((sscanf(argv[2], "%llu%c", &tmpll, &dummy) != 1) || 3269 (tmpll & ((cc->sector_size >> SECTOR_SHIFT) - 1))) { 3270 ti->error = "Invalid iv_offset sector"; 3271 goto bad; 3272 } 3273 cc->iv_offset = tmpll; 3274 3275 ret = dm_get_device(ti, argv[3], dm_table_get_mode(ti->table), &cc->dev); 3276 if (ret) { 3277 ti->error = "Device lookup failed"; 3278 goto bad; 3279 } 3280 3281 ret = -EINVAL; 3282 if (sscanf(argv[4], "%llu%c", &tmpll, &dummy) != 1 || tmpll != (sector_t)tmpll) { 3283 ti->error = "Invalid device sector"; 3284 goto bad; 3285 } 3286 cc->start = tmpll; 3287 3288 if (bdev_is_zoned(cc->dev->bdev)) { 3289 /* 3290 * For zoned block devices, we need to preserve the issuer write 3291 * ordering. To do so, disable write workqueues and force inline 3292 * encryption completion. 3293 */ 3294 set_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags); 3295 set_bit(DM_CRYPT_WRITE_INLINE, &cc->flags); 3296 3297 /* 3298 * All zone append writes to a zone of a zoned block device will 3299 * have the same BIO sector, the start of the zone. When the 3300 * cypher IV mode uses sector values, all data targeting a 3301 * zone will be encrypted using the first sector numbers of the 3302 * zone. This will not result in write errors but will 3303 * cause most reads to fail as reads will use the sector values 3304 * for the actual data locations, resulting in IV mismatch. 3305 * To avoid this problem, ask DM core to emulate zone append 3306 * operations with regular writes. 3307 */ 3308 DMDEBUG("Zone append operations will be emulated"); 3309 ti->emulate_zone_append = true; 3310 } 3311 3312 if (crypt_integrity_aead(cc) || cc->integrity_iv_size) { 3313 ret = crypt_integrity_ctr(cc, ti); 3314 if (ret) 3315 goto bad; 3316 3317 cc->tag_pool_max_sectors = POOL_ENTRY_SIZE / cc->on_disk_tag_size; 3318 if (!cc->tag_pool_max_sectors) 3319 cc->tag_pool_max_sectors = 1; 3320 3321 ret = mempool_init_kmalloc_pool(&cc->tag_pool, MIN_IOS, 3322 cc->tag_pool_max_sectors * cc->on_disk_tag_size); 3323 if (ret) { 3324 ti->error = "Cannot allocate integrity tags mempool"; 3325 goto bad; 3326 } 3327 3328 cc->tag_pool_max_sectors <<= cc->sector_shift; 3329 } 3330 3331 ret = -ENOMEM; 3332 cc->io_queue = alloc_workqueue("kcryptd_io/%s", WQ_MEM_RECLAIM, 1, devname); 3333 if (!cc->io_queue) { 3334 ti->error = "Couldn't create kcryptd io queue"; 3335 goto bad; 3336 } 3337 3338 if (test_bit(DM_CRYPT_SAME_CPU, &cc->flags)) 3339 cc->crypt_queue = alloc_workqueue("kcryptd/%s", WQ_CPU_INTENSIVE | WQ_MEM_RECLAIM, 3340 1, devname); 3341 else 3342 cc->crypt_queue = alloc_workqueue("kcryptd/%s", 3343 WQ_CPU_INTENSIVE | WQ_MEM_RECLAIM | WQ_UNBOUND, 3344 num_online_cpus(), devname); 3345 if (!cc->crypt_queue) { 3346 ti->error = "Couldn't create kcryptd queue"; 3347 goto bad; 3348 } 3349 3350 spin_lock_init(&cc->write_thread_lock); 3351 cc->write_tree = RB_ROOT; 3352 3353 cc->write_thread = kthread_run(dmcrypt_write, cc, "dmcrypt_write/%s", devname); 3354 if (IS_ERR(cc->write_thread)) { 3355 ret = PTR_ERR(cc->write_thread); 3356 cc->write_thread = NULL; 3357 ti->error = "Couldn't spawn write thread"; 3358 goto bad; 3359 } 3360 3361 ti->num_flush_bios = 1; 3362 ti->limit_swap_bios = true; 3363 ti->accounts_remapped_io = true; 3364 3365 dm_audit_log_ctr(DM_MSG_PREFIX, ti, 1); 3366 return 0; 3367 3368 bad: 3369 dm_audit_log_ctr(DM_MSG_PREFIX, ti, 0); 3370 crypt_dtr(ti); 3371 return ret; 3372 } 3373 3374 static int crypt_map(struct dm_target *ti, struct bio *bio) 3375 { 3376 struct dm_crypt_io *io; 3377 struct crypt_config *cc = ti->private; 3378 3379 /* 3380 * If bio is REQ_PREFLUSH or REQ_OP_DISCARD, just bypass crypt queues. 3381 * - for REQ_PREFLUSH device-mapper core ensures that no IO is in-flight 3382 * - for REQ_OP_DISCARD caller must use flush if IO ordering matters 3383 */ 3384 if (unlikely(bio->bi_opf & REQ_PREFLUSH || 3385 bio_op(bio) == REQ_OP_DISCARD)) { 3386 bio_set_dev(bio, cc->dev->bdev); 3387 if (bio_sectors(bio)) 3388 bio->bi_iter.bi_sector = cc->start + 3389 dm_target_offset(ti, bio->bi_iter.bi_sector); 3390 return DM_MAPIO_REMAPPED; 3391 } 3392 3393 /* 3394 * Check if bio is too large, split as needed. 3395 */ 3396 if (unlikely(bio->bi_iter.bi_size > (BIO_MAX_VECS << PAGE_SHIFT)) && 3397 (bio_data_dir(bio) == WRITE || cc->on_disk_tag_size)) 3398 dm_accept_partial_bio(bio, ((BIO_MAX_VECS << PAGE_SHIFT) >> SECTOR_SHIFT)); 3399 3400 /* 3401 * Ensure that bio is a multiple of internal sector encryption size 3402 * and is aligned to this size as defined in IO hints. 3403 */ 3404 if (unlikely((bio->bi_iter.bi_sector & ((cc->sector_size >> SECTOR_SHIFT) - 1)) != 0)) 3405 return DM_MAPIO_KILL; 3406 3407 if (unlikely(bio->bi_iter.bi_size & (cc->sector_size - 1))) 3408 return DM_MAPIO_KILL; 3409 3410 io = dm_per_bio_data(bio, cc->per_bio_data_size); 3411 crypt_io_init(io, cc, bio, dm_target_offset(ti, bio->bi_iter.bi_sector)); 3412 3413 if (cc->on_disk_tag_size) { 3414 unsigned tag_len = cc->on_disk_tag_size * (bio_sectors(bio) >> cc->sector_shift); 3415 3416 if (unlikely(tag_len > KMALLOC_MAX_SIZE) || 3417 unlikely(!(io->integrity_metadata = kmalloc(tag_len, 3418 GFP_NOIO | __GFP_NORETRY | __GFP_NOMEMALLOC | __GFP_NOWARN)))) { 3419 if (bio_sectors(bio) > cc->tag_pool_max_sectors) 3420 dm_accept_partial_bio(bio, cc->tag_pool_max_sectors); 3421 io->integrity_metadata = mempool_alloc(&cc->tag_pool, GFP_NOIO); 3422 io->integrity_metadata_from_pool = true; 3423 } 3424 } 3425 3426 if (crypt_integrity_aead(cc)) 3427 io->ctx.r.req_aead = (struct aead_request *)(io + 1); 3428 else 3429 io->ctx.r.req = (struct skcipher_request *)(io + 1); 3430 3431 if (bio_data_dir(io->base_bio) == READ) { 3432 if (kcryptd_io_read(io, CRYPT_MAP_READ_GFP)) 3433 kcryptd_queue_read(io); 3434 } else 3435 kcryptd_queue_crypt(io); 3436 3437 return DM_MAPIO_SUBMITTED; 3438 } 3439 3440 static char hex2asc(unsigned char c) 3441 { 3442 return c + '0' + ((unsigned)(9 - c) >> 4 & 0x27); 3443 } 3444 3445 static void crypt_status(struct dm_target *ti, status_type_t type, 3446 unsigned status_flags, char *result, unsigned maxlen) 3447 { 3448 struct crypt_config *cc = ti->private; 3449 unsigned i, sz = 0; 3450 int num_feature_args = 0; 3451 3452 switch (type) { 3453 case STATUSTYPE_INFO: 3454 result[0] = '\0'; 3455 break; 3456 3457 case STATUSTYPE_TABLE: 3458 DMEMIT("%s ", cc->cipher_string); 3459 3460 if (cc->key_size > 0) { 3461 if (cc->key_string) 3462 DMEMIT(":%u:%s", cc->key_size, cc->key_string); 3463 else { 3464 for (i = 0; i < cc->key_size; i++) { 3465 DMEMIT("%c%c", hex2asc(cc->key[i] >> 4), 3466 hex2asc(cc->key[i] & 0xf)); 3467 } 3468 } 3469 } else 3470 DMEMIT("-"); 3471 3472 DMEMIT(" %llu %s %llu", (unsigned long long)cc->iv_offset, 3473 cc->dev->name, (unsigned long long)cc->start); 3474 3475 num_feature_args += !!ti->num_discard_bios; 3476 num_feature_args += test_bit(DM_CRYPT_SAME_CPU, &cc->flags); 3477 num_feature_args += test_bit(DM_CRYPT_NO_OFFLOAD, &cc->flags); 3478 num_feature_args += test_bit(DM_CRYPT_NO_READ_WORKQUEUE, &cc->flags); 3479 num_feature_args += test_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags); 3480 num_feature_args += cc->sector_size != (1 << SECTOR_SHIFT); 3481 num_feature_args += test_bit(CRYPT_IV_LARGE_SECTORS, &cc->cipher_flags); 3482 if (cc->on_disk_tag_size) 3483 num_feature_args++; 3484 if (num_feature_args) { 3485 DMEMIT(" %d", num_feature_args); 3486 if (ti->num_discard_bios) 3487 DMEMIT(" allow_discards"); 3488 if (test_bit(DM_CRYPT_SAME_CPU, &cc->flags)) 3489 DMEMIT(" same_cpu_crypt"); 3490 if (test_bit(DM_CRYPT_NO_OFFLOAD, &cc->flags)) 3491 DMEMIT(" submit_from_crypt_cpus"); 3492 if (test_bit(DM_CRYPT_NO_READ_WORKQUEUE, &cc->flags)) 3493 DMEMIT(" no_read_workqueue"); 3494 if (test_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags)) 3495 DMEMIT(" no_write_workqueue"); 3496 if (cc->on_disk_tag_size) 3497 DMEMIT(" integrity:%u:%s", cc->on_disk_tag_size, cc->cipher_auth); 3498 if (cc->sector_size != (1 << SECTOR_SHIFT)) 3499 DMEMIT(" sector_size:%d", cc->sector_size); 3500 if (test_bit(CRYPT_IV_LARGE_SECTORS, &cc->cipher_flags)) 3501 DMEMIT(" iv_large_sectors"); 3502 } 3503 break; 3504 3505 case STATUSTYPE_IMA: 3506 DMEMIT_TARGET_NAME_VERSION(ti->type); 3507 DMEMIT(",allow_discards=%c", ti->num_discard_bios ? 'y' : 'n'); 3508 DMEMIT(",same_cpu_crypt=%c", test_bit(DM_CRYPT_SAME_CPU, &cc->flags) ? 'y' : 'n'); 3509 DMEMIT(",submit_from_crypt_cpus=%c", test_bit(DM_CRYPT_NO_OFFLOAD, &cc->flags) ? 3510 'y' : 'n'); 3511 DMEMIT(",no_read_workqueue=%c", test_bit(DM_CRYPT_NO_READ_WORKQUEUE, &cc->flags) ? 3512 'y' : 'n'); 3513 DMEMIT(",no_write_workqueue=%c", test_bit(DM_CRYPT_NO_WRITE_WORKQUEUE, &cc->flags) ? 3514 'y' : 'n'); 3515 DMEMIT(",iv_large_sectors=%c", test_bit(CRYPT_IV_LARGE_SECTORS, &cc->cipher_flags) ? 3516 'y' : 'n'); 3517 3518 if (cc->on_disk_tag_size) 3519 DMEMIT(",integrity_tag_size=%u,cipher_auth=%s", 3520 cc->on_disk_tag_size, cc->cipher_auth); 3521 if (cc->sector_size != (1 << SECTOR_SHIFT)) 3522 DMEMIT(",sector_size=%d", cc->sector_size); 3523 if (cc->cipher_string) 3524 DMEMIT(",cipher_string=%s", cc->cipher_string); 3525 3526 DMEMIT(",key_size=%u", cc->key_size); 3527 DMEMIT(",key_parts=%u", cc->key_parts); 3528 DMEMIT(",key_extra_size=%u", cc->key_extra_size); 3529 DMEMIT(",key_mac_size=%u", cc->key_mac_size); 3530 DMEMIT(";"); 3531 break; 3532 } 3533 } 3534 3535 static void crypt_postsuspend(struct dm_target *ti) 3536 { 3537 struct crypt_config *cc = ti->private; 3538 3539 set_bit(DM_CRYPT_SUSPENDED, &cc->flags); 3540 } 3541 3542 static int crypt_preresume(struct dm_target *ti) 3543 { 3544 struct crypt_config *cc = ti->private; 3545 3546 if (!test_bit(DM_CRYPT_KEY_VALID, &cc->flags)) { 3547 DMERR("aborting resume - crypt key is not set."); 3548 return -EAGAIN; 3549 } 3550 3551 return 0; 3552 } 3553 3554 static void crypt_resume(struct dm_target *ti) 3555 { 3556 struct crypt_config *cc = ti->private; 3557 3558 clear_bit(DM_CRYPT_SUSPENDED, &cc->flags); 3559 } 3560 3561 /* Message interface 3562 * key set <key> 3563 * key wipe 3564 */ 3565 static int crypt_message(struct dm_target *ti, unsigned argc, char **argv, 3566 char *result, unsigned maxlen) 3567 { 3568 struct crypt_config *cc = ti->private; 3569 int key_size, ret = -EINVAL; 3570 3571 if (argc < 2) 3572 goto error; 3573 3574 if (!strcasecmp(argv[0], "key")) { 3575 if (!test_bit(DM_CRYPT_SUSPENDED, &cc->flags)) { 3576 DMWARN("not suspended during key manipulation."); 3577 return -EINVAL; 3578 } 3579 if (argc == 3 && !strcasecmp(argv[1], "set")) { 3580 /* The key size may not be changed. */ 3581 key_size = get_key_size(&argv[2]); 3582 if (key_size < 0 || cc->key_size != key_size) { 3583 memset(argv[2], '0', strlen(argv[2])); 3584 return -EINVAL; 3585 } 3586 3587 ret = crypt_set_key(cc, argv[2]); 3588 if (ret) 3589 return ret; 3590 if (cc->iv_gen_ops && cc->iv_gen_ops->init) 3591 ret = cc->iv_gen_ops->init(cc); 3592 /* wipe the kernel key payload copy */ 3593 if (cc->key_string) 3594 memset(cc->key, 0, cc->key_size * sizeof(u8)); 3595 return ret; 3596 } 3597 if (argc == 2 && !strcasecmp(argv[1], "wipe")) 3598 return crypt_wipe_key(cc); 3599 } 3600 3601 error: 3602 DMWARN("unrecognised message received."); 3603 return -EINVAL; 3604 } 3605 3606 static int crypt_iterate_devices(struct dm_target *ti, 3607 iterate_devices_callout_fn fn, void *data) 3608 { 3609 struct crypt_config *cc = ti->private; 3610 3611 return fn(ti, cc->dev, cc->start, ti->len, data); 3612 } 3613 3614 static void crypt_io_hints(struct dm_target *ti, struct queue_limits *limits) 3615 { 3616 struct crypt_config *cc = ti->private; 3617 3618 /* 3619 * Unfortunate constraint that is required to avoid the potential 3620 * for exceeding underlying device's max_segments limits -- due to 3621 * crypt_alloc_buffer() possibly allocating pages for the encryption 3622 * bio that are not as physically contiguous as the original bio. 3623 */ 3624 limits->max_segment_size = PAGE_SIZE; 3625 3626 limits->logical_block_size = 3627 max_t(unsigned, limits->logical_block_size, cc->sector_size); 3628 limits->physical_block_size = 3629 max_t(unsigned, limits->physical_block_size, cc->sector_size); 3630 limits->io_min = max_t(unsigned, limits->io_min, cc->sector_size); 3631 limits->dma_alignment = limits->logical_block_size - 1; 3632 } 3633 3634 static struct target_type crypt_target = { 3635 .name = "crypt", 3636 .version = {1, 24, 0}, 3637 .module = THIS_MODULE, 3638 .ctr = crypt_ctr, 3639 .dtr = crypt_dtr, 3640 .features = DM_TARGET_ZONED_HM, 3641 .report_zones = crypt_report_zones, 3642 .map = crypt_map, 3643 .status = crypt_status, 3644 .postsuspend = crypt_postsuspend, 3645 .preresume = crypt_preresume, 3646 .resume = crypt_resume, 3647 .message = crypt_message, 3648 .iterate_devices = crypt_iterate_devices, 3649 .io_hints = crypt_io_hints, 3650 }; 3651 3652 static int __init dm_crypt_init(void) 3653 { 3654 int r; 3655 3656 r = dm_register_target(&crypt_target); 3657 if (r < 0) 3658 DMERR("register failed %d", r); 3659 3660 return r; 3661 } 3662 3663 static void __exit dm_crypt_exit(void) 3664 { 3665 dm_unregister_target(&crypt_target); 3666 } 3667 3668 module_init(dm_crypt_init); 3669 module_exit(dm_crypt_exit); 3670 3671 MODULE_AUTHOR("Jana Saout <jana@saout.de>"); 3672 MODULE_DESCRIPTION(DM_NAME " target for transparent encryption / decryption"); 3673 MODULE_LICENSE("GPL"); 3674