Coverage Report

Created: 2025-12-31 06:58

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