New functions BN_CTX_start(), BN_CTX_get(), BN_CTX_end() to access
[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://security.ece.orst.edu/publications.html, e.g.
62  * http://security.ece.orst.edu/koc/papers/j37acmon.pdf and
63  * sections 3.8 and 4.2 in http://security.ece.orst.edu/koc/papers/r01rsasw.pdf
64  */
65
66 #include <stdio.h>
67 #include "cryptlib.h"
68 #include "bn_lcl.h"
69
70 int BN_mod_mul_montgomery(BIGNUM *r, BIGNUM *a, BIGNUM *b,
71                           BN_MONT_CTX *mont, BN_CTX *ctx)
72         {
73         BIGNUM *tmp,*tmp2;
74
75         BN_CTX_start(ctx);
76         tmp = BN_CTX_get(ctx);
77         tmp2 = BN_CTX_get(ctx);
78         if (tmp == NULL || tmp2 == NULL) goto err;
79
80         bn_check_top(tmp);
81         bn_check_top(tmp2);
82
83         if (a == b)
84                 {
85 #if 0
86                 bn_wexpand(tmp,a->top*2);
87                 bn_wexpand(tmp2,a->top*4);
88                 bn_sqr_recursive(tmp->d,a->d,a->top,tmp2->d);
89                 tmp->top=a->top*2;
90                 if (tmp->d[tmp->top-1] == 0)
91                         tmp->top--;
92 #else
93                 if (!BN_sqr(tmp,a,ctx)) goto err;
94 #endif
95                 }
96         else
97                 {
98                 if (!BN_mul(tmp,a,b,ctx)) goto err;
99                 }
100         /* reduce from aRR to aR */
101         if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
102         BN_CTX_end(ctx);
103         return(1);
104 err:
105         return(0);
106         }
107
108 #define BN_RECURSION_MONT
109
110 int BN_from_montgomery(BIGNUM *ret, BIGNUM *a, BN_MONT_CTX *mont,
111              BN_CTX *ctx)
112         {
113         int retn=0;
114         BN_CTX_start(ctx);
115
116 #ifdef BN_RECURSION_MONT
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
124                 if ((r = BN_CTX_get(ctx)) == NULL) goto err;
125
126                 if (!BN_copy(r,a)) goto err;
127                 n= &(mont->N);
128
129                 ap=a->d;
130                 /* mont->ri is the size of mont->N in bits (rounded up
131                    to the word size) */
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 err;
139                 if (bn_wexpand(ret,max) == NULL) goto err;
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                 }
213 #ifdef BN_RECURSION_MONT
214         else /* bignum version */ 
215                 {
216                 BIGNUM *t1,*t2;
217
218                 t1 = BN_CTX_get(ctx);
219                 t2 = BN_CTX_get(ctx);
220                 if (t1 == NULL || t2 == NULL) goto err;
221
222                 if (!BN_copy(t1,a)) goto err;
223                 BN_mask_bits(t1,mont->ri);
224
225                 if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
226                 BN_mask_bits(t2,mont->ri);
227
228                 if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
229                 if (!BN_add(t2,a,t1)) goto err;
230                 BN_rshift(ret,t2,mont->ri);
231
232                 if (BN_ucmp(ret,&mont->N) >= 0)
233                         BN_usub(ret,ret,&mont->N);
234                 retn=1;
235                 }
236 #endif
237  err:
238         BN_CTX_end(ctx);
239         return(retn);
240         }
241
242 BN_MONT_CTX *BN_MONT_CTX_new(void)
243         {
244         BN_MONT_CTX *ret;
245
246         if ((ret=(BN_MONT_CTX *)Malloc(sizeof(BN_MONT_CTX))) == NULL)
247                 return(NULL);
248
249         BN_MONT_CTX_init(ret);
250         ret->flags=BN_FLG_MALLOCED;
251         return(ret);
252         }
253
254 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
255         {
256         ctx->use_word=0;
257         ctx->ri=0;
258         BN_init(&(ctx->RR));
259         BN_init(&(ctx->N));
260         BN_init(&(ctx->Ni));
261         ctx->flags=0;
262         }
263
264 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
265         {
266         if(mont == NULL)
267             return;
268
269         BN_free(&(mont->RR));
270         BN_free(&(mont->N));
271         BN_free(&(mont->Ni));
272         if (mont->flags & BN_FLG_MALLOCED)
273                 Free(mont);
274         }
275
276 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
277         {
278         BIGNUM Ri,*R;
279
280         BN_init(&Ri);
281         R= &(mont->RR);                                 /* grab RR as a temp */
282         BN_copy(&(mont->N),mod);                        /* Set N */
283
284 #ifdef BN_RECURSION_MONT
285         /* the word-based algorithm is faster */
286         if (mont->N.top > BN_MONT_CTX_SET_SIZE_WORD)
287 #endif
288                 {
289                 BIGNUM tmod;
290                 BN_ULONG buf[2];
291
292                 mont->use_word=1;
293
294                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
295                 BN_zero(R);
296                 BN_set_bit(R,BN_BITS2);                 /* R */
297
298                 buf[0]=mod->d[0]; /* tmod = N mod word size */
299                 buf[1]=0;
300                 tmod.d=buf;
301                 tmod.top=1;
302                 tmod.max=2;
303                 tmod.neg=mod->neg;
304                                                         /* Ri = R^-1 mod N*/
305                 if ((BN_mod_inverse(&Ri,R,&tmod,ctx)) == NULL)
306                         goto err;
307                 BN_lshift(&Ri,&Ri,BN_BITS2);            /* R*Ri */
308                 if (!BN_is_zero(&Ri))
309                         BN_sub_word(&Ri,1);
310                 else /* if N mod word size == 1 */
311                         BN_set_word(&Ri,BN_MASK2);  /* Ri-- (mod word size) */
312                 BN_div(&Ri,NULL,&Ri,&tmod,ctx); /* Ni = (R*Ri-1)/N,
313                                                  * keep only least significant word: */
314                 mont->n0=Ri.d[0];
315                 BN_free(&Ri);
316                 }
317 #ifdef BN_RECURSION_MONT
318         else
319                 { /* bignum version */
320                 mont->use_word=0;
321                 mont->ri=BN_num_bits(mod);
322                 BN_zero(R);
323                 BN_set_bit(R,mont->ri);                 /* R = 2^ri */
324                                                         /* Ri = R^-1 mod N*/
325                 if ((BN_mod_inverse(&Ri,R,mod,ctx)) == NULL)
326                         goto err;
327                 BN_lshift(&Ri,&Ri,mont->ri);            /* R*Ri */
328                 BN_sub_word(&Ri,1);
329                                                         /* Ni = (R*Ri-1) / N */
330                 BN_div(&(mont->Ni),NULL,&Ri,mod,ctx);
331                 BN_free(&Ri);
332                 }
333 #endif
334
335         /* setup RR for conversions */
336         BN_zero(&(mont->RR));
337         BN_set_bit(&(mont->RR),mont->ri*2);
338         BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx);
339
340         return(1);
341 err:
342         return(0);
343         }
344
345 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
346         {
347         if (to == from) return(to);
348
349         BN_copy(&(to->RR),&(from->RR));
350         BN_copy(&(to->N),&(from->N));
351         BN_copy(&(to->Ni),&(from->Ni));
352         to->use_word=from->use_word;
353         to->ri=from->ri;
354         to->n0=from->n0;
355         return(to);
356         }
357