2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
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
11 * DH low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
16 #include <openssl/core_numbers.h>
17 #include <openssl/core_names.h>
18 #include <openssl/bn.h>
19 #include <openssl/params.h>
20 #include "internal/param_build.h"
21 #include "crypto/dh.h"
22 #include "prov/implementations.h"
23 #include "prov/providercommon.h"
24 #include "prov/provider_ctx.h"
25 #include "crypto/dh.h"
27 static OSSL_OP_keymgmt_new_fn dh_newdata
;
28 static OSSL_OP_keymgmt_free_fn dh_freedata
;
29 static OSSL_OP_keymgmt_get_params_fn dh_get_params
;
30 static OSSL_OP_keymgmt_gettable_params_fn dh_gettable_params
;
31 static OSSL_OP_keymgmt_has_fn dh_has
;
32 static OSSL_OP_keymgmt_import_fn dh_import
;
33 static OSSL_OP_keymgmt_import_types_fn dh_import_types
;
34 static OSSL_OP_keymgmt_export_fn dh_export
;
35 static OSSL_OP_keymgmt_export_types_fn dh_export_types
;
37 #define DH_POSSIBLE_SELECTIONS \
38 (OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS)
40 static int params_to_domparams(DH
*dh
, const OSSL_PARAM params
[])
42 const OSSL_PARAM
*param_p
, *param_g
;
43 BIGNUM
*p
= NULL
, *g
= NULL
;
48 param_p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_FFC_P
);
49 param_g
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_FFC_G
);
51 if ((param_p
!= NULL
&& !OSSL_PARAM_get_BN(param_p
, &p
))
52 || (param_g
!= NULL
&& !OSSL_PARAM_get_BN(param_g
, &g
)))
55 if (!DH_set0_pqg(dh
, p
, NULL
, g
))
66 static int domparams_to_params(DH
*dh
, OSSL_PARAM_BLD
*tmpl
)
68 const BIGNUM
*dh_p
= NULL
, *dh_g
= NULL
;
73 DH_get0_pqg(dh
, &dh_p
, NULL
, &dh_g
);
75 && !ossl_param_bld_push_BN(tmpl
, OSSL_PKEY_PARAM_FFC_P
, dh_p
))
78 && !ossl_param_bld_push_BN(tmpl
, OSSL_PKEY_PARAM_FFC_G
, dh_g
))
84 static int params_to_key(DH
*dh
, const OSSL_PARAM params
[])
86 const OSSL_PARAM
*param_priv_key
, *param_pub_key
;
87 BIGNUM
*priv_key
= NULL
, *pub_key
= NULL
;
92 if (!params_to_domparams(dh
, params
))
96 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PRIV_KEY
);
98 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PUB_KEY
);
101 * DH documentation says that a public key must be present if a
102 * private key is present.
103 * We want to have at least a public key either way, so we end up
104 * requiring it unconditionally.
106 if (param_pub_key
== NULL
)
109 if ((param_priv_key
!= NULL
110 && !OSSL_PARAM_get_BN(param_priv_key
, &priv_key
))
111 || !OSSL_PARAM_get_BN(param_pub_key
, &pub_key
))
114 if (!DH_set0_key(dh
, pub_key
, priv_key
))
120 BN_clear_free(priv_key
);
125 static int key_to_params(DH
*dh
, OSSL_PARAM_BLD
*tmpl
)
127 const BIGNUM
*priv_key
= NULL
, *pub_key
= NULL
;
131 if (!domparams_to_params(dh
, tmpl
))
134 DH_get0_key(dh
, &pub_key
, &priv_key
);
136 && !ossl_param_bld_push_BN(tmpl
, OSSL_PKEY_PARAM_PRIV_KEY
, priv_key
))
139 && !ossl_param_bld_push_BN(tmpl
, OSSL_PKEY_PARAM_PUB_KEY
, pub_key
))
145 static void *dh_newdata(void *provctx
)
147 return dh_new_with_ctx(PROV_LIBRARY_CONTEXT_OF(provctx
));
150 static void dh_freedata(void *keydata
)
155 static int dh_has(void *keydata
, int selection
)
160 if ((selection
& DH_POSSIBLE_SELECTIONS
) != 0)
163 if ((selection
& OSSL_KEYMGMT_SELECT_PUBLIC_KEY
) != 0)
164 ok
= ok
&& (DH_get0_pub_key(dh
) != NULL
);
165 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0)
166 ok
= ok
&& (DH_get0_priv_key(dh
) != NULL
);
167 if ((selection
& OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
) != 0)
168 ok
= ok
&& (DH_get0_p(dh
) != NULL
&& DH_get0_g(dh
) != NULL
);
172 static int dh_import(void *keydata
, int selection
, const OSSL_PARAM params
[])
180 if ((selection
& DH_POSSIBLE_SELECTIONS
) != 0)
183 if ((selection
& OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
) != 0)
184 ok
= ok
&& params_to_domparams(dh
, params
);
185 if ((selection
& OSSL_KEYMGMT_SELECT_KEYPAIR
) != 0)
186 ok
= ok
&& params_to_key(dh
, params
);
191 static int dh_export(void *keydata
, int selection
, OSSL_CALLBACK
*param_cb
,
196 OSSL_PARAM
*params
= NULL
;
202 ossl_param_bld_init(&tmpl
);
204 if ((selection
& OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
) != 0)
205 ok
= ok
&& domparams_to_params(dh
, &tmpl
);
206 if ((selection
& OSSL_KEYMGMT_SELECT_KEYPAIR
) != 0)
207 ok
= ok
&& key_to_params(dh
, &tmpl
);
210 || (params
= ossl_param_bld_to_param(&tmpl
)) == NULL
)
213 ok
= param_cb(params
, cbarg
);
214 ossl_param_bld_free(params
);
218 /* IMEXPORT = IMPORT + EXPORT */
220 # define DH_IMEXPORTABLE_PARAMETERS \
221 OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_P, NULL, 0), \
222 OSSL_PARAM_BN(OSSL_PKEY_PARAM_FFC_G, NULL, 0)
223 # define DH_IMEXPORTABLE_PUBLIC_KEY \
224 OSSL_PARAM_BN(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0)
225 # define DH_IMEXPORTABLE_PRIVATE_KEY \
226 OSSL_PARAM_BN(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0)
227 static const OSSL_PARAM dh_all_types
[] = {
228 DH_IMEXPORTABLE_PARAMETERS
,
229 DH_IMEXPORTABLE_PUBLIC_KEY
,
230 DH_IMEXPORTABLE_PRIVATE_KEY
,
233 static const OSSL_PARAM dh_parameter_types
[] = {
234 DH_IMEXPORTABLE_PARAMETERS
,
237 static const OSSL_PARAM dh_key_types
[] = {
238 DH_IMEXPORTABLE_PUBLIC_KEY
,
239 DH_IMEXPORTABLE_PRIVATE_KEY
,
242 static const OSSL_PARAM
*dh_types
[] = {
243 NULL
, /* Index 0 = none of them */
244 dh_parameter_types
, /* Index 1 = parameter types */
245 dh_key_types
, /* Index 2 = key types */
246 dh_all_types
/* Index 3 = 1 + 2 */
249 static const OSSL_PARAM
*dh_imexport_types(int selection
)
253 if ((selection
& OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
) != 0)
255 if ((selection
& OSSL_KEYMGMT_SELECT_KEYPAIR
) != 0)
257 return dh_types
[type_select
];
260 static const OSSL_PARAM
*dh_import_types(int selection
)
262 return dh_imexport_types(selection
);
265 static const OSSL_PARAM
*dh_export_types(int selection
)
267 return dh_imexport_types(selection
);
270 static ossl_inline
int dh_get_params(void *key
, OSSL_PARAM params
[])
275 if ((p
= OSSL_PARAM_locate(params
, OSSL_PKEY_PARAM_BITS
)) != NULL
276 && !OSSL_PARAM_set_int(p
, DH_bits(dh
)))
278 if ((p
= OSSL_PARAM_locate(params
, OSSL_PKEY_PARAM_SECURITY_BITS
)) != NULL
279 && !OSSL_PARAM_set_int(p
, DH_security_bits(dh
)))
281 if ((p
= OSSL_PARAM_locate(params
, OSSL_PKEY_PARAM_MAX_SIZE
)) != NULL
282 && !OSSL_PARAM_set_int(p
, DH_size(dh
)))
287 static const OSSL_PARAM dh_params
[] = {
288 OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS
, NULL
),
289 OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS
, NULL
),
290 OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE
, NULL
),
294 static const OSSL_PARAM
*dh_gettable_params(void)
299 const OSSL_DISPATCH dh_keymgmt_functions
[] = {
300 { OSSL_FUNC_KEYMGMT_NEW
, (void (*)(void))dh_newdata
},
301 { OSSL_FUNC_KEYMGMT_FREE
, (void (*)(void))dh_freedata
},
302 { OSSL_FUNC_KEYMGMT_GET_PARAMS
, (void (*) (void))dh_get_params
},
303 { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS
, (void (*) (void))dh_gettable_params
},
304 { OSSL_FUNC_KEYMGMT_HAS
, (void (*)(void))dh_has
},
305 { OSSL_FUNC_KEYMGMT_IMPORT
, (void (*)(void))dh_import
},
306 { OSSL_FUNC_KEYMGMT_IMPORT_TYPES
, (void (*)(void))dh_import_types
},
307 { OSSL_FUNC_KEYMGMT_EXPORT
, (void (*)(void))dh_export
},
308 { OSSL_FUNC_KEYMGMT_EXPORT_TYPES
, (void (*)(void))dh_export_types
},