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