Thread-safety fixes
[openssl.git] / crypto / bn / bn_mont.c
1 /* crypto/bn/bn_mont.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112 /*
113  * Details about Montgomery multiplication algorithms can be found at
114  * http://security.ece.orst.edu/publications.html, e.g.
115  * http://security.ece.orst.edu/koc/papers/j37acmon.pdf and
116  * sections 3.8 and 4.2 in http://security.ece.orst.edu/koc/papers/r01rsasw.pdf
117  */
118
119 #include <stdio.h>
120 #include "cryptlib.h"
121 #include "bn_lcl.h"
122
123 #define MONT_WORD /* use the faster word-based algorithm */
124
125 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
126                           BN_MONT_CTX *mont, BN_CTX *ctx)
127         {
128         BIGNUM *tmp;
129         int ret=0;
130
131         BN_CTX_start(ctx);
132         tmp = BN_CTX_get(ctx);
133         if (tmp == NULL) goto err;
134
135         bn_check_top(tmp);
136         if (a == b)
137                 {
138                 if (!BN_sqr(tmp,a,ctx)) goto err;
139                 }
140         else
141                 {
142                 if (!BN_mul(tmp,a,b,ctx)) goto err;
143                 }
144         /* reduce from aRR to aR */
145         if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
146         ret=1;
147 err:
148         BN_CTX_end(ctx);
149         return(ret);
150         }
151
152 int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a, BN_MONT_CTX *mont,
153              BN_CTX *ctx)
154         {
155         int retn=0;
156
157 #ifdef MONT_WORD
158         BIGNUM *n,*r;
159         BN_ULONG *ap,*np,*rp,n0,v,*nrp;
160         int al,nl,max,i,x,ri;
161
162         BN_CTX_start(ctx);
163         if ((r = BN_CTX_get(ctx)) == NULL) goto err;
164
165         if (!BN_copy(r,a)) goto err;
166         n= &(mont->N);
167
168         ap=a->d;
169         /* mont->ri is the size of mont->N in bits (rounded up
170            to the word size) */
171         al=ri=mont->ri/BN_BITS2;
172         
173         nl=n->top;
174         if ((al == 0) || (nl == 0)) { r->top=0; return(1); }
175
176         max=(nl+al+1); /* allow for overflow (no?) XXX */
177         if (bn_wexpand(r,max) == NULL) goto err;
178         if (bn_wexpand(ret,max) == NULL) goto err;
179
180         r->neg=a->neg^n->neg;
181         np=n->d;
182         rp=r->d;
183         nrp= &(r->d[nl]);
184
185         /* clear the top words of T */
186 #if 1
187         for (i=r->top; i<max; i++) /* memset? XXX */
188                 r->d[i]=0;
189 #else
190         memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG)); 
191 #endif
192
193         r->top=max;
194         n0=mont->n0;
195
196 #ifdef BN_COUNT
197         fprintf(stderr,"word BN_from_montgomery %d * %d\n",nl,nl);
198 #endif
199         for (i=0; i<nl; i++)
200                 {
201 #ifdef __TANDEM
202                 {
203                    long long t1;
204                    long long t2;
205                    long long t3;
206                    t1 = rp[0] * (n0 & 0177777);
207                    t2 = 037777600000l;
208                    t2 = n0 & t2;
209                    t3 = rp[0] & 0177777;
210                    t2 = (t3 * t2) & BN_MASK2;
211                    t1 = t1 + t2;
212                    v=bn_mul_add_words(rp,np,nl,(BN_ULONG) t1);
213                 }
214 #else
215                 v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
216 #endif
217                 nrp++;
218                 rp++;
219                 if (((nrp[-1]+=v)&BN_MASK2) >= v)
220                         continue;
221                 else
222                         {
223                         if (((++nrp[0])&BN_MASK2) != 0) continue;
224                         if (((++nrp[1])&BN_MASK2) != 0) continue;
225                         for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
226                         }
227                 }
228         bn_fix_top(r);
229         
230         /* mont->ri will be a multiple of the word size */
231 #if 0
232         BN_rshift(ret,r,mont->ri);
233 #else
234         ret->neg = r->neg;
235         x=ri;
236         rp=ret->d;
237         ap= &(r->d[x]);
238         if (r->top < x)
239                 al=0;
240         else
241                 al=r->top-x;
242         ret->top=al;
243         al-=4;
244         for (i=0; i<al; i+=4)
245                 {
246                 BN_ULONG t1,t2,t3,t4;
247                 
248                 t1=ap[i+0];
249                 t2=ap[i+1];
250                 t3=ap[i+2];
251                 t4=ap[i+3];
252                 rp[i+0]=t1;
253                 rp[i+1]=t2;
254                 rp[i+2]=t3;
255                 rp[i+3]=t4;
256                 }
257         al+=4;
258         for (; i<al; i++)
259                 rp[i]=ap[i];
260 #endif
261 #else /* !MONT_WORD */ 
262         BIGNUM *t1,*t2;
263
264         BN_CTX_start(ctx);
265         t1 = BN_CTX_get(ctx);
266         t2 = BN_CTX_get(ctx);
267         if (t1 == NULL || t2 == NULL) goto err;
268         
269         if (!BN_copy(t1,a)) goto err;
270         BN_mask_bits(t1,mont->ri);
271
272         if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
273         BN_mask_bits(t2,mont->ri);
274
275         if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
276         if (!BN_add(t2,a,t1)) goto err;
277         if (!BN_rshift(ret,t2,mont->ri)) goto err;
278 #endif /* MONT_WORD */
279
280         if (BN_ucmp(ret, &(mont->N)) >= 0)
281                 {
282                 if (!BN_usub(ret,ret,&(mont->N))) goto err;
283                 }
284         retn=1;
285  err:
286         BN_CTX_end(ctx);
287         return(retn);
288         }
289
290 BN_MONT_CTX *BN_MONT_CTX_new(void)
291         {
292         BN_MONT_CTX *ret;
293
294         if ((ret=(BN_MONT_CTX *)OPENSSL_malloc(sizeof(BN_MONT_CTX))) == NULL)
295                 return(NULL);
296
297         BN_MONT_CTX_init(ret);
298         ret->flags=BN_FLG_MALLOCED;
299         return(ret);
300         }
301
302 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
303         {
304         ctx->ri=0;
305         BN_init(&(ctx->RR));
306         BN_init(&(ctx->N));
307         BN_init(&(ctx->Ni));
308         ctx->flags=0;
309         }
310
311 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
312         {
313         if(mont == NULL)
314             return;
315
316         BN_free(&(mont->RR));
317         BN_free(&(mont->N));
318         BN_free(&(mont->Ni));
319         if (mont->flags & BN_FLG_MALLOCED)
320                 OPENSSL_free(mont);
321         }
322
323 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
324         {
325         BIGNUM Ri,*R;
326
327         BN_init(&Ri);
328         R= &(mont->RR);                                 /* grab RR as a temp */
329         if (!BN_copy(&(mont->N),mod)) goto err;         /* Set N */
330         mont->N.neg = 0;
331
332 #ifdef MONT_WORD
333                 {
334                 BIGNUM tmod;
335                 BN_ULONG buf[2];
336
337                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
338                 if (!(BN_zero(R))) goto err;
339                 if (!(BN_set_bit(R,BN_BITS2))) goto err;        /* R */
340
341                 buf[0]=mod->d[0]; /* tmod = N mod word size */
342                 buf[1]=0;
343                 tmod.d=buf;
344                 tmod.top=1;
345                 tmod.dmax=2;
346                 tmod.neg=0;
347                                                         /* Ri = R^-1 mod N*/
348                 if ((BN_mod_inverse(&Ri,R,&tmod,ctx)) == NULL)
349                         goto err;
350                 if (!BN_lshift(&Ri,&Ri,BN_BITS2)) goto err; /* R*Ri */
351                 if (!BN_is_zero(&Ri))
352                         {
353                         if (!BN_sub_word(&Ri,1)) goto err;
354                         }
355                 else /* if N mod word size == 1 */
356                         {
357                         if (!BN_set_word(&Ri,BN_MASK2)) goto err;  /* Ri-- (mod word size) */
358                         }
359                 if (!BN_div(&Ri,NULL,&Ri,&tmod,ctx)) goto err;
360                 /* Ni = (R*Ri-1)/N,
361                  * keep only least significant word: */
362                 mont->n0 = (Ri.top > 0) ? Ri.d[0] : 0;
363                 BN_free(&Ri);
364                 }
365 #else /* !MONT_WORD */
366                 { /* bignum version */
367                 mont->ri=BN_num_bits(&mont->N);
368                 if (!BN_zero(R)) goto err;
369                 if (!BN_set_bit(R,mont->ri)) goto err;  /* R = 2^ri */
370                                                         /* Ri = R^-1 mod N*/
371                 if ((BN_mod_inverse(&Ri,R,&mont->N,ctx)) == NULL)
372                         goto err;
373                 if (!BN_lshift(&Ri,&Ri,mont->ri)) goto err; /* R*Ri */
374                 if (!BN_sub_word(&Ri,1)) goto err;
375                                                         /* Ni = (R*Ri-1) / N */
376                 if (!BN_div(&(mont->Ni),NULL,&Ri,&mont->N,ctx)) goto err;
377                 BN_free(&Ri);
378                 }
379 #endif
380
381         /* setup RR for conversions */
382         if (!BN_zero(&(mont->RR))) goto err;
383         if (!BN_set_bit(&(mont->RR),mont->ri*2)) goto err;
384         if (!BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx)) goto err;
385
386         return(1);
387 err:
388         return(0);
389         }
390
391 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
392         {
393         if (to == from) return(to);
394
395         if (!BN_copy(&(to->RR),&(from->RR))) return NULL;
396         if (!BN_copy(&(to->N),&(from->N))) return NULL;
397         if (!BN_copy(&(to->Ni),&(from->Ni))) return NULL;
398         to->ri=from->ri;
399         to->n0=from->n0;
400         return(to);
401         }
402
403 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
404                                         const BIGNUM *mod, BN_CTX *ctx)
405         {
406         if (*pmont)
407                 return *pmont;
408         CRYPTO_w_lock(lock);
409         if (!*pmont)
410                 {
411                 BN_MONT_CTX *mtmp;
412                 mtmp = BN_MONT_CTX_new();
413                 if (mtmp && !BN_MONT_CTX_set(mtmp, mod, ctx))
414                         BN_MONT_CTX_free(mtmp);
415                 else
416                         *pmont = mtmp;
417                 }
418         CRYPTO_w_unlock(lock);
419         return *pmont;
420         }