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