See ChangeLog: Wed Dec 8 21:58:32 CET 1999 Werner Koch
[gnupg.git] / cipher / elgamal.c
1 /* elgamal.c  -  ElGamal Public Key encryption
2  *      Copyright (C) 1998 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
60 progress( int c )
61 {
62     fputc( c, stderr );
63 }
64
65
66 static void
67 test_keys( ELG_secret_key *sk, unsigned nbits )
68 {
69     ELG_public_key pk;
70     MPI test = mpi_alloc( 0 );
71     MPI out1_a = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
72     MPI out1_b = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
73     MPI out2 = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
74
75     pk.p = sk->p;
76     pk.g = sk->g;
77     pk.y = sk->y;
78
79     gcry_mpi_randomize( test, nbits, GCRY_WEAK_RANDOM );
80
81     encrypt( out1_a, out1_b, test, &pk );
82     decrypt( out2, out1_a, out1_b, sk );
83     if( mpi_cmp( test, out2 ) )
84         log_fatal("ElGamal operation: encrypt, decrypt failed\n");
85
86     sign( out1_a, out1_b, test, sk );
87     if( !verify( out1_a, out1_b, test, &pk ) )
88         log_fatal("ElGamal operation: sign, verify failed\n");
89
90     mpi_free( test );
91     mpi_free( out1_a );
92     mpi_free( out1_b );
93     mpi_free( out2 );
94 }
95
96
97 /****************
98  * generate a random secret exponent k from prime p, so
99  * that k is relatively prime to p-1
100  */
101 static MPI
102 gen_k( MPI p )
103 {
104     MPI k = mpi_alloc_secure( 0 );
105     MPI temp = mpi_alloc( mpi_get_nlimbs(p) );
106     MPI p_1 = mpi_copy(p);
107     unsigned int nbits = mpi_get_nbits(p);
108     unsigned int nbytes = (nbits+7)/8;
109     char *rndbuf = NULL;
110
111     if( DBG_CIPHER )
112         log_debug("choosing a random k ");
113     mpi_sub_ui( p_1, p, 1);
114     for(;;) {
115         if( DBG_CIPHER )
116             progress('.');
117         if( !rndbuf || nbits < 32 ) {
118             g10_free(rndbuf);
119             rndbuf = gcry_random_bytes_secure( nbytes, GCRY_STRONG_RANDOM );
120         }
121         else { /* change only some of the higher bits */
122             /* we could imporove this by directly requesting more memory
123              * at the first call to get_random_bytes() and use this the here
124              * maybe it is easier to do this directly in random.c */
125             char *pp = gcry_random_bytes_secure( 4, GCRY_STRONG_RANDOM );
126             memcpy( rndbuf, pp, 4 );
127             g10_free(pp);
128         }
129         mpi_set_buffer( k, rndbuf, nbytes, 0 );
130
131         for(;;) {
132             /* make sure that the number is of the exact lenght */
133             if( mpi_test_bit( k, nbits-1 ) )
134                 mpi_set_highbit( k, nbits-1 );
135             else {
136                 mpi_set_highbit( k, nbits-1 );
137                 mpi_clear_bit( k, nbits-1 );
138             }
139             if( !(mpi_cmp( k, p_1 ) < 0) ) {  /* check: k < (p-1) */
140                 if( DBG_CIPHER )
141                     progress('+');
142                 break; /* no  */
143             }
144             if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
145                 if( DBG_CIPHER )
146                     progress('-');
147                 break; /* no */
148             }
149             if( mpi_gcd( temp, k, p_1 ) )
150                 goto found;  /* okay, k is relatively prime to (p-1) */
151             mpi_add_ui( k, k, 1 );
152         }
153     }
154   found:
155     g10_free(rndbuf);
156     if( DBG_CIPHER )
157         progress('\n');
158     mpi_free(p_1);
159     mpi_free(temp);
160
161     return k;
162 }
163
164 /****************
165  * Generate a key pair with a key of size NBITS
166  * Returns: 2 structures filles with all needed values
167  *          and an array with n-1 factors of (p-1)
168  */
169 static void
170 generate(  ELG_secret_key *sk, unsigned nbits, MPI **ret_factors )
171 {
172     MPI p;    /* the prime */
173     MPI p_min1;
174     MPI g;
175     MPI x;    /* the secret exponent */
176     MPI y;
177     MPI temp;
178     unsigned qbits;
179     byte *rndbuf;
180
181     p_min1 = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
182     temp   = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
183     if( nbits < 512 )
184         qbits = 120;
185     else if( nbits <= 1024 )
186         qbits = 160;
187     else if( nbits <= 2048 )
188         qbits = 200;
189     else
190         qbits = 240;
191     g = mpi_alloc(1);
192     p = generate_elg_prime( 0, nbits, qbits, g, ret_factors );
193     mpi_sub_ui(p_min1, p, 1);
194
195
196     /* select a random number which has these properties:
197      *   0 < x < p-1
198      * This must be a very good random number because this is the
199      * secret part.  The prime is public and may be shared anyway,
200      * so a random generator level of 1 is used for the prime.
201      */
202     x = mpi_alloc_secure( nbits/BITS_PER_MPI_LIMB );
203     if( DBG_CIPHER )
204         log_debug("choosing a random x ");
205     rndbuf = NULL;
206     do {
207         if( DBG_CIPHER )
208             progress('.');
209         if( rndbuf ) { /* change only some of the higher bits */
210             if( nbits < 16 ) {/* should never happen ... */
211                 g10_free(rndbuf);
212                 rndbuf = gcry_random_bytes_secure( (nbits+7)/8,
213                                                    GCRY_VERY_STRONG_RANDOM );
214             }
215             else {
216                 char *r = gcry_random_bytes_secure( 2,
217                                                    GCRY_VERY_STRONG_RANDOM );
218                 memcpy(rndbuf, r, 2 );
219                 g10_free(r);
220             }
221         }
222         else {
223             rndbuf = gcry_random_bytes_secure( (nbits+7)/8,
224                                                GCRY_VERY_STRONG_RANDOM );
225         }
226         mpi_set_buffer( x, rndbuf, (nbits+7)/8, 0 );
227         mpi_clear_highbit( x, nbits+1 );
228     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, p_min1 )<0 ) );
229     g10_free(rndbuf);
230
231     y = mpi_alloc(nbits/BITS_PER_MPI_LIMB);
232     gcry_mpi_powm( y, g, x, p );
233
234     if( DBG_CIPHER ) {
235         progress('\n');
236         log_mpidump("elg  p= ", p );
237         log_mpidump("elg  g= ", g );
238         log_mpidump("elg  y= ", y );
239         log_mpidump("elg  x= ", x );
240     }
241
242     /* copy the stuff to the key structures */
243     sk->p = p;
244     sk->g = g;
245     sk->y = y;
246     sk->x = x;
247
248     /* now we can test our keys (this should never fail!) */
249     test_keys( sk, nbits - 64 );
250
251     mpi_free( p_min1 );
252     mpi_free( temp   );
253 }
254
255
256 /****************
257  * Test whether the secret key is valid.
258  * Returns: if this is a valid key.
259  */
260 static int
261 check_secret_key( ELG_secret_key *sk )
262 {
263     int rc;
264     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
265
266     gcry_mpi_powm( y, sk->g, sk->x, sk->p );
267     rc = !mpi_cmp( y, sk->y );
268     mpi_free( y );
269     return rc;
270 }
271
272
273 static void
274 encrypt(MPI a, MPI b, MPI input, ELG_public_key *pkey )
275 {
276     MPI k;
277
278     /* Note: maybe we should change the interface, so that it
279      * is possible to check that input is < p and return an
280      * error code.
281      */
282
283     k = gen_k( pkey->p );
284     gcry_mpi_powm( a, pkey->g, k, pkey->p );
285     /* b = (y^k * input) mod p
286      *   = ((y^k mod p) * (input mod p)) mod p
287      * and because input is < p
288      *   = ((y^k mod p) * input) mod p
289      */
290     gcry_mpi_powm( b, pkey->y, k, pkey->p );
291     mpi_mulm( b, b, input, pkey->p );
292   #if 0
293     if( DBG_CIPHER ) {
294         log_mpidump("elg encrypted y= ", pkey->y);
295         log_mpidump("elg encrypted p= ", pkey->p);
296         log_mpidump("elg encrypted k= ", k);
297         log_mpidump("elg encrypted M= ", input);
298         log_mpidump("elg encrypted a= ", a);
299         log_mpidump("elg encrypted b= ", b);
300     }
301   #endif
302     mpi_free(k);
303 }
304
305
306
307
308 static void
309 decrypt(MPI output, MPI a, MPI b, ELG_secret_key *skey )
310 {
311     MPI t1 = mpi_alloc_secure( mpi_get_nlimbs( skey->p ) );
312
313     /* output = b/(a^x) mod p */
314
315     gcry_mpi_powm( t1, a, skey->x, skey->p );
316     mpi_invm( t1, t1, skey->p );
317     mpi_mulm( output, b, t1, skey->p );
318   #if 0
319     if( DBG_CIPHER ) {
320         log_mpidump("elg decrypted x= ", skey->x);
321         log_mpidump("elg decrypted p= ", skey->p);
322         log_mpidump("elg decrypted a= ", a);
323         log_mpidump("elg decrypted b= ", b);
324         log_mpidump("elg decrypted M= ", output);
325     }
326   #endif
327     mpi_free(t1);
328 }
329
330
331 /****************
332  * Make an Elgamal signature out of INPUT
333  */
334
335 static void
336 sign(MPI a, MPI b, MPI input, ELG_secret_key *skey )
337 {
338     MPI k;
339     MPI t   = mpi_alloc( mpi_get_nlimbs(a) );
340     MPI inv = mpi_alloc( mpi_get_nlimbs(a) );
341     MPI p_1 = mpi_copy(skey->p);
342
343    /*
344     * b = (t * inv) mod (p-1)
345     * b = (t * inv(k,(p-1),(p-1)) mod (p-1)
346     * b = (((M-x*a) mod (p-1)) * inv(k,(p-1),(p-1))) mod (p-1)
347     *
348     */
349     mpi_sub_ui(p_1, p_1, 1);
350     k = gen_k( skey->p );
351     gcry_mpi_powm( a, skey->g, k, skey->p );
352     mpi_mul(t, skey->x, a );
353     mpi_subm(t, input, t, p_1 );
354     while( mpi_is_neg(t) ) {
355         BUG();  /* That is nonsense code - left over from a very early test?*/
356         mpi_add(t, t, p_1);
357     }
358     mpi_invm(inv, k, p_1 );
359     mpi_mulm(b, t, inv, p_1 );
360
361   #if 0
362     if( DBG_CIPHER ) {
363         log_mpidump("elg sign p= ", skey->p);
364         log_mpidump("elg sign g= ", skey->g);
365         log_mpidump("elg sign y= ", skey->y);
366         log_mpidump("elg sign x= ", skey->x);
367         log_mpidump("elg sign k= ", k);
368         log_mpidump("elg sign M= ", input);
369         log_mpidump("elg sign a= ", a);
370         log_mpidump("elg sign b= ", b);
371     }
372   #endif
373     mpi_free(k);
374     mpi_free(t);
375     mpi_free(inv);
376     mpi_free(p_1);
377 }
378
379
380 /****************
381  * Returns true if the signature composed of A and B is valid.
382  */
383 static int
384 verify(MPI a, MPI b, MPI input, ELG_public_key *pkey )
385 {
386     int rc;
387     MPI t1;
388     MPI t2;
389     MPI base[4];
390     MPI exp[4];
391
392     if( !(mpi_cmp_ui( a, 0 ) > 0 && mpi_cmp( a, pkey->p ) < 0) )
393         return 0; /* assertion  0 < a < p  failed */
394
395     t1 = mpi_alloc( mpi_get_nlimbs(a) );
396     t2 = mpi_alloc( mpi_get_nlimbs(a) );
397
398   #if 0
399     /* t1 = (y^a mod p) * (a^b mod p) mod p */
400     gcry_mpi_powm( t1, pkey->y, a, pkey->p );
401     gcry_mpi_powm( t2, a, b, pkey->p );
402     mpi_mulm( t1, t1, t2, pkey->p );
403
404     /* t2 = g ^ input mod p */
405     gcry_mpi_powm( t2, pkey->g, input, pkey->p );
406
407     rc = !mpi_cmp( t1, t2 );
408   #elif 0
409     /* t1 = (y^a mod p) * (a^b mod p) mod p */
410     base[0] = pkey->y; exp[0] = a;
411     base[1] = a;       exp[1] = b;
412     base[2] = NULL;    exp[2] = NULL;
413     mpi_mulpowm( t1, base, exp, pkey->p );
414
415     /* t2 = g ^ input mod p */
416     gcry_mpi_powm( t2, pkey->g, input, pkey->p );
417
418     rc = !mpi_cmp( t1, t2 );
419   #else
420     /* t1 = g ^ - input * y ^ a * a ^ b  mod p */
421     mpi_invm(t2, pkey->g, pkey->p );
422     base[0] = t2     ; exp[0] = input;
423     base[1] = pkey->y; exp[1] = a;
424     base[2] = a;       exp[2] = b;
425     base[3] = NULL;    exp[3] = NULL;
426     mpi_mulpowm( t1, base, exp, pkey->p );
427     rc = !mpi_cmp_ui( t1, 1 );
428
429   #endif
430
431     mpi_free(t1);
432     mpi_free(t2);
433     return rc;
434 }
435
436 /*********************************************
437  **************  interface  ******************
438  *********************************************/
439
440 int
441 elg_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
442 {
443     ELG_secret_key sk;
444
445     if( !is_ELGAMAL(algo) )
446         return GCRYERR_INV_PK_ALGO;
447
448     generate( &sk, nbits, retfactors );
449     skey[0] = sk.p;
450     skey[1] = sk.g;
451     skey[2] = sk.y;
452     skey[3] = sk.x;
453     return 0;
454 }
455
456
457 int
458 elg_check_secret_key( int algo, MPI *skey )
459 {
460     ELG_secret_key sk;
461
462     if( !is_ELGAMAL(algo) )
463         return GCRYERR_INV_PK_ALGO;
464     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] )
465         return GCRYERR_BAD_MPI;
466
467     sk.p = skey[0];
468     sk.g = skey[1];
469     sk.y = skey[2];
470     sk.x = skey[3];
471     if( !check_secret_key( &sk ) )
472         return GCRYERR_BAD_SECRET_KEY;
473
474     return 0;
475 }
476
477
478
479 int
480 elg_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey )
481 {
482     ELG_public_key pk;
483
484     if( !is_ELGAMAL(algo) )
485         return GCRYERR_INV_PK_ALGO;
486     if( !data || !pkey[0] || !pkey[1] || !pkey[2] )
487         return GCRYERR_BAD_MPI;
488
489     pk.p = pkey[0];
490     pk.g = pkey[1];
491     pk.y = pkey[2];
492     resarr[0] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
493     resarr[1] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
494     encrypt( resarr[0], resarr[1], data, &pk );
495     return 0;
496 }
497
498 int
499 elg_decrypt( int algo, MPI *result, MPI *data, MPI *skey )
500 {
501     ELG_secret_key sk;
502
503     if( !is_ELGAMAL(algo) )
504         return GCRYERR_INV_PK_ALGO;
505     if( !data[0] || !data[1]
506         || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
507         return GCRYERR_BAD_MPI;
508
509     sk.p = skey[0];
510     sk.g = skey[1];
511     sk.y = skey[2];
512     sk.x = skey[3];
513     *result = mpi_alloc_secure( mpi_get_nlimbs( sk.p ) );
514     decrypt( *result, data[0], data[1], &sk );
515     return 0;
516 }
517
518 int
519 elg_sign( int algo, MPI *resarr, MPI data, MPI *skey )
520 {
521     ELG_secret_key sk;
522
523     if( !is_ELGAMAL(algo) )
524         return GCRYERR_INV_PK_ALGO;
525     if( !data || !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     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
533     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
534     sign( resarr[0], resarr[1], data, &sk );
535     return 0;
536 }
537
538 int
539 elg_verify( int algo, MPI hash, MPI *data, MPI *pkey,
540                     int (*cmp)(void *, MPI), void *opaquev )
541 {
542     ELG_public_key pk;
543
544     if( !is_ELGAMAL(algo) )
545         return GCRYERR_INV_PK_ALGO;
546     if( !data[0] || !data[1] || !hash
547         || !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     if( !verify( data[0], data[1], hash, &pk ) )
554         return GCRYERR_BAD_SIGNATURE;
555     return 0;
556 }
557
558
559
560 unsigned
561 elg_get_nbits( int algo, MPI *pkey )
562 {
563     if( !is_ELGAMAL(algo) )
564         return 0;
565     return mpi_get_nbits( pkey[0] );
566 }
567
568
569 /****************
570  * Return some information about the algorithm.  We need algo here to
571  * distinguish different flavors of the algorithm.
572  * Returns: A pointer to string describing the algorithm or NULL if
573  *          the ALGO is invalid.
574  * Usage: Bit 0 set : allows signing
575  *            1 set : allows encryption
576  * NOTE: This function allows signing also for ELG-E, which is not
577  * okay but a bad hack to allow to work with old gpg keys. The real check
578  * is done in the gnupg ocde depending on the packet version.
579  */
580 const char *
581 elg_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
582                                                          int *use )
583 {
584     *npkey = 3;
585     *nskey = 4;
586     *nenc = 2;
587     *nsig = 2;
588
589     switch( algo ) {
590       case PUBKEY_ALGO_ELGAMAL:
591         *use = GCRY_PK_USAGE_SIGN|GCRY_PK_USAGE_ENCR;
592         return "ELG";
593       case PUBKEY_ALGO_ELGAMAL_E:
594         *use = GCRY_PK_USAGE_SIGN|GCRY_PK_USAGE_ENCR;
595         return "ELG-E";
596       default: *use = 0; return NULL;
597     }
598 }
599
600