8fb171e13235bf4ebd71963582acb56a4535faba
[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 #define MONT_WORD /* use the faster word-based algorithm */
71
72 int BN_mod_mul_montgomery(BIGNUM *r, BIGNUM *a, BIGNUM *b,
73                           BN_MONT_CTX *mont, BN_CTX *ctx)
74         {
75         BIGNUM *tmp,*tmp2;
76         int ret=0;
77
78         BN_CTX_start(ctx);
79         tmp = BN_CTX_get(ctx);
80         tmp2 = BN_CTX_get(ctx);
81         if (tmp == NULL || tmp2 == NULL) goto err;
82
83         bn_check_top(tmp);
84         bn_check_top(tmp2);
85
86         if (a == b)
87                 {
88 #if 0 /* buggy -- try squaring  g  (after converting it to Montgomery
89          representation) in the following parameters
90          (but note that squaring 2 or 4 works):
91 Diffie-Hellman-Parameters: (1024 bit)
92     prime:
93         00:ff:ff:ff:ff:ff:ff:ff:ff:c9:0f:da:a2:21:68:
94         c2:34:c4:c6:62:8b:80:dc:1c:d1:29:02:4e:08:8a:
95         67:cc:74:02:0b:be:a6:3b:13:9b:22:51:4a:08:79:
96         8e:34:04:dd:ef:95:19:b3:cd:3a:43:1b:30:2b:0a:
97         6d:f2:5f:14:37:4f:e1:35:6d:6d:51:c2:45:e4:85:
98         b5:76:62:5e:7e:c6:f4:4c:42:e9:a6:37:ed:6b:0b:
99         ff:5c:b6:f4:06:b7:ed:ee:38:6b:fb:5a:89:9f:a5:
100         ae:9f:24:11:7c:4b:1f:e6:49:28:66:51:ec:e6:53:
101         81:ff:ff:ff:ff:ff:ff:ff:ff
102     generator: 8 (0x8)
103 -----BEGIN DH PARAMETERS-----
104 MIGHAoGBAP//////////yQ/aoiFowjTExmKLgNwc0SkCTgiKZ8x0Agu+pjsTmyJR
105 Sgh5jjQE3e+VGbPNOkMbMCsKbfJfFDdP4TVtbVHCReSFtXZiXn7G9ExC6aY37WsL
106 /1y29Aa37e44a/taiZ+lrp8kEXxLH+ZJKGZR7OZTgf//////////AgEI
107 -----END DH PARAMETERS-----
108 */
109                 bn_wexpand(tmp,a->top*2);
110                 bn_wexpand(tmp2,a->top*4);
111                 bn_sqr_recursive(tmp->d,a->d,a->top,tmp2->d);
112                 tmp->top=a->top*2;
113                 while (tmp->top > 0 && tmp->d[tmp->top-1] == 0)
114                         tmp->top--;
115 #else
116                 if (!BN_sqr(tmp,a,ctx)) goto err;
117 #endif
118                 }
119         else
120                 {
121                 if (!BN_mul(tmp,a,b,ctx)) goto err;
122                 }
123         /* reduce from aRR to aR */
124         if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
125         ret=1;
126 err:
127         BN_CTX_end(ctx);
128         return(ret);
129         }
130
131 int BN_from_montgomery(BIGNUM *ret, BIGNUM *a, BN_MONT_CTX *mont,
132              BN_CTX *ctx)
133         {
134         int retn=0;
135
136 #ifdef MONT_WORD
137         BIGNUM *n,*r;
138         BN_ULONG *ap,*np,*rp,n0,v,*nrp;
139         int al,nl,max,i,x,ri;
140
141         BN_CTX_start(ctx);
142         if ((r = BN_CTX_get(ctx)) == NULL) goto err;
143
144         if (!BN_copy(r,a)) goto err;
145         n= &(mont->N);
146
147         ap=a->d;
148         /* mont->ri is the size of mont->N in bits (rounded up
149            to the word size) */
150         al=ri=mont->ri/BN_BITS2;
151         
152         nl=n->top;
153         if ((al == 0) || (nl == 0)) { r->top=0; return(1); }
154
155         max=(nl+al+1); /* allow for overflow (no?) XXX */
156         if (bn_wexpand(r,max) == NULL) goto err;
157         if (bn_wexpand(ret,max) == NULL) goto err;
158
159         r->neg=a->neg^n->neg;
160         np=n->d;
161         rp=r->d;
162         nrp= &(r->d[nl]);
163
164         /* clear the top words of T */
165 #if 1
166         for (i=r->top; i<max; i++) /* memset? XXX */
167                 r->d[i]=0;
168 #else
169         memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG)); 
170 #endif
171
172         r->top=max;
173         n0=mont->n0;
174
175 #ifdef BN_COUNT
176         printf("word BN_from_montgomery %d * %d\n",nl,nl);
177 #endif
178         for (i=0; i<nl; i++)
179                 {
180 #ifdef __TANDEM
181                 {
182                    long long t1;
183                    long long t2;
184                    long long t3;
185                    t1 = rp[0] * (n0 & 0177777);
186                    t2 = 037777600000l;
187                    t2 = n0 & t2;
188                    t3 = rp[0] & 0177777;
189                    t2 = (t3 * t2) & BN_MASK2;
190                    t1 = t1 + t2;
191                    v=bn_mul_add_words(rp,np,nl,(BN_ULONG) t1);
192                 }
193 #else
194                 v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
195 #endif
196                 nrp++;
197                 rp++;
198                 if (((nrp[-1]+=v)&BN_MASK2) >= v)
199                         continue;
200                 else
201                         {
202                         if (((++nrp[0])&BN_MASK2) != 0) continue;
203                         if (((++nrp[1])&BN_MASK2) != 0) continue;
204                         for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
205                         }
206                 }
207         bn_fix_top(r);
208         
209         /* mont->ri will be a multiple of the word size */
210 #if 0
211         BN_rshift(ret,r,mont->ri);
212 #else
213         ret->neg = r->neg;
214         x=ri;
215         rp=ret->d;
216         ap= &(r->d[x]);
217         if (r->top < x)
218                 al=0;
219         else
220                 al=r->top-x;
221         ret->top=al;
222         al-=4;
223         for (i=0; i<al; i+=4)
224                 {
225                 BN_ULONG t1,t2,t3,t4;
226                 
227                 t1=ap[i+0];
228                 t2=ap[i+1];
229                 t3=ap[i+2];
230                 t4=ap[i+3];
231                 rp[i+0]=t1;
232                 rp[i+1]=t2;
233                 rp[i+2]=t3;
234                 rp[i+3]=t4;
235                 }
236         al+=4;
237         for (; i<al; i++)
238                 rp[i]=ap[i];
239 #endif
240 #else /* !MONT_WORD */ 
241         BIGNUM *t1,*t2;
242
243         BN_CTX_start(ctx);
244         t1 = BN_CTX_get(ctx);
245         t2 = BN_CTX_get(ctx);
246         if (t1 == NULL || t2 == NULL) goto err;
247         
248         if (!BN_copy(t1,a)) goto err;
249         BN_mask_bits(t1,mont->ri);
250
251         if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
252         BN_mask_bits(t2,mont->ri);
253
254         if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
255         if (!BN_add(t2,a,t1)) goto err;
256         BN_rshift(ret,t2,mont->ri);
257 #endif /* MONT_WORD */
258
259         if (BN_ucmp(ret, &(mont->N)) >= 0)
260                 {
261                 BN_usub(ret,ret,&(mont->N));
262                 }
263         retn=1;
264  err:
265         BN_CTX_end(ctx);
266         return(retn);
267         }
268
269 BN_MONT_CTX *BN_MONT_CTX_new(void)
270         {
271         BN_MONT_CTX *ret;
272
273         if ((ret=(BN_MONT_CTX *)OPENSSL_malloc(sizeof(BN_MONT_CTX))) == NULL)
274                 return(NULL);
275
276         BN_MONT_CTX_init(ret);
277         ret->flags=BN_FLG_MALLOCED;
278         return(ret);
279         }
280
281 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
282         {
283         ctx->ri=0;
284         BN_init(&(ctx->RR));
285         BN_init(&(ctx->N));
286         BN_init(&(ctx->Ni));
287         ctx->flags=0;
288         }
289
290 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
291         {
292         if(mont == NULL)
293             return;
294
295         BN_free(&(mont->RR));
296         BN_free(&(mont->N));
297         BN_free(&(mont->Ni));
298         if (mont->flags & BN_FLG_MALLOCED)
299                 OPENSSL_free(mont);
300         }
301
302 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
303         {
304         BIGNUM Ri,*R;
305
306         BN_init(&Ri);
307         R= &(mont->RR);                                 /* grab RR as a temp */
308         BN_copy(&(mont->N),mod);                        /* Set N */
309
310 #ifdef MONT_WORD
311                 {
312                 BIGNUM tmod;
313                 BN_ULONG buf[2];
314
315                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
316                 BN_zero(R);
317                 BN_set_bit(R,BN_BITS2);                 /* R */
318
319                 buf[0]=mod->d[0]; /* tmod = N mod word size */
320                 buf[1]=0;
321                 tmod.d=buf;
322                 tmod.top=1;
323                 tmod.dmax=2;
324                 tmod.neg=mod->neg;
325                                                         /* Ri = R^-1 mod N*/
326                 if ((BN_mod_inverse(&Ri,R,&tmod,ctx)) == NULL)
327                         goto err;
328                 BN_lshift(&Ri,&Ri,BN_BITS2);            /* R*Ri */
329                 if (!BN_is_zero(&Ri))
330                         BN_sub_word(&Ri,1);
331                 else /* if N mod word size == 1 */
332                         BN_set_word(&Ri,BN_MASK2);  /* Ri-- (mod word size) */
333                 BN_div(&Ri,NULL,&Ri,&tmod,ctx); /* Ni = (R*Ri-1)/N,
334                                                  * keep only least significant word: */
335                 mont->n0=Ri.d[0];
336                 BN_free(&Ri);
337                 }
338 #else /* !MONT_WORD */
339                 { /* bignum version */
340                 mont->ri=BN_num_bits(mod);
341                 BN_zero(R);
342                 BN_set_bit(R,mont->ri);                 /* R = 2^ri */
343                                                         /* Ri = R^-1 mod N*/
344                 if ((BN_mod_inverse(&Ri,R,mod,ctx)) == NULL)
345                         goto err;
346                 BN_lshift(&Ri,&Ri,mont->ri);            /* R*Ri */
347                 BN_sub_word(&Ri,1);
348                                                         /* Ni = (R*Ri-1) / N */
349                 BN_div(&(mont->Ni),NULL,&Ri,mod,ctx);
350                 BN_free(&Ri);
351                 }
352 #endif
353
354         /* setup RR for conversions */
355         BN_zero(&(mont->RR));
356         BN_set_bit(&(mont->RR),mont->ri*2);
357         BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx);
358
359         return(1);
360 err:
361         return(0);
362         }
363
364 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
365         {
366         if (to == from) return(to);
367
368         BN_copy(&(to->RR),&(from->RR));
369         BN_copy(&(to->N),&(from->N));
370         BN_copy(&(to->Ni),&(from->Ni));
371         to->ri=from->ri;
372         to->n0=from->n0;
373         return(to);
374         }
375