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