Switched to GPLv3.
[gnupg.git] / cipher / elgamal.c
1 /* elgamal.c  -  elgamal Public Key encryption
2  * Copyright (C) 1998, 2000, 2001, 2003,
3  *               2004 Free Software Foundation, Inc.
4  *
5  * For a description of the algorithm, see:
6  *   Bruce Schneier: Applied Cryptography. John Wiley & Sons, 1996.
7  *   ISBN 0-471-11709-9. Pages 476 ff.
8  *
9  * This file is part of GnuPG.
10  *
11  * GnuPG is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * GnuPG is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, see <http://www.gnu.org/licenses/>.
23  */
24
25 #include <config.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include "util.h"
30 #include "mpi.h"
31 #include "cipher.h"
32 #include "elgamal.h"
33
34 typedef struct {
35     MPI p;          /* prime */
36     MPI g;          /* group generator */
37     MPI y;          /* g^x mod p */
38 } ELG_public_key;
39
40
41 typedef struct {
42     MPI p;          /* prime */
43     MPI g;          /* group generator */
44     MPI y;          /* g^x mod p */
45     MPI x;          /* secret exponent */
46 } ELG_secret_key;
47
48
49 static void test_keys( ELG_secret_key *sk, unsigned nbits );
50 static MPI gen_k( MPI p, int small_k );
51 static void generate( ELG_secret_key *sk, unsigned nbits, MPI **factors );
52 static int  check_secret_key( ELG_secret_key *sk );
53 static void do_encrypt(MPI a, MPI b, MPI input, ELG_public_key *pkey );
54 static void decrypt(MPI output, MPI a, MPI b, ELG_secret_key *skey );
55
56
57 static void (*progress_cb) ( void *, int );
58 static void *progress_cb_data;
59
60 void
61 register_pk_elg_progress ( void (*cb)( void *, int), void *cb_data )
62 {
63     progress_cb = cb;
64     progress_cb_data = cb_data;
65 }
66
67
68 static void
69 progress( int c )
70 {
71     if ( progress_cb )
72         progress_cb ( progress_cb_data, c );
73     else
74         fputc( c, stderr );
75 }
76
77
78 /****************
79  * Michael Wiener's table about subgroup sizes to match field sizes
80  * (floating around somewhere - Fixme: need a reference)
81  */
82 static unsigned int
83 wiener_map( unsigned int n )
84 {
85     static struct { unsigned int p_n, q_n; } t[] =
86     {   /*   p    q      attack cost */
87         {  512, 119 },  /* 9 x 10^17 */
88         {  768, 145 },  /* 6 x 10^21 */
89         { 1024, 165 },  /* 7 x 10^24 */
90         { 1280, 183 },  /* 3 x 10^27 */
91         { 1536, 198 },  /* 7 x 10^29 */
92         { 1792, 212 },  /* 9 x 10^31 */
93         { 2048, 225 },  /* 8 x 10^33 */
94         { 2304, 237 },  /* 5 x 10^35 */
95         { 2560, 249 },  /* 3 x 10^37 */
96         { 2816, 259 },  /* 1 x 10^39 */
97         { 3072, 269 },  /* 3 x 10^40 */
98         { 3328, 279 },  /* 8 x 10^41 */
99         { 3584, 288 },  /* 2 x 10^43 */
100         { 3840, 296 },  /* 4 x 10^44 */
101         { 4096, 305 },  /* 7 x 10^45 */
102         { 4352, 313 },  /* 1 x 10^47 */
103         { 4608, 320 },  /* 2 x 10^48 */
104         { 4864, 328 },  /* 2 x 10^49 */
105         { 5120, 335 },  /* 3 x 10^50 */
106         { 0, 0 }
107     };
108     int i;
109
110     for(i=0; t[i].p_n; i++ )  {
111         if( n <= t[i].p_n )
112             return t[i].q_n;
113     }
114     /* not in table - use some arbitrary high number ;-) */
115     return  n / 8 + 200;
116 }
117
118 static void
119 test_keys( ELG_secret_key *sk, unsigned int nbits )
120 {
121     ELG_public_key pk;
122     MPI test = mpi_alloc( 0 );
123     MPI out1_a = mpi_alloc ( mpi_nlimb_hint_from_nbits (nbits) );
124     MPI out1_b = mpi_alloc ( mpi_nlimb_hint_from_nbits (nbits) );
125     MPI out2   = mpi_alloc ( mpi_nlimb_hint_from_nbits (nbits) );
126
127     pk.p = sk->p;
128     pk.g = sk->g;
129     pk.y = sk->y;
130
131     /*mpi_set_bytes( test, nbits, get_random_byte, 0 );*/
132     {   char *p = get_random_bits( nbits, 0, 0 );
133         mpi_set_buffer( test, p, (nbits+7)/8, 0 );
134         xfree(p);
135     }
136
137     do_encrypt( out1_a, out1_b, test, &pk );
138     decrypt( out2, out1_a, out1_b, sk );
139     if( mpi_cmp( test, out2 ) )
140         log_fatal("Elgamal operation: encrypt, decrypt failed\n");
141
142     mpi_free( test );
143     mpi_free( out1_a );
144     mpi_free( out1_b );
145     mpi_free( out2 );
146 }
147
148
149 /****************
150  * Generate a random secret exponent k from prime p, so that k is
151  * relatively prime to p-1.  With SMALL_K set, k will be selected for
152  * better encryption performance - this must never bee used signing!
153  */
154 static MPI
155 gen_k( MPI p, int small_k )
156 {
157     MPI k = mpi_alloc_secure( 0 );
158     MPI temp = mpi_alloc( mpi_get_nlimbs(p) );
159     MPI p_1 = mpi_copy(p);
160     unsigned int orig_nbits = mpi_get_nbits(p);
161     unsigned int nbits;
162     unsigned int nbytes;
163     char *rndbuf = NULL;
164
165     if (small_k)
166       {
167         /* Using a k much lesser than p is sufficient for encryption and
168          * it greatly improves the encryption performance.  We use
169          * Wiener's table and add a large safety margin.
170          */
171         nbits = wiener_map( orig_nbits ) * 3 / 2;
172         if( nbits >= orig_nbits )
173           BUG();
174       }
175     else
176       nbits = orig_nbits;
177
178     nbytes = (nbits+7)/8;
179     if( DBG_CIPHER )
180         log_debug("choosing a random k of %u bits", nbits);
181     mpi_sub_ui( p_1, p, 1);
182     for(;;) {
183         if( !rndbuf || nbits < 32 ) {
184             xfree(rndbuf);
185             rndbuf = get_random_bits( nbits, 1, 1 );
186         }
187         else { /* Change only some of the higher bits. */
188             /* We could impprove this by directly requesting more memory
189              * at the first call to get_random_bits() and use this the here
190              * maybe it is easier to do this directly in random.c
191              * Anyway, it is highly inlikely that we will ever reach this code
192              */
193             char *pp = get_random_bits( 32, 1, 1 );
194             memcpy( rndbuf,pp, 4 );
195             xfree(pp);
196         }
197         mpi_set_buffer( k, rndbuf, nbytes, 0 );
198
199         for(;;) {
200             if( !(mpi_cmp( k, p_1 ) < 0) ) {  /* check: k < (p-1) */
201                 if( DBG_CIPHER )
202                     progress('+');
203                 break; /* no  */
204             }
205             if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
206                 if( DBG_CIPHER )
207                     progress('-');
208                 break; /* no */
209             }
210             if( mpi_gcd( temp, k, p_1 ) )
211                 goto found;  /* okay, k is relatively prime to (p-1) */
212             mpi_add_ui( k, k, 1 );
213             if( DBG_CIPHER )
214                 progress('.');
215         }
216     }
217   found:
218     xfree(rndbuf);
219     if( DBG_CIPHER )
220         progress('\n');
221     mpi_free(p_1);
222     mpi_free(temp);
223
224     return k;
225 }
226
227 /****************
228  * Generate a key pair with a key of size NBITS
229  * Returns: 2 structures filles with all needed values
230  *          and an array with n-1 factors of (p-1)
231  */
232 static void
233 generate(  ELG_secret_key *sk, unsigned int nbits, MPI **ret_factors )
234 {
235     MPI p;    /* the prime */
236     MPI p_min1;
237     MPI g;
238     MPI x;    /* the secret exponent */
239     MPI y;
240     MPI temp;
241     unsigned int qbits;
242     unsigned int xbits;
243     byte *rndbuf;
244
245     p_min1 = mpi_alloc ( mpi_nlimb_hint_from_nbits (nbits) );
246     temp   = mpi_alloc ( mpi_nlimb_hint_from_nbits (nbits) );
247     qbits  = wiener_map ( nbits );
248     if( qbits & 1 ) /* better have a even one */
249         qbits++;
250     g = mpi_alloc(1);
251     p = generate_elg_prime( 0, nbits, qbits, g, ret_factors );
252     mpi_sub_ui(p_min1, p, 1);
253
254
255     /* select a random number which has these properties:
256      *   0 < x < p-1
257      * This must be a very good random number because this is the
258      * secret part.  The prime is public and may be shared anyway,
259      * so a random generator level of 1 is used for the prime.
260      *
261      * I don't see a reason to have a x of about the same size as the
262      * p.  It should be sufficient to have one about the size of q or
263      * the later used k plus a large safety margin. Decryption will be
264      * much faster with such an x.  Note that this is not optimal for
265      * signing keys becuase it makes an attack using accidential small
266      * K values even easier.  Well, one should not use ElGamal signing
267      * anyway.
268      */
269     xbits = qbits * 3 / 2;
270     if( xbits >= nbits )
271         BUG();
272     x = mpi_alloc_secure ( mpi_nlimb_hint_from_nbits (xbits) );
273     if( DBG_CIPHER )
274         log_debug("choosing a random x of size %u", xbits );
275     rndbuf = NULL;
276     do {
277         if( DBG_CIPHER )
278             progress('.');
279         if( rndbuf ) { /* change only some of the higher bits */
280             if( xbits < 16 ) {/* should never happen ... */
281                 xfree(rndbuf);
282                 rndbuf = get_random_bits( xbits, 2, 1 );
283             }
284             else {
285                 char *r = get_random_bits( 16, 2, 1 );
286                 memcpy(rndbuf, r, 16/8 );
287                 xfree(r);
288             }
289         }
290         else
291             rndbuf = get_random_bits( xbits, 2, 1 );
292         mpi_set_buffer( x, rndbuf, (xbits+7)/8, 0 );
293         mpi_clear_highbit( x, xbits+1 );
294     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, p_min1 )<0 ) );
295     xfree(rndbuf);
296
297     y = mpi_alloc ( mpi_nlimb_hint_from_nbits (nbits) );
298     mpi_powm( y, g, x, p );
299
300     if( DBG_CIPHER ) {
301         progress('\n');
302         log_mpidump("elg  p= ", p );
303         log_mpidump("elg  g= ", g );
304         log_mpidump("elg  y= ", y );
305         log_mpidump("elg  x= ", x );
306     }
307
308     /* copy the stuff to the key structures */
309     sk->p = p;
310     sk->g = g;
311     sk->y = y;
312     sk->x = x;
313
314     /* now we can test our keys (this should never fail!) */
315     test_keys( sk, nbits - 64 );
316
317     mpi_free( p_min1 );
318     mpi_free( temp   );
319 }
320
321
322 /****************
323  * Test whether the secret key is valid.
324  * Returns: if this is a valid key.
325  */
326 static int
327 check_secret_key( ELG_secret_key *sk )
328 {
329     int rc;
330     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
331
332     mpi_powm( y, sk->g, sk->x, sk->p );
333     rc = !mpi_cmp( y, sk->y );
334     mpi_free( y );
335     return rc;
336 }
337
338
339 static void
340 do_encrypt(MPI a, MPI b, MPI input, ELG_public_key *pkey )
341 {
342     MPI k;
343
344     /* Note: maybe we should change the interface, so that it
345      * is possible to check that input is < p and return an
346      * error code.
347      */
348
349     k = gen_k( pkey->p, 1 );
350     mpi_powm( a, pkey->g, k, pkey->p );
351     /* b = (y^k * input) mod p
352      *   = ((y^k mod p) * (input mod p)) mod p
353      * and because input is < p
354      *   = ((y^k mod p) * input) mod p
355      */
356     mpi_powm( b, pkey->y, k, pkey->p );
357     mpi_mulm( b, b, input, pkey->p );
358 #if 0
359     if( DBG_CIPHER ) {
360         log_mpidump("elg encrypted y= ", pkey->y);
361         log_mpidump("elg encrypted p= ", pkey->p);
362         log_mpidump("elg encrypted k= ", k);
363         log_mpidump("elg encrypted M= ", input);
364         log_mpidump("elg encrypted a= ", a);
365         log_mpidump("elg encrypted b= ", b);
366     }
367 #endif
368     mpi_free(k);
369 }
370
371
372 static void
373 decrypt(MPI output, MPI a, MPI b, ELG_secret_key *skey )
374 {
375     MPI t1 = mpi_alloc_secure( mpi_get_nlimbs( skey->p ) );
376
377     /* output = b/(a^x) mod p */
378     mpi_powm( t1, a, skey->x, skey->p );
379     mpi_invm( t1, t1, skey->p );
380     mpi_mulm( output, b, t1, skey->p );
381 #if 0
382     if( DBG_CIPHER ) {
383         log_mpidump("elg decrypted x= ", skey->x);
384         log_mpidump("elg decrypted p= ", skey->p);
385         log_mpidump("elg decrypted a= ", a);
386         log_mpidump("elg decrypted b= ", b);
387         log_mpidump("elg decrypted M= ", output);
388     }
389 #endif
390     mpi_free(t1);
391 }
392
393
394 /*********************************************
395  **************  interface  ******************
396  *********************************************/
397
398 int
399 elg_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
400 {
401     ELG_secret_key sk;
402
403     if( !is_ELGAMAL(algo) )
404         return G10ERR_PUBKEY_ALGO;
405
406     generate( &sk, nbits, retfactors );
407     skey[0] = sk.p;
408     skey[1] = sk.g;
409     skey[2] = sk.y;
410     skey[3] = sk.x;
411     return 0;
412 }
413
414
415 int
416 elg_check_secret_key( int algo, MPI *skey )
417 {
418     ELG_secret_key sk;
419
420     if( !is_ELGAMAL(algo) )
421         return G10ERR_PUBKEY_ALGO;
422     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] )
423         return G10ERR_BAD_MPI;
424
425     sk.p = skey[0];
426     sk.g = skey[1];
427     sk.y = skey[2];
428     sk.x = skey[3];
429     if( !check_secret_key( &sk ) )
430         return G10ERR_BAD_SECKEY;
431
432     return 0;
433 }
434
435
436 int
437 elg_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey )
438 {
439     ELG_public_key pk;
440
441     if( !is_ELGAMAL(algo) )
442         return G10ERR_PUBKEY_ALGO;
443     if( !data || !pkey[0] || !pkey[1] || !pkey[2] )
444         return G10ERR_BAD_MPI;
445
446     pk.p = pkey[0];
447     pk.g = pkey[1];
448     pk.y = pkey[2];
449     resarr[0] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
450     resarr[1] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
451     do_encrypt( resarr[0], resarr[1], data, &pk );
452     return 0;
453 }
454
455 int
456 elg_decrypt( int algo, MPI *result, MPI *data, MPI *skey )
457 {
458     ELG_secret_key sk;
459
460     if( !is_ELGAMAL(algo) )
461         return G10ERR_PUBKEY_ALGO;
462     if( !data[0] || !data[1]
463         || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
464         return G10ERR_BAD_MPI;
465
466     sk.p = skey[0];
467     sk.g = skey[1];
468     sk.y = skey[2];
469     sk.x = skey[3];
470     *result = mpi_alloc_secure( mpi_get_nlimbs( sk.p ) );
471     decrypt( *result, data[0], data[1], &sk );
472     return 0;
473 }
474
475
476 unsigned int
477 elg_get_nbits( int algo, MPI *pkey )
478 {
479     if( !is_ELGAMAL(algo) )
480         return 0;
481     return mpi_get_nbits( pkey[0] );
482 }
483
484
485 /****************
486  * Return some information about the algorithm.  We need algo here to
487  * distinguish different flavors of the algorithm.
488  * Returns: A pointer to string describing the algorithm or NULL if
489  *          the ALGO is invalid.
490  * Usage: Bit 0 set : allows signing
491  *            1 set : allows encryption
492  */
493 const char *
494 elg_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
495                                                          int *use )
496 {
497     *npkey = 3;
498     *nskey = 4;
499     *nenc = 2;
500     *nsig = 2;
501
502     switch( algo ) {
503       case PUBKEY_ALGO_ELGAMAL_E:
504         *use = PUBKEY_USAGE_ENC;
505         return "ELG-E";
506       default: *use = 0; return NULL;
507     }
508 }