Inlcude README.ECC in FIPS restricted tarball.
[openssl.git] / crypto / dsa / dsa_ossl.c
1 /* crypto/dsa/dsa_ossl.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 /* Original version from Steven Schoch <schoch@sheba.arc.nasa.gov> */
60
61 #define OPENSSL_FIPSAPI
62
63 #include <stdio.h>
64 #include "cryptlib.h"
65 #include <openssl/bn.h>
66 #include <openssl/sha.h>
67 #include <openssl/dsa.h>
68 #include <openssl/rand.h>
69 #include <openssl/asn1.h>
70 #ifdef OPENSSL_FIPS
71 #include <openssl/fips.h>
72 #endif
73
74 static DSA_SIG *dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
75 static int dsa_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
76 static int dsa_do_verify(const unsigned char *dgst, int dgst_len, DSA_SIG *sig,
77                          DSA *dsa);
78 static int dsa_init(DSA *dsa);
79 static int dsa_finish(DSA *dsa);
80
81 static DSA_METHOD openssl_dsa_meth = {
82 "OpenSSL DSA method",
83 dsa_do_sign,
84 dsa_sign_setup,
85 dsa_do_verify,
86 NULL, /* dsa_mod_exp, */
87 NULL, /* dsa_bn_mod_exp, */
88 dsa_init,
89 dsa_finish,
90 DSA_FLAG_FIPS_METHOD,
91 NULL,
92 NULL,
93 NULL
94 };
95
96 /* These macro wrappers replace attempts to use the dsa_mod_exp() and
97  * bn_mod_exp() handlers in the DSA_METHOD structure. We avoid the problem of
98  * having a the macro work as an expression by bundling an "err_instr". So;
99  * 
100  *     if (!dsa->meth->bn_mod_exp(dsa, r,dsa->g,&k,dsa->p,ctx,
101  *                 dsa->method_mont_p)) goto err;
102  *
103  * can be replaced by;
104  *
105  *     DSA_BN_MOD_EXP(goto err, dsa, r, dsa->g, &k, dsa->p, ctx,
106  *                 dsa->method_mont_p);
107  */
108
109 #define DSA_MOD_EXP(err_instr,dsa,rr,a1,p1,a2,p2,m,ctx,in_mont) \
110         do { \
111         int _tmp_res53; \
112         if((dsa)->meth->dsa_mod_exp) \
113                 _tmp_res53 = (dsa)->meth->dsa_mod_exp((dsa), (rr), (a1), (p1), \
114                                 (a2), (p2), (m), (ctx), (in_mont)); \
115         else \
116                 _tmp_res53 = BN_mod_exp2_mont((rr), (a1), (p1), (a2), (p2), \
117                                 (m), (ctx), (in_mont)); \
118         if(!_tmp_res53) err_instr; \
119         } while(0)
120 #define DSA_BN_MOD_EXP(err_instr,dsa,r,a,p,m,ctx,m_ctx) \
121         do { \
122         int _tmp_res53; \
123         if((dsa)->meth->bn_mod_exp) \
124                 _tmp_res53 = (dsa)->meth->bn_mod_exp((dsa), (r), (a), (p), \
125                                 (m), (ctx), (m_ctx)); \
126         else \
127                 _tmp_res53 = BN_mod_exp_mont((r), (a), (p), (m), (ctx), (m_ctx)); \
128         if(!_tmp_res53) err_instr; \
129         } while(0)
130
131 const DSA_METHOD *DSA_OpenSSL(void)
132 {
133         return &openssl_dsa_meth;
134 }
135
136 static DSA_SIG *dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa)
137         {
138         BIGNUM *kinv=NULL,*r=NULL,*s=NULL;
139         BIGNUM m;
140         BIGNUM xr;
141         BN_CTX *ctx=NULL;
142         int reason=ERR_R_BN_LIB;
143         DSA_SIG *ret=NULL;
144         int noredo = 0;
145
146 #ifdef OPENSSL_FIPS
147         if(FIPS_selftest_failed())
148             {
149             FIPSerr(FIPS_F_DSA_DO_SIGN,FIPS_R_FIPS_SELFTEST_FAILED);
150             return NULL;
151             }
152
153         if (FIPS_mode() && !(dsa->flags & DSA_FLAG_NON_FIPS_ALLOW) 
154                 && (BN_num_bits(dsa->p) < OPENSSL_DSA_FIPS_MIN_MODULUS_BITS))
155                 {
156                 DSAerr(DSA_F_DSA_DO_SIGN, DSA_R_KEY_SIZE_TOO_SMALL);
157                 return NULL;
158                 }
159         if (!fips_check_dsa_prng(dsa, 0, 0))
160                 goto err;
161 #endif
162
163         BN_init(&m);
164         BN_init(&xr);
165
166         if (!dsa->p || !dsa->q || !dsa->g)
167                 {
168                 reason=DSA_R_MISSING_PARAMETERS;
169                 goto err;
170                 }
171
172         s=BN_new();
173         if (s == NULL) goto err;
174         ctx=BN_CTX_new();
175         if (ctx == NULL) goto err;
176 redo:
177         if ((dsa->kinv == NULL) || (dsa->r == NULL))
178                 {
179                 if (!dsa->meth->dsa_sign_setup(dsa,ctx,&kinv,&r)) goto err;
180                 }
181         else
182                 {
183                 kinv=dsa->kinv;
184                 dsa->kinv=NULL;
185                 r=dsa->r;
186                 dsa->r=NULL;
187                 noredo = 1;
188                 }
189
190         
191         if (dlen > BN_num_bytes(dsa->q))
192                 /* if the digest length is greater than the size of q use the
193                  * BN_num_bits(dsa->q) leftmost bits of the digest, see
194                  * fips 186-3, 4.2 */
195                 dlen = BN_num_bytes(dsa->q);
196         if (BN_bin2bn(dgst,dlen,&m) == NULL)
197                 goto err;
198
199         /* Compute  s = inv(k) (m + xr) mod q */
200         if (!BN_mod_mul(&xr,dsa->priv_key,r,dsa->q,ctx)) goto err;/* s = xr */
201         if (!BN_add(s, &xr, &m)) goto err;              /* s = m + xr */
202         if (BN_cmp(s,dsa->q) > 0)
203                 if (!BN_sub(s,s,dsa->q)) goto err;
204         if (!BN_mod_mul(s,s,kinv,dsa->q,ctx)) goto err;
205         ret=DSA_SIG_new();
206         if (ret == NULL) goto err;
207         /* Redo if r or s is zero as required by FIPS 186-3: this is
208          * very unlikely.
209          */
210         if (BN_is_zero(r) || BN_is_zero(s))
211                 {
212                 if (noredo)
213                         {
214                         reason = DSA_R_NEED_NEW_SETUP_VALUES;
215                         goto err;
216                         }
217                 goto redo;
218                 }
219         ret->r = r;
220         ret->s = s;
221         
222 err:
223         if (!ret)
224                 {
225                 DSAerr(DSA_F_DSA_DO_SIGN,reason);
226                 BN_free(r);
227                 BN_free(s);
228                 }
229         if (ctx != NULL) BN_CTX_free(ctx);
230         BN_clear_free(&m);
231         BN_clear_free(&xr);
232         if (kinv != NULL) /* dsa->kinv is NULL now if we used it */
233             BN_clear_free(kinv);
234         return(ret);
235         }
236
237 static int dsa_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp)
238         {
239         BN_CTX *ctx;
240         BIGNUM k,kq,*K,*kinv=NULL,*r=NULL;
241         int ret=0;
242
243         if (!dsa->p || !dsa->q || !dsa->g)
244                 {
245                 DSAerr(DSA_F_DSA_SIGN_SETUP,DSA_R_MISSING_PARAMETERS);
246                 return 0;
247                 }
248
249         BN_init(&k);
250         BN_init(&kq);
251
252         if (ctx_in == NULL)
253                 {
254                 if ((ctx=BN_CTX_new()) == NULL) goto err;
255                 }
256         else
257                 ctx=ctx_in;
258
259         if ((r=BN_new()) == NULL) goto err;
260
261         /* Get random k */
262         do
263                 if (!BN_rand_range(&k, dsa->q)) goto err;
264         while (BN_is_zero(&k));
265         if ((dsa->flags & DSA_FLAG_NO_EXP_CONSTTIME) == 0)
266                 {
267                 BN_set_flags(&k, BN_FLG_CONSTTIME);
268                 }
269
270         if (dsa->flags & DSA_FLAG_CACHE_MONT_P)
271                 {
272                 if (!BN_MONT_CTX_set_locked(&dsa->method_mont_p,
273                                                 CRYPTO_LOCK_DSA,
274                                                 dsa->p, ctx))
275                         goto err;
276                 }
277
278         /* Compute r = (g^k mod p) mod q */
279
280         if ((dsa->flags & DSA_FLAG_NO_EXP_CONSTTIME) == 0)
281                 {
282                 if (!BN_copy(&kq, &k)) goto err;
283
284                 /* We do not want timing information to leak the length of k,
285                  * so we compute g^k using an equivalent exponent of fixed length.
286                  *
287                  * (This is a kludge that we need because the BN_mod_exp_mont()
288                  * does not let us specify the desired timing behaviour.) */
289
290                 if (!BN_add(&kq, &kq, dsa->q)) goto err;
291                 if (BN_num_bits(&kq) <= BN_num_bits(dsa->q))
292                         {
293                         if (!BN_add(&kq, &kq, dsa->q)) goto err;
294                         }
295
296                 K = &kq;
297                 }
298         else
299                 {
300                 K = &k;
301                 }
302         DSA_BN_MOD_EXP(goto err, dsa, r, dsa->g, K, dsa->p, ctx,
303                         dsa->method_mont_p);
304         if (!BN_mod(r,r,dsa->q,ctx)) goto err;
305
306         /* Compute  part of 's = inv(k) (m + xr) mod q' */
307         if ((kinv=BN_mod_inverse(NULL,&k,dsa->q,ctx)) == NULL) goto err;
308
309         if (*kinvp != NULL) BN_clear_free(*kinvp);
310         *kinvp=kinv;
311         kinv=NULL;
312         if (*rp != NULL) BN_clear_free(*rp);
313         *rp=r;
314         ret=1;
315 err:
316         if (!ret)
317                 {
318                 DSAerr(DSA_F_DSA_SIGN_SETUP,ERR_R_BN_LIB);
319                 if (r != NULL)
320                         BN_clear_free(r);
321                 }
322         if (ctx_in == NULL) BN_CTX_free(ctx);
323         BN_clear_free(&k);
324         BN_clear_free(&kq);
325         return(ret);
326         }
327
328 static int dsa_do_verify(const unsigned char *dgst, int dgst_len, DSA_SIG *sig,
329                          DSA *dsa)
330         {
331         BN_CTX *ctx;
332         BIGNUM u1,u2,t1;
333         BN_MONT_CTX *mont=NULL;
334         int ret = -1, i;
335         if (!dsa->p || !dsa->q || !dsa->g)
336                 {
337                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_MISSING_PARAMETERS);
338                 return -1;
339                 }
340
341         i = BN_num_bits(dsa->q);
342         /* fips 186-3 allows only different sizes for q */
343         if (i != 160 && i != 224 && i != 256)
344                 {
345                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_BAD_Q_VALUE);
346                 return -1;
347                 }
348
349 #ifdef OPENSSL_FIPS
350         if(FIPS_selftest_failed())
351             {
352             FIPSerr(FIPS_F_DSA_DO_VERIFY,FIPS_R_FIPS_SELFTEST_FAILED);
353             return -1;
354             }
355
356         if (FIPS_mode() && !(dsa->flags & DSA_FLAG_NON_FIPS_ALLOW) 
357                 && (BN_num_bits(dsa->p) < OPENSSL_DSA_FIPS_MIN_MODULUS_BITS))
358                 {
359                 DSAerr(DSA_F_DSA_DO_VERIFY, DSA_R_KEY_SIZE_TOO_SMALL);
360                 return -1;
361                 }
362 #endif
363
364         if (BN_num_bits(dsa->p) > OPENSSL_DSA_MAX_MODULUS_BITS)
365                 {
366                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_MODULUS_TOO_LARGE);
367                 return -1;
368                 }
369         BN_init(&u1);
370         BN_init(&u2);
371         BN_init(&t1);
372
373         if ((ctx=BN_CTX_new()) == NULL) goto err;
374
375         if (BN_is_zero(sig->r) || BN_is_negative(sig->r) ||
376             BN_ucmp(sig->r, dsa->q) >= 0)
377                 {
378                 ret = 0;
379                 goto err;
380                 }
381         if (BN_is_zero(sig->s) || BN_is_negative(sig->s) ||
382             BN_ucmp(sig->s, dsa->q) >= 0)
383                 {
384                 ret = 0;
385                 goto err;
386                 }
387
388         /* Calculate W = inv(S) mod Q
389          * save W in u2 */
390         if ((BN_mod_inverse(&u2,sig->s,dsa->q,ctx)) == NULL) goto err;
391
392         /* save M in u1 */
393         if (dgst_len > (i >> 3))
394                 /* if the digest length is greater than the size of q use the
395                  * BN_num_bits(dsa->q) leftmost bits of the digest, see
396                  * fips 186-3, 4.2 */
397                 dgst_len = (i >> 3);
398         if (BN_bin2bn(dgst,dgst_len,&u1) == NULL) goto err;
399
400         /* u1 = M * w mod q */
401         if (!BN_mod_mul(&u1,&u1,&u2,dsa->q,ctx)) goto err;
402
403         /* u2 = r * w mod q */
404         if (!BN_mod_mul(&u2,sig->r,&u2,dsa->q,ctx)) goto err;
405
406
407         if (dsa->flags & DSA_FLAG_CACHE_MONT_P)
408                 {
409                 mont = BN_MONT_CTX_set_locked(&dsa->method_mont_p,
410                                         CRYPTO_LOCK_DSA, dsa->p, ctx);
411                 if (!mont)
412                         goto err;
413                 }
414
415
416         DSA_MOD_EXP(goto err, dsa, &t1, dsa->g, &u1, dsa->pub_key, &u2, dsa->p, ctx, mont);
417         /* BN_copy(&u1,&t1); */
418         /* let u1 = u1 mod q */
419         if (!BN_mod(&u1,&t1,dsa->q,ctx)) goto err;
420
421         /* V is now in u1.  If the signature is correct, it will be
422          * equal to R. */
423         ret=(BN_ucmp(&u1, sig->r) == 0);
424
425         err:
426         /* XXX: surely this is wrong - if ret is 0, it just didn't verify;
427            there is no error in BN. Test should be ret == -1 (Ben) */
428         if (ret != 1) DSAerr(DSA_F_DSA_DO_VERIFY,ERR_R_BN_LIB);
429         if (ctx != NULL) BN_CTX_free(ctx);
430         BN_free(&u1);
431         BN_free(&u2);
432         BN_free(&t1);
433         return(ret);
434         }
435
436 static int dsa_init(DSA *dsa)
437 {
438         dsa->flags|=DSA_FLAG_CACHE_MONT_P;
439         return(1);
440 }
441
442 static int dsa_finish(DSA *dsa)
443 {
444         if(dsa->method_mont_p)
445                 BN_MONT_CTX_free(dsa->method_mont_p);
446         return(1);
447 }
448