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