Update source files to handle new FIPS_lock() location. Add FIPS_lock()
[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 #define OPENSSL_FIPSAPI
120
121 #include <stdio.h>
122 #include "cryptlib.h"
123 #include "bn_lcl.h"
124
125 #ifdef OPENSSL_FIPS
126 #include <openssl/fips.h>
127 #endif
128
129 #define MONT_WORD /* use the faster word-based algorithm */
130
131 #ifdef MONT_WORD
132 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont);
133 #endif
134
135 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
136                           BN_MONT_CTX *mont, BN_CTX *ctx)
137         {
138         BIGNUM *tmp;
139         int ret=0;
140 #if defined(OPENSSL_BN_ASM_MONT) && defined(MONT_WORD)
141         int num = mont->N.top;
142
143         if (num>1 && a->top==num && b->top==num)
144                 {
145                 if (bn_wexpand(r,num) == NULL) return(0);
146                 if (bn_mul_mont(r->d,a->d,b->d,mont->N.d,mont->n0,num))
147                         {
148                         r->neg = a->neg^b->neg;
149                         r->top = num;
150                         bn_correct_top(r);
151                         return(1);
152                         }
153                 }
154 #endif
155
156         BN_CTX_start(ctx);
157         tmp = BN_CTX_get(ctx);
158         if (tmp == NULL) goto err;
159
160         bn_check_top(tmp);
161         if (a == b)
162                 {
163                 if (!BN_sqr(tmp,a,ctx)) goto err;
164                 }
165         else
166                 {
167                 if (!BN_mul(tmp,a,b,ctx)) goto err;
168                 }
169         /* reduce from aRR to aR */
170 #ifdef MONT_WORD
171         if (!BN_from_montgomery_word(r,tmp,mont)) goto err;
172 #else
173         if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
174 #endif
175         bn_check_top(r);
176         ret=1;
177 err:
178         BN_CTX_end(ctx);
179         return(ret);
180         }
181
182 #ifdef MONT_WORD
183 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont)
184         {
185         BIGNUM *n;
186         BN_ULONG *ap,*np,*rp,n0,v,*nrp;
187         int al,nl,max,i,x,ri;
188
189         n= &(mont->N);
190         /* mont->ri is the size of mont->N in bits (rounded up
191            to the word size) */
192         al=ri=mont->ri/BN_BITS2;
193
194         nl=n->top;
195         if ((al == 0) || (nl == 0)) { ret->top=0; return(1); }
196
197         max=(nl+al+1); /* allow for overflow (no?) XXX */
198         if (bn_wexpand(r,max) == NULL) return(0);
199
200         r->neg^=n->neg;
201         np=n->d;
202         rp=r->d;
203         nrp= &(r->d[nl]);
204
205         /* clear the top words of T */
206 #if 1
207         for (i=r->top; i<max; i++) /* memset? XXX */
208                 r->d[i]=0;
209 #else
210         memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG)); 
211 #endif
212
213         r->top=max;
214         n0=mont->n0[0];
215
216 #ifdef BN_COUNT
217         fprintf(stderr,"word BN_from_montgomery_word %d * %d\n",nl,nl);
218 #endif
219         for (i=0; i<nl; i++)
220                 {
221 #ifdef __TANDEM
222                 {
223                    long long t1;
224                    long long t2;
225                    long long t3;
226                    t1 = rp[0] * (n0 & 0177777);
227                    t2 = 037777600000l;
228                    t2 = n0 & t2;
229                    t3 = rp[0] & 0177777;
230                    t2 = (t3 * t2) & BN_MASK2;
231                    t1 = t1 + t2;
232                    v=bn_mul_add_words(rp,np,nl,(BN_ULONG) t1);
233                 }
234 #else
235                 v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
236 #endif
237                 nrp++;
238                 rp++;
239                 if (((nrp[-1]+=v)&BN_MASK2) >= v)
240                         continue;
241                 else
242                         {
243                         if (((++nrp[0])&BN_MASK2) != 0) continue;
244                         if (((++nrp[1])&BN_MASK2) != 0) continue;
245                         for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
246                         }
247                 }
248         bn_correct_top(r);
249
250         /* mont->ri will be a multiple of the word size and below code
251          * is kind of BN_rshift(ret,r,mont->ri) equivalent */
252         if (r->top <= ri)
253                 {
254                 ret->top=0;
255                 return(1);
256                 }
257         al=r->top-ri;
258
259 #define BRANCH_FREE 1
260 #if BRANCH_FREE
261         if (bn_wexpand(ret,ri) == NULL) return(0);
262         x=0-(((al-ri)>>(sizeof(al)*8-1))&1);
263         ret->top=x=(ri&~x)|(al&x);      /* min(ri,al) */
264         ret->neg=r->neg;
265
266         rp=ret->d;
267         ap=&(r->d[ri]);
268
269         {
270         size_t m1,m2;
271
272         v=bn_sub_words(rp,ap,np,ri);
273         /* this ----------------^^ works even in al<ri case
274          * thanks to zealous zeroing of top of the vector in the
275          * beginning. */
276
277         /* if (al==ri && !v) || al>ri) nrp=rp; else nrp=ap; */
278         /* in other words if subtraction result is real, then
279          * trick unconditional memcpy below to perform in-place
280          * "refresh" instead of actual copy. */
281         m1=0-(size_t)(((al-ri)>>(sizeof(al)*8-1))&1);   /* al<ri */
282         m2=0-(size_t)(((ri-al)>>(sizeof(al)*8-1))&1);   /* al>ri */
283         m1|=m2;                 /* (al!=ri) */
284         m1|=(0-(size_t)v);      /* (al!=ri || v) */
285         m1&=~m2;                /* (al!=ri || v) && !al>ri */
286         nrp=(BN_ULONG *)(((size_t)rp&~m1)|((size_t)ap&m1));
287         }
288
289         /* 'i<ri' is chosen to eliminate dependency on input data, even
290          * though it results in redundant copy in al<ri case. */
291         for (i=0,ri-=4; i<ri; i+=4)
292                 {
293                 BN_ULONG t1,t2,t3,t4;
294                 
295                 t1=nrp[i+0];
296                 t2=nrp[i+1];
297                 t3=nrp[i+2];    ap[i+0]=0;
298                 t4=nrp[i+3];    ap[i+1]=0;
299                 rp[i+0]=t1;     ap[i+2]=0;
300                 rp[i+1]=t2;     ap[i+3]=0;
301                 rp[i+2]=t3;
302                 rp[i+3]=t4;
303                 }
304         for (ri+=4; i<ri; i++)
305                 rp[i]=nrp[i], ap[i]=0;
306         bn_correct_top(r);
307         bn_correct_top(ret);
308 #else
309         if (bn_wexpand(ret,al) == NULL) return(0);
310         ret->top=al;
311         ret->neg=r->neg;
312
313         rp=ret->d;
314         ap=&(r->d[ri]);
315         al-=4;
316         for (i=0; i<al; i+=4)
317                 {
318                 BN_ULONG t1,t2,t3,t4;
319                 
320                 t1=ap[i+0];
321                 t2=ap[i+1];
322                 t3=ap[i+2];
323                 t4=ap[i+3];
324                 rp[i+0]=t1;
325                 rp[i+1]=t2;
326                 rp[i+2]=t3;
327                 rp[i+3]=t4;
328                 }
329         al+=4;
330         for (; i<al; i++)
331                 rp[i]=ap[i];
332
333         if (BN_ucmp(ret, &(mont->N)) >= 0)
334                 {
335                 if (!BN_usub(ret,ret,&(mont->N))) return(0);
336                 }
337 #endif
338         bn_check_top(ret);
339
340         return(1);
341         }
342 #endif  /* MONT_WORD */
343
344 int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a, BN_MONT_CTX *mont,
345              BN_CTX *ctx)
346         {
347         int retn=0;
348 #ifdef MONT_WORD
349         BIGNUM *t;
350
351         BN_CTX_start(ctx);
352         if ((t = BN_CTX_get(ctx)) && BN_copy(t,a))
353                 retn = BN_from_montgomery_word(ret,t,mont);
354         BN_CTX_end(ctx);
355 #else /* !MONT_WORD */
356         BIGNUM *t1,*t2;
357
358         BN_CTX_start(ctx);
359         t1 = BN_CTX_get(ctx);
360         t2 = BN_CTX_get(ctx);
361         if (t1 == NULL || t2 == NULL) goto err;
362         
363         if (!BN_copy(t1,a)) goto err;
364         BN_mask_bits(t1,mont->ri);
365
366         if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
367         BN_mask_bits(t2,mont->ri);
368
369         if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
370         if (!BN_add(t2,a,t1)) goto err;
371         if (!BN_rshift(ret,t2,mont->ri)) goto err;
372
373         if (BN_ucmp(ret, &(mont->N)) >= 0)
374                 {
375                 if (!BN_usub(ret,ret,&(mont->N))) goto err;
376                 }
377         retn=1;
378         bn_check_top(ret);
379  err:
380         BN_CTX_end(ctx);
381 #endif /* MONT_WORD */
382         return(retn);
383         }
384
385 BN_MONT_CTX *BN_MONT_CTX_new(void)
386         {
387         BN_MONT_CTX *ret;
388
389         if ((ret=(BN_MONT_CTX *)OPENSSL_malloc(sizeof(BN_MONT_CTX))) == NULL)
390                 return(NULL);
391
392         BN_MONT_CTX_init(ret);
393         ret->flags=BN_FLG_MALLOCED;
394         return(ret);
395         }
396
397 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
398         {
399         ctx->ri=0;
400         BN_init(&(ctx->RR));
401         BN_init(&(ctx->N));
402         BN_init(&(ctx->Ni));
403         ctx->n0[0] = ctx->n0[1] = 0;
404         ctx->flags=0;
405         }
406
407 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
408         {
409         if(mont == NULL)
410             return;
411
412         BN_free(&(mont->RR));
413         BN_free(&(mont->N));
414         BN_free(&(mont->Ni));
415         if (mont->flags & BN_FLG_MALLOCED)
416                 OPENSSL_free(mont);
417         }
418
419 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
420         {
421         int ret = 0;
422         BIGNUM *Ri,*R;
423
424         BN_CTX_start(ctx);
425         if((Ri = BN_CTX_get(ctx)) == NULL) goto err;
426         R= &(mont->RR);                                 /* grab RR as a temp */
427         if (!BN_copy(&(mont->N),mod)) goto err;         /* Set N */
428         mont->N.neg = 0;
429
430 #ifdef MONT_WORD
431                 {
432                 BIGNUM tmod;
433                 BN_ULONG buf[2];
434
435                 BN_init(&tmod);
436                 tmod.d=buf;
437                 tmod.dmax=2;
438                 tmod.neg=0;
439
440                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
441
442 #if defined(OPENSSL_BN_ASM_MONT) && (BN_BITS2<=32)
443                 /* Only certain BN_BITS2<=32 platforms actually make use of
444                  * n0[1], and we could use the #else case (with a shorter R
445                  * value) for the others.  However, currently only the assembler
446                  * files do know which is which. */
447
448                 BN_zero(R);
449                 if (!(BN_set_bit(R,2*BN_BITS2))) goto err;
450
451                                                                 tmod.top=0;
452                 if ((buf[0] = mod->d[0]))                       tmod.top=1;
453                 if ((buf[1] = mod->top>1 ? mod->d[1] : 0))      tmod.top=2;
454
455                 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
456                         goto err;
457                 if (!BN_lshift(Ri,Ri,2*BN_BITS2)) goto err; /* R*Ri */
458                 if (!BN_is_zero(Ri))
459                         {
460                         if (!BN_sub_word(Ri,1)) goto err;
461                         }
462                 else /* if N mod word size == 1 */
463                         {
464                         if (bn_expand(Ri,(int)sizeof(BN_ULONG)*2) == NULL)
465                                 goto err;
466                         /* Ri-- (mod double word size) */
467                         Ri->neg=0;
468                         Ri->d[0]=BN_MASK2;
469                         Ri->d[1]=BN_MASK2;
470                         Ri->top=2;
471                         }
472                 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
473                 /* Ni = (R*Ri-1)/N,
474                  * keep only couple of least significant words: */
475                 mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
476                 mont->n0[1] = (Ri->top > 1) ? Ri->d[1] : 0;
477 #else
478                 BN_zero(R);
479                 if (!(BN_set_bit(R,BN_BITS2))) goto err;        /* R */
480
481                 buf[0]=mod->d[0]; /* tmod = N mod word size */
482                 buf[1]=0;
483                 tmod.top = buf[0] != 0 ? 1 : 0;
484                                                         /* Ri = R^-1 mod N*/
485                 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
486                         goto err;
487                 if (!BN_lshift(Ri,Ri,BN_BITS2)) goto err; /* R*Ri */
488                 if (!BN_is_zero(Ri))
489                         {
490                         if (!BN_sub_word(Ri,1)) goto err;
491                         }
492                 else /* if N mod word size == 1 */
493                         {
494                         if (!BN_set_word(Ri,BN_MASK2)) goto err;  /* Ri-- (mod word size) */
495                         }
496                 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
497                 /* Ni = (R*Ri-1)/N,
498                  * keep only least significant word: */
499                 mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
500                 mont->n0[1] = 0;
501 #endif
502                 }
503 #else /* !MONT_WORD */
504                 { /* bignum version */
505                 mont->ri=BN_num_bits(&mont->N);
506                 BN_zero(R);
507                 if (!BN_set_bit(R,mont->ri)) goto err;  /* R = 2^ri */
508                                                         /* Ri = R^-1 mod N*/
509                 if ((BN_mod_inverse(Ri,R,&mont->N,ctx)) == NULL)
510                         goto err;
511                 if (!BN_lshift(Ri,Ri,mont->ri)) goto err; /* R*Ri */
512                 if (!BN_sub_word(Ri,1)) goto err;
513                                                         /* Ni = (R*Ri-1) / N */
514                 if (!BN_div(&(mont->Ni),NULL,Ri,&mont->N,ctx)) goto err;
515                 }
516 #endif
517
518         /* setup RR for conversions */
519         BN_zero(&(mont->RR));
520         if (!BN_set_bit(&(mont->RR),mont->ri*2)) goto err;
521         if (!BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx)) goto err;
522
523         ret = 1;
524 err:
525         BN_CTX_end(ctx);
526         return ret;
527         }
528
529 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
530         {
531         if (to == from) return(to);
532
533         if (!BN_copy(&(to->RR),&(from->RR))) return NULL;
534         if (!BN_copy(&(to->N),&(from->N))) return NULL;
535         if (!BN_copy(&(to->Ni),&(from->Ni))) return NULL;
536         to->ri=from->ri;
537         to->n0[0]=from->n0[0];
538         to->n0[1]=from->n0[1];
539         return(to);
540         }
541
542 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
543                                         const BIGNUM *mod, BN_CTX *ctx)
544         {
545         int got_write_lock = 0;
546         BN_MONT_CTX *ret;
547
548         CRYPTO_r_lock(lock);
549         if (!*pmont)
550                 {
551                 CRYPTO_r_unlock(lock);
552                 CRYPTO_w_lock(lock);
553                 got_write_lock = 1;
554
555                 if (!*pmont)
556                         {
557                         ret = BN_MONT_CTX_new();
558                         if (ret && !BN_MONT_CTX_set(ret, mod, ctx))
559                                 BN_MONT_CTX_free(ret);
560                         else
561                                 *pmont = ret;
562                         }
563                 }
564         
565         ret = *pmont;
566         
567         if (got_write_lock)
568                 CRYPTO_w_unlock(lock);
569         else
570                 CRYPTO_r_unlock(lock);
571                 
572         return ret;
573         }