crypto/bn/bn_gcd.c

   1 /* crypto/bn/bn_gcd.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-2001 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111
 112 #include "cryptlib.h"
 113 #include "bn_lcl.h"
 114
 115 static BIGNUM *euclid(BIGNUM *a, BIGNUM *b);
 116
 117 int BN_gcd(BIGNUM *r, const BIGNUM *in_a, const BIGNUM *in_b, BN_CTX *ctx)
 118         {
 119         BIGNUM *a,*b,*t;
 120         int ret=0;
 121
 122         bn_check_top(in_a);
 123         bn_check_top(in_b);
 124
 125         BN_CTX_start(ctx);
 126         a = BN_CTX_get(ctx);
 127         b = BN_CTX_get(ctx);
 128         if (a == NULL || b == NULL) goto err;
 129
 130         if (BN_copy(a,in_a) == NULL) goto err;
 131         if (BN_copy(b,in_b) == NULL) goto err;
 132         a->neg = 0;
 133         b->neg = 0;
 134
 135         if (BN_cmp(a,b) < 0) { t=a; a=b; b=t; }
 136         t=euclid(a,b);
 137         if (t == NULL) goto err;
 138
 139         if (BN_copy(r,t) == NULL) goto err;
 140         ret=1;
 141 err:
 142         BN_CTX_end(ctx);
 143         return(ret);
 144         }
 145
 146 static BIGNUM *euclid(BIGNUM *a, BIGNUM *b)
 147         {
 148         BIGNUM *t;
 149         int shifts=0;
 150
 151         bn_check_top(a);
 152         bn_check_top(b);
 153
 154         /* 0 <= b <= a */
 155         while (!BN_is_zero(b))
 156                 {
 157                 /* 0 < b <= a */
 158
 159                 if (BN_is_odd(a))
 160                         {
 161                         if (BN_is_odd(b))
 162                                 {
 163                                 if (!BN_sub(a,a,b)) goto err;
 164                                 if (!BN_rshift1(a,a)) goto err;
 165                                 if (BN_cmp(a,b) < 0)
 166                                         { t=a; a=b; b=t; }
 167                                 }
 168                         else            /* a odd - b even */
 169                                 {
 170                                 if (!BN_rshift1(b,b)) goto err;
 171                                 if (BN_cmp(a,b) < 0)
 172                                         { t=a; a=b; b=t; }
 173                                 }
 174                         }
 175                 else                    /* a is even */
 176                         {
 177                         if (BN_is_odd(b))
 178                                 {
 179                                 if (!BN_rshift1(a,a)) goto err;
 180                                 if (BN_cmp(a,b) < 0)
 181                                         { t=a; a=b; b=t; }
 182                                 }
 183                         else            /* a even - b even */
 184                                 {
 185                                 if (!BN_rshift1(a,a)) goto err;
 186                                 if (!BN_rshift1(b,b)) goto err;
 187                                 shifts++;
 188                                 }
 189                         }
 190                 /* 0 <= b <= a */
 191                 }
 192
 193         if (shifts)
 194                 {
 195                 if (!BN_lshift(a,a,shifts)) goto err;
 196                 }
 197         return(a);
 198 err:
 199         return(NULL);
 200         }
 201
 202
 203 /* solves ax == 1 (mod n) */
 204 BIGNUM *BN_mod_inverse(BIGNUM *in,
 205         const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx)
 206         {
 207         BIGNUM *A,*B,*X,*Y,*M,*D,*T,*R=NULL;
 208         BIGNUM *ret=NULL;
 209         int sign;
 210
 211         bn_check_top(a);
 212         bn_check_top(n);
 213
 214         BN_CTX_start(ctx);
 215         A = BN_CTX_get(ctx);
 216         B = BN_CTX_get(ctx);
 217         X = BN_CTX_get(ctx);
 218         D = BN_CTX_get(ctx);
 219         M = BN_CTX_get(ctx);
 220         Y = BN_CTX_get(ctx);
 221         T = BN_CTX_get(ctx);
 222         if (T == NULL) goto err;
 223
 224         if (in == NULL)
 225                 R=BN_new();
 226         else
 227                 R=in;
 228         if (R == NULL) goto err;
 229
 230         BN_one(X);
 231         BN_zero(Y);
 232         if (BN_copy(B,a) == NULL) goto err;
 233         if (BN_copy(A,n) == NULL) goto err;
 234         A->neg = 0;
 235         if (B->neg || (BN_ucmp(B, A) >= 0))
 236                 {
 237                 if (!BN_nnmod(B, B, A, ctx)) goto err;
 238                 }
 239         sign = -1;
 240         /* From  B = a mod |n|,  A = |n|  it follows that
 241          *
 242          *      0 <= B < A,
 243          *     -sign*X*a  ==  B   (mod |n|),
 244          *      sign*Y*a  ==  A   (mod |n|).
 245          */
 246
 247         if (BN_is_odd(n) && (BN_num_bits(n) <= 400))
 248                 {
 249                 /* Binary inversion algorithm; requires odd modulus.
 250                  * This is faster than the general algorithm if the modulus
 251                  * is sufficiently small. */
 252                 int shift;
 253
 254                 while (!BN_is_zero(B))
 255                         {
 256                         /*
 257                          *      0 < B < |n|,
 258                          *      0 < A <= |n|,
 259                          * (1) -sign*X*a  ==  B   (mod |n|),
 260                          * (2)  sign*Y*a  ==  A   (mod |n|)
 261                          */
 262
 263                         /* Now divide  B  by the maximum possible power of two in the integers,
 264                          * and divide  X  by the same value mod |n|.
 265                          * When we're done, (1) still holds. */
 266                         shift = 0;
 267                         while (!BN_is_bit_set(B, shift)) /* note that 0 < B */
 268                                 {
 269                                 shift++;
 270
 271                                 if (BN_is_odd(X))
 272                                         {
 273                                         if (!BN_uadd(X, X, n)) goto err;
 274                                         }
 275                                 /* now X is even, so we can easily divide it by two */
 276                                 if (!BN_rshift1(X, X)) goto err;
 277                                 }
 278                         if (shift > 0)
 279                                 {
 280                                 if (!BN_rshift(B, B, shift)) goto err;
 281                                 }
 282
 283
 284                         /* Same for  A  and  Y.  Afterwards, (2) still holds. */
 285                         shift = 0;
 286                         while (!BN_is_bit_set(A, shift)) /* note that 0 < A */
 287                                 {
 288                                 shift++;
 289
 290                                 if (BN_is_odd(Y))
 291                                         {
 292                                         if (!BN_uadd(Y, Y, n)) goto err;
 293                                         }
 294                                 /* now Y is even */
 295                                 if (!BN_rshift1(Y, Y)) goto err;
 296                                 }
 297                         if (shift > 0)
 298                                 {
 299                                 if (!BN_rshift(A, A, shift)) goto err;
 300                                 }
 301
 302
 303                         /* We still have (1) and (2).
 304                          * Both  A  and  B  are odd.
 305                          * The following computations ensure that
 306                          *
 307                          *     0 <= B < |n|,
 308                          *      0 < A < |n|,
 309                          * (1) -sign*X*a  ==  B   (mod |n|),
 310                          * (2)  sign*Y*a  ==  A   (mod |n|),
 311                          *
 312                          * and that either  A  or  B  is even in the next iteration.
 313                          */
 314                         if (BN_ucmp(B, A) >= 0)
 315                                 {
 316                                 /* -sign*(X + Y)*a == B - A  (mod |n|) */
 317                                 if (!BN_uadd(X, X, Y)) goto err;
 318                                 /* NB: we could use BN_mod_add_quick(X, X, Y, n), but that
 319                                  * actually makes the algorithm slower */
 320                                 if (!BN_usub(B, B, A)) goto err;
 321                                 }
 322                         else
 323                                 {
 324                                 /*  sign*(X + Y)*a == A - B  (mod |n|) */
 325                                 if (!BN_uadd(Y, Y, X)) goto err;
 326                                 /* as above, BN_mod_add_quick(Y, Y, X, n) would slow things down */
 327                                 if (!BN_usub(A, A, B)) goto err;
 328                                 }
 329                         }
 330                 }
 331         else
 332                 {
 333                 /* general inversion algorithm (less efficient than binary inversion) */
 334
 335                 while (!BN_is_zero(B))
 336                         {
 337                         BIGNUM *tmp;
 338
 339                         /*
 340                          *      0 < B < A,
 341                          * (*) -sign*X*a  ==  B   (mod |n|),
 342                          *      sign*Y*a  ==  A   (mod |n|)
 343                          */
 344
 345                         /* (D, M) := (A/B, A%B) ... */
 346                         if (BN_num_bits(A) == BN_num_bits(B))
 347                                 {
 348                                 if (!BN_one(D)) goto err;
 349                                 if (!BN_sub(M,A,B)) goto err;
 350                                 }
 351                         else if (BN_num_bits(A) == BN_num_bits(B) + 1)
 352                                 {
 353                                 /* A/B is 1, 2, or 3 */
 354                                 if (!BN_lshift1(T,B)) goto err;
 355                                 if (BN_ucmp(A,T) < 0)
 356                                         {
 357                                         /* A < 2*B, so D=1 */
 358                                         if (!BN_one(D)) goto err;
 359                                         if (!BN_sub(M,A,B)) goto err;
 360                                         }
 361                                 else
 362                                         {
 363                                         /* A >= 2*B, so D=2 or D=3 */
 364                                         if (!BN_sub(M,A,T)) goto err;
 365                                         if (!BN_add(D,T,B)) goto err; /* use D (:= 3*B) as temp */
 366                                         if (BN_ucmp(A,D) < 0)
 367                                                 {
 368                                                 /* A < 3*B, so D=2 */
 369                                                 if (!BN_set_word(D,2)) goto err;
 370                                                 /* M (= A - 2*B) already has the correct value */
 371                                                 }
 372                                         else
 373                                                 {
 374                                                 /* only D=3 remains */
 375                                                 if (!BN_set_word(D,3)) goto err;
 376                                                 /* currently  M = A - 2*B,  but we need  M = A - 3*B */
 377                                                 if (!BN_sub(M,M,B)) goto err;
 378                                                 }
 379                                         }
 380                                 }
 381                         else
 382                                 {
 383                                 if (!BN_div(D,M,A,B,ctx)) goto err;
 384                                 }
 385
 386                         /* Now
 387                          *      A = D*B + M;
 388                          * thus we have
 389                          * (**)  sign*Y*a  ==  D*B + M   (mod |n|).
 390                          */
 391
 392                         tmp=A; /* keep the BIGNUM object, the value does not matter */
 393
 394                         /* (A, B) := (B, A mod B) ... */
 395                         A=B;
 396                         B=M;
 397                         /* ... so we have  0 <= B < A  again */
 398
 399                         /* Since the former  M  is now  B  and the former  B  is now  A,
 400                          * (**) translates into
 401                          *       sign*Y*a  ==  D*A + B    (mod |n|),
 402                          * i.e.
 403                          *       sign*Y*a - D*A  ==  B    (mod |n|).
 404                          * Similarly, (*) translates into
 405                          *      -sign*X*a  ==  A          (mod |n|).
 406                          *
 407                          * Thus,
 408                          *   sign*Y*a + D*sign*X*a  ==  B  (mod |n|),
 409                          * i.e.
 410                          *        sign*(Y + D*X)*a  ==  B  (mod |n|).
 411                          *
 412                          * So if we set  (X, Y, sign) := (Y + D*X, X, -sign),  we arrive back at
 413                          *      -sign*X*a  ==  B   (mod |n|),
 414                          *       sign*Y*a  ==  A   (mod |n|).
 415                          * Note that  X  and  Y  stay non-negative all the time.
 416                          */
 417
 418                         /* most of the time D is very small, so we can optimize tmp := D*X+Y */
 419                         if (BN_is_one(D))
 420                                 {
 421                                 if (!BN_add(tmp,X,Y)) goto err;
 422                                 }
 423                         else
 424                                 {
 425                                 if (BN_is_word(D,2))
 426                                         {
 427                                         if (!BN_lshift1(tmp,X)) goto err;
 428                                         }
 429                                 else if (BN_is_word(D,4))
 430                                         {
 431                                         if (!BN_lshift(tmp,X,2)) goto err;
 432                                         }
 433                                 else if (D->top == 1)
 434                                         {
 435                                         if (!BN_copy(tmp,X)) goto err;
 436                                         if (!BN_mul_word(tmp,D->d[0])) goto err;
 437                                         }
 438                                 else
 439                                         {
 440                                         if (!BN_mul(tmp,D,X,ctx)) goto err;
 441                                         }
 442                                 if (!BN_add(tmp,tmp,Y)) goto err;
 443                                 }
 444
 445                         M=Y; /* keep the BIGNUM object, the value does not matter */
 446                         Y=X;
 447                         X=tmp;
 448                         sign = -sign;
 449                         }
 450                 }
 451
 452         /*
 453          * The while loop (Euclid's algorithm) ends when
 454          *      A == gcd(a,n);
 455          * we have
 456          *       sign*Y*a  ==  A  (mod |n|),
 457          * where  Y  is non-negative.
 458          */
 459
 460         if (sign < 0)
 461                 {
 462                 if (!BN_sub(Y,n,Y)) goto err;
 463                 }
 464         /* Now  Y*a  ==  A  (mod |n|).  */
 465
 466
 467         if (BN_is_one(A))
 468                 {
 469                 /* Y*a == 1  (mod |n|) */
 470                 if (!Y->neg && BN_ucmp(Y,n) < 0)
 471                         {
 472                         if (!BN_copy(R,Y)) goto err;
 473                         }
 474                 else
 475                         {
 476                         if (!BN_nnmod(R,Y,n,ctx)) goto err;
 477                         }
 478                 }
 479         else
 480                 {
 481                 BNerr(BN_F_BN_MOD_INVERSE,BN_R_NO_INVERSE);
 482                 goto err;
 483                 }
 484         ret=R;
 485 err:
 486         if ((ret == NULL) && (in == NULL)) BN_free(R);
 487         BN_CTX_end(ctx);
 488         return(ret);
 489         }