Following the license change, modify the boilerplates in crypto/dh/
[openssl.git] / crypto / dh / dh_lib.c
1 /*
2  * Copyright 1995-2018 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 #include <stdio.h>
11 #include "internal/cryptlib.h"
12 #include "internal/refcount.h"
13 #include <openssl/bn.h>
14 #include "dh_locl.h"
15 #include <openssl/engine.h>
16
17 int DH_set_method(DH *dh, const DH_METHOD *meth)
18 {
19     /*
20      * NB: The caller is specifically setting a method, so it's not up to us
21      * to deal with which ENGINE it comes from.
22      */
23     const DH_METHOD *mtmp;
24     mtmp = dh->meth;
25     if (mtmp->finish)
26         mtmp->finish(dh);
27 #ifndef OPENSSL_NO_ENGINE
28     ENGINE_finish(dh->engine);
29     dh->engine = NULL;
30 #endif
31     dh->meth = meth;
32     if (meth->init)
33         meth->init(dh);
34     return 1;
35 }
36
37 DH *DH_new(void)
38 {
39     return DH_new_method(NULL);
40 }
41
42 DH *DH_new_method(ENGINE *engine)
43 {
44     DH *ret = OPENSSL_zalloc(sizeof(*ret));
45
46     if (ret == NULL) {
47         DHerr(DH_F_DH_NEW_METHOD, ERR_R_MALLOC_FAILURE);
48         return NULL;
49     }
50
51     ret->references = 1;
52     ret->lock = CRYPTO_THREAD_lock_new();
53     if (ret->lock == NULL) {
54         DHerr(DH_F_DH_NEW_METHOD, ERR_R_MALLOC_FAILURE);
55         OPENSSL_free(ret);
56         return NULL;
57     }
58
59     ret->meth = DH_get_default_method();
60 #ifndef OPENSSL_NO_ENGINE
61     ret->flags = ret->meth->flags;  /* early default init */
62     if (engine) {
63         if (!ENGINE_init(engine)) {
64             DHerr(DH_F_DH_NEW_METHOD, ERR_R_ENGINE_LIB);
65             goto err;
66         }
67         ret->engine = engine;
68     } else
69         ret->engine = ENGINE_get_default_DH();
70     if (ret->engine) {
71         ret->meth = ENGINE_get_DH(ret->engine);
72         if (ret->meth == NULL) {
73             DHerr(DH_F_DH_NEW_METHOD, ERR_R_ENGINE_LIB);
74             goto err;
75         }
76     }
77 #endif
78
79     ret->flags = ret->meth->flags;
80
81     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_DH, ret, &ret->ex_data))
82         goto err;
83
84     if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
85         DHerr(DH_F_DH_NEW_METHOD, ERR_R_INIT_FAIL);
86         goto err;
87     }
88
89     return ret;
90
91  err:
92     DH_free(ret);
93     return NULL;
94 }
95
96 void DH_free(DH *r)
97 {
98     int i;
99
100     if (r == NULL)
101         return;
102
103     CRYPTO_DOWN_REF(&r->references, &i, r->lock);
104     REF_PRINT_COUNT("DH", r);
105     if (i > 0)
106         return;
107     REF_ASSERT_ISNT(i < 0);
108
109     if (r->meth != NULL && r->meth->finish != NULL)
110         r->meth->finish(r);
111 #ifndef OPENSSL_NO_ENGINE
112     ENGINE_finish(r->engine);
113 #endif
114
115     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DH, r, &r->ex_data);
116
117     CRYPTO_THREAD_lock_free(r->lock);
118
119     BN_clear_free(r->p);
120     BN_clear_free(r->g);
121     BN_clear_free(r->q);
122     BN_clear_free(r->j);
123     OPENSSL_free(r->seed);
124     BN_clear_free(r->counter);
125     BN_clear_free(r->pub_key);
126     BN_clear_free(r->priv_key);
127     OPENSSL_free(r);
128 }
129
130 int DH_up_ref(DH *r)
131 {
132     int i;
133
134     if (CRYPTO_UP_REF(&r->references, &i, r->lock) <= 0)
135         return 0;
136
137     REF_PRINT_COUNT("DH", r);
138     REF_ASSERT_ISNT(i < 2);
139     return ((i > 1) ? 1 : 0);
140 }
141
142 int DH_set_ex_data(DH *d, int idx, void *arg)
143 {
144     return CRYPTO_set_ex_data(&d->ex_data, idx, arg);
145 }
146
147 void *DH_get_ex_data(DH *d, int idx)
148 {
149     return CRYPTO_get_ex_data(&d->ex_data, idx);
150 }
151
152 int DH_bits(const DH *dh)
153 {
154     return BN_num_bits(dh->p);
155 }
156
157 int DH_size(const DH *dh)
158 {
159     return BN_num_bytes(dh->p);
160 }
161
162 int DH_security_bits(const DH *dh)
163 {
164     int N;
165     if (dh->q)
166         N = BN_num_bits(dh->q);
167     else if (dh->length)
168         N = dh->length;
169     else
170         N = -1;
171     return BN_security_bits(BN_num_bits(dh->p), N);
172 }
173
174
175 void DH_get0_pqg(const DH *dh,
176                  const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)
177 {
178     if (p != NULL)
179         *p = dh->p;
180     if (q != NULL)
181         *q = dh->q;
182     if (g != NULL)
183         *g = dh->g;
184 }
185
186 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g)
187 {
188     /* If the fields p and g in d are NULL, the corresponding input
189      * parameters MUST be non-NULL.  q may remain NULL.
190      */
191     if ((dh->p == NULL && p == NULL)
192         || (dh->g == NULL && g == NULL))
193         return 0;
194
195     if (p != NULL) {
196         BN_free(dh->p);
197         dh->p = p;
198     }
199     if (q != NULL) {
200         BN_free(dh->q);
201         dh->q = q;
202     }
203     if (g != NULL) {
204         BN_free(dh->g);
205         dh->g = g;
206     }
207
208     if (q != NULL) {
209         dh->length = BN_num_bits(q);
210     }
211
212     return 1;
213 }
214
215 long DH_get_length(const DH *dh)
216 {
217     return dh->length;
218 }
219
220 int DH_set_length(DH *dh, long length)
221 {
222     dh->length = length;
223     return 1;
224 }
225
226 void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key)
227 {
228     if (pub_key != NULL)
229         *pub_key = dh->pub_key;
230     if (priv_key != NULL)
231         *priv_key = dh->priv_key;
232 }
233
234 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key)
235 {
236     if (pub_key != NULL) {
237         BN_free(dh->pub_key);
238         dh->pub_key = pub_key;
239     }
240     if (priv_key != NULL) {
241         BN_free(dh->priv_key);
242         dh->priv_key = priv_key;
243     }
244
245     return 1;
246 }
247
248 const BIGNUM *DH_get0_p(const DH *dh)
249 {
250     return dh->p;
251 }
252
253 const BIGNUM *DH_get0_q(const DH *dh)
254 {
255     return dh->q;
256 }
257
258 const BIGNUM *DH_get0_g(const DH *dh)
259 {
260     return dh->g;
261 }
262
263 const BIGNUM *DH_get0_priv_key(const DH *dh)
264 {
265     return dh->priv_key;
266 }
267
268 const BIGNUM *DH_get0_pub_key(const DH *dh)
269 {
270     return dh->pub_key;
271 }
272
273 void DH_clear_flags(DH *dh, int flags)
274 {
275     dh->flags &= ~flags;
276 }
277
278 int DH_test_flags(const DH *dh, int flags)
279 {
280     return dh->flags & flags;
281 }
282
283 void DH_set_flags(DH *dh, int flags)
284 {
285     dh->flags |= flags;
286 }
287
288 ENGINE *DH_get0_engine(DH *dh)
289 {
290     return dh->engine;
291 }