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