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