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