7ee575d663978c9de8f2c5694f7e0456257501eb
[openssl.git] / crypto / rsa / rsa_lib.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include <openssl/crypto.h>
60 #include "internal/cryptlib.h"
61 #include <openssl/lhash.h>
62 #include "internal/bn_int.h"
63 #include <openssl/rand.h>
64 #include <openssl/engine.h>
65 #include "rsa_locl.h"
66
67 static const RSA_METHOD *default_RSA_meth = NULL;
68
69 RSA *RSA_new(void)
70 {
71     RSA *r = RSA_new_method(NULL);
72
73     return r;
74 }
75
76 void RSA_set_default_method(const RSA_METHOD *meth)
77 {
78     default_RSA_meth = meth;
79 }
80
81 const RSA_METHOD *RSA_get_default_method(void)
82 {
83     if (default_RSA_meth == NULL) {
84 #ifdef RSA_NULL
85         default_RSA_meth = RSA_null_method();
86 #else
87         default_RSA_meth = RSA_PKCS1_OpenSSL();
88 #endif
89     }
90
91     return default_RSA_meth;
92 }
93
94 const RSA_METHOD *RSA_get_method(const RSA *rsa)
95 {
96     return rsa->meth;
97 }
98
99 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth)
100 {
101     /*
102      * NB: The caller is specifically setting a method, so it's not up to us
103      * to deal with which ENGINE it comes from.
104      */
105     const RSA_METHOD *mtmp;
106     mtmp = rsa->meth;
107     if (mtmp->finish)
108         mtmp->finish(rsa);
109 #ifndef OPENSSL_NO_ENGINE
110     ENGINE_finish(rsa->engine);
111     rsa->engine = NULL;
112 #endif
113     rsa->meth = meth;
114     if (meth->init)
115         meth->init(rsa);
116     return 1;
117 }
118
119 RSA *RSA_new_method(ENGINE *engine)
120 {
121     RSA *ret;
122
123     ret = OPENSSL_zalloc(sizeof(*ret));
124     if (ret == NULL) {
125         RSAerr(RSA_F_RSA_NEW_METHOD, ERR_R_MALLOC_FAILURE);
126         return NULL;
127     }
128
129     ret->meth = RSA_get_default_method();
130 #ifndef OPENSSL_NO_ENGINE
131     if (engine) {
132         if (!ENGINE_init(engine)) {
133             RSAerr(RSA_F_RSA_NEW_METHOD, ERR_R_ENGINE_LIB);
134             OPENSSL_free(ret);
135             return NULL;
136         }
137         ret->engine = engine;
138     } else
139         ret->engine = ENGINE_get_default_RSA();
140     if (ret->engine) {
141         ret->meth = ENGINE_get_RSA(ret->engine);
142         if (ret->meth == NULL) {
143             RSAerr(RSA_F_RSA_NEW_METHOD, ERR_R_ENGINE_LIB);
144             ENGINE_finish(ret->engine);
145             OPENSSL_free(ret);
146             return NULL;
147         }
148     }
149 #endif
150
151     ret->references = 1;
152     ret->flags = ret->meth->flags & ~RSA_FLAG_NON_FIPS_ALLOW;
153     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_RSA, ret, &ret->ex_data)) {
154 #ifndef OPENSSL_NO_ENGINE
155         ENGINE_finish(ret->engine);
156 #endif
157         OPENSSL_free(ret);
158         return NULL;
159     }
160
161     ret->lock = CRYPTO_THREAD_lock_new();
162     if (ret->lock == NULL) {
163 #ifndef OPENSSL_NO_ENGINE
164         ENGINE_finish(ret->engine);
165 #endif
166         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_RSA, ret, &ret->ex_data);
167         OPENSSL_free(ret);
168         return NULL;
169     }
170
171     if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
172         RSA_free(ret);
173         ret = NULL;
174     }
175
176     return ret;
177 }
178
179 void RSA_free(RSA *r)
180 {
181     int i;
182
183     if (r == NULL)
184         return;
185
186     CRYPTO_atomic_add(&r->references, -1, &i, r->lock);
187     REF_PRINT_COUNT("RSA", r);
188     if (i > 0)
189         return;
190     REF_ASSERT_ISNT(i < 0);
191
192     if (r->meth->finish)
193         r->meth->finish(r);
194 #ifndef OPENSSL_NO_ENGINE
195     ENGINE_finish(r->engine);
196 #endif
197
198     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_RSA, r, &r->ex_data);
199
200     CRYPTO_THREAD_lock_free(r->lock);
201
202     BN_clear_free(r->n);
203     BN_clear_free(r->e);
204     BN_clear_free(r->d);
205     BN_clear_free(r->p);
206     BN_clear_free(r->q);
207     BN_clear_free(r->dmp1);
208     BN_clear_free(r->dmq1);
209     BN_clear_free(r->iqmp);
210     BN_BLINDING_free(r->blinding);
211     BN_BLINDING_free(r->mt_blinding);
212     OPENSSL_free(r->bignum_data);
213     OPENSSL_free(r);
214 }
215
216 int RSA_up_ref(RSA *r)
217 {
218     int i;
219
220     if (CRYPTO_atomic_add(&r->references, 1, &i, r->lock) <= 0)
221         return 0;
222
223     REF_PRINT_COUNT("RSA", r);
224     REF_ASSERT_ISNT(i < 2);
225     return ((i > 1) ? 1 : 0);
226 }
227
228 int RSA_set_ex_data(RSA *r, int idx, void *arg)
229 {
230     return (CRYPTO_set_ex_data(&r->ex_data, idx, arg));
231 }
232
233 void *RSA_get_ex_data(const RSA *r, int idx)
234 {
235     return (CRYPTO_get_ex_data(&r->ex_data, idx));
236 }
237
238 int RSA_memory_lock(RSA *r)
239 {
240     int i, j, k, off;
241     char *p;
242     BIGNUM *bn, **t[6], *b;
243     BN_ULONG *ul;
244
245     if (r->d == NULL)
246         return (1);
247     t[0] = &r->d;
248     t[1] = &r->p;
249     t[2] = &r->q;
250     t[3] = &r->dmp1;
251     t[4] = &r->dmq1;
252     t[5] = &r->iqmp;
253     k = bn_sizeof_BIGNUM() * 6;
254     off = k / sizeof(BN_ULONG) + 1;
255     j = 1;
256     for (i = 0; i < 6; i++)
257         j += bn_get_top(*t[i]);
258     if ((p = OPENSSL_malloc((off + j) * sizeof(*p))) == NULL) {
259         RSAerr(RSA_F_RSA_MEMORY_LOCK, ERR_R_MALLOC_FAILURE);
260         return (0);
261     }
262     memset(p, 0, sizeof(*p) * (off + j));
263     bn = (BIGNUM *)p;
264     ul = (BN_ULONG *)&(p[off]);
265     for (i = 0; i < 6; i++) {
266         b = *(t[i]);
267         *(t[i]) = bn_array_el(bn, i);
268         memcpy(bn_array_el(bn, i), b, bn_sizeof_BIGNUM());
269         memcpy(ul, bn_get_words(b), sizeof(*ul) * bn_get_top(b));
270         bn_set_static_words(bn_array_el(bn, i), ul, bn_get_top(b));
271         ul += bn_get_top(b);
272         BN_clear_free(b);
273     }
274
275     /* I should fix this so it can still be done */
276     r->flags &= ~(RSA_FLAG_CACHE_PRIVATE | RSA_FLAG_CACHE_PUBLIC);
277
278     r->bignum_data = p;
279     return (1);
280 }
281
282 int RSA_security_bits(const RSA *rsa)
283 {
284     return BN_security_bits(BN_num_bits(rsa->n), -1);
285 }
286
287 int RSA_set0_key(RSA *r, BIGNUM *n, BIGNUM *e, BIGNUM *d)
288 {
289     /* d is the private component and may be NULL */
290     if (n == NULL || e == NULL)
291         return 0;
292
293     BN_free(r->n);
294     BN_free(r->e);
295     BN_free(r->d);
296     r->n = n;
297     r->e = e;
298     r->d = d;
299
300     return 1;
301 }
302
303 int RSA_set0_factors(RSA *r, BIGNUM *p, BIGNUM *q)
304 {
305     if (p == NULL || q == NULL)
306         return 0;
307
308     BN_free(r->p);
309     BN_free(r->q);
310     r->p = p;
311     r->q = q;
312
313     return 1;
314 }
315
316 int RSA_set0_crt_params(RSA *r, BIGNUM *dmp1, BIGNUM *dmq1, BIGNUM *iqmp)
317 {
318     if (dmp1 == NULL || dmq1 == NULL || iqmp == NULL)
319         return 0;
320
321     BN_free(r->dmp1);
322     BN_free(r->dmq1);
323     BN_free(r->iqmp);
324     r->dmp1 = dmp1;
325     r->dmq1 = dmq1;
326     r->iqmp = iqmp;
327
328     return 1;
329 }
330
331 void RSA_get0_key(const RSA *r, BIGNUM **n, BIGNUM **e, BIGNUM **d)
332 {
333     if (n != NULL)
334         *n = r->n;
335     if (e != NULL)
336         *e = r->e;
337     if (d != NULL)
338         *d = r->d;
339 }
340
341 void RSA_get0_factors(const RSA *r, BIGNUM **p, BIGNUM **q)
342 {
343     if (p != NULL)
344         *p = r->p;
345     if (q != NULL)
346         *q = r->q;
347 }
348
349 void RSA_get0_crt_params(const RSA *r,
350                          BIGNUM **dmp1, BIGNUM **dmq1, BIGNUM **iqmp)
351 {
352     if (dmp1 != NULL)
353         *dmp1 = r->dmp1;
354     if (dmq1 != NULL)
355         *dmq1 = r->dmq1;
356     if (iqmp != NULL)
357         *iqmp = r->iqmp;
358 }
359
360 void RSA_clear_flags(RSA *r, int flags)
361 {
362     r->flags &= ~flags;
363 }
364
365 int RSA_test_flags(const RSA *r, int flags)
366 {
367     return r->flags & flags;
368 }
369
370 void RSA_set_flags(RSA *r, int flags)
371 {
372     r->flags |= flags;
373 }
374
375 ENGINE *RSA_get0_engine(RSA *r)
376 {
377     return r->engine;
378 }