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