mark all block comments that need format preserving so that
[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
114 #include "cryptlib.h"
115 #include "bn_lcl.h"
116
117 #include <stdlib.h>
118 #ifdef _WIN32
119 # include <malloc.h>
120 # ifndef alloca
121 #  define alloca _alloca
122 # endif
123 #elif defined(__GNUC__)
124 # ifndef alloca
125 #  define alloca(s) __builtin_alloca((s))
126 # endif
127 #elif defined(__sun)
128 # include <alloca.h>
129 #endif
130
131 #undef RSAZ_ENABLED
132 #if defined(OPENSSL_BN_ASM_MONT) && \
133         (defined(__x86_64) || defined(__x86_64__) || \
134          defined(_M_AMD64) || defined(_M_X64))
135 # include "rsaz_exp.h"
136 # define RSAZ_ENABLED
137 #endif
138
139 #undef SPARC_T4_MONT
140 #if defined(OPENSSL_BN_ASM_MONT) && (defined(__sparc__) || defined(__sparc))
141 # include "sparc_arch.h"
142 extern unsigned int OPENSSL_sparcv9cap_P[];
143 # define SPARC_T4_MONT
144 #endif
145
146 /* maximum precomputation table size for *variable* sliding windows */
147 #define TABLE_SIZE      32
148
149 /* this one works - simple but works */
150 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
151         {
152         int i,bits,ret=0;
153         BIGNUM *v,*rr;
154
155         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
156                 {
157                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
158                 BNerr(BN_F_BN_EXP,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
159                 return -1;
160                 }
161
162         BN_CTX_start(ctx);
163         if ((r == a) || (r == p))
164                 rr = BN_CTX_get(ctx);
165         else
166                 rr = r;
167         v = BN_CTX_get(ctx);
168         if (rr == NULL || v == NULL) goto err;
169
170         if (BN_copy(v,a) == NULL) goto err;
171         bits=BN_num_bits(p);
172
173         if (BN_is_odd(p))
174                 { if (BN_copy(rr,a) == NULL) goto err; }
175         else    { if (!BN_one(rr)) goto err; }
176
177         for (i=1; i<bits; i++)
178                 {
179                 if (!BN_sqr(v,v,ctx)) goto err;
180                 if (BN_is_bit_set(p,i))
181                         {
182                         if (!BN_mul(rr,rr,v,ctx)) goto err;
183                         }
184                 }
185         ret=1;
186 err:
187         if (r != rr) BN_copy(r,rr);
188         BN_CTX_end(ctx);
189         bn_check_top(r);
190         return(ret);
191         }
192
193
194 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m,
195                BN_CTX *ctx)
196         {
197         int ret;
198
199         bn_check_top(a);
200         bn_check_top(p);
201         bn_check_top(m);
202
203         /*-
204          * For even modulus  m = 2^k*m_odd,  it might make sense to compute
205          * a^p mod m_odd  and  a^p mod 2^k  separately (with Montgomery
206          * exponentiation for the odd part), using appropriate exponent
207          * reductions, and combine the results using the CRT.
208          *
209          * For now, we use Montgomery only if the modulus is odd; otherwise,
210          * exponentiation using the reciprocal-based quick remaindering
211          * algorithm is used.
212          *
213          * (Timing obtained with expspeed.c [computations  a^p mod m
214          * where  a, p, m  are of the same length: 256, 512, 1024, 2048,
215          * 4096, 8192 bits], compared to the running time of the
216          * standard algorithm:
217          *
218          *   BN_mod_exp_mont   33 .. 40 %  [AMD K6-2, Linux, debug configuration]
219          *                     55 .. 77 %  [UltraSparc processor, but
220          *                                  debug-solaris-sparcv8-gcc conf.]
221          * 
222          *   BN_mod_exp_recp   50 .. 70 %  [AMD K6-2, Linux, debug configuration]
223          *                     62 .. 118 % [UltraSparc, debug-solaris-sparcv8-gcc]
224          *
225          * On the Sparc, BN_mod_exp_recp was faster than BN_mod_exp_mont
226          * at 2048 and more bits, but at 512 and 1024 bits, it was
227          * slower even than the standard algorithm!
228          *
229          * "Real" timings [linux-elf, solaris-sparcv9-gcc configurations]
230          * should be obtained when the new Montgomery reduction code
231          * has been integrated into OpenSSL.)
232          */
233
234 #define MONT_MUL_MOD
235 #define MONT_EXP_WORD
236 #define RECP_MUL_MOD
237
238 #ifdef MONT_MUL_MOD
239         /* I have finally been able to take out this pre-condition of
240          * the top bit being set.  It was caused by an error in BN_div
241          * with negatives.  There was also another problem when for a^b%m
242          * a >= m.  eay 07-May-97 */
243 /*      if ((m->d[m->top-1]&BN_TBIT) && BN_is_odd(m)) */
244
245         if (BN_is_odd(m))
246                 {
247 #  ifdef MONT_EXP_WORD
248                 if (a->top == 1 && !a->neg && (BN_get_flags(p, BN_FLG_CONSTTIME) == 0))
249                         {
250                         BN_ULONG A = a->d[0];
251                         ret=BN_mod_exp_mont_word(r,A,p,m,ctx,NULL);
252                         }
253                 else
254 #  endif
255                         ret=BN_mod_exp_mont(r,a,p,m,ctx,NULL);
256                 }
257         else
258 #endif
259 #ifdef RECP_MUL_MOD
260                 { ret=BN_mod_exp_recp(r,a,p,m,ctx); }
261 #else
262                 { ret=BN_mod_exp_simple(r,a,p,m,ctx); }
263 #endif
264
265         bn_check_top(r);
266         return(ret);
267         }
268
269
270 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
271                     const BIGNUM *m, BN_CTX *ctx)
272         {
273         int i,j,bits,ret=0,wstart,wend,window,wvalue;
274         int start=1;
275         BIGNUM *aa;
276         /* Table of variables obtained from 'ctx' */
277         BIGNUM *val[TABLE_SIZE];
278         BN_RECP_CTX recp;
279
280         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
281                 {
282                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
283                 BNerr(BN_F_BN_MOD_EXP_RECP,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
284                 return -1;
285                 }
286
287         bits=BN_num_bits(p);
288
289         if (bits == 0)
290                 {
291                 ret = BN_one(r);
292                 return ret;
293                 }
294
295         BN_CTX_start(ctx);
296         aa = BN_CTX_get(ctx);
297         val[0] = BN_CTX_get(ctx);
298         if(!aa || !val[0]) goto err;
299
300         BN_RECP_CTX_init(&recp);
301         if (m->neg)
302                 {
303                 /* ignore sign of 'm' */
304                 if (!BN_copy(aa, m)) goto err;
305                 aa->neg = 0;
306                 if (BN_RECP_CTX_set(&recp,aa,ctx) <= 0) goto err;
307                 }
308         else
309                 {
310                 if (BN_RECP_CTX_set(&recp,m,ctx) <= 0) goto err;
311                 }
312
313         if (!BN_nnmod(val[0],a,m,ctx)) goto err;                /* 1 */
314         if (BN_is_zero(val[0]))
315                 {
316                 BN_zero(r);
317                 ret = 1;
318                 goto err;
319                 }
320
321         window = BN_window_bits_for_exponent_size(bits);
322         if (window > 1)
323                 {
324                 if (!BN_mod_mul_reciprocal(aa,val[0],val[0],&recp,ctx))
325                         goto err;                               /* 2 */
326                 j=1<<(window-1);
327                 for (i=1; i<j; i++)
328                         {
329                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
330                                         !BN_mod_mul_reciprocal(val[i],val[i-1],
331                                                 aa,&recp,ctx))
332                                 goto err;
333                         }
334                 }
335                 
336         start=1;        /* This is used to avoid multiplication etc
337                          * when there is only the value '1' in the
338                          * buffer. */
339         wvalue=0;       /* The 'value' of the window */
340         wstart=bits-1;  /* The top bit of the window */
341         wend=0;         /* The bottom bit of the window */
342
343         if (!BN_one(r)) goto err;
344
345         for (;;)
346                 {
347                 if (BN_is_bit_set(p,wstart) == 0)
348                         {
349                         if (!start)
350                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
351                                 goto err;
352                         if (wstart == 0) break;
353                         wstart--;
354                         continue;
355                         }
356                 /* We now have wstart on a 'set' bit, we now need to work out
357                  * how bit a window to do.  To do this we need to scan
358                  * forward until the last set bit before the end of the
359                  * window */
360                 j=wstart;
361                 wvalue=1;
362                 wend=0;
363                 for (i=1; i<window; i++)
364                         {
365                         if (wstart-i < 0) break;
366                         if (BN_is_bit_set(p,wstart-i))
367                                 {
368                                 wvalue<<=(i-wend);
369                                 wvalue|=1;
370                                 wend=i;
371                                 }
372                         }
373
374                 /* wend is the size of the current window */
375                 j=wend+1;
376                 /* add the 'bytes above' */
377                 if (!start)
378                         for (i=0; i<j; i++)
379                                 {
380                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
381                                         goto err;
382                                 }
383                 
384                 /* wvalue will be an odd number < 2^window */
385                 if (!BN_mod_mul_reciprocal(r,r,val[wvalue>>1],&recp,ctx))
386                         goto err;
387
388                 /* move the 'window' down further */
389                 wstart-=wend+1;
390                 wvalue=0;
391                 start=0;
392                 if (wstart < 0) break;
393                 }
394         ret=1;
395 err:
396         BN_CTX_end(ctx);
397         BN_RECP_CTX_free(&recp);
398         bn_check_top(r);
399         return(ret);
400         }
401
402
403 int BN_mod_exp_mont(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
404                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
405         {
406         int i,j,bits,ret=0,wstart,wend,window,wvalue;
407         int start=1;
408         BIGNUM *d,*r;
409         const BIGNUM *aa;
410         /* Table of variables obtained from 'ctx' */
411         BIGNUM *val[TABLE_SIZE];
412         BN_MONT_CTX *mont=NULL;
413
414         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
415                 {
416                 return BN_mod_exp_mont_consttime(rr, a, p, m, ctx, in_mont);
417                 }
418
419         bn_check_top(a);
420         bn_check_top(p);
421         bn_check_top(m);
422
423         if (!BN_is_odd(m))
424                 {
425                 BNerr(BN_F_BN_MOD_EXP_MONT,BN_R_CALLED_WITH_EVEN_MODULUS);
426                 return(0);
427                 }
428         bits=BN_num_bits(p);
429         if (bits == 0)
430                 {
431                 ret = BN_one(rr);
432                 return ret;
433                 }
434
435         BN_CTX_start(ctx);
436         d = BN_CTX_get(ctx);
437         r = BN_CTX_get(ctx);
438         val[0] = BN_CTX_get(ctx);
439         if (!d || !r || !val[0]) goto err;
440
441         /* If this is not done, things will break in the montgomery
442          * part */
443
444         if (in_mont != NULL)
445                 mont=in_mont;
446         else
447                 {
448                 if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
449                 if (!BN_MONT_CTX_set(mont,m,ctx)) goto err;
450                 }
451
452         if (a->neg || BN_ucmp(a,m) >= 0)
453                 {
454                 if (!BN_nnmod(val[0],a,m,ctx))
455                         goto err;
456                 aa= val[0];
457                 }
458         else
459                 aa=a;
460         if (BN_is_zero(aa))
461                 {
462                 BN_zero(rr);
463                 ret = 1;
464                 goto err;
465                 }
466         if (!BN_to_montgomery(val[0],aa,mont,ctx)) goto err; /* 1 */
467
468         window = BN_window_bits_for_exponent_size(bits);
469         if (window > 1)
470                 {
471                 if (!BN_mod_mul_montgomery(d,val[0],val[0],mont,ctx)) goto err; /* 2 */
472                 j=1<<(window-1);
473                 for (i=1; i<j; i++)
474                         {
475                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
476                                         !BN_mod_mul_montgomery(val[i],val[i-1],
477                                                 d,mont,ctx))
478                                 goto err;
479                         }
480                 }
481
482         start=1;        /* This is used to avoid multiplication etc
483                          * when there is only the value '1' in the
484                          * buffer. */
485         wvalue=0;       /* The 'value' of the window */
486         wstart=bits-1;  /* The top bit of the window */
487         wend=0;         /* The bottom bit of the window */
488
489 #if 1   /* by Shay Gueron's suggestion */
490         j = m->top;     /* borrow j */
491         if (m->d[j-1] & (((BN_ULONG)1)<<(BN_BITS2-1)))
492                 {
493                 if (bn_wexpand(r,j) == NULL) goto err;
494                 /* 2^(top*BN_BITS2) - m */
495                 r->d[0] = (0-m->d[0])&BN_MASK2;
496                 for(i=1;i<j;i++) r->d[i] = (~m->d[i])&BN_MASK2;
497                 r->top = j;
498                 /* Upper words will be zero if the corresponding words of 'm'
499                  * were 0xfff[...], so decrement r->top accordingly. */
500                 bn_correct_top(r);
501                 }
502         else
503 #endif
504         if (!BN_to_montgomery(r,BN_value_one(),mont,ctx)) goto err;
505         for (;;)
506                 {
507                 if (BN_is_bit_set(p,wstart) == 0)
508                         {
509                         if (!start)
510                                 {
511                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
512                                 goto err;
513                                 }
514                         if (wstart == 0) break;
515                         wstart--;
516                         continue;
517                         }
518                 /* We now have wstart on a 'set' bit, we now need to work out
519                  * how bit a window to do.  To do this we need to scan
520                  * forward until the last set bit before the end of the
521                  * window */
522                 j=wstart;
523                 wvalue=1;
524                 wend=0;
525                 for (i=1; i<window; i++)
526                         {
527                         if (wstart-i < 0) break;
528                         if (BN_is_bit_set(p,wstart-i))
529                                 {
530                                 wvalue<<=(i-wend);
531                                 wvalue|=1;
532                                 wend=i;
533                                 }
534                         }
535
536                 /* wend is the size of the current window */
537                 j=wend+1;
538                 /* add the 'bytes above' */
539                 if (!start)
540                         for (i=0; i<j; i++)
541                                 {
542                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
543                                         goto err;
544                                 }
545                 
546                 /* wvalue will be an odd number < 2^window */
547                 if (!BN_mod_mul_montgomery(r,r,val[wvalue>>1],mont,ctx))
548                         goto err;
549
550                 /* move the 'window' down further */
551                 wstart-=wend+1;
552                 wvalue=0;
553                 start=0;
554                 if (wstart < 0) break;
555                 }
556 #if defined(SPARC_T4_MONT)
557         if (OPENSSL_sparcv9cap_P[0]&(SPARCV9_VIS3|SPARCV9_PREFER_FPU))
558                 {
559                 j = mont->N.top;        /* borrow j */
560                 val[0]->d[0] = 1;       /* borrow val[0] */
561                 for (i=1;i<j;i++) val[0]->d[i] = 0;
562                 val[0]->top = j;
563                 if (!BN_mod_mul_montgomery(rr,r,val[0],mont,ctx)) goto err;
564                 }
565         else
566 #endif
567         if (!BN_from_montgomery(rr,r,mont,ctx)) goto err;
568         ret=1;
569 err:
570         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
571         BN_CTX_end(ctx);
572         bn_check_top(rr);
573         return(ret);
574         }
575
576 #if defined(SPARC_T4_MONT)
577 static BN_ULONG bn_get_bits(const BIGNUM *a, int bitpos)
578         {
579         BN_ULONG ret=0;
580         int wordpos;
581
582         wordpos = bitpos/BN_BITS2;
583         bitpos %= BN_BITS2;
584         if (wordpos>=0 && wordpos < a->top)
585                 {
586                 ret = a->d[wordpos]&BN_MASK2;
587                 if (bitpos)
588                         {
589                         ret >>= bitpos;
590                         if (++wordpos < a->top)
591                                 ret |= a->d[wordpos]<<(BN_BITS2-bitpos);
592                         }
593                 }
594
595         return ret&BN_MASK2;
596 }
597 #endif
598
599 /* BN_mod_exp_mont_consttime() stores the precomputed powers in a specific layout
600  * so that accessing any of these table values shows the same access pattern as far
601  * as cache lines are concerned.  The following functions are used to transfer a BIGNUM
602  * from/to that table. */
603
604 static int MOD_EXP_CTIME_COPY_TO_PREBUF(const BIGNUM *b, int top, unsigned char *buf, int idx, int width)
605         {
606         size_t i, j;
607
608         if (top > b->top)
609                 top = b->top; /* this works because 'buf' is explicitly zeroed */
610         for (i = 0, j=idx; i < top * sizeof b->d[0]; i++, j+=width)
611                 {
612                 buf[j] = ((unsigned char*)b->d)[i];
613                 }
614
615         return 1;
616         }
617
618 static int MOD_EXP_CTIME_COPY_FROM_PREBUF(BIGNUM *b, int top, unsigned char *buf, int idx, int width)
619         {
620         size_t i, j;
621
622         if (bn_wexpand(b, top) == NULL)
623                 return 0;
624
625         for (i=0, j=idx; i < top * sizeof b->d[0]; i++, j+=width)
626                 {
627                 ((unsigned char*)b->d)[i] = buf[j];
628                 }
629
630         b->top = top;
631         bn_correct_top(b);
632         return 1;
633         }       
634
635 /* Given a pointer value, compute the next address that is a cache line multiple. */
636 #define MOD_EXP_CTIME_ALIGN(x_) \
637         ((unsigned char*)(x_) + (MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH - (((size_t)(x_)) & (MOD_EXP_CTIME_MIN_CACHE_LINE_MASK))))
638
639 /* This variant of BN_mod_exp_mont() uses fixed windows and the special
640  * precomputation memory layout to limit data-dependency to a minimum
641  * to protect secret exponents (cf. the hyper-threading timing attacks
642  * pointed out by Colin Percival,
643  * http://www.daemonology.net/hyperthreading-considered-harmful/)
644  */
645 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
646                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
647         {
648         int i,bits,ret=0,window,wvalue;
649         int top;
650         BN_MONT_CTX *mont=NULL;
651
652         int numPowers;
653         unsigned char *powerbufFree=NULL;
654         int powerbufLen = 0;
655         unsigned char *powerbuf=NULL;
656         BIGNUM tmp, am;
657 #if defined(SPARC_T4_MONT)
658         unsigned int t4=0;
659 #endif
660
661         bn_check_top(a);
662         bn_check_top(p);
663         bn_check_top(m);
664
665         top = m->top;
666
667         if (!(m->d[0] & 1))
668                 {
669                 BNerr(BN_F_BN_MOD_EXP_MONT_CONSTTIME,BN_R_CALLED_WITH_EVEN_MODULUS);
670                 return(0);
671                 }
672         bits=BN_num_bits(p);
673         if (bits == 0)
674                 {
675                 ret = BN_one(rr);
676                 return ret;
677                 }
678
679         BN_CTX_start(ctx);
680
681         /* Allocate a montgomery context if it was not supplied by the caller.
682          * If this is not done, things will break in the montgomery part.
683          */
684         if (in_mont != NULL)
685                 mont=in_mont;
686         else
687                 {
688                 if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
689                 if (!BN_MONT_CTX_set(mont,m,ctx)) goto err;
690                 }
691
692 #ifdef RSAZ_ENABLED
693         /*
694          * If the size of the operands allow it, perform the optimized
695          * RSAZ exponentiation. For further information see
696          * crypto/bn/rsaz_exp.c and accompanying assembly modules.
697          */
698         if ((16 == a->top) && (16 == p->top) && (BN_num_bits(m) == 1024)
699             && rsaz_avx2_eligible())
700                 {
701                 if (NULL == bn_wexpand(rr, 16)) goto err;
702                 RSAZ_1024_mod_exp_avx2(rr->d, a->d, p->d, m->d, mont->RR.d, mont->n0[0]);
703                 rr->top = 16;
704                 rr->neg = 0;
705                 bn_correct_top(rr);
706                 ret = 1;
707                 goto err;
708                 }
709         else if ((8 == a->top) && (8 == p->top) && (BN_num_bits(m) == 512))
710                 {
711                 if (NULL == bn_wexpand(rr,8)) goto err;
712                 RSAZ_512_mod_exp(rr->d, a->d, p->d, m->d, mont->n0[0], mont->RR.d);
713                 rr->top = 8;
714                 rr->neg = 0;
715                 bn_correct_top(rr);
716                 ret = 1;
717                 goto err;
718                 }
719 #endif
720
721         /* Get the window size to use with size of p. */
722         window = BN_window_bits_for_ctime_exponent_size(bits);
723 #if defined(SPARC_T4_MONT)
724         if (window>=5 && (top&15)==0 && top<=64 &&
725             (OPENSSL_sparcv9cap_P[1]&(CFR_MONTMUL|CFR_MONTSQR))==
726                                      (CFR_MONTMUL|CFR_MONTSQR) &&
727             (t4=OPENSSL_sparcv9cap_P[0]))
728                 window=5;
729         else
730 #endif
731 #if defined(OPENSSL_BN_ASM_MONT5)
732         if (window>=5)
733                 {
734                 window=5;       /* ~5% improvement for RSA2048 sign, and even for RSA4096 */
735                 if ((top&7)==0) powerbufLen += 2*top*sizeof(m->d[0]);
736                 }
737 #endif
738         (void)0;
739
740         /* Allocate a buffer large enough to hold all of the pre-computed
741          * powers of am, am itself and tmp.
742          */
743         numPowers = 1 << window;
744         powerbufLen += sizeof(m->d[0])*(top*numPowers +
745                                 ((2*top)>numPowers?(2*top):numPowers));
746 #ifdef alloca
747         if (powerbufLen < 3072)
748                 powerbufFree = alloca(powerbufLen+MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH);
749         else
750 #endif
751         if ((powerbufFree=(unsigned char*)OPENSSL_malloc(powerbufLen+MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH)) == NULL)
752                 goto err;
753                 
754         powerbuf = MOD_EXP_CTIME_ALIGN(powerbufFree);
755         memset(powerbuf, 0, powerbufLen);
756
757 #ifdef alloca
758         if (powerbufLen < 3072)
759                 powerbufFree = NULL;
760 #endif
761
762         /* lay down tmp and am right after powers table */
763         tmp.d     = (BN_ULONG *)(powerbuf + sizeof(m->d[0])*top*numPowers);
764         am.d      = tmp.d + top;
765         tmp.top   = am.top  = 0;
766         tmp.dmax  = am.dmax = top;
767         tmp.neg   = am.neg  = 0;
768         tmp.flags = am.flags = BN_FLG_STATIC_DATA;
769
770         /* prepare a^0 in Montgomery domain */
771 #if 1   /* by Shay Gueron's suggestion */
772         if (m->d[top-1] & (((BN_ULONG)1)<<(BN_BITS2-1)))
773                 {
774                 /* 2^(top*BN_BITS2) - m */
775                 tmp.d[0] = (0-m->d[0])&BN_MASK2;
776                 for (i=1;i<top;i++) tmp.d[i] = (~m->d[i])&BN_MASK2;
777                 tmp.top = top;
778                 }
779         else
780 #endif
781         if (!BN_to_montgomery(&tmp,BN_value_one(),mont,ctx))    goto err;
782
783         /* prepare a^1 in Montgomery domain */
784         if (a->neg || BN_ucmp(a,m) >= 0)
785                 {
786                 if (!BN_mod(&am,a,m,ctx))                       goto err;
787                 if (!BN_to_montgomery(&am,&am,mont,ctx))        goto err;
788                 }
789         else    if (!BN_to_montgomery(&am,a,mont,ctx))          goto err;
790
791 #if defined(SPARC_T4_MONT)
792     if (t4)
793         {
794         typedef int (*bn_pwr5_mont_f)(BN_ULONG *tp,const BN_ULONG *np,
795                         const BN_ULONG *n0,const void *table,int power,int bits);
796         int bn_pwr5_mont_t4_8(BN_ULONG *tp,const BN_ULONG *np,
797                         const BN_ULONG *n0,const void *table,int power,int bits);
798         int bn_pwr5_mont_t4_16(BN_ULONG *tp,const BN_ULONG *np,
799                         const BN_ULONG *n0,const void *table,int power,int bits);
800         int bn_pwr5_mont_t4_24(BN_ULONG *tp,const BN_ULONG *np,
801                         const BN_ULONG *n0,const void *table,int power,int bits);
802         int bn_pwr5_mont_t4_32(BN_ULONG *tp,const BN_ULONG *np,
803                         const BN_ULONG *n0,const void *table,int power,int bits);
804         static const bn_pwr5_mont_f pwr5_funcs[4] = {
805                         bn_pwr5_mont_t4_8,      bn_pwr5_mont_t4_16,
806                         bn_pwr5_mont_t4_24,     bn_pwr5_mont_t4_32 };
807         bn_pwr5_mont_f pwr5_worker = pwr5_funcs[top/16-1];
808
809         typedef int (*bn_mul_mont_f)(BN_ULONG *rp,const BN_ULONG *ap,
810                         const void *bp,const BN_ULONG *np,const BN_ULONG *n0);
811         int bn_mul_mont_t4_8(BN_ULONG *rp,const BN_ULONG *ap,
812                         const void *bp,const BN_ULONG *np,const BN_ULONG *n0);
813         int bn_mul_mont_t4_16(BN_ULONG *rp,const BN_ULONG *ap,
814                         const void *bp,const BN_ULONG *np,const BN_ULONG *n0);
815         int bn_mul_mont_t4_24(BN_ULONG *rp,const BN_ULONG *ap,
816                         const void *bp,const BN_ULONG *np,const BN_ULONG *n0);
817         int bn_mul_mont_t4_32(BN_ULONG *rp,const BN_ULONG *ap,
818                         const void *bp,const BN_ULONG *np,const BN_ULONG *n0);
819         static const bn_mul_mont_f mul_funcs[4] = {
820                         bn_mul_mont_t4_8,       bn_mul_mont_t4_16,
821                         bn_mul_mont_t4_24,      bn_mul_mont_t4_32 };
822         bn_mul_mont_f mul_worker = mul_funcs[top/16-1];
823
824         void bn_mul_mont_vis3(BN_ULONG *rp,const BN_ULONG *ap,
825                         const void *bp,const BN_ULONG *np,
826                         const BN_ULONG *n0,int num);
827         void bn_mul_mont_t4(BN_ULONG *rp,const BN_ULONG *ap,
828                         const void *bp,const BN_ULONG *np,
829                         const BN_ULONG *n0,int num);
830         void bn_mul_mont_gather5_t4(BN_ULONG *rp,const BN_ULONG *ap,
831                         const void *table,const BN_ULONG *np,
832                         const BN_ULONG *n0,int num,int power);
833         void bn_flip_n_scatter5_t4(const BN_ULONG *inp,size_t num,
834                         void *table,size_t power);
835         void bn_gather5_t4(BN_ULONG *out,size_t num,
836                         void *table,size_t power);
837         void bn_flip_t4(BN_ULONG *dst,BN_ULONG *src,size_t num);
838
839         BN_ULONG *np=mont->N.d, *n0=mont->n0;
840         int stride = 5*(6-(top/16-1));  /* multiple of 5, but less than 32 */
841
842         /* BN_to_montgomery can contaminate words above .top
843          * [in BN_DEBUG[_DEBUG] build]... */
844         for (i=am.top; i<top; i++)      am.d[i]=0;
845         for (i=tmp.top; i<top; i++)     tmp.d[i]=0;
846
847         bn_flip_n_scatter5_t4(tmp.d,top,powerbuf,0);
848         bn_flip_n_scatter5_t4(am.d,top,powerbuf,1);
849         if (!(*mul_worker)(tmp.d,am.d,am.d,np,n0) &&
850             !(*mul_worker)(tmp.d,am.d,am.d,np,n0))
851                 bn_mul_mont_vis3(tmp.d,am.d,am.d,np,n0,top);
852         bn_flip_n_scatter5_t4(tmp.d,top,powerbuf,2);
853
854         for (i=3; i<32; i++)
855                 {
856                 /* Calculate a^i = a^(i-1) * a */
857                 if (!(*mul_worker)(tmp.d,tmp.d,am.d,np,n0) &&
858                     !(*mul_worker)(tmp.d,tmp.d,am.d,np,n0))
859                         bn_mul_mont_vis3(tmp.d,tmp.d,am.d,np,n0,top);
860                 bn_flip_n_scatter5_t4(tmp.d,top,powerbuf,i);
861                 }
862
863         /* switch to 64-bit domain */ 
864         np = alloca(top*sizeof(BN_ULONG));
865         top /= 2;
866         bn_flip_t4(np,mont->N.d,top);
867
868         bits--;
869         for (wvalue=0, i=bits%5; i>=0; i--,bits--)
870                 wvalue = (wvalue<<1)+BN_is_bit_set(p,bits);
871         bn_gather5_t4(tmp.d,top,powerbuf,wvalue);
872
873         /* Scan the exponent one window at a time starting from the most
874          * significant bits.
875          */
876         while (bits >= 0)
877                 {
878                 if (bits < stride) stride = bits+1;
879                 bits -= stride;
880                 wvalue = bn_get_bits(p,bits+1);
881
882                 if ((*pwr5_worker)(tmp.d,np,n0,powerbuf,wvalue,stride)) continue;
883                 /* retry once and fall back */
884                 if ((*pwr5_worker)(tmp.d,np,n0,powerbuf,wvalue,stride)) continue;
885
886                 bits += stride-5;
887                 wvalue >>= stride-5;
888                 wvalue &= 31;
889                 bn_mul_mont_t4(tmp.d,tmp.d,tmp.d,np,n0,top);
890                 bn_mul_mont_t4(tmp.d,tmp.d,tmp.d,np,n0,top);
891                 bn_mul_mont_t4(tmp.d,tmp.d,tmp.d,np,n0,top);
892                 bn_mul_mont_t4(tmp.d,tmp.d,tmp.d,np,n0,top);
893                 bn_mul_mont_t4(tmp.d,tmp.d,tmp.d,np,n0,top);
894                 bn_mul_mont_gather5_t4(tmp.d,tmp.d,powerbuf,np,n0,top,wvalue);
895                 }
896
897         bn_flip_t4(tmp.d,tmp.d,top);
898         top *= 2;
899         /* back to 32-bit domain */
900         tmp.top=top;
901         bn_correct_top(&tmp);
902         OPENSSL_cleanse(np,top*sizeof(BN_ULONG));
903         }
904     else
905 #endif
906 #if defined(OPENSSL_BN_ASM_MONT5)
907     /* This optimization uses ideas from http://eprint.iacr.org/2011/239,
908      * specifically optimization of cache-timing attack countermeasures
909      * and pre-computation optimization. */
910
911     /* Dedicated window==4 case improves 512-bit RSA sign by ~15%, but as
912      * 512-bit RSA is hardly relevant, we omit it to spare size... */ 
913     if (window==5 && top>1)
914         {
915         void bn_mul_mont_gather5(BN_ULONG *rp,const BN_ULONG *ap,
916                         const void *table,const BN_ULONG *np,
917                         const BN_ULONG *n0,int num,int power);
918         void bn_scatter5(const BN_ULONG *inp,size_t num,
919                         void *table,size_t power);
920         void bn_gather5(BN_ULONG *out,size_t num,
921                         void *table,size_t power);
922         void bn_power5(BN_ULONG *rp,const BN_ULONG *ap,
923                         const void *table,const BN_ULONG *np,
924                         const BN_ULONG *n0,int num,int power);
925         int bn_get_bits5(const BN_ULONG *ap,int off);
926         int bn_from_montgomery(BN_ULONG *rp,const BN_ULONG *ap,
927                         const BN_ULONG *not_used,const BN_ULONG *np,
928                         const BN_ULONG *n0,int num);
929
930         BN_ULONG *np=mont->N.d, *n0=mont->n0, *np2;
931
932         /* BN_to_montgomery can contaminate words above .top
933          * [in BN_DEBUG[_DEBUG] build]... */
934         for (i=am.top; i<top; i++)      am.d[i]=0;
935         for (i=tmp.top; i<top; i++)     tmp.d[i]=0;
936
937         if (top&7)
938                 np2 = np;
939         else
940                 for (np2=am.d+top,i=0; i<top; i++) np2[2*i]=np[i];
941
942         bn_scatter5(tmp.d,top,powerbuf,0);
943         bn_scatter5(am.d,am.top,powerbuf,1);
944         bn_mul_mont(tmp.d,am.d,am.d,np,n0,top);
945         bn_scatter5(tmp.d,top,powerbuf,2);
946
947 #if 0
948         for (i=3; i<32; i++)
949                 {
950                 /* Calculate a^i = a^(i-1) * a */
951                 bn_mul_mont_gather5(tmp.d,am.d,powerbuf,np2,n0,top,i-1);
952                 bn_scatter5(tmp.d,top,powerbuf,i);
953                 }
954 #else
955         /* same as above, but uses squaring for 1/2 of operations */
956         for (i=4; i<32; i*=2)
957                 {
958                 bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
959                 bn_scatter5(tmp.d,top,powerbuf,i);
960                 }
961         for (i=3; i<8; i+=2)
962                 {
963                 int j;
964                 bn_mul_mont_gather5(tmp.d,am.d,powerbuf,np2,n0,top,i-1);
965                 bn_scatter5(tmp.d,top,powerbuf,i);
966                 for (j=2*i; j<32; j*=2)
967                         {
968                         bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
969                         bn_scatter5(tmp.d,top,powerbuf,j);
970                         }
971                 }
972         for (; i<16; i+=2)
973                 {
974                 bn_mul_mont_gather5(tmp.d,am.d,powerbuf,np2,n0,top,i-1);
975                 bn_scatter5(tmp.d,top,powerbuf,i);
976                 bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
977                 bn_scatter5(tmp.d,top,powerbuf,2*i);
978                 }
979         for (; i<32; i+=2)
980                 {
981                 bn_mul_mont_gather5(tmp.d,am.d,powerbuf,np2,n0,top,i-1);
982                 bn_scatter5(tmp.d,top,powerbuf,i);
983                 }
984 #endif
985         bits--;
986         for (wvalue=0, i=bits%5; i>=0; i--,bits--)
987                 wvalue = (wvalue<<1)+BN_is_bit_set(p,bits);
988         bn_gather5(tmp.d,top,powerbuf,wvalue);
989
990         /* Scan the exponent one window at a time starting from the most
991          * significant bits.
992          */
993         if (top&7)
994             while (bits >= 0)
995                 {
996                 for (wvalue=0, i=0; i<5; i++,bits--)
997                         wvalue = (wvalue<<1)+BN_is_bit_set(p,bits);
998
999                 bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
1000                 bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
1001                 bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
1002                 bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
1003                 bn_mul_mont(tmp.d,tmp.d,tmp.d,np,n0,top);
1004                 bn_mul_mont_gather5(tmp.d,tmp.d,powerbuf,np,n0,top,wvalue);
1005                 }
1006         else
1007             {
1008             while (bits >= 0)
1009                 {
1010                 wvalue = bn_get_bits5(p->d,bits-4);
1011                 bits-=5;
1012                 bn_power5(tmp.d,tmp.d,powerbuf,np2,n0,top,wvalue);
1013                 }
1014             }
1015
1016         ret=bn_from_montgomery(tmp.d,tmp.d,NULL,np2,n0,top);
1017         tmp.top=top;
1018         bn_correct_top(&tmp);
1019         if (ret)
1020                 {
1021                 if (!BN_copy(rr,&tmp)) ret=0;
1022                 goto err; /* non-zero ret means it's not error */
1023                 }
1024         }
1025     else
1026 #endif
1027         {
1028         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(&tmp, top, powerbuf, 0, numPowers)) goto err;
1029         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(&am,  top, powerbuf, 1, numPowers)) goto err;
1030
1031         /* If the window size is greater than 1, then calculate
1032          * val[i=2..2^winsize-1]. Powers are computed as a*a^(i-1)
1033          * (even powers could instead be computed as (a^(i/2))^2
1034          * to use the slight performance advantage of sqr over mul).
1035          */
1036         if (window > 1)
1037                 {
1038                 if (!BN_mod_mul_montgomery(&tmp,&am,&am,mont,ctx))      goto err;
1039                 if (!MOD_EXP_CTIME_COPY_TO_PREBUF(&tmp, top, powerbuf, 2, numPowers)) goto err;
1040                 for (i=3; i<numPowers; i++)
1041                         {
1042                         /* Calculate a^i = a^(i-1) * a */
1043                         if (!BN_mod_mul_montgomery(&tmp,&am,&tmp,mont,ctx))
1044                                 goto err;
1045                         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(&tmp, top, powerbuf, i, numPowers)) goto err;
1046                         }
1047                 }
1048
1049         bits--;
1050         for (wvalue=0, i=bits%window; i>=0; i--,bits--)
1051                 wvalue = (wvalue<<1)+BN_is_bit_set(p,bits);
1052         if (!MOD_EXP_CTIME_COPY_FROM_PREBUF(&tmp,top,powerbuf,wvalue,numPowers)) goto err;
1053  
1054         /* Scan the exponent one window at a time starting from the most
1055          * significant bits.
1056          */
1057         while (bits >= 0)
1058                 {
1059                 wvalue=0; /* The 'value' of the window */
1060                 
1061                 /* Scan the window, squaring the result as we go */
1062                 for (i=0; i<window; i++,bits--)
1063                         {
1064                         if (!BN_mod_mul_montgomery(&tmp,&tmp,&tmp,mont,ctx))    goto err;
1065                         wvalue = (wvalue<<1)+BN_is_bit_set(p,bits);
1066                         }
1067                 
1068                 /* Fetch the appropriate pre-computed value from the pre-buf */
1069                 if (!MOD_EXP_CTIME_COPY_FROM_PREBUF(&am, top, powerbuf, wvalue, numPowers)) goto err;
1070
1071                 /* Multiply the result into the intermediate result */
1072                 if (!BN_mod_mul_montgomery(&tmp,&tmp,&am,mont,ctx)) goto err;
1073                 }
1074         }
1075
1076         /* Convert the final result from montgomery to standard format */
1077 #if defined(SPARC_T4_MONT)
1078         if (OPENSSL_sparcv9cap_P[0]&(SPARCV9_VIS3|SPARCV9_PREFER_FPU))
1079                 {
1080                 am.d[0] = 1;    /* borrow am */
1081                 for (i=1;i<top;i++) am.d[i] = 0;
1082                 if (!BN_mod_mul_montgomery(rr,&tmp,&am,mont,ctx)) goto err;
1083                 }
1084         else
1085 #endif
1086         if (!BN_from_montgomery(rr,&tmp,mont,ctx)) goto err;
1087         ret=1;
1088 err:
1089         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
1090         if (powerbuf!=NULL)
1091                 {
1092                 OPENSSL_cleanse(powerbuf,powerbufLen);
1093                 if (powerbufFree) OPENSSL_free(powerbufFree);
1094                 }
1095         BN_CTX_end(ctx);
1096         return(ret);
1097         }
1098
1099 int BN_mod_exp_mont_word(BIGNUM *rr, BN_ULONG a, const BIGNUM *p,
1100                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
1101         {
1102         BN_MONT_CTX *mont = NULL;
1103         int b, bits, ret=0;
1104         int r_is_one;
1105         BN_ULONG w, next_w;
1106         BIGNUM *d, *r, *t;
1107         BIGNUM *swap_tmp;
1108 #define BN_MOD_MUL_WORD(r, w, m) \
1109                 (BN_mul_word(r, (w)) && \
1110                 (/* BN_ucmp(r, (m)) < 0 ? 1 :*/  \
1111                         (BN_mod(t, r, m, ctx) && (swap_tmp = r, r = t, t = swap_tmp, 1))))
1112                 /* BN_MOD_MUL_WORD is only used with 'w' large,
1113                  * so the BN_ucmp test is probably more overhead
1114                  * than always using BN_mod (which uses BN_copy if
1115                  * a similar test returns true). */
1116                 /* We can use BN_mod and do not need BN_nnmod because our
1117                  * accumulator is never negative (the result of BN_mod does
1118                  * not depend on the sign of the modulus).
1119                  */
1120 #define BN_TO_MONTGOMERY_WORD(r, w, mont) \
1121                 (BN_set_word(r, (w)) && BN_to_montgomery(r, r, (mont), ctx))
1122
1123         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
1124                 {
1125                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
1126                 BNerr(BN_F_BN_MOD_EXP_MONT_WORD,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1127                 return -1;
1128                 }
1129
1130         bn_check_top(p);
1131         bn_check_top(m);
1132
1133         if (!BN_is_odd(m))
1134                 {
1135                 BNerr(BN_F_BN_MOD_EXP_MONT_WORD,BN_R_CALLED_WITH_EVEN_MODULUS);
1136                 return(0);
1137                 }
1138         if (m->top == 1)
1139                 a %= m->d[0]; /* make sure that 'a' is reduced */
1140
1141         bits = BN_num_bits(p);
1142         if (bits == 0)
1143                 {
1144                 /* x**0 mod 1 is still zero. */
1145                 if (BN_is_one(m))
1146                         {
1147                         ret = 1;
1148                         BN_zero(rr);
1149                         }
1150                 else
1151                         ret = BN_one(rr);
1152                 return ret;
1153                 }
1154         if (a == 0)
1155                 {
1156                 BN_zero(rr);
1157                 ret = 1;
1158                 return ret;
1159                 }
1160
1161         BN_CTX_start(ctx);
1162         d = BN_CTX_get(ctx);
1163         r = BN_CTX_get(ctx);
1164         t = BN_CTX_get(ctx);
1165         if (d == NULL || r == NULL || t == NULL) goto err;
1166
1167         if (in_mont != NULL)
1168                 mont=in_mont;
1169         else
1170                 {
1171                 if ((mont = BN_MONT_CTX_new()) == NULL) goto err;
1172                 if (!BN_MONT_CTX_set(mont, m, ctx)) goto err;
1173                 }
1174
1175         r_is_one = 1; /* except for Montgomery factor */
1176
1177         /* bits-1 >= 0 */
1178
1179         /* The result is accumulated in the product r*w. */
1180         w = a; /* bit 'bits-1' of 'p' is always set */
1181         for (b = bits-2; b >= 0; b--)
1182                 {
1183                 /* First, square r*w. */
1184                 next_w = w*w;
1185                 if ((next_w/w) != w) /* overflow */
1186                         {
1187                         if (r_is_one)
1188                                 {
1189                                 if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
1190                                 r_is_one = 0;
1191                                 }
1192                         else
1193                                 {
1194                                 if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
1195                                 }
1196                         next_w = 1;
1197                         }
1198                 w = next_w;
1199                 if (!r_is_one)
1200                         {
1201                         if (!BN_mod_mul_montgomery(r, r, r, mont, ctx)) goto err;
1202                         }
1203
1204                 /* Second, multiply r*w by 'a' if exponent bit is set. */
1205                 if (BN_is_bit_set(p, b))
1206                         {
1207                         next_w = w*a;
1208                         if ((next_w/a) != w) /* overflow */
1209                                 {
1210                                 if (r_is_one)
1211                                         {
1212                                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
1213                                         r_is_one = 0;
1214                                         }
1215                                 else
1216                                         {
1217                                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
1218                                         }
1219                                 next_w = a;
1220                                 }
1221                         w = next_w;
1222                         }
1223                 }
1224
1225         /* Finally, set r:=r*w. */
1226         if (w != 1)
1227                 {
1228                 if (r_is_one)
1229                         {
1230                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
1231                         r_is_one = 0;
1232                         }
1233                 else
1234                         {
1235                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
1236                         }
1237                 }
1238
1239         if (r_is_one) /* can happen only if a == 1*/
1240                 {
1241                 if (!BN_one(rr)) goto err;
1242                 }
1243         else
1244                 {
1245                 if (!BN_from_montgomery(rr, r, mont, ctx)) goto err;
1246                 }
1247         ret = 1;
1248 err:
1249         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
1250         BN_CTX_end(ctx);
1251         bn_check_top(rr);
1252         return(ret);
1253         }
1254
1255
1256 /* The old fallback, simple version :-) */
1257 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
1258                 const BIGNUM *m, BN_CTX *ctx)
1259         {
1260         int i,j,bits,ret=0,wstart,wend,window,wvalue;
1261         int start=1;
1262         BIGNUM *d;
1263         /* Table of variables obtained from 'ctx' */
1264         BIGNUM *val[TABLE_SIZE];
1265
1266         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
1267                 {
1268                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
1269                 BNerr(BN_F_BN_MOD_EXP_SIMPLE,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
1270                 return -1;
1271                 }
1272
1273         bits=BN_num_bits(p);
1274
1275         if (bits == 0)
1276                 {
1277                 ret = BN_one(r);
1278                 return ret;
1279                 }
1280
1281         BN_CTX_start(ctx);
1282         d = BN_CTX_get(ctx);
1283         val[0] = BN_CTX_get(ctx);
1284         if(!d || !val[0]) goto err;
1285
1286         if (!BN_nnmod(val[0],a,m,ctx)) goto err;                /* 1 */
1287         if (BN_is_zero(val[0]))
1288                 {
1289                 BN_zero(r);
1290                 ret = 1;
1291                 goto err;
1292                 }
1293
1294         window = BN_window_bits_for_exponent_size(bits);
1295         if (window > 1)
1296                 {
1297                 if (!BN_mod_mul(d,val[0],val[0],m,ctx))
1298                         goto err;                               /* 2 */
1299                 j=1<<(window-1);
1300                 for (i=1; i<j; i++)
1301                         {
1302                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
1303                                         !BN_mod_mul(val[i],val[i-1],d,m,ctx))
1304                                 goto err;
1305                         }
1306                 }
1307
1308         start=1;        /* This is used to avoid multiplication etc
1309                          * when there is only the value '1' in the
1310                          * buffer. */
1311         wvalue=0;       /* The 'value' of the window */
1312         wstart=bits-1;  /* The top bit of the window */
1313         wend=0;         /* The bottom bit of the window */
1314
1315         if (!BN_one(r)) goto err;
1316
1317         for (;;)
1318                 {
1319                 if (BN_is_bit_set(p,wstart) == 0)
1320                         {
1321                         if (!start)
1322                                 if (!BN_mod_mul(r,r,r,m,ctx))
1323                                 goto err;
1324                         if (wstart == 0) break;
1325                         wstart--;
1326                         continue;
1327                         }
1328                 /* We now have wstart on a 'set' bit, we now need to work out
1329                  * how bit a window to do.  To do this we need to scan
1330                  * forward until the last set bit before the end of the
1331                  * window */
1332                 j=wstart;
1333                 wvalue=1;
1334                 wend=0;
1335                 for (i=1; i<window; i++)
1336                         {
1337                         if (wstart-i < 0) break;
1338                         if (BN_is_bit_set(p,wstart-i))
1339                                 {
1340                                 wvalue<<=(i-wend);
1341                                 wvalue|=1;
1342                                 wend=i;
1343                                 }
1344                         }
1345
1346                 /* wend is the size of the current window */
1347                 j=wend+1;
1348                 /* add the 'bytes above' */
1349                 if (!start)
1350                         for (i=0; i<j; i++)
1351                                 {
1352                                 if (!BN_mod_mul(r,r,r,m,ctx))
1353                                         goto err;
1354                                 }
1355                 
1356                 /* wvalue will be an odd number < 2^window */
1357                 if (!BN_mod_mul(r,r,val[wvalue>>1],m,ctx))
1358                         goto err;
1359
1360                 /* move the 'window' down further */
1361                 wstart-=wend+1;
1362                 wvalue=0;
1363                 start=0;
1364                 if (wstart < 0) break;
1365                 }
1366         ret=1;
1367 err:
1368         BN_CTX_end(ctx);
1369         bn_check_top(r);
1370         return(ret);
1371         }