/src/openssl/crypto/dh/dh_lib.c
Line  | Count  | Source (jump to first uncovered line)  | 
1  |  | /*  | 
2  |  |  * Copyright 1995-2023 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 <stdio.h>  | 
17  |  | #include <openssl/bn.h>  | 
18  |  | #ifndef FIPS_MODULE  | 
19  |  | # include <openssl/engine.h>  | 
20  |  | #endif  | 
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"  | 
27  |  | #include "dh_local.h"  | 
28  |  |  | 
29  |  | static DH *dh_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx);  | 
30  |  |  | 
31  |  | #ifndef FIPS_MODULE  | 
32  |  | int DH_set_method(DH *dh, const DH_METHOD *meth)  | 
33  | 0  | { | 
34  |  |     /*  | 
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.  | 
37  |  |      */  | 
38  | 0  |     const DH_METHOD *mtmp;  | 
39  | 0  |     mtmp = dh->meth;  | 
40  | 0  |     if (mtmp->finish)  | 
41  | 0  |         mtmp->finish(dh);  | 
42  | 0  | #ifndef OPENSSL_NO_ENGINE  | 
43  | 0  |     ENGINE_finish(dh->engine);  | 
44  | 0  |     dh->engine = NULL;  | 
45  | 0  | #endif  | 
46  | 0  |     dh->meth = meth;  | 
47  | 0  |     if (meth->init)  | 
48  | 0  |         meth->init(dh);  | 
49  | 0  |     return 1;  | 
50  | 0  | }  | 
51  |  |  | 
52  |  | const DH_METHOD *ossl_dh_get_method(const DH *dh)  | 
53  | 0  | { | 
54  | 0  |     return dh->meth;  | 
55  | 0  | }  | 
56  |  | # ifndef OPENSSL_NO_DEPRECATED_3_0  | 
57  |  | DH *DH_new(void)  | 
58  | 0  | { | 
59  | 0  |     return dh_new_intern(NULL, NULL);  | 
60  | 0  | }  | 
61  |  | # endif  | 
62  |  |  | 
63  |  | DH *DH_new_method(ENGINE *engine)  | 
64  | 0  | { | 
65  | 0  |     return dh_new_intern(engine, NULL);  | 
66  | 0  | }  | 
67  |  | #endif /* !FIPS_MODULE */  | 
68  |  |  | 
69  |  | DH *ossl_dh_new_ex(OSSL_LIB_CTX *libctx)  | 
70  | 0  | { | 
71  | 0  |     return dh_new_intern(NULL, libctx);  | 
72  | 0  | }  | 
73  |  |  | 
74  |  | static DH *dh_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx)  | 
75  | 0  | { | 
76  | 0  |     DH *ret = OPENSSL_zalloc(sizeof(*ret));  | 
77  |  | 
  | 
78  | 0  |     if (ret == NULL)  | 
79  | 0  |         return NULL;  | 
80  |  |  | 
81  | 0  |     ret->lock = CRYPTO_THREAD_lock_new();  | 
82  | 0  |     if (ret->lock == NULL) { | 
83  | 0  |         ERR_raise(ERR_LIB_DH, ERR_R_CRYPTO_LIB);  | 
84  | 0  |         OPENSSL_free(ret);  | 
85  | 0  |         return NULL;  | 
86  | 0  |     }  | 
87  |  |  | 
88  | 0  |     if (!CRYPTO_NEW_REF(&ret->references, 1)) { | 
89  | 0  |         CRYPTO_THREAD_lock_free(ret->lock);  | 
90  | 0  |         OPENSSL_free(ret);  | 
91  | 0  |         return NULL;  | 
92  | 0  |     }  | 
93  |  |  | 
94  | 0  |     ret->libctx = libctx;  | 
95  | 0  |     ret->meth = DH_get_default_method();  | 
96  | 0  | #if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)  | 
97  | 0  |     ret->flags = ret->meth->flags;  /* early default init */  | 
98  | 0  |     if (engine) { | 
99  | 0  |         if (!ENGINE_init(engine)) { | 
100  | 0  |             ERR_raise(ERR_LIB_DH, ERR_R_ENGINE_LIB);  | 
101  | 0  |             goto err;  | 
102  | 0  |         }  | 
103  | 0  |         ret->engine = engine;  | 
104  | 0  |     } else  | 
105  | 0  |         ret->engine = ENGINE_get_default_DH();  | 
106  | 0  |     if (ret->engine) { | 
107  | 0  |         ret->meth = ENGINE_get_DH(ret->engine);  | 
108  | 0  |         if (ret->meth == NULL) { | 
109  | 0  |             ERR_raise(ERR_LIB_DH, ERR_R_ENGINE_LIB);  | 
110  | 0  |             goto err;  | 
111  | 0  |         }  | 
112  | 0  |     }  | 
113  | 0  | #endif  | 
114  |  |  | 
115  | 0  |     ret->flags = ret->meth->flags;  | 
116  |  | 
  | 
117  | 0  | #ifndef FIPS_MODULE  | 
118  | 0  |     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_DH, ret, &ret->ex_data))  | 
119  | 0  |         goto err;  | 
120  | 0  | #endif /* FIPS_MODULE */  | 
121  |  |  | 
122  | 0  |     ossl_ffc_params_init(&ret->params);  | 
123  |  | 
  | 
124  | 0  |     if ((ret->meth->init != NULL) && !ret->meth->init(ret)) { | 
125  | 0  |         ERR_raise(ERR_LIB_DH, ERR_R_INIT_FAIL);  | 
126  | 0  |         goto err;  | 
127  | 0  |     }  | 
128  |  |  | 
129  | 0  |     return ret;  | 
130  |  |  | 
131  | 0  |  err:  | 
132  | 0  |     DH_free(ret);  | 
133  | 0  |     return NULL;  | 
134  | 0  | }  | 
135  |  |  | 
136  |  | void DH_free(DH *r)  | 
137  | 0  | { | 
138  | 0  |     int i;  | 
139  |  | 
  | 
140  | 0  |     if (r == NULL)  | 
141  | 0  |         return;  | 
142  |  |  | 
143  | 0  |     CRYPTO_DOWN_REF(&r->references, &i);  | 
144  | 0  |     REF_PRINT_COUNT("DH", i, r); | 
145  | 0  |     if (i > 0)  | 
146  | 0  |         return;  | 
147  | 0  |     REF_ASSERT_ISNT(i < 0);  | 
148  |  | 
  | 
149  | 0  |     if (r->meth != NULL && r->meth->finish != NULL)  | 
150  | 0  |         r->meth->finish(r);  | 
151  | 0  | #if !defined(FIPS_MODULE)  | 
152  | 0  | # if !defined(OPENSSL_NO_ENGINE)  | 
153  | 0  |     ENGINE_finish(r->engine);  | 
154  | 0  | # endif  | 
155  | 0  |     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DH, r, &r->ex_data);  | 
156  | 0  | #endif  | 
157  |  | 
  | 
158  | 0  |     CRYPTO_THREAD_lock_free(r->lock);  | 
159  | 0  |     CRYPTO_FREE_REF(&r->references);  | 
160  |  | 
  | 
161  | 0  |     ossl_ffc_params_cleanup(&r->params);  | 
162  | 0  |     BN_clear_free(r->pub_key);  | 
163  | 0  |     BN_clear_free(r->priv_key);  | 
164  | 0  |     OPENSSL_free(r);  | 
165  | 0  | }  | 
166  |  |  | 
167  |  | int DH_up_ref(DH *r)  | 
168  | 0  | { | 
169  | 0  |     int i;  | 
170  |  | 
  | 
171  | 0  |     if (CRYPTO_UP_REF(&r->references, &i) <= 0)  | 
172  | 0  |         return 0;  | 
173  |  |  | 
174  | 0  |     REF_PRINT_COUNT("DH", i, r); | 
175  | 0  |     REF_ASSERT_ISNT(i < 2);  | 
176  | 0  |     return ((i > 1) ? 1 : 0);  | 
177  | 0  | }  | 
178  |  |  | 
179  |  | void ossl_dh_set0_libctx(DH *d, OSSL_LIB_CTX *libctx)  | 
180  | 0  | { | 
181  | 0  |     d->libctx = libctx;  | 
182  | 0  | }  | 
183  |  |  | 
184  |  | #ifndef FIPS_MODULE  | 
185  |  | int DH_set_ex_data(DH *d, int idx, void *arg)  | 
186  | 0  | { | 
187  | 0  |     return CRYPTO_set_ex_data(&d->ex_data, idx, arg);  | 
188  | 0  | }  | 
189  |  |  | 
190  |  | void *DH_get_ex_data(const DH *d, int idx)  | 
191  | 0  | { | 
192  | 0  |     return CRYPTO_get_ex_data(&d->ex_data, idx);  | 
193  | 0  | }  | 
194  |  | #endif  | 
195  |  |  | 
196  |  | int DH_bits(const DH *dh)  | 
197  | 0  | { | 
198  | 0  |     if (dh->params.p != NULL)  | 
199  | 0  |         return BN_num_bits(dh->params.p);  | 
200  | 0  |     return -1;  | 
201  | 0  | }  | 
202  |  |  | 
203  |  | int DH_size(const DH *dh)  | 
204  | 0  | { | 
205  | 0  |     if (dh->params.p != NULL)  | 
206  | 0  |         return BN_num_bytes(dh->params.p);  | 
207  | 0  |     return -1;  | 
208  | 0  | }  | 
209  |  |  | 
210  |  | int DH_security_bits(const DH *dh)  | 
211  | 0  | { | 
212  | 0  |     int N;  | 
213  |  | 
  | 
214  | 0  |     if (dh->params.q != NULL)  | 
215  | 0  |         N = BN_num_bits(dh->params.q);  | 
216  | 0  |     else if (dh->length)  | 
217  | 0  |         N = dh->length;  | 
218  | 0  |     else  | 
219  | 0  |         N = -1;  | 
220  | 0  |     if (dh->params.p != NULL)  | 
221  | 0  |         return BN_security_bits(BN_num_bits(dh->params.p), N);  | 
222  | 0  |     return -1;  | 
223  | 0  | }  | 
224  |  |  | 
225  |  | void DH_get0_pqg(const DH *dh,  | 
226  |  |                  const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)  | 
227  | 0  | { | 
228  | 0  |     ossl_ffc_params_get0_pqg(&dh->params, p, q, g);  | 
229  | 0  | }  | 
230  |  |  | 
231  |  | int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g)  | 
232  | 0  | { | 
233  |  |     /*  | 
234  |  |      * If the fields p and g in dh are NULL, the corresponding input  | 
235  |  |      * parameters MUST be non-NULL.  q may remain NULL.  | 
236  |  |      */  | 
237  | 0  |     if ((dh->params.p == NULL && p == NULL)  | 
238  | 0  |         || (dh->params.g == NULL && g == NULL))  | 
239  | 0  |         return 0;  | 
240  |  |  | 
241  | 0  |     ossl_ffc_params_set0_pqg(&dh->params, p, q, g);  | 
242  | 0  |     ossl_dh_cache_named_group(dh);  | 
243  | 0  |     dh->dirty_cnt++;  | 
244  | 0  |     return 1;  | 
245  | 0  | }  | 
246  |  |  | 
247  |  | long DH_get_length(const DH *dh)  | 
248  | 0  | { | 
249  | 0  |     return dh->length;  | 
250  | 0  | }  | 
251  |  |  | 
252  |  | int DH_set_length(DH *dh, long length)  | 
253  | 0  | { | 
254  | 0  |     dh->length = length;  | 
255  | 0  |     dh->dirty_cnt++;  | 
256  | 0  |     return 1;  | 
257  | 0  | }  | 
258  |  |  | 
259  |  | void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key)  | 
260  | 0  | { | 
261  | 0  |     if (pub_key != NULL)  | 
262  | 0  |         *pub_key = dh->pub_key;  | 
263  | 0  |     if (priv_key != NULL)  | 
264  | 0  |         *priv_key = dh->priv_key;  | 
265  | 0  | }  | 
266  |  |  | 
267  |  | int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key)  | 
268  | 0  | { | 
269  | 0  |     if (pub_key != NULL) { | 
270  | 0  |         BN_clear_free(dh->pub_key);  | 
271  | 0  |         dh->pub_key = pub_key;  | 
272  | 0  |     }  | 
273  | 0  |     if (priv_key != NULL) { | 
274  | 0  |         BN_clear_free(dh->priv_key);  | 
275  | 0  |         dh->priv_key = priv_key;  | 
276  | 0  |     }  | 
277  |  | 
  | 
278  | 0  |     dh->dirty_cnt++;  | 
279  | 0  |     return 1;  | 
280  | 0  | }  | 
281  |  |  | 
282  |  | const BIGNUM *DH_get0_p(const DH *dh)  | 
283  | 0  | { | 
284  | 0  |     return dh->params.p;  | 
285  | 0  | }  | 
286  |  |  | 
287  |  | const BIGNUM *DH_get0_q(const DH *dh)  | 
288  | 0  | { | 
289  | 0  |     return dh->params.q;  | 
290  | 0  | }  | 
291  |  |  | 
292  |  | const BIGNUM *DH_get0_g(const DH *dh)  | 
293  | 0  | { | 
294  | 0  |     return dh->params.g;  | 
295  | 0  | }  | 
296  |  |  | 
297  |  | const BIGNUM *DH_get0_priv_key(const DH *dh)  | 
298  | 0  | { | 
299  | 0  |     return dh->priv_key;  | 
300  | 0  | }  | 
301  |  |  | 
302  |  | const BIGNUM *DH_get0_pub_key(const DH *dh)  | 
303  | 0  | { | 
304  | 0  |     return dh->pub_key;  | 
305  | 0  | }  | 
306  |  |  | 
307  |  | void DH_clear_flags(DH *dh, int flags)  | 
308  | 0  | { | 
309  | 0  |     dh->flags &= ~flags;  | 
310  | 0  | }  | 
311  |  |  | 
312  |  | int DH_test_flags(const DH *dh, int flags)  | 
313  | 0  | { | 
314  | 0  |     return dh->flags & flags;  | 
315  | 0  | }  | 
316  |  |  | 
317  |  | void DH_set_flags(DH *dh, int flags)  | 
318  | 0  | { | 
319  | 0  |     dh->flags |= flags;  | 
320  | 0  | }  | 
321  |  |  | 
322  |  | #ifndef FIPS_MODULE  | 
323  |  | ENGINE *DH_get0_engine(DH *dh)  | 
324  | 0  | { | 
325  | 0  |     return dh->engine;  | 
326  | 0  | }  | 
327  |  | #endif /*FIPS_MODULE */  | 
328  |  |  | 
329  |  | FFC_PARAMS *ossl_dh_get0_params(DH *dh)  | 
330  | 0  | { | 
331  | 0  |     return &dh->params;  | 
332  | 0  | }  | 
333  |  | int ossl_dh_get0_nid(const DH *dh)  | 
334  | 0  | { | 
335  | 0  |     return dh->params.nid;  | 
336  | 0  | }  |