release 0.2.3
[libgcrypt.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, MPI **ret_factors )
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; /* current 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     if( DBG_CIPHER ) {
171         putc('\n', stderr);
172         log_mpidump( "prime    : ", prime );
173         log_mpidump( "factor  q: ", q );
174         for(i=0; i < n; i++ )
175             log_mpidump( "factor pi: ", factors[i] );
176         log_debug("bit sizes: prime=%u, q=%u", mpi_get_nbits(prime), mpi_get_nbits(q) );
177         for(i=0; i < n; i++ )
178             fprintf(stderr, ", p%d=%u", i, mpi_get_nbits(factors[i]) );
179         putc('\n', stderr);
180     }
181
182     if( ret_factors ) { /* caller wants the factors */
183         *ret_factors = m_alloc_clear( (n+1) * sizeof **ret_factors );
184         for(i=0; i < n; i++ )
185             (*ret_factors)[i] = mpi_copy( factors[i] );
186     }
187
188     if( g ) { /* create a generator (start with 3)*/
189         MPI tmp   = mpi_alloc( mpi_get_nlimbs(prime) );
190         MPI b     = mpi_alloc( mpi_get_nlimbs(prime) );
191         MPI pmin1 = mpi_alloc( mpi_get_nlimbs(prime) );
192
193         factors[n] = q;
194         factors[n+1] = mpi_alloc_set_ui(2);
195         mpi_sub_ui( pmin1, prime, 1 );
196         mpi_set_ui(g,2);
197         do {
198             mpi_add_ui(g, g, 1);
199             if( DBG_CIPHER ) {
200                 log_debug("checking g: ");
201                 mpi_print( stderr, g, 1 );
202             }
203             else
204                 fputc('^', stderr);
205             for(i=0; i < n+2; i++ ) {
206                 fputc('~', stderr);
207                 mpi_fdiv_q(tmp, pmin1, factors[i] );
208                 /* (no mpi_pow(), but it is okay to use this with mod prime) */
209                 mpi_powm(b, g, tmp, prime );
210                 if( !mpi_cmp_ui(b, 1) )
211                     break;
212             }
213             if( DBG_CIPHER )
214                 fputc('\n', stderr);
215         } while( i < n+2 );
216         mpi_free(factors[n+1]);
217         mpi_free(tmp);
218         mpi_free(b);
219         mpi_free(pmin1);
220     }
221     if( !DBG_CIPHER )
222         putc('\n', stderr);
223
224     m_free( factors );  /* (factors are shallow copies) */
225     for(i=0; i < m; i++ )
226         mpi_free( pool[i] );
227     m_free( pool );
228     m_free(perms);
229     return prime;
230 }
231
232
233 static MPI
234 gen_prime( unsigned  nbits, int secret, int randomlevel )
235 {
236     unsigned  nlimbs;
237     MPI prime, val_2, val_3, result;
238     int i;
239     unsigned x, step;
240     unsigned count1, count2;
241     int *mods;
242
243     if( 0 && DBG_CIPHER )
244         log_debug("generate a prime of %u bits ", nbits );
245
246     if( !no_of_small_prime_numbers ) {
247         for(i=0; small_prime_numbers[i]; i++ )
248             no_of_small_prime_numbers++;
249     }
250     mods = m_alloc( no_of_small_prime_numbers * sizeof *mods );
251     /* make nbits fit into MPI implementation */
252     nlimbs = (nbits + BITS_PER_MPI_LIMB - 1) /  BITS_PER_MPI_LIMB;
253     assert( nlimbs );
254     val_2  = mpi_alloc( nlimbs );
255     mpi_set_ui(val_2, 2);
256     val_3  = mpi_alloc( nlimbs );
257     mpi_set_ui(val_3, 3);
258     result = mpi_alloc( nlimbs );
259     prime  = secret? mpi_alloc_secure( nlimbs ): mpi_alloc( nlimbs );
260     count1 = count2 = 0;
261     /* enter (endless) loop */
262     for(;;) {
263         /* generate a random number */
264         mpi_set_bytes( prime, nbits, get_random_byte, randomlevel );
265         /* set high order bit to 1, set low order bit to 1 */
266         mpi_set_highbit( prime, nbits-1 );
267         mpi_set_bit( prime, 0 );
268
269         /* calculate all remainders */
270         for(i=0; (x = small_prime_numbers[i]); i++ )
271             mods[i] = mpi_fdiv_r_ui(NULL, prime, x);
272
273         for(step=0; step < 20000; step += 2 ) {
274             /* check against all the small primes we have in mods */
275             count1++;
276             for(i=0; (x = small_prime_numbers[i]); i++ ) {
277                 while( mods[i] + step >= x )
278                     mods[i] -= x;
279                 if( !(mods[i] + step) )
280                     break;
281             }
282             if( x )
283                 continue;   /* found a multiple of a already known prime */
284
285             mpi_add_ui( prime, prime, step );
286
287            #if 0
288             /* do a Fermat test */
289             count2++;
290             mpi_powm( result, val_2, prime, prime );
291             if( mpi_cmp_ui(result, 2) )
292                 continue;  /* stepping (fermat test failed) */
293             fputc('+', stderr);
294            #endif
295
296             /* perform stronger tests */
297             if( is_prime(prime, 5, &count2 ) ) {
298                 if( !mpi_test_bit( prime, nbits-1 ) ) {
299                     if( 0 && DBG_CIPHER ) {
300                         fputc('\n', stderr);
301                         log_debug("overflow in prime generation\n");
302                         break; /* step loop, cont with a new prime */
303                     }
304                 }
305
306                 if( 0 && DBG_CIPHER ) {
307                     log_debug("performed %u simple and %u stronger tests\n",
308                                         count1, count2 );
309                     log_mpidump("found prime: ", prime );
310                 }
311
312                 mpi_free(val_2);
313                 mpi_free(val_3);
314                 mpi_free(result);
315                 m_free(mods);
316                 return prime;
317             }
318             fputc('.', stderr);
319         }
320         fputc(':', stderr); /* restart with a new random value */
321     }
322 }
323
324 /****************
325  * Returns: true if this is may me a prime
326  */
327 static int
328 check_prime( MPI prime )
329 {
330     int i;
331     unsigned x;
332     int count=0;
333
334     /* check against small primes */
335     for(i=0; (x = small_prime_numbers[i]); i++ ) {
336         if( mpi_divisible_ui( prime, x ) )
337             return 0;
338     }
339
340   #if 0
341     result = mpi_alloc( mpi_get_nlimbs(prime) );
342     val_2  = mpi_alloc_set_ui( 2 );
343     mpi_powm( result, val_2, prime, prime );
344     if( mpi_cmp_ui(result, 2) ) {
345         mpi_free(result);
346         mpi_free(val_2);
347         return 0;
348     }
349     mpi_free(result);
350     mpi_free(val_2);
351     fputc('+', stderr);
352   #endif
353
354     /* perform stronger tests */
355     if( is_prime(prime, 5, &count ) )
356         return 1; /* is probably a prime */
357     fputc('.', stderr);
358     return 0;
359 }
360
361
362 /****************
363  * Return true if n is propably a prime
364  */
365 static int
366 is_prime( MPI n, int steps, int *count )
367 {
368     MPI x = mpi_alloc( mpi_get_nlimbs( n ) );
369     MPI y = mpi_alloc( mpi_get_nlimbs( n ) );
370     MPI z = mpi_alloc( mpi_get_nlimbs( n ) );
371     MPI nminus1 = mpi_alloc( mpi_get_nlimbs( n ) );
372     MPI a2 = mpi_alloc_set_ui( 2 );
373     MPI q;
374     unsigned i, j, k;
375     int rc = 0;
376     unsigned nbits = mpi_get_nbits( n );
377
378     mpi_sub_ui( nminus1, n, 1 );
379
380     /* find q and k, so that n = 1 + 2^k * q */
381     q = mpi_copy( nminus1 );
382     k = mpi_trailing_zeros( q );
383     mpi_tdiv_q_2exp(q, q, k);
384
385     for(i=0 ; i < steps; i++ ) {
386         ++*count;
387         if( !i ) {
388             mpi_set_ui( x, 2 );
389         }
390         else {
391             mpi_set_bytes( x, nbits-1, get_random_byte, 0 );
392             /* work around a bug in mpi_set_bytes */
393             if( mpi_test_bit( x, nbits-2 ) ) {
394                 mpi_set_highbit( x, nbits-2 ); /* clear all higher bits */
395             }
396             else {
397                 mpi_set_highbit( x, nbits-2 );
398                 mpi_clear_bit( x, nbits-2 );
399             }
400             assert( mpi_cmp( x, nminus1 ) < 0 && mpi_cmp_ui( x, 1 ) > 0 );
401         }
402         mpi_powm( y, x, q, n);
403         if( mpi_cmp_ui(y, 1) && mpi_cmp( y, nminus1 ) ) {
404             for( j=1; j < k && mpi_cmp( y, nminus1 ); j++ ) {
405                 mpi_powm(y, y, a2, n);
406                 if( !mpi_cmp_ui( y, 1 ) )
407                     goto leave; /* not a prime */
408             }
409             if( mpi_cmp( y, nminus1 ) )
410                 goto leave; /* not a prime */
411         }
412         fputc('+', stderr);
413     }
414     rc = 1; /* may be a prime */
415
416   leave:
417     mpi_free( x );
418     mpi_free( y );
419     mpi_free( z );
420     mpi_free( nminus1 );
421     mpi_free( q );
422
423     return rc;
424 }
425
426
427 static void
428 m_out_of_n( char *array, int m, int n )
429 {
430     int i=0, i1=0, j=0, jp=0,  j1=0, k1=0, k2=0;
431
432     if( !m || m >= n )
433         return;
434
435     if( m == 1 ) { /* special case */
436         for(i=0; i < n; i++ )
437             if( array[i] ) {
438                 array[i++] = 0;
439                 if( i >= n )
440                     i = 0;
441                 array[i] = 1;
442                 return;
443             }
444         BUG();
445     }
446
447     for(j=1; j < n; j++ ) {
448         if( array[n-1] == array[n-j-1] )
449             continue;
450         j1 = j;
451         break;
452     }
453
454     if( m & 1 ) { /* m is odd */
455         if( array[n-1] ) {
456             if( j1 & 1 ) {
457                 k1 = n - j1;
458                 k2 = k1+2;
459                 if( k2 > n )
460                     k2 = n;
461                 goto leave;
462             }
463             goto scan;
464         }
465         k2 = n - j1 - 1;
466         if( k2 == 0 ) {
467             k1 = i;
468             k2 = n - j1;
469         }
470         else if( array[k2] && array[k2-1] )
471             k1 = n;
472         else
473             k1 = k2 + 1;
474     }
475     else { /* m is even */
476         if( !array[n-1] ) {
477             k1 = n - j1;
478             k2 = k1 + 1;
479             goto leave;
480         }
481
482         if( !(j1 & 1) ) {
483             k1 = n - j1;
484             k2 = k1+2;
485             if( k2 > n )
486                 k2 = n;
487             goto leave;
488         }
489       scan:
490         jp = n - j1 - 1;
491         for(i=1; i <= jp; i++ ) {
492             i1 = jp + 2 - i;
493             if( array[i1-1]  ) {
494                 if( array[i1-2] ) {
495                     k1 = i1 - 1;
496                     k2 = n - j1;
497                 }
498                 else {
499                     k1 = i1 - 1;
500                     k2 = n + 1 - j1;
501                 }
502                 goto leave;
503             }
504         }
505         k1 = 1;
506         k2 = n + 1 - m;
507     }
508   leave:
509     array[k1-1] = !array[k1-1];
510     array[k2-1] = !array[k2-1];
511 }
512