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         if (bn_wexpand(ret,max) == NULL) goto err;
 180
 181         r->neg=a->neg^n->neg;
 182         np=n->d;
 183         rp=r->d;
 184         nrp= &(r->d[nl]);
 185
 186         /* clear the top words of T */
 187 #if 1
 188         for (i=r->top; i<max; i++) /* memset? XXX */
 189                 r->d[i]=0;
 190 #else
 191         memset(&(r->d[r->top]),0,(max-r->top)*sizeof(BN_ULONG));
 192 #endif
 193
 194         r->top=max;
 195         n0=mont->n0;
 196
 197 #ifdef BN_COUNT
 198         fprintf(stderr,"word BN_from_montgomery %d * %d\n",nl,nl);
 199 #endif
 200         for (i=0; i<nl; i++)
 201                 {
 202 #ifdef __TANDEM
 203                 {
 204                    long long t1;
 205                    long long t2;
 206                    long long t3;
 207                    t1 = rp[0] * (n0 & 0177777);
 208                    t2 = 037777600000l;
 209                    t2 = n0 & t2;
 210                    t3 = rp[0] & 0177777;
 211                    t2 = (t3 * t2) & BN_MASK2;
 212                    t1 = t1 + t2;
 213                    v=bn_mul_add_words(rp,np,nl,(BN_ULONG) t1);
 214                 }
 215 #else
 216                 v=bn_mul_add_words(rp,np,nl,(rp[0]*n0)&BN_MASK2);
 217 #endif
 218                 nrp++;
 219                 rp++;
 220                 if (((nrp[-1]+=v)&BN_MASK2) >= v)
 221                         continue;
 222                 else
 223                         {
 224                         if (((++nrp[0])&BN_MASK2) != 0) continue;
 225                         if (((++nrp[1])&BN_MASK2) != 0) continue;
 226                         for (x=2; (((++nrp[x])&BN_MASK2) == 0); x++) ;
 227                         }
 228                 }
 229         bn_correct_top(r);
 230
 231         /* mont->ri will be a multiple of the word size */
 232 #if 0
 233         BN_rshift(ret,r,mont->ri);
 234 #else
 235         ret->neg = r->neg;
 236         x=ri;
 237         rp=ret->d;
 238         ap= &(r->d[x]);
 239         if (r->top < x)
 240                 al=0;
 241         else
 242                 al=r->top-x;
 243         ret->top=al;
 244         al-=4;
 245         for (i=0; i<al; i+=4)
 246                 {
 247                 BN_ULONG t1,t2,t3,t4;
 248
 249                 t1=ap[i+0];
 250                 t2=ap[i+1];
 251                 t3=ap[i+2];
 252                 t4=ap[i+3];
 253                 rp[i+0]=t1;
 254                 rp[i+1]=t2;
 255                 rp[i+2]=t3;
 256                 rp[i+3]=t4;
 257                 }
 258         al+=4;
 259         for (; i<al; i++)
 260                 rp[i]=ap[i];
 261 #endif
 262 #else /* !MONT_WORD */
 263         BIGNUM *t1,*t2;
 264
 265         BN_CTX_start(ctx);
 266         t1 = BN_CTX_get(ctx);
 267         t2 = BN_CTX_get(ctx);
 268         if (t1 == NULL || t2 == NULL) goto err;
 269
 270         if (!BN_copy(t1,a)) goto err;
 271         BN_mask_bits(t1,mont->ri);
 272
 273         if (!BN_mul(t2,t1,&mont->Ni,ctx)) goto err;
 274         BN_mask_bits(t2,mont->ri);
 275
 276         if (!BN_mul(t1,t2,&mont->N,ctx)) goto err;
 277         if (!BN_add(t2,a,t1)) goto err;
 278         if (!BN_rshift(ret,t2,mont->ri)) goto err;
 279 #endif /* MONT_WORD */
 280
 281         if (BN_ucmp(ret, &(mont->N)) >= 0)
 282                 {
 283                 if (!BN_usub(ret,ret,&(mont->N))) goto err;
 284                 }
 285         retn=1;
 286         bn_check_top(ret);
 287  err:
 288         BN_CTX_end(ctx);
 289         return(retn);
 290         }
 291
 292 BN_MONT_CTX *BN_MONT_CTX_new(void)
 293         {
 294         BN_MONT_CTX *ret;
 295
 296         if ((ret=(BN_MONT_CTX *)OPENSSL_malloc(sizeof(BN_MONT_CTX))) == NULL)
 297                 return(NULL);
 298
 299         BN_MONT_CTX_init(ret);
 300         ret->flags=BN_FLG_MALLOCED;
 301         return(ret);
 302         }
 303
 304 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
 305         {
 306         ctx->ri=0;
 307         BN_init(&(ctx->RR));
 308         BN_init(&(ctx->N));
 309         BN_init(&(ctx->Ni));
 310         ctx->flags=0;
 311         }
 312
 313 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
 314         {
 315         if(mont == NULL)
 316             return;
 317
 318         BN_free(&(mont->RR));
 319         BN_free(&(mont->N));
 320         BN_free(&(mont->Ni));
 321         if (mont->flags & BN_FLG_MALLOCED)
 322                 OPENSSL_free(mont);
 323         }
 324
 325 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
 326         {
 327         int ret = 0;
 328         BIGNUM *Ri,*R;
 329
 330         BN_CTX_start(ctx);
 331         if((Ri = BN_CTX_get(ctx)) == NULL) goto err;
 332         R= &(mont->RR);                                 /* grab RR as a temp */
 333         if (!BN_copy(&(mont->N),mod)) goto err;         /* Set N */
 334         mont->N.neg = 0;
 335
 336 #ifdef MONT_WORD
 337                 {
 338                 BIGNUM tmod;
 339                 BN_ULONG buf[2];
 340
 341                 mont->ri=(BN_num_bits(mod)+(BN_BITS2-1))/BN_BITS2*BN_BITS2;
 342                 BN_zero(R);
 343                 if (!(BN_set_bit(R,BN_BITS2))) goto err;        /* R */
 344
 345                 buf[0]=mod->d[0]; /* tmod = N mod word size */
 346                 buf[1]=0;
 347                 tmod.d=buf;
 348                 tmod.top = buf[0] != 0 ? 1 : 0;
 349                 tmod.dmax=2;
 350                 tmod.neg=0;
 351                                                         /* Ri = R^-1 mod N*/
 352                 if ((BN_mod_inverse(Ri,R,&tmod,ctx)) == NULL)
 353                         goto err;
 354                 if (!BN_lshift(Ri,Ri,BN_BITS2)) goto err; /* R*Ri */
 355                 if (!BN_is_zero(Ri))
 356                         {
 357                         if (!BN_sub_word(Ri,1)) goto err;
 358                         }
 359                 else /* if N mod word size == 1 */
 360                         {
 361                         if (!BN_set_word(Ri,BN_MASK2)) goto err;  /* Ri-- (mod word size) */
 362                         }
 363                 if (!BN_div(Ri,NULL,Ri,&tmod,ctx)) goto err;
 364                 /* Ni = (R*Ri-1)/N,
 365                  * keep only least significant word: */
 366                 mont->n0 = (Ri->top > 0) ? Ri->d[0] : 0;
 367                 }
 368 #else /* !MONT_WORD */
 369                 { /* bignum version */
 370                 mont->ri=BN_num_bits(&mont->N);
 371                 BN_zero(R);
 372                 if (!BN_set_bit(R,mont->ri)) goto err;  /* R = 2^ri */
 373                                                         /* Ri = R^-1 mod N*/
 374                 if ((BN_mod_inverse(Ri,R,&mont->N,ctx)) == NULL)
 375                         goto err;
 376                 if (!BN_lshift(Ri,Ri,mont->ri)) goto err; /* R*Ri */
 377                 if (!BN_sub_word(Ri,1)) goto err;
 378                                                         /* Ni = (R*Ri-1) / N */
 379                 if (!BN_div(&(mont->Ni),NULL,Ri,&mont->N,ctx)) goto err;
 380                 }
 381 #endif
 382
 383         /* setup RR for conversions */
 384         BN_zero(&(mont->RR));
 385         if (!BN_set_bit(&(mont->RR),mont->ri*2)) goto err;
 386         if (!BN_mod(&(mont->RR),&(mont->RR),&(mont->N),ctx)) goto err;
 387
 388         ret = 1;
 389 err:
 390         BN_CTX_end(ctx);
 391         return ret;
 392         }
 393
 394 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
 395         {
 396         if (to == from) return(to);
 397
 398         if (!BN_copy(&(to->RR),&(from->RR))) return NULL;
 399         if (!BN_copy(&(to->N),&(from->N))) return NULL;
 400         if (!BN_copy(&(to->Ni),&(from->Ni))) return NULL;
 401         to->ri=from->ri;
 402         to->n0=from->n0;
 403         return(to);
 404         }
 405
 406 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
 407                                         const BIGNUM *mod, BN_CTX *ctx)
 408         {
 409         int got_write_lock = 0;
 410
 411         CRYPTO_r_lock(lock);
 412         if (!*pmont)
 413                 {
 414                 CRYPTO_r_unlock(lock);
 415                 CRYPTO_w_lock(lock);
 416                 got_write_lock = 1;
 417
 418                 if (!*pmont)
 419                         {
 420                         BN_MONT_CTX *mtmp;
 421                         mtmp = BN_MONT_CTX_new();
 422                         if (mtmp && !BN_MONT_CTX_set(mtmp, mod, ctx))
 423                                 BN_MONT_CTX_free(mtmp);
 424                         else
 425                                 *pmont = mtmp;
 426                         }
 427                 }
 428
 429         if (got_write_lock)
 430                 CRYPTO_w_unlock(lock);
 431         else
 432                 CRYPTO_r_unlock(lock);
 433
 434         return *pmont;
 435         }