providers/implementations/kdfs/hkdf.c

   1 /*
   2  * Copyright 2016-2022 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 "internal/packet.h"
  27 #include "crypto/evp.h"
  28 #include "prov/provider_ctx.h"
  29 #include "prov/providercommon.h"
  30 #include "prov/implementations.h"
  31 #include "prov/provider_util.h"
  32 #include "internal/e_os.h"
  33 #include "internal/params.h"
  34
  35 #define HKDF_MAXBUF 2048
  36 #define HKDF_MAXINFO (32*1024)
  37
  38 static OSSL_FUNC_kdf_newctx_fn kdf_hkdf_new;
  39 static OSSL_FUNC_kdf_dupctx_fn kdf_hkdf_dup;
  40 static OSSL_FUNC_kdf_freectx_fn kdf_hkdf_free;
  41 static OSSL_FUNC_kdf_reset_fn kdf_hkdf_reset;
  42 static OSSL_FUNC_kdf_derive_fn kdf_hkdf_derive;
  43 static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_hkdf_settable_ctx_params;
  44 static OSSL_FUNC_kdf_set_ctx_params_fn kdf_hkdf_set_ctx_params;
  45 static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_hkdf_gettable_ctx_params;
  46 static OSSL_FUNC_kdf_get_ctx_params_fn kdf_hkdf_get_ctx_params;
  47 static OSSL_FUNC_kdf_derive_fn kdf_tls1_3_derive;
  48 static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_tls1_3_settable_ctx_params;
  49 static OSSL_FUNC_kdf_set_ctx_params_fn kdf_tls1_3_set_ctx_params;
  50
  51 static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  52                 const unsigned char *salt, size_t salt_len,
  53                 const unsigned char *key, size_t key_len,
  54                 const unsigned char *info, size_t info_len,
  55                 unsigned char *okm, size_t okm_len);
  56 static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  57                         const unsigned char *salt, size_t salt_len,
  58                         const unsigned char *ikm, size_t ikm_len,
  59                         unsigned char *prk, size_t prk_len);
  60 static int HKDF_Expand(const EVP_MD *evp_md,
  61                        const unsigned char *prk, size_t prk_len,
  62                        const unsigned char *info, size_t info_len,
  63                        unsigned char *okm, size_t okm_len);
  64
  65 /* Settable context parameters that are common across HKDF and the TLS KDF */
  66 #define HKDF_COMMON_SETTABLES                                           \
  67         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE, NULL, 0),           \
  68         OSSL_PARAM_int(OSSL_KDF_PARAM_MODE, NULL),                      \
  69         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),     \
  70         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),         \
  71         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),           \
  72         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0)
  73
  74 typedef struct {
  75     void *provctx;
  76     int mode;
  77     PROV_DIGEST digest;
  78     unsigned char *salt;
  79     size_t salt_len;
  80     unsigned char *key;
  81     size_t key_len;
  82     unsigned char *prefix;
  83     size_t prefix_len;
  84     unsigned char *label;
  85     size_t label_len;
  86     unsigned char *data;
  87     size_t data_len;
  88     unsigned char *info;
  89     size_t info_len;
  90 } KDF_HKDF;
  91
  92 static void *kdf_hkdf_new(void *provctx)
  93 {
  94     KDF_HKDF *ctx;
  95
  96     if (!ossl_prov_is_running())
  97         return NULL;
  98
  99     if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) != NULL)
 100         ctx->provctx = provctx;
 101     return ctx;
 102 }
 103
 104 static void kdf_hkdf_free(void *vctx)
 105 {
 106     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 107
 108     if (ctx != NULL) {
 109         kdf_hkdf_reset(ctx);
 110         OPENSSL_free(ctx);
 111     }
 112 }
 113
 114 static void kdf_hkdf_reset(void *vctx)
 115 {
 116     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 117     void *provctx = ctx->provctx;
 118
 119     ossl_prov_digest_reset(&ctx->digest);
 120     OPENSSL_free(ctx->salt);
 121     OPENSSL_free(ctx->prefix);
 122     OPENSSL_free(ctx->label);
 123     OPENSSL_clear_free(ctx->data, ctx->data_len);
 124     OPENSSL_clear_free(ctx->key, ctx->key_len);
 125     OPENSSL_clear_free(ctx->info, ctx->info_len);
 126     memset(ctx, 0, sizeof(*ctx));
 127     ctx->provctx = provctx;
 128 }
 129
 130 static void *kdf_hkdf_dup(void *vctx)
 131 {
 132     const KDF_HKDF *src = (const KDF_HKDF *)vctx;
 133     KDF_HKDF *dest;
 134
 135     dest = kdf_hkdf_new(src->provctx);
 136     if (dest != NULL) {
 137         if (!ossl_prov_memdup(src->salt, src->salt_len, &dest->salt,
 138                               &dest->salt_len)
 139                 || !ossl_prov_memdup(src->key, src->key_len,
 140                                      &dest->key , &dest->key_len)
 141                 || !ossl_prov_memdup(src->prefix, src->prefix_len,
 142                                      &dest->prefix, &dest->prefix_len)
 143                 || !ossl_prov_memdup(src->label, src->label_len,
 144                                      &dest->label, &dest->label_len)
 145                 || !ossl_prov_memdup(src->data, src->data_len,
 146                                      &dest->data, &dest->data_len)
 147                 || !ossl_prov_memdup(src->info, src->info_len,
 148                                      &dest->info, &dest->info_len)
 149                 || !ossl_prov_digest_copy(&dest->digest, &src->digest))
 150             goto err;
 151         dest->mode = src->mode;
 152     }
 153     return dest;
 154
 155  err:
 156     kdf_hkdf_free(dest);
 157     return NULL;
 158 }
 159
 160 static size_t kdf_hkdf_size(KDF_HKDF *ctx)
 161 {
 162     int sz;
 163     const EVP_MD *md = ossl_prov_digest_md(&ctx->digest);
 164
 165     if (ctx->mode != EVP_KDF_HKDF_MODE_EXTRACT_ONLY)
 166         return SIZE_MAX;
 167
 168     if (md == NULL) {
 169         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
 170         return 0;
 171     }
 172     sz = EVP_MD_get_size(md);
 173     if (sz < 0)
 174         return 0;
 175
 176     return sz;
 177 }
 178
 179 static int kdf_hkdf_derive(void *vctx, unsigned char *key, size_t keylen,
 180                            const OSSL_PARAM params[])
 181 {
 182     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 183     OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
 184     const EVP_MD *md;
 185
 186     if (!ossl_prov_is_running() || !kdf_hkdf_set_ctx_params(ctx, params))
 187         return 0;
 188
 189     md = ossl_prov_digest_md(&ctx->digest);
 190     if (md == NULL) {
 191         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
 192         return 0;
 193     }
 194     if (ctx->key == NULL) {
 195         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
 196         return 0;
 197     }
 198     if (keylen == 0) {
 199         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 200         return 0;
 201     }
 202
 203     switch (ctx->mode) {
 204     case EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND:
 205     default:
 206         return HKDF(libctx, md, ctx->salt, ctx->salt_len,
 207                     ctx->key, ctx->key_len, ctx->info, ctx->info_len, key, keylen);
 208
 209     case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
 210         return HKDF_Extract(libctx, md, ctx->salt, ctx->salt_len,
 211                             ctx->key, ctx->key_len, key, keylen);
 212
 213     case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
 214         return HKDF_Expand(md, ctx->key, ctx->key_len, ctx->info,
 215                            ctx->info_len, key, keylen);
 216     }
 217 }
 218
 219 static int hkdf_common_set_ctx_params(KDF_HKDF *ctx, const OSSL_PARAM params[])
 220 {
 221     OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
 222     const OSSL_PARAM *p;
 223     int n;
 224
 225     if (params == NULL)
 226         return 1;
 227
 228     if (!ossl_prov_digest_load_from_params(&ctx->digest, params, libctx))
 229         return 0;
 230
 231     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MODE)) != NULL) {
 232         if (p->data_type == OSSL_PARAM_UTF8_STRING) {
 233             if (OPENSSL_strcasecmp(p->data, "EXTRACT_AND_EXPAND") == 0) {
 234                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND;
 235             } else if (OPENSSL_strcasecmp(p->data, "EXTRACT_ONLY") == 0) {
 236                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_ONLY;
 237             } else if (OPENSSL_strcasecmp(p->data, "EXPAND_ONLY") == 0) {
 238                 ctx->mode = EVP_KDF_HKDF_MODE_EXPAND_ONLY;
 239             } else {
 240                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 241                 return 0;
 242             }
 243         } else if (OSSL_PARAM_get_int(p, &n)) {
 244             if (n != EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
 245                 && n != EVP_KDF_HKDF_MODE_EXTRACT_ONLY
 246                 && n != EVP_KDF_HKDF_MODE_EXPAND_ONLY) {
 247                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 248                 return 0;
 249             }
 250             ctx->mode = n;
 251         } else {
 252             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 253             return 0;
 254         }
 255     }
 256
 257     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL) {
 258         OPENSSL_clear_free(ctx->key, ctx->key_len);
 259         ctx->key = NULL;
 260         if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->key, 0,
 261                                          &ctx->key_len))
 262             return 0;
 263     }
 264
 265     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
 266         if (p->data_size != 0 && p->data != NULL) {
 267             OPENSSL_free(ctx->salt);
 268             ctx->salt = NULL;
 269             if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->salt, 0,
 270                                              &ctx->salt_len))
 271                 return 0;
 272         }
 273     }
 274
 275     return 1;
 276 }
 277
 278 static int kdf_hkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 279 {
 280     KDF_HKDF *ctx = vctx;
 281
 282     if (params == NULL)
 283         return 1;
 284
 285     if (!hkdf_common_set_ctx_params(ctx, params))
 286         return 0;
 287
 288     if (ossl_param_get1_concat_octet_string(params, OSSL_KDF_PARAM_INFO,
 289                                             &ctx->info, &ctx->info_len,
 290                                             HKDF_MAXINFO) == 0)
 291         return 0;
 292
 293     return 1;
 294 }
 295
 296 static const OSSL_PARAM *kdf_hkdf_settable_ctx_params(ossl_unused void *ctx,
 297                                                       ossl_unused void *provctx)
 298 {
 299     static const OSSL_PARAM known_settable_ctx_params[] = {
 300         HKDF_COMMON_SETTABLES,
 301         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
 302         OSSL_PARAM_END
 303     };
 304     return known_settable_ctx_params;
 305 }
 306
 307 static int kdf_hkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
 308 {
 309     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 310     OSSL_PARAM *p;
 311
 312     if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL) {
 313         size_t sz = kdf_hkdf_size(ctx);
 314
 315         if (sz == 0)
 316             return 0;
 317         return OSSL_PARAM_set_size_t(p, sz);
 318     }
 319     return -2;
 320 }
 321
 322 static const OSSL_PARAM *kdf_hkdf_gettable_ctx_params(ossl_unused void *ctx,
 323                                                       ossl_unused void *provctx)
 324 {
 325     static const OSSL_PARAM known_gettable_ctx_params[] = {
 326         OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
 327         OSSL_PARAM_END
 328     };
 329     return known_gettable_ctx_params;
 330 }
 331
 332 const OSSL_DISPATCH ossl_kdf_hkdf_functions[] = {
 333     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
 334     { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_hkdf_dup },
 335     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
 336     { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
 337     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_hkdf_derive },
 338     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
 339       (void(*)(void))kdf_hkdf_settable_ctx_params },
 340     { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_hkdf_set_ctx_params },
 341     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
 342       (void(*)(void))kdf_hkdf_gettable_ctx_params },
 343     { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
 344     OSSL_DISPATCH_END
 345 };
 346
 347 /*
 348  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 349  * Section 2 (https://tools.ietf.org/html/rfc5869#section-2) and
 350  * "Cryptographic Extraction and Key Derivation: The HKDF Scheme"
 351  * Section 4.2 (https://eprint.iacr.org/2010/264.pdf).
 352  *
 353  * From the paper:
 354  *   The scheme HKDF is specified as:
 355  *     HKDF(XTS, SKM, CTXinfo, L) = K(1) | K(2) | ... | K(t)
 356  *
 357  *     where:
 358  *       SKM is source key material
 359  *       XTS is extractor salt (which may be null or constant)
 360  *       CTXinfo is context information (may be null)
 361  *       L is the number of key bits to be produced by KDF
 362  *       k is the output length in bits of the hash function used with HMAC
 363  *       t = ceil(L/k)
 364  *       the value K(t) is truncated to its first d = L mod k bits.
 365  *
 366  * From RFC 5869:
 367  *   2.2.  Step 1: Extract
 368  *     HKDF-Extract(salt, IKM) -> PRK
 369  *   2.3.  Step 2: Expand
 370  *     HKDF-Expand(PRK, info, L) -> OKM
 371  */
 372 static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
 373                 const unsigned char *salt, size_t salt_len,
 374                 const unsigned char *ikm, size_t ikm_len,
 375                 const unsigned char *info, size_t info_len,
 376                 unsigned char *okm, size_t okm_len)
 377 {
 378     unsigned char prk[EVP_MAX_MD_SIZE];
 379     int ret, sz;
 380     size_t prk_len;
 381
 382     sz = EVP_MD_get_size(evp_md);
 383     if (sz < 0)
 384         return 0;
 385     prk_len = (size_t)sz;
 386
 387     /* Step 1: HKDF-Extract(salt, IKM) -> PRK */
 388     if (!HKDF_Extract(libctx, evp_md,
 389                       salt, salt_len, ikm, ikm_len, prk, prk_len))
 390         return 0;
 391
 392     /* Step 2: HKDF-Expand(PRK, info, L) -> OKM */
 393     ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
 394     OPENSSL_cleanse(prk, sizeof(prk));
 395
 396     return ret;
 397 }
 398
 399 /*
 400  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 401  * Section 2.2 (https://tools.ietf.org/html/rfc5869#section-2.2).
 402  *
 403  * 2.2.  Step 1: Extract
 404  *
 405  *   HKDF-Extract(salt, IKM) -> PRK
 406  *
 407  *   Options:
 408  *      Hash     a hash function; HashLen denotes the length of the
 409  *               hash function output in octets
 410  *
 411  *   Inputs:
 412  *      salt     optional salt value (a non-secret random value);
 413  *               if not provided, it is set to a string of HashLen zeros.
 414  *      IKM      input keying material
 415  *
 416  *   Output:
 417  *      PRK      a pseudorandom key (of HashLen octets)
 418  *
 419  *   The output PRK is calculated as follows:
 420  *
 421  *   PRK = HMAC-Hash(salt, IKM)
 422  */
 423 static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
 424                         const unsigned char *salt, size_t salt_len,
 425                         const unsigned char *ikm, size_t ikm_len,
 426                         unsigned char *prk, size_t prk_len)
 427 {
 428     int sz = EVP_MD_get_size(evp_md);
 429
 430     if (sz < 0)
 431         return 0;
 432     if (prk_len != (size_t)sz) {
 433         ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
 434         return 0;
 435     }
 436     /* calc: PRK = HMAC-Hash(salt, IKM) */
 437     return
 438         EVP_Q_mac(libctx, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL, salt,
 439                   salt_len, ikm, ikm_len, prk, EVP_MD_get_size(evp_md), NULL)
 440         != NULL;
 441 }
 442
 443 /*
 444  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 445  * Section 2.3 (https://tools.ietf.org/html/rfc5869#section-2.3).
 446  *
 447  * 2.3.  Step 2: Expand
 448  *
 449  *   HKDF-Expand(PRK, info, L) -> OKM
 450  *
 451  *   Options:
 452  *      Hash     a hash function; HashLen denotes the length of the
 453  *               hash function output in octets
 454  *
 455  *   Inputs:
 456  *      PRK      a pseudorandom key of at least HashLen octets
 457  *               (usually, the output from the extract step)
 458  *      info     optional context and application specific information
 459  *               (can be a zero-length string)
 460  *      L        length of output keying material in octets
 461  *               (<= 255*HashLen)
 462  *
 463  *   Output:
 464  *      OKM      output keying material (of L octets)
 465  *
 466  *   The output OKM is calculated as follows:
 467  *
 468  *   N = ceil(L/HashLen)
 469  *   T = T(1) | T(2) | T(3) | ... | T(N)
 470  *   OKM = first L octets of T
 471  *
 472  *   where:
 473  *   T(0) = empty string (zero length)
 474  *   T(1) = HMAC-Hash(PRK, T(0) | info | 0x01)
 475  *   T(2) = HMAC-Hash(PRK, T(1) | info | 0x02)
 476  *   T(3) = HMAC-Hash(PRK, T(2) | info | 0x03)
 477  *   ...
 478  *
 479  *   (where the constant concatenated to the end of each T(n) is a
 480  *   single octet.)
 481  */
 482 static int HKDF_Expand(const EVP_MD *evp_md,
 483                        const unsigned char *prk, size_t prk_len,
 484                        const unsigned char *info, size_t info_len,
 485                        unsigned char *okm, size_t okm_len)
 486 {
 487     HMAC_CTX *hmac;
 488     int ret = 0, sz;
 489     unsigned int i;
 490     unsigned char prev[EVP_MAX_MD_SIZE];
 491     size_t done_len = 0, dig_len, n;
 492
 493     sz = EVP_MD_get_size(evp_md);
 494     if (sz <= 0)
 495         return 0;
 496     dig_len = (size_t)sz;
 497
 498     /* calc: N = ceil(L/HashLen) */
 499     n = okm_len / dig_len;
 500     if (okm_len % dig_len)
 501         n++;
 502
 503     if (n > 255 || okm == NULL)
 504         return 0;
 505
 506     if ((hmac = HMAC_CTX_new()) == NULL)
 507         return 0;
 508
 509     if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
 510         goto err;
 511
 512     for (i = 1; i <= n; i++) {
 513         size_t copy_len;
 514         const unsigned char ctr = i;
 515
 516         /* calc: T(i) = HMAC-Hash(PRK, T(i - 1) | info | i) */
 517         if (i > 1) {
 518             if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
 519                 goto err;
 520
 521             if (!HMAC_Update(hmac, prev, dig_len))
 522                 goto err;
 523         }
 524
 525         if (!HMAC_Update(hmac, info, info_len))
 526             goto err;
 527
 528         if (!HMAC_Update(hmac, &ctr, 1))
 529             goto err;
 530
 531         if (!HMAC_Final(hmac, prev, NULL))
 532             goto err;
 533
 534         copy_len = (done_len + dig_len > okm_len) ?
 535                        okm_len - done_len :
 536                        dig_len;
 537
 538         memcpy(okm + done_len, prev, copy_len);
 539
 540         done_len += copy_len;
 541     }
 542     ret = 1;
 543
 544  err:
 545     OPENSSL_cleanse(prev, sizeof(prev));
 546     HMAC_CTX_free(hmac);
 547     return ret;
 548 }
 549
 550 /*
 551  * TLS uses slight variations of the above and for FIPS validation purposes,
 552  * they need to be present here.
 553  * Refer to RFC 8446 section 7 for specific details.
 554  */
 555
 556 /*
 557  * Given a |secret|; a |label| of length |labellen|; and |data| of length
 558  * |datalen| (e.g. typically a hash of the handshake messages), derive a new
 559  * secret |outlen| bytes long and store it in the location pointed to be |out|.
 560  * The |data| value may be zero length. Returns 1 on success and 0 on failure.
 561  */
 562 static int prov_tls13_hkdf_expand(const EVP_MD *md,
 563                                   const unsigned char *key, size_t keylen,
 564                                   const unsigned char *prefix, size_t prefixlen,
 565                                   const unsigned char *label, size_t labellen,
 566                                   const unsigned char *data, size_t datalen,
 567                                   unsigned char *out, size_t outlen)
 568 {
 569     size_t hkdflabellen;
 570     unsigned char hkdflabel[HKDF_MAXBUF];
 571     WPACKET pkt;
 572
 573     /*
 574      * 2 bytes for length of derived secret + 1 byte for length of combined
 575      * prefix and label + bytes for the label itself + 1 byte length of hash
 576      * + bytes for the hash itself.  We've got the maximum the KDF can handle
 577      * which should always be sufficient.
 578      */
 579     if (!WPACKET_init_static_len(&pkt, hkdflabel, sizeof(hkdflabel), 0)
 580             || !WPACKET_put_bytes_u16(&pkt, outlen)
 581             || !WPACKET_start_sub_packet_u8(&pkt)
 582             || !WPACKET_memcpy(&pkt, prefix, prefixlen)
 583             || !WPACKET_memcpy(&pkt, label, labellen)
 584             || !WPACKET_close(&pkt)
 585             || !WPACKET_sub_memcpy_u8(&pkt, data, (data == NULL) ? 0 : datalen)
 586             || !WPACKET_get_total_written(&pkt, &hkdflabellen)
 587             || !WPACKET_finish(&pkt)) {
 588         WPACKET_cleanup(&pkt);
 589         return 0;
 590     }
 591
 592     return HKDF_Expand(md, key, keylen, hkdflabel, hkdflabellen,
 593                        out, outlen);
 594 }
 595
 596 static int prov_tls13_hkdf_generate_secret(OSSL_LIB_CTX *libctx,
 597                                            const EVP_MD *md,
 598                                            const unsigned char *prevsecret,
 599                                            size_t prevsecretlen,
 600                                            const unsigned char *insecret,
 601                                            size_t insecretlen,
 602                                            const unsigned char *prefix,
 603                                            size_t prefixlen,
 604                                            const unsigned char *label,
 605                                            size_t labellen,
 606                                            unsigned char *out, size_t outlen)
 607 {
 608     size_t mdlen;
 609     int ret;
 610     unsigned char preextractsec[EVP_MAX_MD_SIZE];
 611     /* Always filled with zeros */
 612     static const unsigned char default_zeros[EVP_MAX_MD_SIZE];
 613
 614     ret = EVP_MD_get_size(md);
 615     /* Ensure cast to size_t is safe */
 616     if (ret <= 0)
 617         return 0;
 618     mdlen = (size_t)ret;
 619
 620     if (insecret == NULL) {
 621         insecret = default_zeros;
 622         insecretlen = mdlen;
 623     }
 624     if (prevsecret == NULL) {
 625         prevsecret = default_zeros;
 626         prevsecretlen = 0;
 627     } else {
 628         EVP_MD_CTX *mctx = EVP_MD_CTX_new();
 629         unsigned char hash[EVP_MAX_MD_SIZE];
 630
 631         /* The pre-extract derive step uses a hash of no messages */
 632         if (mctx == NULL
 633                 || EVP_DigestInit_ex(mctx, md, NULL) <= 0
 634                 || EVP_DigestFinal_ex(mctx, hash, NULL) <= 0) {
 635             EVP_MD_CTX_free(mctx);
 636             return 0;
 637         }
 638         EVP_MD_CTX_free(mctx);
 639
 640         /* Generate the pre-extract secret */
 641         if (!prov_tls13_hkdf_expand(md, prevsecret, mdlen,
 642                                     prefix, prefixlen, label, labellen,
 643                                     hash, mdlen, preextractsec, mdlen))
 644             return 0;
 645         prevsecret = preextractsec;
 646         prevsecretlen = mdlen;
 647     }
 648
 649     ret = HKDF_Extract(libctx, md, prevsecret, prevsecretlen,
 650                        insecret, insecretlen, out, outlen);
 651
 652     if (prevsecret == preextractsec)
 653         OPENSSL_cleanse(preextractsec, mdlen);
 654     return ret;
 655 }
 656
 657 static int kdf_tls1_3_derive(void *vctx, unsigned char *key, size_t keylen,
 658                              const OSSL_PARAM params[])
 659 {
 660     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 661     const EVP_MD *md;
 662
 663     if (!ossl_prov_is_running() || !kdf_tls1_3_set_ctx_params(ctx, params))
 664         return 0;
 665
 666     md = ossl_prov_digest_md(&ctx->digest);
 667     if (md == NULL) {
 668         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
 669         return 0;
 670     }
 671
 672     switch (ctx->mode) {
 673     default:
 674         return 0;
 675
 676     case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
 677         return prov_tls13_hkdf_generate_secret(PROV_LIBCTX_OF(ctx->provctx),
 678                                                md,
 679                                                ctx->salt, ctx->salt_len,
 680                                                ctx->key, ctx->key_len,
 681                                                ctx->prefix, ctx->prefix_len,
 682                                                ctx->label, ctx->label_len,
 683                                                key, keylen);
 684
 685     case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
 686         return prov_tls13_hkdf_expand(md, ctx->key, ctx->key_len,
 687                                       ctx->prefix, ctx->prefix_len,
 688                                       ctx->label, ctx->label_len,
 689                                       ctx->data, ctx->data_len,
 690                                       key, keylen);
 691     }
 692 }
 693
 694 static int kdf_tls1_3_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 695 {
 696     const OSSL_PARAM *p;
 697     KDF_HKDF *ctx = vctx;
 698
 699     if (params == NULL)
 700         return 1;
 701
 702     if (!hkdf_common_set_ctx_params(ctx, params))
 703         return 0;
 704
 705     if (ctx->mode == EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND) {
 706         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 707         return 0;
 708     }
 709
 710     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PREFIX)) != NULL) {
 711         OPENSSL_free(ctx->prefix);
 712         ctx->prefix = NULL;
 713         if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->prefix, 0,
 714                                          &ctx->prefix_len))
 715             return 0;
 716     }
 717
 718     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_LABEL)) != NULL) {
 719         OPENSSL_free(ctx->label);
 720         ctx->label = NULL;
 721         if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->label, 0,
 722                                          &ctx->label_len))
 723             return 0;
 724     }
 725
 726     OPENSSL_clear_free(ctx->data, ctx->data_len);
 727     ctx->data = NULL;
 728     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_DATA)) != NULL
 729             && !OSSL_PARAM_get_octet_string(p, (void **)&ctx->data, 0,
 730                                             &ctx->data_len))
 731         return 0;
 732     return 1;
 733 }
 734
 735 static const OSSL_PARAM *kdf_tls1_3_settable_ctx_params(ossl_unused void *ctx,
 736                                                         ossl_unused void *provctx)
 737 {
 738     static const OSSL_PARAM known_settable_ctx_params[] = {
 739         HKDF_COMMON_SETTABLES,
 740         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PREFIX, NULL, 0),
 741         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_LABEL, NULL, 0),
 742         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_DATA, NULL, 0),
 743         OSSL_PARAM_END
 744     };
 745     return known_settable_ctx_params;
 746 }
 747
 748 const OSSL_DISPATCH ossl_kdf_tls1_3_kdf_functions[] = {
 749     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
 750     { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_hkdf_dup },
 751     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
 752     { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
 753     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_tls1_3_derive },
 754     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
 755       (void(*)(void))kdf_tls1_3_settable_ctx_params },
 756     { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_tls1_3_set_ctx_params },
 757     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
 758       (void(*)(void))kdf_hkdf_gettable_ctx_params },
 759     { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
 760     OSSL_DISPATCH_END
 761 };