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