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