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-2000 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111
 112 #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,*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         if (Y == NULL) goto err;
 222
 223         if (in == NULL)
 224                 R=BN_new();
 225         else
 226                 R=in;
 227         if (R == NULL) goto err;
 228
 229         BN_one(X);
 230         BN_zero(Y);
 231         if (BN_copy(B,a) == NULL) goto err;
 232         if (BN_copy(A,n) == NULL) goto err;
 233         A->neg = 0;
 234         if (B->neg || (BN_ucmp(B, A) >= 0))
 235                 {
 236                 if (!BN_nnmod(B, B, A, ctx)) goto err;
 237                 }
 238         sign = -1;
 239         /* From  B = a mod |n|,  A = |n|  it follows that
 240          *
 241          *      0 <= B < A,
 242          *           X*a  ==  B   (mod |n|),
 243          *     -sign*Y*a  ==  A   (mod |n|).
 244          */
 245
 246         while (!BN_is_zero(B))
 247                 {
 248                 BIGNUM *tmp;
 249
 250                 /*
 251                  *      0 < B < A,
 252                  * (*)       X*a  ==  B   (mod |n|),
 253                  *     -sign*Y*a  ==  A   (mod |n|)
 254                  */
 255
 256                 if (!BN_div(D,M,A,B,ctx)) goto err;
 257                 /* Now
 258                  *      A = D*B + M;
 259                  * thus we have
 260                  * (**) -sign*Y*a  ==  D*B + M   (mod |n|).
 261                  */
 262
 263                 tmp=A; /* keep the BIGNUM object, the value does not matter */
 264
 265                 /* (A, B) := (B, A mod B) ... */
 266                 A=B;
 267                 B=M;
 268                 /* ... so we have  0 <= B < A  again */
 269
 270                 /* Since the former  M  is now  B  and the former  B  is now  A,
 271                  * (**) translates into
 272                  *      -sign*Y*a  ==  D*A + B    (mod |n|),
 273                  * i.e.
 274                  *      -sign*Y*a - D*A  ==  B    (mod |n|).
 275                  * Similarly, (*) translates into
 276                  *      X*a  ==  A          (mod |n|).
 277                  *
 278                  * Thus,
 279                  *      -sign*Y*a - D*X*a  ==  B  (mod |n|),
 280                  * i.e.
 281                  *      -sign*(Y + D*X)*a  ==  B  (mod |n|).
 282                  *
 283                  * So if we set  (X, Y, sign) := (Y + D*X, X, -sign),  we arrive back at
 284                  *            X*a  ==  B   (mod |n|),
 285                  *      -sign*Y*a  ==  A   (mod |n|).
 286                  * Note that  X  and  Y  stay non-negative all the time.
 287                  */
 288
 289                 if (!BN_mul(tmp,D,X,ctx)) goto err;
 290                 if (!BN_add(tmp,tmp,Y)) goto err;
 291                 M=Y; /* keep the BIGNUM object, the value does not matter */
 292                 Y=X;
 293                 X=tmp;
 294                 sign = -sign;
 295                 }
 296
 297         /*
 298          * The while loop ends when
 299          *      A == gcd(a,n);
 300          * we have
 301          *      -sign*Y*a  ==  A  (mod |n|),
 302          * where  Y  is non-negative.
 303          */
 304
 305         if (sign < 0)
 306                 {
 307                 if (!BN_sub(Y,n,Y)) goto err;
 308                 }
 309         /* Now  Y*a  ==  A  (mod |n|).  */
 310
 311
 312         if (BN_is_one(A))
 313                 {
 314                 /* Y*a == 1  (mod |n|) */
 315                 if (!BN_mod(R,Y,n,ctx)) goto err;
 316                 }
 317         else
 318                 {
 319                 BNerr(BN_F_BN_MOD_INVERSE,BN_R_NO_INVERSE);
 320                 goto err;
 321                 }
 322         ret=R;
 323 err:
 324         if ((ret == NULL) && (in == NULL)) BN_free(R);
 325         BN_CTX_end(ctx);
 326         return(ret);
 327         }
 328