See ChangeLog: Wed Jul 7 13:23:40 CEST 1999 Werner Koch
[gnupg.git] / cipher / primegen.c
index 9d91ae4..9bf1085 100644 (file)
@@ -1,14 +1,14 @@
 /* primegen.c - prime number generator
- *     Copyright (c) 1997 by Werner Koch (dd9jn)
+ *     Copyright (C) 1998 Free Software Foundation, Inc.
  *
- * This file is part of G10.
+ * This file is part of GnuPG.
  *
- * G10 is free software; you can redistribute it and/or modify
+ * GnuPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
- * G10 is distributed in the hope that it will be useful,
+ * GnuPG is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ *
+ * ***********************************************************************
+ * The algorithm used to generate practically save primes is due to
+ * Lim and Lee as described in the CRYPTO '97 proceedings (ISBN3540633847)
+ * page 260.
  */
 
 #include <config.h>
 
 static int no_of_small_prime_numbers;
 static MPI gen_prime( unsigned nbits, int mode, int randomlevel );
-static int check_prime( MPI prime );
+static int check_prime( MPI prime, MPI val_2 );
 static int is_prime( MPI n, int steps, int *count );
 static void m_out_of_n( char *array, int m, int n );
 
 
+static void
+progress( int c )
+{
+    fputc( c, stderr );
+}
+
+
 /****************
  * Generate a prime number (stored in secure memory)
  */
@@ -43,7 +55,7 @@ generate_secret_prime( unsigned  nbits )
     MPI prime;
 
     prime = gen_prime( nbits, 1, 2 );
-    fputc('\n', stderr);
+    progress('\n');
     return prime;
 }
 
@@ -53,7 +65,7 @@ generate_public_prime( unsigned  nbits )
     MPI prime;
 
     prime = gen_prime( nbits, 0, 2 );
-    fputc('\n', stderr);
+    progress('\n');
     return prime;
 }
 
@@ -63,43 +75,58 @@ generate_public_prime( unsigned  nbits )
  * security from it - The prime number is public and we could also
  * offer the factors for those who are willing to check that it is
  * indeed a strong prime.
+ *
+ * mode 0: Standard
+ *     1: Make sure that at least one factor is of size qbits.
  */
 MPI
-generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
+generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
+                   MPI g, MPI **ret_factors )
 {
     int n;  /* number of factors */
     int m;  /* number of primes in pool */
     unsigned fbits; /* length of prime factors */
-    MPI *factors; /* curent factors */
+    MPI *factors; /* current factors */
     MPI *pool; /* pool of primes */
-    MPI q;     /* first prime factor */
+    MPI q;     /* first prime factor (variable)*/
     MPI prime; /* prime test value */
+    MPI q_factor; /* used for mode 1 */
     byte *perms = NULL;
     int i, j;
     int count1, count2;
     unsigned nprime;
+    unsigned req_qbits = qbits; /* the requested q bits size */
+    MPI val_2  = mpi_alloc_set_ui( 2 );
 
     /* find number of needed prime factors */
     for(n=1; (pbits - qbits - 1) / n  >= qbits; n++ )
        ;
     n--;
-    if( !n )
+    if( !n || (mode==1 && n < 2) )
        log_fatal("can't gen prime with pbits=%u qbits=%u\n", pbits, qbits );
-    fbits = (pbits - qbits -1) / n;
-    while( qbits + n*fbits < pbits )
-       qbits++;
+    if( mode == 1 ) {
+       n--;
+       fbits = (pbits - 2*req_qbits -1) / n;
+       qbits =  pbits - req_qbits - n*fbits;
+    }
+    else {
+       fbits = (pbits - req_qbits -1) / n;
+       qbits = pbits - n*fbits;
+    }
     if( DBG_CIPHER )
-       log_debug("gen prime: pbits=%u qbits=%u fbits=%u n=%d\n",
-                   pbits, qbits, fbits, n  );
-
+       log_debug("gen prime: pbits=%u qbits=%u fbits=%u/%u n=%d\n",
+                   pbits, req_qbits, qbits, fbits, n  );
     prime = mpi_alloc( (pbits + BITS_PER_MPI_LIMB - 1) /  BITS_PER_MPI_LIMB );
     q = gen_prime( qbits, 0, 1 );
+    q_factor = mode==1? gen_prime( req_qbits, 0, 1 ) : NULL;
 
     /* allocate an array to hold the factors + 2 for later usage */
     factors = m_alloc_clear( (n+2) * sizeof *factors );
 
     /* make a pool of 3n+5 primes (this is an arbitrary value) */
     m = n*3+5;
+    if( mode == 1 )
+       m += 5; /* need some more for DSA */
     if( m < 25 )
        m = 25;
     pool = m_alloc_clear( m * sizeof *pool );
@@ -132,13 +159,15 @@ generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
                }
            if( i == n ) {
                m_free(perms); perms = NULL;
-               fputc('!', stderr);
+               progress('!');
                goto next_try;  /* allocate new primes */
            }
        }
 
        mpi_set( prime, q );
        mpi_mul_ui( prime, prime, 2 );
+       if( mode == 1 )
+           mpi_mul( prime, prime, q_factor );
        for(i=0; i < n; i++ )
            mpi_mul( prime, prime, factors[i] );
        mpi_add_ui( prime, prime, 1 );
@@ -147,7 +176,7 @@ generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
            if( ++count1 > 20 ) {
                count1 = 0;
                qbits++;
-               fputc('>', stderr);
+               progress('>');
                q = gen_prime( qbits, 0, 1 );
                goto next_try;
            }
@@ -158,26 +187,43 @@ generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
            if( ++count2 > 20 ) {
                count2 = 0;
                qbits--;
-               fputc('<', stderr);
+               progress('<');
                q = gen_prime( qbits, 0, 1 );
                goto next_try;
            }
        }
        else
            count2 = 0;
-    } while( !(nprime == pbits && check_prime( prime )) );
-
+    } while( !(nprime == pbits && check_prime( prime, val_2 )) );
 
     if( DBG_CIPHER ) {
-       putc('\n', stderr);
+       progress('\n');
        log_mpidump( "prime    : ", prime );
        log_mpidump( "factor  q: ", q );
+       if( mode == 1 )
+           log_mpidump( "factor q0: ", q_factor );
        for(i=0; i < n; i++ )
            log_mpidump( "factor pi: ", factors[i] );
        log_debug("bit sizes: prime=%u, q=%u", mpi_get_nbits(prime), mpi_get_nbits(q) );
+       if( mode == 1 )
+           fprintf(stderr, ", q0=%u", mpi_get_nbits(q_factor) );
        for(i=0; i < n; i++ )
            fprintf(stderr, ", p%d=%u", i, mpi_get_nbits(factors[i]) );
-       putc('\n', stderr);
+       progress('\n');
+    }
+
+    if( ret_factors ) { /* caller wants the factors */
+       *ret_factors = m_alloc_clear( (n+2) * sizeof **ret_factors);
+       if( mode == 1 ) {
+           i = 0;
+           (*ret_factors)[i++] = mpi_copy( q_factor );
+           for(; i <= n; i++ )
+               (*ret_factors)[i] = mpi_copy( factors[i] );
+       }
+       else {
+           for(; i < n; i++ )
+               (*ret_factors)[i] = mpi_copy( factors[i] );
+       }
     }
 
     if( g ) { /* create a generator (start with 3)*/
@@ -185,6 +231,8 @@ generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
        MPI b     = mpi_alloc( mpi_get_nlimbs(prime) );
        MPI pmin1 = mpi_alloc( mpi_get_nlimbs(prime) );
 
+       if( mode == 1 )
+           BUG(); /* not yet implemented */
        factors[n] = q;
        factors[n+1] = mpi_alloc_set_ui(2);
        mpi_sub_ui( pmin1, prime, 1 );
@@ -196,9 +244,9 @@ generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
                mpi_print( stderr, g, 1 );
            }
            else
-               fputc('^', stderr);
+               progress('^');
            for(i=0; i < n+2; i++ ) {
-               fputc('~', stderr);
+               /*fputc('~', stderr);*/
                mpi_fdiv_q(tmp, pmin1, factors[i] );
                /* (no mpi_pow(), but it is okay to use this with mod prime) */
                mpi_powm(b, g, tmp, prime );
@@ -206,7 +254,7 @@ generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
                    break;
            }
            if( DBG_CIPHER )
-               fputc('\n', stderr);
+               progress('\n');
        } while( i < n+2 );
        mpi_free(factors[n+1]);
        mpi_free(tmp);
@@ -214,22 +262,24 @@ generate_elg_prime( unsigned pbits, unsigned qbits, MPI g )
        mpi_free(pmin1);
     }
     if( !DBG_CIPHER )
-       putc('\n', stderr);
+       progress('\n');
 
     m_free( factors ); /* (factors are shallow copies) */
     for(i=0; i < m; i++ )
        mpi_free( pool[i] );
     m_free( pool );
     m_free(perms);
+    mpi_free(val_2);
     return prime;
 }
 
 
+
 static MPI
 gen_prime( unsigned  nbits, int secret, int randomlevel )
 {
     unsigned  nlimbs;
-    MPI prime, val_2, val_3, result;
+    MPI prime, ptest, pminus1, val_2, val_3, result;
     int i;
     unsigned x, step;
     unsigned count1, count2;
@@ -245,18 +295,22 @@ gen_prime( unsigned  nbits, int secret, int randomlevel )
     mods = m_alloc( no_of_small_prime_numbers * sizeof *mods );
     /* make nbits fit into MPI implementation */
     nlimbs = (nbits + BITS_PER_MPI_LIMB - 1) / BITS_PER_MPI_LIMB;
-    assert( nlimbs );
-    val_2  = mpi_alloc( nlimbs );
-    mpi_set_ui(val_2, 2);
-    val_3  = mpi_alloc( nlimbs );
-    mpi_set_ui(val_3, 3);
-    result = mpi_alloc( nlimbs );
+    val_2  = mpi_alloc_set_ui( 2 );
+    val_3 = mpi_alloc_set_ui( 3);
     prime  = secret? mpi_alloc_secure( nlimbs ): mpi_alloc( nlimbs );
+    result = mpi_alloc_like( prime );
+    pminus1= mpi_alloc_like( prime );
+    ptest  = mpi_alloc_like( prime );
     count1 = count2 = 0;
-    /* enter (endless) loop */
-    for(;;) {
+    for(;;) {  /* try forvever */
+       int dotcount=0;
+
        /* generate a random number */
-       mpi_set_bytes( prime, nbits, get_random_byte, randomlevel );
+       {   char *p = get_random_bits( nbits, randomlevel, secret );
+           mpi_set_buffer( prime, p, (nbits+7)/8, 0 );
+           m_free(p);
+       }
+
        /* set high order bit to 1, set low order bit to 1 */
        mpi_set_highbit( prime, nbits-1 );
        mpi_set_bit( prime, 0 );
@@ -265,6 +319,7 @@ gen_prime( unsigned  nbits, int secret, int randomlevel )
        for(i=0; (x = small_prime_numbers[i]); i++ )
            mods[i] = mpi_fdiv_r_ui(NULL, prime, x);
 
+       /* now try some primes starting with prime */
        for(step=0; step < 20000; step += 2 ) {
            /* check against all the small primes we have in mods */
            count1++;
@@ -275,52 +330,46 @@ gen_prime( unsigned  nbits, int secret, int randomlevel )
                    break;
            }
            if( x )
-               continue;   /* found a multiple of a already known prime */
+               continue;   /* found a multiple of an already known prime */
 
-           mpi_add_ui( prime, prime, step );
+           mpi_add_ui( ptest, prime, step );
 
-          #if 0
-           /* do a Fermat test */
+           /* do a faster Fermat test */
            count2++;
-           mpi_powm( result, val_2, prime, prime );
-           if( mpi_cmp_ui(result, 2) )
-               continue;  /* stepping (fermat test failed) */
-           fputc('+', stderr);
-          #endif
-
-           /* perform stronger tests */
-           if( is_prime(prime, 5, &count2 ) ) {
-               if( !mpi_test_bit( prime, nbits-1 ) ) {
-                   if( 0 && DBG_CIPHER ) {
-                       fputc('\n', stderr);
+           mpi_sub_ui( pminus1, ptest, 1);
+           mpi_powm( result, val_2, pminus1, ptest );
+           if( !mpi_cmp_ui( result, 1 ) ) { /* not composite */
+               /* perform stronger tests */
+               if( is_prime(ptest, 5, &count2 ) ) {
+                   if( !mpi_test_bit( ptest, nbits-1 ) ) {
+                       progress('\n');
                        log_debug("overflow in prime generation\n");
-                       break; /* step loop, cont with a new prime */
+                       break; /* step loop, continue with a new prime */
                    }
-               }
 
-               if( 0 && DBG_CIPHER ) {
-                   log_debug("performed %u simple and %u stronger tests\n",
-                                       count1, count2 );
-                   log_mpidump("found prime: ", prime );
+                   mpi_free(val_2);
+                   mpi_free(val_3);
+                   mpi_free(result);
+                   mpi_free(pminus1);
+                   mpi_free(prime);
+                   m_free(mods);
+                   return ptest;
                }
-
-               mpi_free(val_2);
-               mpi_free(val_3);
-               mpi_free(result);
-               m_free(mods);
-               return prime;
            }
-           fputc('.', stderr);
+           if( ++dotcount == 10 ) {
+               progress('.');
+               dotcount = 0;
+           }
        }
-       fputc(':', stderr); /* restart with a new random value */
+       progress(':'); /* restart with a new random value */
     }
 }
 
 /****************
- * Returns: true if this is may me a prime
+ * Returns: true if this may be a prime
  */
 static int
-check_prime( MPI prime )
+check_prime( MPI prime, MPI val_2 )
 {
     int i;
     unsigned x;
@@ -332,30 +381,31 @@ check_prime( MPI prime )
            return 0;
     }
 
-  #if 0
-    result = mpi_alloc( mpi_get_nlimbs(prime) );
-    val_2  = mpi_alloc_set_ui( 2 );
-    mpi_powm( result, val_2, prime, prime );
-    if( mpi_cmp_ui(result, 2) ) {
-       mpi_free(result);
-       mpi_free(val_2);
-       return 0;
+    /* a quick fermat test */
+    {
+       MPI result = mpi_alloc_like( prime );
+       MPI pminus1 = mpi_alloc_like( prime );
+       mpi_sub_ui( pminus1, prime, 1);
+       mpi_powm( result, val_2, pminus1, prime );
+       mpi_free( pminus1 );
+       if( mpi_cmp_ui( result, 1 ) ) { /* if composite */
+           mpi_free( result );
+           progress('.');
+           return 0;
+       }
+       mpi_free( result );
     }
-    mpi_free(result);
-    mpi_free(val_2);
-    fputc('+', stderr);
-  #endif
 
     /* perform stronger tests */
     if( is_prime(prime, 5, &count ) )
        return 1; /* is probably a prime */
-    fputc('.', stderr);
+    progress('.');
     return 0;
 }
 
 
 /****************
- * Return true if n is propably a prime
+ * Return true if n is probably a prime
  */
 static int
 is_prime( MPI n, int steps, int *count )
@@ -383,8 +433,13 @@ is_prime( MPI n, int steps, int *count )
            mpi_set_ui( x, 2 );
        }
        else {
-           mpi_set_bytes( x, nbits-1, get_random_byte, 0 );
-           /* work around a bug in mpi_set_bytes */
+           /*mpi_set_bytes( x, nbits-1, get_random_byte, 0 );*/
+           {   char *p = get_random_bits( nbits, 0, 0 );
+               mpi_set_buffer( x, p, (nbits+7)/8, 0 );
+               m_free(p);
+           }
+           /* make sure that the number is smaller than the prime
+            * and keep the randomness of the high bit */
            if( mpi_test_bit( x, nbits-2 ) ) {
                mpi_set_highbit( x, nbits-2 ); /* clear all higher bits */
            }
@@ -404,7 +459,7 @@ is_prime( MPI n, int steps, int *count )
            if( mpi_cmp( y, nminus1 ) )
                goto leave; /* not a prime */
        }
-       fputc('+', stderr);
+       progress('+');
     }
     rc = 1; /* may be a prime */