Coverage Report

Created: 2023-06-08 06:41

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