crypto/bn/bn_mont.c

   1 /* crypto/bn/bn_mont.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-2006 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  * Details about Montgomery multiplication algorithms can be found at
 114  * http://security.ece.orst.edu/publications.html, e.g.
 115  * http://security.ece.orst.edu/koc/papers/j37acmon.pdf and
 116  * sections 3.8 and 4.2 in http://security.ece.orst.edu/koc/papers/r01rsasw.pdf
 117  */
 118
 119 #include <stdio.h>
 120 #include "cryptlib.h"
 121 #include "bn_lcl.h"
 122
 123 #define MONT_WORD /* use the faster word-based algorithm */
 124
 125 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 126                           BN_MONT_CTX *mont, BN_CTX *ctx)
 127         {
 128         BIGNUM *tmp;
 129         int ret=0;
 130
 131         BN_CTX_start(ctx);
 132         tmp = BN_CTX_get(ctx);
 133         if (tmp == NULL) goto err;
 134
 135         bn_check_top(tmp);
 136         if (a == b)
 137                 {
 138                 if (!BN_sqr(tmp,a,ctx)) goto err;
 139                 }
 140         else
 141                 {
 142                 if (!BN_mul(tmp,a,b,ctx)) goto err;
 143                 }
 144         /* reduce from aRR to aR */
 145         if (!BN_from_montgomery(r,tmp,mont,ctx)) goto err;
 146         bn_check_top(r);
 147         ret=1;
 148 err:
 149         BN_CTX_end(ctx);
 150         return(ret);
 151         }
 152
 153 int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a, BN_MONT_CTX *mont,
 154              BN_CTX *ctx)
 155         {
 156         int retn=0;
 157
 158 #ifdef MONT_WORD
 159         BIGNUM *n,*r;
 160         BN_ULONG *ap,*np,*rp,n0,v,*nrp;
 161         int al,nl,max,i,x,ri;
 162
 163         BN_CTX_start(ctx);
 164         if ((r = BN_CTX_get(ctx)) == NULL) goto err;
 165
 166         if (!BN_copy(r,a)) goto err;
 167         n= &(mont->N);
 168
 169         ap=a->d;
 170         /* mont->ri is the size of mont->N in bits (rounded up
 171            to the word size) */
 172         al=ri=mont->ri/BN_BITS2;
 173
 174         nl=n->top;
 175         if ((al == 0) || (nl == 0)) { r->top=0; return(1); }
 176
 177         max=(nl+al+1); /* allow for overflow (no?) XXX */
 178         if (bn_wexpand(r,max) == NULL) goto err;
 179
 180         r->neg=a->neg^n->neg;
 181         np=n->d;
 182         rp=r->d;
 183         nrp= &(r->d[nl]);
 184
 185         /* clear the top words of T */
 186 #if 1
 187         for (i=r->top; i<max; i++) /* memset? XXX */
 188                 r->d[i]=0;
 189 #else
 190         memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG));
 191 #endif
 192
 193         r->top=max;
 194         n0=mont->n0;
 195
 196 #ifdef BN_COUNT
 197         fprintf(stderr,"word BN_from_montgomery %d * %d\n",nl,nl);
 198 #endif
 199         for (i=0; i<nl; i++)
 200                 {
 201 #ifdef __TANDEM
 202                 {
 203                    long long t1;
 204                    long long t2;
 205                    long long t3;
 206                    t1 = rp[0] * (n0 & 0177777);
 207                    t2 = 037777600000l;
 208                    t2 = n0 & t2;
 209                    t3 = rp[0] & 0177777;
 210                    t2 = (t3 * t2) & BN_MASK2;
 211                    t1 = t1 + t2;
 212                    v=bn_mul_add_words(rp,np,nl,(BN_ULONG) t1);
 213                 }
 214 #else
 215                 v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
 216 #endif
 217                 nrp++;
 218                 rp++;
 219                 if (((nrp[-1]+=v)&BN_MASK2) >= v)
 220                         continue;
 221                 else
 222                         {
 223                         if (((++nrp[0])&BN_MASK2) != 0) continue;
 224                         if (((++nrp[1])&BN_MASK2) != 0) continue;
 225                         for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
 226                         }
 227                 }
 228         bn_correct_top(r);
 229
 230         /* mont->ri will be a multiple of the word size and below code
 231          * is kind of BN_rshift(ret,r,mont->ri) equivalent */
 232         if (r->top <= ri)
 233                 {
 234                 ret->top=0;
 235                 retn=1;
 236                 goto err;
 237                 }
 238         al=r->top-ri;
 239
 240 # define BRANCH_FREE 1
 241 # if BRANCH_FREE
 242         if (bn_wexpand(ret,ri) == NULL) goto err;
 243         x=0-(((al-ri)>>(sizeof(al)*8-1))&1);
 244         ret->top=x=(ri&~x)|(al&x);      /* min(ri,al) */
 245         ret->neg=r->neg;
 246
 247         rp=ret->d;
 248         ap=&(r->d[ri]);
 249         nrp=ap;
 250
 251         /* This 'if' denotes violation of 2*M<r^(n-1) boundary condition
 252          * formulated by C.D.Walter in "Montgomery exponentiation needs
 253          * no final subtractions." Incurred branch can disclose only
 254          * information about modulus length, which is not really secret. */
 255         if ((mont->N.d[ri-1]>>(BN_BITS2-2))!=0)
 256                 {
 257                 size_t m1,m2;
 258
 259                 v=bn_sub_words(rp,ap,mont->N.d,ri);
 260                 /* this -----------------------^^ works even in al<ri case
 261                  * thanks to zealous zeroing of top of the vector in the
 262                  * beginning. */
 263
 264                 /* if (al==ri && !v) || al>ri) nrp=rp; else nrp=ap; */
 265                 /* in other words if subtraction result is real, then
 266                  * trick unconditional memcpy below to perform in-place
 267                  * "refresh" instead of actual copy. */
 268                 m1=0-(size_t)(((al-ri)>>(sizeof(al)*8-1))&1);   /* al<ri */
 269                 m2=0-(size_t)(((ri-al)>>(sizeof(al)*8-1))&1);   /* al>ri */
 270                 m1|=m2;                 /* (al!=ri) */
 271                 m1|=(0-(size_t)v);      /* (al!=ri || v) */
 272                 m1&=~m2;                /* (al!=ri || v) && !al>ri */
 273                 nrp=(BN_ULONG *)(((size_t)rp&~m1)|((size_t)ap&m1));
 274                 }
 275
 276         /* 'i<ri' is chosen to eliminate dependency on input data, even
 277          * though it results in redundant copy in al<ri case. */
 278         for (i=0,ri-=4; i<ri; i+=4)
 279                 {
 280                 BN_ULONG t1,t2,t3,t4;
 281
 282                 t1=nrp[i+0];
 283                 t2=nrp[i+1];
 284                 t3=nrp[i+2];    ap[i+0]=0;
 285                 t4=nrp[i+3];    ap[i+1]=0;
 286                 rp[i+0]=t1;     ap[i+2]=0;
 287                 rp[i+1]=t2;     ap[i+3]=0;
 288                 rp[i+2]=t3;
 289                 rp[i+3]=t4;
 290                 }
 291         for (ri+=4; i<ri; i++)
 292                 rp[i]=nrp[i], ap[i]=0;
 293 # else
 294         if (bn_wexpand(ret,al) == NULL) goto err;
 295         ret->top=al;
 296         ret->neg=r->neg;
 297
 298         rp=ret->d;
 299         ap=&(r->d[ri]);
 300         al-=4;
 301         for (i=0; i<al; i+=4)
 302                 {
 303                 BN_ULONG t1,t2,t3,t4;
 304
 305                 t1=ap[i+0];
 306                 t2=ap[i+1];
 307                 t3=ap[i+2];
 308                 t4=ap[i+3];
 309                 rp[i+0]=t1;
 310                 rp[i+1]=t2;
 311                 rp[i+2]=t3;
 312                 rp[i+3]=t4;
 313                 }
 314         al+=4;
 315         for (; i<al; i++)
 316                 rp[i]=ap[i];
 317 # endif
 318 #else /* !MONT_WORD */
 319         BIGNUM *t1,*t2;
 320
 321         BN_CTX_start(ctx);
 322         t1 = BN_CTX_get(ctx);
 323         t2 = BN_CTX_get(ctx);
 324         if (t1 == NULL || t2 == NULL) goto err;
 325
 326         if (!BN_copy(t1,a)) goto err;
 327         BN_mask_bits(t1,mont->ri);
 328
 329         if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
 330         BN_mask_bits(t2,mont->ri);
 331
 332         if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
 333         if (!BN_add(t2,a,t1)) goto err;
 334         if (!BN_rshift(ret,t2,mont->ri)) goto err;
 335 #endif /* MONT_WORD */
 336
 337 #if !defined(BRANCH_FREE) || BRANCH_FREE==0
 338         if (BN_ucmp(ret, &(mont->N)) >= 0)
 339                 {
 340                 if (!BN_usub(ret,ret,&(mont->N))) goto err;
 341                 }
 342 #endif
 343         retn=1;
 344         bn_check_top(ret);
 345  err:
 346         BN_CTX_end(ctx);
 347         return(retn);
 348         }
 349
 350 BN_MONT_CTX *BN_MONT_CTX_new(void)
 351         {
 352         BN_MONT_CTX *ret;
 353
 354         if ((ret=(BN_MONT_CTX *)OPENSSL_malloc(sizeof(BN_MONT_CTX))) == NULL)
 355                 return(NULL);
 356
 357         BN_MONT_CTX_init(ret);
 358         ret->flags=BN_FLG_MALLOCED;
 359         return(ret);
 360         }
 361
 362 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
 363         {
 364         ctx->ri=0;
 365         BN_init(&(ctx->RR));
 366         BN_init(&(ctx->N));
 367         BN_init(&(ctx->Ni));
 368         ctx->flags=0;
 369         }
 370
 371 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
 372         {
 373         if(mont == NULL)
 374             return;
 375
 376         BN_free(&(mont->RR));
 377         BN_free(&(mont->N));
 378         BN_free(&(mont->Ni));
 379         if (mont->flags & BN_FLG_MALLOCED)
 380                 OPENSSL_free(mont);
 381         }
 382
 383 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
 384         {
 385         int ret = 0;
 386         BIGNUM *Ri,*R;
 387
 388         BN_CTX_start(ctx);
 389         if((Ri = BN_CTX_get(ctx)) == NULL) goto err;
 390         R= &(mont->RR);                                 /* grab RR as a temp */
 391         if (!BN_copy(&(mont->N),mod)) goto err;         /* Set N */
 392         mont->N.neg = 0;
 393
 394 #ifdef MONT_WORD
 395                 {
 396                 BIGNUM tmod;
 397                 BN_ULONG buf[2];
 398
 399                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
 400                 BN_zero(R);
 401                 if (!(BN_set_bit(R,BN_BITS2))) goto err;        /* R */
 402
 403                 buf[0]=mod->d[0]; /* tmod = N mod word size */
 404                 buf[1]=0;
 405                 tmod.d=buf;
 406                 tmod.top = buf[0] != 0 ? 1 : 0;
 407                 tmod.dmax=2;
 408                 tmod.neg=0;
 409                                                         /* Ri = R^-1 mod N*/
 410                 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
 411                         goto err;
 412                 if (!BN_lshift(Ri,Ri,BN_BITS2)) goto err; /* R*Ri */
 413                 if (!BN_is_zero(Ri))
 414                         {
 415                         if (!BN_sub_word(Ri,1)) goto err;
 416                         }
 417                 else /* if N mod word size == 1 */
 418                         {
 419                         if (!BN_set_word(Ri,BN_MASK2)) goto err;  /* Ri-- (mod word size) */
 420                         }
 421                 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
 422                 /* Ni = (R*Ri-1)/N,
 423                  * keep only least significant word: */
 424                 mont->n0 = (Ri->top > 0) ? Ri->d[0] : 0;
 425                 }
 426 #else /* !MONT_WORD */
 427                 { /* bignum version */
 428                 mont->ri=BN_num_bits(&mont->N);
 429                 BN_zero(R);
 430                 if (!BN_set_bit(R,mont->ri)) goto err;  /* R = 2^ri */
 431                                                         /* Ri = R^-1 mod N*/
 432                 if ((BN_mod_inverse(Ri,R,&mont->N,ctx)) == NULL)
 433                         goto err;
 434                 if (!BN_lshift(Ri,Ri,mont->ri)) goto err; /* R*Ri */
 435                 if (!BN_sub_word(Ri,1)) goto err;
 436                                                         /* Ni = (R*Ri-1) / N */
 437                 if (!BN_div(&(mont->Ni),NULL,Ri,&mont->N,ctx)) goto err;
 438                 }
 439 #endif
 440
 441         /* setup RR for conversions */
 442         BN_zero(&(mont->RR));
 443         if (!BN_set_bit(&(mont->RR),mont->ri*2)) goto err;
 444         if (!BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx)) goto err;
 445
 446         ret = 1;
 447 err:
 448         BN_CTX_end(ctx);
 449         return ret;
 450         }
 451
 452 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
 453         {
 454         if (to == from) return(to);
 455
 456         if (!BN_copy(&(to->RR),&(from->RR))) return NULL;
 457         if (!BN_copy(&(to->N),&(from->N))) return NULL;
 458         if (!BN_copy(&(to->Ni),&(from->Ni))) return NULL;
 459         to->ri=from->ri;
 460         to->n0=from->n0;
 461         return(to);
 462         }
 463
 464 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
 465                                         const BIGNUM *mod, BN_CTX *ctx)
 466         {
 467         int got_write_lock = 0;
 468         BN_MONT_CTX *ret;
 469
 470         CRYPTO_r_lock(lock);
 471         if (!*pmont)
 472                 {
 473                 CRYPTO_r_unlock(lock);
 474                 CRYPTO_w_lock(lock);
 475                 got_write_lock = 1;
 476
 477                 if (!*pmont)
 478                         {
 479                         ret = BN_MONT_CTX_new();
 480                         if (ret && !BN_MONT_CTX_set(ret, mod, ctx))
 481                                 BN_MONT_CTX_free(ret);
 482                         else
 483                                 *pmont = ret;
 484                         }
 485                 }
 486
 487         ret = *pmont;
 488
 489         if (got_write_lock)
 490                 CRYPTO_w_unlock(lock);
 491         else
 492                 CRYPTO_r_unlock(lock);
 493
 494         return ret;
 495         }