See ChangeLog: Fri Jul 14 19:38:23 CEST 2000 Werner Koch
[gnupg.git] / cipher / elgamal.c
1 /* elgamal.c  -  ElGamal Public Key encryption
2  *      Copyright (C) 1998, 2000 Free Software Foundation, Inc.
3  *
4  * For a description of the algorithm, see:
5  *   Bruce Schneier: Applied Cryptography. John Wiley & Sons, 1996.
6  *   ISBN 0-471-11709-9. Pages 476 ff.
7  *
8  * This file is part of GnuPG.
9  *
10  * GnuPG is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * GnuPG is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
23  */
24
25 #include <config.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include "g10lib.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 );
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 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 static void sign(MPI a, MPI b, MPI input, ELG_secret_key *skey);
56 static int  verify(MPI a, MPI b, MPI input, ELG_public_key *pkey);
57
58
59 static void (*progress_cb) ( void *, int );
60 static void *progress_cb_data;
61
62 void
63 register_pk_elg_progress ( void (*cb)( void *, int), void *cb_data )
64 {
65     progress_cb = cb;
66     progress_cb_data = cb_data;
67 }
68
69
70 static void
71 progress( int c )
72 {
73     if ( progress_cb )
74         progress_cb ( progress_cb_data, c );
75     else
76         fputc( c, stderr );
77 }
78
79
80 /****************
81  * Michael Wiener's table on subgroup sizes to match field sizes
82  * (floating around somewhere - Fixme: need a reference)
83  */
84 static unsigned int
85 wiener_map( unsigned int n )
86 {
87     static struct { unsigned int p_n, q_n; } t[] =
88     {   /*   p    q      attack cost */
89         {  512, 119 },  /* 9 x 10^17 */
90         {  768, 145 },  /* 6 x 10^21 */
91         { 1024, 165 },  /* 7 x 10^24 */
92         { 1280, 183 },  /* 3 x 10^27 */
93         { 1536, 198 },  /* 7 x 10^29 */
94         { 1792, 212 },  /* 9 x 10^31 */
95         { 2048, 225 },  /* 8 x 10^33 */
96         { 2304, 237 },  /* 5 x 10^35 */
97         { 2560, 249 },  /* 3 x 10^37 */
98         { 2816, 259 },  /* 1 x 10^39 */
99         { 3072, 269 },  /* 3 x 10^40 */
100         { 3328, 279 },  /* 8 x 10^41 */
101         { 3584, 288 },  /* 2 x 10^43 */
102         { 3840, 296 },  /* 4 x 10^44 */
103         { 4096, 305 },  /* 7 x 10^45 */
104         { 4352, 313 },  /* 1 x 10^47 */
105         { 4608, 320 },  /* 2 x 10^48 */
106         { 4864, 328 },  /* 2 x 10^49 */
107         { 5120, 335 },  /* 3 x 10^50 */
108         { 0, 0 }
109     };
110     int i;
111
112     for(i=0; t[i].p_n; i++ )  {
113         if( n <= t[i].p_n )
114             return t[i].q_n;
115     }
116     /* not in table - use some arbitrary high number ;-) */
117     return  n / 8 + 200;
118 }
119
120 static void
121 test_keys( ELG_secret_key *sk, unsigned nbits )
122 {
123     ELG_public_key pk;
124     MPI test = mpi_alloc( 0 );
125     MPI out1_a = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
126     MPI out1_b = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
127     MPI out2 = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
128
129     pk.p = sk->p;
130     pk.g = sk->g;
131     pk.y = sk->y;
132
133     gcry_mpi_randomize( test, nbits, GCRY_WEAK_RANDOM );
134
135     encrypt( out1_a, out1_b, test, &pk );
136     decrypt( out2, out1_a, out1_b, sk );
137     if( mpi_cmp( test, out2 ) )
138         log_fatal("ElGamal operation: encrypt, decrypt failed\n");
139
140     sign( out1_a, out1_b, test, sk );
141     if( !verify( out1_a, out1_b, test, &pk ) )
142         log_fatal("ElGamal operation: sign, verify failed\n");
143
144     mpi_free( test );
145     mpi_free( out1_a );
146     mpi_free( out1_b );
147     mpi_free( out2 );
148 }
149
150
151 /****************
152  * generate a random secret exponent k from prime p, so
153  * that k is relatively prime to p-1
154  */
155 static MPI
156 gen_k( MPI p )
157 {
158     MPI k = mpi_alloc_secure( 0 );
159     MPI temp = mpi_alloc( mpi_get_nlimbs(p) );
160     MPI p_1 = mpi_copy(p);
161     unsigned int orig_nbits = mpi_get_nbits(p);
162     unsigned int nbits, nbytes;
163     char *rndbuf = NULL;
164
165     /* IMO using a k much lesser than p is sufficient and it greatly
166      * improves the encryption performance.  We use Wiener's table
167      * and add a large safety margin.
168      */
169     nbits = wiener_map( orig_nbits ) * 3 / 2;
170     if( nbits >= orig_nbits )
171         BUG();
172
173     nbytes = (nbits+7)/8;
174     if( DBG_CIPHER )
175         log_debug("choosing a random k ");
176     mpi_sub_ui( p_1, p, 1);
177     for(;;) {
178         if( !rndbuf || nbits < 32 ) {
179             g10_free(rndbuf);
180             rndbuf = gcry_random_bytes_secure( nbytes, GCRY_STRONG_RANDOM );
181         }
182         else { /* change only some of the higher bits */
183             /* we could improve this by directly requesting more memory
184              * at the first call to get_random_bytes() and use this the here
185              * maybe it is easier to do this directly in random.c
186              * Anyway, it is highly inlikely that we will ever reach this code
187              */
188             char *pp = gcry_random_bytes_secure( 4, GCRY_STRONG_RANDOM );
189             memcpy( rndbuf, pp, 4 );
190             g10_free(pp);
191             log_debug("gen_k: tsss, never expected to reach this\n");
192         }
193         mpi_set_buffer( k, rndbuf, nbytes, 0 );
194
195         for(;;) {
196             /* Hmm, actually we don't need this step here
197              * because we use k much smaller than p - we do it anyway
198              * just in case the keep on adding a one to k ;) */
199             if( !(mpi_cmp( k, p_1 ) < 0) ) {  /* check: k < (p-1) */
200                 if( DBG_CIPHER )
201                     progress('+');
202                 break; /* no  */
203             }
204             if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
205                 if( DBG_CIPHER )
206                     progress('-');
207                 break; /* no */
208             }
209             if( mpi_gcd( temp, k, p_1 ) )
210                 goto found;  /* okay, k is relatively prime to (p-1) */
211             mpi_add_ui( k, k, 1 );
212             if( DBG_CIPHER )
213                 progress('.');
214         }
215     }
216   found:
217     g10_free(rndbuf);
218     if( DBG_CIPHER )
219         progress('\n');
220     mpi_free(p_1);
221     mpi_free(temp);
222
223     return k;
224 }
225
226 /****************
227  * Generate a key pair with a key of size NBITS
228  * Returns: 2 structures filles with all needed values
229  *          and an array with n-1 factors of (p-1)
230  */
231 static void
232 generate(  ELG_secret_key *sk, unsigned int nbits, MPI **ret_factors )
233 {
234     MPI p;    /* the prime */
235     MPI p_min1;
236     MPI g;
237     MPI x;    /* the secret exponent */
238     MPI y;
239     MPI temp;
240     unsigned int qbits;
241     unsigned int xbits;
242     byte *rndbuf;
243
244     p_min1 = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
245     temp   = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
246     qbits = wiener_map( nbits );
247     if( qbits & 1 ) /* better have a even one */
248         qbits++;
249     g = mpi_alloc(1);
250     p = generate_elg_prime( 0, nbits, qbits, g, ret_factors );
251     mpi_sub_ui(p_min1, p, 1);
252
253
254     /* select a random number which has these properties:
255      *   0 < x < p-1
256      * This must be a very good random number because this is the
257      * secret part.  The prime is public and may be shared anyway,
258      * so a random generator level of 1 is used for the prime.
259      *
260      * I don't see a reason to have a x of about the same size
261      * as the p.  It should be sufficient to have one about the size
262      * of q or the later used k plus a large safety margin. Decryption
263      * will be much faster with such an x.
264      */
265     xbits = qbits * 3 / 2;
266     if( xbits >= nbits )
267         BUG();
268     x = mpi_alloc_secure( xbits/BITS_PER_MPI_LIMB );
269     if( DBG_CIPHER )
270         log_debug("choosing a random x of size %u", xbits );
271     rndbuf = NULL;
272     do {
273         if( DBG_CIPHER )
274             progress('.');
275         if( rndbuf ) { /* change only some of the higher bits */
276             if( xbits < 16 ) {/* should never happen ... */
277                 g10_free(rndbuf);
278                 rndbuf = gcry_random_bytes_secure( (xbits+7)/8,
279                                                    GCRY_VERY_STRONG_RANDOM );
280             }
281             else {
282                 char *r = gcry_random_bytes_secure( 2,
283                                                    GCRY_VERY_STRONG_RANDOM );
284                 memcpy(rndbuf, r, 2 );
285                 g10_free(r);
286             }
287         }
288         else {
289             rndbuf = gcry_random_bytes_secure( (xbits+7)/8,
290                                                GCRY_VERY_STRONG_RANDOM );
291         }
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     g10_free(rndbuf);
296
297     y = mpi_alloc(nbits/BITS_PER_MPI_LIMB);
298     gcry_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     gcry_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 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 );
350     gcry_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     gcry_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
373
374 static void
375 decrypt(MPI output, MPI a, MPI b, ELG_secret_key *skey )
376 {
377     MPI t1 = mpi_alloc_secure( mpi_get_nlimbs( skey->p ) );
378
379     /* output = b/(a^x) mod p */
380     gcry_mpi_powm( t1, a, skey->x, skey->p );
381     mpi_invm( t1, t1, skey->p );
382     mpi_mulm( output, b, t1, skey->p );
383   #if 0
384     if( DBG_CIPHER ) {
385         log_mpidump("elg decrypted x= ", skey->x);
386         log_mpidump("elg decrypted p= ", skey->p);
387         log_mpidump("elg decrypted a= ", a);
388         log_mpidump("elg decrypted b= ", b);
389         log_mpidump("elg decrypted M= ", output);
390     }
391   #endif
392     mpi_free(t1);
393 }
394
395
396 /****************
397  * Make an Elgamal signature out of INPUT
398  */
399
400 static void
401 sign(MPI a, MPI b, MPI input, ELG_secret_key *skey )
402 {
403     MPI k;
404     MPI t   = mpi_alloc( mpi_get_nlimbs(a) );
405     MPI inv = mpi_alloc( mpi_get_nlimbs(a) );
406     MPI p_1 = mpi_copy(skey->p);
407
408    /*
409     * b = (t * inv) mod (p-1)
410     * b = (t * inv(k,(p-1),(p-1)) mod (p-1)
411     * b = (((M-x*a) mod (p-1)) * inv(k,(p-1),(p-1))) mod (p-1)
412     *
413     */
414     mpi_sub_ui(p_1, p_1, 1);
415     k = gen_k( skey->p );
416     gcry_mpi_powm( a, skey->g, k, skey->p );
417     mpi_mul(t, skey->x, a );
418     mpi_subm(t, input, t, p_1 );
419     mpi_invm(inv, k, p_1 );
420     mpi_mulm(b, t, inv, p_1 );
421
422   #if 0
423     if( DBG_CIPHER ) {
424         log_mpidump("elg sign p= ", skey->p);
425         log_mpidump("elg sign g= ", skey->g);
426         log_mpidump("elg sign y= ", skey->y);
427         log_mpidump("elg sign x= ", skey->x);
428         log_mpidump("elg sign k= ", k);
429         log_mpidump("elg sign M= ", input);
430         log_mpidump("elg sign a= ", a);
431         log_mpidump("elg sign b= ", b);
432     }
433   #endif
434     mpi_free(k);
435     mpi_free(t);
436     mpi_free(inv);
437     mpi_free(p_1);
438 }
439
440
441 /****************
442  * Returns true if the signature composed of A and B is valid.
443  */
444 static int
445 verify(MPI a, MPI b, MPI input, ELG_public_key *pkey )
446 {
447     int rc;
448     MPI t1;
449     MPI t2;
450     MPI base[4];
451     MPI exp[4];
452
453     if( !(mpi_cmp_ui( a, 0 ) > 0 && mpi_cmp( a, pkey->p ) < 0) )
454         return 0; /* assertion  0 < a < p  failed */
455
456     t1 = mpi_alloc( mpi_get_nlimbs(a) );
457     t2 = mpi_alloc( mpi_get_nlimbs(a) );
458
459   #if 0
460     /* t1 = (y^a mod p) * (a^b mod p) mod p */
461     gcry_mpi_powm( t1, pkey->y, a, pkey->p );
462     gcry_mpi_powm( t2, a, b, pkey->p );
463     mpi_mulm( t1, t1, t2, pkey->p );
464
465     /* t2 = g ^ input mod p */
466     gcry_mpi_powm( t2, pkey->g, input, pkey->p );
467
468     rc = !mpi_cmp( t1, t2 );
469   #elif 0
470     /* t1 = (y^a mod p) * (a^b mod p) mod p */
471     base[0] = pkey->y; exp[0] = a;
472     base[1] = a;       exp[1] = b;
473     base[2] = NULL;    exp[2] = NULL;
474     mpi_mulpowm( t1, base, exp, pkey->p );
475
476     /* t2 = g ^ input mod p */
477     gcry_mpi_powm( t2, pkey->g, input, pkey->p );
478
479     rc = !mpi_cmp( t1, t2 );
480   #else
481     /* t1 = g ^ - input * y ^ a * a ^ b  mod p */
482     mpi_invm(t2, pkey->g, pkey->p );
483     base[0] = t2     ; exp[0] = input;
484     base[1] = pkey->y; exp[1] = a;
485     base[2] = a;       exp[2] = b;
486     base[3] = NULL;    exp[3] = NULL;
487     mpi_mulpowm( t1, base, exp, pkey->p );
488     rc = !mpi_cmp_ui( t1, 1 );
489
490   #endif
491
492     mpi_free(t1);
493     mpi_free(t2);
494     return rc;
495 }
496
497 /*********************************************
498  **************  interface  ******************
499  *********************************************/
500
501 int
502 elg_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
503 {
504     ELG_secret_key sk;
505
506     if( !is_ELGAMAL(algo) )
507         return GCRYERR_INV_PK_ALGO;
508
509     generate( &sk, nbits, retfactors );
510     skey[0] = sk.p;
511     skey[1] = sk.g;
512     skey[2] = sk.y;
513     skey[3] = sk.x;
514     return 0;
515 }
516
517
518 int
519 elg_check_secret_key( int algo, MPI *skey )
520 {
521     ELG_secret_key sk;
522
523     if( !is_ELGAMAL(algo) )
524         return GCRYERR_INV_PK_ALGO;
525     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] )
526         return GCRYERR_BAD_MPI;
527
528     sk.p = skey[0];
529     sk.g = skey[1];
530     sk.y = skey[2];
531     sk.x = skey[3];
532     if( !check_secret_key( &sk ) )
533         return GCRYERR_BAD_SECRET_KEY;
534
535     return 0;
536 }
537
538
539
540 int
541 elg_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey )
542 {
543     ELG_public_key pk;
544
545     if( !is_ELGAMAL(algo) )
546         return GCRYERR_INV_PK_ALGO;
547     if( !data || !pkey[0] || !pkey[1] || !pkey[2] )
548         return GCRYERR_BAD_MPI;
549
550     pk.p = pkey[0];
551     pk.g = pkey[1];
552     pk.y = pkey[2];
553     resarr[0] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
554     resarr[1] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
555     encrypt( resarr[0], resarr[1], data, &pk );
556     return 0;
557 }
558
559 int
560 elg_decrypt( int algo, MPI *result, MPI *data, MPI *skey )
561 {
562     ELG_secret_key sk;
563
564     if( !is_ELGAMAL(algo) )
565         return GCRYERR_INV_PK_ALGO;
566     if( !data[0] || !data[1]
567         || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
568         return GCRYERR_BAD_MPI;
569
570     sk.p = skey[0];
571     sk.g = skey[1];
572     sk.y = skey[2];
573     sk.x = skey[3];
574     *result = mpi_alloc_secure( mpi_get_nlimbs( sk.p ) );
575     decrypt( *result, data[0], data[1], &sk );
576     return 0;
577 }
578
579 int
580 elg_sign( int algo, MPI *resarr, MPI data, MPI *skey )
581 {
582     ELG_secret_key sk;
583
584     if( !is_ELGAMAL(algo) )
585         return GCRYERR_INV_PK_ALGO;
586     if( !data || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
587         return GCRYERR_BAD_MPI;
588
589     sk.p = skey[0];
590     sk.g = skey[1];
591     sk.y = skey[2];
592     sk.x = skey[3];
593     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
594     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
595     sign( resarr[0], resarr[1], data, &sk );
596     return 0;
597 }
598
599 int
600 elg_verify( int algo, MPI hash, MPI *data, MPI *pkey,
601                     int (*cmp)(void *, MPI), void *opaquev )
602 {
603     ELG_public_key pk;
604
605     if( !is_ELGAMAL(algo) )
606         return GCRYERR_INV_PK_ALGO;
607     if( !data[0] || !data[1] || !hash
608         || !pkey[0] || !pkey[1] || !pkey[2] )
609         return GCRYERR_BAD_MPI;
610
611     pk.p = pkey[0];
612     pk.g = pkey[1];
613     pk.y = pkey[2];
614     if( !verify( data[0], data[1], hash, &pk ) )
615         return GCRYERR_BAD_SIGNATURE;
616     return 0;
617 }
618
619
620
621 unsigned int
622 elg_get_nbits( int algo, MPI *pkey )
623 {
624     if( !is_ELGAMAL(algo) )
625         return 0;
626     return mpi_get_nbits( pkey[0] );
627 }
628
629
630 /****************
631  * Return some information about the algorithm.  We need algo here to
632  * distinguish different flavors of the algorithm.
633  * Returns: A pointer to string describing the algorithm or NULL if
634  *          the ALGO is invalid.
635  * Usage: Bit 0 set : allows signing
636  *            1 set : allows encryption
637  * NOTE: This function allows signing also for ELG-E, which is not
638  * okay but a bad hack to allow to work with old gpg keys. The real check
639  * is done in the gnupg ocde depending on the packet version.
640  */
641 const char *
642 elg_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
643                                                          int *use )
644 {
645     *npkey = 3;
646     *nskey = 4;
647     *nenc = 2;
648     *nsig = 2;
649
650     switch( algo ) {
651       case GCRY_PK_ELG:
652         *use = GCRY_PK_USAGE_SIGN|GCRY_PK_USAGE_ENCR;
653         return "ELG";
654       case GCRY_PK_ELG_E:
655         *use = GCRY_PK_USAGE_SIGN|GCRY_PK_USAGE_ENCR;
656         return "ELG-E";
657       default: *use = 0; return NULL;
658     }
659 }
660
661