Handle special cases correctly in exponentation functions.
[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-2000 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112
113 #include "cryptlib.h"
114 #include "bn_lcl.h"
115
116 #define TABLE_SIZE      32
117
118 /* this one works - simple but works */
119 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
120         {
121         int i,bits,ret=0;
122         BIGNUM *v,*rr;
123
124         BN_CTX_start(ctx);
125         if ((r == a) || (r == p))
126                 rr = BN_CTX_get(ctx);
127         else
128                 rr = r;
129         if ((v = BN_CTX_get(ctx)) == NULL) goto err;
130
131         if (BN_copy(v,a) == NULL) goto err;
132         bits=BN_num_bits(p);
133
134         if (BN_is_odd(p))
135                 { if (BN_copy(rr,a) == NULL) goto err; }
136         else    { if (!BN_one(rr)) goto err; }
137
138         for (i=1; i<bits; i++)
139                 {
140                 if (!BN_sqr(v,v,ctx)) goto err;
141                 if (BN_is_bit_set(p,i))
142                         {
143                         if (!BN_mul(rr,rr,v,ctx)) goto err;
144                         }
145                 }
146         ret=1;
147 err:
148         if (r != rr) BN_copy(r,rr);
149         BN_CTX_end(ctx);
150         return(ret);
151         }
152
153
154 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m,
155                BN_CTX *ctx)
156         {
157         int ret;
158
159         bn_check_top(a);
160         bn_check_top(p);
161         bn_check_top(m);
162
163         /* For even modulus  m = 2^k*m_odd,  it might make sense to compute
164          * a^p mod m_odd  and  a^p mod 2^k  separately (with Montgomery
165          * exponentiation for the odd part), using appropriate exponent
166          * reductions, and combine the results using the CRT.
167          *
168          * For now, we use Montgomery only if the modulus is odd; otherwise,
169          * exponentiation using the reciprocal-based quick remaindering
170          * algorithm is used.
171          *
172          * (Timing obtained with expspeed.c [computations  a^p mod m
173          * where  a, p, m  are of the same length: 256, 512, 1024, 2048,
174          * 4096, 8192 bits], compared to the running time of the
175          * standard algorithm:
176          *
177          *   BN_mod_exp_mont   33 .. 40 %  [AMD K6-2, Linux, debug configuration]
178          *                     55 .. 77 %  [UltraSparc processor, but
179          *                                  debug-solaris-sparcv8-gcc conf.]
180          * 
181          *   BN_mod_exp_recp   50 .. 70 %  [AMD K6-2, Linux, debug configuration]
182          *                     62 .. 118 % [UltraSparc, debug-solaris-sparcv8-gcc]
183          *
184          * On the Sparc, BN_mod_exp_recp was faster than BN_mod_exp_mont
185          * at 2048 and more bits, but at 512 and 1024 bits, it was
186          * slower even than the standard algorithm!
187          *
188          * "Real" timings [linux-elf, solaris-sparcv9-gcc configurations]
189          * should be obtained when the new Montgomery reduction code
190          * has been integrated into OpenSSL.)
191          */
192
193 #define MONT_MUL_MOD
194 #define RECP_MUL_MOD
195
196 #ifdef MONT_MUL_MOD
197         /* I have finally been able to take out this pre-condition of
198          * the top bit being set.  It was caused by an error in BN_div
199          * with negatives.  There was also another problem when for a^b%m
200          * a >= m.  eay 07-May-97 */
201 /*      if ((m->d[m->top-1]&BN_TBIT) && BN_is_odd(m)) */
202
203         if (BN_is_odd(m))
204                 {
205                 if (a->top == 1 && !a->neg)
206                         {
207                         BN_ULONG A = a->d[0];
208                         if (m->top == 1)
209                                 A %= m->d[0]; /* make sure that A is reduced */
210                         ret=BN_mod_exp_mont_word(r,A,p,m,ctx,NULL);
211                         }
212                 else
213                         ret=BN_mod_exp_mont(r,a,p,m,ctx,NULL);
214                 }
215         else
216 #endif
217 #ifdef RECP_MUL_MOD
218                 { ret=BN_mod_exp_recp(r,a,p,m,ctx); }
219 #else
220                 { ret=BN_mod_exp_simple(r,a,p,m,ctx); }
221 #endif
222
223         return(ret);
224         }
225
226
227 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
228                     const BIGNUM *m, BN_CTX *ctx)
229         {
230         int i,j,bits,ret=0,wstart,wend,window,wvalue;
231         int start=1,ts=0;
232         BIGNUM *aa;
233         BIGNUM val[TABLE_SIZE];
234         BN_RECP_CTX recp;
235
236         bits=BN_num_bits(p);
237
238         if (bits == 0)
239                 {
240                 ret = BN_one(r);
241                 return ret;
242                 }
243
244         BN_CTX_start(ctx);
245         if ((aa = BN_CTX_get(ctx)) == NULL) goto err;
246
247         BN_RECP_CTX_init(&recp);
248         if (BN_RECP_CTX_set(&recp,m,ctx) <= 0) goto err;
249
250         BN_init(&(val[0]));
251         ts=1;
252
253         if (!BN_nnmod(&(val[0]),a,m,ctx)) goto err;             /* 1 */
254         if (BN_is_zero(&(val[0])))
255                 {
256                 ret = BN_zero(r);
257                 goto err;
258                 }
259
260         window = BN_window_bits_for_exponent_size(bits);
261         if (window > 1)
262                 {
263                 if (!BN_mod_mul_reciprocal(aa,&(val[0]),&(val[0]),&recp,ctx))
264                         goto err;                               /* 2 */
265                 j=1<<(window-1);
266                 for (i=1; i<j; i++)
267                         {
268                         BN_init(&val[i]);
269                         if (!BN_mod_mul_reciprocal(&(val[i]),&(val[i-1]),aa,&recp,ctx))
270                                 goto err;
271                         }
272                 ts=i;
273                 }
274                 
275         start=1;        /* This is used to avoid multiplication etc
276                          * when there is only the value '1' in the
277                          * buffer. */
278         wvalue=0;       /* The 'value' of the window */
279         wstart=bits-1;  /* The top bit of the window */
280         wend=0;         /* The bottom bit of the window */
281
282         if (!BN_one(r)) goto err;
283
284         for (;;)
285                 {
286                 if (BN_is_bit_set(p,wstart) == 0)
287                         {
288                         if (!start)
289                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
290                                 goto err;
291                         if (wstart == 0) break;
292                         wstart--;
293                         continue;
294                         }
295                 /* We now have wstart on a 'set' bit, we now need to work out
296                  * how bit a window to do.  To do this we need to scan
297                  * forward until the last set bit before the end of the
298                  * window */
299                 j=wstart;
300                 wvalue=1;
301                 wend=0;
302                 for (i=1; i<window; i++)
303                         {
304                         if (wstart-i < 0) break;
305                         if (BN_is_bit_set(p,wstart-i))
306                                 {
307                                 wvalue<<=(i-wend);
308                                 wvalue|=1;
309                                 wend=i;
310                                 }
311                         }
312
313                 /* wend is the size of the current window */
314                 j=wend+1;
315                 /* add the 'bytes above' */
316                 if (!start)
317                         for (i=0; i<j; i++)
318                                 {
319                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
320                                         goto err;
321                                 }
322                 
323                 /* wvalue will be an odd number < 2^window */
324                 if (!BN_mod_mul_reciprocal(r,r,&(val[wvalue>>1]),&recp,ctx))
325                         goto err;
326
327                 /* move the 'window' down further */
328                 wstart-=wend+1;
329                 wvalue=0;
330                 start=0;
331                 if (wstart < 0) break;
332                 }
333         ret=1;
334 err:
335         BN_CTX_end(ctx);
336         for (i=0; i<ts; i++)
337                 BN_clear_free(&(val[i]));
338         BN_RECP_CTX_free(&recp);
339         return(ret);
340         }
341
342
343 int BN_mod_exp_mont(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
344                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
345         {
346         int i,j,bits,ret=0,wstart,wend,window,wvalue;
347         int start=1,ts=0;
348         BIGNUM *d,*r;
349         const BIGNUM *aa;
350         BIGNUM val[TABLE_SIZE];
351         BN_MONT_CTX *mont=NULL;
352
353         bn_check_top(a);
354         bn_check_top(p);
355         bn_check_top(m);
356
357         if (!(m->d[0] & 1))
358                 {
359                 BNerr(BN_F_BN_MOD_EXP_MONT,BN_R_CALLED_WITH_EVEN_MODULUS);
360                 return(0);
361                 }
362         bits=BN_num_bits(p);
363         if (bits == 0)
364                 {
365                 ret = BN_one(rr);
366                 return ret;
367                 }
368
369         BN_CTX_start(ctx);
370         d = BN_CTX_get(ctx);
371         r = BN_CTX_get(ctx);
372         if (d == NULL || r == NULL) goto err;
373
374         /* If this is not done, things will break in the montgomery
375          * part */
376
377         if (in_mont != NULL)
378                 mont=in_mont;
379         else
380                 {
381                 if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
382                 if (!BN_MONT_CTX_set(mont,m,ctx)) goto err;
383                 }
384
385         BN_init(&val[0]);
386         ts=1;
387         if (a->neg || BN_ucmp(a,m) >= 0)
388                 {
389                 if (!BN_nnmod(&(val[0]),a,m,ctx))
390                         goto err;
391                 aa= &(val[0]);
392                 }
393         else
394                 aa=a;
395         if (BN_is_zero(aa))
396                 {
397                 ret = BN_zero(rr);
398                 goto err;
399                 }
400         if (!BN_to_montgomery(&(val[0]),aa,mont,ctx)) goto err; /* 1 */
401
402         window = BN_window_bits_for_exponent_size(bits);
403         if (window > 1)
404                 {
405                 if (!BN_mod_mul_montgomery(d,&(val[0]),&(val[0]),mont,ctx)) goto err; /* 2 */
406                 j=1<<(window-1);
407                 for (i=1; i<j; i++)
408                         {
409                         BN_init(&(val[i]));
410                         if (!BN_mod_mul_montgomery(&(val[i]),&(val[i-1]),d,mont,ctx))
411                                 goto err;
412                         }
413                 ts=i;
414                 }
415
416         start=1;        /* This is used to avoid multiplication etc
417                          * when there is only the value '1' in the
418                          * buffer. */
419         wvalue=0;       /* The 'value' of the window */
420         wstart=bits-1;  /* The top bit of the window */
421         wend=0;         /* The bottom bit of the window */
422
423         if (!BN_to_montgomery(r,BN_value_one(),mont,ctx)) goto err;
424         for (;;)
425                 {
426                 if (BN_is_bit_set(p,wstart) == 0)
427                         {
428                         if (!start)
429                                 {
430                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
431                                 goto err;
432                                 }
433                         if (wstart == 0) break;
434                         wstart--;
435                         continue;
436                         }
437                 /* We now have wstart on a 'set' bit, we now need to work out
438                  * how bit a window to do.  To do this we need to scan
439                  * forward until the last set bit before the end of the
440                  * window */
441                 j=wstart;
442                 wvalue=1;
443                 wend=0;
444                 for (i=1; i<window; i++)
445                         {
446                         if (wstart-i < 0) break;
447                         if (BN_is_bit_set(p,wstart-i))
448                                 {
449                                 wvalue<<=(i-wend);
450                                 wvalue|=1;
451                                 wend=i;
452                                 }
453                         }
454
455                 /* wend is the size of the current window */
456                 j=wend+1;
457                 /* add the 'bytes above' */
458                 if (!start)
459                         for (i=0; i<j; i++)
460                                 {
461                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
462                                         goto err;
463                                 }
464                 
465                 /* wvalue will be an odd number < 2^window */
466                 if (!BN_mod_mul_montgomery(r,r,&(val[wvalue>>1]),mont,ctx))
467                         goto err;
468
469                 /* move the 'window' down further */
470                 wstart-=wend+1;
471                 wvalue=0;
472                 start=0;
473                 if (wstart < 0) break;
474                 }
475         if (!BN_from_montgomery(rr,r,mont,ctx)) goto err;
476         ret=1;
477 err:
478         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
479         BN_CTX_end(ctx);
480         for (i=0; i<ts; i++)
481                 BN_clear_free(&(val[i]));
482         return(ret);
483         }
484
485 int BN_mod_exp_mont_word(BIGNUM *rr, BN_ULONG a, const BIGNUM *p,
486                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
487         {
488         BN_MONT_CTX *mont = NULL;
489         int b, bits, ret=0;
490         int r_is_one;
491         BN_ULONG w, next_w;
492         BIGNUM *d, *r, *t;
493         BIGNUM *swap_tmp;
494 #define BN_MOD_MUL_WORD(r, w, m) \
495                 (BN_mul_word(r, (w)) && \
496                 (/* BN_ucmp(r, (m)) < 0 ? 1 :*/  \
497                         (BN_mod(t, r, m, ctx) && (swap_tmp = r, r = t, t = swap_tmp, 1))))
498                 /* BN_MOD_MUL_WORD is only used with 'w' large,
499                   * so the BN_ucmp test is probably more overhead
500                   * than always using BN_mod (which uses BN_copy if
501                   * a similar test returns true). */
502 #define BN_TO_MONTGOMERY_WORD(r, w, mont) \
503                 (BN_set_word(r, (w)) && BN_to_montgomery(r, r, (mont), ctx))
504
505         bn_check_top(p);
506         bn_check_top(m);
507
508         if (!(m->d[0] & 1))
509                 {
510                 BNerr(BN_F_BN_MOD_EXP_MONT_WORD,BN_R_CALLED_WITH_EVEN_MODULUS);
511                 return(0);
512                 }
513         bits = BN_num_bits(p);
514         if (bits == 0)
515                 {
516                 ret = BN_one(rr);
517                 return ret;
518                 }
519         if (a == 0)
520                 {
521                 ret = BN_zero(rr);
522                 return ret;
523                 }
524
525         BN_CTX_start(ctx);
526         d = BN_CTX_get(ctx);
527         r = BN_CTX_get(ctx);
528         t = BN_CTX_get(ctx);
529         if (d == NULL || r == NULL || t == NULL) goto err;
530
531         if (in_mont != NULL)
532                 mont=in_mont;
533         else
534                 {
535                 if ((mont = BN_MONT_CTX_new()) == NULL) goto err;
536                 if (!BN_MONT_CTX_set(mont, m, ctx)) goto err;
537                 }
538
539         r_is_one = 1; /* except for Montgomery factor */
540
541         /* bits-1 >= 0 */
542
543         /* The result is accumulated in the product r*w. */
544         w = a; /* bit 'bits-1' of 'p' is always set */
545         for (b = bits-2; b >= 0; b--)
546                 {
547                 /* First, square r*w. */
548                 next_w = w*w;
549                 if ((next_w/w) != w) /* overflow */
550                         {
551                         if (r_is_one)
552                                 {
553                                 if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
554                                 r_is_one = 0;
555                                 }
556                         else
557                                 {
558                                 if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
559                                 }
560                         next_w = 1;
561                         }
562                 w = next_w;
563                 if (!r_is_one)
564                         {
565                         if (!BN_mod_mul_montgomery(r, r, r, mont, ctx)) goto err;
566                         }
567
568                 /* Second, multiply r*w by 'a' if exponent bit is set. */
569                 if (BN_is_bit_set(p, b))
570                         {
571                         next_w = w*a;
572                         if ((next_w/a) != w) /* overflow */
573                                 {
574                                 if (r_is_one)
575                                         {
576                                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
577                                         r_is_one = 0;
578                                         }
579                                 else
580                                         {
581                                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
582                                         }
583                                 next_w = a;
584                                 }
585                         w = next_w;
586                         }
587                 }
588
589         /* Finally, set r:=r*w. */
590         if (w != 1)
591                 {
592                 if (r_is_one)
593                         {
594                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
595                         r_is_one = 0;
596                         }
597                 else
598                         {
599                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
600                         }
601                 }
602
603         if (r_is_one) /* can happen only if a == 1*/
604                 {
605                 if (!BN_one(rr)) goto err;
606                 }
607         else
608                 {
609                 if (!BN_from_montgomery(rr, r, mont, ctx)) goto err;
610                 }
611         ret = 1;
612 err:
613         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
614         BN_CTX_end(ctx);
615         return(ret);
616         }
617
618
619 /* The old fallback, simple version :-) */
620 int BN_mod_exp_simple(BIGNUM *r,
621         const BIGNUM *a, const BIGNUM *p, const BIGNUM *m,
622         BN_CTX *ctx)
623         {
624         int i,j,bits,ret=0,wstart,wend,window,wvalue,ts=0;
625         int start=1;
626         BIGNUM *d;
627         BIGNUM val[TABLE_SIZE];
628
629         bits=BN_num_bits(p);
630
631         if (bits == 0)
632                 {
633                 ret = BN_one(r);
634                 return ret;
635                 }
636
637         BN_CTX_start(ctx);
638         if ((d = BN_CTX_get(ctx)) == NULL) goto err;
639
640         BN_init(&(val[0]));
641         ts=1;
642         if (!BN_nnmod(&(val[0]),a,m,ctx)) goto err;             /* 1 */
643         if (BN_is_zero(&(val[0])))
644                 {
645                 ret = BN_one(r);
646                 return ret;
647                 }
648
649         window = BN_window_bits_for_exponent_size(bits);
650         if (window > 1)
651                 {
652                 if (!BN_mod_mul(d,&(val[0]),&(val[0]),m,ctx))
653                         goto err;                               /* 2 */
654                 j=1<<(window-1);
655                 for (i=1; i<j; i++)
656                         {
657                         BN_init(&(val[i]));
658                         if (!BN_mod_mul(&(val[i]),&(val[i-1]),d,m,ctx))
659                                 goto err;
660                         }
661                 ts=i;
662                 }
663
664         start=1;        /* This is used to avoid multiplication etc
665                          * when there is only the value '1' in the
666                          * buffer. */
667         wvalue=0;       /* The 'value' of the window */
668         wstart=bits-1;  /* The top bit of the window */
669         wend=0;         /* The bottom bit of the window */
670
671         if (!BN_one(r)) goto err;
672
673         for (;;)
674                 {
675                 if (BN_is_bit_set(p,wstart) == 0)
676                         {
677                         if (!start)
678                                 if (!BN_mod_mul(r,r,r,m,ctx))
679                                 goto err;
680                         if (wstart == 0) break;
681                         wstart--;
682                         continue;
683                         }
684                 /* We now have wstart on a 'set' bit, we now need to work out
685                  * how bit a window to do.  To do this we need to scan
686                  * forward until the last set bit before the end of the
687                  * window */
688                 j=wstart;
689                 wvalue=1;
690                 wend=0;
691                 for (i=1; i<window; i++)
692                         {
693                         if (wstart-i < 0) break;
694                         if (BN_is_bit_set(p,wstart-i))
695                                 {
696                                 wvalue<<=(i-wend);
697                                 wvalue|=1;
698                                 wend=i;
699                                 }
700                         }
701
702                 /* wend is the size of the current window */
703                 j=wend+1;
704                 /* add the 'bytes above' */
705                 if (!start)
706                         for (i=0; i<j; i++)
707                                 {
708                                 if (!BN_mod_mul(r,r,r,m,ctx))
709                                         goto err;
710                                 }
711                 
712                 /* wvalue will be an odd number < 2^window */
713                 if (!BN_mod_mul(r,r,&(val[wvalue>>1]),m,ctx))
714                         goto err;
715
716                 /* move the 'window' down further */
717                 wstart-=wend+1;
718                 wvalue=0;
719                 start=0;
720                 if (wstart < 0) break;
721                 }
722         ret=1;
723 err:
724         BN_CTX_end(ctx);
725         for (i=0; i<ts; i++)
726                 BN_clear_free(&(val[i]));
727         return(ret);
728         }
729