e73b0cbb693df6c96fdba26c833cba7e4cf2a6cc
[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 /*
60  * Details about Montgomery multiplication algorithms can be found at:
61  * http://www.ece.orst.edu/ISL/Publications.html
62  * http://www.ece.orst.edu/ISL/Koc/papers/j37acmon.pdf
63  */
64
65 #include <stdio.h>
66 #include "cryptlib.h"
67 #include "bn_lcl.h"
68
69 #define MONT_WORD
70
71 int BN_mod_mul_montgomery(r,a,b,mont,ctx)
72 BIGNUM *r,*a,*b;
73 BN_MONT_CTX *mont;
74 BN_CTX *ctx;
75         {
76         BIGNUM *tmp,*tmp2;
77
78         tmp= &(ctx->bn[ctx->tos]);
79         tmp2= &(ctx->bn[ctx->tos]);
80         ctx->tos+=2;
81
82         bn_check_top(tmp);
83         bn_check_top(tmp2);
84
85         if (a == b)
86                 {
87 #if 0
88                 bn_wexpand(tmp,a->top*2);
89                 bn_wexpand(tmp2,a->top*4);
90                 bn_sqr_recursive(tmp->d,a->d,a->top,tmp2->d);
91                 tmp->top=a->top*2;
92                 if (tmp->d[tmp->top-1] == 0)
93                         tmp->top--;
94 #else
95                 if (!BN_sqr(tmp,a,ctx)) goto err;
96 #endif
97                 }
98         else
99                 {
100                 if (!BN_mul(tmp,a,b,ctx)) goto err;
101                 }
102         /* reduce from aRR to aR */
103         if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
104         ctx->tos-=2;
105         return(1);
106 err:
107         return(0);
108         }
109
110 int BN_from_montgomery(ret,a,mont,ctx)
111 BIGNUM *ret;
112 BIGNUM *a;
113 BN_MONT_CTX *mont;
114 BN_CTX *ctx;
115         {
116 #ifdef BN_RECURSION
117         if (mont->use_word)
118 #endif
119                 {
120                 BIGNUM *n,*r;
121                 BN_ULONG *ap,*np,*rp,n0,v,*nrp;
122                 int al,nl,max,i,x,ri;
123                 int retn=0;
124
125                 r= &(ctx->bn[ctx->tos]);
126
127                 if (!BN_copy(r,a)) goto err1;
128                 n= &(mont->N);
129
130                 ap=a->d;
131                 /* mont->ri is the size of mont->N in bits/words */
132                 al=ri=mont->ri/BN_BITS2;
133
134                 nl=n->top;
135                 if ((al == 0) || (nl == 0)) { r->top=0; return(1); }
136
137                 max=(nl+al+1); /* allow for overflow (no?) XXX */
138                 if (bn_wexpand(r,max) == NULL) goto err1;
139                 if (bn_wexpand(ret,max) == NULL) goto err1;
140
141                 r->neg=a->neg^n->neg;
142                 np=n->d;
143                 rp=r->d;
144                 nrp= &(r->d[nl]);
145
146                 /* clear the top words of T */
147 #if 1
148                 for (i=r->top; i<max; i++) /* memset? XXX */
149                         r->d[i]=0;
150 #else
151                 memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG)); 
152 #endif
153
154                 r->top=max;
155                 n0=mont->n0;
156
157 #ifdef BN_COUNT
158 printf("word BN_from_montgomery %d * %d\n",nl,nl);
159 #endif
160                 for (i=0; i<nl; i++)
161                         {
162                         v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
163                         nrp++;
164                         rp++;
165                         if (((nrp[-1]+=v)&BN_MASK2) >= v)
166                                 continue;
167                         else
168                                 {
169                                 if (((++nrp[0])&BN_MASK2) != 0) continue;
170                                 if (((++nrp[1])&BN_MASK2) != 0) continue;
171                                 for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
172                                 }
173                         }
174                 bn_fix_top(r);
175
176                 /* mont->ri will be a multiple of the word size */
177 #if 0
178                 BN_rshift(ret,r,mont->ri);
179 #else
180                 x=ri;
181                 rp=ret->d;
182                 ap= &(r->d[x]);
183                 if (r->top < x)
184                         al=0;
185                 else
186                         al=r->top-x;
187                 ret->top=al;
188                 al-=4;
189                 for (i=0; i<al; i+=4)
190                         {
191                         BN_ULONG t1,t2,t3,t4;
192
193                         t1=ap[i+0];
194                         t2=ap[i+1];
195                         t3=ap[i+2];
196                         t4=ap[i+3];
197                         rp[i+0]=t1;
198                         rp[i+1]=t2;
199                         rp[i+2]=t3;
200                         rp[i+3]=t4;
201                         }
202                 al+=4;
203                 for (; i<al; i++)
204                         rp[i]=ap[i];
205 #endif
206
207                 if (BN_ucmp(ret, &(mont->N)) >= 0)
208                         {
209                         BN_usub(ret,ret,&(mont->N)); /* XXX */
210                         }
211                 retn=1;
212 err1:
213                 return(retn);
214                 }
215 #ifdef BN_RECURSION
216         else /* bignum version */ 
217                 {
218                 BIGNUM *t1,*t2,*t3;
219                 int j,i;
220
221 #ifdef BN_COUNT
222 printf("number BN_from_montgomery\n");
223 #endif
224
225                 t1= &(ctx->bn[ctx->tos]);
226                 t2= &(ctx->bn[ctx->tos+1]);
227                 t3= &(ctx->bn[ctx->tos+2]);
228
229                 i=mont->Ni.top;
230                 bn_wexpand(ret,i); /* perhaps only i*2 */
231                 bn_wexpand(t1,i*4); /* perhaps only i*2 */
232                 bn_wexpand(t2,i*2); /* perhaps only i   */
233
234                 bn_mul_low_recursive(t2->d,a->d,mont->Ni.d,i,t1->d);
235
236                 BN_zero(t3);
237                 BN_set_bit(t3,mont->N.top*BN_BITS2);
238                 bn_sub_words(t3->d,t3->d,a->d,i);
239                 bn_mul_high(ret->d,t2->d,mont->N.d,t3->d,i,t1->d);
240
241                 /* hmm... if a is between i and 2*i, things are bad */
242                 if (a->top > i)
243                         {
244                         j=(int)(bn_add_words(ret->d,ret->d,&(a->d[i]),i));
245                         if (j) /* overflow */
246                                 bn_sub_words(ret->d,ret->d,mont->N.d,i);
247                         }
248                 ret->top=i;
249                 bn_fix_top(ret);
250                 if (a->d[0])
251                         BN_add_word(ret,1); /* Always? */
252                 else    /* Very very rare */
253                         {
254                         for (i=1; i<mont->N.top-1; i++)
255                                 {
256                                 if (a->d[i])
257                                         {
258                                         BN_add_word(ret,1); /* Always? */
259                                         break;
260                                         }
261                                 }
262                         }
263
264                 if (BN_ucmp(ret,&(mont->N)) >= 0)
265                         BN_usub(ret,ret,&(mont->N));
266
267                 return(1);
268                 }
269 #endif
270         }
271
272 BN_MONT_CTX *BN_MONT_CTX_new()
273         {
274         BN_MONT_CTX *ret;
275
276         if ((ret=(BN_MONT_CTX *)Malloc(sizeof(BN_MONT_CTX))) == NULL)
277                 return(NULL);
278
279         BN_MONT_CTX_init(ret);
280         ret->flags=BN_FLG_MALLOCED;
281         return(ret);
282         }
283
284 void BN_MONT_CTX_init(ctx)
285 BN_MONT_CTX *ctx;
286         {
287         ctx->use_word=0;
288         ctx->ri=0;
289         BN_init(&(ctx->RR));
290         BN_init(&(ctx->N));
291         BN_init(&(ctx->Ni));
292         ctx->flags=0;
293         }
294
295 void BN_MONT_CTX_free(mont)
296 BN_MONT_CTX *mont;
297         {
298         if(mont == NULL)
299             return;
300
301         BN_free(&(mont->RR));
302         BN_free(&(mont->N));
303         BN_free(&(mont->Ni));
304         if (mont->flags & BN_FLG_MALLOCED)
305                 Free(mont);
306         }
307
308 int BN_MONT_CTX_set(mont,mod,ctx)
309 BN_MONT_CTX *mont;
310 BIGNUM *mod;
311 BN_CTX *ctx;
312         {
313         BIGNUM Ri,*R;
314
315         BN_init(&Ri);
316         R= &(mont->RR);                                 /* grab RR as a temp */
317         BN_copy(&(mont->N),mod);                        /* Set N */
318
319 #ifdef BN_RECURSION
320         if (mont->N.top < BN_MONT_CTX_SET_SIZE_WORD)
321 #endif
322                 {
323                 BIGNUM tmod;
324                 BN_ULONG buf[2];
325
326                 mont->use_word=1;
327
328                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
329                 BN_zero(R);
330                 BN_set_bit(R,BN_BITS2);
331                 /* I was bad, this modification of a passed variable was
332                  * breaking the multithreaded stuff :-(
333                  * z=mod->top;
334                  * mod->top=1; */
335
336                 buf[0]=mod->d[0];
337                 buf[1]=0;
338                 tmod.d=buf;
339                 tmod.top=1;
340                 tmod.max=mod->max;
341                 tmod.neg=mod->neg;
342
343                 if ((BN_mod_inverse(&Ri,R,&tmod,ctx)) == NULL)
344                         goto err;
345                 BN_lshift(&Ri,&Ri,BN_BITS2);                    /* R*Ri */
346                 if (!BN_is_zero(&Ri))
347                         {
348 #if 1
349                         BN_sub_word(&Ri,1);
350 #else
351                         BN_usub(&Ri,&Ri,BN_value_one());        /* R*Ri - 1 */
352 #endif
353                         }
354                 else
355                         {
356                         /* This is not common..., 1 in BN_MASK2,
357                          * It happens when buf[0] was == 1.  So for 8 bit,
358                          * this is 1/256, 16bit, 1 in 2^16 etc.
359                          */
360                         BN_set_word(&Ri,BN_MASK2);
361                         }
362                 BN_div(&Ri,NULL,&Ri,&tmod,ctx);
363                 mont->n0=Ri.d[0];
364                 BN_free(&Ri);
365                 /* mod->top=z; */
366                 }
367 #ifdef BN_RECURSION
368         else
369                 {
370                 mont->use_word=0;
371                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
372 #if 1
373                 BN_zero(R);
374                 BN_set_bit(R,mont->ri);
375 #else
376                 BN_lshift(R,BN_value_one(),mont->ri);   /* R */
377 #endif
378                 if ((BN_mod_inverse(&Ri,R,mod,ctx)) == NULL)
379                         goto err;
380                 BN_lshift(&Ri,&Ri,mont->ri);            /* R*Ri */
381 #if 1
382                 BN_sub_word(&Ri,1);
383 #else
384                 BN_usub(&Ri,&Ri,BN_value_one());        /* R*Ri - 1 */
385 #endif
386                 BN_div(&(mont->Ni),NULL,&Ri,mod,ctx);
387                 BN_free(&Ri);
388                 }
389 #endif
390
391         /* setup RR for conversions */
392 #if 1
393         BN_zero(&(mont->RR));
394         BN_set_bit(&(mont->RR),mont->ri*2);
395 #else
396         BN_lshift(mont->RR,BN_value_one(),mont->ri*2);
397 #endif
398         BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx);
399
400         return(1);
401 err:
402         return(0);
403         }
404
405 BN_MONT_CTX *BN_MONT_CTX_copy(to, from)
406 BN_MONT_CTX *to, *from;
407         {
408         if (to == from) return(to);
409
410         BN_copy(&(to->RR),&(from->RR));
411         BN_copy(&(to->N),&(from->N));
412         BN_copy(&(to->Ni),&(from->Ni));
413         to->use_word=from->use_word;
414         to->ri=from->ri;
415         to->n0=from->n0;
416         return(to);
417         }
418