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 1024
  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(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(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_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     const EVP_MD *md;
 131
 132     if (!ossl_prov_is_running() || !kdf_hkdf_set_ctx_params(ctx, params))
 133         return 0;
 134
 135     md = ossl_prov_digest_md(&ctx->digest);
 136     if (md == NULL) {
 137         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
 138         return 0;
 139     }
 140     if (ctx->key == NULL) {
 141         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
 142         return 0;
 143     }
 144     if (keylen == 0) {
 145         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 146         return 0;
 147     }
 148
 149     switch (ctx->mode) {
 150     case EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND:
 151         return HKDF(md, ctx->salt, ctx->salt_len, ctx->key,
 152                     ctx->key_len, ctx->info, ctx->info_len, key,
 153                     keylen);
 154
 155     case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
 156         return HKDF_Extract(md, ctx->salt, ctx->salt_len, ctx->key,
 157                             ctx->key_len, key, keylen);
 158
 159     case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
 160         return HKDF_Expand(md, ctx->key, ctx->key_len, ctx->info,
 161                            ctx->info_len, key, keylen);
 162
 163     default:
 164         return 0;
 165     }
 166 }
 167
 168 static int kdf_hkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 169 {
 170     const OSSL_PARAM *p;
 171     KDF_HKDF *ctx = vctx;
 172     OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
 173     int n;
 174
 175     if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
 176         return 0;
 177
 178     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MODE)) != NULL) {
 179         if (p->data_type == OSSL_PARAM_UTF8_STRING) {
 180             if (strcasecmp(p->data, "EXTRACT_AND_EXPAND") == 0) {
 181                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND;
 182             } else if (strcasecmp(p->data, "EXTRACT_ONLY") == 0) {
 183                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_ONLY;
 184             } else if (strcasecmp(p->data, "EXPAND_ONLY") == 0) {
 185                 ctx->mode = EVP_KDF_HKDF_MODE_EXPAND_ONLY;
 186             } else {
 187                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 188                 return 0;
 189             }
 190         } else if (OSSL_PARAM_get_int(p, &n)) {
 191             if (n != EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
 192                 && n != EVP_KDF_HKDF_MODE_EXTRACT_ONLY
 193                 && n != EVP_KDF_HKDF_MODE_EXPAND_ONLY) {
 194                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 195                 return 0;
 196             }
 197             ctx->mode = n;
 198         } else {
 199             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 200             return 0;
 201         }
 202     }
 203
 204     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL) {
 205         OPENSSL_clear_free(ctx->key, ctx->key_len);
 206         ctx->key = NULL;
 207         if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->key, 0,
 208                                          &ctx->key_len))
 209             return 0;
 210     }
 211
 212     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
 213         if (p->data_size != 0 && p->data != NULL) {
 214             OPENSSL_free(ctx->salt);
 215             ctx->salt = NULL;
 216             if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->salt, 0,
 217                                              &ctx->salt_len))
 218                 return 0;
 219         }
 220     }
 221     /* The info fields concatenate, so process them all */
 222     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_INFO)) != NULL) {
 223         ctx->info_len = 0;
 224         for (; p != NULL; p = OSSL_PARAM_locate_const(p + 1,
 225                                                       OSSL_KDF_PARAM_INFO)) {
 226             const void *q = ctx->info + ctx->info_len;
 227             size_t sz = 0;
 228
 229             if (p->data_size != 0
 230                 && p->data != NULL
 231                 && !OSSL_PARAM_get_octet_string(p, (void **)&q,
 232                                                 HKDF_MAXBUF - ctx->info_len,
 233                                                 &sz))
 234                 return 0;
 235             ctx->info_len += sz;
 236         }
 237     }
 238     return 1;
 239 }
 240
 241 static const OSSL_PARAM *kdf_hkdf_settable_ctx_params(ossl_unused void *ctx,
 242                                                       ossl_unused void *provctx)
 243 {
 244     static const OSSL_PARAM known_settable_ctx_params[] = {
 245         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE, NULL, 0),
 246         OSSL_PARAM_int(OSSL_KDF_PARAM_MODE, NULL),
 247         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
 248         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
 249         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
 250         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
 251         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
 252         OSSL_PARAM_END
 253     };
 254     return known_settable_ctx_params;
 255 }
 256
 257 static int kdf_hkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
 258 {
 259     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
 260     OSSL_PARAM *p;
 261
 262     if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
 263         return OSSL_PARAM_set_size_t(p, kdf_hkdf_size(ctx));
 264     return -2;
 265 }
 266
 267 static const OSSL_PARAM *kdf_hkdf_gettable_ctx_params(ossl_unused void *ctx,
 268                                                       ossl_unused void *provctx)
 269 {
 270     static const OSSL_PARAM known_gettable_ctx_params[] = {
 271         OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
 272         OSSL_PARAM_END
 273     };
 274     return known_gettable_ctx_params;
 275 }
 276
 277 const OSSL_DISPATCH ossl_kdf_hkdf_functions[] = {
 278     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
 279     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
 280     { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
 281     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_hkdf_derive },
 282     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
 283       (void(*)(void))kdf_hkdf_settable_ctx_params },
 284     { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_hkdf_set_ctx_params },
 285     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
 286       (void(*)(void))kdf_hkdf_gettable_ctx_params },
 287     { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
 288     { 0, NULL }
 289 };
 290
 291 /*
 292  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 293  * Section 2 (https://tools.ietf.org/html/rfc5869#section-2) and
 294  * "Cryptographic Extraction and Key Derivation: The HKDF Scheme"
 295  * Section 4.2 (https://eprint.iacr.org/2010/264.pdf).
 296  *
 297  * From the paper:
 298  *   The scheme HKDF is specified as:
 299  *     HKDF(XTS, SKM, CTXinfo, L) = K(1) | K(2) | ... | K(t)
 300  *
 301  *     where:
 302  *       SKM is source key material
 303  *       XTS is extractor salt (which may be null or constant)
 304  *       CTXinfo is context information (may be null)
 305  *       L is the number of key bits to be produced by KDF
 306  *       k is the output length in bits of the hash function used with HMAC
 307  *       t = ceil(L/k)
 308  *       the value K(t) is truncated to its first d = L mod k bits.
 309  *
 310  * From RFC 5869:
 311  *   2.2.  Step 1: Extract
 312  *     HKDF-Extract(salt, IKM) -> PRK
 313  *   2.3.  Step 2: Expand
 314  *     HKDF-Expand(PRK, info, L) -> OKM
 315  */
 316 static int HKDF(const EVP_MD *evp_md,
 317                 const unsigned char *salt, size_t salt_len,
 318                 const unsigned char *ikm, size_t ikm_len,
 319                 const unsigned char *info, size_t info_len,
 320                 unsigned char *okm, size_t okm_len)
 321 {
 322     unsigned char prk[EVP_MAX_MD_SIZE];
 323     int ret, sz;
 324     size_t prk_len;
 325
 326     sz = EVP_MD_size(evp_md);
 327     if (sz < 0)
 328         return 0;
 329     prk_len = (size_t)sz;
 330
 331     /* Step 1: HKDF-Extract(salt, IKM) -> PRK */
 332     if (!HKDF_Extract(evp_md, salt, salt_len, ikm, ikm_len, prk, prk_len))
 333         return 0;
 334
 335     /* Step 2: HKDF-Expand(PRK, info, L) -> OKM */
 336     ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
 337     OPENSSL_cleanse(prk, sizeof(prk));
 338
 339     return ret;
 340 }
 341
 342 /*
 343  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 344  * Section 2.2 (https://tools.ietf.org/html/rfc5869#section-2.2).
 345  *
 346  * 2.2.  Step 1: Extract
 347  *
 348  *   HKDF-Extract(salt, IKM) -> PRK
 349  *
 350  *   Options:
 351  *      Hash     a hash function; HashLen denotes the length of the
 352  *               hash function output in octets
 353  *
 354  *   Inputs:
 355  *      salt     optional salt value (a non-secret random value);
 356  *               if not provided, it is set to a string of HashLen zeros.
 357  *      IKM      input keying material
 358  *
 359  *   Output:
 360  *      PRK      a pseudorandom key (of HashLen octets)
 361  *
 362  *   The output PRK is calculated as follows:
 363  *
 364  *   PRK = HMAC-Hash(salt, IKM)
 365  */
 366 static int HKDF_Extract(const EVP_MD *evp_md,
 367                         const unsigned char *salt, size_t salt_len,
 368                         const unsigned char *ikm, size_t ikm_len,
 369                         unsigned char *prk, size_t prk_len)
 370 {
 371     int sz = EVP_MD_size(evp_md);
 372
 373     if (sz < 0)
 374         return 0;
 375     if (prk_len != (size_t)sz) {
 376         ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
 377         return 0;
 378     }
 379     /* calc: PRK = HMAC-Hash(salt, IKM) */
 380     return HMAC(evp_md, salt, salt_len, ikm, ikm_len, prk, NULL) != NULL;
 381 }
 382
 383 /*
 384  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
 385  * Section 2.3 (https://tools.ietf.org/html/rfc5869#section-2.3).
 386  *
 387  * 2.3.  Step 2: Expand
 388  *
 389  *   HKDF-Expand(PRK, info, L) -> OKM
 390  *
 391  *   Options:
 392  *      Hash     a hash function; HashLen denotes the length of the
 393  *               hash function output in octets
 394  *
 395  *   Inputs:
 396  *      PRK      a pseudorandom key of at least HashLen octets
 397  *               (usually, the output from the extract step)
 398  *      info     optional context and application specific information
 399  *               (can be a zero-length string)
 400  *      L        length of output keying material in octets
 401  *               (<= 255*HashLen)
 402  *
 403  *   Output:
 404  *      OKM      output keying material (of L octets)
 405  *
 406  *   The output OKM is calculated as follows:
 407  *
 408  *   N = ceil(L/HashLen)
 409  *   T = T(1) | T(2) | T(3) | ... | T(N)
 410  *   OKM = first L octets of T
 411  *
 412  *   where:
 413  *   T(0) = empty string (zero length)
 414  *   T(1) = HMAC-Hash(PRK, T(0) | info | 0x01)
 415  *   T(2) = HMAC-Hash(PRK, T(1) | info | 0x02)
 416  *   T(3) = HMAC-Hash(PRK, T(2) | info | 0x03)
 417  *   ...
 418  *
 419  *   (where the constant concatenated to the end of each T(n) is a
 420  *   single octet.)
 421  */
 422 static int HKDF_Expand(const EVP_MD *evp_md,
 423                        const unsigned char *prk, size_t prk_len,
 424                        const unsigned char *info, size_t info_len,
 425                        unsigned char *okm, size_t okm_len)
 426 {
 427     HMAC_CTX *hmac;
 428     int ret = 0, sz;
 429     unsigned int i;
 430     unsigned char prev[EVP_MAX_MD_SIZE];
 431     size_t done_len = 0, dig_len, n;
 432
 433     sz = EVP_MD_size(evp_md);
 434     if (sz <= 0)
 435         return 0;
 436     dig_len = (size_t)sz;
 437
 438     /* calc: N = ceil(L/HashLen) */
 439     n = okm_len / dig_len;
 440     if (okm_len % dig_len)
 441         n++;
 442
 443     if (n > 255 || okm == NULL)
 444         return 0;
 445
 446     if ((hmac = HMAC_CTX_new()) == NULL)
 447         return 0;
 448
 449     if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
 450         goto err;
 451
 452     for (i = 1; i <= n; i++) {
 453         size_t copy_len;
 454         const unsigned char ctr = i;
 455
 456         /* calc: T(i) = HMAC-Hash(PRK, T(i - 1) | info | i) */
 457         if (i > 1) {
 458             if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
 459                 goto err;
 460
 461             if (!HMAC_Update(hmac, prev, dig_len))
 462                 goto err;
 463         }
 464
 465         if (!HMAC_Update(hmac, info, info_len))
 466             goto err;
 467
 468         if (!HMAC_Update(hmac, &ctr, 1))
 469             goto err;
 470
 471         if (!HMAC_Final(hmac, prev, NULL))
 472             goto err;
 473
 474         copy_len = (done_len + dig_len > okm_len) ?
 475                        okm_len - done_len :
 476                        dig_len;
 477
 478         memcpy(okm + done_len, prev, copy_len);
 479
 480         done_len += copy_len;
 481     }
 482     ret = 1;
 483
 484  err:
 485     OPENSSL_cleanse(prev, sizeof(prev));
 486     HMAC_CTX_free(hmac);
 487     return ret;
 488 }