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