providers/implementations/kdfs/kbkdf.c

   1 /*
   2  * Copyright 2019-2022 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright 2019 Red Hat, Inc.
   4  *
   5  * Licensed under the Apache License 2.0 (the "License").  You may not use
   6  * this file except in compliance with the License.  You can obtain a copy
   7  * in the file LICENSE in the source distribution or at
   8  * https://www.openssl.org/source/license.html
   9  */
  10
  11 /*
  12  * This implements https://csrc.nist.gov/publications/detail/sp/800-108/final
  13  * section 5.1 ("counter mode") and section 5.2 ("feedback mode") in both HMAC
  14  * and CMAC.  That document does not name the KDFs it defines; the name is
  15  * derived from
  16  * https://csrc.nist.gov/Projects/Cryptographic-Algorithm-Validation-Program/Key-Derivation
  17  *
  18  * Note that section 5.3 ("double-pipeline mode") is not implemented, though
  19  * it would be possible to do so in the future.
  20  *
  21  * These versions all assume the counter is used.  It would be relatively
  22  * straightforward to expose a configuration handle should the need arise.
  23  *
  24  * Variable names attempt to match those of SP800-108.
  25  */
  26
  27 #include <stdarg.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30
  31 #include <openssl/core_names.h>
  32 #include <openssl/evp.h>
  33 #include <openssl/hmac.h>
  34 #include <openssl/kdf.h>
  35 #include <openssl/params.h>
  36 #include <openssl/proverr.h>
  37
  38 #include "internal/cryptlib.h"
  39 #include "crypto/evp.h"
  40 #include "internal/numbers.h"
  41 #include "internal/endian.h"
  42 #include "prov/implementations.h"
  43 #include "prov/provider_ctx.h"
  44 #include "prov/provider_util.h"
  45 #include "prov/providercommon.h"
  46
  47 #include "internal/e_os.h"
  48
  49 #define ossl_min(a, b) ((a) < (b)) ? (a) : (b)
  50
  51 typedef enum {
  52     COUNTER = 0,
  53     FEEDBACK
  54 } kbkdf_mode;
  55
  56 /* Our context structure. */
  57 typedef struct {
  58     void *provctx;
  59     kbkdf_mode mode;
  60     EVP_MAC_CTX *ctx_init;
  61
  62     /* Names are lowercased versions of those found in SP800-108. */
  63     int r;
  64     unsigned char *ki;
  65     size_t ki_len;
  66     unsigned char *label;
  67     size_t label_len;
  68     unsigned char *context;
  69     size_t context_len;
  70     unsigned char *iv;
  71     size_t iv_len;
  72     int use_l;
  73     int is_kmac;
  74     int use_separator;
  75 } KBKDF;
  76
  77 /* Definitions needed for typechecking. */
  78 static OSSL_FUNC_kdf_newctx_fn kbkdf_new;
  79 static OSSL_FUNC_kdf_dupctx_fn kbkdf_dup;
  80 static OSSL_FUNC_kdf_freectx_fn kbkdf_free;
  81 static OSSL_FUNC_kdf_reset_fn kbkdf_reset;
  82 static OSSL_FUNC_kdf_derive_fn kbkdf_derive;
  83 static OSSL_FUNC_kdf_settable_ctx_params_fn kbkdf_settable_ctx_params;
  84 static OSSL_FUNC_kdf_set_ctx_params_fn kbkdf_set_ctx_params;
  85 static OSSL_FUNC_kdf_gettable_ctx_params_fn kbkdf_gettable_ctx_params;
  86 static OSSL_FUNC_kdf_get_ctx_params_fn kbkdf_get_ctx_params;
  87
  88 /* Not all platforms have htobe32(). */
  89 static uint32_t be32(uint32_t host)
  90 {
  91     uint32_t big = 0;
  92     DECLARE_IS_ENDIAN;
  93
  94     if (!IS_LITTLE_ENDIAN)
  95         return host;
  96
  97     big |= (host & 0xff000000) >> 24;
  98     big |= (host & 0x00ff0000) >> 8;
  99     big |= (host & 0x0000ff00) << 8;
 100     big |= (host & 0x000000ff) << 24;
 101     return big;
 102 }
 103
 104 static void init(KBKDF *ctx)
 105 {
 106     ctx->r = 32;
 107     ctx->use_l = 1;
 108     ctx->use_separator = 1;
 109     ctx->is_kmac = 0;
 110 }
 111
 112 static void *kbkdf_new(void *provctx)
 113 {
 114     KBKDF *ctx;
 115
 116     if (!ossl_prov_is_running())
 117         return NULL;
 118
 119     ctx = OPENSSL_zalloc(sizeof(*ctx));
 120     if (ctx == NULL)
 121         return NULL;
 122
 123     ctx->provctx = provctx;
 124     init(ctx);
 125     return ctx;
 126 }
 127
 128 static void kbkdf_free(void *vctx)
 129 {
 130     KBKDF *ctx = (KBKDF *)vctx;
 131
 132     if (ctx != NULL) {
 133         kbkdf_reset(ctx);
 134         OPENSSL_free(ctx);
 135     }
 136 }
 137
 138 static void kbkdf_reset(void *vctx)
 139 {
 140     KBKDF *ctx = (KBKDF *)vctx;
 141     void *provctx = ctx->provctx;
 142
 143     EVP_MAC_CTX_free(ctx->ctx_init);
 144     OPENSSL_clear_free(ctx->context, ctx->context_len);
 145     OPENSSL_clear_free(ctx->label, ctx->label_len);
 146     OPENSSL_clear_free(ctx->ki, ctx->ki_len);
 147     OPENSSL_clear_free(ctx->iv, ctx->iv_len);
 148     memset(ctx, 0, sizeof(*ctx));
 149     ctx->provctx = provctx;
 150     init(ctx);
 151 }
 152
 153 static void *kbkdf_dup(void *vctx)
 154 {
 155     const KBKDF *src = (const KBKDF *)vctx;
 156     KBKDF *dest;
 157
 158     dest = kbkdf_new(src->provctx);
 159     if (dest != NULL) {
 160         dest->ctx_init = EVP_MAC_CTX_dup(src->ctx_init);
 161         if (dest->ctx_init == NULL
 162                 || !ossl_prov_memdup(src->ki, src->ki_len,
 163                                      &dest->ki, &dest->ki_len)
 164                 || !ossl_prov_memdup(src->label, src->label_len,
 165                                      &dest->label, &dest->label_len)
 166                 || !ossl_prov_memdup(src->context, src->context_len,
 167                                      &dest->context, &dest->context_len)
 168                 || !ossl_prov_memdup(src->iv, src->iv_len,
 169                                      &dest->iv, &dest->iv_len))
 170             goto err;
 171         dest->mode = src->mode;
 172         dest->r = src->r;
 173         dest->use_l = src->use_l;
 174         dest->use_separator = src->use_separator;
 175         dest->is_kmac = src->is_kmac;
 176     }
 177     return dest;
 178
 179  err:
 180     kbkdf_free(dest);
 181     return NULL;
 182 }
 183
 184 /* SP800-108 section 5.1 or section 5.2 depending on mode. */
 185 static int derive(EVP_MAC_CTX *ctx_init, kbkdf_mode mode, unsigned char *iv,
 186                   size_t iv_len, unsigned char *label, size_t label_len,
 187                   unsigned char *context, size_t context_len,
 188                   unsigned char *k_i, size_t h, uint32_t l, int has_separator,
 189                   unsigned char *ko, size_t ko_len, int r)
 190 {
 191     int ret = 0;
 192     EVP_MAC_CTX *ctx = NULL;
 193     size_t written = 0, to_write, k_i_len = iv_len;
 194     const unsigned char zero = 0;
 195     uint32_t counter, i;
 196     /*
 197      * From SP800-108:
 198      * The fixed input data is a concatenation of a Label,
 199      * a separation indicator 0x00, the Context, and L.
 200      * One or more of these fixed input data fields may be omitted.
 201      *
 202      * has_separator == 0 means that the separator is omitted.
 203      * Passing a value of l == 0 means that L is omitted.
 204      * The Context and L are omitted automatically if a NULL buffer is passed.
 205      */
 206     int has_l = (l != 0);
 207
 208     /* Setup K(0) for feedback mode. */
 209     if (iv_len > 0)
 210         memcpy(k_i, iv, iv_len);
 211
 212     for (counter = 1; written < ko_len; counter++) {
 213         i = be32(counter);
 214
 215         ctx = EVP_MAC_CTX_dup(ctx_init);
 216         if (ctx == NULL)
 217             goto done;
 218
 219         /* Perform feedback, if appropriate. */
 220         if (mode == FEEDBACK && !EVP_MAC_update(ctx, k_i, k_i_len))
 221             goto done;
 222
 223         if (!EVP_MAC_update(ctx, 4 - (r / 8) + (unsigned char *)&i, r / 8)
 224             || !EVP_MAC_update(ctx, label, label_len)
 225             || (has_separator && !EVP_MAC_update(ctx, &zero, 1))
 226             || !EVP_MAC_update(ctx, context, context_len)
 227             || (has_l && !EVP_MAC_update(ctx, (unsigned char *)&l, 4))
 228             || !EVP_MAC_final(ctx, k_i, NULL, h))
 229             goto done;
 230
 231         to_write = ko_len - written;
 232         memcpy(ko + written, k_i, ossl_min(to_write, h));
 233         written += h;
 234
 235         k_i_len = h;
 236         EVP_MAC_CTX_free(ctx);
 237         ctx = NULL;
 238     }
 239
 240     ret = 1;
 241 done:
 242     EVP_MAC_CTX_free(ctx);
 243     return ret;
 244 }
 245
 246 /* This must be run before the key is set */
 247 static int kmac_init(EVP_MAC_CTX *ctx, const unsigned char *custom, size_t customlen)
 248 {
 249     OSSL_PARAM params[2];
 250
 251     if (custom == NULL || customlen == 0)
 252         return 1;
 253     params[0] = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_CUSTOM,
 254                                                   (void *)custom, customlen);
 255     params[1] = OSSL_PARAM_construct_end();
 256     return EVP_MAC_CTX_set_params(ctx, params) > 0;
 257 }
 258
 259 static int kmac_derive(EVP_MAC_CTX *ctx, unsigned char *out, size_t outlen,
 260                        const unsigned char *context, size_t contextlen)
 261 {
 262     OSSL_PARAM params[2];
 263
 264     params[0] = OSSL_PARAM_construct_size_t(OSSL_MAC_PARAM_SIZE, &outlen);
 265     params[1] = OSSL_PARAM_construct_end();
 266     return EVP_MAC_CTX_set_params(ctx, params) > 0
 267            && EVP_MAC_update(ctx, context, contextlen)
 268            && EVP_MAC_final(ctx, out, NULL, outlen);
 269 }
 270
 271 static int kbkdf_derive(void *vctx, unsigned char *key, size_t keylen,
 272                         const OSSL_PARAM params[])
 273 {
 274     KBKDF *ctx = (KBKDF *)vctx;
 275     int ret = 0;
 276     unsigned char *k_i = NULL;
 277     uint32_t l = 0;
 278     size_t h = 0;
 279     uint64_t counter_max;
 280
 281     if (!ossl_prov_is_running() || !kbkdf_set_ctx_params(ctx, params))
 282         return 0;
 283
 284     /* label, context, and iv are permitted to be empty.  Check everything
 285      * else. */
 286     if (ctx->ctx_init == NULL) {
 287         if (ctx->ki_len == 0 || ctx->ki == NULL) {
 288             ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
 289             return 0;
 290         }
 291         /* Could either be missing MAC or missing message digest or missing
 292          * cipher - arbitrarily, I pick this one. */
 293         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MAC);
 294         return 0;
 295     }
 296
 297     /* Fail if the output length is zero */
 298     if (keylen == 0) {
 299         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 300         return 0;
 301     }
 302
 303     if (ctx->is_kmac) {
 304         ret = kmac_derive(ctx->ctx_init, key, keylen,
 305                           ctx->context, ctx->context_len);
 306         goto done;
 307     }
 308
 309     h = EVP_MAC_CTX_get_mac_size(ctx->ctx_init);
 310     if (h == 0)
 311         goto done;
 312
 313     if (ctx->iv_len != 0 && ctx->iv_len != h) {
 314         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SEED_LENGTH);
 315         goto done;
 316     }
 317
 318     if (ctx->mode == COUNTER) {
 319         /* Fail if keylen is too large for r */
 320         counter_max = (uint64_t)1 << (uint64_t)ctx->r;
 321         if ((uint64_t)(keylen / h) >= counter_max) {
 322             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 323             goto done;
 324         }
 325     }
 326
 327     if (ctx->use_l != 0)
 328         l = be32(keylen * 8);
 329
 330     k_i = OPENSSL_zalloc(h);
 331     if (k_i == NULL)
 332         goto done;
 333
 334     ret = derive(ctx->ctx_init, ctx->mode, ctx->iv, ctx->iv_len, ctx->label,
 335                  ctx->label_len, ctx->context, ctx->context_len, k_i, h, l,
 336                  ctx->use_separator, key, keylen, ctx->r);
 337 done:
 338     if (ret != 1)
 339         OPENSSL_cleanse(key, keylen);
 340     OPENSSL_clear_free(k_i, h);
 341     return ret;
 342 }
 343
 344 static int kbkdf_set_buffer(unsigned char **out, size_t *out_len,
 345                             const OSSL_PARAM *p)
 346 {
 347     if (p->data == NULL || p->data_size == 0)
 348         return 1;
 349
 350     OPENSSL_clear_free(*out, *out_len);
 351     *out = NULL;
 352     return OSSL_PARAM_get_octet_string(p, (void **)out, 0, out_len);
 353 }
 354
 355 static int kbkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 356 {
 357     KBKDF *ctx = (KBKDF *)vctx;
 358     OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
 359     const OSSL_PARAM *p;
 360
 361     if (params == NULL)
 362         return 1;
 363
 364     if (!ossl_prov_macctx_load_from_params(&ctx->ctx_init, params, NULL,
 365                                            NULL, NULL, libctx))
 366         return 0;
 367     else if (ctx->ctx_init != NULL) {
 368         if (EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->ctx_init),
 369                          OSSL_MAC_NAME_KMAC128)
 370             || EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->ctx_init),
 371                             OSSL_MAC_NAME_KMAC256)) {
 372             ctx->is_kmac = 1;
 373         } else if (!EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->ctx_init),
 374                                  OSSL_MAC_NAME_HMAC)
 375                    && !EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->ctx_init),
 376                                     OSSL_MAC_NAME_CMAC)) {
 377             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MAC);
 378             return 0;
 379         }
 380     }
 381
 382     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MODE);
 383     if (p != NULL
 384         && OPENSSL_strncasecmp("counter", p->data, p->data_size) == 0) {
 385         ctx->mode = COUNTER;
 386     } else if (p != NULL
 387                && OPENSSL_strncasecmp("feedback", p->data, p->data_size) == 0) {
 388         ctx->mode = FEEDBACK;
 389     } else if (p != NULL) {
 390         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
 391         return 0;
 392     }
 393
 394     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY);
 395     if (p != NULL && !kbkdf_set_buffer(&ctx->ki, &ctx->ki_len, p))
 396         return 0;
 397
 398     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT);
 399     if (p != NULL && !kbkdf_set_buffer(&ctx->label, &ctx->label_len, p))
 400         return 0;
 401
 402     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_INFO);
 403     if (p != NULL && !kbkdf_set_buffer(&ctx->context, &ctx->context_len, p))
 404         return 0;
 405
 406     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SEED);
 407     if (p != NULL && !kbkdf_set_buffer(&ctx->iv, &ctx->iv_len, p))
 408         return 0;
 409
 410     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KBKDF_USE_L);
 411     if (p != NULL && !OSSL_PARAM_get_int(p, &ctx->use_l))
 412         return 0;
 413
 414     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KBKDF_R);
 415     if (p != NULL) {
 416         int new_r = 0;
 417
 418         if (!OSSL_PARAM_get_int(p, &new_r))
 419             return 0;
 420         if (new_r != 8 && new_r != 16 && new_r != 24 && new_r != 32)
 421             return 0;
 422         ctx->r = new_r;
 423     }
 424
 425     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KBKDF_USE_SEPARATOR);
 426     if (p != NULL && !OSSL_PARAM_get_int(p, &ctx->use_separator))
 427         return 0;
 428
 429     /* Set up digest context, if we can. */
 430     if (ctx->ctx_init != NULL && ctx->ki_len != 0) {
 431         if ((ctx->is_kmac && !kmac_init(ctx->ctx_init, ctx->label, ctx->label_len))
 432             || !EVP_MAC_init(ctx->ctx_init, ctx->ki, ctx->ki_len, NULL))
 433             return 0;
 434     }
 435     return 1;
 436 }
 437
 438 static const OSSL_PARAM *kbkdf_settable_ctx_params(ossl_unused void *ctx,
 439                                                    ossl_unused void *provctx)
 440 {
 441     static const OSSL_PARAM known_settable_ctx_params[] = {
 442         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
 443         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
 444         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
 445         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SEED, NULL, 0),
 446         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
 447         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_CIPHER, NULL, 0),
 448         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MAC, NULL, 0),
 449         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE, NULL, 0),
 450         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
 451         OSSL_PARAM_int(OSSL_KDF_PARAM_KBKDF_USE_L, NULL),
 452         OSSL_PARAM_int(OSSL_KDF_PARAM_KBKDF_USE_SEPARATOR, NULL),
 453         OSSL_PARAM_int(OSSL_KDF_PARAM_KBKDF_R, NULL),
 454         OSSL_PARAM_END,
 455     };
 456     return known_settable_ctx_params;
 457 }
 458
 459 static int kbkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
 460 {
 461     OSSL_PARAM *p;
 462
 463     p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE);
 464     if (p == NULL)
 465         return -2;
 466
 467     /* KBKDF can produce results as large as you like. */
 468     return OSSL_PARAM_set_size_t(p, SIZE_MAX);
 469 }
 470
 471 static const OSSL_PARAM *kbkdf_gettable_ctx_params(ossl_unused void *ctx,
 472                                                    ossl_unused void *provctx)
 473 {
 474     static const OSSL_PARAM known_gettable_ctx_params[] =
 475         { OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL), OSSL_PARAM_END };
 476     return known_gettable_ctx_params;
 477 }
 478
 479 const OSSL_DISPATCH ossl_kdf_kbkdf_functions[] = {
 480     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kbkdf_new },
 481     { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kbkdf_dup },
 482     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kbkdf_free },
 483     { OSSL_FUNC_KDF_RESET, (void(*)(void))kbkdf_reset },
 484     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kbkdf_derive },
 485     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
 486       (void(*)(void))kbkdf_settable_ctx_params },
 487     { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kbkdf_set_ctx_params },
 488     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
 489       (void(*)(void))kbkdf_gettable_ctx_params },
 490     { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kbkdf_get_ctx_params },
 491     { 0, NULL },
 492 };