See ChangeLog: Mon Jul 17 16:35:47 CEST 2000 Werner Koch
[gnupg.git] / cipher / primegen.c
1 /* primegen.c - prime number generator
2  *      Copyright (C) 1998, 2000 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  *
20  * ***********************************************************************
21  * The algorithm used to generate practically save primes is due to
22  * Lim and Lee as described in the CRYPTO '97 proceedings (ISBN3540633847)
23  * page 260.
24  */
25
26 #include <config.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <assert.h>
31 #include "g10lib.h"
32 #include "mpi.h"
33 #include "cipher.h"
34
35 static int no_of_small_prime_numbers;
36 static MPI gen_prime( unsigned  nbits, int mode, int randomlevel );
37 static int check_prime( MPI prime, MPI val_2 );
38 static int is_prime( MPI n, int steps, int *count );
39 static void m_out_of_n( char *array, int m, int n );
40
41 static void (*progress_cb) ( void *, int );
42 static void *progress_cb_data;
43
44 void
45 register_primegen_progress ( void (*cb)( void *, int), void *cb_data )
46 {
47     progress_cb = cb;
48     progress_cb_data = cb_data;
49 }
50
51
52 static void
53 progress( int c )
54 {
55     if ( progress_cb )
56         progress_cb ( progress_cb_data, c );
57     else
58         fputc( c, stderr );
59 }
60
61
62 /****************
63  * Generate a prime number (stored in secure memory)
64  */
65 MPI
66 generate_secret_prime( unsigned  nbits )
67 {
68     MPI prime;
69
70     prime = gen_prime( nbits, 1, 2 );
71     progress('\n');
72     return prime;
73 }
74
75 MPI
76 generate_public_prime( unsigned  nbits )
77 {
78     MPI prime;
79
80     prime = gen_prime( nbits, 0, 2 );
81     progress('\n');
82     return prime;
83 }
84
85
86 /****************
87  * We do not need to use the strongest RNG because we gain no extra
88  * security from it - The prime number is public and we could also
89  * offer the factors for those who are willing to check that it is
90  * indeed a strong prime.
91  *
92  * mode 0: Standard
93  *      1: Make sure that at least one factor is of size qbits.
94  */
95 MPI
96 generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
97                     MPI g, MPI **ret_factors )
98 {
99     int n;  /* number of factors */
100     int m;  /* number of primes in pool */
101     unsigned fbits; /* length of prime factors */
102     MPI *factors; /* current factors */
103     MPI *pool;  /* pool of primes */
104     MPI q;      /* first prime factor (variable)*/
105     MPI prime;  /* prime test value */
106     MPI q_factor; /* used for mode 1 */
107     byte *perms = NULL;
108     int i, j;
109     int count1, count2;
110     unsigned nprime;
111     unsigned req_qbits = qbits; /* the requested q bits size */
112     MPI val_2  = mpi_alloc_set_ui( 2 );
113
114     /* find number of needed prime factors */
115     for(n=1; (pbits - qbits - 1) / n  >= qbits; n++ )
116         ;
117     n--;
118     if( !n || (mode==1 && n < 2) )
119         log_fatal("can't gen prime with pbits=%u qbits=%u\n", pbits, qbits );
120     if( mode == 1 ) {
121         n--;
122         fbits = (pbits - 2*req_qbits -1) / n;
123         qbits =  pbits - req_qbits - n*fbits;
124     }
125     else {
126         fbits = (pbits - req_qbits -1) / n;
127         qbits = pbits - n*fbits;
128     }
129     if( DBG_CIPHER )
130         log_debug("gen prime: pbits=%u qbits=%u fbits=%u/%u n=%d\n",
131                     pbits, req_qbits, qbits, fbits, n  );
132     prime = mpi_alloc( (pbits + BITS_PER_MPI_LIMB - 1) /  BITS_PER_MPI_LIMB );
133     q = gen_prime( qbits, 0, 0 );
134     q_factor = mode==1? gen_prime( req_qbits, 0, 0 ) : NULL;
135
136     /* allocate an array to hold the factors + 2 for later usage */
137     factors = g10_xcalloc( n+2, sizeof *factors );
138
139     /* make a pool of 3n+5 primes (this is an arbitrary value) */
140     m = n*3+5;
141     if( mode == 1 )
142         m += 5; /* need some more for DSA */
143     if( m < 25 )
144         m = 25;
145     pool = g10_xcalloc( m , sizeof *pool );
146
147     /* permutate over the pool of primes */
148     count1=count2=0;
149     do {
150       next_try:
151         if( !perms ) {
152             /* allocate new primes */
153             for(i=0; i < m; i++ ) {
154                 mpi_free(pool[i]);
155                 pool[i] = NULL;
156             }
157             /* init m_out_of_n() */
158             perms = g10_xcalloc( 1, m );
159             for(i=0; i < n; i++ ) {
160                 perms[i] = 1;
161                 pool[i] = gen_prime( fbits, 0, 1 );
162                 factors[i] = pool[i];
163             }
164         }
165         else {
166             m_out_of_n( perms, n, m );
167             for(i=j=0; i < m && j < n ; i++ )
168                 if( perms[i] ) {
169                     if( !pool[i] )
170                         pool[i] = gen_prime( fbits, 0, 1 );
171                     factors[j++] = pool[i];
172                 }
173             if( i == n ) {
174                 g10_free(perms); perms = NULL;
175                 progress('!');
176                 goto next_try;  /* allocate new primes */
177             }
178         }
179
180         mpi_set( prime, q );
181         mpi_mul_ui( prime, prime, 2 );
182         if( mode == 1 )
183             mpi_mul( prime, prime, q_factor );
184         for(i=0; i < n; i++ )
185             mpi_mul( prime, prime, factors[i] );
186         mpi_add_ui( prime, prime, 1 );
187         nprime = mpi_get_nbits(prime);
188         if( nprime < pbits ) {
189             if( ++count1 > 20 ) {
190                 count1 = 0;
191                 qbits++;
192                 progress('>');
193                 q = gen_prime( qbits, 0, 0 );
194                 goto next_try;
195             }
196         }
197         else
198             count1 = 0;
199         if( nprime > pbits ) {
200             if( ++count2 > 20 ) {
201                 count2 = 0;
202                 qbits--;
203                 progress('<');
204                 q = gen_prime( qbits, 0, 0 );
205                 goto next_try;
206             }
207         }
208         else
209             count2 = 0;
210     } while( !(nprime == pbits && check_prime( prime, val_2 )) );
211
212     if( DBG_CIPHER ) {
213         progress('\n');
214         log_mpidump( "prime    : ", prime );
215         log_mpidump( "factor  q: ", q );
216         if( mode == 1 )
217             log_mpidump( "factor q0: ", q_factor );
218         for(i=0; i < n; i++ )
219             log_mpidump( "factor pi: ", factors[i] );
220         log_debug("bit sizes: prime=%u, q=%u", mpi_get_nbits(prime), mpi_get_nbits(q) );
221         if( mode == 1 )
222             fprintf(stderr, ", q0=%u", mpi_get_nbits(q_factor) );
223         for(i=0; i < n; i++ )
224             fprintf(stderr, ", p%d=%u", i, mpi_get_nbits(factors[i]) );
225         progress('\n');
226     }
227
228     if( ret_factors ) { /* caller wants the factors */
229         *ret_factors = g10_xcalloc( n+2 , sizeof **ret_factors);
230         if( mode == 1 ) {
231             i = 0;
232             (*ret_factors)[i++] = mpi_copy( q_factor );
233             for(; i <= n; i++ )
234                 (*ret_factors)[i] = mpi_copy( factors[i] );
235         }
236         else {
237             for(i=0; i < n; i++ )
238                 (*ret_factors)[i] = mpi_copy( factors[i] );
239         }
240     }
241
242     if( g ) { /* create a generator (start with 3)*/
243         MPI tmp   = mpi_alloc( mpi_get_nlimbs(prime) );
244         MPI b     = mpi_alloc( mpi_get_nlimbs(prime) );
245         MPI pmin1 = mpi_alloc( mpi_get_nlimbs(prime) );
246
247         if( mode == 1 )
248             BUG(); /* not yet implemented */
249         factors[n] = q;
250         factors[n+1] = mpi_alloc_set_ui(2);
251         mpi_sub_ui( pmin1, prime, 1 );
252         mpi_set_ui(g,2);
253         do {
254             mpi_add_ui(g, g, 1);
255             if( DBG_CIPHER ) {
256                 log_debug("checking g: ");
257                 /*mpi_print( stderr, g, 1 );*/
258                 #warning we need an internal mpi_print for debugging
259             }
260             else
261                 progress('^');
262             for(i=0; i < n+2; i++ ) {
263                 /*fputc('~', stderr);*/
264                 mpi_fdiv_q(tmp, pmin1, factors[i] );
265                 /* (no mpi_pow(), but it is okay to use this with mod prime) */
266                 gcry_mpi_powm(b, g, tmp, prime );
267                 if( !mpi_cmp_ui(b, 1) )
268                     break;
269             }
270             if( DBG_CIPHER )
271                 progress('\n');
272         } while( i < n+2 );
273         mpi_free(factors[n+1]);
274         mpi_free(tmp);
275         mpi_free(b);
276         mpi_free(pmin1);
277     }
278     if( !DBG_CIPHER )
279         progress('\n');
280
281     g10_free( factors );  /* (factors are shallow copies) */
282     for(i=0; i < m; i++ )
283         mpi_free( pool[i] );
284     g10_free( pool );
285     g10_free(perms);
286     mpi_free(val_2);
287     return prime;
288 }
289
290
291
292 static MPI
293 gen_prime( unsigned  nbits, int secret, int randomlevel )
294 {
295     unsigned  nlimbs;
296     MPI prime, ptest, pminus1, val_2, val_3, result;
297     int i;
298     unsigned x, step;
299     unsigned count1, count2;
300     int *mods;
301
302     if( 0 && DBG_CIPHER )
303         log_debug("generate a prime of %u bits ", nbits );
304
305     if( !no_of_small_prime_numbers ) {
306         for(i=0; small_prime_numbers[i]; i++ )
307             no_of_small_prime_numbers++;
308     }
309     mods = g10_xmalloc( no_of_small_prime_numbers * sizeof *mods );
310     /* make nbits fit into MPI implementation */
311     nlimbs = (nbits + BITS_PER_MPI_LIMB - 1) /  BITS_PER_MPI_LIMB;
312     val_2  = mpi_alloc_set_ui( 2 );
313     val_3 = mpi_alloc_set_ui( 3);
314     prime  = secret? mpi_alloc_secure( nlimbs ): mpi_alloc( nlimbs );
315     result = mpi_alloc_like( prime );
316     pminus1= mpi_alloc_like( prime );
317     ptest  = mpi_alloc_like( prime );
318     count1 = count2 = 0;
319     for(;;) {  /* try forvever */
320         int dotcount=0;
321
322         /* generate a random number */
323         gcry_mpi_randomize( prime, nbits, randomlevel );
324
325         /* set high order bit to 1, set low order bit to 1 */
326         mpi_set_highbit( prime, nbits-1 );
327         mpi_set_bit( prime, 0 );
328
329         /* calculate all remainders */
330         for(i=0; (x = small_prime_numbers[i]); i++ )
331             mods[i] = mpi_fdiv_r_ui(NULL, prime, x);
332
333         /* now try some primes starting with prime */
334         for(step=0; step < 20000; step += 2 ) {
335             /* check against all the small primes we have in mods */
336             count1++;
337             for(i=0; (x = small_prime_numbers[i]); i++ ) {
338                 while( mods[i] + step >= x )
339                     mods[i] -= x;
340                 if( !(mods[i] + step) )
341                     break;
342             }
343             if( x )
344                 continue;   /* found a multiple of an already known prime */
345
346             mpi_add_ui( ptest, prime, step );
347
348             /* do a faster Fermat test */
349             count2++;
350             mpi_sub_ui( pminus1, ptest, 1);
351             gcry_mpi_powm( result, val_2, pminus1, ptest );
352             if( !mpi_cmp_ui( result, 1 ) ) { /* not composite */
353                 /* perform stronger tests */
354                 if( is_prime(ptest, 5, &count2 ) ) {
355                     if( !mpi_test_bit( ptest, nbits-1 ) ) {
356                         progress('\n');
357                         log_debug("overflow in prime generation\n");
358                         break; /* step loop, continue with a new prime */
359                     }
360
361                     mpi_free(val_2);
362                     mpi_free(val_3);
363                     mpi_free(result);
364                     mpi_free(pminus1);
365                     mpi_free(prime);
366                     g10_free(mods);
367                     return ptest;
368                 }
369             }
370             if( ++dotcount == 10 ) {
371                 progress('.');
372                 dotcount = 0;
373             }
374         }
375         progress(':'); /* restart with a new random value */
376     }
377 }
378
379 /****************
380  * Returns: true if this may be a prime
381  */
382 static int
383 check_prime( MPI prime, MPI val_2 )
384 {
385     int i;
386     unsigned x;
387     int count=0;
388
389     /* check against small primes */
390     for(i=0; (x = small_prime_numbers[i]); i++ ) {
391         if( mpi_divisible_ui( prime, x ) )
392             return 0;
393     }
394
395     /* a quick fermat test */
396     {
397         MPI result = mpi_alloc_like( prime );
398         MPI pminus1 = mpi_alloc_like( prime );
399         mpi_sub_ui( pminus1, prime, 1);
400         gcry_mpi_powm( result, val_2, pminus1, prime );
401         mpi_free( pminus1 );
402         if( mpi_cmp_ui( result, 1 ) ) { /* if composite */
403             mpi_free( result );
404             progress('.');
405             return 0;
406         }
407         mpi_free( result );
408     }
409
410     /* perform stronger tests */
411     if( is_prime(prime, 5, &count ) )
412         return 1; /* is probably a prime */
413     progress('.');
414     return 0;
415 }
416
417
418 /****************
419  * Return true if n is probably a prime
420  */
421 static int
422 is_prime( MPI n, int steps, int *count )
423 {
424     MPI x = mpi_alloc( mpi_get_nlimbs( n ) );
425     MPI y = mpi_alloc( mpi_get_nlimbs( n ) );
426     MPI z = mpi_alloc( mpi_get_nlimbs( n ) );
427     MPI nminus1 = mpi_alloc( mpi_get_nlimbs( n ) );
428     MPI a2 = mpi_alloc_set_ui( 2 );
429     MPI q;
430     unsigned i, j, k;
431     int rc = 0;
432     unsigned nbits = mpi_get_nbits( n );
433
434     mpi_sub_ui( nminus1, n, 1 );
435
436     /* find q and k, so that n = 1 + 2^k * q */
437     q = mpi_copy( nminus1 );
438     k = mpi_trailing_zeros( q );
439     mpi_tdiv_q_2exp(q, q, k);
440
441     for(i=0 ; i < steps; i++ ) {
442         ++*count;
443         if( !i ) {
444             mpi_set_ui( x, 2 );
445         }
446         else {
447             gcry_mpi_randomize( x, nbits, GCRY_WEAK_RANDOM );
448
449             /* make sure that the number is smaller than the prime
450              * and keep the randomness of the high bit */
451             if( mpi_test_bit( x, nbits-2 ) ) {
452                 mpi_set_highbit( x, nbits-2 ); /* clear all higher bits */
453             }
454             else {
455                 mpi_set_highbit( x, nbits-2 );
456                 mpi_clear_bit( x, nbits-2 );
457             }
458             assert( mpi_cmp( x, nminus1 ) < 0 && mpi_cmp_ui( x, 1 ) > 0 );
459         }
460         gcry_mpi_powm( y, x, q, n);
461         if( mpi_cmp_ui(y, 1) && mpi_cmp( y, nminus1 ) ) {
462             for( j=1; j < k && mpi_cmp( y, nminus1 ); j++ ) {
463                 gcry_mpi_powm(y, y, a2, n);
464                 if( !mpi_cmp_ui( y, 1 ) )
465                     goto leave; /* not a prime */
466             }
467             if( mpi_cmp( y, nminus1 ) )
468                 goto leave; /* not a prime */
469         }
470         progress('+');
471     }
472     rc = 1; /* may be a prime */
473
474   leave:
475     mpi_free( x );
476     mpi_free( y );
477     mpi_free( z );
478     mpi_free( nminus1 );
479     mpi_free( q );
480
481     return rc;
482 }
483
484
485 static void
486 m_out_of_n( char *array, int m, int n )
487 {
488     int i=0, i1=0, j=0, jp=0,  j1=0, k1=0, k2=0;
489
490     if( !m || m >= n )
491         return;
492
493     if( m == 1 ) { /* special case */
494         for(i=0; i < n; i++ )
495             if( array[i] ) {
496                 array[i++] = 0;
497                 if( i >= n )
498                     i = 0;
499                 array[i] = 1;
500                 return;
501             }
502         BUG();
503     }
504
505     for(j=1; j < n; j++ ) {
506         if( array[n-1] == array[n-j-1] )
507             continue;
508         j1 = j;
509         break;
510     }
511
512     if( m & 1 ) { /* m is odd */
513         if( array[n-1] ) {
514             if( j1 & 1 ) {
515                 k1 = n - j1;
516                 k2 = k1+2;
517                 if( k2 > n )
518                     k2 = n;
519                 goto leave;
520             }
521             goto scan;
522         }
523         k2 = n - j1 - 1;
524         if( k2 == 0 ) {
525             k1 = i;
526             k2 = n - j1;
527         }
528         else if( array[k2] && array[k2-1] )
529             k1 = n;
530         else
531             k1 = k2 + 1;
532     }
533     else { /* m is even */
534         if( !array[n-1] ) {
535             k1 = n - j1;
536             k2 = k1 + 1;
537             goto leave;
538         }
539
540         if( !(j1 & 1) ) {
541             k1 = n - j1;
542             k2 = k1+2;
543             if( k2 > n )
544                 k2 = n;
545             goto leave;
546         }
547       scan:
548         jp = n - j1 - 1;
549         for(i=1; i <= jp; i++ ) {
550             i1 = jp + 2 - i;
551             if( array[i1-1]  ) {
552                 if( array[i1-2] ) {
553                     k1 = i1 - 1;
554                     k2 = n - j1;
555                 }
556                 else {
557                     k1 = i1 - 1;
558                     k2 = n + 1 - j1;
559                 }
560                 goto leave;
561             }
562         }
563         k1 = 1;
564         k2 = n + 1 - m;
565     }
566   leave:
567     array[k1-1] = !array[k1-1];
568     array[k2-1] = !array[k2-1];
569 }
570