Redirect FIPS memory allocation to FIPS_malloc() routine, remove
[openssl.git] / crypto / bn / bn_blind.c
1 /* crypto/bn/bn_blind.c */
2 /* ====================================================================
3  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer. 
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@openssl.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
56  * All rights reserved.
57  *
58  * This package is an SSL implementation written
59  * by Eric Young (eay@cryptsoft.com).
60  * The implementation was written so as to conform with Netscapes SSL.
61  * 
62  * This library is free for commercial and non-commercial use as long as
63  * the following conditions are aheared to.  The following conditions
64  * apply to all code found in this distribution, be it the RC4, RSA,
65  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
66  * included with this distribution is covered by the same copyright terms
67  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
68  * 
69  * Copyright remains Eric Young's, and as such any Copyright notices in
70  * the code are not to be removed.
71  * If this package is used in a product, Eric Young should be given attribution
72  * as the author of the parts of the library used.
73  * This can be in the form of a textual message at program startup or
74  * in documentation (online or textual) provided with the package.
75  * 
76  * Redistribution and use in source and binary forms, with or without
77  * modification, are permitted provided that the following conditions
78  * are met:
79  * 1. Redistributions of source code must retain the copyright
80  *    notice, this list of conditions and the following disclaimer.
81  * 2. Redistributions in binary form must reproduce the above copyright
82  *    notice, this list of conditions and the following disclaimer in the
83  *    documentation and/or other materials provided with the distribution.
84  * 3. All advertising materials mentioning features or use of this software
85  *    must display the following acknowledgement:
86  *    "This product includes cryptographic software written by
87  *     Eric Young (eay@cryptsoft.com)"
88  *    The word 'cryptographic' can be left out if the rouines from the library
89  *    being used are not cryptographic related :-).
90  * 4. If you include any Windows specific code (or a derivative thereof) from 
91  *    the apps directory (application code) you must include an acknowledgement:
92  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
93  * 
94  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
95  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
96  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
97  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
98  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
99  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
100  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
104  * SUCH DAMAGE.
105  * 
106  * The licence and distribution terms for any publically available version or
107  * derivative of this code cannot be changed.  i.e. this code cannot simply be
108  * copied and put under another distribution licence
109  * [including the GNU Public Licence.]
110  */
111
112 #include <stdio.h>
113 #include "cryptlib.h"
114 #include "bn_lcl.h"
115
116 #define OPENSSL_FIPSAPI
117
118 #ifdef OPENSSL_FIPS
119 #include <openssl/fips.h>
120 #endif
121
122 #define BN_BLINDING_COUNTER     32
123
124 struct bn_blinding_st
125         {
126         BIGNUM *A;
127         BIGNUM *Ai;
128         BIGNUM *e;
129         BIGNUM *mod; /* just a reference */
130 #ifndef OPENSSL_NO_DEPRECATED
131         unsigned long thread_id; /* added in OpenSSL 0.9.6j and 0.9.7b;
132                                   * used only by crypto/rsa/rsa_eay.c, rsa_lib.c */
133 #endif
134         CRYPTO_THREADID tid;
135         unsigned int  counter;
136         unsigned long flags;
137         BN_MONT_CTX *m_ctx;
138         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
139                           const BIGNUM *m, BN_CTX *ctx,
140                           BN_MONT_CTX *m_ctx);
141         };
142
143 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod)
144         {
145         BN_BLINDING *ret=NULL;
146
147         bn_check_top(mod);
148
149         if ((ret=(BN_BLINDING *)OPENSSL_malloc(sizeof(BN_BLINDING))) == NULL)
150                 {
151                 BNerr(BN_F_BN_BLINDING_NEW,ERR_R_MALLOC_FAILURE);
152                 return(NULL);
153                 }
154         memset(ret,0,sizeof(BN_BLINDING));
155         if (A != NULL)
156                 {
157                 if ((ret->A  = BN_dup(A))  == NULL) goto err;
158                 }
159         if (Ai != NULL)
160                 {
161                 if ((ret->Ai = BN_dup(Ai)) == NULL) goto err;
162                 }
163
164         /* save a copy of mod in the BN_BLINDING structure */
165         if ((ret->mod = BN_dup(mod)) == NULL) goto err;
166         if (BN_get_flags(mod, BN_FLG_CONSTTIME) != 0)
167                 BN_set_flags(ret->mod, BN_FLG_CONSTTIME);
168
169         ret->counter = BN_BLINDING_COUNTER;
170         CRYPTO_THREADID_current(&ret->tid);
171         return(ret);
172 err:
173         if (ret != NULL) BN_BLINDING_free(ret);
174         return(NULL);
175         }
176
177 void BN_BLINDING_free(BN_BLINDING *r)
178         {
179         if(r == NULL)
180             return;
181
182         if (r->A  != NULL) BN_free(r->A );
183         if (r->Ai != NULL) BN_free(r->Ai);
184         if (r->e  != NULL) BN_free(r->e );
185         if (r->mod != NULL) BN_free(r->mod); 
186         OPENSSL_free(r);
187         }
188
189 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx)
190         {
191         int ret=0;
192
193         if ((b->A == NULL) || (b->Ai == NULL))
194                 {
195                 BNerr(BN_F_BN_BLINDING_UPDATE,BN_R_NOT_INITIALIZED);
196                 goto err;
197                 }
198
199         if (--(b->counter) == 0 && b->e != NULL &&
200                 !(b->flags & BN_BLINDING_NO_RECREATE))
201                 {
202                 /* re-create blinding parameters */
203                 if (!BN_BLINDING_create_param(b, NULL, NULL, ctx, NULL, NULL))
204                         goto err;
205                 }
206         else if (!(b->flags & BN_BLINDING_NO_UPDATE))
207                 {
208                 if (!BN_mod_mul(b->A,b->A,b->A,b->mod,ctx)) goto err;
209                 if (!BN_mod_mul(b->Ai,b->Ai,b->Ai,b->mod,ctx)) goto err;
210                 }
211
212         ret=1;
213 err:
214         if (b->counter == 0)
215                 b->counter = BN_BLINDING_COUNTER;
216         return(ret);
217         }
218
219 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx)
220         {
221         return BN_BLINDING_convert_ex(n, NULL, b, ctx);
222         }
223
224 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *ctx)
225         {
226         int ret = 1;
227
228         bn_check_top(n);
229
230         if ((b->A == NULL) || (b->Ai == NULL))
231                 {
232                 BNerr(BN_F_BN_BLINDING_CONVERT_EX,BN_R_NOT_INITIALIZED);
233                 return(0);
234                 }
235
236         if (r != NULL)
237                 {
238                 if (!BN_copy(r, b->Ai)) ret=0;
239                 }
240
241         if (!BN_mod_mul(n,n,b->A,b->mod,ctx)) ret=0;
242         
243         return ret;
244         }
245
246 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx)
247         {
248         return BN_BLINDING_invert_ex(n, NULL, b, ctx);
249         }
250
251 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *ctx)
252         {
253         int ret;
254
255         bn_check_top(n);
256         if ((b->A == NULL) || (b->Ai == NULL))
257                 {
258                 BNerr(BN_F_BN_BLINDING_INVERT_EX,BN_R_NOT_INITIALIZED);
259                 return(0);
260                 }
261
262         if (r != NULL)
263                 ret = BN_mod_mul(n, n, r, b->mod, ctx);
264         else
265                 ret = BN_mod_mul(n, n, b->Ai, b->mod, ctx);
266
267         if (ret >= 0)
268                 {
269                 if (!BN_BLINDING_update(b,ctx))
270                         return(0);
271                 }
272         bn_check_top(n);
273         return(ret);
274         }
275
276 #ifndef OPENSSL_NO_DEPRECATED
277 unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *b)
278         {
279         return b->thread_id;
280         }
281
282 void BN_BLINDING_set_thread_id(BN_BLINDING *b, unsigned long n)
283         {
284         b->thread_id = n;
285         }
286 #endif
287
288 CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *b)
289         {
290         return &b->tid;
291         }
292
293 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *b)
294         {
295         return b->flags;
296         }
297
298 void BN_BLINDING_set_flags(BN_BLINDING *b, unsigned long flags)
299         {
300         b->flags = flags;
301         }
302
303 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
304         const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
305         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
306                           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
307         BN_MONT_CTX *m_ctx)
308 {
309         int    retry_counter = 32;
310         BN_BLINDING *ret = NULL;
311
312         if (b == NULL)
313                 ret = BN_BLINDING_new(NULL, NULL, m);
314         else
315                 ret = b;
316
317         if (ret == NULL)
318                 goto err;
319
320         if (ret->A  == NULL && (ret->A  = BN_new()) == NULL)
321                 goto err;
322         if (ret->Ai == NULL && (ret->Ai = BN_new()) == NULL)
323                 goto err;
324
325         if (e != NULL)
326                 {
327                 if (ret->e != NULL)
328                         BN_free(ret->e);
329                 ret->e = BN_dup(e);
330                 }
331         if (ret->e == NULL)
332                 goto err;
333
334         if (bn_mod_exp != NULL)
335                 ret->bn_mod_exp = bn_mod_exp;
336         if (m_ctx != NULL)
337                 ret->m_ctx = m_ctx;
338
339         do {
340                 int rv;
341                 if (!BN_rand_range(ret->A, ret->mod)) goto err;
342                 if (!int_bn_mod_inverse(ret->Ai, ret->A, ret->mod, ctx, &rv))
343                         {
344                         /* this should almost never happen for good RSA keys */
345                         if (rv)
346                                 {
347                                 if (retry_counter-- == 0)
348                                 {
349                                         BNerr(BN_F_BN_BLINDING_CREATE_PARAM,
350                                                 BN_R_TOO_MANY_ITERATIONS);
351                                         goto err;
352                                 }
353                                 }
354                         else
355                                 goto err;
356                         }
357                 else
358                         break;
359         } while (1);
360
361         if (ret->bn_mod_exp != NULL && ret->m_ctx != NULL)
362                 {
363                 if (!ret->bn_mod_exp(ret->A, ret->A, ret->e, ret->mod, ctx, ret->m_ctx))
364                         goto err;
365                 }
366         else
367                 {
368                 if (!BN_mod_exp(ret->A, ret->A, ret->e, ret->mod, ctx))
369                         goto err;
370                 }
371
372         return ret;
373 err:
374         if (b == NULL && ret != NULL)
375                 {
376                 BN_BLINDING_free(ret);
377                 ret = NULL;
378                 }
379
380         return ret;
381 }