d8ec37bd90828128fb5209bc741d803698047173
[libgcrypt.git] / cipher / dsa.c
1 /* dsa.c  -  DSA signature scheme
2  *      Copyright (C) 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser general Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt 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 Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "g10lib.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 static void (*progress_cb) (void *,const char *, int, int, int );
57 static void *progress_cb_data;
58
59 void
60 _gcry_register_pk_dsa_progress ( void (*cb)( void *,const char *, int,int,int),
61                                  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, "pk_dsa", c, 0, 0);
73 }
74
75
76
77 /****************
78  * Generate a random secret exponent k less than q
79  */
80 static MPI
81 gen_k( MPI q )
82 {
83     MPI k = mpi_alloc_secure( mpi_get_nlimbs(q) );
84     unsigned int nbits = mpi_get_nbits(q);
85     unsigned int nbytes = (nbits+7)/8;
86     char *rndbuf = NULL;
87
88     if( DBG_CIPHER )
89         log_debug("choosing a random k ");
90     for(;;) {
91         if( DBG_CIPHER )
92             progress('.');
93
94         if( !rndbuf || nbits < 32 ) {
95             gcry_free(rndbuf);
96             rndbuf = gcry_random_bytes_secure( (nbits+7)/8,
97                                                GCRY_STRONG_RANDOM );
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_bytes() and use this the here
102              * maybe it is easier to do this directly in random.c */
103             char *pp = gcry_random_bytes_secure( 4, GCRY_STRONG_RANDOM );
104             memcpy( rndbuf,pp, 4 );
105             gcry_free(pp);
106         }
107         _gcry_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     gcry_free(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 = gcry_mpi_new ( qbits  );
140     MPI out1_a = gcry_mpi_new ( qbits );
141     MPI out1_b = gcry_mpi_new ( qbits );
142
143     pk.p = sk->p;
144     pk.q = sk->q;
145     pk.g = sk->g;
146     pk.y = sk->y;
147     gcry_mpi_randomize( test, qbits, GCRY_WEAK_RANDOM );
148
149     sign( out1_a, out1_b, test, sk );
150     if( !verify( out1_a, out1_b, test, &pk ) )
151         log_fatal("DSA:: sign, verify failed\n");
152
153     gcry_mpi_release ( test );
154     gcry_mpi_release ( out1_a );
155     gcry_mpi_release ( out1_b );
156 }
157
158
159
160 /****************
161  * Generate a DSA key pair with a key of size NBITS
162  * Returns: 2 structures filled with all needed values
163  *          and an array with the n-1 factors of (p-1)
164  */
165 static void
166 generate( DSA_secret_key *sk, unsigned nbits, MPI **ret_factors )
167 {
168     MPI p;    /* the prime */
169     MPI q;    /* the 160 bit prime factor */
170     MPI g;    /* the generator */
171     MPI y;    /* g^x mod p */
172     MPI x;    /* the secret exponent */
173     MPI h, e;  /* helper */
174     unsigned qbits;
175     byte *rndbuf;
176
177     assert( nbits >= 512 && nbits <= 1024 );
178
179     qbits = 160;
180     p = _gcry_generate_elg_prime( 1, nbits, qbits, NULL, ret_factors );
181     /* get q out of factors */
182     q = mpi_copy((*ret_factors)[0]);
183     if( mpi_get_nbits(q) != qbits )
184         BUG();
185
186     /* find a generator g (h and e are helpers)*/
187     /* e = (p-1)/q */
188     e = mpi_alloc( mpi_get_nlimbs(p) );
189     mpi_sub_ui( e, p, 1 );
190     mpi_fdiv_q( e, e, q );
191     g = mpi_alloc( mpi_get_nlimbs(p) );
192     h = mpi_alloc_set_ui( 1 ); /* we start with 2 */
193     do {
194         mpi_add_ui( h, h, 1 );
195         /* g = h^e mod p */
196         gcry_mpi_powm( g, h, e, p );
197     } while( !mpi_cmp_ui( g, 1 ) );  /* continue until g != 1 */
198
199     /* select a random number which has these properties:
200      *   0 < x < q-1
201      * This must be a very good random number because this
202      * is the secret part. */
203     if( DBG_CIPHER )
204         log_debug("choosing a random x ");
205     assert( qbits >= 160 );
206     x = mpi_alloc_secure( mpi_get_nlimbs(q) );
207     mpi_sub_ui( h, q, 1 );  /* put q-1 into h */
208     rndbuf = NULL;
209     do {
210         if( DBG_CIPHER )
211             progress('.');
212         if( !rndbuf )
213             rndbuf = gcry_random_bytes_secure( (qbits+7)/8,
214                                                GCRY_VERY_STRONG_RANDOM );
215         else { /* change only some of the higher bits (= 2 bytes)*/
216             char *r = gcry_random_bytes_secure( 2,
217                                                 GCRY_VERY_STRONG_RANDOM );
218             memcpy(rndbuf, r, 2 );
219             gcry_free(r);
220         }
221         _gcry_mpi_set_buffer( x, rndbuf, (qbits+7)/8, 0 );
222         mpi_clear_highbit( x, qbits+1 );
223     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, h )<0 ) );
224     gcry_free(rndbuf);
225     mpi_free( e );
226     mpi_free( h );
227
228     /* y = g^x mod p */
229     y = mpi_alloc( mpi_get_nlimbs(p) );
230     gcry_mpi_powm( y, g, x, p );
231
232     if( DBG_CIPHER ) {
233         progress('\n');
234         log_mpidump("dsa  p= ", p );
235         log_mpidump("dsa  q= ", q );
236         log_mpidump("dsa  g= ", g );
237         log_mpidump("dsa  y= ", y );
238         log_mpidump("dsa  x= ", x );
239     }
240
241     /* copy the stuff to the key structures */
242     sk->p = p;
243     sk->q = q;
244     sk->g = g;
245     sk->y = y;
246     sk->x = x;
247
248     /* now we can test our keys (this should never fail!) */
249     test_keys( sk, qbits );
250 }
251
252
253
254 /****************
255  * Test whether the secret key is valid.
256  * Returns: if this is a valid key.
257  */
258 static int
259 check_secret_key( DSA_secret_key *sk )
260 {
261     int rc;
262     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
263
264     gcry_mpi_powm( y, sk->g, sk->x, sk->p );
265     rc = !mpi_cmp( y, sk->y );
266     mpi_free( y );
267     return rc;
268 }
269
270
271
272 /****************
273  * Make a DSA signature from HASH and put it into r and s.
274  */
275
276 static void
277 sign(MPI r, MPI s, MPI hash, DSA_secret_key *skey )
278 {
279     MPI k;
280     MPI kinv;
281     MPI tmp;
282
283     /* select a random k with 0 < k < q */
284     k = gen_k( skey->q );
285
286     /* r = (a^k mod p) mod q */
287     gcry_mpi_powm( r, skey->g, k, skey->p );
288     mpi_fdiv_r( r, r, skey->q );
289
290     /* kinv = k^(-1) mod q */
291     kinv = mpi_alloc( mpi_get_nlimbs(k) );
292     mpi_invm(kinv, k, skey->q );
293
294     /* s = (kinv * ( hash + x * r)) mod q */
295     tmp = mpi_alloc( mpi_get_nlimbs(skey->p) );
296     mpi_mul( tmp, skey->x, r );
297     mpi_add( tmp, tmp, hash );
298     mpi_mulm( s , kinv, tmp, skey->q );
299
300     mpi_free(k);
301     mpi_free(kinv);
302     mpi_free(tmp);
303 }
304
305
306 /****************
307  * Returns true if the signature composed from R and S is valid.
308  */
309 static int
310 verify(MPI r, MPI s, MPI hash, DSA_public_key *pkey )
311 {
312     int rc;
313     MPI w, u1, u2, v;
314     MPI base[3];
315     MPI exp[3];
316
317
318     if( !(mpi_cmp_ui( r, 0 ) > 0 && mpi_cmp( r, pkey->q ) < 0) )
319         return 0; /* assertion  0 < r < q  failed */
320     if( !(mpi_cmp_ui( s, 0 ) > 0 && mpi_cmp( s, pkey->q ) < 0) )
321         return 0; /* assertion  0 < s < q  failed */
322
323     w  = mpi_alloc( mpi_get_nlimbs(pkey->q) );
324     u1 = mpi_alloc( mpi_get_nlimbs(pkey->q) );
325     u2 = mpi_alloc( mpi_get_nlimbs(pkey->q) );
326     v  = mpi_alloc( mpi_get_nlimbs(pkey->p) );
327
328     /* w = s^(-1) mod q */
329     mpi_invm( w, s, pkey->q );
330
331     /* u1 = (hash * w) mod q */
332     mpi_mulm( u1, hash, w, pkey->q );
333
334     /* u2 = r * w mod q  */
335     mpi_mulm( u2, r, w, pkey->q );
336
337     /* v =  g^u1 * y^u2 mod p mod q */
338     base[0] = pkey->g; exp[0] = u1;
339     base[1] = pkey->y; exp[1] = u2;
340     base[2] = NULL;    exp[2] = NULL;
341     mpi_mulpowm( v, base, exp, pkey->p );
342     mpi_fdiv_r( v, v, pkey->q );
343
344     rc = !mpi_cmp( v, r );
345
346     mpi_free(w);
347     mpi_free(u1);
348     mpi_free(u2);
349     mpi_free(v);
350     return rc;
351 }
352
353
354 /*********************************************
355  **************  interface  ******************
356  *********************************************/
357
358 int
359 _gcry_dsa_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
360 {
361     DSA_secret_key sk;
362
363     if( algo != PUBKEY_ALGO_DSA )
364         return GCRYERR_INV_PK_ALGO;
365
366     generate( &sk, nbits, retfactors );
367     skey[0] = sk.p;
368     skey[1] = sk.q;
369     skey[2] = sk.g;
370     skey[3] = sk.y;
371     skey[4] = sk.x;
372     return 0;
373 }
374
375
376 int
377 _gcry_dsa_check_secret_key( int algo, MPI *skey )
378 {
379     DSA_secret_key sk;
380
381     if( algo != PUBKEY_ALGO_DSA )
382         return GCRYERR_INV_PK_ALGO;
383     if( !skey[0] || !skey[1] || !skey[2] || !skey[3] || !skey[4] )
384         return GCRYERR_BAD_MPI;
385
386     sk.p = skey[0];
387     sk.q = skey[1];
388     sk.g = skey[2];
389     sk.y = skey[3];
390     sk.x = skey[4];
391     if( !check_secret_key( &sk ) )
392         return GCRYERR_BAD_SECRET_KEY;
393
394     return 0;
395 }
396
397
398
399 int
400 _gcry_dsa_sign( int algo, MPI *resarr, MPI data, MPI *skey )
401 {
402     DSA_secret_key sk;
403
404     if( algo != PUBKEY_ALGO_DSA )
405         return GCRYERR_INV_PK_ALGO;
406     if( !data || !skey[0] || !skey[1] || !skey[2] || !skey[3] || !skey[4] )
407         return GCRYERR_BAD_MPI;
408
409     sk.p = skey[0];
410     sk.q = skey[1];
411     sk.g = skey[2];
412     sk.y = skey[3];
413     sk.x = skey[4];
414     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
415     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
416     sign( resarr[0], resarr[1], data, &sk );
417     return 0;
418 }
419
420 int
421 _gcry_dsa_verify( int algo, MPI hash, MPI *data, MPI *pkey,
422                     int (*cmp)(void *, MPI), void *opaquev )
423 {
424     DSA_public_key pk;
425
426     if( algo != PUBKEY_ALGO_DSA )
427         return GCRYERR_INV_PK_ALGO;
428     if( !data[0] || !data[1] || !hash
429         || !pkey[0] || !pkey[1] || !pkey[2] || !pkey[3] )
430         return GCRYERR_BAD_MPI;
431
432     pk.p = pkey[0];
433     pk.q = pkey[1];
434     pk.g = pkey[2];
435     pk.y = pkey[3];
436     if( !verify( data[0], data[1], hash, &pk ) )
437         return GCRYERR_BAD_SIGNATURE;
438     return 0;
439 }
440
441
442
443 unsigned int
444 _gcry_dsa_get_nbits( int algo, MPI *pkey )
445 {
446     if( algo != PUBKEY_ALGO_DSA )
447         return 0;
448     return mpi_get_nbits( pkey[0] );
449 }
450
451
452 /****************
453  * Return some information about the algorithm.  We need algo here to
454  * distinguish different flavors of the algorithm.
455  * Returns: A pointer to string describing the algorithm or NULL if
456  *          the ALGO is invalid.
457  * Usage: Bit 0 set : allows signing
458  *            1 set : allows encryption
459  */
460 const char *
461 _gcry_dsa_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
462                                                          int *use )
463 {
464     *npkey = 4;
465     *nskey = 5;
466     *nenc = 0;
467     *nsig = 2;
468
469     switch( algo ) {
470       case PUBKEY_ALGO_DSA:   *use = GCRY_PK_USAGE_SIGN; return "DSA";
471       default: *use = 0; return NULL;
472     }
473 }
474
475