See ChangeLog: Fri Jul 23 13:53:03 CEST 1999 Werner Koch
[libgcrypt.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 "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 );
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     /*mpi_set_bytes( test, nbits, get_random_byte, 0 );*/
80     {   char *p = get_random_bits( nbits, 0, 0 );
81         mpi_set_buffer( test, p, (nbits+7)/8, 0 );
82         m_free(p);
83     }
84
85     encrypt( out1_a, out1_b, test, &pk );
86     decrypt( out2, out1_a, out1_b, sk );
87     if( mpi_cmp( test, out2 ) )
88         log_fatal("ElGamal operation: encrypt, decrypt failed\n");
89
90     sign( out1_a, out1_b, test, sk );
91     if( !verify( out1_a, out1_b, test, &pk ) )
92         log_fatal("ElGamal operation: sign, verify failed\n");
93
94     mpi_free( test );
95     mpi_free( out1_a );
96     mpi_free( out1_b );
97     mpi_free( out2 );
98 }
99
100
101 /****************
102  * generate a random secret exponent k from prime p, so
103  * that k is relatively prime to p-1
104  */
105 static MPI
106 gen_k( MPI p )
107 {
108     MPI k = mpi_alloc_secure( 0 );
109     MPI temp = mpi_alloc( mpi_get_nlimbs(p) );
110     MPI p_1 = mpi_copy(p);
111     unsigned int nbits = mpi_get_nbits(p);
112     unsigned int nbytes = (nbits+7)/8;
113     char *rndbuf = NULL;
114
115     if( DBG_CIPHER )
116         log_debug("choosing a random k ");
117     mpi_sub_ui( p_1, p, 1);
118     for(;;) {
119         if( DBG_CIPHER )
120             progress('.');
121         if( !rndbuf || nbits < 32 ) {
122             m_free(rndbuf);
123             rndbuf = get_random_bits( nbits, 1, 1 );
124         }
125         else { /* change only some of the higher bits */
126             /* we could imporove this by directly requesting more memory
127              * at the first call to get_random_bits() and use this the here
128              * maybe it is easier to do this directly in random.c */
129             char *pp = get_random_bits( 32, 1, 1 );
130             memcpy( rndbuf,pp, 4 );
131             m_free(pp);
132         }
133         mpi_set_buffer( k, rndbuf, nbytes, 0 );
134
135         for(;;) {
136             /* make sure that the number is of the exact lenght */
137             if( mpi_test_bit( k, nbits-1 ) )
138                 mpi_set_highbit( k, nbits-1 );
139             else {
140                 mpi_set_highbit( k, nbits-1 );
141                 mpi_clear_bit( k, nbits-1 );
142             }
143             if( !(mpi_cmp( k, p_1 ) < 0) ) {  /* check: k < (p-1) */
144                 if( DBG_CIPHER )
145                     progress('+');
146                 break; /* no  */
147             }
148             if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
149                 if( DBG_CIPHER )
150                     progress('-');
151                 break; /* no */
152             }
153             if( mpi_gcd( temp, k, p_1 ) )
154                 goto found;  /* okay, k is relatively prime to (p-1) */
155             mpi_add_ui( k, k, 1 );
156         }
157     }
158   found:
159     m_free(rndbuf);
160     if( DBG_CIPHER )
161         progress('\n');
162     mpi_free(p_1);
163     mpi_free(temp);
164
165     return k;
166 }
167
168 /****************
169  * Generate a key pair with a key of size NBITS
170  * Returns: 2 structures filles with all needed values
171  *          and an array with n-1 factors of (p-1)
172  */
173 static void
174 generate(  ELG_secret_key *sk, unsigned nbits, MPI **ret_factors )
175 {
176     MPI p;    /* the prime */
177     MPI p_min1;
178     MPI g;
179     MPI x;    /* the secret exponent */
180     MPI y;
181     MPI temp;
182     unsigned qbits;
183     byte *rndbuf;
184
185     p_min1 = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
186     temp   = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
187     if( nbits < 512 )
188         qbits = 120;
189     else if( nbits <= 1024 )
190         qbits = 160;
191     else if( nbits <= 2048 )
192         qbits = 200;
193     else
194         qbits = 240;
195     g = mpi_alloc(1);
196     p = generate_elg_prime( 0, nbits, qbits, g, ret_factors );
197     mpi_sub_ui(p_min1, p, 1);
198
199
200     /* select a random number which has these properties:
201      *   0 < x < p-1
202      * This must be a very good random number because this is the
203      * secret part.  The prime is public and may be shared anyway,
204      * so a random generator level of 1 is used for the prime.
205      */
206     x = mpi_alloc_secure( nbits/BITS_PER_MPI_LIMB );
207     if( DBG_CIPHER )
208         log_debug("choosing a random x ");
209     rndbuf = NULL;
210     do {
211         if( DBG_CIPHER )
212             progress('.');
213         if( rndbuf ) { /* change only some of the higher bits */
214             if( nbits < 16 ) {/* should never happen ... */
215                 m_free(rndbuf);
216                 rndbuf = get_random_bits( nbits, 2, 1 );
217             }
218             else {
219                 char *r = get_random_bits( 16, 2, 1 );
220                 memcpy(rndbuf, r, 16/8 );
221                 m_free(r);
222             }
223         }
224         else
225             rndbuf = get_random_bits( nbits, 2, 1 );
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     m_free(rndbuf);
230
231     y = mpi_alloc(nbits/BITS_PER_MPI_LIMB);
232     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     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     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     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     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     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         mpi_add(t, t, p_1);
356     mpi_invm(inv, k, p_1 );
357     mpi_mulm(b, t, inv, p_1 );
358
359   #if 0
360     if( DBG_CIPHER ) {
361         log_mpidump("elg sign p= ", skey->p);
362         log_mpidump("elg sign g= ", skey->g);
363         log_mpidump("elg sign y= ", skey->y);
364         log_mpidump("elg sign x= ", skey->x);
365         log_mpidump("elg sign k= ", k);
366         log_mpidump("elg sign M= ", input);
367         log_mpidump("elg sign a= ", a);
368         log_mpidump("elg sign b= ", b);
369     }
370   #endif
371     mpi_free(k);
372     mpi_free(t);
373     mpi_free(inv);
374     mpi_free(p_1);
375 }
376
377
378 /****************
379  * Returns true if the signature composed of A and B is valid.
380  */
381 static int
382 verify(MPI a, MPI b, MPI input, ELG_public_key *pkey )
383 {
384     int rc;
385     MPI t1;
386     MPI t2;
387     MPI base[4];
388     MPI exp[4];
389
390     if( !(mpi_cmp_ui( a, 0 ) > 0 && mpi_cmp( a, pkey->p ) < 0) )
391         return 0; /* assertion  0 < a < p  failed */
392
393     t1 = mpi_alloc( mpi_get_nlimbs(a) );
394     t2 = mpi_alloc( mpi_get_nlimbs(a) );
395
396   #if 0
397     /* t1 = (y^a mod p) * (a^b mod p) mod p */
398     mpi_powm( t1, pkey->y, a, pkey->p );
399     mpi_powm( t2, a, b, pkey->p );
400     mpi_mulm( t1, t1, t2, pkey->p );
401
402     /* t2 = g ^ input mod p */
403     mpi_powm( t2, pkey->g, input, pkey->p );
404
405     rc = !mpi_cmp( t1, t2 );
406   #elif 0
407     /* t1 = (y^a mod p) * (a^b mod p) mod p */
408     base[0] = pkey->y; exp[0] = a;
409     base[1] = a;       exp[1] = b;
410     base[2] = NULL;    exp[2] = NULL;
411     mpi_mulpowm( t1, base, exp, pkey->p );
412
413     /* t2 = g ^ input mod p */
414     mpi_powm( t2, pkey->g, input, pkey->p );
415
416     rc = !mpi_cmp( t1, t2 );
417   #else
418     /* t1 = g ^ - input * y ^ a * a ^ b  mod p */
419     mpi_invm(t2, pkey->g, pkey->p );
420     base[0] = t2     ; exp[0] = input;
421     base[1] = pkey->y; exp[1] = a;
422     base[2] = a;       exp[2] = b;
423     base[3] = NULL;    exp[3] = NULL;
424     mpi_mulpowm( t1, base, exp, pkey->p );
425     rc = !mpi_cmp_ui( t1, 1 );
426
427   #endif
428
429     mpi_free(t1);
430     mpi_free(t2);
431     return rc;
432 }
433
434 /*********************************************
435  **************  interface  ******************
436  *********************************************/
437
438 int
439 elg_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
440 {
441     ELG_secret_key sk;
442
443     if( !is_ELGAMAL(algo) )
444         return G10ERR_PUBKEY_ALGO;
445
446     generate( &sk, nbits, retfactors );
447     skey[0] = sk.p;
448     skey[1] = sk.g;
449     skey[2] = sk.y;
450     skey[3] = sk.x;
451     return 0;
452 }
453
454
455 int
456 elg_check_secret_key( int algo, MPI *skey )
457 {
458     ELG_secret_key sk;
459
460     if( !is_ELGAMAL(algo) )
461         return G10ERR_PUBKEY_ALGO;
462     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] )
463         return G10ERR_BAD_MPI;
464
465     sk.p = skey[0];
466     sk.g = skey[1];
467     sk.y = skey[2];
468     sk.x = skey[3];
469     if( !check_secret_key( &sk ) )
470         return G10ERR_BAD_SECKEY;
471
472     return 0;
473 }
474
475
476
477 int
478 elg_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey )
479 {
480     ELG_public_key pk;
481
482     if( !is_ELGAMAL(algo) )
483         return G10ERR_PUBKEY_ALGO;
484     if( !data || !pkey[0] || !pkey[1] || !pkey[2] )
485         return G10ERR_BAD_MPI;
486
487     pk.p = pkey[0];
488     pk.g = pkey[1];
489     pk.y = pkey[2];
490     resarr[0] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
491     resarr[1] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
492     encrypt( resarr[0], resarr[1], data, &pk );
493     return 0;
494 }
495
496 int
497 elg_decrypt( int algo, MPI *result, MPI *data, MPI *skey )
498 {
499     ELG_secret_key sk;
500
501     if( !is_ELGAMAL(algo) )
502         return G10ERR_PUBKEY_ALGO;
503     if( !data[0] || !data[1]
504         || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
505         return G10ERR_BAD_MPI;
506
507     sk.p = skey[0];
508     sk.g = skey[1];
509     sk.y = skey[2];
510     sk.x = skey[3];
511     *result = mpi_alloc_secure( mpi_get_nlimbs( sk.p ) );
512     decrypt( *result, data[0], data[1], &sk );
513     return 0;
514 }
515
516 int
517 elg_sign( int algo, MPI *resarr, MPI data, MPI *skey )
518 {
519     ELG_secret_key sk;
520
521     if( !is_ELGAMAL(algo) )
522         return G10ERR_PUBKEY_ALGO;
523     if( !data || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
524         return G10ERR_BAD_MPI;
525
526     sk.p = skey[0];
527     sk.g = skey[1];
528     sk.y = skey[2];
529     sk.x = skey[3];
530     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
531     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
532     sign( resarr[0], resarr[1], data, &sk );
533     return 0;
534 }
535
536 int
537 elg_verify( int algo, MPI hash, MPI *data, MPI *pkey,
538                     int (*cmp)(void *, MPI), void *opaquev )
539 {
540     ELG_public_key pk;
541
542     if( !is_ELGAMAL(algo) )
543         return G10ERR_PUBKEY_ALGO;
544     if( !data[0] || !data[1] || !hash
545         || !pkey[0] || !pkey[1] || !pkey[2] )
546         return G10ERR_BAD_MPI;
547
548     pk.p = pkey[0];
549     pk.g = pkey[1];
550     pk.y = pkey[2];
551     if( !verify( data[0], data[1], hash, &pk ) )
552         return G10ERR_BAD_SIGN;
553     return 0;
554 }
555
556
557
558 unsigned
559 elg_get_nbits( int algo, MPI *pkey )
560 {
561     if( !is_ELGAMAL(algo) )
562         return 0;
563     return mpi_get_nbits( pkey[0] );
564 }
565
566
567 /****************
568  * Return some information about the algorithm.  We need algo here to
569  * distinguish different flavors of the algorithm.
570  * Returns: A pointer to string describing the algorithm or NULL if
571  *          the ALGO is invalid.
572  * Usage: Bit 0 set : allows signing
573  *            1 set : allows encryption
574  * NOTE: This function allows signing also for ELG-E, which is not
575  * okay but a bad hack to allow to work with old gpg keys. The real check
576  * is done in the gnupg ocde depending on the packet version.
577  */
578 const char *
579 elg_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
580                                                          int *use )
581 {
582     *npkey = 3;
583     *nskey = 4;
584     *nenc = 2;
585     *nsig = 2;
586
587     switch( algo ) {
588       case PUBKEY_ALGO_ELGAMAL:
589         *use = PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC;
590         return "ELG";
591       case PUBKEY_ALGO_ELGAMAL_E:
592         *use = PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC;
593         return "ELG-E";
594       default: *use = 0; return NULL;
595     }
596 }
597
598