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