See ChangeLog: Fri Jul 2 11:45:54 CEST 1999 Werner Koch
[gnupg.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 "util.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             m_free(rndbuf);
81             rndbuf = get_random_bits( nbits, 1, 1 );
82         }
83         else { /* change only some of the higher bits */
84             /* we could imporove this by directly requesting more memory
85              * at the first call to get_random_bits() and use this the here
86              * maybe it is easier to do this directly in random.c */
87             char *pp = get_random_bits( 32, 1, 1 );
88             memcpy( rndbuf,pp, 4 );
89             m_free(pp);
90         }
91         mpi_set_buffer( k, rndbuf, nbytes, 0 );
92         if( mpi_test_bit( k, nbits-1 ) )
93             mpi_set_highbit( k, nbits-1 );
94         else {
95             mpi_set_highbit( k, nbits-1 );
96             mpi_clear_bit( k, nbits-1 );
97         }
98
99         if( !(mpi_cmp( k, q ) < 0) ) {  /* check: k < q */
100             if( DBG_CIPHER )
101                 progress('+');
102             continue; /* no  */
103         }
104         if( !(mpi_cmp_ui( k, 0 ) > 0) ) { /* check: k > 0 */
105             if( DBG_CIPHER )
106                 progress('-');
107             continue; /* no */
108         }
109         break;  /* okay */
110     }
111     m_free(rndbuf);
112     if( DBG_CIPHER )
113         progress('\n');
114
115     return k;
116 }
117
118
119 static void
120 test_keys( DSA_secret_key *sk, unsigned qbits )
121 {
122     DSA_public_key pk;
123     MPI test = mpi_alloc( qbits / BITS_PER_MPI_LIMB );
124     MPI out1_a = mpi_alloc( qbits / BITS_PER_MPI_LIMB );
125     MPI out1_b = mpi_alloc( qbits / BITS_PER_MPI_LIMB );
126
127     pk.p = sk->p;
128     pk.q = sk->q;
129     pk.g = sk->g;
130     pk.y = sk->y;
131     /*mpi_set_bytes( test, qbits, get_random_byte, 0 );*/
132     {   char *p = get_random_bits( qbits, 0, 0 );
133         mpi_set_buffer( test, p, (qbits+7)/8, 0 );
134         m_free(p);
135     }
136
137     sign( out1_a, out1_b, test, sk );
138     if( !verify( out1_a, out1_b, test, &pk ) )
139         log_fatal("DSA:: sign, verify failed\n");
140
141     mpi_free( test );
142     mpi_free( out1_a );
143     mpi_free( out1_b );
144 }
145
146
147
148 /****************
149  * Generate a DSA key pair with a key of size NBITS
150  * Returns: 2 structures filled with all needed values
151  *          and an array with the n-1 factors of (p-1)
152  */
153 static void
154 generate( DSA_secret_key *sk, unsigned nbits, MPI **ret_factors )
155 {
156     MPI p;    /* the prime */
157     MPI q;    /* the 160 bit prime factor */
158     MPI g;    /* the generator */
159     MPI y;    /* g^x mod p */
160     MPI x;    /* the secret exponent */
161     MPI h, e;  /* helper */
162     unsigned qbits;
163     byte *rndbuf;
164
165     assert( nbits >= 512 && nbits <= 1024 );
166
167     qbits = 160;
168     p = generate_elg_prime( 1, nbits, qbits, NULL, ret_factors );
169     /* get q out of factors */
170     q = mpi_copy((*ret_factors)[0]);
171     if( mpi_get_nbits(q) != qbits )
172         BUG();
173
174     /* find a generator g (h and e are helpers)*/
175     /* e = (p-1)/q */
176     e = mpi_alloc( mpi_get_nlimbs(p) );
177     mpi_sub_ui( e, p, 1 );
178     mpi_fdiv_q( e, e, q );
179     g = mpi_alloc( mpi_get_nlimbs(p) );
180     h = mpi_alloc_set_ui( 1 ); /* we start with 2 */
181     do {
182         mpi_add_ui( h, h, 1 );
183         /* g = h^e mod p */
184         mpi_powm( g, h, e, p );
185     } while( !mpi_cmp_ui( g, 1 ) );  /* continue until g != 1 */
186
187     /* select a random number which has these properties:
188      *   0 < x < q-1
189      * This must be a very good random number because this
190      * is the secret part. */
191     if( DBG_CIPHER )
192         log_debug("choosing a random x ");
193     assert( qbits >= 160 );
194     x = mpi_alloc_secure( mpi_get_nlimbs(q) );
195     mpi_sub_ui( h, q, 1 );  /* put q-1 into h */
196     rndbuf = NULL;
197     do {
198         if( DBG_CIPHER )
199             progress('.');
200         if( !rndbuf )
201             rndbuf = get_random_bits( qbits, 2, 1 );
202         else { /* change only some of the higher bits (= 2 bytes)*/
203             char *r = get_random_bits( 16, 2, 1 );
204             memcpy(rndbuf, r, 16/8 );
205             m_free(r);
206         }
207         mpi_set_buffer( x, rndbuf, (qbits+7)/8, 0 );
208         mpi_clear_highbit( x, qbits+1 );
209     } while( !( mpi_cmp_ui( x, 0 )>0 && mpi_cmp( x, h )<0 ) );
210     m_free(rndbuf);
211     mpi_free( e );
212     mpi_free( h );
213
214     /* y = g^x mod p */
215     y = mpi_alloc( mpi_get_nlimbs(p) );
216     mpi_powm( y, g, x, p );
217
218     if( DBG_CIPHER ) {
219         progress('\n');
220         log_mpidump("dsa  p= ", p );
221         log_mpidump("dsa  q= ", q );
222         log_mpidump("dsa  g= ", g );
223         log_mpidump("dsa  y= ", y );
224         log_mpidump("dsa  x= ", x );
225     }
226
227     /* copy the stuff to the key structures */
228     sk->p = p;
229     sk->q = q;
230     sk->g = g;
231     sk->y = y;
232     sk->x = x;
233
234     /* now we can test our keys (this should never fail!) */
235     test_keys( sk, qbits );
236 }
237
238
239
240 /****************
241  * Test whether the secret key is valid.
242  * Returns: if this is a valid key.
243  */
244 static int
245 check_secret_key( DSA_secret_key *sk )
246 {
247     int rc;
248     MPI y = mpi_alloc( mpi_get_nlimbs(sk->y) );
249
250     mpi_powm( y, sk->g, sk->x, sk->p );
251     rc = !mpi_cmp( y, sk->y );
252     mpi_free( y );
253     return rc;
254 }
255
256
257
258 /****************
259  * Make a DSA signature from HASH and put it into r and s.
260  */
261
262 static void
263 sign(MPI r, MPI s, MPI hash, DSA_secret_key *skey )
264 {
265     MPI k;
266     MPI kinv;
267     MPI tmp;
268
269     /* select a random k with 0 < k < q */
270     k = gen_k( skey->q );
271
272     /* r = (a^k mod p) mod q */
273     mpi_powm( r, skey->g, k, skey->p );
274     mpi_fdiv_r( r, r, skey->q );
275
276     /* kinv = k^(-1) mod q */
277     kinv = mpi_alloc( mpi_get_nlimbs(k) );
278     mpi_invm(kinv, k, skey->q );
279
280     /* s = (kinv * ( hash + x * r)) mod q */
281     tmp = mpi_alloc( mpi_get_nlimbs(skey->p) );
282     mpi_mul( tmp, skey->x, r );
283     mpi_add( tmp, tmp, hash );
284     mpi_mulm( s , kinv, tmp, skey->q );
285
286     mpi_free(k);
287     mpi_free(kinv);
288     mpi_free(tmp);
289 }
290
291
292 /****************
293  * Returns true if the signature composed from R and S is valid.
294  */
295 static int
296 verify(MPI r, MPI s, MPI hash, DSA_public_key *pkey )
297 {
298     int rc;
299     MPI w, u1, u2, v;
300     MPI base[3];
301     MPI exp[3];
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 G10ERR_PUBKEY_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 G10ERR_PUBKEY_ALGO;
368
369     sk.p = skey[0];
370     sk.q = skey[1];
371     sk.g = skey[2];
372     sk.y = skey[3];
373     sk.x = skey[4];
374     if( !check_secret_key( &sk ) )
375         return G10ERR_BAD_SECKEY;
376
377     return 0;
378 }
379
380
381
382 int
383 dsa_sign( int algo, MPI *resarr, MPI data, MPI *skey )
384 {
385     DSA_secret_key sk;
386
387     if( algo != PUBKEY_ALGO_DSA )
388         return G10ERR_PUBKEY_ALGO;
389
390     sk.p = skey[0];
391     sk.q = skey[1];
392     sk.g = skey[2];
393     sk.y = skey[3];
394     sk.x = skey[4];
395     resarr[0] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
396     resarr[1] = mpi_alloc( mpi_get_nlimbs( sk.p ) );
397     sign( resarr[0], resarr[1], data, &sk );
398     return 0;
399 }
400
401 int
402 dsa_verify( int algo, MPI hash, MPI *data, MPI *pkey,
403                     int (*cmp)(void *, MPI), void *opaquev )
404 {
405     DSA_public_key pk;
406
407     if( algo != PUBKEY_ALGO_DSA )
408         return G10ERR_PUBKEY_ALGO;
409
410     pk.p = pkey[0];
411     pk.q = pkey[1];
412     pk.g = pkey[2];
413     pk.y = pkey[3];
414     if( !verify( data[0], data[1], hash, &pk ) )
415         return G10ERR_BAD_SIGN;
416     return 0;
417 }
418
419
420
421 unsigned
422 dsa_get_nbits( int algo, MPI *pkey )
423 {
424     if( algo != PUBKEY_ALGO_DSA )
425         return 0;
426     return mpi_get_nbits( pkey[0] );
427 }
428
429
430 /****************
431  * Return some information about the algorithm.  We need algo here to
432  * distinguish different flavors of the algorithm.
433  * Returns: A pointer to string describing the algorithm or NULL if
434  *          the ALGO is invalid.
435  * Usage: Bit 0 set : allows signing
436  *            1 set : allows encryption
437  */
438 const char *
439 dsa_get_info( int algo, int *npkey, int *nskey, int *nenc, int *nsig,
440                                                          int *use )
441 {
442     *npkey = 4;
443     *nskey = 5;
444     *nenc = 0;
445     *nsig = 2;
446
447     switch( algo ) {
448       case PUBKEY_ALGO_DSA:   *use = PUBKEY_USAGE_SIG; return "DSA";
449       default: *use = 0; return NULL;
450     }
451 }
452
453