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