The big extension module removal.
[gnupg.git] / cipher / elgamal.c
1 /* elgamal.c  -  ElGamal Public Key encryption
2  *      Copyright (C) 1998, 2000, 2001 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 do_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 (*progress_cb) ( void *, int );
60 static void *progress_cb_data;
61
62 void
63 register_pk_elg_progress ( void (*cb)( void *, int), void *cb_data )
64 {
65     progress_cb = cb;
66     progress_cb_data = cb_data;
67 }
68
69
70 static void
71 progress( int c )
72 {
73     if ( progress_cb )
74         progress_cb ( progress_cb_data, c );
75     else
76         fputc( c, stderr );
77 }
78
79
80 /****************
81  * Michael Wiener's table about subgroup sizes to match field sizes
82  * (floating around somewhere - Fixme: need a reference)
83  */
84 static unsigned int
85 wiener_map( unsigned int n )
86 {
87     static struct { unsigned int p_n, q_n; } t[] =
88     {   /*   p    q      attack cost */
89         {  512, 119 },  /* 9 x 10^17 */
90         {  768, 145 },  /* 6 x 10^21 */
91         { 1024, 165 },  /* 7 x 10^24 */
92         { 1280, 183 },  /* 3 x 10^27 */
93         { 1536, 198 },  /* 7 x 10^29 */
94         { 1792, 212 },  /* 9 x 10^31 */
95         { 2048, 225 },  /* 8 x 10^33 */
96         { 2304, 237 },  /* 5 x 10^35 */
97         { 2560, 249 },  /* 3 x 10^37 */
98         { 2816, 259 },  /* 1 x 10^39 */
99         { 3072, 269 },  /* 3 x 10^40 */
100         { 3328, 279 },  /* 8 x 10^41 */
101         { 3584, 288 },  /* 2 x 10^43 */
102         { 3840, 296 },  /* 4 x 10^44 */
103         { 4096, 305 },  /* 7 x 10^45 */
104         { 4352, 313 },  /* 1 x 10^47 */
105         { 4608, 320 },  /* 2 x 10^48 */
106         { 4864, 328 },  /* 2 x 10^49 */
107         { 5120, 335 },  /* 3 x 10^50 */
108         { 0, 0 }
109     };
110     int i;
111
112     for(i=0; t[i].p_n; i++ )  {
113         if( n <= t[i].p_n )
114             return t[i].q_n;
115     }
116     /* not in table - use some arbitrary high number ;-) */
117     return  n / 8 + 200;
118 }
119
120 static void
121 test_keys( ELG_secret_key *sk, unsigned nbits )
122 {
123     ELG_public_key pk;
124     MPI test = mpi_alloc( 0 );
125     MPI out1_a = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
126     MPI out1_b = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
127     MPI out2 = mpi_alloc( nbits / BITS_PER_MPI_LIMB );
128
129     pk.p = sk->p;
130     pk.g = sk->g;
131     pk.y = sk->y;
132
133     /*mpi_set_bytes( test, nbits, get_random_byte, 0 );*/
134     {   char *p = get_random_bits( nbits, 0, 0 );
135         mpi_set_buffer( test, p, (nbits+7)/8, 0 );
136         m_free(p);
137     }
138
139     do_encrypt( out1_a, out1_b, test, &pk );
140     decrypt( out2, out1_a, out1_b, sk );
141     if( mpi_cmp( test, out2 ) )
142         log_fatal("ElGamal operation: encrypt, decrypt failed\n");
143
144     sign( out1_a, out1_b, test, sk );
145     if( !verify( out1_a, out1_b, test, &pk ) )
146         log_fatal("ElGamal operation: sign, verify failed\n");
147
148     mpi_free( test );
149     mpi_free( out1_a );
150     mpi_free( out1_b );
151     mpi_free( out2 );
152 }
153
154
155 /****************
156  * generate a random secret exponent k from prime p, so
157  * that k is relatively prime to p-1
158  */
159 static MPI
160 gen_k( MPI p )
161 {
162     MPI k = mpi_alloc_secure( 0 );
163     MPI temp = mpi_alloc( mpi_get_nlimbs(p) );
164     MPI p_1 = mpi_copy(p);
165     unsigned int orig_nbits = mpi_get_nbits(p);
166     unsigned int nbits;
167     unsigned int nbytes;
168     char *rndbuf = NULL;
169
170     /* IMO using a k much lesser than p is sufficient and it greatly
171      * improves the encryption performance.  We use Wiener's table
172      * and add a large safety margin.
173      */
174     nbits = wiener_map( orig_nbits ) * 3 / 2;
175     if( nbits >= orig_nbits )
176         BUG();
177
178     nbytes = (nbits+7)/8;
179     if( DBG_CIPHER )
180         log_debug("choosing a random k of %u bits", nbits);
181     mpi_sub_ui( p_1, p, 1);
182     for(;;) {
183         if( !rndbuf || nbits < 32 ) {
184             m_free(rndbuf);
185             rndbuf = get_random_bits( nbits, 1, 1 );
186         }
187         else { /* change only some of the higher bits */
188             /* we could impprove this by directly requesting more memory
189              * at the first call to get_random_bits() and use this the here
190              * maybe it is easier to do this directly in random.c
191              * Anyway, it is highly inlikely that we will ever reach this code
192              */
193             char *pp = get_random_bits( 32, 1, 1 );
194             memcpy( rndbuf,pp, 4 );
195             m_free(pp);
196             log_debug("gen_k: tsss, never expected to reach this\n");
197         }
198         mpi_set_buffer( k, rndbuf, nbytes, 0 );
199
200         for(;;) {
201             /* Hmm, actually we don't need this step here
202              * because we use k much smaller than p - we do it anyway
203              * just in case the keep on adding a one to k ;) */
204             if( !(mpi_cmp( k, p_1 ) < 0) ) {  /* check: k < (p-1) */
205                 if( DBG_CIPHER )
206                     progress('+');
207                 break; /* no  */
208             }
209             if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
210                 if( DBG_CIPHER )
211                     progress('-');
212                 break; /* no */
213             }
214             if( mpi_gcd( temp, k, p_1 ) )
215                 goto found;  /* okay, k is relatively prime to (p-1) */
216             mpi_add_ui( k, k, 1 );
217             if( DBG_CIPHER )
218                 progress('.');
219         }
220     }
221   found:
222     m_free(rndbuf);
223     if( DBG_CIPHER )
224         progress('\n');
225     mpi_free(p_1);
226     mpi_free(temp);
227
228     return k;
229 }
230
231 /****************
232  * Generate a key pair with a key of size NBITS
233  * Returns: 2 structures filles with all needed values
234  *          and an array with n-1 factors of (p-1)
235  */
236 static void
237 generate(  ELG_secret_key *sk, unsigned int nbits, MPI **ret_factors )
238 {
239     MPI p;    /* the prime */
240     MPI p_min1;
241     MPI g;
242     MPI x;    /* the secret exponent */
243     MPI y;
244     MPI temp;
245     unsigned int qbits;
246     unsigned int xbits;
247     byte *rndbuf;
248
249     p_min1 = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
250     temp   = mpi_alloc( (nbits+BITS_PER_MPI_LIMB-1)/BITS_PER_MPI_LIMB );
251     qbits = wiener_map( nbits );
252     if( qbits & 1 ) /* better have a even one */
253         qbits++;
254     g = mpi_alloc(1);
255     p = generate_elg_prime( 0, nbits, qbits, g, ret_factors );
256     mpi_sub_ui(p_min1, p, 1);
257
258
259     /* select a random number which has these properties:
260      *   0 < x < p-1
261      * This must be a very good random number because this is the
262      * secret part.  The prime is public and may be shared anyway,
263      * so a random generator level of 1 is used for the prime.
264      *
265      * I don't see a reason to have a x of about the same size
266      * as the p.  It should be sufficient to have one about the size
267      * of q or the later used k plus a large safety margin. Decryption
268      * will be much faster with such an x.
269      */
270     xbits = qbits * 3 / 2;
271     if( xbits >= nbits )
272         BUG();
273     x = mpi_alloc_secure( xbits/BITS_PER_MPI_LIMB );
274     if( DBG_CIPHER )
275         log_debug("choosing a random x of size %u", xbits );
276     rndbuf = NULL;
277     do {
278         if( DBG_CIPHER )
279             progress('.');
280         if( rndbuf ) { /* change only some of the higher bits */
281             if( xbits < 16 ) {/* should never happen ... */
282                 m_free(rndbuf);
283                 rndbuf = get_random_bits( xbits, 2, 1 );
284             }
285             else {
286                 char *r = get_random_bits( 16, 2, 1 );
287                 memcpy(rndbuf, r, 16/8 );
288                 m_free(r);
289             }
290         }
291         else
292             rndbuf = get_random_bits( xbits, 2, 1 );
293         mpi_set_buffer( x, rndbuf, (xbits+7)/8, 0 );
294         mpi_clear_highbit( x, xbits+1 );
295     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, p_min1 )<0 ) );
296     m_free(rndbuf);
297
298     y = mpi_alloc(nbits/BITS_PER_MPI_LIMB);
299     mpi_powm( y, g, x, p );
300
301     if( DBG_CIPHER ) {
302         progress('\n');
303         log_mpidump("elg  p= ", p );
304         log_mpidump("elg  g= ", g );
305         log_mpidump("elg  y= ", y );
306         log_mpidump("elg  x= ", x );
307     }
308
309     /* copy the stuff to the key structures */
310     sk->p = p;
311     sk->g = g;
312     sk->y = y;
313     sk->x = x;
314
315     /* now we can test our keys (this should never fail!) */
316     test_keys( sk, nbits - 64 );
317
318     mpi_free( p_min1 );
319     mpi_free( temp   );
320 }
321
322
323 /****************
324  * Test whether the secret key is valid.
325  * Returns: if this is a valid key.
326  */
327 static int
328 check_secret_key( ELG_secret_key *sk )
329 {
330     int rc;
331     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
332
333     mpi_powm( y, sk->g, sk->x, sk->p );
334     rc = !mpi_cmp( y, sk->y );
335     mpi_free( y );
336     return rc;
337 }
338
339
340 static void
341 do_encrypt(MPI a, MPI b, MPI input, ELG_public_key *pkey )
342 {
343     MPI k;
344
345     /* Note: maybe we should change the interface, so that it
346      * is possible to check that input is < p and return an
347      * error code.
348      */
349
350     k = gen_k( pkey->p );
351     mpi_powm( a, pkey->g, k, pkey->p );
352     /* b = (y^k * input) mod p
353      *   = ((y^k mod p) * (input mod p)) mod p
354      * and because input is < p
355      *   = ((y^k mod p) * input) mod p
356      */
357     mpi_powm( b, pkey->y, k, pkey->p );
358     mpi_mulm( b, b, input, pkey->p );
359   #if 0
360     if( DBG_CIPHER ) {
361         log_mpidump("elg encrypted y= ", pkey->y);
362         log_mpidump("elg encrypted p= ", pkey->p);
363         log_mpidump("elg encrypted k= ", k);
364         log_mpidump("elg encrypted M= ", input);
365         log_mpidump("elg encrypted a= ", a);
366         log_mpidump("elg encrypted b= ", b);
367     }
368   #endif
369     mpi_free(k);
370 }
371
372
373
374
375 static void
376 decrypt(MPI output, MPI a, MPI b, ELG_secret_key *skey )
377 {
378     MPI t1 = mpi_alloc_secure( mpi_get_nlimbs( skey->p ) );
379
380     /* output = b/(a^x) mod p */
381     mpi_powm( t1, a, skey->x, skey->p );
382     mpi_invm( t1, t1, skey->p );
383     mpi_mulm( output, b, t1, skey->p );
384   #if 0
385     if( DBG_CIPHER ) {
386         log_mpidump("elg decrypted x= ", skey->x);
387         log_mpidump("elg decrypted p= ", skey->p);
388         log_mpidump("elg decrypted a= ", a);
389         log_mpidump("elg decrypted b= ", b);
390         log_mpidump("elg decrypted M= ", output);
391     }
392   #endif
393     mpi_free(t1);
394 }
395
396
397 /****************
398  * Make an Elgamal signature out of INPUT
399  */
400
401 static void
402 sign(MPI a, MPI b, MPI input, ELG_secret_key *skey )
403 {
404     MPI k;
405     MPI t   = mpi_alloc( mpi_get_nlimbs(a) );
406     MPI inv = mpi_alloc( mpi_get_nlimbs(a) );
407     MPI p_1 = mpi_copy(skey->p);
408
409    /*
410     * b = (t * inv) mod (p-1)
411     * b = (t * inv(k,(p-1),(p-1)) mod (p-1)
412     * b = (((M-x*a) mod (p-1)) * inv(k,(p-1),(p-1))) mod (p-1)
413     *
414     */
415     mpi_sub_ui(p_1, p_1, 1);
416     k = gen_k( skey->p );
417     mpi_powm( a, skey->g, k, skey->p );
418     mpi_mul(t, skey->x, a );
419     mpi_subm(t, input, t, p_1 );
420     while( mpi_is_neg(t) ) {
421         BUG();  /* That is nonsense code - left over from a very early test?*/
422         mpi_add(t, t, p_1);
423     }
424     mpi_invm(inv, k, p_1 );
425     mpi_mulm(b, t, inv, p_1 );
426
427   #if 0
428     if( DBG_CIPHER ) {
429         log_mpidump("elg sign p= ", skey->p);
430         log_mpidump("elg sign g= ", skey->g);
431         log_mpidump("elg sign y= ", skey->y);
432         log_mpidump("elg sign x= ", skey->x);
433         log_mpidump("elg sign k= ", k);
434         log_mpidump("elg sign M= ", input);
435         log_mpidump("elg sign a= ", a);
436         log_mpidump("elg sign b= ", b);
437     }
438   #endif
439     mpi_free(k);
440     mpi_free(t);
441     mpi_free(inv);
442     mpi_free(p_1);
443 }
444
445
446 /****************
447  * Returns true if the signature composed of A and B is valid.
448  */
449 static int
450 verify(MPI a, MPI b, MPI input, ELG_public_key *pkey )
451 {
452     int rc;
453     MPI t1;
454     MPI t2;
455     MPI base[4];
456     MPI exp[4];
457
458     if( !(mpi_cmp_ui( a, 0 ) > 0 && mpi_cmp( a, pkey->p ) < 0) )
459         return 0; /* assertion  0 < a < p  failed */
460
461     t1 = mpi_alloc( mpi_get_nlimbs(a) );
462     t2 = mpi_alloc( mpi_get_nlimbs(a) );
463
464   #if 0
465     /* t1 = (y^a mod p) * (a^b mod p) mod p */
466     mpi_powm( t1, pkey->y, a, pkey->p );
467     mpi_powm( t2, a, b, pkey->p );
468     mpi_mulm( t1, t1, t2, pkey->p );
469
470     /* t2 = g ^ input mod p */
471     mpi_powm( t2, pkey->g, input, pkey->p );
472
473     rc = !mpi_cmp( t1, t2 );
474   #elif 0
475     /* t1 = (y^a mod p) * (a^b mod p) mod p */
476     base[0] = pkey->y; exp[0] = a;
477     base[1] = a;       exp[1] = b;
478     base[2] = NULL;    exp[2] = NULL;
479     mpi_mulpowm( t1, base, exp, pkey->p );
480
481     /* t2 = g ^ input mod p */
482     mpi_powm( t2, pkey->g, input, pkey->p );
483
484     rc = !mpi_cmp( t1, t2 );
485   #else
486     /* t1 = g ^ - input * y ^ a * a ^ b  mod p */
487     mpi_invm(t2, pkey->g, pkey->p );
488     base[0] = t2     ; exp[0] = input;
489     base[1] = pkey->y; exp[1] = a;
490     base[2] = a;       exp[2] = b;
491     base[3] = NULL;    exp[3] = NULL;
492     mpi_mulpowm( t1, base, exp, pkey->p );
493     rc = !mpi_cmp_ui( t1, 1 );
494
495   #endif
496
497     mpi_free(t1);
498     mpi_free(t2);
499     return rc;
500 }
501
502 /*********************************************
503  **************  interface  ******************
504  *********************************************/
505
506 int
507 elg_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
508 {
509     ELG_secret_key sk;
510
511     if( !is_ELGAMAL(algo) )
512         return G10ERR_PUBKEY_ALGO;
513
514     generate( &sk, nbits, retfactors );
515     skey[0] = sk.p;
516     skey[1] = sk.g;
517     skey[2] = sk.y;
518     skey[3] = sk.x;
519     return 0;
520 }
521
522
523 int
524 elg_check_secret_key( int algo, MPI *skey )
525 {
526     ELG_secret_key sk;
527
528     if( !is_ELGAMAL(algo) )
529         return G10ERR_PUBKEY_ALGO;
530     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] )
531         return G10ERR_BAD_MPI;
532
533     sk.p = skey[0];
534     sk.g = skey[1];
535     sk.y = skey[2];
536     sk.x = skey[3];
537     if( !check_secret_key( &sk ) )
538         return G10ERR_BAD_SECKEY;
539
540     return 0;
541 }
542
543
544
545 int
546 elg_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey )
547 {
548     ELG_public_key pk;
549
550     if( !is_ELGAMAL(algo) )
551         return G10ERR_PUBKEY_ALGO;
552     if( !data || !pkey[0] || !pkey[1] || !pkey[2] )
553         return G10ERR_BAD_MPI;
554
555     pk.p = pkey[0];
556     pk.g = pkey[1];
557     pk.y = pkey[2];
558     resarr[0] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
559     resarr[1] = mpi_alloc( mpi_get_nlimbs( pk.p ) );
560     do_encrypt( resarr[0], resarr[1], data, &pk );
561     return 0;
562 }
563
564 int
565 elg_decrypt( int algo, MPI *result, MPI *data, MPI *skey )
566 {
567     ELG_secret_key sk;
568
569     if( !is_ELGAMAL(algo) )
570         return G10ERR_PUBKEY_ALGO;
571     if( !data[0] || !data[1]
572         || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
573         return G10ERR_BAD_MPI;
574
575     sk.p = skey[0];
576     sk.g = skey[1];
577     sk.y = skey[2];
578     sk.x = skey[3];
579     *result = mpi_alloc_secure( mpi_get_nlimbs( sk.p ) );
580     decrypt( *result, data[0], data[1], &sk );
581     return 0;
582 }
583
584 int
585 elg_sign( int algo, MPI *resarr, MPI data, MPI *skey )
586 {
587     ELG_secret_key sk;
588
589     if( !is_ELGAMAL(algo) )
590         return G10ERR_PUBKEY_ALGO;
591     if( !data || !skey[0] || !skey[1] || !skey[2] || !skey[3] )
592         return G10ERR_BAD_MPI;
593
594     sk.p = skey[0];
595     sk.g = skey[1];
596     sk.y = skey[2];
597     sk.x = skey[3];
598     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
599     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
600     sign( resarr[0], resarr[1], data, &sk );
601     return 0;
602 }
603
604 int
605 elg_verify( int algo, MPI hash, MPI *data, MPI *pkey,
606                     int (*cmp)(void *, MPI), void *opaquev )
607 {
608     ELG_public_key pk;
609
610     if( !is_ELGAMAL(algo) )
611         return G10ERR_PUBKEY_ALGO;
612     if( !data[0] || !data[1] || !hash
613         || !pkey[0] || !pkey[1] || !pkey[2] )
614         return G10ERR_BAD_MPI;
615
616     pk.p = pkey[0];
617     pk.g = pkey[1];
618     pk.y = pkey[2];
619     if( !verify( data[0], data[1], hash, &pk ) )
620         return G10ERR_BAD_SIGN;
621     return 0;
622 }
623
624
625
626 unsigned int
627 elg_get_nbits( int algo, MPI *pkey )
628 {
629     if( !is_ELGAMAL(algo) )
630         return 0;
631     return mpi_get_nbits( pkey[0] );
632 }
633
634
635 /****************
636  * Return some information about the algorithm.  We need algo here to
637  * distinguish different flavors of the algorithm.
638  * Returns: A pointer to string describing the algorithm or NULL if
639  *          the ALGO is invalid.
640  * Usage: Bit 0 set : allows signing
641  *            1 set : allows encryption
642  * NOTE: This function allows signing also for ELG-E, which is not
643  * okay but a bad hack to allow to work with old gpg keys. The real check
644  * is done in the gnupg ocde depending on the packet version.
645  */
646 const char *
647 elg_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
648                                                          int *use )
649 {
650     *npkey = 3;
651     *nskey = 4;
652     *nenc = 2;
653     *nsig = 2;
654
655     switch( algo ) {
656       case PUBKEY_ALGO_ELGAMAL:
657         *use = PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC;
658         return "ELG";
659       case PUBKEY_ALGO_ELGAMAL_E:
660         *use = PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC;
661         return "ELG-E";
662       default: *use = 0; return NULL;
663     }
664 }
665
666