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