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_locked(ukey);
 318         *master_key = upayload->data;
 319         *master_keylen = upayload->datalen;
 320 error:
 321         return ukey;
 322 }
 323
 324 static struct sdesc *alloc_sdesc(struct crypto_shash *alg)
 325 {
 326         struct sdesc *sdesc;
 327         int size;
 328
 329         size = sizeof(struct shash_desc) + crypto_shash_descsize(alg);
 330         sdesc = kmalloc(size, GFP_KERNEL);
 331         if (!sdesc)
 332                 return ERR_PTR(-ENOMEM);
 333         sdesc->shash.tfm = alg;
 334         sdesc->shash.flags = 0x0;
 335         return sdesc;
 336 }
 337
 338 static int calc_hmac(u8 *digest, const u8 *key, unsigned int keylen,
 339                      const u8 *buf, unsigned int buflen)
 340 {
 341         struct sdesc *sdesc;
 342         int ret;
 343
 344         sdesc = alloc_sdesc(hmacalg);
 345         if (IS_ERR(sdesc)) {
 346                 pr_info("encrypted_key: can't alloc %s\n", hmac_alg);
 347                 return PTR_ERR(sdesc);
 348         }
 349
 350         ret = crypto_shash_setkey(hmacalg, key, keylen);
 351         if (!ret)
 352                 ret = crypto_shash_digest(&sdesc->shash, buf, buflen, digest);
 353         kfree(sdesc);
 354         return ret;
 355 }
 356
 357 static int calc_hash(u8 *digest, const u8 *buf, unsigned int buflen)
 358 {
 359         struct sdesc *sdesc;
 360         int ret;
 361
 362         sdesc = alloc_sdesc(hashalg);
 363         if (IS_ERR(sdesc)) {
 364                 pr_info("encrypted_key: can't alloc %s\n", hash_alg);
 365                 return PTR_ERR(sdesc);
 366         }
 367
 368         ret = crypto_shash_digest(&sdesc->shash, buf, buflen, digest);
 369         kfree(sdesc);
 370         return ret;
 371 }
 372
 373 enum derived_key_type { ENC_KEY, AUTH_KEY };
 374
 375 /* Derive authentication/encryption key from trusted key */
 376 static int get_derived_key(u8 *derived_key, enum derived_key_type key_type,
 377                            const u8 *master_key, size_t master_keylen)
 378 {
 379         u8 *derived_buf;
 380         unsigned int derived_buf_len;
 381         int ret;
 382
 383         derived_buf_len = strlen("AUTH_KEY") + 1 + master_keylen;
 384         if (derived_buf_len < HASH_SIZE)
 385                 derived_buf_len = HASH_SIZE;
 386
 387         derived_buf = kzalloc(derived_buf_len, GFP_KERNEL);
 388         if (!derived_buf)
 389                 return -ENOMEM;
 390
 391         if (key_type)
 392                 strcpy(derived_buf, "AUTH_KEY");
 393         else
 394                 strcpy(derived_buf, "ENC_KEY");
 395
 396         memcpy(derived_buf + strlen(derived_buf) + 1, master_key,
 397                master_keylen);
 398         ret = calc_hash(derived_key, derived_buf, derived_buf_len);
 399         kfree(derived_buf);
 400         return ret;
 401 }
 402
 403 static struct skcipher_request *init_skcipher_req(const u8 *key,
 404                                                   unsigned int key_len)
 405 {
 406         struct skcipher_request *req;
 407         struct crypto_skcipher *tfm;
 408         int ret;
 409
 410         tfm = crypto_alloc_skcipher(blkcipher_alg, 0, CRYPTO_ALG_ASYNC);
 411         if (IS_ERR(tfm)) {
 412                 pr_err("encrypted_key: failed to load %s transform (%ld)\n",
 413                        blkcipher_alg, PTR_ERR(tfm));
 414                 return ERR_CAST(tfm);
 415         }
 416
 417         ret = crypto_skcipher_setkey(tfm, key, key_len);
 418         if (ret < 0) {
 419                 pr_err("encrypted_key: failed to setkey (%d)\n", ret);
 420                 crypto_free_skcipher(tfm);
 421                 return ERR_PTR(ret);
 422         }
 423
 424         req = skcipher_request_alloc(tfm, GFP_KERNEL);
 425         if (!req) {
 426                 pr_err("encrypted_key: failed to allocate request for %s\n",
 427                        blkcipher_alg);
 428                 crypto_free_skcipher(tfm);
 429                 return ERR_PTR(-ENOMEM);
 430         }
 431
 432         skcipher_request_set_callback(req, 0, NULL, NULL);
 433         return req;
 434 }
 435
 436 static struct key *request_master_key(struct encrypted_key_payload *epayload,
 437                                       const u8 **master_key, size_t *master_keylen)
 438 {
 439         struct key *mkey = ERR_PTR(-EINVAL);
 440
 441         if (!strncmp(epayload->master_desc, KEY_TRUSTED_PREFIX,
 442                      KEY_TRUSTED_PREFIX_LEN)) {
 443                 mkey = request_trusted_key(epayload->master_desc +
 444                                            KEY_TRUSTED_PREFIX_LEN,
 445                                            master_key, master_keylen);
 446         } else if (!strncmp(epayload->master_desc, KEY_USER_PREFIX,
 447                             KEY_USER_PREFIX_LEN)) {
 448                 mkey = request_user_key(epayload->master_desc +
 449                                         KEY_USER_PREFIX_LEN,
 450                                         master_key, master_keylen);
 451         } else
 452                 goto out;
 453
 454         if (IS_ERR(mkey)) {
 455                 int ret = PTR_ERR(mkey);
 456
 457                 if (ret == -ENOTSUPP)
 458                         pr_info("encrypted_key: key %s not supported",
 459                                 epayload->master_desc);
 460                 else
 461                         pr_info("encrypted_key: key %s not found",
 462                                 epayload->master_desc);
 463                 goto out;
 464         }
 465
 466         dump_master_key(*master_key, *master_keylen);
 467 out:
 468         return mkey;
 469 }
 470
 471 /* Before returning data to userspace, encrypt decrypted data. */
 472 static int derived_key_encrypt(struct encrypted_key_payload *epayload,
 473                                const u8 *derived_key,
 474                                unsigned int derived_keylen)
 475 {
 476         struct scatterlist sg_in[2];
 477         struct scatterlist sg_out[1];
 478         struct crypto_skcipher *tfm;
 479         struct skcipher_request *req;
 480         unsigned int encrypted_datalen;
 481         u8 iv[AES_BLOCK_SIZE];
 482         unsigned int padlen;
 483         char pad[16];
 484         int ret;
 485
 486         encrypted_datalen = roundup(epayload->decrypted_datalen, blksize);
 487         padlen = encrypted_datalen - epayload->decrypted_datalen;
 488
 489         req = init_skcipher_req(derived_key, derived_keylen);
 490         ret = PTR_ERR(req);
 491         if (IS_ERR(req))
 492                 goto out;
 493         dump_decrypted_data(epayload);
 494
 495         memset(pad, 0, sizeof pad);
 496         sg_init_table(sg_in, 2);
 497         sg_set_buf(&sg_in[0], epayload->decrypted_data,
 498                    epayload->decrypted_datalen);
 499         sg_set_buf(&sg_in[1], pad, padlen);
 500
 501         sg_init_table(sg_out, 1);
 502         sg_set_buf(sg_out, epayload->encrypted_data, encrypted_datalen);
 503
 504         memcpy(iv, epayload->iv, sizeof(iv));
 505         skcipher_request_set_crypt(req, sg_in, sg_out, encrypted_datalen, iv);
 506         ret = crypto_skcipher_encrypt(req);
 507         tfm = crypto_skcipher_reqtfm(req);
 508         skcipher_request_free(req);
 509         crypto_free_skcipher(tfm);
 510         if (ret < 0)
 511                 pr_err("encrypted_key: failed to encrypt (%d)\n", ret);
 512         else
 513                 dump_encrypted_data(epayload, encrypted_datalen);
 514 out:
 515         return ret;
 516 }
 517
 518 static int datablob_hmac_append(struct encrypted_key_payload *epayload,
 519                                 const u8 *master_key, size_t master_keylen)
 520 {
 521         u8 derived_key[HASH_SIZE];
 522         u8 *digest;
 523         int ret;
 524
 525         ret = get_derived_key(derived_key, AUTH_KEY, master_key, master_keylen);
 526         if (ret < 0)
 527                 goto out;
 528
 529         digest = epayload->format + epayload->datablob_len;
 530         ret = calc_hmac(digest, derived_key, sizeof derived_key,
 531                         epayload->format, epayload->datablob_len);
 532         if (!ret)
 533                 dump_hmac(NULL, digest, HASH_SIZE);
 534 out:
 535         return ret;
 536 }
 537
 538 /* verify HMAC before decrypting encrypted key */
 539 static int datablob_hmac_verify(struct encrypted_key_payload *epayload,
 540                                 const u8 *format, const u8 *master_key,
 541                                 size_t master_keylen)
 542 {
 543         u8 derived_key[HASH_SIZE];
 544         u8 digest[HASH_SIZE];
 545         int ret;
 546         char *p;
 547         unsigned short len;
 548
 549         ret = get_derived_key(derived_key, AUTH_KEY, master_key, master_keylen);
 550         if (ret < 0)
 551                 goto out;
 552
 553         len = epayload->datablob_len;
 554         if (!format) {
 555                 p = epayload->master_desc;
 556                 len -= strlen(epayload->format) + 1;
 557         } else
 558                 p = epayload->format;
 559
 560         ret = calc_hmac(digest, derived_key, sizeof derived_key, p, len);
 561         if (ret < 0)
 562                 goto out;
 563         ret = memcmp(digest, epayload->format + epayload->datablob_len,
 564                      sizeof digest);
 565         if (ret) {
 566                 ret = -EINVAL;
 567                 dump_hmac("datablob",
 568                           epayload->format + epayload->datablob_len,
 569                           HASH_SIZE);
 570                 dump_hmac("calc", digest, HASH_SIZE);
 571         }
 572 out:
 573         return ret;
 574 }
 575
 576 static int derived_key_decrypt(struct encrypted_key_payload *epayload,
 577                                const u8 *derived_key,
 578                                unsigned int derived_keylen)
 579 {
 580         struct scatterlist sg_in[1];
 581         struct scatterlist sg_out[2];
 582         struct crypto_skcipher *tfm;
 583         struct skcipher_request *req;
 584         unsigned int encrypted_datalen;
 585         u8 iv[AES_BLOCK_SIZE];
 586         char pad[16];
 587         int ret;
 588
 589         encrypted_datalen = roundup(epayload->decrypted_datalen, blksize);
 590         req = init_skcipher_req(derived_key, derived_keylen);
 591         ret = PTR_ERR(req);
 592         if (IS_ERR(req))
 593                 goto out;
 594         dump_encrypted_data(epayload, encrypted_datalen);
 595
 596         memset(pad, 0, sizeof pad);
 597         sg_init_table(sg_in, 1);
 598         sg_init_table(sg_out, 2);
 599         sg_set_buf(sg_in, epayload->encrypted_data, encrypted_datalen);
 600         sg_set_buf(&sg_out[0], epayload->decrypted_data,
 601                    epayload->decrypted_datalen);
 602         sg_set_buf(&sg_out[1], pad, sizeof pad);
 603
 604         memcpy(iv, epayload->iv, sizeof(iv));
 605         skcipher_request_set_crypt(req, sg_in, sg_out, encrypted_datalen, iv);
 606         ret = crypto_skcipher_decrypt(req);
 607         tfm = crypto_skcipher_reqtfm(req);
 608         skcipher_request_free(req);
 609         crypto_free_skcipher(tfm);
 610         if (ret < 0)
 611                 goto out;
 612         dump_decrypted_data(epayload);
 613 out:
 614         return ret;
 615 }
 616
 617 /* Allocate memory for decrypted key and datablob. */
 618 static struct encrypted_key_payload *encrypted_key_alloc(struct key *key,
 619                                                          const char *format,
 620                                                          const char *master_desc,
 621                                                          const char *datalen)
 622 {
 623         struct encrypted_key_payload *epayload = NULL;
 624         unsigned short datablob_len;
 625         unsigned short decrypted_datalen;
 626         unsigned short payload_datalen;
 627         unsigned int encrypted_datalen;
 628         unsigned int format_len;
 629         long dlen;
 630         int ret;
 631
 632         ret = kstrtol(datalen, 10, &dlen);
 633         if (ret < 0 || dlen < MIN_DATA_SIZE || dlen > MAX_DATA_SIZE)
 634                 return ERR_PTR(-EINVAL);
 635
 636         format_len = (!format) ? strlen(key_format_default) : strlen(format);
 637         decrypted_datalen = dlen;
 638         payload_datalen = decrypted_datalen;
 639         if (format && !strcmp(format, key_format_ecryptfs)) {
 640                 if (dlen != ECRYPTFS_MAX_KEY_BYTES) {
 641                         pr_err("encrypted_key: keylen for the ecryptfs format "
 642                                "must be equal to %d bytes\n",
 643                                ECRYPTFS_MAX_KEY_BYTES);
 644                         return ERR_PTR(-EINVAL);
 645                 }
 646                 decrypted_datalen = ECRYPTFS_MAX_KEY_BYTES;
 647                 payload_datalen = sizeof(struct ecryptfs_auth_tok);
 648         }
 649
 650         encrypted_datalen = roundup(decrypted_datalen, blksize);
 651
 652         datablob_len = format_len + 1 + strlen(master_desc) + 1
 653             + strlen(datalen) + 1 + ivsize + 1 + encrypted_datalen;
 654
 655         ret = key_payload_reserve(key, payload_datalen + datablob_len
 656                                   + HASH_SIZE + 1);
 657         if (ret < 0)
 658                 return ERR_PTR(ret);
 659
 660         epayload = kzalloc(sizeof(*epayload) + payload_datalen +
 661                            datablob_len + HASH_SIZE + 1, GFP_KERNEL);
 662         if (!epayload)
 663                 return ERR_PTR(-ENOMEM);
 664
 665         epayload->payload_datalen = payload_datalen;
 666         epayload->decrypted_datalen = decrypted_datalen;
 667         epayload->datablob_len = datablob_len;
 668         return epayload;
 669 }
 670
 671 static int encrypted_key_decrypt(struct encrypted_key_payload *epayload,
 672                                  const char *format, const char *hex_encoded_iv)
 673 {
 674         struct key *mkey;
 675         u8 derived_key[HASH_SIZE];
 676         const u8 *master_key;
 677         u8 *hmac;
 678         const char *hex_encoded_data;
 679         unsigned int encrypted_datalen;
 680         size_t master_keylen;
 681         size_t asciilen;
 682         int ret;
 683
 684         encrypted_datalen = roundup(epayload->decrypted_datalen, blksize);
 685         asciilen = (ivsize + 1 + encrypted_datalen + HASH_SIZE) * 2;
 686         if (strlen(hex_encoded_iv) != asciilen)
 687                 return -EINVAL;
 688
 689         hex_encoded_data = hex_encoded_iv + (2 * ivsize) + 2;
 690         ret = hex2bin(epayload->iv, hex_encoded_iv, ivsize);
 691         if (ret < 0)
 692                 return -EINVAL;
 693         ret = hex2bin(epayload->encrypted_data, hex_encoded_data,
 694                       encrypted_datalen);
 695         if (ret < 0)
 696                 return -EINVAL;
 697
 698         hmac = epayload->format + epayload->datablob_len;
 699         ret = hex2bin(hmac, hex_encoded_data + (encrypted_datalen * 2),
 700                       HASH_SIZE);
 701         if (ret < 0)
 702                 return -EINVAL;
 703
 704         mkey = request_master_key(epayload, &master_key, &master_keylen);
 705         if (IS_ERR(mkey))
 706                 return PTR_ERR(mkey);
 707
 708         ret = datablob_hmac_verify(epayload, format, master_key, master_keylen);
 709         if (ret < 0) {
 710                 pr_err("encrypted_key: bad hmac (%d)\n", ret);
 711                 goto out;
 712         }
 713
 714         ret = get_derived_key(derived_key, ENC_KEY, master_key, master_keylen);
 715         if (ret < 0)
 716                 goto out;
 717
 718         ret = derived_key_decrypt(epayload, derived_key, sizeof derived_key);
 719         if (ret < 0)
 720                 pr_err("encrypted_key: failed to decrypt key (%d)\n", ret);
 721 out:
 722         up_read(&mkey->sem);
 723         key_put(mkey);
 724         return ret;
 725 }
 726
 727 static void __ekey_init(struct encrypted_key_payload *epayload,
 728                         const char *format, const char *master_desc,
 729                         const char *datalen)
 730 {
 731         unsigned int format_len;
 732
 733         format_len = (!format) ? strlen(key_format_default) : strlen(format);
 734         epayload->format = epayload->payload_data + epayload->payload_datalen;
 735         epayload->master_desc = epayload->format + format_len + 1;
 736         epayload->datalen = epayload->master_desc + strlen(master_desc) + 1;
 737         epayload->iv = epayload->datalen + strlen(datalen) + 1;
 738         epayload->encrypted_data = epayload->iv + ivsize + 1;
 739         epayload->decrypted_data = epayload->payload_data;
 740
 741         if (!format)
 742                 memcpy(epayload->format, key_format_default, format_len);
 743         else {
 744                 if (!strcmp(format, key_format_ecryptfs))
 745                         epayload->decrypted_data =
 746                                 ecryptfs_get_auth_tok_key((struct ecryptfs_auth_tok *)epayload->payload_data);
 747
 748                 memcpy(epayload->format, format, format_len);
 749         }
 750
 751         memcpy(epayload->master_desc, master_desc, strlen(master_desc));
 752         memcpy(epayload->datalen, datalen, strlen(datalen));
 753 }
 754
 755 /*
 756  * encrypted_init - initialize an encrypted key
 757  *
 758  * For a new key, use a random number for both the iv and data
 759  * itself.  For an old key, decrypt the hex encoded data.
 760  */
 761 static int encrypted_init(struct encrypted_key_payload *epayload,
 762                           const char *key_desc, const char *format,
 763                           const char *master_desc, const char *datalen,
 764                           const char *hex_encoded_iv)
 765 {
 766         int ret = 0;
 767
 768         if (format && !strcmp(format, key_format_ecryptfs)) {
 769                 ret = valid_ecryptfs_desc(key_desc);
 770                 if (ret < 0)
 771                         return ret;
 772
 773                 ecryptfs_fill_auth_tok((struct ecryptfs_auth_tok *)epayload->payload_data,
 774                                        key_desc);
 775         }
 776
 777         __ekey_init(epayload, format, master_desc, datalen);
 778         if (!hex_encoded_iv) {
 779                 get_random_bytes(epayload->iv, ivsize);
 780
 781                 get_random_bytes(epayload->decrypted_data,
 782                                  epayload->decrypted_datalen);
 783         } else
 784                 ret = encrypted_key_decrypt(epayload, format, hex_encoded_iv);
 785         return ret;
 786 }
 787
 788 /*
 789  * encrypted_instantiate - instantiate an encrypted key
 790  *
 791  * Decrypt an existing encrypted datablob or create a new encrypted key
 792  * based on a kernel random number.
 793  *
 794  * On success, return 0. Otherwise return errno.
 795  */
 796 static int encrypted_instantiate(struct key *key,
 797                                  struct key_preparsed_payload *prep)
 798 {
 799         struct encrypted_key_payload *epayload = NULL;
 800         char *datablob = NULL;
 801         const char *format = NULL;
 802         char *master_desc = NULL;
 803         char *decrypted_datalen = NULL;
 804         char *hex_encoded_iv = NULL;
 805         size_t datalen = prep->datalen;
 806         int ret;
 807
 808         if (datalen <= 0 || datalen > 32767 || !prep->data)
 809                 return -EINVAL;
 810
 811         datablob = kmalloc(datalen + 1, GFP_KERNEL);
 812         if (!datablob)
 813                 return -ENOMEM;
 814         datablob[datalen] = 0;
 815         memcpy(datablob, prep->data, datalen);
 816         ret = datablob_parse(datablob, &format, &master_desc,
 817                              &decrypted_datalen, &hex_encoded_iv);
 818         if (ret < 0)
 819                 goto out;
 820
 821         epayload = encrypted_key_alloc(key, format, master_desc,
 822                                        decrypted_datalen);
 823         if (IS_ERR(epayload)) {
 824                 ret = PTR_ERR(epayload);
 825                 goto out;
 826         }
 827         ret = encrypted_init(epayload, key->description, format, master_desc,
 828                              decrypted_datalen, hex_encoded_iv);
 829         if (ret < 0) {
 830                 kfree(epayload);
 831                 goto out;
 832         }
 833
 834         rcu_assign_keypointer(key, epayload);
 835 out:
 836         kfree(datablob);
 837         return ret;
 838 }
 839
 840 static void encrypted_rcu_free(struct rcu_head *rcu)
 841 {
 842         struct encrypted_key_payload *epayload;
 843
 844         epayload = container_of(rcu, struct encrypted_key_payload, rcu);
 845         memset(epayload->decrypted_data, 0, epayload->decrypted_datalen);
 846         kfree(epayload);
 847 }
 848
 849 /*
 850  * encrypted_update - update the master key description
 851  *
 852  * Change the master key description for an existing encrypted key.
 853  * The next read will return an encrypted datablob using the new
 854  * master key description.
 855  *
 856  * On success, return 0. Otherwise return errno.
 857  */
 858 static int encrypted_update(struct key *key, struct key_preparsed_payload *prep)
 859 {
 860         struct encrypted_key_payload *epayload = key->payload.data[0];
 861         struct encrypted_key_payload *new_epayload;
 862         char *buf;
 863         char *new_master_desc = NULL;
 864         const char *format = NULL;
 865         size_t datalen = prep->datalen;
 866         int ret = 0;
 867
 868         if (test_bit(KEY_FLAG_NEGATIVE, &key->flags))
 869                 return -ENOKEY;
 870         if (datalen <= 0 || datalen > 32767 || !prep->data)
 871                 return -EINVAL;
 872
 873         buf = kmalloc(datalen + 1, GFP_KERNEL);
 874         if (!buf)
 875                 return -ENOMEM;
 876
 877         buf[datalen] = 0;
 878         memcpy(buf, prep->data, datalen);
 879         ret = datablob_parse(buf, &format, &new_master_desc, NULL, NULL);
 880         if (ret < 0)
 881                 goto out;
 882
 883         ret = valid_master_desc(new_master_desc, epayload->master_desc);
 884         if (ret < 0)
 885                 goto out;
 886
 887         new_epayload = encrypted_key_alloc(key, epayload->format,
 888                                            new_master_desc, epayload->datalen);
 889         if (IS_ERR(new_epayload)) {
 890                 ret = PTR_ERR(new_epayload);
 891                 goto out;
 892         }
 893
 894         __ekey_init(new_epayload, epayload->format, new_master_desc,
 895                     epayload->datalen);
 896
 897         memcpy(new_epayload->iv, epayload->iv, ivsize);
 898         memcpy(new_epayload->payload_data, epayload->payload_data,
 899                epayload->payload_datalen);
 900
 901         rcu_assign_keypointer(key, new_epayload);
 902         call_rcu(&epayload->rcu, encrypted_rcu_free);
 903 out:
 904         kfree(buf);
 905         return ret;
 906 }
 907
 908 /*
 909  * encrypted_read - format and copy the encrypted data to userspace
 910  *
 911  * The resulting datablob format is:
 912  * <master-key name> <decrypted data length> <encrypted iv> <encrypted data>
 913  *
 914  * On success, return to userspace the encrypted key datablob size.
 915  */
 916 static long encrypted_read(const struct key *key, char __user *buffer,
 917                            size_t buflen)
 918 {
 919         struct encrypted_key_payload *epayload;
 920         struct key *mkey;
 921         const u8 *master_key;
 922         size_t master_keylen;
 923         char derived_key[HASH_SIZE];
 924         char *ascii_buf;
 925         size_t asciiblob_len;
 926         int ret;
 927
 928         epayload = dereference_key_locked(key);
 929
 930         /* returns the hex encoded iv, encrypted-data, and hmac as ascii */
 931         asciiblob_len = epayload->datablob_len + ivsize + 1
 932             + roundup(epayload->decrypted_datalen, blksize)
 933             + (HASH_SIZE * 2);
 934
 935         if (!buffer || buflen < asciiblob_len)
 936                 return asciiblob_len;
 937
 938         mkey = request_master_key(epayload, &master_key, &master_keylen);
 939         if (IS_ERR(mkey))
 940                 return PTR_ERR(mkey);
 941
 942         ret = get_derived_key(derived_key, ENC_KEY, master_key, master_keylen);
 943         if (ret < 0)
 944                 goto out;
 945
 946         ret = derived_key_encrypt(epayload, derived_key, sizeof derived_key);
 947         if (ret < 0)
 948                 goto out;
 949
 950         ret = datablob_hmac_append(epayload, master_key, master_keylen);
 951         if (ret < 0)
 952                 goto out;
 953
 954         ascii_buf = datablob_format(epayload, asciiblob_len);
 955         if (!ascii_buf) {
 956                 ret = -ENOMEM;
 957                 goto out;
 958         }
 959
 960         up_read(&mkey->sem);
 961         key_put(mkey);
 962
 963         if (copy_to_user(buffer, ascii_buf, asciiblob_len) != 0)
 964                 ret = -EFAULT;
 965         kfree(ascii_buf);
 966
 967         return asciiblob_len;
 968 out:
 969         up_read(&mkey->sem);
 970         key_put(mkey);
 971         return ret;
 972 }
 973
 974 /*
 975  * encrypted_destroy - before freeing the key, clear the decrypted data
 976  *
 977  * Before freeing the key, clear the memory containing the decrypted
 978  * key data.
 979  */
 980 static void encrypted_destroy(struct key *key)
 981 {
 982         struct encrypted_key_payload *epayload = key->payload.data[0];
 983
 984         if (!epayload)
 985                 return;
 986
 987         memzero_explicit(epayload->decrypted_data, epayload->decrypted_datalen);
 988         kfree(key->payload.data[0]);
 989 }
 990
 991 struct key_type key_type_encrypted = {
 992         .name = "encrypted",
 993         .instantiate = encrypted_instantiate,
 994         .update = encrypted_update,
 995         .destroy = encrypted_destroy,
 996         .describe = user_describe,
 997         .read = encrypted_read,
 998 };
 999 EXPORT_SYMBOL_GPL(key_type_encrypted);
1000
1001 static void encrypted_shash_release(void)
1002 {
1003         if (hashalg)
1004                 crypto_free_shash(hashalg);
1005         if (hmacalg)
1006                 crypto_free_shash(hmacalg);
1007 }
1008
1009 static int __init encrypted_shash_alloc(void)
1010 {
1011         int ret;
1012
1013         hmacalg = crypto_alloc_shash(hmac_alg, 0, CRYPTO_ALG_ASYNC);
1014         if (IS_ERR(hmacalg)) {
1015                 pr_info("encrypted_key: could not allocate crypto %s\n",
1016                         hmac_alg);
1017                 return PTR_ERR(hmacalg);
1018         }
1019
1020         hashalg = crypto_alloc_shash(hash_alg, 0, CRYPTO_ALG_ASYNC);
1021         if (IS_ERR(hashalg)) {
1022                 pr_info("encrypted_key: could not allocate crypto %s\n",
1023                         hash_alg);
1024                 ret = PTR_ERR(hashalg);
1025                 goto hashalg_fail;
1026         }
1027
1028         return 0;
1029
1030 hashalg_fail:
1031         crypto_free_shash(hmacalg);
1032         return ret;
1033 }
1034
1035 static int __init init_encrypted(void)
1036 {
1037         int ret;
1038
1039         ret = encrypted_shash_alloc();
1040         if (ret < 0)
1041                 return ret;
1042         ret = aes_get_sizes();
1043         if (ret < 0)
1044                 goto out;
1045         ret = register_key_type(&key_type_encrypted);
1046         if (ret < 0)
1047                 goto out;
1048         return 0;
1049 out:
1050         encrypted_shash_release();
1051         return ret;
1052
1053 }
1054
1055 static void __exit cleanup_encrypted(void)
1056 {
1057         encrypted_shash_release();
1058         unregister_key_type(&key_type_encrypted);
1059 }
1060
1061 late_initcall(init_encrypted);
1062 module_exit(cleanup_encrypted);
1063
1064 MODULE_LICENSE("GPL");