2 * Copyright 1995-2023 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"
17 #include <openssl/bn.h>
19 # include <openssl/engine.h>
21 #include <openssl/obj_mac.h>
22 #include <openssl/core_names.h>
23 #include "internal/cryptlib.h"
24 #include "internal/refcount.h"
25 #include "crypto/evp.h"
26 #include "crypto/dh.h"
29 static DH *dh_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx);
32 int DH_set_method(DH *dh, const DH_METHOD *meth)
35 * NB: The caller is specifically setting a method, so it's not up to us
36 * to deal with which ENGINE it comes from.
38 const DH_METHOD *mtmp;
42 #ifndef OPENSSL_NO_ENGINE
43 ENGINE_finish(dh->engine);
52 const DH_METHOD *ossl_dh_get_method(const DH *dh)
56 # ifndef OPENSSL_NO_DEPRECATED_3_0
59 return dh_new_intern(NULL, NULL);
63 DH *DH_new_method(ENGINE *engine)
65 return dh_new_intern(engine, NULL);
67 #endif /* !FIPS_MODULE */
69 DH *ossl_dh_new_ex(OSSL_LIB_CTX *libctx)
71 return dh_new_intern(NULL, libctx);
74 static DH *dh_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx)
76 DH *ret = OPENSSL_zalloc(sizeof(*ret));
81 ret->lock = CRYPTO_THREAD_lock_new();
82 if (ret->lock == NULL) {
83 ERR_raise(ERR_LIB_DH, ERR_R_CRYPTO_LIB);
88 if (!CRYPTO_NEW_REF(&ret->references, 1)) {
89 CRYPTO_THREAD_lock_free(ret->lock);
95 ret->meth = DH_get_default_method();
96 #if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
97 ret->flags = ret->meth->flags; /* early default init */
99 if (!ENGINE_init(engine)) {
100 ERR_raise(ERR_LIB_DH, ERR_R_ENGINE_LIB);
103 ret->engine = engine;
105 ret->engine = ENGINE_get_default_DH();
107 ret->meth = ENGINE_get_DH(ret->engine);
108 if (ret->meth == NULL) {
109 ERR_raise(ERR_LIB_DH, ERR_R_ENGINE_LIB);
115 ret->flags = ret->meth->flags;
118 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_DH, ret, &ret->ex_data))
120 #endif /* FIPS_MODULE */
122 ossl_ffc_params_init(&ret->params);
124 if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
125 ERR_raise(ERR_LIB_DH, ERR_R_INIT_FAIL);
143 CRYPTO_DOWN_REF(&r->references, &i);
144 REF_PRINT_COUNT("DH", r);
147 REF_ASSERT_ISNT(i < 0);
149 if (r->meth != NULL && r->meth->finish != NULL)
151 #if !defined(FIPS_MODULE)
152 # if !defined(OPENSSL_NO_ENGINE)
153 ENGINE_finish(r->engine);
155 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DH, r, &r->ex_data);
158 CRYPTO_THREAD_lock_free(r->lock);
159 CRYPTO_FREE_REF(&r->references);
161 ossl_ffc_params_cleanup(&r->params);
162 BN_clear_free(r->pub_key);
163 BN_clear_free(r->priv_key);
171 if (CRYPTO_UP_REF(&r->references, &i) <= 0)
174 REF_PRINT_COUNT("DH", r);
175 REF_ASSERT_ISNT(i < 2);
176 return ((i > 1) ? 1 : 0);
179 void ossl_dh_set0_libctx(DH *d, OSSL_LIB_CTX *libctx)
185 int DH_set_ex_data(DH *d, int idx, void *arg)
187 return CRYPTO_set_ex_data(&d->ex_data, idx, arg);
190 void *DH_get_ex_data(const DH *d, int idx)
192 return CRYPTO_get_ex_data(&d->ex_data, idx);
196 int DH_bits(const DH *dh)
198 if (dh->params.p != NULL)
199 return BN_num_bits(dh->params.p);
203 int DH_size(const DH *dh)
205 if (dh->params.p != NULL)
206 return BN_num_bytes(dh->params.p);
210 int DH_security_bits(const DH *dh)
214 if (dh->params.q != NULL)
215 N = BN_num_bits(dh->params.q);
220 if (dh->params.p != NULL)
221 return BN_security_bits(BN_num_bits(dh->params.p), N);
225 void DH_get0_pqg(const DH *dh,
226 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)
228 ossl_ffc_params_get0_pqg(&dh->params, p, q, g);
231 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g)
234 * If the fields p and g in dh are NULL, the corresponding input
235 * parameters MUST be non-NULL. q may remain NULL.
237 if ((dh->params.p == NULL && p == NULL)
238 || (dh->params.g == NULL && g == NULL))
241 ossl_ffc_params_set0_pqg(&dh->params, p, q, g);
242 ossl_dh_cache_named_group(dh);
247 long DH_get_length(const DH *dh)
252 int DH_set_length(DH *dh, long length)
259 void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key)
262 *pub_key = dh->pub_key;
263 if (priv_key != NULL)
264 *priv_key = dh->priv_key;
267 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key)
269 if (pub_key != NULL) {
270 BN_clear_free(dh->pub_key);
271 dh->pub_key = pub_key;
273 if (priv_key != NULL) {
274 BN_clear_free(dh->priv_key);
275 dh->priv_key = priv_key;
282 const BIGNUM *DH_get0_p(const DH *dh)
287 const BIGNUM *DH_get0_q(const DH *dh)
292 const BIGNUM *DH_get0_g(const DH *dh)
297 const BIGNUM *DH_get0_priv_key(const DH *dh)
302 const BIGNUM *DH_get0_pub_key(const DH *dh)
307 void DH_clear_flags(DH *dh, int flags)
312 int DH_test_flags(const DH *dh, int flags)
314 return dh->flags & flags;
317 void DH_set_flags(DH *dh, int flags)
323 ENGINE *DH_get0_engine(DH *dh)
327 #endif /*FIPS_MODULE */
329 FFC_PARAMS *ossl_dh_get0_params(DH *dh)
333 int ossl_dh_get0_nid(const DH *dh)
335 return dh->params.nid;