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