mark all block comments that need format preserving so that
[openssl.git] / crypto / bn / bn_gcd.c
index 7496dbc3bd83b753dd12f4e52854c5bf6c27668b..8ff0439370f8bbb224771a6d6c179a64f6f575b1 100644 (file)
@@ -140,6 +140,7 @@ int BN_gcd(BIGNUM *r, const BIGNUM *in_a, const BIGNUM *in_b, BN_CTX *ctx)
        ret=1;
 err:
        BN_CTX_end(ctx);
+       bn_check_top(r);
        return(ret);
        }
 
@@ -194,6 +195,7 @@ static BIGNUM *euclid(BIGNUM *a, BIGNUM *b)
                {
                if (!BN_lshift(a,a,shifts)) goto err;
                }
+       bn_check_top(a);
        return(a);
 err:
        return(NULL);
@@ -201,6 +203,8 @@ err:
 
 
 /* solves ax == 1 (mod n) */
+static BIGNUM *BN_mod_inverse_no_branch(BIGNUM *in,
+        const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
 BIGNUM *BN_mod_inverse(BIGNUM *in,
        const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx)
        {
@@ -208,6 +212,11 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
        BIGNUM *ret=NULL;
        int sign;
 
+       if ((BN_get_flags(a, BN_FLG_CONSTTIME) != 0) || (BN_get_flags(n, BN_FLG_CONSTTIME) != 0))
+               {
+               return BN_mod_inverse_no_branch(in, a, n, ctx);
+               }
+
        bn_check_top(a);
        bn_check_top(n);
 
@@ -237,23 +246,25 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
                if (!BN_nnmod(B, B, A, ctx)) goto err;
                }
        sign = -1;
-       /* From  B = a mod |n|,  A = |n|  it follows that
+       /*-
+        * From  B = a mod |n|,  A = |n|  it follows that
         *
         *      0 <= B < A,
         *     -sign*X*a  ==  B   (mod |n|),
         *      sign*Y*a  ==  A   (mod |n|).
         */
 
-       if (BN_is_odd(n) && (BN_num_bits(n) <= 400))
+       if (BN_is_odd(n) && (BN_num_bits(n) <= (BN_BITS <= 32 ? 450 : 2048)))
                {
                /* Binary inversion algorithm; requires odd modulus.
                 * This is faster than the general algorithm if the modulus
-                * is sufficiently small. */
+                * is sufficiently small (about 400 .. 500 bits on 32-bit
+                * sytems, but much more on 64-bit systems) */
                int shift;
                
                while (!BN_is_zero(B))
                        {
-                       /*
+                       /*-
                         *      0 < B < |n|,
                         *      0 < A <= |n|,
                         * (1) -sign*X*a  ==  B   (mod |n|),
@@ -300,7 +311,8 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
                                }
 
                        
-                       /* We still have (1) and (2).
+                       /*-
+                        * We still have (1) and (2).
                         * Both  A  and  B  are odd.
                         * The following computations ensure that
                         *
@@ -336,7 +348,7 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
                        {
                        BIGNUM *tmp;
                        
-                       /*
+                       /*-
                         *      0 < B < A,
                         * (*) -sign*X*a  ==  B   (mod |n|),
                         *      sign*Y*a  ==  A   (mod |n|)
@@ -383,7 +395,8 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
                                if (!BN_div(D,M,A,B,ctx)) goto err;
                                }
                        
-                       /* Now
+                       /*-
+                        * Now
                         *      A = D*B + M;
                         * thus we have
                         * (**)  sign*Y*a  ==  D*B + M   (mod |n|).
@@ -396,7 +409,8 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
                        B=M;
                        /* ... so we have  0 <= B < A  again */
                        
-                       /* Since the former  M  is now  B  and the former  B  is now  A,
+                       /*-
+                        * Since the former  M  is now  B  and the former  B  is now  A,
                         * (**) translates into
                         *       sign*Y*a  ==  D*A + B    (mod |n|),
                         * i.e.
@@ -449,7 +463,7 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
                        }
                }
                
-       /*
+       /*-
         * The while loop (Euclid's algorithm) ends when
         *      A == gcd(a,n);
         * we have
@@ -485,5 +499,163 @@ BIGNUM *BN_mod_inverse(BIGNUM *in,
 err:
        if ((ret == NULL) && (in == NULL)) BN_free(R);
        BN_CTX_end(ctx);
+       bn_check_top(ret);
+       return(ret);
+       }
+
+
+/* BN_mod_inverse_no_branch is a special version of BN_mod_inverse. 
+ * It does not contain branches that may leak sensitive information.
+ */
+static BIGNUM *BN_mod_inverse_no_branch(BIGNUM *in,
+       const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx)
+       {
+       BIGNUM *A,*B,*X,*Y,*M,*D,*T,*R=NULL;
+       BIGNUM local_A, local_B;
+       BIGNUM *pA, *pB;
+       BIGNUM *ret=NULL;
+       int sign;
+
+       bn_check_top(a);
+       bn_check_top(n);
+
+       BN_CTX_start(ctx);
+       A = BN_CTX_get(ctx);
+       B = BN_CTX_get(ctx);
+       X = BN_CTX_get(ctx);
+       D = BN_CTX_get(ctx);
+       M = BN_CTX_get(ctx);
+       Y = BN_CTX_get(ctx);
+       T = BN_CTX_get(ctx);
+       if (T == NULL) goto err;
+
+       if (in == NULL)
+               R=BN_new();
+       else
+               R=in;
+       if (R == NULL) goto err;
+
+       BN_one(X);
+       BN_zero(Y);
+       if (BN_copy(B,a) == NULL) goto err;
+       if (BN_copy(A,n) == NULL) goto err;
+       A->neg = 0;
+
+       if (B->neg || (BN_ucmp(B, A) >= 0))
+               {
+               /* Turn BN_FLG_CONSTTIME flag on, so that when BN_div is invoked,
+                * BN_div_no_branch will be called eventually.
+                */
+               pB = &local_B;
+               BN_with_flags(pB, B, BN_FLG_CONSTTIME); 
+               if (!BN_nnmod(B, pB, A, ctx)) goto err;
+               }
+       sign = -1;
+       /*-
+        * From  B = a mod |n|,  A = |n|  it follows that
+        *
+        *      0 <= B < A,
+        *     -sign*X*a  ==  B   (mod |n|),
+        *      sign*Y*a  ==  A   (mod |n|).
+        */
+
+       while (!BN_is_zero(B))
+               {
+               BIGNUM *tmp;
+               
+               /*-
+                *      0 < B < A,
+                * (*) -sign*X*a  ==  B   (mod |n|),
+                *      sign*Y*a  ==  A   (mod |n|)
+                */
+
+               /* Turn BN_FLG_CONSTTIME flag on, so that when BN_div is invoked,
+                * BN_div_no_branch will be called eventually.
+                */
+               pA = &local_A;
+               BN_with_flags(pA, A, BN_FLG_CONSTTIME); 
+               
+               /* (D, M) := (A/B, A%B) ... */          
+               if (!BN_div(D,M,pA,B,ctx)) goto err;
+               
+               /*-
+                * Now
+                *      A = D*B + M;
+                * thus we have
+                * (**)  sign*Y*a  ==  D*B + M   (mod |n|).
+                */
+               
+               tmp=A; /* keep the BIGNUM object, the value does not matter */
+               
+               /* (A, B) := (B, A mod B) ... */
+               A=B;
+               B=M;
+               /* ... so we have  0 <= B < A  again */
+               
+               /*-
+                * Since the former  M  is now  B  and the former  B  is now  A,
+                * (**) translates into
+                *       sign*Y*a  ==  D*A + B    (mod |n|),
+                * i.e.
+                *       sign*Y*a - D*A  ==  B    (mod |n|).
+                * Similarly, (*) translates into
+                *      -sign*X*a  ==  A          (mod |n|).
+                *
+                * Thus,
+                *   sign*Y*a + D*sign*X*a  ==  B  (mod |n|),
+                * i.e.
+                *        sign*(Y + D*X)*a  ==  B  (mod |n|).
+                *
+                * So if we set  (X, Y, sign) := (Y + D*X, X, -sign),  we arrive back at
+                *      -sign*X*a  ==  B   (mod |n|),
+                *       sign*Y*a  ==  A   (mod |n|).
+                * Note that  X  and  Y  stay non-negative all the time.
+                */
+                       
+               if (!BN_mul(tmp,D,X,ctx)) goto err;
+               if (!BN_add(tmp,tmp,Y)) goto err;
+
+               M=Y; /* keep the BIGNUM object, the value does not matter */
+               Y=X;
+               X=tmp;
+               sign = -sign;
+               }
+               
+       /*-
+        * The while loop (Euclid's algorithm) ends when
+        *      A == gcd(a,n);
+        * we have
+        *       sign*Y*a  ==  A  (mod |n|),
+        * where  Y  is non-negative.
+        */
+
+       if (sign < 0)
+               {
+               if (!BN_sub(Y,n,Y)) goto err;
+               }
+       /* Now  Y*a  ==  A  (mod |n|).  */
+
+       if (BN_is_one(A))
+               {
+               /* Y*a == 1  (mod |n|) */
+               if (!Y->neg && BN_ucmp(Y,n) < 0)
+                       {
+                       if (!BN_copy(R,Y)) goto err;
+                       }
+               else
+                       {
+                       if (!BN_nnmod(R,Y,n,ctx)) goto err;
+                       }
+               }
+       else
+               {
+               BNerr(BN_F_BN_MOD_INVERSE_NO_BRANCH,BN_R_NO_INVERSE);
+               goto err;
+               }
+       ret=R;
+err:
+       if ((ret == NULL) && (in == NULL)) BN_free(R);
+       BN_CTX_end(ctx);
+       bn_check_top(ret);
        return(ret);
        }