2003-04-27 Moritz Schulte <moritz@g10code.com>
[libgcrypt.git] / cipher / elgamal.c
1 /* elgamal.c  -  ElGamal Public Key encryption
2  * Copyright (C) 1998, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser general Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt 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 Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License 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  * For a description of the algorithm, see:
21  *   Bruce Schneier: Applied Cryptography. John Wiley & Sons, 1996.
22  *   ISBN 0-471-11709-9. Pages 476 ff.
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
33 typedef struct {
34     MPI p;          /* prime */
35     MPI g;          /* group generator */
36     MPI y;          /* g^x mod p */
37 } ELG_public_key;
38
39
40 typedef struct {
41     MPI p;          /* prime */
42     MPI g;          /* group generator */
43     MPI y;          /* g^x mod p */
44     MPI x;          /* secret exponent */
45 } ELG_secret_key;
46
47
48 static void test_keys( ELG_secret_key *sk, unsigned nbits );
49 static MPI gen_k( MPI p );
50 static void generate( ELG_secret_key *sk, unsigned nbits, MPI **factors );
51 static int  check_secret_key( ELG_secret_key *sk );
52 static void do_encrypt(MPI a, MPI b, MPI input, ELG_public_key *pkey );
53 static void decrypt(MPI output, MPI a, MPI b, ELG_secret_key *skey );
54 static void sign(MPI a, MPI b, MPI input, ELG_secret_key *skey);
55 static int  verify(MPI a, MPI b, MPI input, ELG_public_key *pkey);
56
57
58 static void (*progress_cb) ( void *, const char *, int, int, int );
59 static void *progress_cb_data;
60
61 void
62 _gcry_register_pk_elg_progress ( void (*cb)( void *,const char*, int,int,int),
63                                  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, "pk_elg", c, 0, 0);
75 }
76
77
78 /****************
79  * Michael Wiener's table on 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 nbits )
120 {
121     ELG_public_key pk;
122     MPI test = gcry_mpi_new ( 0 );
123     MPI out1_a = gcry_mpi_new ( nbits );
124     MPI out1_b = gcry_mpi_new ( nbits );
125     MPI out2 = gcry_mpi_new ( nbits );
126
127     pk.p = sk->p;
128     pk.g = sk->g;
129     pk.y = sk->y;
130
131     gcry_mpi_randomize( test, nbits, GCRY_WEAK_RANDOM );
132
133     do_encrypt( out1_a, out1_b, test, &pk );
134     decrypt( out2, out1_a, out1_b, sk );
135     if( mpi_cmp( test, out2 ) )
136         log_fatal("ElGamal operation: encrypt, decrypt failed\n");
137
138     sign( out1_a, out1_b, test, sk );
139     if( !verify( out1_a, out1_b, test, &pk ) )
140         log_fatal("ElGamal operation: sign, verify failed\n");
141
142     gcry_mpi_release ( test );
143     gcry_mpi_release ( out1_a );
144     gcry_mpi_release ( out1_b );
145     gcry_mpi_release ( out2 );
146 }
147
148
149 /****************
150  * generate a random secret exponent k from prime p, so
151  * that k is relatively prime to p-1
152  */
153 static MPI
154 gen_k( MPI p )
155 {
156     MPI k = mpi_alloc_secure( 0 );
157     MPI temp = mpi_alloc( mpi_get_nlimbs(p) );
158     MPI p_1 = mpi_copy(p);
159     unsigned int orig_nbits = mpi_get_nbits(p);
160     unsigned int nbits, nbytes;
161     char *rndbuf = NULL;
162
163     /* IMO using a k much lesser than p is sufficient and it greatly
164      * improves the encryption performance.  We use Wiener's table
165      * and add a large safety margin.
166      */
167     nbits = wiener_map( orig_nbits ) * 3 / 2;
168     if( nbits >= orig_nbits )
169         BUG();
170
171     nbytes = (nbits+7)/8;
172     if( DBG_CIPHER )
173         log_debug("choosing a random k ");
174     mpi_sub_ui( p_1, p, 1);
175     for(;;) {
176         if( !rndbuf || nbits < 32 ) {
177             gcry_free(rndbuf);
178             rndbuf = gcry_random_bytes_secure( nbytes, GCRY_STRONG_RANDOM );
179         }
180         else { /* change only some of the higher bits */
181             /* we could improve this by directly requesting more memory
182              * at the first call to get_random_bytes() and use this the here
183              * maybe it is easier to do this directly in random.c
184              * Anyway, it is highly inlikely that we will ever reach this code
185              */
186             char *pp = gcry_random_bytes_secure( 4, GCRY_STRONG_RANDOM );
187             memcpy( rndbuf, pp, 4 );
188             gcry_free(pp);
189             log_debug("gen_k: tsss, never expected to reach this\n");
190         }
191         _gcry_mpi_set_buffer( k, rndbuf, nbytes, 0 );
192
193         for(;;) {
194             /* Hmm, actually we don't need this step here
195              * because we use k much smaller than p - we do it anyway
196              * just in case the keep on adding a one to k ;) */
197             if( !(mpi_cmp( k, p_1 ) < 0) ) {  /* check: k < (p-1) */
198                 if( DBG_CIPHER )
199                     progress('+');
200                 break; /* no  */
201             }
202             if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
203                 if( DBG_CIPHER )
204                     progress('-');
205                 break; /* no */
206             }
207             if( gcry_mpi_gcd( temp, k, p_1 ) )
208                 goto found;  /* okay, k is relatively prime to (p-1) */
209             mpi_add_ui( k, k, 1 );
210             if( DBG_CIPHER )
211                 progress('.');
212         }
213     }
214   found:
215     gcry_free(rndbuf);
216     if( DBG_CIPHER )
217         progress('\n');
218     mpi_free(p_1);
219     mpi_free(temp);
220
221     return k;
222 }
223
224 /****************
225  * Generate a key pair with a key of size NBITS
226  * Returns: 2 structures filles with all needed values
227  *          and an array with n-1 factors of (p-1)
228  */
229 static void
230 generate(  ELG_secret_key *sk, unsigned int nbits, MPI **ret_factors )
231 {
232     MPI p;    /* the prime */
233     MPI p_min1;
234     MPI g;
235     MPI x;    /* the secret exponent */
236     MPI y;
237     MPI temp;
238     unsigned int qbits;
239     unsigned int xbits;
240     byte *rndbuf;
241
242     p_min1 = gcry_mpi_new ( nbits );
243     temp   = gcry_mpi_new( nbits );
244     qbits = wiener_map( nbits );
245     if( qbits & 1 ) /* better have a even one */
246         qbits++;
247     g = mpi_alloc(1);
248     p = _gcry_generate_elg_prime( 0, nbits, qbits, g, ret_factors );
249     mpi_sub_ui(p_min1, p, 1);
250
251
252     /* select a random number which has these properties:
253      *   0 < x < p-1
254      * This must be a very good random number because this is the
255      * secret part.  The prime is public and may be shared anyway,
256      * so a random generator level of 1 is used for the prime.
257      *
258      * I don't see a reason to have a x of about the same size
259      * as the p.  It should be sufficient to have one about the size
260      * of q or the later used k plus a large safety margin. Decryption
261      * will be much faster with such an x.
262      */
263     xbits = qbits * 3 / 2;
264     if( xbits >= nbits )
265         BUG();
266     x = gcry_mpi_snew ( xbits );
267     if( DBG_CIPHER )
268         log_debug("choosing a random x of size %u", xbits );
269     rndbuf = NULL;
270     do {
271         if( DBG_CIPHER )
272             progress('.');
273         if( rndbuf ) { /* change only some of the higher bits */
274             if( xbits < 16 ) {/* should never happen ... */
275                 gcry_free(rndbuf);
276                 rndbuf = gcry_random_bytes_secure( (xbits+7)/8,
277                                                    GCRY_VERY_STRONG_RANDOM );
278             }
279             else {
280                 char *r = gcry_random_bytes_secure( 2,
281                                                    GCRY_VERY_STRONG_RANDOM );
282                 memcpy(rndbuf, r, 2 );
283                 gcry_free(r);
284             }
285         }
286         else {
287             rndbuf = gcry_random_bytes_secure( (xbits+7)/8,
288                                                GCRY_VERY_STRONG_RANDOM );
289         }
290         _gcry_mpi_set_buffer( x, rndbuf, (xbits+7)/8, 0 );
291         mpi_clear_highbit( x, xbits+1 );
292     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, p_min1 )<0 ) );
293     gcry_free(rndbuf);
294
295     y = gcry_mpi_new (nbits);
296     gcry_mpi_powm( y, g, x, p );
297
298     if( DBG_CIPHER ) {
299         progress('\n');
300         log_mpidump("elg  p= ", p );
301         log_mpidump("elg  g= ", g );
302         log_mpidump("elg  y= ", y );
303         log_mpidump("elg  x= ", x );
304     }
305
306     /* copy the stuff to the key structures */
307     sk->p = p;
308     sk->g = g;
309     sk->y = y;
310     sk->x = x;
311
312     /* now we can test our keys (this should never fail!) */
313     test_keys( sk, nbits - 64 );
314
315     gcry_mpi_release ( p_min1 );
316     gcry_mpi_release ( temp   );
317 }
318
319
320 /****************
321  * Test whether the secret key is valid.
322  * Returns: if this is a valid key.
323  */
324 static int
325 check_secret_key( ELG_secret_key *sk )
326 {
327     int rc;
328     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
329
330     gcry_mpi_powm( y, sk->g, sk->x, sk->p );
331     rc = !mpi_cmp( y, sk->y );
332     mpi_free( y );
333     return rc;
334 }
335
336
337 static void
338 do_encrypt(MPI a, MPI b, MPI input, ELG_public_key *pkey )
339 {
340     MPI k;
341
342     /* Note: maybe we should change the interface, so that it
343      * is possible to check that input is < p and return an
344      * error code.
345      */
346
347     k = gen_k( pkey->p );
348     gcry_mpi_powm( a, pkey->g, k, pkey->p );
349     /* b = (y^k * input) mod p
350      *   = ((y^k mod p) * (input mod p)) mod p
351      * and because input is < p
352      *   = ((y^k mod p) * input) mod p
353      */
354     gcry_mpi_powm( b, pkey->y, k, pkey->p );
355     gcry_mpi_mulm( b, b, input, pkey->p );
356   #if 0
357     if( DBG_CIPHER ) {
358         log_mpidump("elg encrypted y= ", pkey->y);
359         log_mpidump("elg encrypted p= ", pkey->p);
360         log_mpidump("elg encrypted k= ", k);
361         log_mpidump("elg encrypted M= ", input);
362         log_mpidump("elg encrypted a= ", a);
363         log_mpidump("elg encrypted b= ", b);
364     }
365   #endif
366     mpi_free(k);
367 }
368
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     gcry_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  * Make an Elgamal signature out of INPUT
396  */
397
398 static void
399 sign(MPI a, MPI b, MPI input, ELG_secret_key *skey )
400 {
401     MPI k;
402     MPI t   = mpi_alloc( mpi_get_nlimbs(a) );
403     MPI inv = mpi_alloc( mpi_get_nlimbs(a) );
404     MPI p_1 = mpi_copy(skey->p);
405
406    /*
407     * b = (t * inv) mod (p-1)
408     * b = (t * inv(k,(p-1),(p-1)) mod (p-1)
409     * b = (((M-x*a) mod (p-1)) * inv(k,(p-1),(p-1))) mod (p-1)
410     *
411     */
412     mpi_sub_ui(p_1, p_1, 1);
413     k = gen_k( skey->p );
414     gcry_mpi_powm( a, skey->g, k, skey->p );
415     mpi_mul(t, skey->x, a );
416     mpi_subm(t, input, t, p_1 );
417     mpi_invm(inv, k, p_1 );
418     mpi_mulm(b, t, inv, p_1 );
419
420   #if 0
421     if( DBG_CIPHER ) {
422         log_mpidump("elg sign p= ", skey->p);
423         log_mpidump("elg sign g= ", skey->g);
424         log_mpidump("elg sign y= ", skey->y);
425         log_mpidump("elg sign x= ", skey->x);
426         log_mpidump("elg sign k= ", k);
427         log_mpidump("elg sign M= ", input);
428         log_mpidump("elg sign a= ", a);
429         log_mpidump("elg sign b= ", b);
430     }
431   #endif
432     mpi_free(k);
433     mpi_free(t);
434     mpi_free(inv);
435     mpi_free(p_1);
436 }
437
438
439 /****************
440  * Returns true if the signature composed of A and B is valid.
441  */
442 static int
443 verify(MPI a, MPI b, MPI input, ELG_public_key *pkey )
444 {
445     int rc;
446     MPI t1;
447     MPI t2;
448     MPI base[4];
449     MPI exp[4];
450
451     if( !(mpi_cmp_ui( a, 0 ) > 0 && mpi_cmp( a, pkey->p ) < 0) )
452         return 0; /* assertion  0 < a < p  failed */
453
454     t1 = mpi_alloc( mpi_get_nlimbs(a) );
455     t2 = mpi_alloc( mpi_get_nlimbs(a) );
456
457   #if 0
458     /* t1 = (y^a mod p) * (a^b mod p) mod p */
459     gcry_mpi_powm( t1, pkey->y, a, pkey->p );
460     gcry_mpi_powm( t2, a, b, pkey->p );
461     mpi_mulm( t1, t1, t2, pkey->p );
462
463     /* t2 = g ^ input mod p */
464     gcry_mpi_powm( t2, pkey->g, input, pkey->p );
465
466     rc = !mpi_cmp( t1, t2 );
467   #elif 0
468     /* t1 = (y^a mod p) * (a^b mod p) mod p */
469     base[0] = pkey->y; exp[0] = a;
470     base[1] = a;       exp[1] = b;
471     base[2] = NULL;    exp[2] = NULL;
472     mpi_mulpowm( t1, base, exp, pkey->p );
473
474     /* t2 = g ^ input mod p */
475     gcry_mpi_powm( t2, pkey->g, input, pkey->p );
476
477     rc = !mpi_cmp( t1, t2 );
478   #else
479     /* t1 = g ^ - input * y ^ a * a ^ b  mod p */
480     mpi_invm(t2, pkey->g, pkey->p );
481     base[0] = t2     ; exp[0] = input;
482     base[1] = pkey->y; exp[1] = a;
483     base[2] = a;       exp[2] = b;
484     base[3] = NULL;    exp[3] = NULL;
485     mpi_mulpowm( t1, base, exp, pkey->p );
486     rc = !mpi_cmp_ui( t1, 1 );
487
488   #endif
489
490     mpi_free(t1);
491     mpi_free(t2);
492     return rc;
493 }
494
495 /*********************************************
496  **************  interface  ******************
497  *********************************************/
498
499 int
500 _gcry_elg_generate( int algo, unsigned nbits, unsigned long dummy,
501                     MPI *skey, MPI **retfactors )
502 {
503     ELG_secret_key sk;
504
505     if( !is_ELGAMAL(algo) )
506         return GCRYERR_INV_PK_ALGO;
507
508     generate( &sk, nbits, retfactors );
509     skey[0] = sk.p;
510     skey[1] = sk.g;
511     skey[2] = sk.y;
512     skey[3] = sk.x;
513     return 0;
514 }
515
516
517 int
518 _gcry_elg_check_secret_key( int algo, MPI *skey )
519 {
520     ELG_secret_key sk;
521
522     if( !is_ELGAMAL(algo) )
523         return GCRYERR_INV_PK_ALGO;
524     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] )
525         return GCRYERR_BAD_MPI;
526
527     sk.p = skey[0];
528     sk.g = skey[1];
529     sk.y = skey[2];
530     sk.x = skey[3];
531     if( !check_secret_key( &sk ) )
532         return GCRYERR_BAD_SECRET_KEY;
533
534     return 0;
535 }
536
537
538
539 int
540 _gcry_elg_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey, int flags)
541 {
542     ELG_public_key pk;
543
544     if( !is_ELGAMAL(algo) )
545         return GCRYERR_INV_PK_ALGO;
546     if( !data || !pkey[0] || !pkey[1] || !pkey[2] )
547         return GCRYERR_BAD_MPI;
548
549     pk.p = pkey[0];
550     pk.g = pkey[1];
551     pk.y = pkey[2];
552     resarr[0] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
553     resarr[1] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
554     do_encrypt( resarr[0], resarr[1], data, &pk );
555     return 0;
556 }
557
558 int
559 _gcry_elg_decrypt( int algo, MPI *result, MPI *data, MPI *skey, int flags)
560 {
561     ELG_secret_key sk;
562
563     if( !is_ELGAMAL(algo) )
564         return GCRYERR_INV_PK_ALGO;
565     if( !data[0] || !data[1]
566         || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
567         return GCRYERR_BAD_MPI;
568
569     sk.p = skey[0];
570     sk.g = skey[1];
571     sk.y = skey[2];
572     sk.x = skey[3];
573     *result = mpi_alloc_secure( mpi_get_nlimbs( sk.p ) );
574     decrypt( *result, data[0], data[1], &sk );
575     return 0;
576 }
577
578 int
579 _gcry_elg_sign( int algo, MPI *resarr, MPI data, MPI *skey )
580 {
581     ELG_secret_key sk;
582
583     if( !is_ELGAMAL(algo) )
584         return GCRYERR_INV_PK_ALGO;
585     if( !data || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
586         return GCRYERR_BAD_MPI;
587
588     sk.p = skey[0];
589     sk.g = skey[1];
590     sk.y = skey[2];
591     sk.x = skey[3];
592     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
593     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
594     sign( resarr[0], resarr[1], data, &sk );
595     return 0;
596 }
597
598 int
599 _gcry_elg_verify( int algo, MPI hash, MPI *data, MPI *pkey,
600                     int (*cmp)(void *, MPI), void *opaquev )
601 {
602     ELG_public_key pk;
603
604     if( !is_ELGAMAL(algo) )
605         return GCRYERR_INV_PK_ALGO;
606     if( !data[0] || !data[1] || !hash
607         || !pkey[0] || !pkey[1] || !pkey[2] )
608         return GCRYERR_BAD_MPI;
609
610     pk.p = pkey[0];
611     pk.g = pkey[1];
612     pk.y = pkey[2];
613     if( !verify( data[0], data[1], hash, &pk ) )
614         return GCRYERR_BAD_SIGNATURE;
615     return 0;
616 }
617
618
619
620 unsigned int
621 _gcry_elg_get_nbits( int algo, MPI *pkey )
622 {
623     if( !is_ELGAMAL(algo) )
624         return 0;
625     return mpi_get_nbits( pkey[0] );
626 }
627
628 static char *elg_names[] =
629   {
630     "elg",
631     "openpgp-elg",
632     "openpgp-elg-sig",
633     NULL,
634   };
635
636
637 GcryPubkeySpec pubkey_spec_elg =
638   {
639     "ELG", elg_names, GCRY_PK_ELG,
640     "pgy", "pgyx", "ab", "rs", "pgy",
641     GCRY_PK_USAGE_SIGN | GCRY_PK_USAGE_ENCR,
642     _gcry_elg_generate,
643     _gcry_elg_check_secret_key,
644     _gcry_elg_encrypt,
645     _gcry_elg_decrypt,
646     _gcry_elg_sign,
647     _gcry_elg_verify,
648     _gcry_elg_get_nbits,
649   };