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