tools: Fix option parsing for gpg-zip.
[gnupg.git] / cipher / dsa.c
1 /* dsa.c  -  DSA signature algorithm
2  * Copyright (C) 1998, 1999, 2000, 2003, 2006 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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <assert.h>
25 #include "util.h"
26 #include "mpi.h"
27 #include "cipher.h"
28 #include "dsa.h"
29
30 typedef struct {
31     MPI p;          /* prime */
32     MPI q;          /* group order */
33     MPI g;          /* group generator */
34     MPI y;          /* g^x mod p */
35 } DSA_public_key;
36
37
38 typedef struct {
39     MPI p;          /* prime */
40     MPI q;          /* group order */
41     MPI g;          /* group generator */
42     MPI y;          /* g^x mod p */
43     MPI x;          /* secret exponent */
44 } DSA_secret_key;
45
46
47 static MPI gen_k( MPI q );
48 static void test_keys( DSA_secret_key *sk, unsigned qbits );
49 static int  check_secret_key( DSA_secret_key *sk );
50 static void generate( DSA_secret_key *sk, unsigned nbits, unsigned qbits,
51                       MPI **ret_factors );
52 static void sign(MPI r, MPI s, MPI input, DSA_secret_key *skey);
53 static int  verify(MPI r, MPI s, MPI input, DSA_public_key *pkey);
54
55
56 static void (*progress_cb) ( void *, int );
57 static void *progress_cb_data;
58
59 void
60 register_pk_dsa_progress ( void (*cb)( void *, int), void *cb_data )
61 {
62     progress_cb = cb;
63     progress_cb_data = cb_data;
64 }
65
66
67 static void
68 progress( int c )
69 {
70     if ( progress_cb )
71         progress_cb ( progress_cb_data, c );
72     else
73         fputc( c, stderr );
74 }
75
76
77
78 /****************
79  * Generate a random secret exponent k less than q
80  */
81 static MPI
82 gen_k( MPI q )
83 {
84     MPI k = mpi_alloc_secure( mpi_get_nlimbs(q) );
85     unsigned int nbits = mpi_get_nbits(q);
86     unsigned int nbytes = (nbits+7)/8;
87     char *rndbuf = NULL;
88
89     if( DBG_CIPHER )
90         log_debug("choosing a random k ");
91     for(;;) {
92         if( DBG_CIPHER )
93             progress('.');
94
95         if( !rndbuf || nbits < 32 ) {
96             xfree(rndbuf);
97             rndbuf = get_random_bits( nbits, 1, 1 );
98         }
99         else { /* change only some of the higher bits */
100             /* we could imporove this by directly requesting more memory
101              * at the first call to get_random_bits() and use this the here
102              * maybe it is easier to do this directly in random.c */
103             char *pp = get_random_bits( 32, 1, 1 );
104             memcpy( rndbuf,pp, 4 );
105             xfree(pp);
106         }
107         mpi_set_buffer( k, rndbuf, nbytes, 0 );
108         if( mpi_test_bit( k, nbits-1 ) )
109             mpi_set_highbit( k, nbits-1 );
110         else {
111             mpi_set_highbit( k, nbits-1 );
112             mpi_clear_bit( k, nbits-1 );
113         }
114
115         if( !(mpi_cmp( k, q ) < 0) ) {  /* check: k < q */
116             if( DBG_CIPHER )
117                 progress('+');
118             continue; /* no  */
119         }
120         if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
121             if( DBG_CIPHER )
122                 progress('-');
123             continue; /* no */
124         }
125         break;  /* okay */
126     }
127     xfree(rndbuf);
128     if( DBG_CIPHER )
129         progress('\n');
130
131     return k;
132 }
133
134
135 static void
136 test_keys( DSA_secret_key *sk, unsigned qbits )
137 {
138     DSA_public_key pk;
139     MPI test = mpi_alloc ( mpi_nlimb_hint_from_nbits (qbits) );
140     MPI out1_a = mpi_alloc ( mpi_nlimb_hint_from_nbits (qbits) );
141     MPI out1_b = mpi_alloc( mpi_nlimb_hint_from_nbits (qbits) );
142
143     pk.p = sk->p;
144     pk.q = sk->q;
145     pk.g = sk->g;
146     pk.y = sk->y;
147     /*mpi_set_bytes( test, qbits, get_random_byte, 0 );*/
148     {   char *p = get_random_bits( qbits, 0, 0 );
149         mpi_set_buffer( test, p, (qbits+7)/8, 0 );
150         xfree(p);
151     }
152
153     sign( out1_a, out1_b, test, sk );
154     if( !verify( out1_a, out1_b, test, &pk ) )
155         log_fatal("DSA:: sign, verify failed\n");
156
157     mpi_free( test );
158     mpi_free( out1_a );
159     mpi_free( out1_b );
160 }
161
162
163
164 /****************
165  * Generate a DSA key pair with a key of size NBITS
166  * Returns: 2 structures filled with all needed values
167  *          and an array with the n-1 factors of (p-1)
168  */
169 static void
170 generate( DSA_secret_key *sk, unsigned nbits, unsigned qbits,
171           MPI **ret_factors )
172 {
173     MPI p;    /* the prime */
174     MPI q;    /* the 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     byte *rndbuf;
180
181     assert( nbits >= 512 );
182     assert( qbits >= 160 );
183     assert( qbits %8 == 0 );
184
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     x = mpi_alloc_secure( mpi_get_nlimbs(q) );
211     mpi_sub_ui( h, q, 1 );  /* put q-1 into h */
212     rndbuf = NULL;
213     do {
214         if( DBG_CIPHER )
215             progress('.');
216         if( !rndbuf )
217             rndbuf = get_random_bits( qbits, 2, 1 );
218         else { /* change only some of the higher bits (= 2 bytes)*/
219             char *r = get_random_bits( 16, 2, 1 );
220             memcpy(rndbuf, r, 16/8 );
221             xfree(r);
222         }
223         mpi_set_buffer( x, rndbuf, (qbits+7)/8, 0 );
224         mpi_clear_highbit( x, qbits+1 );
225     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, h )<0 ) );
226     xfree(rndbuf);
227     mpi_free( e );
228     mpi_free( h );
229
230     /* y = g^x mod p */
231     y = mpi_alloc( mpi_get_nlimbs(p) );
232     mpi_powm( y, g, x, p );
233
234     if( DBG_CIPHER ) {
235         progress('\n');
236         log_mpidump("dsa  p= ", p );
237         log_mpidump("dsa  q= ", q );
238         log_mpidump("dsa  g= ", g );
239         log_mpidump("dsa  y= ", y );
240         log_mpidump("dsa  x= ", x );
241     }
242
243     /* copy the stuff to the key structures */
244     sk->p = p;
245     sk->q = q;
246     sk->g = g;
247     sk->y = y;
248     sk->x = x;
249
250     /* now we can test our keys (this should never fail!) */
251     test_keys( sk, qbits );
252 }
253
254
255
256 /****************
257  * Test whether the secret key is valid.
258  * Returns: if this is a valid key.
259  */
260 static int
261 check_secret_key( DSA_secret_key *sk )
262 {
263     int rc;
264     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
265
266     mpi_powm( y, sk->g, sk->x, sk->p );
267     rc = !mpi_cmp( y, sk->y );
268     mpi_free( y );
269     return rc;
270 }
271
272
273
274 /****************
275  * Make a DSA signature from HASH and put it into r and s.
276  *
277  * Without generating the k this function runs in
278  * about 26ms on a 300 Mhz Mobile Pentium
279  */
280
281 static void
282 sign(MPI r, MPI s, MPI hash, DSA_secret_key *skey )
283 {
284     MPI k;
285     MPI kinv;
286     MPI tmp;
287
288     mpi_normalize (hash);
289
290     /* select a random k with 0 < k < q */
291     k = gen_k( skey->q );
292
293     /* r = (a^k mod p) mod q */
294     mpi_powm( r, skey->g, k, skey->p );
295     mpi_fdiv_r( r, r, skey->q );
296
297     /* kinv = k^(-1) mod q */
298     kinv = mpi_alloc( mpi_get_nlimbs(k) );
299     mpi_invm(kinv, k, skey->q );
300
301     /* s = (kinv * ( hash + x * r)) mod q */
302     tmp = mpi_alloc( mpi_get_nlimbs(skey->p) );
303     mpi_mul( tmp, skey->x, r );
304     mpi_add( tmp, tmp, hash );
305     mpi_mulm( s , kinv, tmp, skey->q );
306
307     mpi_free(k);
308     mpi_free(kinv);
309     mpi_free(tmp);
310 }
311
312
313 /****************
314  * Returns true if the signature composed from R and S is valid.
315  *
316  * Without the checks this function runs in
317  * about 31ms on a 300 Mhz Mobile Pentium
318  */
319 static int
320 verify(MPI r, MPI s, MPI hash, DSA_public_key *pkey )
321 {
322     int rc;
323     MPI w, u1, u2, v;
324     MPI base[3];
325     MPI exponent[3];
326
327
328     if( !(mpi_cmp_ui( r, 0 ) > 0 && mpi_cmp( r, pkey->q ) < 0) )
329         return 0; /* assertion  0 < r < q  failed */
330     if( !(mpi_cmp_ui( s, 0 ) > 0 && mpi_cmp( s, pkey->q ) < 0) )
331         return 0; /* assertion  0 < s < q  failed */
332
333     w  = mpi_alloc( mpi_get_nlimbs(pkey->q) );
334     u1 = mpi_alloc( mpi_get_nlimbs(pkey->q) );
335     u2 = mpi_alloc( mpi_get_nlimbs(pkey->q) );
336     v  = mpi_alloc( mpi_get_nlimbs(pkey->p) );
337
338     /* w = s^(-1) mod q */
339     mpi_invm( w, s, pkey->q );
340
341     /* u1 = (hash * w) mod q */
342     mpi_mulm( u1, hash, w, pkey->q );
343
344     /* u2 = r * w mod q  */
345     mpi_mulm( u2, r, w, pkey->q );
346
347     /* v =  g^u1 * y^u2 mod p mod q */
348     base[0] = pkey->g; exponent[0] = u1;
349     base[1] = pkey->y; exponent[1] = u2;
350     base[2] = NULL;    exponent[2] = NULL;
351     mpi_mulpowm( v, base, exponent, pkey->p );
352     mpi_fdiv_r( v, v, pkey->q );
353
354     rc = !mpi_cmp( v, r );
355
356     mpi_free(w);
357     mpi_free(u1);
358     mpi_free(u2);
359     mpi_free(v);
360     return rc;
361 }
362
363
364 /*********************************************
365  **************  interface  ******************
366  *********************************************/
367
368 /* DSA2 has a variable-sized q, which adds an extra parameter to the
369    pubkey generation.  I'm doing this as a different function as it is
370    only called from one place and is thus cleaner than revamping the
371    pubkey_generate interface to carry an extra parameter which would
372    be meaningless for all algorithms other than DSA. */
373
374 int
375 dsa2_generate( int algo, unsigned nbits, unsigned qbits,
376                MPI *skey, MPI **retfactors )
377 {
378     DSA_secret_key sk;
379
380     if( algo != PUBKEY_ALGO_DSA )
381         return G10ERR_PUBKEY_ALGO;
382
383     generate( &sk, nbits, qbits, retfactors );
384     skey[0] = sk.p;
385     skey[1] = sk.q;
386     skey[2] = sk.g;
387     skey[3] = sk.y;
388     skey[4] = sk.x;
389     return 0;
390 }
391
392
393 int
394 dsa_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
395 {
396   return dsa2_generate(algo,nbits,160,skey,retfactors);
397 }
398
399
400 int
401 dsa_check_secret_key( int algo, MPI *skey )
402 {
403     DSA_secret_key sk;
404
405     if( algo != PUBKEY_ALGO_DSA )
406         return G10ERR_PUBKEY_ALGO;
407     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] || !skey[4] )
408         return G10ERR_BAD_MPI;
409
410     sk.p = skey[0];
411     sk.q = skey[1];
412     sk.g = skey[2];
413     sk.y = skey[3];
414     sk.x = skey[4];
415     if( !check_secret_key( &sk ) )
416         return G10ERR_BAD_SECKEY;
417
418     return 0;
419 }
420
421
422
423 int
424 dsa_sign( int algo, MPI *resarr, MPI data, MPI *skey )
425 {
426     DSA_secret_key sk;
427
428     if( algo != PUBKEY_ALGO_DSA )
429         return G10ERR_PUBKEY_ALGO;
430     if( !data || !skey[0] || !skey[1] || !skey[2] || !skey[3] || !skey[4] )
431         return G10ERR_BAD_MPI;
432
433     sk.p = skey[0];
434     sk.q = skey[1];
435     sk.g = skey[2];
436     sk.y = skey[3];
437     sk.x = skey[4];
438     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
439     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
440     sign( resarr[0], resarr[1], data, &sk );
441     return 0;
442 }
443
444 int
445 dsa_verify( int algo, MPI hash, MPI *data, MPI *pkey )
446 {
447     DSA_public_key pk;
448
449     if( algo != PUBKEY_ALGO_DSA )
450         return G10ERR_PUBKEY_ALGO;
451     if( !data[0] || !data[1] || !hash
452         || !pkey[0] || !pkey[1] || !pkey[2] || !pkey[3] )
453         return G10ERR_BAD_MPI;
454
455     pk.p = pkey[0];
456     pk.q = pkey[1];
457     pk.g = pkey[2];
458     pk.y = pkey[3];
459     if( !verify( data[0], data[1], hash, &pk ) )
460         return G10ERR_BAD_SIGN;
461     return 0;
462 }
463
464
465
466 unsigned
467 dsa_get_nbits( int algo, MPI *pkey )
468 {
469     if( algo != PUBKEY_ALGO_DSA )
470         return 0;
471     return mpi_get_nbits( pkey[0] );
472 }
473
474
475 /****************
476  * Return some information about the algorithm.  We need algo here to
477  * distinguish different flavors of the algorithm.
478  * Returns: A pointer to string describing the algorithm or NULL if
479  *          the ALGO is invalid.
480  * Usage: Bit 0 set : allows signing
481  *            1 set : allows encryption
482  */
483 const char *
484 dsa_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
485                                                          int *use )
486 {
487     *npkey = 4;
488     *nskey = 5;
489     *nenc = 0;
490     *nsig = 2;
491
492     switch( algo ) {
493       case PUBKEY_ALGO_DSA:   *use = PUBKEY_USAGE_SIG; return "DSA";
494       default: *use = 0; return NULL;
495     }
496 }