1 /* crypto/bn/bn_gcd.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
58 /* ====================================================================
59 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
112 #include "cryptlib.h"
115 static BIGNUM *euclid(BIGNUM *a, BIGNUM *b);
117 int BN_gcd(BIGNUM *r, const BIGNUM *in_a, const BIGNUM *in_b, BN_CTX *ctx)
128 if (a == NULL || b == NULL) goto err;
130 if (BN_copy(a,in_a) == NULL) goto err;
131 if (BN_copy(b,in_b) == NULL) goto err;
135 if (BN_cmp(a,b) < 0) { t=a; a=b; b=t; }
137 if (t == NULL) goto err;
139 if (BN_copy(r,t) == NULL) goto err;
147 static BIGNUM *euclid(BIGNUM *a, BIGNUM *b)
156 while (!BN_is_zero(b))
164 if (!BN_sub(a,a,b)) goto err;
165 if (!BN_rshift1(a,a)) goto err;
169 else /* a odd - b even */
171 if (!BN_rshift1(b,b)) goto err;
180 if (!BN_rshift1(a,a)) goto err;
184 else /* a even - b even */
186 if (!BN_rshift1(a,a)) goto err;
187 if (!BN_rshift1(b,b)) goto err;
196 if (!BN_lshift(a,a,shifts)) goto err;
205 /* solves ax == 1 (mod n) */
206 static BIGNUM *BN_mod_inverse_no_branch(BIGNUM *in,
207 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
209 BIGNUM *BN_mod_inverse(BIGNUM *in,
210 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx)
214 rv = int_bn_mod_inverse(in, a, n, ctx, &noinv);
216 BNerr(BN_F_BN_MOD_INVERSE,BN_R_NO_INVERSE);
220 BIGNUM *int_bn_mod_inverse(BIGNUM *in,
221 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx, int *pnoinv)
223 BIGNUM *A,*B,*X,*Y,*M,*D,*T,*R=NULL;
230 if ((BN_get_flags(a, BN_FLG_CONSTTIME) != 0) || (BN_get_flags(n, BN_FLG_CONSTTIME) != 0))
232 return BN_mod_inverse_no_branch(in, a, n, ctx);
246 if (T == NULL) goto err;
252 if (R == NULL) goto err;
256 if (BN_copy(B,a) == NULL) goto err;
257 if (BN_copy(A,n) == NULL) goto err;
259 if (B->neg || (BN_ucmp(B, A) >= 0))
261 if (!BN_nnmod(B, B, A, ctx)) goto err;
264 /* From B = a mod |n|, A = |n| it follows that
267 * -sign*X*a == B (mod |n|),
268 * sign*Y*a == A (mod |n|).
271 if (BN_is_odd(n) && (BN_num_bits(n) <= (BN_BITS <= 32 ? 450 : 2048)))
273 /* Binary inversion algorithm; requires odd modulus.
274 * This is faster than the general algorithm if the modulus
275 * is sufficiently small (about 400 .. 500 bits on 32-bit
276 * sytems, but much more on 64-bit systems) */
279 while (!BN_is_zero(B))
284 * (1) -sign*X*a == B (mod |n|),
285 * (2) sign*Y*a == A (mod |n|)
288 /* Now divide B by the maximum possible power of two in the integers,
289 * and divide X by the same value mod |n|.
290 * When we're done, (1) still holds. */
292 while (!BN_is_bit_set(B, shift)) /* note that 0 < B */
298 if (!BN_uadd(X, X, n)) goto err;
300 /* now X is even, so we can easily divide it by two */
301 if (!BN_rshift1(X, X)) goto err;
305 if (!BN_rshift(B, B, shift)) goto err;
309 /* Same for A and Y. Afterwards, (2) still holds. */
311 while (!BN_is_bit_set(A, shift)) /* note that 0 < A */
317 if (!BN_uadd(Y, Y, n)) goto err;
320 if (!BN_rshift1(Y, Y)) goto err;
324 if (!BN_rshift(A, A, shift)) goto err;
328 /* We still have (1) and (2).
329 * Both A and B are odd.
330 * The following computations ensure that
334 * (1) -sign*X*a == B (mod |n|),
335 * (2) sign*Y*a == A (mod |n|),
337 * and that either A or B is even in the next iteration.
339 if (BN_ucmp(B, A) >= 0)
341 /* -sign*(X + Y)*a == B - A (mod |n|) */
342 if (!BN_uadd(X, X, Y)) goto err;
343 /* NB: we could use BN_mod_add_quick(X, X, Y, n), but that
344 * actually makes the algorithm slower */
345 if (!BN_usub(B, B, A)) goto err;
349 /* sign*(X + Y)*a == A - B (mod |n|) */
350 if (!BN_uadd(Y, Y, X)) goto err;
351 /* as above, BN_mod_add_quick(Y, Y, X, n) would slow things down */
352 if (!BN_usub(A, A, B)) goto err;
358 /* general inversion algorithm */
360 while (!BN_is_zero(B))
366 * (*) -sign*X*a == B (mod |n|),
367 * sign*Y*a == A (mod |n|)
370 /* (D, M) := (A/B, A%B) ... */
371 if (BN_num_bits(A) == BN_num_bits(B))
373 if (!BN_one(D)) goto err;
374 if (!BN_sub(M,A,B)) goto err;
376 else if (BN_num_bits(A) == BN_num_bits(B) + 1)
378 /* A/B is 1, 2, or 3 */
379 if (!BN_lshift1(T,B)) goto err;
380 if (BN_ucmp(A,T) < 0)
382 /* A < 2*B, so D=1 */
383 if (!BN_one(D)) goto err;
384 if (!BN_sub(M,A,B)) goto err;
388 /* A >= 2*B, so D=2 or D=3 */
389 if (!BN_sub(M,A,T)) goto err;
390 if (!BN_add(D,T,B)) goto err; /* use D (:= 3*B) as temp */
391 if (BN_ucmp(A,D) < 0)
393 /* A < 3*B, so D=2 */
394 if (!BN_set_word(D,2)) goto err;
395 /* M (= A - 2*B) already has the correct value */
399 /* only D=3 remains */
400 if (!BN_set_word(D,3)) goto err;
401 /* currently M = A - 2*B, but we need M = A - 3*B */
402 if (!BN_sub(M,M,B)) goto err;
408 if (!BN_div(D,M,A,B,ctx)) goto err;
414 * (**) sign*Y*a == D*B + M (mod |n|).
417 tmp=A; /* keep the BIGNUM object, the value does not matter */
419 /* (A, B) := (B, A mod B) ... */
422 /* ... so we have 0 <= B < A again */
424 /* Since the former M is now B and the former B is now A,
425 * (**) translates into
426 * sign*Y*a == D*A + B (mod |n|),
428 * sign*Y*a - D*A == B (mod |n|).
429 * Similarly, (*) translates into
430 * -sign*X*a == A (mod |n|).
433 * sign*Y*a + D*sign*X*a == B (mod |n|),
435 * sign*(Y + D*X)*a == B (mod |n|).
437 * So if we set (X, Y, sign) := (Y + D*X, X, -sign), we arrive back at
438 * -sign*X*a == B (mod |n|),
439 * sign*Y*a == A (mod |n|).
440 * Note that X and Y stay non-negative all the time.
443 /* most of the time D is very small, so we can optimize tmp := D*X+Y */
446 if (!BN_add(tmp,X,Y)) goto err;
452 if (!BN_lshift1(tmp,X)) goto err;
454 else if (BN_is_word(D,4))
456 if (!BN_lshift(tmp,X,2)) goto err;
458 else if (D->top == 1)
460 if (!BN_copy(tmp,X)) goto err;
461 if (!BN_mul_word(tmp,D->d[0])) goto err;
465 if (!BN_mul(tmp,D,X,ctx)) goto err;
467 if (!BN_add(tmp,tmp,Y)) goto err;
470 M=Y; /* keep the BIGNUM object, the value does not matter */
478 * The while loop (Euclid's algorithm) ends when
481 * sign*Y*a == A (mod |n|),
482 * where Y is non-negative.
487 if (!BN_sub(Y,n,Y)) goto err;
489 /* Now Y*a == A (mod |n|). */
494 /* Y*a == 1 (mod |n|) */
495 if (!Y->neg && BN_ucmp(Y,n) < 0)
497 if (!BN_copy(R,Y)) goto err;
501 if (!BN_nnmod(R,Y,n,ctx)) goto err;
512 if ((ret == NULL) && (in == NULL)) BN_free(R);
519 /* BN_mod_inverse_no_branch is a special version of BN_mod_inverse.
520 * It does not contain branches that may leak sensitive information.
522 static BIGNUM *BN_mod_inverse_no_branch(BIGNUM *in,
523 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx)
525 BIGNUM *A,*B,*X,*Y,*M,*D,*T,*R=NULL;
526 BIGNUM local_A, local_B;
542 if (T == NULL) goto err;
548 if (R == NULL) goto err;
552 if (BN_copy(B,a) == NULL) goto err;
553 if (BN_copy(A,n) == NULL) goto err;
556 if (B->neg || (BN_ucmp(B, A) >= 0))
558 /* Turn BN_FLG_CONSTTIME flag on, so that when BN_div is invoked,
559 * BN_div_no_branch will be called eventually.
562 BN_with_flags(pB, B, BN_FLG_CONSTTIME);
563 if (!BN_nnmod(B, pB, A, ctx)) goto err;
566 /* From B = a mod |n|, A = |n| it follows that
569 * -sign*X*a == B (mod |n|),
570 * sign*Y*a == A (mod |n|).
573 while (!BN_is_zero(B))
579 * (*) -sign*X*a == B (mod |n|),
580 * sign*Y*a == A (mod |n|)
583 /* Turn BN_FLG_CONSTTIME flag on, so that when BN_div is invoked,
584 * BN_div_no_branch will be called eventually.
587 BN_with_flags(pA, A, BN_FLG_CONSTTIME);
589 /* (D, M) := (A/B, A%B) ... */
590 if (!BN_div(D,M,pA,B,ctx)) goto err;
595 * (**) sign*Y*a == D*B + M (mod |n|).
598 tmp=A; /* keep the BIGNUM object, the value does not matter */
600 /* (A, B) := (B, A mod B) ... */
603 /* ... so we have 0 <= B < A again */
605 /* Since the former M is now B and the former B is now A,
606 * (**) translates into
607 * sign*Y*a == D*A + B (mod |n|),
609 * sign*Y*a - D*A == B (mod |n|).
610 * Similarly, (*) translates into
611 * -sign*X*a == A (mod |n|).
614 * sign*Y*a + D*sign*X*a == B (mod |n|),
616 * sign*(Y + D*X)*a == B (mod |n|).
618 * So if we set (X, Y, sign) := (Y + D*X, X, -sign), we arrive back at
619 * -sign*X*a == B (mod |n|),
620 * sign*Y*a == A (mod |n|).
621 * Note that X and Y stay non-negative all the time.
624 if (!BN_mul(tmp,D,X,ctx)) goto err;
625 if (!BN_add(tmp,tmp,Y)) goto err;
627 M=Y; /* keep the BIGNUM object, the value does not matter */
634 * The while loop (Euclid's algorithm) ends when
637 * sign*Y*a == A (mod |n|),
638 * where Y is non-negative.
643 if (!BN_sub(Y,n,Y)) goto err;
645 /* Now Y*a == A (mod |n|). */
649 /* Y*a == 1 (mod |n|) */
650 if (!Y->neg && BN_ucmp(Y,n) < 0)
652 if (!BN_copy(R,Y)) goto err;
656 if (!BN_nnmod(R,Y,n,ctx)) goto err;
661 BNerr(BN_F_BN_MOD_INVERSE_NO_BRANCH,BN_R_NO_INVERSE);
666 if ((ret == NULL) && (in == NULL)) BN_free(R);