RT4351: Update doc for OPENSSL_cleanse
[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/rsa.h>
64 #include <openssl/rand.h>
65 #ifndef OPENSSL_NO_ENGINE
66 # include <openssl/engine.h>
67 #endif
68
69 static const RSA_METHOD *default_RSA_meth = NULL;
70
71 RSA *RSA_new(void)
72 {
73     RSA *r = RSA_new_method(NULL);
74
75     return r;
76 }
77
78 void RSA_set_default_method(const RSA_METHOD *meth)
79 {
80     default_RSA_meth = meth;
81 }
82
83 const RSA_METHOD *RSA_get_default_method(void)
84 {
85     if (default_RSA_meth == NULL) {
86 #ifdef RSA_NULL
87         default_RSA_meth = RSA_null_method();
88 #else
89         default_RSA_meth = RSA_PKCS1_OpenSSL();
90 #endif
91     }
92
93     return default_RSA_meth;
94 }
95
96 const RSA_METHOD *RSA_get_method(const RSA *rsa)
97 {
98     return rsa->meth;
99 }
100
101 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth)
102 {
103     /*
104      * NB: The caller is specifically setting a method, so it's not up to us
105      * to deal with which ENGINE it comes from.
106      */
107     const RSA_METHOD *mtmp;
108     mtmp = rsa->meth;
109     if (mtmp->finish)
110         mtmp->finish(rsa);
111 #ifndef OPENSSL_NO_ENGINE
112     ENGINE_finish(rsa->engine);
113     rsa->engine = NULL;
114 #endif
115     rsa->meth = meth;
116     if (meth->init)
117         meth->init(rsa);
118     return 1;
119 }
120
121 RSA *RSA_new_method(ENGINE *engine)
122 {
123     RSA *ret;
124
125     ret = OPENSSL_zalloc(sizeof(*ret));
126     if (ret == NULL) {
127         RSAerr(RSA_F_RSA_NEW_METHOD, ERR_R_MALLOC_FAILURE);
128         return NULL;
129     }
130
131     ret->meth = RSA_get_default_method();
132 #ifndef OPENSSL_NO_ENGINE
133     if (engine) {
134         if (!ENGINE_init(engine)) {
135             RSAerr(RSA_F_RSA_NEW_METHOD, ERR_R_ENGINE_LIB);
136             OPENSSL_free(ret);
137             return NULL;
138         }
139         ret->engine = engine;
140     } else
141         ret->engine = ENGINE_get_default_RSA();
142     if (ret->engine) {
143         ret->meth = ENGINE_get_RSA(ret->engine);
144         if (ret->meth == NULL) {
145             RSAerr(RSA_F_RSA_NEW_METHOD, ERR_R_ENGINE_LIB);
146             ENGINE_finish(ret->engine);
147             OPENSSL_free(ret);
148             return NULL;
149         }
150     }
151 #endif
152
153     ret->references = 1;
154     ret->flags = ret->meth->flags & ~RSA_FLAG_NON_FIPS_ALLOW;
155     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_RSA, ret, &ret->ex_data)) {
156 #ifndef OPENSSL_NO_ENGINE
157         if (ret->engine)
158             ENGINE_finish(ret->engine);
159 #endif
160         OPENSSL_free(ret);
161         return (NULL);
162     }
163
164     if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
165 #ifndef OPENSSL_NO_ENGINE
166         if (ret->engine)
167             ENGINE_finish(ret->engine);
168 #endif
169         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_RSA, ret, &ret->ex_data);
170         OPENSSL_free(ret);
171         ret = NULL;
172     }
173     return (ret);
174 }
175
176 void RSA_free(RSA *r)
177 {
178     int i;
179
180     if (r == NULL)
181         return;
182
183     i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_RSA);
184     REF_PRINT_COUNT("RSA", r);
185     if (i > 0)
186         return;
187     REF_ASSERT_ISNT(i < 0);
188
189     if (r->meth->finish)
190         r->meth->finish(r);
191 #ifndef OPENSSL_NO_ENGINE
192     if (r->engine)
193         ENGINE_finish(r->engine);
194 #endif
195
196     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_RSA, r, &r->ex_data);
197
198     BN_clear_free(r->n);
199     BN_clear_free(r->e);
200     BN_clear_free(r->d);
201     BN_clear_free(r->p);
202     BN_clear_free(r->q);
203     BN_clear_free(r->dmp1);
204     BN_clear_free(r->dmq1);
205     BN_clear_free(r->iqmp);
206     BN_BLINDING_free(r->blinding);
207     BN_BLINDING_free(r->mt_blinding);
208     OPENSSL_free(r->bignum_data);
209     OPENSSL_free(r);
210 }
211
212 int RSA_up_ref(RSA *r)
213 {
214     int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_RSA);
215
216     REF_PRINT_COUNT("RSA", r);
217     REF_ASSERT_ISNT(i < 2);
218     return ((i > 1) ? 1 : 0);
219 }
220
221 int RSA_set_ex_data(RSA *r, int idx, void *arg)
222 {
223     return (CRYPTO_set_ex_data(&r->ex_data, idx, arg));
224 }
225
226 void *RSA_get_ex_data(const RSA *r, int idx)
227 {
228     return (CRYPTO_get_ex_data(&r->ex_data, idx));
229 }
230
231 int RSA_memory_lock(RSA *r)
232 {
233     int i, j, k, off;
234     char *p;
235     BIGNUM *bn, **t[6], *b;
236     BN_ULONG *ul;
237
238     if (r->d == NULL)
239         return (1);
240     t[0] = &r->d;
241     t[1] = &r->p;
242     t[2] = &r->q;
243     t[3] = &r->dmp1;
244     t[4] = &r->dmq1;
245     t[5] = &r->iqmp;
246     k = bn_sizeof_BIGNUM() * 6;
247     off = k / sizeof(BN_ULONG) + 1;
248     j = 1;
249     for (i = 0; i < 6; i++)
250         j += bn_get_top(*t[i]);
251     if ((p = OPENSSL_malloc((off + j) * sizeof(*p))) == NULL) {
252         RSAerr(RSA_F_RSA_MEMORY_LOCK, ERR_R_MALLOC_FAILURE);
253         return (0);
254     }
255     memset(p, 0, sizeof(*p) * (off + j));
256     bn = (BIGNUM *)p;
257     ul = (BN_ULONG *)&(p[off]);
258     for (i = 0; i < 6; i++) {
259         b = *(t[i]);
260         *(t[i]) = bn_array_el(bn, i);
261         memcpy(bn_array_el(bn, i), b, bn_sizeof_BIGNUM());
262         memcpy(ul, bn_get_words(b), sizeof(*ul) * bn_get_top(b));
263         bn_set_static_words(bn_array_el(bn, i), ul, bn_get_top(b));
264         ul += bn_get_top(b);
265         BN_clear_free(b);
266     }
267
268     /* I should fix this so it can still be done */
269     r->flags &= ~(RSA_FLAG_CACHE_PRIVATE | RSA_FLAG_CACHE_PUBLIC);
270
271     r->bignum_data = p;
272     return (1);
273 }
274
275 int RSA_security_bits(const RSA *rsa)
276 {
277     return BN_security_bits(BN_num_bits(rsa->n), -1);
278 }