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