providers/implementations/kdfs/hkdf.c

   1 /*
   2  * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*
  11  * HMAC low level APIs are deprecated for public use, but still ok for internal
  12  * use.
  13  */
  14 #include "internal/deprecated.h"
  15
  16 #include <stdlib.h>
  17 #include <stdarg.h>
  18 #include <string.h>
  19 #include <openssl/hmac.h>
  20 #include <openssl/evp.h>
  21 #include <openssl/kdf.h>
  22 #include <openssl/core_names.h>
  23 #include <openssl/proverr.h>
  24 #include "internal/cryptlib.h"
  25 #include "internal/numbers.h"
  26 #include "crypto/evp.h"
  27 #include "prov/provider_ctx.h"
  28 #include "prov/providercommon.h"
  29 #include "prov/implementations.h"
  30 #include "prov/provider_util.h"
  31 #include "e_os.h"
  32
  33 #define HKDF_MAXBUF 2048
  34
  35 static OSSL_FUNC_kdf_newctx_fn kdf_hkdf_new;
  36 static OSSL_FUNC_kdf_freectx_fn kdf_hkdf_free;
  37 static OSSL_FUNC_kdf_reset_fn kdf_hkdf_reset;
  38 static OSSL_FUNC_kdf_derive_fn kdf_hkdf_derive;
  39 static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_hkdf_settable_ctx_params;
  40 static OSSL_FUNC_kdf_set_ctx_params_fn kdf_hkdf_set_ctx_params;
  41 static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_hkdf_gettable_ctx_params;
  42 static OSSL_FUNC_kdf_get_ctx_params_fn kdf_hkdf_get_ctx_params;
  43
  44 static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  45                 const unsigned char *salt, size_t salt_len,
  46                 const unsigned char *key, size_t key_len,
  47                 const unsigned char *info, size_t info_len,
  48                 unsigned char *okm, size_t okm_len);
  49 static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  50                         const unsigned char *salt, size_t salt_len,
  51                         const unsigned char *ikm, size_t ikm_len,
  52                         unsigned char *prk, size_t prk_len);
  53 static int HKDF_Expand(const EVP_MD *evp_md,
  54                        const unsigned char *prk, size_t prk_len,
  55                        const unsigned char *info, size_t info_len,
  56                        unsigned char *okm, size_t okm_len);
  57
  58 typedef struct {
  59     void *provctx;
  60     int mode;
  61     PROV_DIGEST digest;
  62     unsigned char *salt;
  63     size_t salt_len;
  64     unsigned char *key;
  65     size_t key_len;
  66     unsigned char info[HKDF_MAXBUF];
  67     size_t info_len;
  68 } KDF_HKDF;
  69
  70 static void *kdf_hkdf_new(void *provctx)
  71 {
  72     KDF_HKDF *ctx;
  73
  74     if (!ossl_prov_is_running())
  75         return NULL;
  76
  77     if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
  78         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
  79     else
  80         ctx->provctx = provctx;
  81     return ctx;
  82 }
  83
  84 static void kdf_hkdf_free(void *vctx)
  85 {
  86     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  87
  88     if (ctx != NULL) {
  89         kdf_hkdf_reset(ctx);
  90         OPENSSL_free(ctx);
  91     }
  92 }
  93
  94 static void kdf_hkdf_reset(void *vctx)
  95 {
  96     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  97     void *provctx = ctx->provctx;
  98
  99     ossl_prov_digest_reset(&ctx->digest);
 100     OPENSSL_free(ctx->salt);
 101     OPENSSL_clear_free(ctx->key, ctx->key_len);
 102     OPENSSL_cleanse(ctx->info, ctx->info_len);
 103     memset(ctx, 0, sizeof(*ctx));
 104     ctx->provctx = provctx;
 105 }
 106
 107 static size_t kdf_hkdf_size(KDF_HKDF *ctx)
 108 {
 109     int sz;
 110     const EVP_MD *md = ossl_prov_digest_md(&ctx->digest);
 111
 112     if (ctx->mode != EVP_KDF_HKDF_MODE_EXTRACT_ONLY)
 113         return SIZE_MAX;
 114
 115     if (md == NULL) {
 116         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
 117         return 0;
 118     }
 119     sz = EVP_MD_get_size(md);
 120     if (sz < 0)
 121         return 0;
 122
 123     return sz;
 124 }
 125
 126 static int kdf_hkdf_derive(void *vctx, unsigned char *key, size_t keylen,
 127                            const OSSL_PARAM params[])
 128 {
 129     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 130     OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
 131     const EVP_MD *md;
 132
 133     if (!ossl_prov_is_running() || !kdf_hkdf_set_ctx_params(ctx, params))
 134         return 0;
 135
 136     md = ossl_prov_digest_md(&ctx->digest);
 137     if (md == NULL) {
 138         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
 139         return 0;
 140     }
 141     if (ctx->key == NULL) {
 142         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
 143         return 0;
 144     }
 145     if (keylen == 0) {
 146         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 147         return 0;
 148     }
 149
 150     switch (ctx->mode) {
 151     case EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND:
 152     default:
 153         return HKDF(libctx, md, ctx->salt, ctx->salt_len,
 154                     ctx->key, ctx->key_len, ctx->info, ctx->info_len, key, keylen);
 155
 156     case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
 157         return HKDF_Extract(libctx, md, ctx->salt, ctx->salt_len,
 158                             ctx->key, ctx->key_len, key, keylen);
 159
 160     case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
 161         return HKDF_Expand(md, ctx->key, ctx->key_len, ctx->info,
 162                            ctx->info_len, key, keylen);
 163     }
 164 }
 165
 166 static int kdf_hkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 167 {
 168     const OSSL_PARAM *p;
 169     KDF_HKDF *ctx = vctx;
 170     OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
 171     int n;
 172
 173     if (params == NULL)
 174         return 1;
 175
 176     if (!ossl_prov_digest_load_from_params(&ctx->digest, params, libctx))
 177         return 0;
 178
 179     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MODE)) != NULL) {
 180         if (p->data_type == OSSL_PARAM_UTF8_STRING) {
 181             if (strcasecmp(p->data, "EXTRACT_AND_EXPAND") == 0) {
 182                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND;
 183             } else if (strcasecmp(p->data, "EXTRACT_ONLY") == 0) {
 184                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_ONLY;
 185             } else if (strcasecmp(p->data, "EXPAND_ONLY") == 0) {
 186                 ctx->mode = EVP_KDF_HKDF_MODE_EXPAND_ONLY;
 187             } else {
 188                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 189                 return 0;
 190             }
 191         } else if (OSSL_PARAM_get_int(p, &n)) {
 192             if (n != EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
 193                 && n != EVP_KDF_HKDF_MODE_EXTRACT_ONLY
 194                 && n != EVP_KDF_HKDF_MODE_EXPAND_ONLY) {
 195                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 196                 return 0;
 197             }
 198             ctx->mode = n;
 199         } else {
 200             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 201             return 0;
 202         }
 203     }
 204
 205     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL) {
 206         OPENSSL_clear_free(ctx->key, ctx->key_len);
 207         ctx->key = NULL;
 208         if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->key, 0,
 209                                          &ctx->key_len))
 210             return 0;
 211     }
 212
 213     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
 214         if (p->data_size != 0 && p->data != NULL) {
 215             OPENSSL_free(ctx->salt);
 216             ctx->salt = NULL;
 217             if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->salt, 0,
 218                                              &ctx->salt_len))
 219                 return 0;
 220         }
 221     }
 222     /* The info fields concatenate, so process them all */
 223     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_INFO)) != NULL) {
 224         ctx->info_len = 0;
 225         for (; p != NULL; p = OSSL_PARAM_locate_const(p + 1,
 226                                                       OSSL_KDF_PARAM_INFO)) {
 227             const void *q = ctx->info + ctx->info_len;
 228             size_t sz = 0;
 229
 230             if (p->data_size != 0
 231                 && p->data != NULL
 232                 && !OSSL_PARAM_get_octet_string(p, (void **)&q,
 233                                                 HKDF_MAXBUF - ctx->info_len,
 234                                                 &sz))
 235                 return 0;
 236             ctx->info_len += sz;
 237         }
 238     }
 239     return 1;
 240 }
 241
 242 static const OSSL_PARAM *kdf_hkdf_settable_ctx_params(ossl_unused void *ctx,
 243                                                       ossl_unused void *provctx)
 244 {
 245     static const OSSL_PARAM known_settable_ctx_params[] = {
 246         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE, NULL, 0),
 247         OSSL_PARAM_int(OSSL_KDF_PARAM_MODE, NULL),
 248         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
 249         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
 250         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
 251         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
 252         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
 253         OSSL_PARAM_END
 254     };
 255     return known_settable_ctx_params;
 256 }
 257
 258 static int kdf_hkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
 259 {
 260     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 261     OSSL_PARAM *p;
 262
 263     if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL) {
 264         size_t sz = kdf_hkdf_size(ctx);
 265
 266         if (sz == 0)
 267             return 0;
 268         return OSSL_PARAM_set_size_t(p, sz);
 269     }
 270     return -2;
 271 }
 272
 273 static const OSSL_PARAM *kdf_hkdf_gettable_ctx_params(ossl_unused void *ctx,
 274                                                       ossl_unused void *provctx)
 275 {
 276     static const OSSL_PARAM known_gettable_ctx_params[] = {
 277         OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
 278         OSSL_PARAM_END
 279     };
 280     return known_gettable_ctx_params;
 281 }
 282
 283 const OSSL_DISPATCH ossl_kdf_hkdf_functions[] = {
 284     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
 285     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
 286     { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
 287     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_hkdf_derive },
 288     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
 289       (void(*)(void))kdf_hkdf_settable_ctx_params },
 290     { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_hkdf_set_ctx_params },
 291     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
 292       (void(*)(void))kdf_hkdf_gettable_ctx_params },
 293     { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
 294     { 0, NULL }
 295 };
 296
 297 /*
 298  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 299  * Section 2 (https://tools.ietf.org/html/rfc5869#section-2) and
 300  * "Cryptographic Extraction and Key Derivation: The HKDF Scheme"
 301  * Section 4.2 (https://eprint.iacr.org/2010/264.pdf).
 302  *
 303  * From the paper:
 304  *   The scheme HKDF is specified as:
 305  *     HKDF(XTS, SKM, CTXinfo, L) = K(1) | K(2) | ... | K(t)
 306  *
 307  *     where:
 308  *       SKM is source key material
 309  *       XTS is extractor salt (which may be null or constant)
 310  *       CTXinfo is context information (may be null)
 311  *       L is the number of key bits to be produced by KDF
 312  *       k is the output length in bits of the hash function used with HMAC
 313  *       t = ceil(L/k)
 314  *       the value K(t) is truncated to its first d = L mod k bits.
 315  *
 316  * From RFC 5869:
 317  *   2.2.  Step 1: Extract
 318  *     HKDF-Extract(salt, IKM) -> PRK
 319  *   2.3.  Step 2: Expand
 320  *     HKDF-Expand(PRK, info, L) -> OKM
 321  */
 322 static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
 323                 const unsigned char *salt, size_t salt_len,
 324                 const unsigned char *ikm, size_t ikm_len,
 325                 const unsigned char *info, size_t info_len,
 326                 unsigned char *okm, size_t okm_len)
 327 {
 328     unsigned char prk[EVP_MAX_MD_SIZE];
 329     int ret, sz;
 330     size_t prk_len;
 331
 332     sz = EVP_MD_get_size(evp_md);
 333     if (sz < 0)
 334         return 0;
 335     prk_len = (size_t)sz;
 336
 337     /* Step 1: HKDF-Extract(salt, IKM) -> PRK */
 338     if (!HKDF_Extract(libctx, evp_md,
 339                       salt, salt_len, ikm, ikm_len, prk, prk_len))
 340         return 0;
 341
 342     /* Step 2: HKDF-Expand(PRK, info, L) -> OKM */
 343     ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
 344     OPENSSL_cleanse(prk, sizeof(prk));
 345
 346     return ret;
 347 }
 348
 349 /*
 350  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 351  * Section 2.2 (https://tools.ietf.org/html/rfc5869#section-2.2).
 352  *
 353  * 2.2.  Step 1: Extract
 354  *
 355  *   HKDF-Extract(salt, IKM) -> PRK
 356  *
 357  *   Options:
 358  *      Hash     a hash function; HashLen denotes the length of the
 359  *               hash function output in octets
 360  *
 361  *   Inputs:
 362  *      salt     optional salt value (a non-secret random value);
 363  *               if not provided, it is set to a string of HashLen zeros.
 364  *      IKM      input keying material
 365  *
 366  *   Output:
 367  *      PRK      a pseudorandom key (of HashLen octets)
 368  *
 369  *   The output PRK is calculated as follows:
 370  *
 371  *   PRK = HMAC-Hash(salt, IKM)
 372  */
 373 static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
 374                         const unsigned char *salt, size_t salt_len,
 375                         const unsigned char *ikm, size_t ikm_len,
 376                         unsigned char *prk, size_t prk_len)
 377 {
 378     int sz = EVP_MD_get_size(evp_md);
 379
 380     if (sz < 0)
 381         return 0;
 382     if (prk_len != (size_t)sz) {
 383         ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
 384         return 0;
 385     }
 386     /* calc: PRK = HMAC-Hash(salt, IKM) */
 387     return
 388         EVP_Q_mac(libctx, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL, salt,
 389                   salt_len, ikm, ikm_len, prk, EVP_MD_get_size(evp_md), NULL)
 390         != NULL;
 391 }
 392
 393 /*
 394  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 395  * Section 2.3 (https://tools.ietf.org/html/rfc5869#section-2.3).
 396  *
 397  * 2.3.  Step 2: Expand
 398  *
 399  *   HKDF-Expand(PRK, info, L) -> OKM
 400  *
 401  *   Options:
 402  *      Hash     a hash function; HashLen denotes the length of the
 403  *               hash function output in octets
 404  *
 405  *   Inputs:
 406  *      PRK      a pseudorandom key of at least HashLen octets
 407  *               (usually, the output from the extract step)
 408  *      info     optional context and application specific information
 409  *               (can be a zero-length string)
 410  *      L        length of output keying material in octets
 411  *               (<= 255*HashLen)
 412  *
 413  *   Output:
 414  *      OKM      output keying material (of L octets)
 415  *
 416  *   The output OKM is calculated as follows:
 417  *
 418  *   N = ceil(L/HashLen)
 419  *   T = T(1) | T(2) | T(3) | ... | T(N)
 420  *   OKM = first L octets of T
 421  *
 422  *   where:
 423  *   T(0) = empty string (zero length)
 424  *   T(1) = HMAC-Hash(PRK, T(0) | info | 0x01)
 425  *   T(2) = HMAC-Hash(PRK, T(1) | info | 0x02)
 426  *   T(3) = HMAC-Hash(PRK, T(2) | info | 0x03)
 427  *   ...
 428  *
 429  *   (where the constant concatenated to the end of each T(n) is a
 430  *   single octet.)
 431  */
 432 static int HKDF_Expand(const EVP_MD *evp_md,
 433                        const unsigned char *prk, size_t prk_len,
 434                        const unsigned char *info, size_t info_len,
 435                        unsigned char *okm, size_t okm_len)
 436 {
 437     HMAC_CTX *hmac;
 438     int ret = 0, sz;
 439     unsigned int i;
 440     unsigned char prev[EVP_MAX_MD_SIZE];
 441     size_t done_len = 0, dig_len, n;
 442
 443     sz = EVP_MD_get_size(evp_md);
 444     if (sz <= 0)
 445         return 0;
 446     dig_len = (size_t)sz;
 447
 448     /* calc: N = ceil(L/HashLen) */
 449     n = okm_len / dig_len;
 450     if (okm_len % dig_len)
 451         n++;
 452
 453     if (n > 255 || okm == NULL)
 454         return 0;
 455
 456     if ((hmac = HMAC_CTX_new()) == NULL)
 457         return 0;
 458
 459     if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
 460         goto err;
 461
 462     for (i = 1; i <= n; i++) {
 463         size_t copy_len;
 464         const unsigned char ctr = i;
 465
 466         /* calc: T(i) = HMAC-Hash(PRK, T(i - 1) | info | i) */
 467         if (i > 1) {
 468             if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
 469                 goto err;
 470
 471             if (!HMAC_Update(hmac, prev, dig_len))
 472                 goto err;
 473         }
 474
 475         if (!HMAC_Update(hmac, info, info_len))
 476             goto err;
 477
 478         if (!HMAC_Update(hmac, &ctr, 1))
 479             goto err;
 480
 481         if (!HMAC_Final(hmac, prev, NULL))
 482             goto err;
 483
 484         copy_len = (done_len + dig_len > okm_len) ?
 485                        okm_len - done_len :
 486                        dig_len;
 487
 488         memcpy(okm + done_len, prev, copy_len);
 489
 490         done_len += copy_len;
 491     }
 492     ret = 1;
 493
 494  err:
 495     OPENSSL_cleanse(prev, sizeof(prev));
 496     HMAC_CTX_free(hmac);
 497     return ret;
 498 }