* getkey.c (parse_auto_key_locate): Fix dupe-removal code.
[gnupg.git] / cipher / dsa.c
1 /* dsa.c  -  DSA signature algorithm
2  *      Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <assert.h>
27 #include "util.h"
28 #include "mpi.h"
29 #include "cipher.h"
30 #include "dsa.h"
31
32 typedef struct {
33     MPI p;          /* prime */
34     MPI q;          /* group order */
35     MPI g;          /* group generator */
36     MPI y;          /* g^x mod p */
37 } DSA_public_key;
38
39
40 typedef struct {
41     MPI p;          /* prime */
42     MPI q;          /* group order */
43     MPI g;          /* group generator */
44     MPI y;          /* g^x mod p */
45     MPI x;          /* secret exponent */
46 } DSA_secret_key;
47
48
49 static MPI gen_k( MPI q );
50 static void test_keys( DSA_secret_key *sk, unsigned qbits );
51 static int  check_secret_key( DSA_secret_key *sk );
52 static void generate( DSA_secret_key *sk, unsigned nbits, MPI **ret_factors );
53 static void sign(MPI r, MPI s, MPI input, DSA_secret_key *skey);
54 static int  verify(MPI r, MPI s, MPI input, DSA_public_key *pkey);
55
56
57 static void (*progress_cb) ( void *, int );
58 static void *progress_cb_data;
59
60 void
61 register_pk_dsa_progress ( void (*cb)( void *, int), void *cb_data )
62 {
63     progress_cb = cb;
64     progress_cb_data = cb_data;
65 }
66
67
68 static void
69 progress( int c )
70 {
71     if ( progress_cb )
72         progress_cb ( progress_cb_data, c );
73     else
74         fputc( c, stderr );
75 }
76
77
78
79 /****************
80  * Generate a random secret exponent k less than q
81  */
82 static MPI
83 gen_k( MPI q )
84 {
85     MPI k = mpi_alloc_secure( mpi_get_nlimbs(q) );
86     unsigned int nbits = mpi_get_nbits(q);
87     unsigned int nbytes = (nbits+7)/8;
88     char *rndbuf = NULL;
89
90     if( DBG_CIPHER )
91         log_debug("choosing a random k ");
92     for(;;) {
93         if( DBG_CIPHER )
94             progress('.');
95
96         if( !rndbuf || nbits < 32 ) {
97             xfree(rndbuf);
98             rndbuf = get_random_bits( nbits, 1, 1 );
99         }
100         else { /* change only some of the higher bits */
101             /* we could imporove this by directly requesting more memory
102              * at the first call to get_random_bits() and use this the here
103              * maybe it is easier to do this directly in random.c */
104             char *pp = get_random_bits( 32, 1, 1 );
105             memcpy( rndbuf,pp, 4 );
106             xfree(pp);
107         }
108         mpi_set_buffer( k, rndbuf, nbytes, 0 );
109         if( mpi_test_bit( k, nbits-1 ) )
110             mpi_set_highbit( k, nbits-1 );
111         else {
112             mpi_set_highbit( k, nbits-1 );
113             mpi_clear_bit( k, nbits-1 );
114         }
115
116         if( !(mpi_cmp( k, q ) < 0) ) {  /* check: k < q */
117             if( DBG_CIPHER )
118                 progress('+');
119             continue; /* no  */
120         }
121         if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
122             if( DBG_CIPHER )
123                 progress('-');
124             continue; /* no */
125         }
126         break;  /* okay */
127     }
128     xfree(rndbuf);
129     if( DBG_CIPHER )
130         progress('\n');
131
132     return k;
133 }
134
135
136 static void
137 test_keys( DSA_secret_key *sk, unsigned qbits )
138 {
139     DSA_public_key pk;
140     MPI test = mpi_alloc( qbits / BITS_PER_MPI_LIMB );
141     MPI out1_a = mpi_alloc( qbits / BITS_PER_MPI_LIMB );
142     MPI out1_b = mpi_alloc( qbits / BITS_PER_MPI_LIMB );
143
144     pk.p = sk->p;
145     pk.q = sk->q;
146     pk.g = sk->g;
147     pk.y = sk->y;
148     /*mpi_set_bytes( test, qbits, get_random_byte, 0 );*/
149     {   char *p = get_random_bits( qbits, 0, 0 );
150         mpi_set_buffer( test, p, (qbits+7)/8, 0 );
151         xfree(p);
152     }
153
154     sign( out1_a, out1_b, test, sk );
155     if( !verify( out1_a, out1_b, test, &pk ) )
156         log_fatal("DSA:: sign, verify failed\n");
157
158     mpi_free( test );
159     mpi_free( out1_a );
160     mpi_free( out1_b );
161 }
162
163
164
165 /****************
166  * Generate a DSA key pair with a key of size NBITS
167  * Returns: 2 structures filled with all needed values
168  *          and an array with the n-1 factors of (p-1)
169  */
170 static void
171 generate( DSA_secret_key *sk, unsigned nbits, MPI **ret_factors )
172 {
173     MPI p;    /* the prime */
174     MPI q;    /* the 160 bit prime factor */
175     MPI g;    /* the generator */
176     MPI y;    /* g^x mod p */
177     MPI x;    /* the secret exponent */
178     MPI h, e;  /* helper */
179     unsigned qbits;
180     byte *rndbuf;
181
182     assert( nbits >= 512 && nbits <= 1024 );
183
184     qbits = 160;
185     p = generate_elg_prime( 1, nbits, qbits, NULL, ret_factors );
186     /* get q out of factors */
187     q = mpi_copy((*ret_factors)[0]);
188     if( mpi_get_nbits(q) != qbits )
189         BUG();
190
191     /* find a generator g (h and e are helpers)*/
192     /* e = (p-1)/q */
193     e = mpi_alloc( mpi_get_nlimbs(p) );
194     mpi_sub_ui( e, p, 1 );
195     mpi_fdiv_q( e, e, q );
196     g = mpi_alloc( mpi_get_nlimbs(p) );
197     h = mpi_alloc_set_ui( 1 ); /* we start with 2 */
198     do {
199         mpi_add_ui( h, h, 1 );
200         /* g = h^e mod p */
201         mpi_powm( g, h, e, p );
202     } while( !mpi_cmp_ui( g, 1 ) );  /* continue until g != 1 */
203
204     /* select a random number which has these properties:
205      *   0 < x < q-1
206      * This must be a very good random number because this
207      * is the secret part. */
208     if( DBG_CIPHER )
209         log_debug("choosing a random x ");
210     assert( qbits >= 160 );
211     x = mpi_alloc_secure( mpi_get_nlimbs(q) );
212     mpi_sub_ui( h, q, 1 );  /* put q-1 into h */
213     rndbuf = NULL;
214     do {
215         if( DBG_CIPHER )
216             progress('.');
217         if( !rndbuf )
218             rndbuf = get_random_bits( qbits, 2, 1 );
219         else { /* change only some of the higher bits (= 2 bytes)*/
220             char *r = get_random_bits( 16, 2, 1 );
221             memcpy(rndbuf, r, 16/8 );
222             xfree(r);
223         }
224         mpi_set_buffer( x, rndbuf, (qbits+7)/8, 0 );
225         mpi_clear_highbit( x, qbits+1 );
226     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, h )<0 ) );
227     xfree(rndbuf);
228     mpi_free( e );
229     mpi_free( h );
230
231     /* y = g^x mod p */
232     y = mpi_alloc( mpi_get_nlimbs(p) );
233     mpi_powm( y, g, x, p );
234
235     if( DBG_CIPHER ) {
236         progress('\n');
237         log_mpidump("dsa  p= ", p );
238         log_mpidump("dsa  q= ", q );
239         log_mpidump("dsa  g= ", g );
240         log_mpidump("dsa  y= ", y );
241         log_mpidump("dsa  x= ", x );
242     }
243
244     /* copy the stuff to the key structures */
245     sk->p = p;
246     sk->q = q;
247     sk->g = g;
248     sk->y = y;
249     sk->x = x;
250
251     /* now we can test our keys (this should never fail!) */
252     test_keys( sk, qbits );
253 }
254
255
256
257 /****************
258  * Test whether the secret key is valid.
259  * Returns: if this is a valid key.
260  */
261 static int
262 check_secret_key( DSA_secret_key *sk )
263 {
264     int rc;
265     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
266
267     mpi_powm( y, sk->g, sk->x, sk->p );
268     rc = !mpi_cmp( y, sk->y );
269     mpi_free( y );
270     return rc;
271 }
272
273
274
275 /****************
276  * Make a DSA signature from HASH and put it into r and s.
277  *
278  * Without generating the k this function runs in 
279  * about 26ms on a 300 Mhz Mobile Pentium
280  */
281
282 static void
283 sign(MPI r, MPI s, MPI hash, DSA_secret_key *skey )
284 {
285     MPI k;
286     MPI kinv;
287     MPI tmp;
288
289     /* select a random k with 0 < k < q */
290     k = gen_k( skey->q );
291
292     /* r = (a^k mod p) mod q */
293     mpi_powm( r, skey->g, k, skey->p );
294     mpi_fdiv_r( r, r, skey->q );
295
296     /* kinv = k^(-1) mod q */
297     kinv = mpi_alloc( mpi_get_nlimbs(k) );
298     mpi_invm(kinv, k, skey->q );
299
300     /* s = (kinv * ( hash + x * r)) mod q */
301     tmp = mpi_alloc( mpi_get_nlimbs(skey->p) );
302     mpi_mul( tmp, skey->x, r );
303     mpi_add( tmp, tmp, hash );
304     mpi_mulm( s , kinv, tmp, skey->q );
305
306     mpi_free(k);
307     mpi_free(kinv);
308     mpi_free(tmp);
309 }
310
311
312 /****************
313  * Returns true if the signature composed from R and S is valid.
314  *
315  * Without the checks this function runs in 
316  * about 31ms on a 300 Mhz Mobile Pentium
317  */
318 static int
319 verify(MPI r, MPI s, MPI hash, DSA_public_key *pkey )
320 {
321     int rc;
322     MPI w, u1, u2, v;
323     MPI base[3];
324     MPI exponent[3];
325
326
327     if( !(mpi_cmp_ui( r, 0 ) > 0 && mpi_cmp( r, pkey->q ) < 0) )
328         return 0; /* assertion  0 < r < q  failed */
329     if( !(mpi_cmp_ui( s, 0 ) > 0 && mpi_cmp( s, pkey->q ) < 0) )
330         return 0; /* assertion  0 < s < q  failed */
331
332     w  = mpi_alloc( mpi_get_nlimbs(pkey->q) );
333     u1 = mpi_alloc( mpi_get_nlimbs(pkey->q) );
334     u2 = mpi_alloc( mpi_get_nlimbs(pkey->q) );
335     v  = mpi_alloc( mpi_get_nlimbs(pkey->p) );
336
337     /* w = s^(-1) mod q */
338     mpi_invm( w, s, pkey->q );
339
340     /* u1 = (hash * w) mod q */
341     mpi_mulm( u1, hash, w, pkey->q );
342
343     /* u2 = r * w mod q  */
344     mpi_mulm( u2, r, w, pkey->q );
345
346     /* v =  g^u1 * y^u2 mod p mod q */
347     base[0] = pkey->g; exponent[0] = u1;
348     base[1] = pkey->y; exponent[1] = u2;
349     base[2] = NULL;    exponent[2] = NULL;
350     mpi_mulpowm( v, base, exponent, pkey->p );
351     mpi_fdiv_r( v, v, pkey->q );
352
353     rc = !mpi_cmp( v, r );
354
355     mpi_free(w);
356     mpi_free(u1);
357     mpi_free(u2);
358     mpi_free(v);
359     return rc;
360 }
361
362
363 /*********************************************
364  **************  interface  ******************
365  *********************************************/
366
367 int
368 dsa_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
369 {
370     DSA_secret_key sk;
371
372     if( algo != PUBKEY_ALGO_DSA )
373         return G10ERR_PUBKEY_ALGO;
374
375     generate( &sk, nbits, retfactors );
376     skey[0] = sk.p;
377     skey[1] = sk.q;
378     skey[2] = sk.g;
379     skey[3] = sk.y;
380     skey[4] = sk.x;
381     return 0;
382 }
383
384
385 int
386 dsa_check_secret_key( int algo, MPI *skey )
387 {
388     DSA_secret_key sk;
389
390     if( algo != PUBKEY_ALGO_DSA )
391         return G10ERR_PUBKEY_ALGO;
392     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] || !skey[4] )
393         return G10ERR_BAD_MPI;
394
395     sk.p = skey[0];
396     sk.q = skey[1];
397     sk.g = skey[2];
398     sk.y = skey[3];
399     sk.x = skey[4];
400     if( !check_secret_key( &sk ) )
401         return G10ERR_BAD_SECKEY;
402
403     return 0;
404 }
405
406
407
408 int
409 dsa_sign( int algo, MPI *resarr, MPI data, MPI *skey )
410 {
411     DSA_secret_key sk;
412
413     if( algo != PUBKEY_ALGO_DSA )
414         return G10ERR_PUBKEY_ALGO;
415     if( !data || !skey[0] || !skey[1] || !skey[2] || !skey[3] || !skey[4] )
416         return G10ERR_BAD_MPI;
417
418     sk.p = skey[0];
419     sk.q = skey[1];
420     sk.g = skey[2];
421     sk.y = skey[3];
422     sk.x = skey[4];
423     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
424     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
425     sign( resarr[0], resarr[1], data, &sk );
426     return 0;
427 }
428
429 int
430 dsa_verify( int algo, MPI hash, MPI *data, MPI *pkey )
431 {
432     DSA_public_key pk;
433
434     if( algo != PUBKEY_ALGO_DSA )
435         return G10ERR_PUBKEY_ALGO;
436     if( !data[0] || !data[1] || !hash
437         || !pkey[0] || !pkey[1] || !pkey[2] || !pkey[3] )
438         return G10ERR_BAD_MPI;
439
440     pk.p = pkey[0];
441     pk.q = pkey[1];
442     pk.g = pkey[2];
443     pk.y = pkey[3];
444     if( !verify( data[0], data[1], hash, &pk ) )
445         return G10ERR_BAD_SIGN;
446     return 0;
447 }
448
449
450
451 unsigned
452 dsa_get_nbits( int algo, MPI *pkey )
453 {
454     if( algo != PUBKEY_ALGO_DSA )
455         return 0;
456     return mpi_get_nbits( pkey[0] );
457 }
458
459
460 /****************
461  * Return some information about the algorithm.  We need algo here to
462  * distinguish different flavors of the algorithm.
463  * Returns: A pointer to string describing the algorithm or NULL if
464  *          the ALGO is invalid.
465  * Usage: Bit 0 set : allows signing
466  *            1 set : allows encryption
467  */
468 const char *
469 dsa_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
470                                                          int *use )
471 {
472     *npkey = 4;
473     *nskey = 5;
474     *nenc = 0;
475     *nsig = 2;
476
477     switch( algo ) {
478       case PUBKEY_ALGO_DSA:   *use = PUBKEY_USAGE_SIG; return "DSA";
479       default: *use = 0; return NULL;
480     }
481 }