Coverage Report

Created: 2025-11-16 06:40

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl35/providers/implementations/keymgmt/dh_kmgmt.c
Line
Count
Source
1
/*
2
 * Copyright 2019-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
 * DH low level APIs are deprecated for public use, but still ok for
12
 * internal use.
13
 */
14
#include "internal/deprecated.h"
15
#include "internal/common.h"
16
17
#include <string.h> /* strcmp */
18
#include <openssl/core_dispatch.h>
19
#include <openssl/core_names.h>
20
#include <openssl/bn.h>
21
#include <openssl/err.h>
22
#include <openssl/self_test.h>
23
#include "prov/implementations.h"
24
#include "prov/providercommon.h"
25
#include "prov/provider_ctx.h"
26
#include "crypto/dh.h"
27
#include "internal/fips.h"
28
#include "internal/sizes.h"
29
30
static OSSL_FUNC_keymgmt_new_fn dh_newdata;
31
static OSSL_FUNC_keymgmt_free_fn dh_freedata;
32
static OSSL_FUNC_keymgmt_gen_init_fn dh_gen_init;
33
static OSSL_FUNC_keymgmt_gen_init_fn dhx_gen_init;
34
static OSSL_FUNC_keymgmt_gen_set_template_fn dh_gen_set_template;
35
static OSSL_FUNC_keymgmt_gen_set_params_fn dh_gen_set_params;
36
static OSSL_FUNC_keymgmt_gen_settable_params_fn dh_gen_settable_params;
37
static OSSL_FUNC_keymgmt_gen_fn dh_gen;
38
static OSSL_FUNC_keymgmt_gen_cleanup_fn dh_gen_cleanup;
39
static OSSL_FUNC_keymgmt_load_fn dh_load;
40
static OSSL_FUNC_keymgmt_get_params_fn dh_get_params;
41
static OSSL_FUNC_keymgmt_gettable_params_fn dh_gettable_params;
42
static OSSL_FUNC_keymgmt_set_params_fn dh_set_params;
43
static OSSL_FUNC_keymgmt_settable_params_fn dh_settable_params;
44
static OSSL_FUNC_keymgmt_has_fn dh_has;
45
static OSSL_FUNC_keymgmt_match_fn dh_match;
46
static OSSL_FUNC_keymgmt_validate_fn dh_validate;
47
static OSSL_FUNC_keymgmt_import_fn dh_import;
48
static OSSL_FUNC_keymgmt_import_types_fn dh_import_types;
49
static OSSL_FUNC_keymgmt_export_fn dh_export;
50
static OSSL_FUNC_keymgmt_export_types_fn dh_export_types;
51
static OSSL_FUNC_keymgmt_dup_fn dh_dup;
52
53
#define DH_POSSIBLE_SELECTIONS                                                 \
54
77.4k
    (OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS)
55
56
struct dh_gen_ctx {
57
    OSSL_LIB_CTX *libctx;
58
59
    FFC_PARAMS *ffc_params;
60
    int selection;
61
    /* All these parameters are used for parameter generation only */
62
    /* If there is a group name then the remaining parameters are not needed */
63
    int group_nid;
64
    size_t pbits;
65
    size_t qbits;
66
    unsigned char *seed; /* optional FIPS186-4 param for testing */
67
    size_t seedlen;
68
    int gindex; /* optional  FIPS186-4 generator index (ignored if -1) */
69
    int gen_type; /* see dhtype2id */
70
    int generator; /* Used by DH_PARAMGEN_TYPE_GENERATOR in non fips mode only */
71
    int pcounter;
72
    int hindex;
73
    int priv_len;
74
75
    char *mdname;
76
    char *mdprops;
77
    OSSL_CALLBACK *cb;
78
    void *cbarg;
79
    int dh_type;
80
};
81
82
static int dh_gen_type_name2id_w_default(const char *name, int type)
83
0
{
84
0
    if (strcmp(name, "default") == 0) {
85
#ifdef FIPS_MODULE
86
        if (type == DH_FLAG_TYPE_DHX)
87
            return DH_PARAMGEN_TYPE_FIPS_186_4;
88
89
        return DH_PARAMGEN_TYPE_GROUP;
90
#else
91
0
        if (type == DH_FLAG_TYPE_DHX)
92
0
            return DH_PARAMGEN_TYPE_FIPS_186_2;
93
94
0
        return DH_PARAMGEN_TYPE_GENERATOR;
95
0
#endif
96
0
    }
97
98
0
    return ossl_dh_gen_type_name2id(name, type);
99
0
}
100
101
static void *dh_newdata(void *provctx)
102
9.31k
{
103
9.31k
    DH *dh = NULL;
104
105
9.31k
    if (ossl_prov_is_running()) {
106
9.31k
        dh = ossl_dh_new_ex(PROV_LIBCTX_OF(provctx));
107
9.31k
        if (dh != NULL) {
108
9.31k
            DH_clear_flags(dh, DH_FLAG_TYPE_MASK);
109
9.31k
            DH_set_flags(dh, DH_FLAG_TYPE_DH);
110
9.31k
        }
111
9.31k
    }
112
9.31k
    return dh;
113
9.31k
}
114
115
static void *dhx_newdata(void *provctx)
116
0
{
117
0
    DH *dh = NULL;
118
119
0
    dh = ossl_dh_new_ex(PROV_LIBCTX_OF(provctx));
120
0
    if (dh != NULL) {
121
0
        DH_clear_flags(dh, DH_FLAG_TYPE_MASK);
122
0
        DH_set_flags(dh, DH_FLAG_TYPE_DHX);
123
0
    }
124
0
    return dh;
125
0
}
126
127
static void dh_freedata(void *keydata)
128
69.2k
{
129
69.2k
    DH_free(keydata);
130
69.2k
}
131
132
static int dh_has(const void *keydata, int selection)
133
9.93k
{
134
9.93k
    const DH *dh = keydata;
135
9.93k
    int ok = 1;
136
137
9.93k
    if (!ossl_prov_is_running() || dh == NULL)
138
0
        return 0;
139
9.93k
    if ((selection & DH_POSSIBLE_SELECTIONS) == 0)
140
0
        return 1; /* the selection is not missing */
141
142
9.93k
    if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
143
9.68k
        ok = ok && (DH_get0_pub_key(dh) != NULL);
144
9.93k
    if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
145
106
        ok = ok && (DH_get0_priv_key(dh) != NULL);
146
9.93k
    if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
147
137
        ok = ok && (DH_get0_p(dh) != NULL && DH_get0_g(dh) != NULL);
148
9.93k
    return ok;
149
9.93k
}
150
151
static int dh_match(const void *keydata1, const void *keydata2, int selection)
152
9.25k
{
153
9.25k
    const DH *dh1 = keydata1;
154
9.25k
    const DH *dh2 = keydata2;
155
9.25k
    int ok = 1;
156
157
9.25k
    if (!ossl_prov_is_running())
158
0
        return 0;
159
160
9.25k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
161
9.25k
        int key_checked = 0;
162
163
9.25k
        if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
164
9.25k
            const BIGNUM *pa = DH_get0_pub_key(dh1);
165
9.25k
            const BIGNUM *pb = DH_get0_pub_key(dh2);
166
167
9.25k
            if (pa != NULL && pb != NULL) {
168
435
                ok = ok && BN_cmp(pa, pb) == 0;
169
435
                key_checked = 1;
170
435
            }
171
9.25k
        }
172
9.25k
        if (!key_checked
173
8.81k
            && (selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
174
8.81k
            const BIGNUM *pa = DH_get0_priv_key(dh1);
175
8.81k
            const BIGNUM *pb = DH_get0_priv_key(dh2);
176
177
8.81k
            if (pa != NULL && pb != NULL) {
178
0
                ok = ok && BN_cmp(pa, pb) == 0;
179
0
                key_checked = 1;
180
0
            }
181
8.81k
        }
182
9.25k
        ok = ok && key_checked;
183
9.25k
    }
184
9.25k
    if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
185
9.25k
        FFC_PARAMS *dhparams1 = ossl_dh_get0_params((DH *)dh1);
186
9.25k
        FFC_PARAMS *dhparams2 = ossl_dh_get0_params((DH *)dh2);
187
188
9.25k
        ok = ok && ossl_ffc_params_cmp(dhparams1, dhparams2, 1);
189
9.25k
    }
190
9.25k
    return ok;
191
9.25k
}
192
193
static int dh_import(void *keydata, int selection, const OSSL_PARAM params[])
194
9.31k
{
195
9.31k
    DH *dh = keydata;
196
9.31k
    int ok = 1;
197
198
9.31k
    if (!ossl_prov_is_running() || dh == NULL)
199
0
        return 0;
200
201
9.31k
    if ((selection & DH_POSSIBLE_SELECTIONS) == 0)
202
0
        return 0;
203
204
    /* a key without parameters is meaningless */
205
9.31k
    ok = ok && ossl_dh_params_fromdata(dh, params);
206
207
9.31k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
208
9.31k
        int include_private =
209
9.31k
            selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
210
211
9.31k
        ok = ok && ossl_dh_key_fromdata(dh, params, include_private);
212
9.31k
    }
213
214
9.31k
    return ok;
215
9.31k
}
216
217
static int dh_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,
218
                     void *cbarg)
219
0
{
220
0
    DH *dh = keydata;
221
0
    OSSL_PARAM_BLD *tmpl = NULL;
222
0
    OSSL_PARAM *params = NULL;
223
0
    int ok = 1;
224
225
0
    if (!ossl_prov_is_running() || dh == NULL)
226
0
        return 0;
227
228
0
    if ((selection & DH_POSSIBLE_SELECTIONS) == 0)
229
0
        return 0;
230
231
0
    tmpl = OSSL_PARAM_BLD_new();
232
0
    if (tmpl == NULL)
233
0
        return 0;
234
235
0
    if ((selection & OSSL_KEYMGMT_SELECT_ALL_PARAMETERS) != 0)
236
0
        ok = ok && ossl_dh_params_todata(dh, tmpl, NULL);
237
238
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
239
0
        int include_private =
240
0
            selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
241
242
0
        ok = ok && ossl_dh_key_todata(dh, tmpl, NULL, include_private);
243
0
    }
244
245
0
    if (!ok || (params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL) {
246
0
        ok = 0;
247
0
        goto err;
248
0
    }
249
250
0
    ok = param_cb(params, cbarg);
251
0
    OSSL_PARAM_free(params);
252
0
err:
253
0
    OSSL_PARAM_BLD_free(tmpl);
254
0
    return ok;
255
0
}
256
257
/* IMEXPORT = IMPORT + EXPORT */
258
259
# define DH_IMEXPORTABLE_PARAMETERS                                            \
260
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_P, NULL, 0),                             \
261
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_Q, NULL, 0),                             \
262
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_G, NULL, 0),                             \
263
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_COFACTOR, NULL, 0),                      \
264
    OSSL_PARAM_int(OSSL_PKEY_PARAM_FFC_GINDEX, NULL),                          \
265
    OSSL_PARAM_int(OSSL_PKEY_PARAM_FFC_PCOUNTER, NULL),                        \
266
    OSSL_PARAM_int(OSSL_PKEY_PARAM_FFC_H, NULL),                               \
267
    OSSL_PARAM_int(OSSL_PKEY_PARAM_DH_PRIV_LEN, NULL),                         \
268
    OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_FFC_SEED, NULL, 0),                \
269
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME, NULL, 0)
270
# define DH_IMEXPORTABLE_PUBLIC_KEY                                            \
271
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0)
272
# define DH_IMEXPORTABLE_PRIVATE_KEY                                           \
273
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0)
274
static const OSSL_PARAM dh_all_types[] = {
275
    DH_IMEXPORTABLE_PARAMETERS,
276
    DH_IMEXPORTABLE_PUBLIC_KEY,
277
    DH_IMEXPORTABLE_PRIVATE_KEY,
278
    OSSL_PARAM_END
279
};
280
static const OSSL_PARAM dh_parameter_types[] = {
281
    DH_IMEXPORTABLE_PARAMETERS,
282
    OSSL_PARAM_END
283
};
284
static const OSSL_PARAM dh_key_types[] = {
285
    DH_IMEXPORTABLE_PUBLIC_KEY,
286
    DH_IMEXPORTABLE_PRIVATE_KEY,
287
    OSSL_PARAM_END
288
};
289
static const OSSL_PARAM *dh_types[] = {
290
    NULL,                        /* Index 0 = none of them */
291
    dh_parameter_types,          /* Index 1 = parameter types */
292
    dh_key_types,                /* Index 2 = key types */
293
    dh_all_types                 /* Index 3 = 1 + 2 */
294
};
295
296
static const OSSL_PARAM *dh_imexport_types(int selection)
297
0
{
298
0
    int type_select = 0;
299
300
0
    if ((selection & OSSL_KEYMGMT_SELECT_ALL_PARAMETERS) != 0)
301
0
        type_select += 1;
302
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
303
0
        type_select += 2;
304
0
    return dh_types[type_select];
305
0
}
306
307
static const OSSL_PARAM *dh_import_types(int selection)
308
0
{
309
0
    return dh_imexport_types(selection);
310
0
}
311
312
static const OSSL_PARAM *dh_export_types(int selection)
313
0
{
314
0
    return dh_imexport_types(selection);
315
0
}
316
317
static ossl_inline int dh_get_params(void *key, OSSL_PARAM params[])
318
66.3k
{
319
66.3k
    DH *dh = key;
320
66.3k
    OSSL_PARAM *p;
321
322
66.3k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
323
58.7k
        && !OSSL_PARAM_set_int(p, DH_bits(dh)))
324
0
        return 0;
325
66.3k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
326
58.7k
        && !OSSL_PARAM_set_int(p, DH_security_bits(dh)))
327
0
        return 0;
328
66.3k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
329
58.7k
        && !OSSL_PARAM_set_int(p, DH_size(dh)))
330
0
        return 0;
331
66.3k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY)) != NULL) {
332
7.63k
        if (p->data_type != OSSL_PARAM_OCTET_STRING)
333
0
            return 0;
334
7.63k
        p->return_size = ossl_dh_key2buf(dh, (unsigned char **)&p->data,
335
7.63k
                                         p->data_size, 0);
336
7.63k
        if (p->return_size == 0)
337
0
            return 0;
338
7.63k
    }
339
340
66.3k
    return ossl_dh_params_todata(dh, NULL, params)
341
66.3k
        && ossl_dh_key_todata(dh, NULL, params, 1);
342
66.3k
}
343
344
static const OSSL_PARAM dh_params[] = {
345
    OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
346
    OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
347
    OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
348
    OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),
349
    DH_IMEXPORTABLE_PARAMETERS,
350
    DH_IMEXPORTABLE_PUBLIC_KEY,
351
    DH_IMEXPORTABLE_PRIVATE_KEY,
352
    OSSL_PARAM_END
353
};
354
355
static const OSSL_PARAM *dh_gettable_params(void *provctx)
356
0
{
357
0
    return dh_params;
358
0
}
359
360
static const OSSL_PARAM dh_known_settable_params[] = {
361
    OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),
362
    OSSL_PARAM_END
363
};
364
365
static const OSSL_PARAM *dh_settable_params(void *provctx)
366
0
{
367
0
    return dh_known_settable_params;
368
0
}
369
370
static int dh_set_params(void *key, const OSSL_PARAM params[])
371
1.41k
{
372
1.41k
    DH *dh = key;
373
1.41k
    const OSSL_PARAM *p;
374
375
1.41k
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY);
376
1.41k
    if (p != NULL
377
1.41k
            && (p->data_type != OSSL_PARAM_OCTET_STRING
378
1.41k
                || !ossl_dh_buf2key(dh, p->data, p->data_size)))
379
30
        return 0;
380
381
1.38k
    return 1;
382
1.41k
}
383
384
static int dh_validate_public(const DH *dh, int checktype)
385
17.1k
{
386
17.1k
    const BIGNUM *pub_key = NULL;
387
17.1k
    int res = 0;
388
389
17.1k
    DH_get0_key(dh, &pub_key, NULL);
390
17.1k
    if (pub_key == NULL)
391
10.5k
        return 0;
392
393
    /*
394
     * The partial test is only valid for named group's with q = (p - 1) / 2
395
     * but for that case it is also fully sufficient to check the key validity.
396
     */
397
6.60k
    if (ossl_dh_is_named_safe_prime_group(dh))
398
312
        return ossl_dh_check_pub_key_partial(dh, pub_key, &res);
399
400
6.29k
    return DH_check_pub_key_ex(dh, pub_key);
401
6.60k
}
402
403
static int dh_validate_private(const DH *dh)
404
9.23k
{
405
9.23k
    int status = 0;
406
9.23k
    const BIGNUM *priv_key = NULL;
407
408
9.23k
    DH_get0_key(dh, NULL, &priv_key);
409
9.23k
    if (priv_key == NULL)
410
9.14k
        return 0;
411
87
    return ossl_dh_check_priv_key(dh, priv_key, &status);
412
9.23k
}
413
414
static int dh_validate(const void *keydata, int selection, int checktype)
415
58.1k
{
416
58.1k
    const DH *dh = keydata;
417
58.1k
    int ok = 1;
418
419
58.1k
    if (!ossl_prov_is_running())
420
0
        return 0;
421
422
58.1k
    if ((selection & DH_POSSIBLE_SELECTIONS) == 0)
423
0
        return 1; /* nothing to validate */
424
425
58.1k
    if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
426
        /*
427
         * Both of these functions check parameters. DH_check_params_ex()
428
         * performs a lightweight check (e.g. it does not check that p is a
429
         * safe prime)
430
         */
431
18.4k
        if (checktype == OSSL_KEYMGMT_VALIDATE_QUICK_CHECK)
432
9.31k
            ok = ok && DH_check_params_ex(dh);
433
9.16k
        else
434
9.16k
            ok = ok && DH_check_ex(dh);
435
18.4k
    }
436
437
58.1k
    if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
438
30.4k
        ok = ok && dh_validate_public(dh, checktype);
439
440
58.1k
    if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
441
18.4k
        ok = ok && dh_validate_private(dh);
442
443
58.1k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR)
444
58.1k
            == OSSL_KEYMGMT_SELECT_KEYPAIR)
445
9.20k
        ok = ok && ossl_dh_check_pairwise(dh, 0);
446
58.1k
    return ok;
447
58.1k
}
448
449
static void *dh_gen_init_base(void *provctx, int selection,
450
                              const OSSL_PARAM params[], int type)
451
6.80k
{
452
6.80k
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
453
6.80k
    struct dh_gen_ctx *gctx = NULL;
454
455
6.80k
    if (!ossl_prov_is_running())
456
0
        return NULL;
457
458
6.80k
    if ((selection & (OSSL_KEYMGMT_SELECT_KEYPAIR
459
6.80k
                      | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS)) == 0)
460
0
        return NULL;
461
462
6.80k
    if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
463
6.80k
        gctx->selection = selection;
464
6.80k
        gctx->libctx = libctx;
465
6.80k
        gctx->pbits = 2048;
466
6.80k
        gctx->qbits = 224;
467
6.80k
        gctx->mdname = NULL;
468
#ifdef FIPS_MODULE
469
        gctx->gen_type = (type == DH_FLAG_TYPE_DHX)
470
                         ? DH_PARAMGEN_TYPE_FIPS_186_4
471
                         : DH_PARAMGEN_TYPE_GROUP;
472
#else
473
6.80k
        gctx->gen_type = (type == DH_FLAG_TYPE_DHX)
474
6.80k
                         ? DH_PARAMGEN_TYPE_FIPS_186_2
475
6.80k
                         : DH_PARAMGEN_TYPE_GENERATOR;
476
6.80k
#endif
477
6.80k
        gctx->gindex = -1;
478
6.80k
        gctx->hindex = 0;
479
6.80k
        gctx->pcounter = -1;
480
6.80k
        gctx->generator = DH_GENERATOR_2;
481
6.80k
        gctx->dh_type = type;
482
6.80k
    }
483
6.80k
    if (!dh_gen_set_params(gctx, params)) {
484
0
        OPENSSL_free(gctx);
485
0
        gctx = NULL;
486
0
    }
487
6.80k
    return gctx;
488
6.80k
}
489
490
static void *dh_gen_init(void *provctx, int selection,
491
                         const OSSL_PARAM params[])
492
6.80k
{
493
6.80k
    return dh_gen_init_base(provctx, selection, params, DH_FLAG_TYPE_DH);
494
6.80k
}
495
496
static void *dhx_gen_init(void *provctx, int selection,
497
                          const OSSL_PARAM params[])
498
0
{
499
0
   return dh_gen_init_base(provctx, selection, params, DH_FLAG_TYPE_DHX);
500
0
}
501
502
static int dh_gen_set_template(void *genctx, void *templ)
503
4.94k
{
504
4.94k
    struct dh_gen_ctx *gctx = genctx;
505
4.94k
    DH *dh = templ;
506
507
4.94k
    if (!ossl_prov_is_running() || gctx == NULL || dh == NULL)
508
0
        return 0;
509
4.94k
    gctx->ffc_params = ossl_dh_get0_params(dh);
510
4.94k
    return 1;
511
4.94k
}
512
513
static int dh_set_gen_seed(struct dh_gen_ctx *gctx, unsigned char *seed,
514
                           size_t seedlen)
515
0
{
516
0
    OPENSSL_clear_free(gctx->seed, gctx->seedlen);
517
0
    gctx->seed = NULL;
518
0
    gctx->seedlen = 0;
519
0
    if (seed != NULL && seedlen > 0) {
520
0
        gctx->seed = OPENSSL_memdup(seed, seedlen);
521
0
        if (gctx->seed == NULL)
522
0
            return 0;
523
0
        gctx->seedlen = seedlen;
524
0
    }
525
0
    return 1;
526
0
}
527
528
static int dh_gen_common_set_params(void *genctx, const OSSL_PARAM params[])
529
1.21k
{
530
1.21k
    struct dh_gen_ctx *gctx = genctx;
531
1.21k
    const OSSL_PARAM *p;
532
1.21k
    int gen_type = -1;
533
534
1.21k
    if (gctx == NULL)
535
0
        return 0;
536
1.21k
    if (ossl_param_is_empty(params))
537
953
        return 1;
538
539
262
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_TYPE);
540
262
    if (p != NULL) {
541
0
        if (p->data_type != OSSL_PARAM_UTF8_STRING
542
0
            || ((gen_type =
543
0
                 dh_gen_type_name2id_w_default(p->data, gctx->dh_type)) == -1)) {
544
0
            ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
545
0
            return 0;
546
0
        }
547
0
        if (gen_type != -1)
548
0
            gctx->gen_type = gen_type;
549
0
    }
550
262
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_GROUP_NAME);
551
262
    if (p != NULL) {
552
262
        const DH_NAMED_GROUP *group = NULL;
553
554
262
        if (p->data_type != OSSL_PARAM_UTF8_STRING
555
262
            || p->data == NULL
556
262
            || (group = ossl_ffc_name_to_dh_named_group(p->data)) == NULL
557
262
            || ((gctx->group_nid =
558
262
                 ossl_ffc_named_group_get_uid(group)) == NID_undef)) {
559
0
            ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
560
0
            return 0;
561
0
        }
562
262
    }
563
262
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_PBITS)) != NULL
564
0
        && !OSSL_PARAM_get_size_t(p, &gctx->pbits))
565
0
        return 0;
566
262
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DH_PRIV_LEN);
567
262
    if (p != NULL && !OSSL_PARAM_get_int(p, &gctx->priv_len))
568
0
        return 0;
569
262
    return 1;
570
262
}
571
572
static const OSSL_PARAM *dh_gen_settable_params(ossl_unused void *genctx,
573
                                                ossl_unused void *provctx)
574
0
{
575
0
    static const OSSL_PARAM dh_gen_settable[] = {
576
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_FFC_TYPE, NULL, 0),
577
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME, NULL, 0),
578
0
        OSSL_PARAM_int(OSSL_PKEY_PARAM_DH_PRIV_LEN, NULL),
579
0
        OSSL_PARAM_size_t(OSSL_PKEY_PARAM_FFC_PBITS, NULL),
580
0
        OSSL_PARAM_int(OSSL_PKEY_PARAM_DH_GENERATOR, NULL),
581
0
        OSSL_PARAM_END
582
0
    };
583
0
    return dh_gen_settable;
584
0
}
585
586
static const OSSL_PARAM *dhx_gen_settable_params(ossl_unused void *genctx,
587
                                                 ossl_unused void *provctx)
588
0
{
589
0
    static const OSSL_PARAM dhx_gen_settable[] = {
590
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_FFC_TYPE, NULL, 0),
591
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME, NULL, 0),
592
0
        OSSL_PARAM_int(OSSL_PKEY_PARAM_DH_PRIV_LEN, NULL),
593
0
        OSSL_PARAM_size_t(OSSL_PKEY_PARAM_FFC_PBITS, NULL),
594
0
        OSSL_PARAM_size_t(OSSL_PKEY_PARAM_FFC_QBITS, NULL),
595
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_FFC_DIGEST, NULL, 0),
596
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_FFC_DIGEST_PROPS, NULL, 0),
597
0
        OSSL_PARAM_int(OSSL_PKEY_PARAM_FFC_GINDEX, NULL),
598
0
        OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_FFC_SEED, NULL, 0),
599
0
        OSSL_PARAM_int(OSSL_PKEY_PARAM_FFC_PCOUNTER, NULL),
600
0
        OSSL_PARAM_int(OSSL_PKEY_PARAM_FFC_H, NULL),
601
0
        OSSL_PARAM_END
602
0
    };
603
0
    return dhx_gen_settable;
604
0
}
605
606
static int dhx_gen_set_params(void *genctx, const OSSL_PARAM params[])
607
0
{
608
0
    struct dh_gen_ctx *gctx = genctx;
609
0
    const OSSL_PARAM *p;
610
611
0
    if (!dh_gen_common_set_params(genctx, params))
612
0
        return 0;
613
614
    /* Parameters related to fips186-4 and fips186-2 */
615
0
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_GINDEX);
616
0
    if (p != NULL && !OSSL_PARAM_get_int(p, &gctx->gindex))
617
0
        return 0;
618
0
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_PCOUNTER);
619
0
    if (p != NULL && !OSSL_PARAM_get_int(p, &gctx->pcounter))
620
0
        return 0;
621
0
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_H);
622
0
    if (p != NULL && !OSSL_PARAM_get_int(p, &gctx->hindex))
623
0
        return 0;
624
0
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_SEED);
625
0
    if (p != NULL
626
0
        && (p->data_type != OSSL_PARAM_OCTET_STRING
627
0
            || !dh_set_gen_seed(gctx, p->data, p->data_size)))
628
0
            return 0;
629
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_QBITS)) != NULL
630
0
        && !OSSL_PARAM_get_size_t(p, &gctx->qbits))
631
0
        return 0;
632
0
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_DIGEST);
633
0
    if (p != NULL) {
634
0
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
635
0
            return 0;
636
0
        OPENSSL_free(gctx->mdname);
637
0
        gctx->mdname = OPENSSL_strdup(p->data);
638
0
        if (gctx->mdname == NULL)
639
0
            return 0;
640
0
    }
641
0
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_DIGEST_PROPS);
642
0
    if (p != NULL) {
643
0
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
644
0
            return 0;
645
0
        OPENSSL_free(gctx->mdprops);
646
0
        gctx->mdprops = OPENSSL_strdup(p->data);
647
0
        if (gctx->mdprops == NULL)
648
0
            return 0;
649
0
    }
650
651
    /* Parameters that are not allowed for DHX */
652
0
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DH_GENERATOR);
653
0
    if (p != NULL) {
654
0
        ERR_raise(ERR_LIB_PROV, ERR_R_UNSUPPORTED);
655
0
        return 0;
656
0
    }
657
0
    return 1;
658
0
}
659
660
static int dh_gen_set_params(void *genctx, const OSSL_PARAM params[])
661
7.26k
{
662
7.26k
    struct dh_gen_ctx *gctx = genctx;
663
7.26k
    const OSSL_PARAM *p;
664
665
7.26k
    if (!dh_gen_common_set_params(genctx, params))
666
0
        return 0;
667
668
7.26k
    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_DH_GENERATOR);
669
7.26k
    if (p != NULL && !OSSL_PARAM_get_int(p, &gctx->generator))
670
0
        return 0;
671
672
    /* Parameters that are not allowed for DH */
673
7.26k
    if (OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_GINDEX) != NULL
674
7.26k
        || OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_PCOUNTER) != NULL
675
7.26k
        || OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_H) != NULL
676
7.26k
        || OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_SEED) != NULL
677
7.26k
        || OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_QBITS) != NULL
678
7.26k
        || OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_FFC_DIGEST) != NULL
679
7.26k
        || OSSL_PARAM_locate_const(params,
680
7.26k
                                   OSSL_PKEY_PARAM_FFC_DIGEST_PROPS) != NULL) {
681
0
        ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
682
0
        return 0;
683
0
    }
684
7.26k
    return 1;
685
7.26k
}
686
687
static int dh_gencb(int p, int n, BN_GENCB *cb)
688
0
{
689
0
    struct dh_gen_ctx *gctx = BN_GENCB_get_arg(cb);
690
0
    OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END };
691
692
0
    params[0] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_POTENTIAL, &p);
693
0
    params[1] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_ITERATION, &n);
694
695
0
    return gctx->cb(params, gctx->cbarg);
696
0
}
697
698
static void *dh_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)
699
4.60k
{
700
4.60k
    int ret = 0;
701
4.60k
    struct dh_gen_ctx *gctx = genctx;
702
4.60k
    DH *dh = NULL;
703
4.60k
    BN_GENCB *gencb = NULL;
704
4.60k
    FFC_PARAMS *ffc;
705
706
4.60k
    if (!ossl_prov_is_running() || gctx == NULL)
707
0
        return NULL;
708
709
    /*
710
     * If a group name is selected then the type is group regardless of what
711
     * the user selected. This overrides rather than errors for backwards
712
     * compatibility.
713
     */
714
4.60k
    if (gctx->group_nid != NID_undef)
715
1.28k
        gctx->gen_type = DH_PARAMGEN_TYPE_GROUP;
716
717
    /*
718
     * Do a bounds check on context gen_type. Must be in range:
719
     * DH_PARAMGEN_TYPE_GENERATOR <= gen_type <= DH_PARAMGEN_TYPE_GROUP
720
     * Noted here as this needs to be adjusted if a new group type is
721
     * added.
722
     */
723
4.60k
    if (!ossl_assert((gctx->gen_type >= DH_PARAMGEN_TYPE_GENERATOR)
724
4.60k
                    && (gctx->gen_type <= DH_PARAMGEN_TYPE_GROUP))) {
725
0
        ERR_raise_data(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR,
726
0
                       "gen_type set to unsupported value %d", gctx->gen_type);
727
0
        return NULL;
728
0
    }
729
730
    /* For parameter generation - If there is a group name just create it */
731
4.60k
    if (gctx->gen_type == DH_PARAMGEN_TYPE_GROUP
732
1.28k
            && gctx->ffc_params == NULL) {
733
        /* Select a named group if there is not one already */
734
1.28k
        if (gctx->group_nid == NID_undef)
735
0
            gctx->group_nid = ossl_dh_get_named_group_uid_from_size(gctx->pbits);
736
1.28k
        if (gctx->group_nid == NID_undef)
737
0
            return NULL;
738
1.28k
        dh = ossl_dh_new_by_nid_ex(gctx->libctx, gctx->group_nid);
739
1.28k
        if (dh == NULL)
740
0
            return NULL;
741
1.28k
        ffc = ossl_dh_get0_params(dh);
742
3.32k
    } else {
743
3.32k
        dh = ossl_dh_new_ex(gctx->libctx);
744
3.32k
        if (dh == NULL)
745
0
            return NULL;
746
3.32k
        ffc = ossl_dh_get0_params(dh);
747
748
        /* Copy the template value if one was passed */
749
3.32k
        if (gctx->ffc_params != NULL
750
3.32k
            && !ossl_ffc_params_copy(ffc, gctx->ffc_params))
751
0
            goto end;
752
753
3.32k
        if (!ossl_ffc_params_set_seed(ffc, gctx->seed, gctx->seedlen))
754
0
            goto end;
755
3.32k
        if (gctx->gindex != -1) {
756
0
            ossl_ffc_params_set_gindex(ffc, gctx->gindex);
757
0
            if (gctx->pcounter != -1)
758
0
                ossl_ffc_params_set_pcounter(ffc, gctx->pcounter);
759
3.32k
        } else if (gctx->hindex != 0) {
760
0
            ossl_ffc_params_set_h(ffc, gctx->hindex);
761
0
        }
762
3.32k
        if (gctx->mdname != NULL)
763
0
            ossl_ffc_set_digest(ffc, gctx->mdname, gctx->mdprops);
764
3.32k
        gctx->cb = osslcb;
765
3.32k
        gctx->cbarg = cbarg;
766
3.32k
        gencb = BN_GENCB_new();
767
3.32k
        if (gencb != NULL)
768
3.32k
            BN_GENCB_set(gencb, dh_gencb, genctx);
769
770
3.32k
        if ((gctx->selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
771
            /*
772
             * NOTE: The old safe prime generator code is not used in fips mode,
773
             * (i.e internally it ignores the generator and chooses a named
774
             * group based on pbits.
775
             */
776
0
            if (gctx->gen_type == DH_PARAMGEN_TYPE_GENERATOR)
777
0
                ret = DH_generate_parameters_ex(dh, gctx->pbits,
778
0
                                                gctx->generator, gencb);
779
0
            else
780
0
                ret = ossl_dh_generate_ffc_parameters(dh, gctx->gen_type,
781
0
                                                      gctx->pbits, gctx->qbits,
782
0
                                                      gencb);
783
0
            if (ret <= 0)
784
0
                goto end;
785
0
        }
786
3.32k
    }
787
788
4.60k
    if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
789
3.38k
        if (ffc->p == NULL || ffc->g == NULL)
790
0
            goto end;
791
3.38k
        if (gctx->priv_len > 0)
792
0
            DH_set_length(dh, (long)gctx->priv_len);
793
3.38k
        ossl_ffc_params_enable_flags(ffc, FFC_PARAM_FLAG_VALIDATE_LEGACY,
794
3.38k
                                     gctx->gen_type == DH_PARAMGEN_TYPE_FIPS_186_2);
795
3.38k
        if (DH_generate_key(dh) <= 0)
796
0
            goto end;
797
#ifdef FIPS_MODULE
798
        if (!ossl_fips_self_testing()) {
799
            ret = ossl_dh_check_pairwise(dh, 0);
800
            if (ret <= 0) {
801
                ossl_set_error_state(OSSL_SELF_TEST_TYPE_PCT);
802
                goto end;
803
            }
804
        }
805
#endif /* FIPS_MODULE */
806
3.38k
    }
807
4.60k
    DH_clear_flags(dh, DH_FLAG_TYPE_MASK);
808
4.60k
    DH_set_flags(dh, gctx->dh_type);
809
810
4.60k
    ret = 1;
811
4.60k
end:
812
4.60k
    if (ret <= 0) {
813
0
        DH_free(dh);
814
0
        dh = NULL;
815
0
    }
816
4.60k
    BN_GENCB_free(gencb);
817
4.60k
    return dh;
818
4.60k
}
819
820
static void dh_gen_cleanup(void *genctx)
821
6.80k
{
822
6.80k
    struct dh_gen_ctx *gctx = genctx;
823
824
6.80k
    if (gctx == NULL)
825
0
        return;
826
827
6.80k
    OPENSSL_free(gctx->mdname);
828
6.80k
    OPENSSL_free(gctx->mdprops);
829
6.80k
    OPENSSL_clear_free(gctx->seed, gctx->seedlen);
830
6.80k
    OPENSSL_free(gctx);
831
6.80k
}
832
833
static void *dh_load(const void *reference, size_t reference_sz)
834
43.9k
{
835
43.9k
    DH *dh = NULL;
836
837
43.9k
    if (ossl_prov_is_running() && reference_sz == sizeof(dh)) {
838
        /* The contents of the reference is the address to our object */
839
43.9k
        dh = *(DH **)reference;
840
        /* We grabbed, so we detach it */
841
43.9k
        *(DH **)reference = NULL;
842
43.9k
        return dh;
843
43.9k
    }
844
0
    return NULL;
845
43.9k
}
846
847
static void *dh_dup(const void *keydata_from, int selection)
848
9.25k
{
849
9.25k
    if (ossl_prov_is_running())
850
9.25k
        return ossl_dh_dup(keydata_from, selection);
851
0
    return NULL;
852
9.25k
}
853
854
const OSSL_DISPATCH ossl_dh_keymgmt_functions[] = {
855
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))dh_newdata },
856
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))dh_gen_init },
857
    { OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE, (void (*)(void))dh_gen_set_template },
858
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))dh_gen_set_params },
859
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
860
      (void (*)(void))dh_gen_settable_params },
861
    { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))dh_gen },
862
    { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))dh_gen_cleanup },
863
    { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))dh_load },
864
    { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))dh_freedata },
865
    { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))dh_get_params },
866
    { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))dh_gettable_params },
867
    { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))dh_set_params },
868
    { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))dh_settable_params },
869
    { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))dh_has },
870
    { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))dh_match },
871
    { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))dh_validate },
872
    { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))dh_import },
873
    { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))dh_import_types },
874
    { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))dh_export },
875
    { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))dh_export_types },
876
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))dh_dup },
877
    OSSL_DISPATCH_END
878
};
879
880
/* For any DH key, we use the "DH" algorithms regardless of sub-type. */
881
static const char *dhx_query_operation_name(int operation_id)
882
0
{
883
0
    return "DH";
884
0
}
885
886
const OSSL_DISPATCH ossl_dhx_keymgmt_functions[] = {
887
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))dhx_newdata },
888
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))dhx_gen_init },
889
    { OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE, (void (*)(void))dh_gen_set_template },
890
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))dhx_gen_set_params },
891
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
892
      (void (*)(void))dhx_gen_settable_params },
893
    { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))dh_gen },
894
    { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))dh_gen_cleanup },
895
    { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))dh_load },
896
    { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))dh_freedata },
897
    { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))dh_get_params },
898
    { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))dh_gettable_params },
899
    { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))dh_set_params },
900
    { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))dh_settable_params },
901
    { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))dh_has },
902
    { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))dh_match },
903
    { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))dh_validate },
904
    { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))dh_import },
905
    { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))dh_import_types },
906
    { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))dh_export },
907
    { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))dh_export_types },
908
    { OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME,
909
      (void (*)(void))dhx_query_operation_name },
910
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))dh_dup },
911
    OSSL_DISPATCH_END
912
};