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 #define OPENSSL_FIPSAPI
 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 #endif
 128
 129 /* maximum precomputation table size for *variable* sliding windows */
 130 #define TABLE_SIZE      32
 131
 132 /* this one works - simple but works */
 133 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
 134         {
 135         int i,bits,ret=0;
 136         BIGNUM *v,*rr;
 137
 138         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
 139                 {
 140                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
 141                 BNerr(BN_F_BN_EXP,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 142                 return -1;
 143                 }
 144
 145         BN_CTX_start(ctx);
 146         if ((r == a) || (r == p))
 147                 rr = BN_CTX_get(ctx);
 148         else
 149                 rr = r;
 150         v = BN_CTX_get(ctx);
 151         if (rr == NULL || v == NULL) goto err;
 152
 153         if (BN_copy(v,a) == NULL) goto err;
 154         bits=BN_num_bits(p);
 155
 156         if (BN_is_odd(p))
 157                 { if (BN_copy(rr,a) == NULL) goto err; }
 158         else    { if (!BN_one(rr)) goto err; }
 159
 160         for (i=1; i<bits; i++)
 161                 {
 162                 if (!BN_sqr(v,v,ctx)) goto err;
 163                 if (BN_is_bit_set(p,i))
 164                         {
 165                         if (!BN_mul(rr,rr,v,ctx)) goto err;
 166                         }
 167                 }
 168         ret=1;
 169 err:
 170         if (r != rr) BN_copy(r,rr);
 171         BN_CTX_end(ctx);
 172         bn_check_top(r);
 173         return(ret);
 174         }
 175
 176
 177 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, const BIGNUM *m,
 178                BN_CTX *ctx)
 179         {
 180         int ret;
 181
 182         bn_check_top(a);
 183         bn_check_top(p);
 184         bn_check_top(m);
 185
 186         /* For even modulus  m = 2^k*m_odd,  it might make sense to compute
 187          * a^p mod m_odd  and  a^p mod 2^k  separately (with Montgomery
 188          * exponentiation for the odd part), using appropriate exponent
 189          * reductions, and combine the results using the CRT.
 190          *
 191          * For now, we use Montgomery only if the modulus is odd; otherwise,
 192          * exponentiation using the reciprocal-based quick remaindering
 193          * algorithm is used.
 194          *
 195          * (Timing obtained with expspeed.c [computations  a^p mod m
 196          * where  a, p, m  are of the same length: 256, 512, 1024, 2048,
 197          * 4096, 8192 bits], compared to the running time of the
 198          * standard algorithm:
 199          *
 200          *   BN_mod_exp_mont   33 .. 40 %  [AMD K6-2, Linux, debug configuration]
 201          *                     55 .. 77 %  [UltraSparc processor, but
 202          *                                  debug-solaris-sparcv8-gcc conf.]
 203          *
 204          *   BN_mod_exp_recp   50 .. 70 %  [AMD K6-2, Linux, debug configuration]
 205          *                     62 .. 118 % [UltraSparc, debug-solaris-sparcv8-gcc]
 206          *
 207          * On the Sparc, BN_mod_exp_recp was faster than BN_mod_exp_mont
 208          * at 2048 and more bits, but at 512 and 1024 bits, it was
 209          * slower even than the standard algorithm!
 210          *
 211          * "Real" timings [linux-elf, solaris-sparcv9-gcc configurations]
 212          * should be obtained when the new Montgomery reduction code
 213          * has been integrated into OpenSSL.)
 214          */
 215
 216 #define MONT_MUL_MOD
 217 #define MONT_EXP_WORD
 218 #define RECP_MUL_MOD
 219
 220 #ifdef MONT_MUL_MOD
 221         /* I have finally been able to take out this pre-condition of
 222          * the top bit being set.  It was caused by an error in BN_div
 223          * with negatives.  There was also another problem when for a^b%m
 224          * a >= m.  eay 07-May-97 */
 225 /*      if ((m->d[m->top-1]&BN_TBIT) && BN_is_odd(m)) */
 226
 227         if (BN_is_odd(m))
 228                 {
 229 #  ifdef MONT_EXP_WORD
 230                 if (a->top == 1 && !a->neg && (BN_get_flags(p, BN_FLG_CONSTTIME) == 0))
 231                         {
 232                         BN_ULONG A = a->d[0];
 233                         ret=BN_mod_exp_mont_word(r,A,p,m,ctx,NULL);
 234                         }
 235                 else
 236 #  endif
 237                         ret=BN_mod_exp_mont(r,a,p,m,ctx,NULL);
 238                 }
 239         else
 240 #endif
 241 #ifdef RECP_MUL_MOD
 242                 { ret=BN_mod_exp_recp(r,a,p,m,ctx); }
 243 #else
 244                 { ret=BN_mod_exp_simple(r,a,p,m,ctx); }
 245 #endif
 246
 247         bn_check_top(r);
 248         return(ret);
 249         }
 250
 251
 252 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 253                     const BIGNUM *m, BN_CTX *ctx)
 254         {
 255         int i,j,bits,ret=0,wstart,wend,window,wvalue;
 256         int start=1;
 257         BIGNUM *aa;
 258         /* Table of variables obtained from 'ctx' */
 259         BIGNUM *val[TABLE_SIZE];
 260         BN_RECP_CTX recp;
 261
 262         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
 263                 {
 264                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
 265                 BNerr(BN_F_BN_MOD_EXP_RECP,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 266                 return -1;
 267                 }
 268
 269         bits=BN_num_bits(p);
 270
 271         if (bits == 0)
 272                 {
 273                 ret = BN_one(r);
 274                 return ret;
 275                 }
 276
 277         BN_CTX_start(ctx);
 278         aa = BN_CTX_get(ctx);
 279         val[0] = BN_CTX_get(ctx);
 280         if(!aa || !val[0]) goto err;
 281
 282         BN_RECP_CTX_init(&recp);
 283         if (m->neg)
 284                 {
 285                 /* ignore sign of 'm' */
 286                 if (!BN_copy(aa, m)) goto err;
 287                 aa->neg = 0;
 288                 if (BN_RECP_CTX_set(&recp,aa,ctx) <= 0) goto err;
 289                 }
 290         else
 291                 {
 292                 if (BN_RECP_CTX_set(&recp,m,ctx) <= 0) goto err;
 293                 }
 294
 295         if (!BN_nnmod(val[0],a,m,ctx)) goto err;                /* 1 */
 296         if (BN_is_zero(val[0]))
 297                 {
 298                 BN_zero(r);
 299                 ret = 1;
 300                 goto err;
 301                 }
 302
 303         window = BN_window_bits_for_exponent_size(bits);
 304         if (window > 1)
 305                 {
 306                 if (!BN_mod_mul_reciprocal(aa,val[0],val[0],&recp,ctx))
 307                         goto err;                               /* 2 */
 308                 j=1<<(window-1);
 309                 for (i=1; i<j; i++)
 310                         {
 311                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
 312                                         !BN_mod_mul_reciprocal(val[i],val[i-1],
 313                                                 aa,&recp,ctx))
 314                                 goto err;
 315                         }
 316                 }
 317
 318         start=1;        /* This is used to avoid multiplication etc
 319                          * when there is only the value '1' in the
 320                          * buffer. */
 321         wvalue=0;       /* The 'value' of the window */
 322         wstart=bits-1;  /* The top bit of the window */
 323         wend=0;         /* The bottom bit of the window */
 324
 325         if (!BN_one(r)) goto err;
 326
 327         for (;;)
 328                 {
 329                 if (BN_is_bit_set(p,wstart) == 0)
 330                         {
 331                         if (!start)
 332                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
 333                                 goto err;
 334                         if (wstart == 0) break;
 335                         wstart--;
 336                         continue;
 337                         }
 338                 /* We now have wstart on a 'set' bit, we now need to work out
 339                  * how bit a window to do.  To do this we need to scan
 340                  * forward until the last set bit before the end of the
 341                  * window */
 342                 j=wstart;
 343                 wvalue=1;
 344                 wend=0;
 345                 for (i=1; i<window; i++)
 346                         {
 347                         if (wstart-i < 0) break;
 348                         if (BN_is_bit_set(p,wstart-i))
 349                                 {
 350                                 wvalue<<=(i-wend);
 351                                 wvalue|=1;
 352                                 wend=i;
 353                                 }
 354                         }
 355
 356                 /* wend is the size of the current window */
 357                 j=wend+1;
 358                 /* add the 'bytes above' */
 359                 if (!start)
 360                         for (i=0; i<j; i++)
 361                                 {
 362                                 if (!BN_mod_mul_reciprocal(r,r,r,&recp,ctx))
 363                                         goto err;
 364                                 }
 365
 366                 /* wvalue will be an odd number < 2^window */
 367                 if (!BN_mod_mul_reciprocal(r,r,val[wvalue>>1],&recp,ctx))
 368                         goto err;
 369
 370                 /* move the 'window' down further */
 371                 wstart-=wend+1;
 372                 wvalue=0;
 373                 start=0;
 374                 if (wstart < 0) break;
 375                 }
 376         ret=1;
 377 err:
 378         BN_CTX_end(ctx);
 379         BN_RECP_CTX_free(&recp);
 380         bn_check_top(r);
 381         return(ret);
 382         }
 383
 384
 385 int BN_mod_exp_mont(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
 386                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
 387         {
 388         int i,j,bits,ret=0,wstart,wend,window,wvalue;
 389         int start=1;
 390         BIGNUM *d,*r;
 391         const BIGNUM *aa;
 392         /* Table of variables obtained from 'ctx' */
 393         BIGNUM *val[TABLE_SIZE];
 394         BN_MONT_CTX *mont=NULL;
 395
 396         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
 397                 {
 398                 return BN_mod_exp_mont_consttime(rr, a, p, m, ctx, in_mont);
 399                 }
 400
 401         bn_check_top(a);
 402         bn_check_top(p);
 403         bn_check_top(m);
 404
 405         if (!BN_is_odd(m))
 406                 {
 407                 BNerr(BN_F_BN_MOD_EXP_MONT,BN_R_CALLED_WITH_EVEN_MODULUS);
 408                 return(0);
 409                 }
 410         bits=BN_num_bits(p);
 411         if (bits == 0)
 412                 {
 413                 ret = BN_one(rr);
 414                 return ret;
 415                 }
 416
 417         BN_CTX_start(ctx);
 418         d = BN_CTX_get(ctx);
 419         r = BN_CTX_get(ctx);
 420         val[0] = BN_CTX_get(ctx);
 421         if (!d || !r || !val[0]) goto err;
 422
 423         /* If this is not done, things will break in the montgomery
 424          * part */
 425
 426         if (in_mont != NULL)
 427                 mont=in_mont;
 428         else
 429                 {
 430                 if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
 431                 if (!BN_MONT_CTX_set(mont,m,ctx)) goto err;
 432                 }
 433
 434         if (a->neg || BN_ucmp(a,m) >= 0)
 435                 {
 436                 if (!BN_nnmod(val[0],a,m,ctx))
 437                         goto err;
 438                 aa= val[0];
 439                 }
 440         else
 441                 aa=a;
 442         if (BN_is_zero(aa))
 443                 {
 444                 BN_zero(rr);
 445                 ret = 1;
 446                 goto err;
 447                 }
 448         if (!BN_to_montgomery(val[0],aa,mont,ctx)) goto err; /* 1 */
 449
 450         window = BN_window_bits_for_exponent_size(bits);
 451         if (window > 1)
 452                 {
 453                 if (!BN_mod_mul_montgomery(d,val[0],val[0],mont,ctx)) goto err; /* 2 */
 454                 j=1<<(window-1);
 455                 for (i=1; i<j; i++)
 456                         {
 457                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
 458                                         !BN_mod_mul_montgomery(val[i],val[i-1],
 459                                                 d,mont,ctx))
 460                                 goto err;
 461                         }
 462                 }
 463
 464         start=1;        /* This is used to avoid multiplication etc
 465                          * when there is only the value '1' in the
 466                          * buffer. */
 467         wvalue=0;       /* The 'value' of the window */
 468         wstart=bits-1;  /* The top bit of the window */
 469         wend=0;         /* The bottom bit of the window */
 470
 471         if (!BN_to_montgomery(r,BN_value_one(),mont,ctx)) goto err;
 472         for (;;)
 473                 {
 474                 if (BN_is_bit_set(p,wstart) == 0)
 475                         {
 476                         if (!start)
 477                                 {
 478                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
 479                                 goto err;
 480                                 }
 481                         if (wstart == 0) break;
 482                         wstart--;
 483                         continue;
 484                         }
 485                 /* We now have wstart on a 'set' bit, we now need to work out
 486                  * how bit a window to do.  To do this we need to scan
 487                  * forward until the last set bit before the end of the
 488                  * window */
 489                 j=wstart;
 490                 wvalue=1;
 491                 wend=0;
 492                 for (i=1; i<window; i++)
 493                         {
 494                         if (wstart-i < 0) break;
 495                         if (BN_is_bit_set(p,wstart-i))
 496                                 {
 497                                 wvalue<<=(i-wend);
 498                                 wvalue|=1;
 499                                 wend=i;
 500                                 }
 501                         }
 502
 503                 /* wend is the size of the current window */
 504                 j=wend+1;
 505                 /* add the 'bytes above' */
 506                 if (!start)
 507                         for (i=0; i<j; i++)
 508                                 {
 509                                 if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))
 510                                         goto err;
 511                                 }
 512
 513                 /* wvalue will be an odd number < 2^window */
 514                 if (!BN_mod_mul_montgomery(r,r,val[wvalue>>1],mont,ctx))
 515                         goto err;
 516
 517                 /* move the 'window' down further */
 518                 wstart-=wend+1;
 519                 wvalue=0;
 520                 start=0;
 521                 if (wstart < 0) break;
 522                 }
 523         if (!BN_from_montgomery(rr,r,mont,ctx)) goto err;
 524         ret=1;
 525 err:
 526         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
 527         BN_CTX_end(ctx);
 528         bn_check_top(rr);
 529         return(ret);
 530         }
 531
 532
 533 /* BN_mod_exp_mont_consttime() stores the precomputed powers in a specific layout
 534  * so that accessing any of these table values shows the same access pattern as far
 535  * as cache lines are concerned.  The following functions are used to transfer a BIGNUM
 536  * from/to that table. */
 537
 538 static int MOD_EXP_CTIME_COPY_TO_PREBUF(BIGNUM *b, int top, unsigned char *buf, int idx, int width)
 539         {
 540         size_t i, j;
 541
 542         if (bn_wexpand(b, top) == NULL)
 543                 return 0;
 544         while (b->top < top)
 545                 {
 546                 b->d[b->top++] = 0;
 547                 }
 548
 549         for (i = 0, j=idx; i < top * sizeof b->d[0]; i++, j+=width)
 550                 {
 551                 buf[j] = ((unsigned char*)b->d)[i];
 552                 }
 553
 554         bn_correct_top(b);
 555         return 1;
 556         }
 557
 558 static int MOD_EXP_CTIME_COPY_FROM_PREBUF(BIGNUM *b, int top, unsigned char *buf, int idx, int width)
 559         {
 560         size_t i, j;
 561
 562         if (bn_wexpand(b, top) == NULL)
 563                 return 0;
 564
 565         for (i=0, j=idx; i < top * sizeof b->d[0]; i++, j+=width)
 566                 {
 567                 ((unsigned char*)b->d)[i] = buf[j];
 568                 }
 569
 570         b->top = top;
 571         bn_correct_top(b);
 572         return 1;
 573         }
 574
 575 /* Given a pointer value, compute the next address that is a cache line multiple. */
 576 #define MOD_EXP_CTIME_ALIGN(x_) \
 577         ((unsigned char*)(x_) + (MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH - (((size_t)(x_)) & (MOD_EXP_CTIME_MIN_CACHE_LINE_MASK))))
 578
 579 /* This variant of BN_mod_exp_mont() uses fixed windows and the special
 580  * precomputation memory layout to limit data-dependency to a minimum
 581  * to protect secret exponents (cf. the hyper-threading timing attacks
 582  * pointed out by Colin Percival,
 583  * http://www.daemonology.net/hyperthreading-considered-harmful/)
 584  */
 585 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
 586                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
 587         {
 588         int i,bits,ret=0,window,wvalue;
 589         int top;
 590         BIGNUM *r;
 591         BN_MONT_CTX *mont=NULL;
 592
 593         int numPowers;
 594         unsigned char *powerbufFree=NULL;
 595         int powerbufLen = 0;
 596         unsigned char *powerbuf=NULL;
 597         BIGNUM computeTemp, *am=NULL;
 598
 599         bn_check_top(a);
 600         bn_check_top(p);
 601         bn_check_top(m);
 602
 603         top = m->top;
 604
 605         if (!(m->d[0] & 1))
 606                 {
 607                 BNerr(BN_F_BN_MOD_EXP_MONT_CONSTTIME,BN_R_CALLED_WITH_EVEN_MODULUS);
 608                 return(0);
 609                 }
 610         bits=BN_num_bits(p);
 611         if (bits == 0)
 612                 {
 613                 ret = BN_one(rr);
 614                 return ret;
 615                 }
 616
 617         /* Initialize BIGNUM context and allocate intermediate result */
 618         BN_CTX_start(ctx);
 619         r = BN_CTX_get(ctx);
 620         if (r == NULL) goto err;
 621
 622         /* Allocate a montgomery context if it was not supplied by the caller.
 623          * If this is not done, things will break in the montgomery part.
 624          */
 625         if (in_mont != NULL)
 626                 mont=in_mont;
 627         else
 628                 {
 629                 if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
 630                 if (!BN_MONT_CTX_set(mont,m,ctx)) goto err;
 631                 }
 632
 633         /* Get the window size to use with size of p. */
 634         window = BN_window_bits_for_ctime_exponent_size(bits);
 635 #if defined(OPENSSL_BN_ASM_MONT5)
 636         if (window==6 && bits<=1024) window=5;  /* ~5% improvement of 2048-bit RSA sign */
 637 #endif
 638         /* Adjust the number of bits up to a multiple of the window size.
 639          * If the exponent length is not a multiple of the window size, then
 640          * this pads the most significant bits with zeros to normalize the
 641          * scanning loop to there's no special cases.
 642          *
 643          * * NOTE: Making the window size a power of two less than the native
 644          * * word size ensures that the padded bits won't go past the last
 645          * * word in the internal BIGNUM structure. Going past the end will
 646          * * still produce the correct result, but causes a different branch
 647          * * to be taken in the BN_is_bit_set function.
 648          */
 649         bits = ((bits+window-1)/window)*window;
 650
 651         /* Allocate a buffer large enough to hold all of the pre-computed
 652          * powers of a, plus computeTemp.
 653          */
 654         numPowers = 1 << window;
 655         powerbufLen = sizeof(m->d[0])*(top*numPowers +
 656                                 (top>numPowers?top:numPowers));
 657         if (powerbufLen < 3072)
 658                 powerbufFree = alloca(powerbufLen+MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH);
 659         else if ((powerbufFree=(unsigned char*)OPENSSL_malloc(powerbufLen+MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH)) == NULL)
 660                 goto err;
 661
 662         powerbuf = MOD_EXP_CTIME_ALIGN(powerbufFree);
 663         memset(powerbuf, 0, powerbufLen);
 664
 665         if (powerbufLen < 3072)
 666                 powerbufFree = NULL;
 667
 668         computeTemp.d = (BN_ULONG *)(powerbuf + sizeof(m->d[0])*top*numPowers);
 669         computeTemp.top = computeTemp.dmax = top;
 670         computeTemp.neg = 0;
 671         computeTemp.flags = BN_FLG_STATIC_DATA;
 672
 673         /* Initialize the intermediate result. Do this early to save double conversion,
 674          * once each for a^0 and intermediate result.
 675          */
 676         if (!BN_to_montgomery(r,BN_value_one(),mont,ctx)) goto err;
 677
 678         /* Initialize computeTemp as a^1 with montgomery precalcs */
 679         am = BN_CTX_get(ctx);
 680         if (am==NULL) goto err;
 681
 682         if (a->neg || BN_ucmp(a,m) >= 0)
 683                 {
 684                 if (!BN_mod(am,a,m,ctx))                goto err;
 685                 if (!BN_to_montgomery(am,am,mont,ctx))  goto err;
 686                 }
 687         else    if (!BN_to_montgomery(am,a,mont,ctx))   goto err;
 688
 689         if (!BN_copy(&computeTemp, am)) goto err;
 690
 691         if (bn_wexpand(am,top)==NULL || bn_wexpand(r,top)==NULL)
 692                 goto err;
 693
 694 #if defined(OPENSSL_BN_ASM_MONT5)
 695     /* This optimization uses ideas from http://eprint.iacr.org/2011/239,
 696      * specifically optimization of cache-timing attack countermeasures
 697      * and pre-computation optimization. */
 698
 699     /* Dedicated window==4 case improves 512-bit RSA sign by ~15%, but as
 700      * 512-bit RSA is hardly relevant, we omit it to spare size... */
 701     if (window==5)
 702         {
 703         void bn_mul_mont_gather5(BN_ULONG *rp,const BN_ULONG *ap,
 704                         const void *table,const BN_ULONG *np,
 705                         const BN_ULONG *n0,int num,int power);
 706         void bn_scatter5(const BN_ULONG *inp,size_t num,
 707                         void *table,size_t power);
 708
 709         BN_ULONG *acc, *np=mont->N.d, *n0=mont->n0;
 710
 711         bn_scatter5(r->d,r->top,powerbuf,0);
 712         bn_scatter5(am->d,am->top,powerbuf,1);
 713
 714         acc = computeTemp.d;
 715 #if 0
 716         for (i=2; i<32; i++)
 717                 {
 718                 bn_mul_mont_gather5(acc,am->d,powerbuf,np,n0,top,i-1);
 719                 bn_scatter5(acc,top,powerbuf,i);
 720                 }
 721 #else
 722         /* same as above, but uses squaring for 1/2 of operations */
 723         for (i=2; i<32; i*=2)
 724                 {
 725                 bn_mul_mont(acc,acc,acc,np,n0,top);
 726                 bn_scatter5(acc,top,powerbuf,i);
 727                 }
 728         for (i=3; i<8; i+=2)
 729                 {
 730                 int j;
 731                 bn_mul_mont_gather5(acc,am->d,powerbuf,np,n0,top,i-1);
 732                 bn_scatter5(acc,top,powerbuf,i);
 733                 for (j=2*i; j<32; j*=2)
 734                         {
 735                         bn_mul_mont(acc,acc,acc,np,n0,top);
 736                         bn_scatter5(acc,top,powerbuf,j);
 737                         }
 738                 }
 739         for (; i<16; i+=2)
 740                 {
 741                 bn_mul_mont_gather5(acc,am->d,powerbuf,np,n0,top,i-1);
 742                 bn_scatter5(acc,top,powerbuf,i);
 743                 bn_mul_mont(acc,acc,acc,np,n0,top);
 744                 bn_scatter5(acc,top,powerbuf,2*i);
 745                 }
 746         for (; i<32; i+=2)
 747                 {
 748                 bn_mul_mont_gather5(acc,am->d,powerbuf,np,n0,top,i-1);
 749                 bn_scatter5(acc,top,powerbuf,i);
 750                 }
 751 #endif
 752         acc = r->d;
 753
 754         /* Scan the exponent one window at a time starting from the most
 755          * significant bits.
 756          */
 757         bits--;
 758         while (bits >= 0)
 759                 {
 760                 for (wvalue=0, i=0; i<5; i++,bits--)
 761                         wvalue = (wvalue<<1)+BN_is_bit_set(p,bits);
 762
 763                 bn_mul_mont(acc,acc,acc,np,n0,top);
 764                 bn_mul_mont(acc,acc,acc,np,n0,top);
 765                 bn_mul_mont(acc,acc,acc,np,n0,top);
 766                 bn_mul_mont(acc,acc,acc,np,n0,top);
 767                 bn_mul_mont(acc,acc,acc,np,n0,top);
 768                 bn_mul_mont_gather5(acc,acc,powerbuf,np,n0,top,wvalue);
 769                 }
 770
 771         r->top=top;
 772         bn_correct_top(r);
 773         }
 774     else
 775 #endif
 776         {
 777         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(r, top, powerbuf, 0, numPowers)) goto err;
 778         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(am, top, powerbuf, 1, numPowers)) goto err;
 779
 780         /* If the window size is greater than 1, then calculate
 781          * val[i=2..2^winsize-1]. Powers are computed as a*a^(i-1)
 782          * (even powers could instead be computed as (a^(i/2))^2
 783          * to use the slight performance advantage of sqr over mul).
 784          */
 785         if (window > 1)
 786                 {
 787                 for (i=2; i<numPowers; i++)
 788                         {
 789                         /* Calculate a^i = a^(i-1) * a */
 790                         if (!BN_mod_mul_montgomery(&computeTemp,am,&computeTemp,mont,ctx))
 791                                 goto err;
 792                         if (!MOD_EXP_CTIME_COPY_TO_PREBUF(&computeTemp, top, powerbuf, i, numPowers)) goto err;
 793                         }
 794                 }
 795
 796         /* Scan the exponent one window at a time starting from the most
 797          * significant bits.
 798          */
 799         bits--;
 800         while (bits >= 0)
 801                 {
 802                 wvalue=0; /* The 'value' of the window */
 803
 804                 /* Scan the window, squaring the result as we go */
 805                 for (i=0; i<window; i++,bits--)
 806                         {
 807                         if (!BN_mod_mul_montgomery(r,r,r,mont,ctx))     goto err;
 808                         wvalue = (wvalue<<1)+BN_is_bit_set(p,bits);
 809                         }
 810
 811                 /* Fetch the appropriate pre-computed value from the pre-buf */
 812                 if (!MOD_EXP_CTIME_COPY_FROM_PREBUF(&computeTemp, top, powerbuf, wvalue, numPowers)) goto err;
 813
 814                 /* Multiply the result into the intermediate result */
 815                 if (!BN_mod_mul_montgomery(r,r,&computeTemp,mont,ctx)) goto err;
 816                 }
 817         }
 818
 819         /* Convert the final result from montgomery to standard format */
 820         if (!BN_from_montgomery(rr,r,mont,ctx)) goto err;
 821         ret=1;
 822 err:
 823         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
 824         if (powerbuf!=NULL)
 825                 {
 826                 OPENSSL_cleanse(powerbuf,powerbufLen);
 827                 if (powerbufFree) OPENSSL_free(powerbufFree);
 828                 }
 829         if (am!=NULL) BN_clear(am);
 830         BN_CTX_end(ctx);
 831         return(ret);
 832         }
 833
 834 int BN_mod_exp_mont_word(BIGNUM *rr, BN_ULONG a, const BIGNUM *p,
 835                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont)
 836         {
 837         BN_MONT_CTX *mont = NULL;
 838         int b, bits, ret=0;
 839         int r_is_one;
 840         BN_ULONG w, next_w;
 841         BIGNUM *d, *r, *t;
 842         BIGNUM *swap_tmp;
 843 #define BN_MOD_MUL_WORD(r, w, m) \
 844                 (BN_mul_word(r, (w)) && \
 845                 (/* BN_ucmp(r, (m)) < 0 ? 1 :*/  \
 846                         (BN_mod(t, r, m, ctx) && (swap_tmp = r, r = t, t = swap_tmp, 1))))
 847                 /* BN_MOD_MUL_WORD is only used with 'w' large,
 848                  * so the BN_ucmp test is probably more overhead
 849                  * than always using BN_mod (which uses BN_copy if
 850                  * a similar test returns true). */
 851                 /* We can use BN_mod and do not need BN_nnmod because our
 852                  * accumulator is never negative (the result of BN_mod does
 853                  * not depend on the sign of the modulus).
 854                  */
 855 #define BN_TO_MONTGOMERY_WORD(r, w, mont) \
 856                 (BN_set_word(r, (w)) && BN_to_montgomery(r, r, (mont), ctx))
 857
 858         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
 859                 {
 860                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
 861                 BNerr(BN_F_BN_MOD_EXP_MONT_WORD,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 862                 return -1;
 863                 }
 864
 865         bn_check_top(p);
 866         bn_check_top(m);
 867
 868         if (!BN_is_odd(m))
 869                 {
 870                 BNerr(BN_F_BN_MOD_EXP_MONT_WORD,BN_R_CALLED_WITH_EVEN_MODULUS);
 871                 return(0);
 872                 }
 873         if (m->top == 1)
 874                 a %= m->d[0]; /* make sure that 'a' is reduced */
 875
 876         bits = BN_num_bits(p);
 877         if (bits == 0)
 878                 {
 879                 ret = BN_one(rr);
 880                 return ret;
 881                 }
 882         if (a == 0)
 883                 {
 884                 BN_zero(rr);
 885                 ret = 1;
 886                 return ret;
 887                 }
 888
 889         BN_CTX_start(ctx);
 890         d = BN_CTX_get(ctx);
 891         r = BN_CTX_get(ctx);
 892         t = BN_CTX_get(ctx);
 893         if (d == NULL || r == NULL || t == NULL) goto err;
 894
 895         if (in_mont != NULL)
 896                 mont=in_mont;
 897         else
 898                 {
 899                 if ((mont = BN_MONT_CTX_new()) == NULL) goto err;
 900                 if (!BN_MONT_CTX_set(mont, m, ctx)) goto err;
 901                 }
 902
 903         r_is_one = 1; /* except for Montgomery factor */
 904
 905         /* bits-1 >= 0 */
 906
 907         /* The result is accumulated in the product r*w. */
 908         w = a; /* bit 'bits-1' of 'p' is always set */
 909         for (b = bits-2; b >= 0; b--)
 910                 {
 911                 /* First, square r*w. */
 912                 next_w = w*w;
 913                 if ((next_w/w) != w) /* overflow */
 914                         {
 915                         if (r_is_one)
 916                                 {
 917                                 if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
 918                                 r_is_one = 0;
 919                                 }
 920                         else
 921                                 {
 922                                 if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
 923                                 }
 924                         next_w = 1;
 925                         }
 926                 w = next_w;
 927                 if (!r_is_one)
 928                         {
 929                         if (!BN_mod_mul_montgomery(r, r, r, mont, ctx)) goto err;
 930                         }
 931
 932                 /* Second, multiply r*w by 'a' if exponent bit is set. */
 933                 if (BN_is_bit_set(p, b))
 934                         {
 935                         next_w = w*a;
 936                         if ((next_w/a) != w) /* overflow */
 937                                 {
 938                                 if (r_is_one)
 939                                         {
 940                                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
 941                                         r_is_one = 0;
 942                                         }
 943                                 else
 944                                         {
 945                                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
 946                                         }
 947                                 next_w = a;
 948                                 }
 949                         w = next_w;
 950                         }
 951                 }
 952
 953         /* Finally, set r:=r*w. */
 954         if (w != 1)
 955                 {
 956                 if (r_is_one)
 957                         {
 958                         if (!BN_TO_MONTGOMERY_WORD(r, w, mont)) goto err;
 959                         r_is_one = 0;
 960                         }
 961                 else
 962                         {
 963                         if (!BN_MOD_MUL_WORD(r, w, m)) goto err;
 964                         }
 965                 }
 966
 967         if (r_is_one) /* can happen only if a == 1*/
 968                 {
 969                 if (!BN_one(rr)) goto err;
 970                 }
 971         else
 972                 {
 973                 if (!BN_from_montgomery(rr, r, mont, ctx)) goto err;
 974                 }
 975         ret = 1;
 976 err:
 977         if ((in_mont == NULL) && (mont != NULL)) BN_MONT_CTX_free(mont);
 978         BN_CTX_end(ctx);
 979         bn_check_top(rr);
 980         return(ret);
 981         }
 982
 983
 984 /* The old fallback, simple version :-) */
 985 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 986                 const BIGNUM *m, BN_CTX *ctx)
 987         {
 988         int i,j,bits,ret=0,wstart,wend,window,wvalue;
 989         int start=1;
 990         BIGNUM *d;
 991         /* Table of variables obtained from 'ctx' */
 992         BIGNUM *val[TABLE_SIZE];
 993
 994         if (BN_get_flags(p, BN_FLG_CONSTTIME) != 0)
 995                 {
 996                 /* BN_FLG_CONSTTIME only supported by BN_mod_exp_mont() */
 997                 BNerr(BN_F_BN_MOD_EXP_SIMPLE,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 998                 return -1;
 999                 }
1000
1001         bits=BN_num_bits(p);
1002
1003         if (bits == 0)
1004                 {
1005                 ret = BN_one(r);
1006                 return ret;
1007                 }
1008
1009         BN_CTX_start(ctx);
1010         d = BN_CTX_get(ctx);
1011         val[0] = BN_CTX_get(ctx);
1012         if(!d || !val[0]) goto err;
1013
1014         if (!BN_nnmod(val[0],a,m,ctx)) goto err;                /* 1 */
1015         if (BN_is_zero(val[0]))
1016                 {
1017                 BN_zero(r);
1018                 ret = 1;
1019                 goto err;
1020                 }
1021
1022         window = BN_window_bits_for_exponent_size(bits);
1023         if (window > 1)
1024                 {
1025                 if (!BN_mod_mul(d,val[0],val[0],m,ctx))
1026                         goto err;                               /* 2 */
1027                 j=1<<(window-1);
1028                 for (i=1; i<j; i++)
1029                         {
1030                         if(((val[i] = BN_CTX_get(ctx)) == NULL) ||
1031                                         !BN_mod_mul(val[i],val[i-1],d,m,ctx))
1032                                 goto err;
1033                         }
1034                 }
1035
1036         start=1;        /* This is used to avoid multiplication etc
1037                          * when there is only the value '1' in the
1038                          * buffer. */
1039         wvalue=0;       /* The 'value' of the window */
1040         wstart=bits-1;  /* The top bit of the window */
1041         wend=0;         /* The bottom bit of the window */
1042
1043         if (!BN_one(r)) goto err;
1044
1045         for (;;)
1046                 {
1047                 if (BN_is_bit_set(p,wstart) == 0)
1048                         {
1049                         if (!start)
1050                                 if (!BN_mod_mul(r,r,r,m,ctx))
1051                                 goto err;
1052                         if (wstart == 0) break;
1053                         wstart--;
1054                         continue;
1055                         }
1056                 /* We now have wstart on a 'set' bit, we now need to work out
1057                  * how bit a window to do.  To do this we need to scan
1058                  * forward until the last set bit before the end of the
1059                  * window */
1060                 j=wstart;
1061                 wvalue=1;
1062                 wend=0;
1063                 for (i=1; i<window; i++)
1064                         {
1065                         if (wstart-i < 0) break;
1066                         if (BN_is_bit_set(p,wstart-i))
1067                                 {
1068                                 wvalue<<=(i-wend);
1069                                 wvalue|=1;
1070                                 wend=i;
1071                                 }
1072                         }
1073
1074                 /* wend is the size of the current window */
1075                 j=wend+1;
1076                 /* add the 'bytes above' */
1077                 if (!start)
1078                         for (i=0; i<j; i++)
1079                                 {
1080                                 if (!BN_mod_mul(r,r,r,m,ctx))
1081                                         goto err;
1082                                 }
1083
1084                 /* wvalue will be an odd number < 2^window */
1085                 if (!BN_mod_mul(r,r,val[wvalue>>1],m,ctx))
1086                         goto err;
1087
1088                 /* move the 'window' down further */
1089                 wstart-=wend+1;
1090                 wvalue=0;
1091                 start=0;
1092                 if (wstart < 0) break;
1093                 }
1094         ret=1;
1095 err:
1096         BN_CTX_end(ctx);
1097         bn_check_top(r);
1098         return(ret);
1099         }
1100