b532305b80b08bc508342a167dac9cec92085cf0
[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 */
245 #if 0
246         BN_rshift(ret,r,mont->ri);
247 #else
248         if (r->top < ri)
249                 {
250                 ret->top=0;
251                 return(1);
252                 }
253         al=r->top-ri;
254         if (bn_wexpand(ret,al) == NULL) return(0);
255         ret->neg=r->neg;
256         ret->top=al;
257
258         rp=ret->d;
259         ap=&(r->d[ri]);
260         al-=4;
261         for (i=0; i<al; i+=4)
262                 {
263                 BN_ULONG t1,t2,t3,t4;
264                 
265                 t1=ap[i+0];
266                 t2=ap[i+1];
267                 t3=ap[i+2];
268                 t4=ap[i+3];
269                 rp[i+0]=t1;
270                 rp[i+1]=t2;
271                 rp[i+2]=t3;
272                 rp[i+3]=t4;
273                 }
274         al+=4;
275         for (; i<al; i++)
276                 rp[i]=ap[i];
277 #endif
278
279         if (BN_ucmp(ret, &(mont->N)) >= 0)
280                 {
281                 if (!BN_usub(ret,ret,&(mont->N))) return(0);
282                 }
283         bn_check_top(ret);
284
285         return(1);
286         }
287 #endif  /* MONT_WORD */
288
289 int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a, BN_MONT_CTX *mont,
290              BN_CTX *ctx)
291         {
292         int retn=0;
293 #ifdef MONT_WORD
294         BIGNUM *t;
295
296         BN_CTX_start(ctx);
297         if ((t = BN_CTX_get(ctx)) && BN_copy(t,a))
298                 retn = BN_from_montgomery_word(ret,t,mont);
299         BN_CTX_end(ctx);
300 #else /* !MONT_WORD */
301         BIGNUM *t1,*t2;
302
303         BN_CTX_start(ctx);
304         t1 = BN_CTX_get(ctx);
305         t2 = BN_CTX_get(ctx);
306         if (t1 == NULL || t2 == NULL) goto err;
307         
308         if (!BN_copy(t1,a)) goto err;
309         BN_mask_bits(t1,mont->ri);
310
311         if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
312         BN_mask_bits(t2,mont->ri);
313
314         if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
315         if (!BN_add(t2,a,t1)) goto err;
316         if (!BN_rshift(ret,t2,mont->ri)) goto err;
317
318         if (BN_ucmp(ret, &(mont->N)) >= 0)
319                 {
320                 if (!BN_usub(ret,ret,&(mont->N))) goto err;
321                 }
322         retn=1;
323         bn_check_top(ret);
324  err:
325         BN_CTX_end(ctx);
326 #endif /* MONT_WORD */
327         return(retn);
328         }
329
330 BN_MONT_CTX *BN_MONT_CTX_new(void)
331         {
332         BN_MONT_CTX *ret;
333
334         if ((ret=(BN_MONT_CTX *)OPENSSL_malloc(sizeof(BN_MONT_CTX))) == NULL)
335                 return(NULL);
336
337         BN_MONT_CTX_init(ret);
338         ret->flags=BN_FLG_MALLOCED;
339         return(ret);
340         }
341
342 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
343         {
344         ctx->ri=0;
345         BN_init(&(ctx->RR));
346         BN_init(&(ctx->N));
347         BN_init(&(ctx->Ni));
348         ctx->flags=0;
349         }
350
351 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
352         {
353         if(mont == NULL)
354             return;
355
356         BN_free(&(mont->RR));
357         BN_free(&(mont->N));
358         BN_free(&(mont->Ni));
359         if (mont->flags & BN_FLG_MALLOCED)
360                 OPENSSL_free(mont);
361         }
362
363 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
364         {
365         int ret = 0;
366         BIGNUM *Ri,*R;
367
368         BN_CTX_start(ctx);
369         if((Ri = BN_CTX_get(ctx)) == NULL) goto err;
370         R= &(mont->RR);                                 /* grab RR as a temp */
371         if (!BN_copy(&(mont->N),mod)) goto err;         /* Set N */
372         mont->N.neg = 0;
373
374 #ifdef MONT_WORD
375                 {
376                 BIGNUM tmod;
377                 BN_ULONG buf[2];
378
379                 tmod.d=buf;
380                 tmod.dmax=2;
381                 tmod.neg=0;
382
383                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
384
385 #if defined(OPENSSL_BN_ASM_MONT) && (BN_BITS2<=32)
386                 BN_zero(R);
387                 if (!(BN_set_bit(R,2*BN_BITS2))) goto err;
388
389                                                                 tmod.top=0;
390                 if ((buf[0] = mod->d[0]))                       tmod.top=1;
391                 if ((buf[1] = mod->top>1 ? mod->d[1] : 0))      tmod.top=2;
392
393                 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
394                         goto err;
395                 if (!BN_lshift(Ri,Ri,2*BN_BITS2)) goto err; /* R*Ri */
396                 if (!BN_is_zero(Ri))
397                         {
398                         if (!BN_sub_word(Ri,1)) goto err;
399                         }
400                 else /* if N mod word size == 1 */
401                         {
402                         if (bn_expand(Ri,(int)sizeof(BN_ULONG)*2) == NULL)
403                                 goto err;
404                         /* Ri-- (mod double word size) */
405                         Ri->neg=0;
406                         Ri->d[0]=BN_MASK2;
407                         Ri->d[1]=BN_MASK2;
408                         Ri->top=2;
409                         }
410                 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
411                 /* Ni = (R*Ri-1)/N,
412                  * keep only couple of least significant words: */
413                 mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
414                 mont->n0[1] = (Ri->top > 1) ? Ri->d[1] : 0;
415 #else
416                 BN_zero(R);
417                 if (!(BN_set_bit(R,BN_BITS2))) goto err;        /* R */
418
419                 buf[0]=mod->d[0]; /* tmod = N mod word size */
420                 buf[1]=0;
421                 tmod.top = buf[0] != 0 ? 1 : 0;
422                                                         /* Ri = R^-1 mod N*/
423                 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
424                         goto err;
425                 if (!BN_lshift(Ri,Ri,BN_BITS2)) goto err; /* R*Ri */
426                 if (!BN_is_zero(Ri))
427                         {
428                         if (!BN_sub_word(Ri,1)) goto err;
429                         }
430                 else /* if N mod word size == 1 */
431                         {
432                         if (!BN_set_word(Ri,BN_MASK2)) goto err;  /* Ri-- (mod word size) */
433                         }
434                 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
435                 /* Ni = (R*Ri-1)/N,
436                  * keep only least significant word: */
437                 mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
438                 mont->n0[1] = 0;
439 #endif
440                 }
441 #else /* !MONT_WORD */
442                 { /* bignum version */
443                 mont->ri=BN_num_bits(&mont->N);
444                 BN_zero(R);
445                 if (!BN_set_bit(R,mont->ri)) goto err;  /* R = 2^ri */
446                                                         /* Ri = R^-1 mod N*/
447                 if ((BN_mod_inverse(Ri,R,&mont->N,ctx)) == NULL)
448                         goto err;
449                 if (!BN_lshift(Ri,Ri,mont->ri)) goto err; /* R*Ri */
450                 if (!BN_sub_word(Ri,1)) goto err;
451                                                         /* Ni = (R*Ri-1) / N */
452                 if (!BN_div(&(mont->Ni),NULL,Ri,&mont->N,ctx)) goto err;
453                 }
454 #endif
455
456         /* setup RR for conversions */
457         BN_zero(&(mont->RR));
458         if (!BN_set_bit(&(mont->RR),mont->ri*2)) goto err;
459         if (!BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx)) goto err;
460
461         ret = 1;
462 err:
463         BN_CTX_end(ctx);
464         return ret;
465         }
466
467 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
468         {
469         if (to == from) return(to);
470
471         if (!BN_copy(&(to->RR),&(from->RR))) return NULL;
472         if (!BN_copy(&(to->N),&(from->N))) return NULL;
473         if (!BN_copy(&(to->Ni),&(from->Ni))) return NULL;
474         to->ri=from->ri;
475         to->n0[0]=from->n0[0];
476         to->n0[1]=from->n0[1];
477         return(to);
478         }
479
480 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
481                                         const BIGNUM *mod, BN_CTX *ctx)
482         {
483         int got_write_lock = 0;
484
485         CRYPTO_r_lock(lock);
486         if (!*pmont)
487                 {
488                 CRYPTO_r_unlock(lock);
489                 CRYPTO_w_lock(lock);
490                 got_write_lock = 1;
491
492                 if (!*pmont)
493                         {
494                         BN_MONT_CTX *mtmp;
495                         mtmp = BN_MONT_CTX_new();
496                         if (mtmp && !BN_MONT_CTX_set(mtmp, mod, ctx))
497                                 BN_MONT_CTX_free(mtmp);
498                         else
499                                 *pmont = mtmp;
500                         }
501                 }
502         
503         if (got_write_lock)
504                 CRYPTO_w_unlock(lock);
505         else
506                 CRYPTO_r_unlock(lock);
507                 
508         return *pmont;
509         }