size_tification.
[openssl.git] / crypto / bn / bn_exp.c
1 /* crypto/bn/bn_exp.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  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112
113 #include "cryptlib.h"
114 #include "bn_lcl.h"
115
116 /* maximum precomputation table size for *variable* sliding windows */
117 #define TABLE_SIZE      32
118
119 /* this one works - simple but works */
120 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
121         {
122         int i,bits,ret=0;
123         BIGNUM *v,*rr;
124
125         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
126                 {
127                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
128                 BNerr(BN_F_BN_EXP,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
129                 return -1;
130                 }
131
132         BN_CTX_start(ctx);
133         if ((r == a) || (r == p))
134                 rr = BN_CTX_get(ctx);
135         else
136                 rr = r;
137         if ((v = BN_CTX_get(ctx)) == NULL) goto err;
138
139         if (BN_copy(v,a) == NULL) goto err;
140         bits=BN_num_bits(p);
141
142         if (BN_is_odd(p))
143                 { if (BN_copy(rr,a) == NULL) goto err; }
144         else    { if (!BN_one(rr)) goto err; }
145
146         for (i=1; i<bits; i++)
147                 {
148                 if (!BN_sqr(v,v,ctx)) goto err;
149                 if (BN_is_bit_set(p,i))
150                         {
151                         if (!BN_mul(rr,rr,v,ctx)) goto err;
152                         }
153                 }
154         ret=1;
155 err:
156         if (r != rr) BN_copy(r,rr);
157         BN_CTX_end(ctx);
158         bn_check_top(r);
159         return(ret);
160         }
161
162
163 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m,
164                BN_CTX *ctx)
165         {
166         int ret;
167
168         bn_check_top(a);
169         bn_check_top(p);
170         bn_check_top(m);
171
172         /* For even modulus  m = 2^k*m_odd,  it might make sense to compute
173          * a^p mod m_odd  and  a^p mod 2^k  separately (with Montgomery
174          * exponentiation for the odd part), using appropriate exponent
175          * reductions, and combine the results using the CRT.
176          *
177          * For now, we use Montgomery only if the modulus is odd; otherwise,
178          * exponentiation using the reciprocal-based quick remaindering
179          * algorithm is used.
180          *
181          * (Timing obtained with expspeed.c [computations  a^p mod m
182          * where  a, p, m  are of the same length: 256, 512, 1024, 2048,
183          * 4096, 8192 bits], compared to the running time of the
184          * standard algorithm:
185          *
186          *   BN_mod_exp_mont   33 .. 40 %  [AMD K6-2, Linux, debug configuration]
187          *                     55 .. 77 %  [UltraSparc processor, but
188          *                                  debug-solaris-sparcv8-gcc conf.]
189          * 
190          *   BN_mod_exp_recp   50 .. 70 %  [AMD K6-2, Linux, debug configuration]
191          *                     62 .. 118 % [UltraSparc, debug-solaris-sparcv8-gcc]
192          *
193          * On the Sparc, BN_mod_exp_recp was faster than BN_mod_exp_mont
194          * at 2048 and more bits, but at 512 and 1024 bits, it was
195          * slower even than the standard algorithm!
196          *
197          * "Real" timings [linux-elf, solaris-sparcv9-gcc configurations]
198          * should be obtained when the new Montgomery reduction code
199          * has been integrated into OpenSSL.)
200          */
201
202 #define MONT_MUL_MOD
203 #define MONT_EXP_WORD
204 #define RECP_MUL_MOD
205
206 #ifdef MONT_MUL_MOD
207         /* I have finally been able to take out this pre-condition of
208          * the top bit being set.  It was caused by an error in BN_div
209          * with negatives.  There was also another problem when for a^b%m
210          * a >= m.  eay 07-May-97 */
211 /*      if ((m->d[m->top-1]&BN_TBIT) && BN_is_odd(m)) */
212
213         if (BN_is_odd(m))
214                 {
215 #  ifdef MONT_EXP_WORD
216                 if (a->top == 1 && !a->neg && (BN_get_flags(p, BN_FLG_CONSTTIME) == 0))
217                         {
218                         BN_ULONG A = a->d[0];
219                         ret=BN_mod_exp_mont_word(r,A,p,m,ctx,NULL);
220                         }
221                 else
222 #  endif
223                         ret=BN_mod_exp_mont(r,a,p,m,ctx,NULL);
224                 }
225         else
226 #endif
227 #ifdef RECP_MUL_MOD
228                 { ret=BN_mod_exp_recp(r,a,p,m,ctx); }
229 #else
230                 { ret=BN_mod_exp_simple(r,a,p,m,ctx); }
231 #endif
232
233         bn_check_top(r);
234         return(ret);
235         }
236
237
238 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
239                     const BIGNUM *m, BN_CTX *ctx)
240         {
241         int i,j,bits,ret=0,wstart,wend,window,wvalue;
242         int start=1;
243         BIGNUM *aa;
244         /* Table of variables obtained from 'ctx' */
245         BIGNUM *val[TABLE_SIZE];
246         BN_RECP_CTX recp;
247
248         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
249                 {
250                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
251                 BNerr(BN_F_BN_MOD_EXP_RECP,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
252                 return -1;
253                 }
254
255         bits=BN_num_bits(p);
256
257         if (bits == 0)
258                 {
259                 ret = BN_one(r);
260                 return ret;
261                 }
262
263         BN_CTX_start(ctx);
264         aa = BN_CTX_get(ctx);
265         val[0] = BN_CTX_get(ctx);
266         if(!aa || !val[0]) goto err;
267
268         BN_RECP_CTX_init(&recp);
269         if (m->neg)
270                 {
271                 /* ignore sign of 'm' */
272                 if (!BN_copy(aa, m)) goto err;
273                 aa->neg = 0;
274                 if (BN_RECP_CTX_set(&recp,aa,ctx) <= 0) goto err;
275                 }
276         else
277                 {
278                 if (BN_RECP_CTX_set(&recp,m,ctx) <= 0) goto err;
279                 }
280
281         if (!BN_nnmod(val[0],a,m,ctx)) goto err;                /* 1 */
282         if (BN_is_zero(val[0]))
283                 {
284                 BN_zero(r);
285                 ret = 1;
286                 goto err;
287                 }
288
289         window = BN_window_bits_for_exponent_size(bits);
290         if (window > 1)
291                 {
292                 if (!BN_mod_mul_reciprocal(aa,val[0],val[0],&recp,ctx))
293                         goto err;                               /* 2 */
294                 j=1<<(window-1);
295                 for (i=1; i<j; i++)
296                         {
297                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
298                                         !BN_mod_mul_reciprocal(val[i],val[i-1],
299                                                 aa,&recp,ctx))
300                                 goto err;
301                         }
302                 }
303                 
304         start=1;        /* This is used to avoid multiplication etc
305                          * when there is only the value '1' in the
306                          * buffer. */
307         wvalue=0;       /* The 'value' of the window */
308         wstart=bits-1;  /* The top bit of the window */
309         wend=0;         /* The bottom bit of the window */
310
311         if (!BN_one(r)) goto err;
312
313         for (;;)
314                 {
315                 if (BN_is_bit_set(p,wstart) == 0)
316                         {
317                         if (!start)
318                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
319                                 goto err;
320                         if (wstart == 0) break;
321                         wstart--;
322                         continue;
323                         }
324                 /* We now have wstart on a 'set' bit, we now need to work out
325                  * how bit a window to do.  To do this we need to scan
326                  * forward until the last set bit before the end of the
327                  * window */
328                 j=wstart;
329                 wvalue=1;
330                 wend=0;
331                 for (i=1; i<window; i++)
332                         {
333                         if (wstart-i < 0) break;
334                         if (BN_is_bit_set(p,wstart-i))
335                                 {
336                                 wvalue<<=(i-wend);
337                                 wvalue|=1;
338                                 wend=i;
339                                 }
340                         }
341
342                 /* wend is the size of the current window */
343                 j=wend+1;
344                 /* add the 'bytes above' */
345                 if (!start)
346                         for (i=0; i<j; i++)
347                                 {
348                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
349                                         goto err;
350                                 }
351                 
352                 /* wvalue will be an odd number < 2^window */
353                 if (!BN_mod_mul_reciprocal(r,r,val[wvalue>>1],&recp,ctx))
354                         goto err;
355
356                 /* move the 'window' down further */
357                 wstart-=wend+1;
358                 wvalue=0;
359                 start=0;
360                 if (wstart < 0) break;
361                 }
362         ret=1;
363 err:
364         BN_CTX_end(ctx);
365         BN_RECP_CTX_free(&recp);
366         bn_check_top(r);
367         return(ret);
368         }
369
370
371 int BN_mod_exp_mont(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
372                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
373         {
374         int i,j,bits,ret=0,wstart,wend,window,wvalue;
375         int start=1;
376         BIGNUM *d,*r;
377         const BIGNUM *aa;
378         /* Table of variables obtained from 'ctx' */
379         BIGNUM *val[TABLE_SIZE];
380         BN_MONT_CTX *mont=NULL;
381
382         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
383                 {
384                 return BN_mod_exp_mont_consttime(rr, a, p, m, ctx, in_mont);
385                 }
386
387         bn_check_top(a);
388         bn_check_top(p);
389         bn_check_top(m);
390
391         if (!BN_is_odd(m))
392                 {
393                 BNerr(BN_F_BN_MOD_EXP_MONT,BN_R_CALLED_WITH_EVEN_MODULUS);
394                 return(0);
395                 }
396         bits=BN_num_bits(p);
397         if (bits == 0)
398                 {
399                 ret = BN_one(rr);
400                 return ret;
401                 }
402
403         BN_CTX_start(ctx);
404         d = BN_CTX_get(ctx);
405         r = BN_CTX_get(ctx);
406         val[0] = BN_CTX_get(ctx);
407         if (!d || !r || !val[0]) goto err;
408
409         /* If this is not done, things will break in the montgomery
410          * part */
411
412         if (in_mont != NULL)
413                 mont=in_mont;
414         else
415                 {
416                 if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
417                 if (!BN_MONT_CTX_set(mont,m,ctx)) goto err;
418                 }
419
420         if (a->neg || BN_ucmp(a,m) >= 0)
421                 {
422                 if (!BN_nnmod(val[0],a,m,ctx))
423                         goto err;
424                 aa= val[0];
425                 }
426         else
427                 aa=a;
428         if (BN_is_zero(aa))
429                 {
430                 BN_zero(rr);
431                 ret = 1;
432                 goto err;
433                 }
434         if (!BN_to_montgomery(val[0],aa,mont,ctx)) goto err; /* 1 */
435
436         window = BN_window_bits_for_exponent_size(bits);
437         if (window > 1)
438                 {
439                 if (!BN_mod_mul_montgomery(d,val[0],val[0],mont,ctx)) goto err; /* 2 */
440                 j=1<<(window-1);
441                 for (i=1; i<j; i++)
442                         {
443                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
444                                         !BN_mod_mul_montgomery(val[i],val[i-1],
445                                                 d,mont,ctx))
446                                 goto err;
447                         }
448                 }
449
450         start=1;        /* This is used to avoid multiplication etc
451                          * when there is only the value '1' in the
452                          * buffer. */
453         wvalue=0;       /* The 'value' of the window */
454         wstart=bits-1;  /* The top bit of the window */
455         wend=0;         /* The bottom bit of the window */
456
457         if (!BN_to_montgomery(r,BN_value_one(),mont,ctx)) goto err;
458         for (;;)
459                 {
460                 if (BN_is_bit_set(p,wstart) == 0)
461                         {
462                         if (!start)
463                                 {
464                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
465                                 goto err;
466                                 }
467                         if (wstart == 0) break;
468                         wstart--;
469                         continue;
470                         }
471                 /* We now have wstart on a 'set' bit, we now need to work out
472                  * how bit a window to do.  To do this we need to scan
473                  * forward until the last set bit before the end of the
474                  * window */
475                 j=wstart;
476                 wvalue=1;
477                 wend=0;
478                 for (i=1; i<window; i++)
479                         {
480                         if (wstart-i < 0) break;
481                         if (BN_is_bit_set(p,wstart-i))
482                                 {
483                                 wvalue<<=(i-wend);
484                                 wvalue|=1;
485                                 wend=i;
486                                 }
487                         }
488
489                 /* wend is the size of the current window */
490                 j=wend+1;
491                 /* add the 'bytes above' */
492                 if (!start)
493                         for (i=0; i<j; i++)
494                                 {
495                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
496                                         goto err;
497                                 }
498                 
499                 /* wvalue will be an odd number < 2^window */
500                 if (!BN_mod_mul_montgomery(r,r,val[wvalue>>1],mont,ctx))
501                         goto err;
502
503                 /* move the 'window' down further */
504                 wstart-=wend+1;
505                 wvalue=0;
506                 start=0;
507                 if (wstart < 0) break;
508                 }
509         if (!BN_from_montgomery(rr,r,mont,ctx)) goto err;
510         ret=1;
511 err:
512         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
513         BN_CTX_end(ctx);
514         bn_check_top(rr);
515         return(ret);
516         }
517
518
519 /* BN_mod_exp_mont_consttime() stores the precomputed powers in a specific layout
520  * so that accessing any of these table values shows the same access pattern as far
521  * as cache lines are concerned.  The following functions are used to transfer a BIGNUM
522  * from/to that table. */
523
524 static int MOD_EXP_CTIME_COPY_TO_PREBUF(BIGNUM *b, size_t top,
525                                         unsigned char *buf, int idx, int width)
526         {
527         size_t i, j;
528
529         if (bn_wexpand(b, top) == NULL)
530                 return 0;
531         while (b->top < top)
532                 {
533                 b->d[b->top++] = 0;
534                 }
535         
536         for (i = 0, j=idx; i < top * sizeof b->d[0]; i++, j+=width)
537                 {
538                 buf[j] = ((unsigned char*)b->d)[i];
539                 }
540
541         bn_correct_top(b);
542         return 1;
543         }
544
545 static int MOD_EXP_CTIME_COPY_FROM_PREBUF(BIGNUM *b, size_t top,
546                                           unsigned char *buf, int idx,
547                                           int width)
548         {
549         size_t i, j;
550
551         if (bn_wexpand(b, top) == NULL)
552                 return 0;
553
554         for (i=0, j=idx; i < top * sizeof b->d[0]; i++, j+=width)
555                 {
556                 ((unsigned char*)b->d)[i] = buf[j];
557                 }
558
559         b->top = top;
560         bn_correct_top(b);
561         return 1;
562         }       
563
564 /* Given a pointer value, compute the next address that is a cache line multiple. */
565 #define MOD_EXP_CTIME_ALIGN(x_) \
566         ((unsigned char*)(x_) + (MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH - (((BN_ULONG)(x_)) & (MOD_EXP_CTIME_MIN_CACHE_LINE_MASK))))
567
568 /* This variant of BN_mod_exp_mont() uses fixed windows and the special
569  * precomputation memory layout to limit data-dependency to a minimum
570  * to protect secret exponents (cf. the hyper-threading timing attacks
571  * pointed out by Colin Percival,
572  * http://www.daemonology.net/hyperthreading-considered-harmful/)
573  */
574 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
575                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
576         {
577         int i,bits,ret=0,idx,window,wvalue;
578         size_t top;
579         BIGNUM *r;
580         const BIGNUM *aa;
581         BN_MONT_CTX *mont=NULL;
582
583         int numPowers;
584         unsigned char *powerbufFree=NULL;
585         size_t powerbufLen = 0;
586         unsigned char *powerbuf=NULL;
587         BIGNUM *computeTemp=NULL, *am=NULL;
588
589         bn_check_top(a);
590         bn_check_top(p);
591         bn_check_top(m);
592
593         top = m->top;
594
595         if (!(m->d[0] & 1))
596                 {
597                 BNerr(BN_F_BN_MOD_EXP_MONT_CONSTTIME,BN_R_CALLED_WITH_EVEN_MODULUS);
598                 return(0);
599                 }
600         bits=BN_num_bits(p);
601         if (bits == 0)
602                 {
603                 ret = BN_one(rr);
604                 return ret;
605                 }
606
607         /* Initialize BIGNUM context and allocate intermediate result */
608         BN_CTX_start(ctx);
609         r = BN_CTX_get(ctx);
610         if (r == NULL) goto err;
611
612         /* Allocate a montgomery context if it was not supplied by the caller.
613          * If this is not done, things will break in the montgomery part.
614          */
615         if (in_mont != NULL)
616                 mont=in_mont;
617         else
618                 {
619                 if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
620                 if (!BN_MONT_CTX_set(mont,m,ctx)) goto err;
621                 }
622
623         /* Get the window size to use with size of p. */
624         window = BN_window_bits_for_ctime_exponent_size(bits);
625
626         /* Allocate a buffer large enough to hold all of the pre-computed
627          * powers of a.
628          */
629         numPowers = 1 << window;
630         powerbufLen = sizeof(m->d[0])*top*numPowers;
631         if ((powerbufFree=OPENSSL_malloc(powerbufLen+MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH)) == NULL)
632                 goto err;
633                 
634         powerbuf = MOD_EXP_CTIME_ALIGN(powerbufFree);
635         memset(powerbuf, 0, powerbufLen);
636
637         /* Initialize the intermediate result. Do this early to save double conversion,
638          * once each for a^0 and intermediate result.
639          */
640         if (!BN_to_montgomery(r,BN_value_one(),mont,ctx)) goto err;
641         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(r, top, powerbuf, 0, numPowers)) goto err;
642
643         /* Initialize computeTemp as a^1 with montgomery precalcs */
644         computeTemp = BN_CTX_get(ctx);
645         am = BN_CTX_get(ctx);
646         if (computeTemp==NULL || am==NULL) goto err;
647
648         if (a->neg || BN_ucmp(a,m) >= 0)
649                 {
650                 if (!BN_mod(am,a,m,ctx))
651                         goto err;
652                 aa= am;
653                 }
654         else
655                 aa=a;
656         if (!BN_to_montgomery(am,aa,mont,ctx)) goto err;
657         if (!BN_copy(computeTemp, am)) goto err;
658         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(am, top, powerbuf, 1, numPowers)) goto err;
659
660         /* If the window size is greater than 1, then calculate
661          * val[i=2..2^winsize-1]. Powers are computed as a*a^(i-1)
662          * (even powers could instead be computed as (a^(i/2))^2
663          * to use the slight performance advantage of sqr over mul).
664          */
665         if (window > 1)
666                 {
667                 for (i=2; i<numPowers; i++)
668                         {
669                         /* Calculate a^i = a^(i-1) * a */
670                         if (!BN_mod_mul_montgomery(computeTemp,am,computeTemp,mont,ctx))
671                                 goto err;
672                         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(computeTemp, top, powerbuf, i, numPowers)) goto err;
673                         }
674                 }
675
676         /* Adjust the number of bits up to a multiple of the window size.
677          * If the exponent length is not a multiple of the window size, then
678          * this pads the most significant bits with zeros to normalize the
679          * scanning loop to there's no special cases.
680          *
681          * * NOTE: Making the window size a power of two less than the native
682          * * word size ensures that the padded bits won't go past the last
683          * * word in the internal BIGNUM structure. Going past the end will
684          * * still produce the correct result, but causes a different branch
685          * * to be taken in the BN_is_bit_set function.
686          */
687         bits = ((bits+window-1)/window)*window;
688         idx=bits-1;     /* The top bit of the window */
689
690         /* Scan the exponent one window at a time starting from the most
691          * significant bits.
692          */
693         while (idx >= 0)
694                 {
695                 wvalue=0; /* The 'value' of the window */
696                 
697                 /* Scan the window, squaring the result as we go */
698                 for (i=0; i<window; i++,idx--)
699                         {
700                         if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))     goto err;
701                         wvalue = (wvalue<<1)+BN_is_bit_set(p,idx);
702                         }
703                 
704                 /* Fetch the appropriate pre-computed value from the pre-buf */
705                 if (!MOD_EXP_CTIME_COPY_FROM_PREBUF(computeTemp, top, powerbuf, wvalue, numPowers)) goto err;
706
707                 /* Multiply the result into the intermediate result */
708                 if (!BN_mod_mul_montgomery(r,r,computeTemp,mont,ctx)) goto err;
709                 }
710
711         /* Convert the final result from montgomery to standard format */
712         if (!BN_from_montgomery(rr,r,mont,ctx)) goto err;
713         ret=1;
714 err:
715         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
716         if (powerbuf!=NULL)
717                 {
718                 OPENSSL_cleanse(powerbuf,powerbufLen);
719                 OPENSSL_free(powerbufFree);
720                 }
721         if (am!=NULL) BN_clear(am);
722         if (computeTemp!=NULL) BN_clear(computeTemp);
723         BN_CTX_end(ctx);
724         return(ret);
725         }
726
727 int BN_mod_exp_mont_word(BIGNUM *rr, BN_ULONG a, const BIGNUM *p,
728                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
729         {
730         BN_MONT_CTX *mont = NULL;
731         int b, bits, ret=0;
732         int r_is_one;
733         BN_ULONG w, next_w;
734         BIGNUM *d, *r, *t;
735         BIGNUM *swap_tmp;
736 #define BN_MOD_MUL_WORD(r, w, m) \
737                 (BN_mul_word(r, (w)) && \
738                 (/* BN_ucmp(r, (m)) < 0 ? 1 :*/  \
739                         (BN_mod(t, r, m, ctx) && (swap_tmp = r, r = t, t = swap_tmp, 1))))
740                 /* BN_MOD_MUL_WORD is only used with 'w' large,
741                  * so the BN_ucmp test is probably more overhead
742                  * than always using BN_mod (which uses BN_copy if
743                  * a similar test returns true). */
744                 /* We can use BN_mod and do not need BN_nnmod because our
745                  * accumulator is never negative (the result of BN_mod does
746                  * not depend on the sign of the modulus).
747                  */
748 #define BN_TO_MONTGOMERY_WORD(r, w, mont) \
749                 (BN_set_word(r, (w)) && BN_to_montgomery(r, r, (mont), ctx))
750
751         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
752                 {
753                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
754                 BNerr(BN_F_BN_MOD_EXP_MONT_WORD,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
755                 return -1;
756                 }
757
758         bn_check_top(p);
759         bn_check_top(m);
760
761         if (!BN_is_odd(m))
762                 {
763                 BNerr(BN_F_BN_MOD_EXP_MONT_WORD,BN_R_CALLED_WITH_EVEN_MODULUS);
764                 return(0);
765                 }
766         if (m->top == 1)
767                 a %= m->d[0]; /* make sure that 'a' is reduced */
768
769         bits = BN_num_bits(p);
770         if (bits == 0)
771                 {
772                 ret = BN_one(rr);
773                 return ret;
774                 }
775         if (a == 0)
776                 {
777                 BN_zero(rr);
778                 ret = 1;
779                 return ret;
780                 }
781
782         BN_CTX_start(ctx);
783         d = BN_CTX_get(ctx);
784         r = BN_CTX_get(ctx);
785         t = BN_CTX_get(ctx);
786         if (d == NULL || r == NULL || t == NULL) goto err;
787
788         if (in_mont != NULL)
789                 mont=in_mont;
790         else
791                 {
792                 if ((mont = BN_MONT_CTX_new()) == NULL) goto err;
793                 if (!BN_MONT_CTX_set(mont, m, ctx)) goto err;
794                 }
795
796         r_is_one = 1; /* except for Montgomery factor */
797
798         /* bits-1 >= 0 */
799
800         /* The result is accumulated in the product r*w. */
801         w = a; /* bit 'bits-1' of 'p' is always set */
802         for (b = bits-2; b >= 0; b--)
803                 {
804                 /* First, square r*w. */
805                 next_w = w*w;
806                 if ((next_w/w) != w) /* overflow */
807                         {
808                         if (r_is_one)
809                                 {
810                                 if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
811                                 r_is_one = 0;
812                                 }
813                         else
814                                 {
815                                 if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
816                                 }
817                         next_w = 1;
818                         }
819                 w = next_w;
820                 if (!r_is_one)
821                         {
822                         if (!BN_mod_mul_montgomery(r, r, r, mont, ctx)) goto err;
823                         }
824
825                 /* Second, multiply r*w by 'a' if exponent bit is set. */
826                 if (BN_is_bit_set(p, b))
827                         {
828                         next_w = w*a;
829                         if ((next_w/a) != w) /* overflow */
830                                 {
831                                 if (r_is_one)
832                                         {
833                                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
834                                         r_is_one = 0;
835                                         }
836                                 else
837                                         {
838                                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
839                                         }
840                                 next_w = a;
841                                 }
842                         w = next_w;
843                         }
844                 }
845
846         /* Finally, set r:=r*w. */
847         if (w != 1)
848                 {
849                 if (r_is_one)
850                         {
851                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
852                         r_is_one = 0;
853                         }
854                 else
855                         {
856                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
857                         }
858                 }
859
860         if (r_is_one) /* can happen only if a == 1*/
861                 {
862                 if (!BN_one(rr)) goto err;
863                 }
864         else
865                 {
866                 if (!BN_from_montgomery(rr, r, mont, ctx)) goto err;
867                 }
868         ret = 1;
869 err:
870         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
871         BN_CTX_end(ctx);
872         bn_check_top(rr);
873         return(ret);
874         }
875
876
877 /* The old fallback, simple version :-) */
878 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
879                 const BIGNUM *m, BN_CTX *ctx)
880         {
881         int i,j,bits,ret=0,wstart,wend,window,wvalue;
882         int start=1;
883         BIGNUM *d;
884         /* Table of variables obtained from 'ctx' */
885         BIGNUM *val[TABLE_SIZE];
886
887         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
888                 {
889                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
890                 BNerr(BN_F_BN_MOD_EXP_SIMPLE,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
891                 return -1;
892                 }
893
894         bits=BN_num_bits(p);
895
896         if (bits == 0)
897                 {
898                 ret = BN_one(r);
899                 return ret;
900                 }
901
902         BN_CTX_start(ctx);
903         d = BN_CTX_get(ctx);
904         val[0] = BN_CTX_get(ctx);
905         if(!d || !val[0]) goto err;
906
907         if (!BN_nnmod(val[0],a,m,ctx)) goto err;                /* 1 */
908         if (BN_is_zero(val[0]))
909                 {
910                 BN_zero(r);
911                 ret = 1;
912                 goto err;
913                 }
914
915         window = BN_window_bits_for_exponent_size(bits);
916         if (window > 1)
917                 {
918                 if (!BN_mod_mul(d,val[0],val[0],m,ctx))
919                         goto err;                               /* 2 */
920                 j=1<<(window-1);
921                 for (i=1; i<j; i++)
922                         {
923                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
924                                         !BN_mod_mul(val[i],val[i-1],d,m,ctx))
925                                 goto err;
926                         }
927                 }
928
929         start=1;        /* This is used to avoid multiplication etc
930                          * when there is only the value '1' in the
931                          * buffer. */
932         wvalue=0;       /* The 'value' of the window */
933         wstart=bits-1;  /* The top bit of the window */
934         wend=0;         /* The bottom bit of the window */
935
936         if (!BN_one(r)) goto err;
937
938         for (;;)
939                 {
940                 if (BN_is_bit_set(p,wstart) == 0)
941                         {
942                         if (!start)
943                                 if (!BN_mod_mul(r,r,r,m,ctx))
944                                 goto err;
945                         if (wstart == 0) break;
946                         wstart--;
947                         continue;
948                         }
949                 /* We now have wstart on a 'set' bit, we now need to work out
950                  * how bit a window to do.  To do this we need to scan
951                  * forward until the last set bit before the end of the
952                  * window */
953                 j=wstart;
954                 wvalue=1;
955                 wend=0;
956                 for (i=1; i<window; i++)
957                         {
958                         if (wstart-i < 0) break;
959                         if (BN_is_bit_set(p,wstart-i))
960                                 {
961                                 wvalue<<=(i-wend);
962                                 wvalue|=1;
963                                 wend=i;
964                                 }
965                         }
966
967                 /* wend is the size of the current window */
968                 j=wend+1;
969                 /* add the 'bytes above' */
970                 if (!start)
971                         for (i=0; i<j; i++)
972                                 {
973                                 if (!BN_mod_mul(r,r,r,m,ctx))
974                                         goto err;
975                                 }
976                 
977                 /* wvalue will be an odd number < 2^window */
978                 if (!BN_mod_mul(r,r,val[wvalue>>1],m,ctx))
979                         goto err;
980
981                 /* move the 'window' down further */
982                 wstart-=wend+1;
983                 wvalue=0;
984                 start=0;
985                 if (wstart < 0) break;
986                 }
987         ret=1;
988 err:
989         BN_CTX_end(ctx);
990         bn_check_top(r);
991         return(ret);
992         }
993