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