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