Coverage Report

Created: 2025-08-25 06:30

/src/openssl/providers/implementations/exchange/dh_exch.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2019-2024 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
/*
12
 * DH low level APIs are deprecated for public use, but still ok for
13
 * internal use.
14
 */
15
#include "internal/deprecated.h"
16
17
#include <string.h>
18
#include <openssl/crypto.h>
19
#include <openssl/core_dispatch.h>
20
#include <openssl/core_names.h>
21
#include <openssl/dh.h>
22
#include <openssl/err.h>
23
#include <openssl/proverr.h>
24
#include <openssl/params.h>
25
#include "internal/cryptlib.h"
26
#include "prov/providercommon.h"
27
#include "prov/implementations.h"
28
#include "prov/provider_ctx.h"
29
#include "prov/securitycheck.h"
30
#include "crypto/dh.h"
31
32
static OSSL_FUNC_keyexch_newctx_fn dh_newctx;
33
static OSSL_FUNC_keyexch_init_fn dh_init;
34
static OSSL_FUNC_keyexch_set_peer_fn dh_set_peer;
35
static OSSL_FUNC_keyexch_derive_fn dh_derive;
36
static OSSL_FUNC_keyexch_freectx_fn dh_freectx;
37
static OSSL_FUNC_keyexch_dupctx_fn dh_dupctx;
38
static OSSL_FUNC_keyexch_set_ctx_params_fn dh_set_ctx_params;
39
static OSSL_FUNC_keyexch_settable_ctx_params_fn dh_settable_ctx_params;
40
static OSSL_FUNC_keyexch_get_ctx_params_fn dh_get_ctx_params;
41
static OSSL_FUNC_keyexch_gettable_ctx_params_fn dh_gettable_ctx_params;
42
43
/*
44
 * This type is only really used to handle some legacy related functionality.
45
 * If you need to use other KDF's (such as SSKDF) just use PROV_DH_KDF_NONE
46
 * here and then create and run a KDF after the key is derived.
47
 * Note that X942 has 2 variants of key derivation:
48
 *   (1) DH_KDF_X9_42_ASN1 - which contains an ANS1 encoded object that has
49
 *   the counter embedded in it.
50
 *   (2) DH_KDF_X941_CONCAT - which is the same as ECDH_X963_KDF (which can be
51
 *       done by creating a "X963KDF".
52
 */
53
enum kdf_type {
54
    PROV_DH_KDF_NONE = 0,
55
    PROV_DH_KDF_X9_42_ASN1
56
};
57
58
/*
59
 * What's passed as an actual key is defined by the KEYMGMT interface.
60
 * We happen to know that our KEYMGMT simply passes DH structures, so
61
 * we use that here too.
62
 */
63
64
typedef struct {
65
    OSSL_LIB_CTX *libctx;
66
    DH *dh;
67
    DH *dhpeer;
68
    unsigned int pad : 1;
69
70
    /* DH KDF */
71
    /* KDF (if any) to use for DH */
72
    enum kdf_type kdf_type;
73
    /* Message digest to use for key derivation */
74
    EVP_MD *kdf_md;
75
    /* User key material */
76
    unsigned char *kdf_ukm;
77
    size_t kdf_ukmlen;
78
    /* KDF output length */
79
    size_t kdf_outlen;
80
    char *kdf_cekalg;
81
    OSSL_FIPS_IND_DECLARE
82
} PROV_DH_CTX;
83
84
static void *dh_newctx(void *provctx)
85
0
{
86
0
    PROV_DH_CTX *pdhctx;
87
88
0
    if (!ossl_prov_is_running())
89
0
        return NULL;
90
91
0
    pdhctx = OPENSSL_zalloc(sizeof(PROV_DH_CTX));
92
0
    if (pdhctx == NULL)
93
0
        return NULL;
94
0
    OSSL_FIPS_IND_INIT(pdhctx)
95
0
    pdhctx->libctx = PROV_LIBCTX_OF(provctx);
96
0
    pdhctx->kdf_type = PROV_DH_KDF_NONE;
97
0
    return pdhctx;
98
0
}
99
100
#ifdef FIPS_MODULE
101
static int dh_check_key(PROV_DH_CTX *ctx)
102
{
103
    int key_approved = ossl_dh_check_key(ctx->dh);
104
105
    if (!key_approved) {
106
        if (!OSSL_FIPS_IND_ON_UNAPPROVED(ctx, OSSL_FIPS_IND_SETTABLE0,
107
                                         ctx->libctx, "DH Init", "DH Key",
108
                                         ossl_fips_config_securitycheck_enabled)) {
109
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
110
            return 0;
111
        }
112
    }
113
    return 1;
114
}
115
116
static int digest_check(PROV_DH_CTX *ctx, const EVP_MD *md)
117
{
118
    return ossl_fips_ind_digest_exch_check(OSSL_FIPS_IND_GET(ctx),
119
                                           OSSL_FIPS_IND_SETTABLE1, ctx->libctx,
120
                                           md, "DH Set Ctx");
121
}
122
#endif
123
124
static int dh_init(void *vpdhctx, void *vdh, const OSSL_PARAM params[])
125
0
{
126
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
127
128
0
    if (!ossl_prov_is_running()
129
0
            || pdhctx == NULL
130
0
            || vdh == NULL
131
0
            || !DH_up_ref(vdh))
132
0
        return 0;
133
0
    DH_free(pdhctx->dh);
134
0
    pdhctx->dh = vdh;
135
0
    pdhctx->kdf_type = PROV_DH_KDF_NONE;
136
137
0
    OSSL_FIPS_IND_SET_APPROVED(pdhctx)
138
0
    if (!dh_set_ctx_params(pdhctx, params))
139
0
        return 0;
140
#ifdef FIPS_MODULE
141
    if (!dh_check_key(pdhctx))
142
        return 0;
143
#endif
144
0
    return 1;
145
0
}
146
147
/* The 2 parties must share the same domain parameters */
148
static int dh_match_params(DH *priv, DH *peer)
149
0
{
150
0
    int ret;
151
0
    FFC_PARAMS *dhparams_priv = ossl_dh_get0_params(priv);
152
0
    FFC_PARAMS *dhparams_peer = ossl_dh_get0_params(peer);
153
154
0
    ret = dhparams_priv != NULL
155
0
          && dhparams_peer != NULL
156
0
          && ossl_ffc_params_cmp(dhparams_priv, dhparams_peer, 1);
157
0
    if (!ret)
158
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISMATCHING_DOMAIN_PARAMETERS);
159
0
    return ret;
160
0
}
161
162
static int dh_set_peer(void *vpdhctx, void *vdh)
163
0
{
164
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
165
166
0
    if (!ossl_prov_is_running()
167
0
            || pdhctx == NULL
168
0
            || vdh == NULL
169
0
            || !dh_match_params(vdh, pdhctx->dh)
170
0
            || !DH_up_ref(vdh))
171
0
        return 0;
172
0
    DH_free(pdhctx->dhpeer);
173
0
    pdhctx->dhpeer = vdh;
174
0
    return 1;
175
0
}
176
177
static int dh_plain_derive(void *vpdhctx,
178
                           unsigned char *secret, size_t *secretlen,
179
                           size_t outlen, unsigned int pad)
180
0
{
181
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
182
0
    int ret;
183
0
    size_t dhsize;
184
0
    const BIGNUM *pub_key = NULL;
185
186
0
    if (pdhctx->dh == NULL || pdhctx->dhpeer == NULL) {
187
0
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
188
0
        return 0;
189
0
    }
190
191
0
    dhsize = (size_t)DH_size(pdhctx->dh);
192
0
    if (secret == NULL) {
193
0
        *secretlen = dhsize;
194
0
        return 1;
195
0
    }
196
0
    if (outlen < dhsize) {
197
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
198
0
        return 0;
199
0
    }
200
201
0
    DH_get0_key(pdhctx->dhpeer, &pub_key, NULL);
202
0
    if (pad)
203
0
        ret = DH_compute_key_padded(secret, pub_key, pdhctx->dh);
204
0
    else
205
0
        ret = DH_compute_key(secret, pub_key, pdhctx->dh);
206
0
    if (ret <= 0)
207
0
        return 0;
208
209
0
    *secretlen = ret;
210
0
    return 1;
211
0
}
212
213
static int dh_X9_42_kdf_derive(void *vpdhctx, unsigned char *secret,
214
                               size_t *secretlen, size_t outlen)
215
0
{
216
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
217
0
    unsigned char *stmp = NULL;
218
0
    size_t stmplen;
219
0
    int ret = 0;
220
221
0
    if (secret == NULL) {
222
0
        *secretlen = pdhctx->kdf_outlen;
223
0
        return 1;
224
0
    }
225
226
0
    if (pdhctx->kdf_outlen > outlen) {
227
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
228
0
        return 0;
229
0
    }
230
0
    if (!dh_plain_derive(pdhctx, NULL, &stmplen, 0, 1))
231
0
        return 0;
232
0
    if ((stmp = OPENSSL_secure_malloc(stmplen)) == NULL)
233
0
        return 0;
234
0
    if (!dh_plain_derive(pdhctx, stmp, &stmplen, stmplen, 1))
235
0
        goto err;
236
237
    /* Do KDF stuff */
238
0
    if (pdhctx->kdf_type == PROV_DH_KDF_X9_42_ASN1) {
239
0
        if (!ossl_dh_kdf_X9_42_asn1(secret, pdhctx->kdf_outlen,
240
0
                                    stmp, stmplen,
241
0
                                    pdhctx->kdf_cekalg,
242
0
                                    pdhctx->kdf_ukm,
243
0
                                    pdhctx->kdf_ukmlen,
244
0
                                    pdhctx->kdf_md,
245
0
                                    pdhctx->libctx, NULL))
246
0
            goto err;
247
0
    }
248
0
    *secretlen = pdhctx->kdf_outlen;
249
0
    ret = 1;
250
0
err:
251
0
    OPENSSL_secure_clear_free(stmp, stmplen);
252
0
    return ret;
253
0
}
254
255
static int dh_derive(void *vpdhctx, unsigned char *secret,
256
                     size_t *psecretlen, size_t outlen)
257
0
{
258
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
259
260
0
    if (!ossl_prov_is_running())
261
0
        return 0;
262
263
0
    switch (pdhctx->kdf_type) {
264
0
        case PROV_DH_KDF_NONE:
265
0
            return dh_plain_derive(pdhctx, secret, psecretlen, outlen,
266
0
                                   pdhctx->pad);
267
0
        case PROV_DH_KDF_X9_42_ASN1:
268
0
            return dh_X9_42_kdf_derive(pdhctx, secret, psecretlen, outlen);
269
0
        default:
270
0
            break;
271
0
    }
272
0
    return 0;
273
0
}
274
275
static void dh_freectx(void *vpdhctx)
276
0
{
277
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
278
279
0
    OPENSSL_free(pdhctx->kdf_cekalg);
280
0
    DH_free(pdhctx->dh);
281
0
    DH_free(pdhctx->dhpeer);
282
0
    EVP_MD_free(pdhctx->kdf_md);
283
0
    OPENSSL_clear_free(pdhctx->kdf_ukm, pdhctx->kdf_ukmlen);
284
285
0
    OPENSSL_free(pdhctx);
286
0
}
287
288
static void *dh_dupctx(void *vpdhctx)
289
0
{
290
0
    PROV_DH_CTX *srcctx = (PROV_DH_CTX *)vpdhctx;
291
0
    PROV_DH_CTX *dstctx;
292
293
0
    if (!ossl_prov_is_running())
294
0
        return NULL;
295
296
0
    dstctx = OPENSSL_zalloc(sizeof(*srcctx));
297
0
    if (dstctx == NULL)
298
0
        return NULL;
299
300
0
    *dstctx = *srcctx;
301
0
    dstctx->dh = NULL;
302
0
    dstctx->dhpeer = NULL;
303
0
    dstctx->kdf_md = NULL;
304
0
    dstctx->kdf_ukm = NULL;
305
0
    dstctx->kdf_cekalg = NULL;
306
307
0
    if (srcctx->dh != NULL && !DH_up_ref(srcctx->dh))
308
0
        goto err;
309
0
    else
310
0
        dstctx->dh = srcctx->dh;
311
312
0
    if (srcctx->dhpeer != NULL && !DH_up_ref(srcctx->dhpeer))
313
0
        goto err;
314
0
    else
315
0
        dstctx->dhpeer = srcctx->dhpeer;
316
317
0
    if (srcctx->kdf_md != NULL && !EVP_MD_up_ref(srcctx->kdf_md))
318
0
        goto err;
319
0
    else
320
0
        dstctx->kdf_md = srcctx->kdf_md;
321
322
    /* Duplicate UKM data if present */
323
0
    if (srcctx->kdf_ukm != NULL && srcctx->kdf_ukmlen > 0) {
324
0
        dstctx->kdf_ukm = OPENSSL_memdup(srcctx->kdf_ukm,
325
0
                                         srcctx->kdf_ukmlen);
326
0
        if (dstctx->kdf_ukm == NULL)
327
0
            goto err;
328
0
    }
329
330
0
    if (srcctx->kdf_cekalg != NULL) {
331
0
        dstctx->kdf_cekalg = OPENSSL_strdup(srcctx->kdf_cekalg);
332
0
        if (dstctx->kdf_cekalg == NULL)
333
0
            goto err;
334
0
    }
335
336
0
    return dstctx;
337
0
err:
338
0
    dh_freectx(dstctx);
339
0
    return NULL;
340
0
}
341
342
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
343
#ifndef dh_set_ctx_params_list
344
static const OSSL_PARAM dh_set_ctx_params_list[] = {
345
    OSSL_PARAM_int(OSSL_EXCHANGE_PARAM_PAD, NULL),
346
    OSSL_PARAM_utf8_string(OSSL_EXCHANGE_PARAM_KDF_TYPE, NULL, 0),
347
    OSSL_PARAM_utf8_string(OSSL_EXCHANGE_PARAM_KDF_DIGEST, NULL, 0),
348
    OSSL_PARAM_utf8_string(OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS, NULL, 0),
349
    OSSL_PARAM_size_t(OSSL_EXCHANGE_PARAM_KDF_OUTLEN, NULL),
350
    OSSL_PARAM_octet_string(OSSL_EXCHANGE_PARAM_KDF_UKM, NULL, 0),
351
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_CEK_ALG, NULL, 0),
352
# if defined(FIPS_MODULE)
353
    OSSL_PARAM_int(OSSL_EXCHANGE_PARAM_FIPS_KEY_CHECK, NULL),
354
# endif
355
# if defined(FIPS_MODULE)
356
    OSSL_PARAM_int(OSSL_EXCHANGE_PARAM_FIPS_DIGEST_CHECK, NULL),
357
# endif
358
    OSSL_PARAM_END
359
};
360
#endif
361
362
#ifndef dh_set_ctx_params_st
363
struct dh_set_ctx_params_st {
364
    OSSL_PARAM *cekalg;
365
    OSSL_PARAM *digest;
366
# if defined(FIPS_MODULE)
367
    OSSL_PARAM *ind_d;
368
# endif
369
# if defined(FIPS_MODULE)
370
    OSSL_PARAM *ind_k;
371
# endif
372
    OSSL_PARAM *kdf;
373
    OSSL_PARAM *len;
374
    OSSL_PARAM *pad;
375
    OSSL_PARAM *propq;
376
    OSSL_PARAM *ukm;
377
};
378
#endif
379
380
#ifndef dh_set_ctx_params_decoder
381
static int dh_set_ctx_params_decoder
382
    (const OSSL_PARAM *p, struct dh_set_ctx_params_st *r)
383
0
{
384
0
    const char *s;
385
386
0
    memset(r, 0, sizeof(*r));
387
0
    if (p != NULL)
388
0
        for (; (s = p->key) != NULL; p++)
389
0
            switch(s[0]) {
390
0
            default:
391
0
                break;
392
0
            case 'c':
393
0
                if (ossl_likely(strcmp("ekalg", s + 1) == 0)) {
394
                    /* KDF_PARAM_CEK_ALG */
395
0
                    if (ossl_unlikely(r->cekalg != NULL)) {
396
0
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
397
0
                                       "param %s is repeated", s);
398
0
                        return 0;
399
0
                    }
400
0
                    r->cekalg = (OSSL_PARAM *)p;
401
0
                }
402
0
                break;
403
0
            case 'd':
404
# if defined(FIPS_MODULE)
405
                if (ossl_likely(strcmp("igest-check", s + 1) == 0)) {
406
                    /* EXCHANGE_PARAM_FIPS_DIGEST_CHECK */
407
                    if (ossl_unlikely(r->ind_d != NULL)) {
408
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
409
                                       "param %s is repeated", s);
410
                        return 0;
411
                    }
412
                    r->ind_d = (OSSL_PARAM *)p;
413
                }
414
# endif
415
0
                break;
416
0
            case 'k':
417
0
                switch(s[1]) {
418
0
                default:
419
0
                    break;
420
0
                case 'd':
421
0
                    switch(s[2]) {
422
0
                    default:
423
0
                        break;
424
0
                    case 'f':
425
0
                        switch(s[3]) {
426
0
                        default:
427
0
                            break;
428
0
                        case '-':
429
0
                            switch(s[4]) {
430
0
                            default:
431
0
                                break;
432
0
                            case 'd':
433
0
                                switch(s[5]) {
434
0
                                default:
435
0
                                    break;
436
0
                                case 'i':
437
0
                                    switch(s[6]) {
438
0
                                    default:
439
0
                                        break;
440
0
                                    case 'g':
441
0
                                        switch(s[7]) {
442
0
                                        default:
443
0
                                            break;
444
0
                                        case 'e':
445
0
                                            switch(s[8]) {
446
0
                                            default:
447
0
                                                break;
448
0
                                            case 's':
449
0
                                                switch(s[9]) {
450
0
                                                default:
451
0
                                                    break;
452
0
                                                case 't':
453
0
                                                    switch(s[10]) {
454
0
                                                    default:
455
0
                                                        break;
456
0
                                                    case '-':
457
0
                                                        if (ossl_likely(strcmp("props", s + 11) == 0)) {
458
                                                            /* EXCHANGE_PARAM_KDF_DIGEST_PROPS */
459
0
                                                            if (ossl_unlikely(r->propq != NULL)) {
460
0
                                                                ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
461
0
                                                                               "param %s is repeated", s);
462
0
                                                                return 0;
463
0
                                                            }
464
0
                                                            r->propq = (OSSL_PARAM *)p;
465
0
                                                        }
466
0
                                                        break;
467
0
                                                    case '\0':
468
0
                                                        if (ossl_unlikely(r->digest != NULL)) {
469
0
                                                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
470
0
                                                                           "param %s is repeated", s);
471
0
                                                            return 0;
472
0
                                                        }
473
0
                                                        r->digest = (OSSL_PARAM *)p;
474
0
                                                    }
475
0
                                                }
476
0
                                            }
477
0
                                        }
478
0
                                    }
479
0
                                }
480
0
                                break;
481
0
                            case 'o':
482
0
                                if (ossl_likely(strcmp("utlen", s + 5) == 0)) {
483
                                    /* EXCHANGE_PARAM_KDF_OUTLEN */
484
0
                                    if (ossl_unlikely(r->len != NULL)) {
485
0
                                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
486
0
                                                       "param %s is repeated", s);
487
0
                                        return 0;
488
0
                                    }
489
0
                                    r->len = (OSSL_PARAM *)p;
490
0
                                }
491
0
                                break;
492
0
                            case 't':
493
0
                                if (ossl_likely(strcmp("ype", s + 5) == 0)) {
494
                                    /* EXCHANGE_PARAM_KDF_TYPE */
495
0
                                    if (ossl_unlikely(r->kdf != NULL)) {
496
0
                                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
497
0
                                                       "param %s is repeated", s);
498
0
                                        return 0;
499
0
                                    }
500
0
                                    r->kdf = (OSSL_PARAM *)p;
501
0
                                }
502
0
                                break;
503
0
                            case 'u':
504
0
                                if (ossl_likely(strcmp("km", s + 5) == 0)) {
505
                                    /* EXCHANGE_PARAM_KDF_UKM */
506
0
                                    if (ossl_unlikely(r->ukm != NULL)) {
507
0
                                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
508
0
                                                       "param %s is repeated", s);
509
0
                                        return 0;
510
0
                                    }
511
0
                                    r->ukm = (OSSL_PARAM *)p;
512
0
                                }
513
0
                            }
514
0
                        }
515
0
                    }
516
0
                    break;
517
0
                case 'e':
518
# if defined(FIPS_MODULE)
519
                    if (ossl_likely(strcmp("y-check", s + 2) == 0)) {
520
                        /* EXCHANGE_PARAM_FIPS_KEY_CHECK */
521
                        if (ossl_unlikely(r->ind_k != NULL)) {
522
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
523
                                           "param %s is repeated", s);
524
                            return 0;
525
                        }
526
                        r->ind_k = (OSSL_PARAM *)p;
527
                    }
528
# endif
529
0
                    break;
530
0
                }
531
0
                break;
532
0
            case 'p':
533
0
                if (ossl_likely(strcmp("ad", s + 1) == 0)) {
534
                    /* EXCHANGE_PARAM_PAD */
535
0
                    if (ossl_unlikely(r->pad != NULL)) {
536
0
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
537
0
                                       "param %s is repeated", s);
538
0
                        return 0;
539
0
                    }
540
0
                    r->pad = (OSSL_PARAM *)p;
541
0
                }
542
0
            }
543
0
    return 1;
544
0
}
545
#endif
546
/* End of machine generated */
547
548
static int dh_set_ctx_params(void *vpdhctx, const OSSL_PARAM params[])
549
0
{
550
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
551
0
    struct dh_set_ctx_params_st p;
552
0
    unsigned int pad;
553
0
    char name[80] = { '\0' }; /* should be big enough */
554
0
    char *str = NULL;
555
556
0
    if (pdhctx == NULL || !dh_set_ctx_params_decoder(params, &p))
557
0
        return 0;
558
559
0
    if (!OSSL_FIPS_IND_SET_CTX_FROM_PARAM(pdhctx, OSSL_FIPS_IND_SETTABLE0, p.ind_k))
560
0
        return 0;
561
0
    if (!OSSL_FIPS_IND_SET_CTX_FROM_PARAM(pdhctx, OSSL_FIPS_IND_SETTABLE1, p.ind_d))
562
0
        return 0;
563
564
0
    if (p.kdf != NULL) {
565
0
        str = name;
566
0
        if (!OSSL_PARAM_get_utf8_string(p.kdf, &str, sizeof(name)))
567
0
            return 0;
568
569
0
        if (name[0] == '\0')
570
0
            pdhctx->kdf_type = PROV_DH_KDF_NONE;
571
0
        else if (strcmp(name, OSSL_KDF_NAME_X942KDF_ASN1) == 0)
572
0
            pdhctx->kdf_type = PROV_DH_KDF_X9_42_ASN1;
573
0
        else
574
0
            return 0;
575
0
    }
576
577
0
    if (p.digest != NULL) {
578
0
        char mdprops[80] = { '\0' }; /* should be big enough */
579
580
0
        str = name;
581
0
        if (!OSSL_PARAM_get_utf8_string(p.digest, &str, sizeof(name)))
582
0
            return 0;
583
584
0
        str = mdprops;
585
0
        if (p.propq != NULL) {
586
0
            if (!OSSL_PARAM_get_utf8_string(p.propq, &str, sizeof(mdprops)))
587
0
                return 0;
588
0
        }
589
590
0
        EVP_MD_free(pdhctx->kdf_md);
591
0
        pdhctx->kdf_md = EVP_MD_fetch(pdhctx->libctx, name, mdprops);
592
0
        if (pdhctx->kdf_md == NULL)
593
0
            return 0;
594
        /* XOF digests are not allowed */
595
0
        if (EVP_MD_xof(pdhctx->kdf_md)) {
596
0
            ERR_raise(ERR_LIB_PROV, PROV_R_XOF_DIGESTS_NOT_ALLOWED);
597
0
            return 0;
598
0
        }
599
#ifdef FIPS_MODULE
600
        if (!digest_check(pdhctx, pdhctx->kdf_md)) {
601
            EVP_MD_free(pdhctx->kdf_md);
602
            pdhctx->kdf_md = NULL;
603
            return 0;
604
        }
605
#endif
606
0
    }
607
608
0
    if (p.len != NULL) {
609
0
        size_t outlen;
610
611
0
        if (!OSSL_PARAM_get_size_t(p.len, &outlen))
612
0
            return 0;
613
0
        pdhctx->kdf_outlen = outlen;
614
0
    }
615
616
0
    if (p.ukm != NULL) {
617
0
        void *tmp_ukm = NULL;
618
0
        size_t tmp_ukmlen;
619
620
0
        OPENSSL_free(pdhctx->kdf_ukm);
621
0
        pdhctx->kdf_ukm = NULL;
622
0
        pdhctx->kdf_ukmlen = 0;
623
        /* ukm is an optional field so it can be NULL */
624
0
        if (p.ukm->data != NULL && p.ukm->data_size != 0) {
625
0
            if (!OSSL_PARAM_get_octet_string(p.ukm, &tmp_ukm, 0, &tmp_ukmlen))
626
0
                return 0;
627
0
            pdhctx->kdf_ukm = tmp_ukm;
628
0
            pdhctx->kdf_ukmlen = tmp_ukmlen;
629
0
        }
630
0
    }
631
632
0
    if (p.pad != NULL) {
633
0
        if (!OSSL_PARAM_get_uint(p.pad, &pad))
634
0
            return 0;
635
0
        pdhctx->pad = pad ? 1 : 0;
636
0
    }
637
638
0
    if (p.cekalg != NULL) {
639
0
        str = name;
640
641
0
        OPENSSL_free(pdhctx->kdf_cekalg);
642
0
        pdhctx->kdf_cekalg = NULL;
643
0
        if (p.cekalg->data != NULL && p.cekalg->data_size != 0) {
644
0
            if (!OSSL_PARAM_get_utf8_string(p.cekalg, &str, sizeof(name)))
645
0
                return 0;
646
0
            pdhctx->kdf_cekalg = OPENSSL_strdup(name);
647
0
            if (pdhctx->kdf_cekalg == NULL)
648
0
                return 0;
649
0
        }
650
0
    }
651
0
    return 1;
652
0
}
653
654
static const OSSL_PARAM *dh_settable_ctx_params(ossl_unused void *vpdhctx,
655
                                                ossl_unused void *provctx)
656
0
{
657
0
    return dh_set_ctx_params_list;
658
0
}
659
660
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
661
#ifndef dh_get_ctx_params_list
662
static const OSSL_PARAM dh_get_ctx_params_list[] = {
663
    OSSL_PARAM_utf8_string(OSSL_EXCHANGE_PARAM_KDF_TYPE, NULL, 0),
664
    OSSL_PARAM_utf8_string(OSSL_EXCHANGE_PARAM_KDF_DIGEST, NULL, 0),
665
    OSSL_PARAM_size_t(OSSL_EXCHANGE_PARAM_KDF_OUTLEN, NULL),
666
    OSSL_PARAM_octet_ptr(OSSL_EXCHANGE_PARAM_KDF_UKM, NULL, 0),
667
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_CEK_ALG, NULL, 0),
668
# if defined(FIPS_MODULE)
669
    OSSL_PARAM_int(OSSL_ALG_PARAM_FIPS_APPROVED_INDICATOR, NULL),
670
# endif
671
    OSSL_PARAM_END
672
};
673
#endif
674
675
#ifndef dh_get_ctx_params_st
676
struct dh_get_ctx_params_st {
677
    OSSL_PARAM *cekalg;
678
    OSSL_PARAM *digest;
679
# if defined(FIPS_MODULE)
680
    OSSL_PARAM *ind;
681
# endif
682
    OSSL_PARAM *kdf;
683
    OSSL_PARAM *len;
684
    OSSL_PARAM *ukm;
685
};
686
#endif
687
688
#ifndef dh_get_ctx_params_decoder
689
static int dh_get_ctx_params_decoder
690
    (const OSSL_PARAM *p, struct dh_get_ctx_params_st *r)
691
0
{
692
0
    const char *s;
693
694
0
    memset(r, 0, sizeof(*r));
695
0
    if (p != NULL)
696
0
        for (; (s = p->key) != NULL; p++)
697
0
            switch(s[0]) {
698
0
            default:
699
0
                break;
700
0
            case 'c':
701
0
                if (ossl_likely(strcmp("ekalg", s + 1) == 0)) {
702
                    /* KDF_PARAM_CEK_ALG */
703
0
                    if (ossl_unlikely(r->cekalg != NULL)) {
704
0
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
705
0
                                       "param %s is repeated", s);
706
0
                        return 0;
707
0
                    }
708
0
                    r->cekalg = (OSSL_PARAM *)p;
709
0
                }
710
0
                break;
711
0
            case 'f':
712
# if defined(FIPS_MODULE)
713
                if (ossl_likely(strcmp("ips-indicator", s + 1) == 0)) {
714
                    /* ALG_PARAM_FIPS_APPROVED_INDICATOR */
715
                    if (ossl_unlikely(r->ind != NULL)) {
716
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
717
                                       "param %s is repeated", s);
718
                        return 0;
719
                    }
720
                    r->ind = (OSSL_PARAM *)p;
721
                }
722
# endif
723
0
                break;
724
0
            case 'k':
725
0
                switch(s[1]) {
726
0
                default:
727
0
                    break;
728
0
                case 'd':
729
0
                    switch(s[2]) {
730
0
                    default:
731
0
                        break;
732
0
                    case 'f':
733
0
                        switch(s[3]) {
734
0
                        default:
735
0
                            break;
736
0
                        case '-':
737
0
                            switch(s[4]) {
738
0
                            default:
739
0
                                break;
740
0
                            case 'd':
741
0
                                if (ossl_likely(strcmp("igest", s + 5) == 0)) {
742
                                    /* EXCHANGE_PARAM_KDF_DIGEST */
743
0
                                    if (ossl_unlikely(r->digest != NULL)) {
744
0
                                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
745
0
                                                       "param %s is repeated", s);
746
0
                                        return 0;
747
0
                                    }
748
0
                                    r->digest = (OSSL_PARAM *)p;
749
0
                                }
750
0
                                break;
751
0
                            case 'o':
752
0
                                if (ossl_likely(strcmp("utlen", s + 5) == 0)) {
753
                                    /* EXCHANGE_PARAM_KDF_OUTLEN */
754
0
                                    if (ossl_unlikely(r->len != NULL)) {
755
0
                                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
756
0
                                                       "param %s is repeated", s);
757
0
                                        return 0;
758
0
                                    }
759
0
                                    r->len = (OSSL_PARAM *)p;
760
0
                                }
761
0
                                break;
762
0
                            case 't':
763
0
                                if (ossl_likely(strcmp("ype", s + 5) == 0)) {
764
                                    /* EXCHANGE_PARAM_KDF_TYPE */
765
0
                                    if (ossl_unlikely(r->kdf != NULL)) {
766
0
                                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
767
0
                                                       "param %s is repeated", s);
768
0
                                        return 0;
769
0
                                    }
770
0
                                    r->kdf = (OSSL_PARAM *)p;
771
0
                                }
772
0
                                break;
773
0
                            case 'u':
774
0
                                if (ossl_likely(strcmp("km", s + 5) == 0)) {
775
                                    /* EXCHANGE_PARAM_KDF_UKM */
776
0
                                    if (ossl_unlikely(r->ukm != NULL)) {
777
0
                                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
778
0
                                                       "param %s is repeated", s);
779
0
                                        return 0;
780
0
                                    }
781
0
                                    r->ukm = (OSSL_PARAM *)p;
782
0
                                }
783
0
                            }
784
0
                        }
785
0
                    }
786
0
                }
787
0
            }
788
0
    return 1;
789
0
}
790
#endif
791
/* End of machine generated */
792
793
static const OSSL_PARAM *dh_gettable_ctx_params(ossl_unused void *vpdhctx,
794
                                                ossl_unused void *provctx)
795
0
{
796
0
    return dh_get_ctx_params_list;
797
0
}
798
799
static int dh_get_ctx_params(void *vpdhctx, OSSL_PARAM params[])
800
0
{
801
0
    PROV_DH_CTX *pdhctx = (PROV_DH_CTX *)vpdhctx;
802
0
    struct dh_get_ctx_params_st p;
803
804
0
    if (pdhctx == NULL || !dh_get_ctx_params_decoder(params, &p))
805
0
        return 0;
806
807
0
    if (p.kdf != NULL) {
808
0
        const char *kdf_type = NULL;
809
810
0
        switch (pdhctx->kdf_type) {
811
0
        case PROV_DH_KDF_NONE:
812
0
            kdf_type = "";
813
0
            break;
814
0
        case PROV_DH_KDF_X9_42_ASN1:
815
0
            kdf_type = OSSL_KDF_NAME_X942KDF_ASN1;
816
0
            break;
817
0
        default:
818
0
            return 0;
819
0
        }
820
821
0
        if (!OSSL_PARAM_set_utf8_string(p.kdf, kdf_type))
822
0
            return 0;
823
0
    }
824
825
0
    if (p.digest != NULL
826
0
            && !OSSL_PARAM_set_utf8_string(p.digest, pdhctx->kdf_md == NULL
827
0
                                           ? ""
828
0
                                           : EVP_MD_get0_name(pdhctx->kdf_md))) {
829
0
        return 0;
830
0
    }
831
832
0
    if (p.len != NULL && !OSSL_PARAM_set_size_t(p.len, pdhctx->kdf_outlen))
833
0
        return 0;
834
835
0
    if (p.ukm != NULL
836
0
        && !OSSL_PARAM_set_octet_ptr(p.ukm, pdhctx->kdf_ukm, pdhctx->kdf_ukmlen))
837
0
        return 0;
838
839
0
    if (p.cekalg != NULL
840
0
            && !OSSL_PARAM_set_utf8_string(p.cekalg, pdhctx->kdf_cekalg == NULL
841
0
                                           ? "" :  pdhctx->kdf_cekalg))
842
0
        return 0;
843
844
0
    if (!OSSL_FIPS_IND_GET_CTX_FROM_PARAM(pdhctx, p.ind))
845
0
        return 0;
846
0
    return 1;
847
0
}
848
849
const OSSL_DISPATCH ossl_dh_keyexch_functions[] = {
850
    { OSSL_FUNC_KEYEXCH_NEWCTX, (void (*)(void))dh_newctx },
851
    { OSSL_FUNC_KEYEXCH_INIT, (void (*)(void))dh_init },
852
    { OSSL_FUNC_KEYEXCH_DERIVE, (void (*)(void))dh_derive },
853
    { OSSL_FUNC_KEYEXCH_SET_PEER, (void (*)(void))dh_set_peer },
854
    { OSSL_FUNC_KEYEXCH_FREECTX, (void (*)(void))dh_freectx },
855
    { OSSL_FUNC_KEYEXCH_DUPCTX, (void (*)(void))dh_dupctx },
856
    { OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS, (void (*)(void))dh_set_ctx_params },
857
    { OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS,
858
      (void (*)(void))dh_settable_ctx_params },
859
    { OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS, (void (*)(void))dh_get_ctx_params },
860
    { OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS,
861
      (void (*)(void))dh_gettable_ctx_params },
862
    OSSL_DISPATCH_END
863
};