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