Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl33/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 "internal/e_os.h"
33
#include "internal/params.h"
34
35
#define HKDF_MAXBUF 2048
36
10.8k
#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
83
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE, NULL, 0),           \
68
83
        OSSL_PARAM_int(OSSL_KDF_PARAM_MODE, NULL),                  \
69
83
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0), \
70
83
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),     \
71
83
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),       \
72
83
        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.32M
{
94
1.32M
    KDF_HKDF *ctx;
95
96
1.32M
    if (!ossl_prov_is_running())
97
0
        return NULL;
98
99
1.32M
    if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) != NULL)
100
1.32M
        ctx->provctx = provctx;
101
1.32M
    return ctx;
102
1.32M
}
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 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
51.2k
{
182
51.2k
    KDF_HKDF *ctx = (KDF_HKDF *)vctx;
183
51.2k
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
184
51.2k
    const EVP_MD *md;
185
186
51.2k
    if (!ossl_prov_is_running() || !kdf_hkdf_set_ctx_params(ctx, params))
187
0
        return 0;
188
189
51.2k
    md = ossl_prov_digest_md(&ctx->digest);
190
51.2k
    if (md == NULL) {
191
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
192
0
        return 0;
193
0
    }
194
51.2k
    if (ctx->key == NULL) {
195
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
196
0
        return 0;
197
0
    }
198
51.2k
    if (keylen == 0) {
199
0
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
200
0
        return 0;
201
0
    }
202
203
51.2k
    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
51.2k
    case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
210
51.2k
        return HKDF_Extract(libctx, md, ctx->salt, ctx->salt_len,
211
51.2k
            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
51.2k
    }
217
51.2k
}
218
219
static int hkdf_common_set_ctx_params(KDF_HKDF *ctx, const OSSL_PARAM params[])
220
275k
{
221
275k
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
222
275k
    const OSSL_PARAM *p;
223
275k
    int n;
224
225
275k
    if (params == NULL)
226
0
        return 1;
227
228
275k
    if (!ossl_prov_digest_load_from_params(&ctx->digest, params, libctx))
229
0
        return 0;
230
231
275k
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MODE)) != NULL) {
232
275k
        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
275k
        } else if (OSSL_PARAM_get_int(p, &n)) {
244
275k
            if (n != EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
245
275k
                && n != EVP_KDF_HKDF_MODE_EXTRACT_ONLY
246
248k
                && 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
275k
            ctx->mode = n;
251
275k
        } else {
252
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
253
0
            return 0;
254
0
        }
255
275k
    }
256
257
275k
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL) {
258
265k
        OPENSSL_clear_free(ctx->key, ctx->key_len);
259
265k
        ctx->key = NULL;
260
265k
        if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->key, 0,
261
265k
                &ctx->key_len))
262
0
            return 0;
263
265k
    }
264
265
275k
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
266
20.5k
        OPENSSL_free(ctx->salt);
267
20.5k
        ctx->salt = NULL;
268
20.5k
        if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->salt, 0,
269
20.5k
                &ctx->salt_len))
270
0
            return 0;
271
20.5k
    }
272
273
275k
    return 1;
274
275k
}
275
276
static int kdf_hkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
277
10.8k
{
278
10.8k
    KDF_HKDF *ctx = vctx;
279
280
10.8k
    if (params == NULL)
281
0
        return 1;
282
283
10.8k
    if (!hkdf_common_set_ctx_params(ctx, params))
284
0
        return 0;
285
286
10.8k
    if (ossl_param_get1_concat_octet_string(params, OSSL_KDF_PARAM_INFO,
287
10.8k
            &ctx->info, &ctx->info_len,
288
10.8k
            HKDF_MAXINFO)
289
10.8k
        == 0)
290
0
        return 0;
291
292
10.8k
    return 1;
293
10.8k
}
294
295
static const OSSL_PARAM *kdf_hkdf_settable_ctx_params(ossl_unused void *ctx,
296
    ossl_unused void *provctx)
297
66
{
298
66
    static const OSSL_PARAM known_settable_ctx_params[] = {
299
66
        HKDF_COMMON_SETTABLES,
300
66
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
301
66
        OSSL_PARAM_END
302
66
    };
303
66
    return known_settable_ctx_params;
304
66
}
305
306
static int kdf_hkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
307
0
{
308
0
    KDF_HKDF *ctx = (KDF_HKDF *)vctx;
309
0
    OSSL_PARAM *p;
310
311
0
    if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL) {
312
0
        size_t sz = kdf_hkdf_size(ctx);
313
314
0
        if (sz == 0)
315
0
            return 0;
316
0
        return OSSL_PARAM_set_size_t(p, sz);
317
0
    }
318
0
    if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_INFO)) != NULL) {
319
0
        if (ctx->info == NULL || ctx->info_len == 0) {
320
0
            p->return_size = 0;
321
0
            return 1;
322
0
        }
323
0
        return OSSL_PARAM_set_octet_string(p, ctx->info, ctx->info_len);
324
0
    }
325
0
    return -2;
326
0
}
327
328
static const OSSL_PARAM *kdf_hkdf_gettable_ctx_params(ossl_unused void *ctx,
329
    ossl_unused void *provctx)
330
0
{
331
0
    static const OSSL_PARAM known_gettable_ctx_params[] = {
332
0
        OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
333
0
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
334
0
        OSSL_PARAM_END
335
0
    };
336
0
    return known_gettable_ctx_params;
337
0
}
338
339
const OSSL_DISPATCH ossl_kdf_hkdf_functions[] = {
340
    { OSSL_FUNC_KDF_NEWCTX, (void (*)(void))kdf_hkdf_new },
341
    { OSSL_FUNC_KDF_DUPCTX, (void (*)(void))kdf_hkdf_dup },
342
    { OSSL_FUNC_KDF_FREECTX, (void (*)(void))kdf_hkdf_free },
343
    { OSSL_FUNC_KDF_RESET, (void (*)(void))kdf_hkdf_reset },
344
    { OSSL_FUNC_KDF_DERIVE, (void (*)(void))kdf_hkdf_derive },
345
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
346
        (void (*)(void))kdf_hkdf_settable_ctx_params },
347
    { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void (*)(void))kdf_hkdf_set_ctx_params },
348
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
349
        (void (*)(void))kdf_hkdf_gettable_ctx_params },
350
    { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void (*)(void))kdf_hkdf_get_ctx_params },
351
    OSSL_DISPATCH_END
352
};
353
354
/*
355
 * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
356
 * Section 2 (https://tools.ietf.org/html/rfc5869#section-2) and
357
 * "Cryptographic Extraction and Key Derivation: The HKDF Scheme"
358
 * Section 4.2 (https://eprint.iacr.org/2010/264.pdf).
359
 *
360
 * From the paper:
361
 *   The scheme HKDF is specified as:
362
 *     HKDF(XTS, SKM, CTXinfo, L) = K(1) | K(2) | ... | K(t)
363
 *
364
 *     where:
365
 *       SKM is source key material
366
 *       XTS is extractor salt (which may be null or constant)
367
 *       CTXinfo is context information (may be null)
368
 *       L is the number of key bits to be produced by KDF
369
 *       k is the output length in bits of the hash function used with HMAC
370
 *       t = ceil(L/k)
371
 *       the value K(t) is truncated to its first d = L mod k bits.
372
 *
373
 * From RFC 5869:
374
 *   2.2.  Step 1: Extract
375
 *     HKDF-Extract(salt, IKM) -> PRK
376
 *   2.3.  Step 2: Expand
377
 *     HKDF-Expand(PRK, info, L) -> OKM
378
 */
379
static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
380
    const unsigned char *salt, size_t salt_len,
381
    const unsigned char *ikm, size_t ikm_len,
382
    const unsigned char *info, size_t info_len,
383
    unsigned char *okm, size_t okm_len)
384
0
{
385
0
    unsigned char prk[EVP_MAX_MD_SIZE];
386
0
    int ret, sz;
387
0
    size_t prk_len;
388
389
0
    sz = EVP_MD_get_size(evp_md);
390
0
    if (sz < 0)
391
0
        return 0;
392
0
    prk_len = (size_t)sz;
393
394
    /* Step 1: HKDF-Extract(salt, IKM) -> PRK */
395
0
    if (!HKDF_Extract(libctx, evp_md,
396
0
            salt, salt_len, ikm, ikm_len, prk, prk_len))
397
0
        return 0;
398
399
    /* Step 2: HKDF-Expand(PRK, info, L) -> OKM */
400
0
    ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
401
0
    OPENSSL_cleanse(prk, sizeof(prk));
402
403
0
    return ret;
404
0
}
405
406
/*
407
 * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
408
 * Section 2.2 (https://tools.ietf.org/html/rfc5869#section-2.2).
409
 *
410
 * 2.2.  Step 1: Extract
411
 *
412
 *   HKDF-Extract(salt, IKM) -> PRK
413
 *
414
 *   Options:
415
 *      Hash     a hash function; HashLen denotes the length of the
416
 *               hash function output in octets
417
 *
418
 *   Inputs:
419
 *      salt     optional salt value (a non-secret random value);
420
 *               if not provided, it is set to a string of HashLen zeros.
421
 *      IKM      input keying material
422
 *
423
 *   Output:
424
 *      PRK      a pseudorandom key (of HashLen octets)
425
 *
426
 *   The output PRK is calculated as follows:
427
 *
428
 *   PRK = HMAC-Hash(salt, IKM)
429
 */
430
static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
431
    const unsigned char *salt, size_t salt_len,
432
    const unsigned char *ikm, size_t ikm_len,
433
    unsigned char *prk, size_t prk_len)
434
26.7k
{
435
26.7k
    int sz = EVP_MD_get_size(evp_md);
436
437
26.7k
    if (sz < 0)
438
0
        return 0;
439
26.7k
    if (prk_len != (size_t)sz) {
440
0
        ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
441
0
        return 0;
442
0
    }
443
    /* calc: PRK = HMAC-Hash(salt, IKM) */
444
26.7k
    return EVP_Q_mac(libctx, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL, salt,
445
26.7k
               salt_len, ikm, ikm_len, prk, EVP_MD_get_size(evp_md), NULL)
446
26.7k
        != NULL;
447
26.7k
}
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.25M
{
493
1.25M
    HMAC_CTX *hmac;
494
1.25M
    int ret = 0, sz;
495
1.25M
    unsigned int i;
496
1.25M
    unsigned char prev[EVP_MAX_MD_SIZE];
497
1.25M
    size_t done_len = 0, dig_len, n;
498
499
1.25M
    sz = EVP_MD_get_size(evp_md);
500
1.25M
    if (sz <= 0)
501
0
        return 0;
502
1.25M
    dig_len = (size_t)sz;
503
504
    /* calc: N = ceil(L/HashLen) */
505
1.25M
    n = okm_len / dig_len;
506
1.25M
    if (okm_len % dig_len)
507
826k
        n++;
508
509
1.25M
    if (n > 255 || okm == NULL)
510
0
        return 0;
511
512
1.25M
    if ((hmac = HMAC_CTX_new()) == NULL)
513
0
        return 0;
514
515
1.25M
    if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
516
0
        goto err;
517
518
2.51M
    for (i = 1; i <= n; i++) {
519
1.25M
        size_t copy_len;
520
1.25M
        const unsigned char ctr = i;
521
522
        /* calc: T(i) = HMAC-Hash(PRK, T(i - 1) | info | i) */
523
1.25M
        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.25M
        if (!HMAC_Update(hmac, info, info_len))
532
0
            goto err;
533
534
1.25M
        if (!HMAC_Update(hmac, &ctr, 1))
535
0
            goto err;
536
537
1.25M
        if (!HMAC_Final(hmac, prev, NULL))
538
0
            goto err;
539
540
1.25M
        copy_len = (dig_len > okm_len - done_len) ? okm_len - done_len : dig_len;
541
542
1.25M
        memcpy(okm + done_len, prev, copy_len);
543
544
1.25M
        done_len += copy_len;
545
1.25M
    }
546
1.25M
    ret = 1;
547
548
1.25M
err:
549
1.25M
    OPENSSL_cleanse(prev, sizeof(prev));
550
1.25M
    HMAC_CTX_free(hmac);
551
1.25M
    return ret;
552
1.25M
}
553
554
/*
555
 * TLS uses slight variations of the above and for FIPS validation purposes,
556
 * they need to be present here.
557
 * Refer to RFC 8446 section 7 for specific details.
558
 */
559
560
/*
561
 * Given a |secret|; a |label| of length |labellen|; and |data| of length
562
 * |datalen| (e.g. typically a hash of the handshake messages), derive a new
563
 * secret |outlen| bytes long and store it in the location pointed to be |out|.
564
 * The |data| value may be zero length. Returns 1 on success and 0 on failure.
565
 */
566
static int prov_tls13_hkdf_expand(const EVP_MD *md,
567
    const unsigned char *key, size_t keylen,
568
    const unsigned char *prefix, size_t prefixlen,
569
    const unsigned char *label, size_t labellen,
570
    const unsigned char *data, size_t datalen,
571
    unsigned char *out, size_t outlen)
572
1.25M
{
573
1.25M
    size_t hkdflabellen;
574
1.25M
    unsigned char hkdflabel[HKDF_MAXBUF];
575
1.25M
    WPACKET pkt;
576
577
    /*
578
     * 2 bytes for length of derived secret + 1 byte for length of combined
579
     * prefix and label + bytes for the label itself + 1 byte length of hash
580
     * + bytes for the hash itself.  We've got the maximum the KDF can handle
581
     * which should always be sufficient.
582
     */
583
1.25M
    if (!WPACKET_init_static_len(&pkt, hkdflabel, sizeof(hkdflabel), 0)
584
1.25M
        || !WPACKET_put_bytes_u16(&pkt, outlen)
585
1.25M
        || !WPACKET_start_sub_packet_u8(&pkt)
586
1.25M
        || !WPACKET_memcpy(&pkt, prefix, prefixlen)
587
1.25M
        || !WPACKET_memcpy(&pkt, label, labellen)
588
1.25M
        || !WPACKET_close(&pkt)
589
1.25M
        || !WPACKET_sub_memcpy_u8(&pkt, data, (data == NULL) ? 0 : datalen)
590
1.25M
        || !WPACKET_get_total_written(&pkt, &hkdflabellen)
591
1.25M
        || !WPACKET_finish(&pkt)) {
592
0
        WPACKET_cleanup(&pkt);
593
0
        return 0;
594
0
    }
595
596
1.25M
    return HKDF_Expand(md, key, keylen, hkdflabel, hkdflabellen,
597
1.25M
        out, outlen);
598
1.25M
}
599
600
static int prov_tls13_hkdf_generate_secret(OSSL_LIB_CTX *libctx,
601
    const EVP_MD *md,
602
    const unsigned char *prevsecret,
603
    size_t prevsecretlen,
604
    const unsigned char *insecret,
605
    size_t insecretlen,
606
    const unsigned char *prefix,
607
    size_t prefixlen,
608
    const unsigned char *label,
609
    size_t labellen,
610
    unsigned char *out, size_t outlen)
611
71.9k
{
612
71.9k
    size_t mdlen;
613
71.9k
    int ret;
614
71.9k
    unsigned char preextractsec[EVP_MAX_MD_SIZE];
615
    /* Always filled with zeros */
616
71.9k
    static const unsigned char default_zeros[EVP_MAX_MD_SIZE];
617
618
71.9k
    ret = EVP_MD_get_size(md);
619
    /* Ensure cast to size_t is safe */
620
71.9k
    if (ret <= 0)
621
0
        return 0;
622
71.9k
    mdlen = (size_t)ret;
623
624
71.9k
    if (insecret == NULL) {
625
43.6k
        insecret = default_zeros;
626
43.6k
        insecretlen = mdlen;
627
43.6k
    }
628
71.9k
    if (prevsecret == NULL) {
629
28.3k
        prevsecret = default_zeros;
630
28.3k
        prevsecretlen = 0;
631
43.6k
    } else {
632
43.6k
        EVP_MD_CTX *mctx = EVP_MD_CTX_new();
633
43.6k
        unsigned char hash[EVP_MAX_MD_SIZE];
634
635
        /* The pre-extract derive step uses a hash of no messages */
636
43.6k
        if (mctx == NULL
637
43.6k
            || EVP_DigestInit_ex(mctx, md, NULL) <= 0
638
43.6k
            || EVP_DigestFinal_ex(mctx, hash, NULL) <= 0) {
639
0
            EVP_MD_CTX_free(mctx);
640
0
            return 0;
641
0
        }
642
43.6k
        EVP_MD_CTX_free(mctx);
643
644
        /* Generate the pre-extract secret */
645
43.6k
        if (!prov_tls13_hkdf_expand(md, prevsecret, prevsecretlen,
646
43.6k
                prefix, prefixlen, label, labellen,
647
43.6k
                hash, mdlen, preextractsec, mdlen))
648
0
            return 0;
649
43.6k
        prevsecret = preextractsec;
650
43.6k
        prevsecretlen = mdlen;
651
43.6k
    }
652
653
71.9k
    ret = HKDF_Extract(libctx, md, prevsecret, prevsecretlen,
654
71.9k
        insecret, insecretlen, out, outlen);
655
656
71.9k
    if (prevsecret == preextractsec)
657
43.6k
        OPENSSL_cleanse(preextractsec, mdlen);
658
71.9k
    return ret;
659
71.9k
}
660
661
static int kdf_tls1_3_derive(void *vctx, unsigned char *key, size_t keylen,
662
    const OSSL_PARAM params[])
663
1.28M
{
664
1.28M
    KDF_HKDF *ctx = (KDF_HKDF *)vctx;
665
1.28M
    const EVP_MD *md;
666
667
1.28M
    if (!ossl_prov_is_running() || !kdf_tls1_3_set_ctx_params(ctx, params))
668
0
        return 0;
669
670
1.28M
    md = ossl_prov_digest_md(&ctx->digest);
671
1.28M
    if (md == NULL) {
672
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
673
0
        return 0;
674
0
    }
675
676
1.28M
    switch (ctx->mode) {
677
0
    default:
678
0
        return 0;
679
680
71.9k
    case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
681
71.9k
        return prov_tls13_hkdf_generate_secret(PROV_LIBCTX_OF(ctx->provctx),
682
71.9k
            md,
683
71.9k
            ctx->salt, ctx->salt_len,
684
71.9k
            ctx->key, ctx->key_len,
685
71.9k
            ctx->prefix, ctx->prefix_len,
686
71.9k
            ctx->label, ctx->label_len,
687
71.9k
            key, keylen);
688
689
1.21M
    case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
690
1.21M
        return prov_tls13_hkdf_expand(md, ctx->key, ctx->key_len,
691
1.21M
            ctx->prefix, ctx->prefix_len,
692
1.21M
            ctx->label, ctx->label_len,
693
1.21M
            ctx->data, ctx->data_len,
694
1.21M
            key, keylen);
695
1.28M
    }
696
1.28M
}
697
698
static int kdf_tls1_3_set_ctx_params(void *vctx, const OSSL_PARAM params[])
699
264k
{
700
264k
    const OSSL_PARAM *p;
701
264k
    KDF_HKDF *ctx = vctx;
702
703
264k
    if (params == NULL)
704
0
        return 1;
705
706
264k
    if (!hkdf_common_set_ctx_params(ctx, params))
707
0
        return 0;
708
709
264k
    if (ctx->mode == EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND) {
710
0
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
711
0
        return 0;
712
0
    }
713
714
264k
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PREFIX)) != NULL) {
715
264k
        OPENSSL_free(ctx->prefix);
716
264k
        ctx->prefix = NULL;
717
264k
        if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->prefix, 0,
718
264k
                &ctx->prefix_len))
719
0
            return 0;
720
264k
    }
721
722
264k
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_LABEL)) != NULL) {
723
264k
        OPENSSL_free(ctx->label);
724
264k
        ctx->label = NULL;
725
264k
        if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->label, 0,
726
264k
                &ctx->label_len))
727
0
            return 0;
728
264k
    }
729
730
264k
    OPENSSL_clear_free(ctx->data, ctx->data_len);
731
264k
    ctx->data = NULL;
732
264k
    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_DATA)) != NULL
733
24.9k
        && !OSSL_PARAM_get_octet_string(p, (void **)&ctx->data, 0,
734
24.9k
            &ctx->data_len))
735
0
        return 0;
736
264k
    return 1;
737
264k
}
738
739
static const OSSL_PARAM *kdf_tls1_3_settable_ctx_params(ossl_unused void *ctx,
740
    ossl_unused void *provctx)
741
17
{
742
17
    static const OSSL_PARAM known_settable_ctx_params[] = {
743
17
        HKDF_COMMON_SETTABLES,
744
17
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PREFIX, NULL, 0),
745
17
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_LABEL, NULL, 0),
746
17
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_DATA, NULL, 0),
747
        OSSL_PARAM_END
748
17
    };
749
17
    return known_settable_ctx_params;
750
17
}
751
752
const OSSL_DISPATCH ossl_kdf_tls1_3_kdf_functions[] = {
753
    { OSSL_FUNC_KDF_NEWCTX, (void (*)(void))kdf_hkdf_new },
754
    { OSSL_FUNC_KDF_DUPCTX, (void (*)(void))kdf_hkdf_dup },
755
    { OSSL_FUNC_KDF_FREECTX, (void (*)(void))kdf_hkdf_free },
756
    { OSSL_FUNC_KDF_RESET, (void (*)(void))kdf_hkdf_reset },
757
    { OSSL_FUNC_KDF_DERIVE, (void (*)(void))kdf_tls1_3_derive },
758
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
759
        (void (*)(void))kdf_tls1_3_settable_ctx_params },
760
    { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void (*)(void))kdf_tls1_3_set_ctx_params },
761
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
762
        (void (*)(void))kdf_hkdf_gettable_ctx_params },
763
    { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void (*)(void))kdf_hkdf_get_ctx_params },
764
    OSSL_DISPATCH_END
765
};