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