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