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