security/keys/encrypted-keys/encrypted.c

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