1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (C) 2010 IBM Corporation 4 * Copyright (C) 2010 Politecnico di Torino, Italy 5 * TORSEC group -- https://security.polito.it 6 * 7 * Authors: 8 * Mimi Zohar <zohar@us.ibm.com> 9 * Roberto Sassu <roberto.sassu@polito.it> 10 * 11 * See Documentation/security/keys/trusted-encrypted.rst 12 */ 13 14 #include <linux/uaccess.h> 15 #include <linux/module.h> 16 #include <linux/hex.h> 17 #include <linux/init.h> 18 #include <linux/slab.h> 19 #include <linux/parser.h> 20 #include <linux/string.h> 21 #include <linux/err.h> 22 #include <linux/overflow.h> 23 #include <keys/user-type.h> 24 #include <keys/trusted-type.h> 25 #include <keys/encrypted-type.h> 26 #include <linux/key-type.h> 27 #include <linux/random.h> 28 #include <linux/rcupdate.h> 29 #include <linux/scatterlist.h> 30 #include <linux/ctype.h> 31 #include <crypto/aes.h> 32 #include <crypto/sha2.h> 33 #include <crypto/skcipher.h> 34 #include <crypto/utils.h> 35 36 #include "encrypted.h" 37 #include "ecryptfs_format.h" 38 39 static const char KEY_TRUSTED_PREFIX[] = "trusted:"; 40 static const char KEY_USER_PREFIX[] = "user:"; 41 static const char blkcipher_alg[] = "cbc(aes)"; 42 static const char key_format_default[] = "default"; 43 static const char key_format_ecryptfs[] = "ecryptfs"; 44 static const char key_format_enc32[] = "enc32"; 45 static unsigned int ivsize; 46 static int blksize; 47 48 #define KEY_TRUSTED_PREFIX_LEN (sizeof (KEY_TRUSTED_PREFIX) - 1) 49 #define KEY_USER_PREFIX_LEN (sizeof (KEY_USER_PREFIX) - 1) 50 #define KEY_ECRYPTFS_DESC_LEN 16 51 #define HASH_SIZE SHA256_DIGEST_SIZE 52 #define MAX_DATA_SIZE 4096 53 #define MIN_DATA_SIZE 20 54 #define KEY_ENC32_PAYLOAD_LEN 32 55 56 enum { 57 Opt_new, Opt_load, Opt_update, Opt_err 58 }; 59 60 enum { 61 Opt_default, Opt_ecryptfs, Opt_enc32, Opt_error 62 }; 63 64 static const match_table_t key_format_tokens = { 65 {Opt_default, "default"}, 66 {Opt_ecryptfs, "ecryptfs"}, 67 {Opt_enc32, "enc32"}, 68 {Opt_error, NULL} 69 }; 70 71 static const match_table_t key_tokens = { 72 {Opt_new, "new"}, 73 {Opt_load, "load"}, 74 {Opt_update, "update"}, 75 {Opt_err, NULL} 76 }; 77 78 static bool user_decrypted_data = IS_ENABLED(CONFIG_USER_DECRYPTED_DATA); 79 module_param(user_decrypted_data, bool, 0); 80 MODULE_PARM_DESC(user_decrypted_data, 81 "Allow instantiation of encrypted keys using provided decrypted data"); 82 83 static int aes_get_sizes(void) 84 { 85 struct crypto_skcipher *tfm; 86 87 tfm = crypto_alloc_skcipher(blkcipher_alg, 0, CRYPTO_ALG_ASYNC); 88 if (IS_ERR(tfm)) { 89 pr_err("encrypted_key: failed to alloc_cipher (%ld)\n", 90 PTR_ERR(tfm)); 91 return PTR_ERR(tfm); 92 } 93 ivsize = crypto_skcipher_ivsize(tfm); 94 blksize = crypto_skcipher_blocksize(tfm); 95 crypto_free_skcipher(tfm); 96 return 0; 97 } 98 99 /* 100 * valid_ecryptfs_desc - verify the description of a new/loaded encrypted key 101 * 102 * The description of a encrypted key with format 'ecryptfs' must contain 103 * exactly 16 hexadecimal characters. 104 * 105 */ 106 static int valid_ecryptfs_desc(const char *ecryptfs_desc) 107 { 108 int i; 109 110 if (strlen(ecryptfs_desc) != KEY_ECRYPTFS_DESC_LEN) { 111 pr_err("encrypted_key: key description must be %d hexadecimal " 112 "characters long\n", KEY_ECRYPTFS_DESC_LEN); 113 return -EINVAL; 114 } 115 116 for (i = 0; i < KEY_ECRYPTFS_DESC_LEN; i++) { 117 if (!isxdigit(ecryptfs_desc[i])) { 118 pr_err("encrypted_key: key description must contain " 119 "only hexadecimal characters\n"); 120 return -EINVAL; 121 } 122 } 123 124 return 0; 125 } 126 127 /* 128 * valid_master_desc - verify the 'key-type:desc' of a new/updated master-key 129 * 130 * key-type:= "trusted:" | "user:" 131 * desc:= master-key description 132 * 133 * Verify that 'key-type' is valid and that 'desc' exists. On key update, 134 * only the master key description is permitted to change, not the key-type. 135 * The key-type remains constant. 136 * 137 * On success returns 0, otherwise -EINVAL. 138 */ 139 static int valid_master_desc(const char *new_desc, const char *orig_desc) 140 { 141 int prefix_len; 142 143 if (!strncmp(new_desc, KEY_TRUSTED_PREFIX, KEY_TRUSTED_PREFIX_LEN)) 144 prefix_len = KEY_TRUSTED_PREFIX_LEN; 145 else if (!strncmp(new_desc, KEY_USER_PREFIX, KEY_USER_PREFIX_LEN)) 146 prefix_len = KEY_USER_PREFIX_LEN; 147 else 148 return -EINVAL; 149 150 if (!new_desc[prefix_len]) 151 return -EINVAL; 152 153 if (orig_desc && strncmp(new_desc, orig_desc, prefix_len)) 154 return -EINVAL; 155 156 return 0; 157 } 158 159 /* 160 * datablob_parse - parse the keyctl data 161 * 162 * datablob format: 163 * new [<format>] <master-key name> <decrypted data length> [<decrypted data>] 164 * load [<format>] <master-key name> <decrypted data length> 165 * <encrypted iv + data> 166 * update <new-master-key name> 167 * 168 * Tokenizes a copy of the keyctl data, returning a pointer to each token, 169 * which is null terminated. 170 * 171 * On success returns 0, otherwise -EINVAL. 172 */ 173 static int datablob_parse(char *datablob, const char **format, 174 char **master_desc, char **decrypted_datalen, 175 char **hex_encoded_iv, char **decrypted_data) 176 { 177 substring_t args[MAX_OPT_ARGS]; 178 int ret = -EINVAL; 179 int key_cmd; 180 int key_format; 181 char *p, *keyword; 182 183 keyword = strsep(&datablob, " \t"); 184 if (!keyword) { 185 pr_info("encrypted_key: insufficient parameters specified\n"); 186 return ret; 187 } 188 key_cmd = match_token(keyword, key_tokens, args); 189 190 /* Get optional format: default | ecryptfs */ 191 p = strsep(&datablob, " \t"); 192 if (!p) { 193 pr_err("encrypted_key: insufficient parameters specified\n"); 194 return ret; 195 } 196 197 key_format = match_token(p, key_format_tokens, args); 198 switch (key_format) { 199 case Opt_ecryptfs: 200 case Opt_enc32: 201 case Opt_default: 202 *format = p; 203 *master_desc = strsep(&datablob, " \t"); 204 break; 205 case Opt_error: 206 *master_desc = p; 207 break; 208 } 209 210 if (!*master_desc) { 211 pr_info("encrypted_key: master key parameter is missing\n"); 212 goto out; 213 } 214 215 if (valid_master_desc(*master_desc, NULL) < 0) { 216 pr_info("encrypted_key: master key parameter \'%s\' " 217 "is invalid\n", *master_desc); 218 goto out; 219 } 220 221 if (decrypted_datalen) { 222 *decrypted_datalen = strsep(&datablob, " \t"); 223 if (!*decrypted_datalen) { 224 pr_info("encrypted_key: keylen parameter is missing\n"); 225 goto out; 226 } 227 } 228 229 switch (key_cmd) { 230 case Opt_new: 231 if (!decrypted_datalen) { 232 pr_info("encrypted_key: keyword \'%s\' not allowed " 233 "when called from .update method\n", keyword); 234 break; 235 } 236 *decrypted_data = strsep(&datablob, " \t"); 237 ret = 0; 238 break; 239 case Opt_load: 240 if (!decrypted_datalen) { 241 pr_info("encrypted_key: keyword \'%s\' not allowed " 242 "when called from .update method\n", keyword); 243 break; 244 } 245 *hex_encoded_iv = strsep(&datablob, " \t"); 246 if (!*hex_encoded_iv) { 247 pr_info("encrypted_key: hex blob is missing\n"); 248 break; 249 } 250 ret = 0; 251 break; 252 case Opt_update: 253 if (decrypted_datalen) { 254 pr_info("encrypted_key: keyword \'%s\' not allowed " 255 "when called from .instantiate method\n", 256 keyword); 257 break; 258 } 259 ret = 0; 260 break; 261 case Opt_err: 262 pr_info("encrypted_key: keyword \'%s\' not recognized\n", 263 keyword); 264 break; 265 } 266 out: 267 return ret; 268 } 269 270 /* 271 * datablob_format - format as an ascii string, before copying to userspace 272 */ 273 static char *datablob_format(struct encrypted_key_payload *epayload, 274 size_t asciiblob_len) 275 { 276 char *ascii_buf, *bufp; 277 u8 *iv = epayload->iv; 278 int len; 279 int i; 280 281 ascii_buf = kmalloc(asciiblob_len + 1, GFP_KERNEL); 282 if (!ascii_buf) 283 goto out; 284 285 ascii_buf[asciiblob_len] = '\0'; 286 287 /* copy datablob master_desc and datalen strings */ 288 len = sprintf(ascii_buf, "%s %s %s ", epayload->format, 289 epayload->master_desc, epayload->datalen); 290 291 /* convert the hex encoded iv, encrypted-data and HMAC to ascii */ 292 bufp = &ascii_buf[len]; 293 for (i = 0; i < (asciiblob_len - len) / 2; i++) 294 bufp = hex_byte_pack(bufp, iv[i]); 295 out: 296 return ascii_buf; 297 } 298 299 /* 300 * request_user_key - request the user key 301 * 302 * Use a user provided key to encrypt/decrypt an encrypted-key. 303 */ 304 static struct key *request_user_key(const char *master_desc, const u8 **master_key, 305 size_t *master_keylen) 306 { 307 const struct user_key_payload *upayload; 308 struct key *ukey; 309 310 ukey = request_key(&key_type_user, master_desc, NULL); 311 if (IS_ERR(ukey)) 312 goto error; 313 314 down_read(&ukey->sem); 315 upayload = user_key_payload_locked(ukey); 316 if (!upayload) { 317 /* key was revoked before we acquired its semaphore */ 318 up_read(&ukey->sem); 319 key_put(ukey); 320 ukey = ERR_PTR(-EKEYREVOKED); 321 goto error; 322 } 323 *master_key = upayload->data; 324 *master_keylen = upayload->datalen; 325 error: 326 return ukey; 327 } 328 329 enum derived_key_type { ENC_KEY, AUTH_KEY }; 330 331 /* Derive authentication/encryption key from trusted key */ 332 static int get_derived_key(u8 *derived_key, enum derived_key_type key_type, 333 const u8 *master_key, size_t master_keylen) 334 { 335 u8 *derived_buf; 336 unsigned int derived_buf_len; 337 338 derived_buf_len = strlen("AUTH_KEY") + 1 + master_keylen; 339 if (derived_buf_len < HASH_SIZE) 340 derived_buf_len = HASH_SIZE; 341 342 derived_buf = kzalloc(derived_buf_len, GFP_KERNEL); 343 if (!derived_buf) 344 return -ENOMEM; 345 346 if (key_type) 347 strscpy(derived_buf, "AUTH_KEY", HASH_SIZE); 348 else 349 strscpy(derived_buf, "ENC_KEY", HASH_SIZE); 350 351 memcpy(derived_buf + strlen(derived_buf) + 1, master_key, 352 master_keylen); 353 sha256(derived_buf, derived_buf_len, derived_key); 354 kfree_sensitive(derived_buf); 355 return 0; 356 } 357 358 static struct skcipher_request *init_skcipher_req(const u8 *key, 359 unsigned int key_len) 360 { 361 struct skcipher_request *req; 362 struct crypto_skcipher *tfm; 363 int ret; 364 365 tfm = crypto_alloc_skcipher(blkcipher_alg, 0, CRYPTO_ALG_ASYNC); 366 if (IS_ERR(tfm)) { 367 pr_err("encrypted_key: failed to load %s transform (%ld)\n", 368 blkcipher_alg, PTR_ERR(tfm)); 369 return ERR_CAST(tfm); 370 } 371 372 ret = crypto_skcipher_setkey(tfm, key, key_len); 373 if (ret < 0) { 374 pr_err("encrypted_key: failed to setkey (%d)\n", ret); 375 crypto_free_skcipher(tfm); 376 return ERR_PTR(ret); 377 } 378 379 req = skcipher_request_alloc(tfm, GFP_KERNEL); 380 if (!req) { 381 pr_err("encrypted_key: failed to allocate request for %s\n", 382 blkcipher_alg); 383 crypto_free_skcipher(tfm); 384 return ERR_PTR(-ENOMEM); 385 } 386 387 skcipher_request_set_callback(req, 0, NULL, NULL); 388 return req; 389 } 390 391 static struct key *request_master_key(struct encrypted_key_payload *epayload, 392 const u8 **master_key, size_t *master_keylen) 393 { 394 struct key *mkey = ERR_PTR(-EINVAL); 395 396 if (!strncmp(epayload->master_desc, KEY_TRUSTED_PREFIX, 397 KEY_TRUSTED_PREFIX_LEN)) { 398 mkey = request_trusted_key(epayload->master_desc + 399 KEY_TRUSTED_PREFIX_LEN, 400 master_key, master_keylen); 401 } else if (!strncmp(epayload->master_desc, KEY_USER_PREFIX, 402 KEY_USER_PREFIX_LEN)) { 403 mkey = request_user_key(epayload->master_desc + 404 KEY_USER_PREFIX_LEN, 405 master_key, master_keylen); 406 } else 407 goto out; 408 409 if (IS_ERR(mkey)) { 410 int ret = PTR_ERR(mkey); 411 412 if (ret == -ENOTSUPP) 413 pr_info("encrypted_key: key %s not supported", 414 epayload->master_desc); 415 else 416 pr_info("encrypted_key: key %s not found", 417 epayload->master_desc); 418 goto out; 419 } 420 421 dump_master_key(*master_key, *master_keylen); 422 out: 423 return mkey; 424 } 425 426 /* Before returning data to userspace, encrypt decrypted data. */ 427 static int derived_key_encrypt(struct encrypted_key_payload *epayload, 428 const u8 *derived_key, 429 unsigned int derived_keylen) 430 { 431 struct scatterlist sg_in[2]; 432 struct scatterlist sg_out[1]; 433 struct crypto_skcipher *tfm; 434 struct skcipher_request *req; 435 unsigned int encrypted_datalen; 436 u8 iv[AES_BLOCK_SIZE]; 437 int ret; 438 439 encrypted_datalen = roundup(epayload->decrypted_datalen, blksize); 440 441 req = init_skcipher_req(derived_key, derived_keylen); 442 ret = PTR_ERR(req); 443 if (IS_ERR(req)) 444 goto out; 445 dump_decrypted_data(epayload); 446 447 sg_init_table(sg_in, 2); 448 sg_set_buf(&sg_in[0], epayload->decrypted_data, 449 epayload->decrypted_datalen); 450 sg_set_page(&sg_in[1], ZERO_PAGE(0), AES_BLOCK_SIZE, 0); 451 452 sg_init_table(sg_out, 1); 453 sg_set_buf(sg_out, epayload->encrypted_data, encrypted_datalen); 454 455 memcpy(iv, epayload->iv, sizeof(iv)); 456 skcipher_request_set_crypt(req, sg_in, sg_out, encrypted_datalen, iv); 457 ret = crypto_skcipher_encrypt(req); 458 tfm = crypto_skcipher_reqtfm(req); 459 skcipher_request_free(req); 460 crypto_free_skcipher(tfm); 461 if (ret < 0) 462 pr_err("encrypted_key: failed to encrypt (%d)\n", ret); 463 else 464 dump_encrypted_data(epayload, encrypted_datalen); 465 out: 466 return ret; 467 } 468 469 static int datablob_hmac_append(struct encrypted_key_payload *epayload, 470 const u8 *master_key, size_t master_keylen) 471 { 472 u8 derived_key[HASH_SIZE]; 473 u8 *digest; 474 int ret; 475 476 ret = get_derived_key(derived_key, AUTH_KEY, master_key, master_keylen); 477 if (ret < 0) 478 goto out; 479 480 digest = epayload->format + epayload->datablob_len; 481 hmac_sha256_usingrawkey(derived_key, sizeof(derived_key), 482 epayload->format, epayload->datablob_len, 483 digest); 484 dump_hmac(NULL, digest, HASH_SIZE); 485 out: 486 memzero_explicit(derived_key, sizeof(derived_key)); 487 return ret; 488 } 489 490 /* verify HMAC before decrypting encrypted key */ 491 static int datablob_hmac_verify(struct encrypted_key_payload *epayload, 492 const u8 *format, const u8 *master_key, 493 size_t master_keylen) 494 { 495 u8 derived_key[HASH_SIZE]; 496 u8 digest[HASH_SIZE]; 497 int ret; 498 char *p; 499 unsigned short len; 500 501 ret = get_derived_key(derived_key, AUTH_KEY, master_key, master_keylen); 502 if (ret < 0) 503 goto out; 504 505 len = epayload->datablob_len; 506 if (!format) { 507 p = epayload->master_desc; 508 len -= strlen(epayload->format) + 1; 509 } else 510 p = epayload->format; 511 512 hmac_sha256_usingrawkey(derived_key, sizeof(derived_key), p, len, 513 digest); 514 ret = crypto_memneq(digest, epayload->format + epayload->datablob_len, 515 sizeof(digest)); 516 if (ret) { 517 ret = -EINVAL; 518 dump_hmac("datablob", 519 epayload->format + epayload->datablob_len, 520 HASH_SIZE); 521 dump_hmac("calc", digest, HASH_SIZE); 522 } 523 out: 524 memzero_explicit(derived_key, sizeof(derived_key)); 525 return ret; 526 } 527 528 static int derived_key_decrypt(struct encrypted_key_payload *epayload, 529 const u8 *derived_key, 530 unsigned int derived_keylen) 531 { 532 struct scatterlist sg_in[1]; 533 struct scatterlist sg_out[2]; 534 struct crypto_skcipher *tfm; 535 struct skcipher_request *req; 536 unsigned int encrypted_datalen; 537 u8 iv[AES_BLOCK_SIZE]; 538 u8 *pad; 539 int ret; 540 541 /* Throwaway buffer to hold the unused zero padding at the end */ 542 pad = kmalloc(AES_BLOCK_SIZE, GFP_KERNEL); 543 if (!pad) 544 return -ENOMEM; 545 546 encrypted_datalen = roundup(epayload->decrypted_datalen, blksize); 547 req = init_skcipher_req(derived_key, derived_keylen); 548 ret = PTR_ERR(req); 549 if (IS_ERR(req)) 550 goto out; 551 dump_encrypted_data(epayload, encrypted_datalen); 552 553 sg_init_table(sg_in, 1); 554 sg_init_table(sg_out, 2); 555 sg_set_buf(sg_in, epayload->encrypted_data, encrypted_datalen); 556 sg_set_buf(&sg_out[0], epayload->decrypted_data, 557 epayload->decrypted_datalen); 558 sg_set_buf(&sg_out[1], pad, AES_BLOCK_SIZE); 559 560 memcpy(iv, epayload->iv, sizeof(iv)); 561 skcipher_request_set_crypt(req, sg_in, sg_out, encrypted_datalen, iv); 562 ret = crypto_skcipher_decrypt(req); 563 tfm = crypto_skcipher_reqtfm(req); 564 skcipher_request_free(req); 565 crypto_free_skcipher(tfm); 566 if (ret < 0) 567 goto out; 568 dump_decrypted_data(epayload); 569 out: 570 kfree(pad); 571 return ret; 572 } 573 574 /* Allocate memory for decrypted key and datablob. */ 575 static struct encrypted_key_payload *encrypted_key_alloc(struct key *key, 576 const char *format, 577 const char *master_desc, 578 const char *datalen, 579 const char *decrypted_data) 580 { 581 struct encrypted_key_payload *epayload = NULL; 582 unsigned short datablob_len; 583 unsigned short payload_totallen; 584 unsigned short decrypted_datalen; 585 unsigned short payload_datalen; 586 unsigned int encrypted_datalen; 587 unsigned int format_len; 588 long dlen; 589 int i; 590 int ret; 591 592 ret = kstrtol(datalen, 10, &dlen); 593 if (ret < 0 || dlen < MIN_DATA_SIZE || dlen > MAX_DATA_SIZE) 594 return ERR_PTR(-EINVAL); 595 596 format_len = (!format) ? strlen(key_format_default) : strlen(format); 597 decrypted_datalen = dlen; 598 payload_datalen = decrypted_datalen; 599 600 if (decrypted_data) { 601 if (!user_decrypted_data) { 602 pr_err("encrypted key: instantiation of keys using provided decrypted data is disabled since CONFIG_USER_DECRYPTED_DATA is set to false\n"); 603 return ERR_PTR(-EINVAL); 604 } 605 if (strlen(decrypted_data) != decrypted_datalen * 2) { 606 pr_err("encrypted key: decrypted data provided does not match decrypted data length provided\n"); 607 return ERR_PTR(-EINVAL); 608 } 609 for (i = 0; i < strlen(decrypted_data); i++) { 610 if (!isxdigit(decrypted_data[i])) { 611 pr_err("encrypted key: decrypted data provided must contain only hexadecimal characters\n"); 612 return ERR_PTR(-EINVAL); 613 } 614 } 615 } 616 617 if (format) { 618 if (!strcmp(format, key_format_ecryptfs)) { 619 if (dlen != ECRYPTFS_MAX_KEY_BYTES) { 620 pr_err("encrypted_key: keylen for the ecryptfs format must be equal to %d bytes\n", 621 ECRYPTFS_MAX_KEY_BYTES); 622 return ERR_PTR(-EINVAL); 623 } 624 decrypted_datalen = ECRYPTFS_MAX_KEY_BYTES; 625 payload_datalen = sizeof(struct ecryptfs_auth_tok); 626 } else if (!strcmp(format, key_format_enc32)) { 627 if (decrypted_datalen != KEY_ENC32_PAYLOAD_LEN) { 628 pr_err("encrypted_key: enc32 key payload incorrect length: %d\n", 629 decrypted_datalen); 630 return ERR_PTR(-EINVAL); 631 } 632 } 633 } 634 635 encrypted_datalen = roundup(decrypted_datalen, blksize); 636 637 if (check_add_overflow(format_len + 1 + strlen(master_desc) + 1 638 + strlen(datalen) + 1 + ivsize + 1, 639 encrypted_datalen, &datablob_len)) 640 return ERR_PTR(-EINVAL); 641 642 if (check_add_overflow(datablob_len, 643 payload_datalen + HASH_SIZE + 1, 644 &payload_totallen)) 645 return ERR_PTR(-EINVAL); 646 647 ret = key_payload_reserve(key, payload_totallen); 648 if (ret < 0) 649 return ERR_PTR(ret); 650 651 epayload = kzalloc_flex(*epayload, payload_data, payload_totallen); 652 if (!epayload) 653 return ERR_PTR(-ENOMEM); 654 655 epayload->payload_datalen = payload_datalen; 656 epayload->decrypted_datalen = decrypted_datalen; 657 epayload->datablob_len = datablob_len; 658 return epayload; 659 } 660 661 static int encrypted_key_decrypt(struct encrypted_key_payload *epayload, 662 const char *format, const char *hex_encoded_iv) 663 { 664 struct key *mkey; 665 u8 derived_key[HASH_SIZE]; 666 const u8 *master_key; 667 u8 *hmac; 668 const char *hex_encoded_data; 669 unsigned int encrypted_datalen; 670 size_t master_keylen; 671 size_t asciilen; 672 int ret; 673 674 encrypted_datalen = roundup(epayload->decrypted_datalen, blksize); 675 asciilen = (ivsize + 1 + encrypted_datalen + HASH_SIZE) * 2; 676 if (strlen(hex_encoded_iv) != asciilen) 677 return -EINVAL; 678 679 hex_encoded_data = hex_encoded_iv + (2 * ivsize) + 2; 680 ret = hex2bin(epayload->iv, hex_encoded_iv, ivsize); 681 if (ret < 0) 682 return -EINVAL; 683 ret = hex2bin(epayload->encrypted_data, hex_encoded_data, 684 encrypted_datalen); 685 if (ret < 0) 686 return -EINVAL; 687 688 hmac = epayload->format + epayload->datablob_len; 689 ret = hex2bin(hmac, hex_encoded_data + (encrypted_datalen * 2), 690 HASH_SIZE); 691 if (ret < 0) 692 return -EINVAL; 693 694 mkey = request_master_key(epayload, &master_key, &master_keylen); 695 if (IS_ERR(mkey)) 696 return PTR_ERR(mkey); 697 698 ret = datablob_hmac_verify(epayload, format, master_key, master_keylen); 699 if (ret < 0) { 700 pr_err("encrypted_key: bad hmac (%d)\n", ret); 701 goto out; 702 } 703 704 ret = get_derived_key(derived_key, ENC_KEY, master_key, master_keylen); 705 if (ret < 0) 706 goto out; 707 708 ret = derived_key_decrypt(epayload, derived_key, sizeof derived_key); 709 if (ret < 0) 710 pr_err("encrypted_key: failed to decrypt key (%d)\n", ret); 711 out: 712 up_read(&mkey->sem); 713 key_put(mkey); 714 memzero_explicit(derived_key, sizeof(derived_key)); 715 return ret; 716 } 717 718 static void __ekey_init(struct encrypted_key_payload *epayload, 719 const char *format, const char *master_desc, 720 const char *datalen) 721 { 722 unsigned int format_len; 723 724 format_len = (!format) ? strlen(key_format_default) : strlen(format); 725 epayload->format = epayload->payload_data + epayload->payload_datalen; 726 epayload->master_desc = epayload->format + format_len + 1; 727 epayload->datalen = epayload->master_desc + strlen(master_desc) + 1; 728 epayload->iv = epayload->datalen + strlen(datalen) + 1; 729 epayload->encrypted_data = epayload->iv + ivsize + 1; 730 epayload->decrypted_data = epayload->payload_data; 731 732 if (!format) 733 memcpy(epayload->format, key_format_default, format_len); 734 else { 735 if (!strcmp(format, key_format_ecryptfs)) 736 epayload->decrypted_data = 737 ecryptfs_get_auth_tok_key((struct ecryptfs_auth_tok *)epayload->payload_data); 738 739 memcpy(epayload->format, format, format_len); 740 } 741 742 memcpy(epayload->master_desc, master_desc, strlen(master_desc)); 743 memcpy(epayload->datalen, datalen, strlen(datalen)); 744 } 745 746 /* 747 * encrypted_init - initialize an encrypted key 748 * 749 * For a new key, use either a random number or user-provided decrypted data in 750 * case it is provided. A random number is used for the iv in both cases. For 751 * an old key, decrypt the hex encoded data. 752 */ 753 static int encrypted_init(struct encrypted_key_payload *epayload, 754 const char *key_desc, const char *format, 755 const char *master_desc, const char *datalen, 756 const char *hex_encoded_iv, const char *decrypted_data) 757 { 758 int ret = 0; 759 760 if (format && !strcmp(format, key_format_ecryptfs)) { 761 ret = valid_ecryptfs_desc(key_desc); 762 if (ret < 0) 763 return ret; 764 765 ecryptfs_fill_auth_tok((struct ecryptfs_auth_tok *)epayload->payload_data, 766 key_desc); 767 } 768 769 __ekey_init(epayload, format, master_desc, datalen); 770 if (hex_encoded_iv) { 771 ret = encrypted_key_decrypt(epayload, format, hex_encoded_iv); 772 } else if (decrypted_data) { 773 get_random_bytes(epayload->iv, ivsize); 774 ret = hex2bin(epayload->decrypted_data, decrypted_data, 775 epayload->decrypted_datalen); 776 } else { 777 get_random_bytes(epayload->iv, ivsize); 778 get_random_bytes(epayload->decrypted_data, epayload->decrypted_datalen); 779 } 780 return ret; 781 } 782 783 /* 784 * encrypted_instantiate - instantiate an encrypted key 785 * 786 * Instantiates the key: 787 * - by decrypting an existing encrypted datablob, or 788 * - by creating a new encrypted key based on a kernel random number, or 789 * - using provided decrypted data. 790 * 791 * On success, return 0. Otherwise return errno. 792 */ 793 static int encrypted_instantiate(struct key *key, 794 struct key_preparsed_payload *prep) 795 { 796 struct encrypted_key_payload *epayload = NULL; 797 char *datablob = NULL; 798 const char *format = NULL; 799 char *master_desc = NULL; 800 char *decrypted_datalen = NULL; 801 char *hex_encoded_iv = NULL; 802 char *decrypted_data = NULL; 803 size_t datalen = prep->datalen; 804 int ret; 805 806 if (datalen == 0 || datalen > 32767 || !prep->data) 807 return -EINVAL; 808 809 datablob = kmalloc(datalen + 1, GFP_KERNEL); 810 if (!datablob) 811 return -ENOMEM; 812 datablob[datalen] = 0; 813 memcpy(datablob, prep->data, datalen); 814 ret = datablob_parse(datablob, &format, &master_desc, 815 &decrypted_datalen, &hex_encoded_iv, &decrypted_data); 816 if (ret < 0) 817 goto out; 818 819 epayload = encrypted_key_alloc(key, format, master_desc, 820 decrypted_datalen, decrypted_data); 821 if (IS_ERR(epayload)) { 822 ret = PTR_ERR(epayload); 823 goto out; 824 } 825 ret = encrypted_init(epayload, key->description, format, master_desc, 826 decrypted_datalen, hex_encoded_iv, decrypted_data); 827 if (ret < 0) { 828 kfree_sensitive(epayload); 829 goto out; 830 } 831 832 rcu_assign_keypointer(key, epayload); 833 out: 834 kfree_sensitive(datablob); 835 return ret; 836 } 837 838 static void encrypted_rcu_free(struct rcu_head *rcu) 839 { 840 struct encrypted_key_payload *epayload; 841 842 epayload = container_of(rcu, struct encrypted_key_payload, rcu); 843 kfree_sensitive(epayload); 844 } 845 846 /* 847 * encrypted_update - update the master key description 848 * 849 * Change the master key description for an existing encrypted key. 850 * The next read will return an encrypted datablob using the new 851 * master key description. 852 * 853 * On success, return 0. Otherwise return errno. 854 */ 855 static int encrypted_update(struct key *key, struct key_preparsed_payload *prep) 856 { 857 struct encrypted_key_payload *epayload = key->payload.data[0]; 858 struct encrypted_key_payload *new_epayload; 859 char *buf; 860 char *new_master_desc = NULL; 861 const char *format = NULL; 862 size_t datalen = prep->datalen; 863 int ret = 0; 864 865 if (key_is_negative(key)) 866 return -ENOKEY; 867 if (datalen == 0 || datalen > 32767 || !prep->data) 868 return -EINVAL; 869 870 buf = kmalloc(datalen + 1, GFP_KERNEL); 871 if (!buf) 872 return -ENOMEM; 873 874 buf[datalen] = 0; 875 memcpy(buf, prep->data, datalen); 876 ret = datablob_parse(buf, &format, &new_master_desc, NULL, NULL, NULL); 877 if (ret < 0) 878 goto out; 879 880 ret = valid_master_desc(new_master_desc, epayload->master_desc); 881 if (ret < 0) 882 goto out; 883 884 new_epayload = encrypted_key_alloc(key, epayload->format, 885 new_master_desc, epayload->datalen, NULL); 886 if (IS_ERR(new_epayload)) { 887 ret = PTR_ERR(new_epayload); 888 goto out; 889 } 890 891 __ekey_init(new_epayload, epayload->format, new_master_desc, 892 epayload->datalen); 893 894 memcpy(new_epayload->iv, epayload->iv, ivsize); 895 memcpy(new_epayload->payload_data, epayload->payload_data, 896 epayload->payload_datalen); 897 898 rcu_assign_keypointer(key, new_epayload); 899 call_rcu(&epayload->rcu, encrypted_rcu_free); 900 out: 901 kfree_sensitive(buf); 902 return ret; 903 } 904 905 /* 906 * encrypted_read - format and copy out the encrypted data 907 * 908 * The resulting datablob format is: 909 * <master-key name> <decrypted data length> <encrypted iv> <encrypted data> 910 * 911 * On success, return to userspace the encrypted key datablob size. 912 */ 913 static long encrypted_read(const struct key *key, char *buffer, 914 size_t buflen) 915 { 916 struct encrypted_key_payload *epayload; 917 struct key *mkey; 918 const u8 *master_key; 919 size_t master_keylen; 920 char derived_key[HASH_SIZE]; 921 char *ascii_buf; 922 size_t asciiblob_len; 923 int ret; 924 925 epayload = dereference_key_locked(key); 926 927 /* returns the hex encoded iv, encrypted-data, and hmac as ascii */ 928 asciiblob_len = epayload->datablob_len + ivsize + 1 929 + roundup(epayload->decrypted_datalen, blksize) 930 + (HASH_SIZE * 2); 931 932 if (!buffer || buflen < asciiblob_len) 933 return asciiblob_len; 934 935 mkey = request_master_key(epayload, &master_key, &master_keylen); 936 if (IS_ERR(mkey)) 937 return PTR_ERR(mkey); 938 939 ret = get_derived_key(derived_key, ENC_KEY, master_key, master_keylen); 940 if (ret < 0) 941 goto out; 942 943 ret = derived_key_encrypt(epayload, derived_key, sizeof derived_key); 944 if (ret < 0) 945 goto out; 946 947 ret = datablob_hmac_append(epayload, master_key, master_keylen); 948 if (ret < 0) 949 goto out; 950 951 ascii_buf = datablob_format(epayload, asciiblob_len); 952 if (!ascii_buf) { 953 ret = -ENOMEM; 954 goto out; 955 } 956 957 up_read(&mkey->sem); 958 key_put(mkey); 959 memzero_explicit(derived_key, sizeof(derived_key)); 960 961 memcpy(buffer, ascii_buf, asciiblob_len); 962 kfree_sensitive(ascii_buf); 963 964 return asciiblob_len; 965 out: 966 up_read(&mkey->sem); 967 key_put(mkey); 968 memzero_explicit(derived_key, sizeof(derived_key)); 969 return ret; 970 } 971 972 /* 973 * encrypted_destroy - clear and free the key's payload 974 */ 975 static void encrypted_destroy(struct key *key) 976 { 977 kfree_sensitive(key->payload.data[0]); 978 } 979 980 struct key_type key_type_encrypted = { 981 .name = "encrypted", 982 .instantiate = encrypted_instantiate, 983 .update = encrypted_update, 984 .destroy = encrypted_destroy, 985 .describe = user_describe, 986 .read = encrypted_read, 987 }; 988 EXPORT_SYMBOL_GPL(key_type_encrypted); 989 990 static int __init init_encrypted(void) 991 { 992 int ret; 993 994 ret = aes_get_sizes(); 995 if (ret < 0) 996 return ret; 997 return register_key_type(&key_type_encrypted); 998 } 999 1000 static void __exit cleanup_encrypted(void) 1001 { 1002 unregister_key_type(&key_type_encrypted); 1003 } 1004 1005 late_initcall(init_encrypted); 1006 module_exit(cleanup_encrypted); 1007 1008 MODULE_DESCRIPTION("Encrypted key type"); 1009 MODULE_LICENSE("GPL"); 1010