Coverage Report

Created: 2025-08-28 07:07

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