Add a pointer to a paper (is the algorithm in section 4.2 the
[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         tmp= &(ctx->bn[ctx->tos]);
76         tmp2= &(ctx->bn[ctx->tos]);
77         ctx->tos+=2;
78
79         bn_check_top(tmp);
80         bn_check_top(tmp2);
81
82         if (a == b)
83                 {
84 #if 0
85                 bn_wexpand(tmp,a->top*2);
86                 bn_wexpand(tmp2,a->top*4);
87                 bn_sqr_recursive(tmp->d,a->d,a->top,tmp2->d);
88                 tmp->top=a->top*2;
89                 if (tmp->d[tmp->top-1] == 0)
90                         tmp->top--;
91 #else
92                 if (!BN_sqr(tmp,a,ctx)) goto err;
93 #endif
94                 }
95         else
96                 {
97                 if (!BN_mul(tmp,a,b,ctx)) goto err;
98                 }
99         /* reduce from aRR to aR */
100         if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
101         ctx->tos-=2;
102         return(1);
103 err:
104         return(0);
105         }
106
107 int BN_from_montgomery(BIGNUM *ret, BIGNUM *a, BN_MONT_CTX *mont,
108              BN_CTX *ctx)
109         {
110         int retn=0;
111 #ifdef BN_RECURSION_MONT
112         if (mont->use_word)
113 #endif
114                 {
115                 BIGNUM *n,*r;
116                 BN_ULONG *ap,*np,*rp,n0,v,*nrp;
117                 int al,nl,max,i,x,ri;
118
119                 r= &(ctx->bn[ctx->tos]);
120
121                 if (!BN_copy(r,a)) goto err;
122                 n= &(mont->N);
123
124                 ap=a->d;
125                 /* mont->ri is the size of mont->N in bits (rounded up
126                    to the word size) */
127                 al=ri=mont->ri/BN_BITS2;
128
129                 nl=n->top;
130                 if ((al == 0) || (nl == 0)) { r->top=0; return(1); }
131
132                 max=(nl+al+1); /* allow for overflow (no?) XXX */
133                 if (bn_wexpand(r,max) == NULL) goto err;
134                 if (bn_wexpand(ret,max) == NULL) goto err;
135
136                 r->neg=a->neg^n->neg;
137                 np=n->d;
138                 rp=r->d;
139                 nrp= &(r->d[nl]);
140
141                 /* clear the top words of T */
142 #if 1
143                 for (i=r->top; i<max; i++) /* memset? XXX */
144                         r->d[i]=0;
145 #else
146                 memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG)); 
147 #endif
148
149                 r->top=max;
150                 n0=mont->n0;
151
152 #ifdef BN_COUNT
153 printf("word BN_from_montgomery %d * %d\n",nl,nl);
154 #endif
155                 for (i=0; i<nl; i++)
156                         {
157                         v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
158                         nrp++;
159                         rp++;
160                         if (((nrp[-1]+=v)&BN_MASK2) >= v)
161                                 continue;
162                         else
163                                 {
164                                 if (((++nrp[0])&BN_MASK2) != 0) continue;
165                                 if (((++nrp[1])&BN_MASK2) != 0) continue;
166                                 for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
167                                 }
168                         }
169                 bn_fix_top(r);
170
171                 /* mont->ri will be a multiple of the word size */
172 #if 0
173                 BN_rshift(ret,r,mont->ri);
174 #else
175                 x=ri;
176                 rp=ret->d;
177                 ap= &(r->d[x]);
178                 if (r->top < x)
179                         al=0;
180                 else
181                         al=r->top-x;
182                 ret->top=al;
183                 al-=4;
184                 for (i=0; i<al; i+=4)
185                         {
186                         BN_ULONG t1,t2,t3,t4;
187
188                         t1=ap[i+0];
189                         t2=ap[i+1];
190                         t3=ap[i+2];
191                         t4=ap[i+3];
192                         rp[i+0]=t1;
193                         rp[i+1]=t2;
194                         rp[i+2]=t3;
195                         rp[i+3]=t4;
196                         }
197                 al+=4;
198                 for (; i<al; i++)
199                         rp[i]=ap[i];
200 #endif
201
202                 if (BN_ucmp(ret, &(mont->N)) >= 0)
203                         {
204                         BN_usub(ret,ret,&(mont->N)); /* XXX */
205                         }
206                 retn=1;
207                 }
208 #ifdef BN_RECURSION_MONT
209         else /* bignum version */ 
210                 {
211                 BIGNUM *t1,*t2;
212
213                 t1=&(ctx->bn[ctx->tos]);
214                 t2=&(ctx->bn[ctx->tos+1]);
215                 ctx->tos+=2;
216
217                 if (!BN_copy(t1,a)) goto err;
218                 BN_mask_bits(t1,mont->ri);
219
220                 if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
221                 BN_mask_bits(t2,mont->ri);
222
223                 if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
224                 if (!BN_add(t2,a,t1)) goto err;
225                 BN_rshift(ret,t2,mont->ri);
226
227                 if (BN_ucmp(ret,&mont->N) >= 0)
228                         BN_usub(ret,ret,&mont->N);
229                 ctx->tos-=2;
230                 retn=1;
231                 }
232 #endif
233  err:
234         return(retn);
235         }
236
237 BN_MONT_CTX *BN_MONT_CTX_new(void)
238         {
239         BN_MONT_CTX *ret;
240
241         if ((ret=(BN_MONT_CTX *)Malloc(sizeof(BN_MONT_CTX))) == NULL)
242                 return(NULL);
243
244         BN_MONT_CTX_init(ret);
245         ret->flags=BN_FLG_MALLOCED;
246         return(ret);
247         }
248
249 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
250         {
251         ctx->use_word=0;
252         ctx->ri=0;
253         BN_init(&(ctx->RR));
254         BN_init(&(ctx->N));
255         BN_init(&(ctx->Ni));
256         ctx->flags=0;
257         }
258
259 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
260         {
261         if(mont == NULL)
262             return;
263
264         BN_free(&(mont->RR));
265         BN_free(&(mont->N));
266         BN_free(&(mont->Ni));
267         if (mont->flags & BN_FLG_MALLOCED)
268                 Free(mont);
269         }
270
271 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
272         {
273         BIGNUM Ri,*R;
274
275         BN_init(&Ri);
276         R= &(mont->RR);                                 /* grab RR as a temp */
277         BN_copy(&(mont->N),mod);                        /* Set N */
278
279 #ifdef BN_RECURSION_MONT
280         /* the word-based algorithm is faster */
281         if (mont->N.top > BN_MONT_CTX_SET_SIZE_WORD)
282 #endif
283                 {
284                 BIGNUM tmod;
285                 BN_ULONG buf[2];
286
287                 mont->use_word=1;
288
289                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
290                 BN_zero(R);
291                 BN_set_bit(R,BN_BITS2);                 /* R = 2^ri */
292
293                 buf[0]=mod->d[0]; /* tmod = N mod word size */
294                 buf[1]=0;
295                 tmod.d=buf;
296                 tmod.top=1;
297                 tmod.max=2;
298                 tmod.neg=mod->neg;
299                                                         /* Ri = R^-1 mod N*/
300                 if ((BN_mod_inverse(&Ri,R,&tmod,ctx)) == NULL)
301                         goto err;
302                 BN_lshift(&Ri,&Ri,BN_BITS2);            /* R*Ri */
303                 if (!BN_is_zero(&Ri))
304                         BN_sub_word(&Ri,1);
305                 else /* if N mod word size == 1 */
306                         BN_set_word(&Ri,BN_MASK2);  /* Ri-- (mod word size) */
307                 BN_div(&Ri,NULL,&Ri,&tmod,ctx);          /* Ni = (R*Ri-1)/N */
308                 mont->n0=Ri.d[0];
309                 BN_free(&Ri);
310                 }
311 #ifdef BN_RECURSION_MONT
312         else
313                 { /* bignum version */
314                 mont->use_word=0;
315                 mont->ri=BN_num_bits(mod);
316                 BN_zero(R);
317                 BN_set_bit(R,mont->ri);                 /* R = 2^ri */
318                                                         /* Ri = R^-1 mod N*/
319                 if ((BN_mod_inverse(&Ri,R,mod,ctx)) == NULL)
320                         goto err;
321                 BN_lshift(&Ri,&Ri,mont->ri);            /* R*Ri */
322                 BN_sub_word(&Ri,1);
323                                                         /* Ni = (R*Ri-1) / N */
324                 BN_div(&(mont->Ni),NULL,&Ri,mod,ctx);
325                 BN_free(&Ri);
326                 }
327 #endif
328
329         /* setup RR for conversions */
330         BN_zero(&(mont->RR));
331         BN_set_bit(&(mont->RR),mont->ri*2);
332         BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx);
333
334         return(1);
335 err:
336         return(0);
337         }
338
339 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
340         {
341         if (to == from) return(to);
342
343         BN_copy(&(to->RR),&(from->RR));
344         BN_copy(&(to->N),&(from->N));
345         BN_copy(&(to->Ni),&(from->Ni));
346         to->use_word=from->use_word;
347         to->ri=from->ri;
348         to->n0=from->n0;
349         return(to);
350         }
351