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