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