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