Transfer error redirection to fips.h, add OPENSSL_FIPSAPI to source files
[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() && (BN_num_bits(dsa->p) < OPENSSL_DSA_FIPS_MIN_MODULUS_BITS))
154                 {
155                 DSAerr(DSA_F_DSA_DO_SIGN, DSA_R_KEY_SIZE_TOO_SMALL);
156                 return NULL;
157                 }
158 #endif
159
160         BN_init(&m);
161         BN_init(&xr);
162
163         if (!dsa->p || !dsa->q || !dsa->g)
164                 {
165                 reason=DSA_R_MISSING_PARAMETERS;
166                 goto err;
167                 }
168
169         s=BN_new();
170         if (s == NULL) goto err;
171         ctx=BN_CTX_new();
172         if (ctx == NULL) goto err;
173 redo:
174         if ((dsa->kinv == NULL) || (dsa->r == NULL))
175                 {
176                 if (!DSA_sign_setup(dsa,ctx,&kinv,&r)) goto err;
177                 }
178         else
179                 {
180                 kinv=dsa->kinv;
181                 dsa->kinv=NULL;
182                 r=dsa->r;
183                 dsa->r=NULL;
184                 noredo = 1;
185                 }
186
187         
188         if (dlen > BN_num_bytes(dsa->q))
189                 /* if the digest length is greater than the size of q use the
190                  * BN_num_bits(dsa->q) leftmost bits of the digest, see
191                  * fips 186-3, 4.2 */
192                 dlen = BN_num_bytes(dsa->q);
193         if (BN_bin2bn(dgst,dlen,&m) == NULL)
194                 goto err;
195
196         /* Compute  s = inv(k) (m + xr) mod q */
197         if (!BN_mod_mul(&xr,dsa->priv_key,r,dsa->q,ctx)) goto err;/* s = xr */
198         if (!BN_add(s, &xr, &m)) goto err;              /* s = m + xr */
199         if (BN_cmp(s,dsa->q) > 0)
200                 if (!BN_sub(s,s,dsa->q)) goto err;
201         if (!BN_mod_mul(s,s,kinv,dsa->q,ctx)) goto err;
202
203         ret=DSA_SIG_new();
204         if (ret == NULL) goto err;
205         /* Redo if r or s is zero as required by FIPS 186-3: this is
206          * very unlikely.
207          */
208         if (BN_is_zero(r) || BN_is_zero(s))
209                 {
210                 if (noredo)
211                         {
212                         reason = DSA_R_NEED_NEW_SETUP_VALUES;
213                         goto err;
214                         }
215                 goto redo;
216                 }
217         ret->r = r;
218         ret->s = s;
219         
220 err:
221         if (!ret)
222                 {
223                 DSAerr(DSA_F_DSA_DO_SIGN,reason);
224                 BN_free(r);
225                 BN_free(s);
226                 }
227         if (ctx != NULL) BN_CTX_free(ctx);
228         BN_clear_free(&m);
229         BN_clear_free(&xr);
230         if (kinv != NULL) /* dsa->kinv is NULL now if we used it */
231             BN_clear_free(kinv);
232         return(ret);
233         }
234
235 static int dsa_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp)
236         {
237         BN_CTX *ctx;
238         BIGNUM k,kq,*K,*kinv=NULL,*r=NULL;
239         int ret=0;
240
241         if (!dsa->p || !dsa->q || !dsa->g)
242                 {
243                 DSAerr(DSA_F_DSA_SIGN_SETUP,DSA_R_MISSING_PARAMETERS);
244                 return 0;
245                 }
246
247         BN_init(&k);
248         BN_init(&kq);
249
250         if (ctx_in == NULL)
251                 {
252                 if ((ctx=BN_CTX_new()) == NULL) goto err;
253                 }
254         else
255                 ctx=ctx_in;
256
257         if ((r=BN_new()) == NULL) goto err;
258
259         /* Get random k */
260         do
261                 if (!BN_rand_range(&k, dsa->q)) goto err;
262         while (BN_is_zero(&k));
263         if ((dsa->flags & DSA_FLAG_NO_EXP_CONSTTIME) == 0)
264                 {
265                 BN_set_flags(&k, BN_FLG_CONSTTIME);
266                 }
267
268         if (dsa->flags & DSA_FLAG_CACHE_MONT_P)
269                 {
270                 if (!BN_MONT_CTX_set_locked(&dsa->method_mont_p,
271                                                 CRYPTO_LOCK_DSA,
272                                                 dsa->p, ctx))
273                         goto err;
274                 }
275
276         /* Compute r = (g^k mod p) mod q */
277
278         if ((dsa->flags & DSA_FLAG_NO_EXP_CONSTTIME) == 0)
279                 {
280                 if (!BN_copy(&kq, &k)) goto err;
281
282                 /* We do not want timing information to leak the length of k,
283                  * so we compute g^k using an equivalent exponent of fixed length.
284                  *
285                  * (This is a kludge that we need because the BN_mod_exp_mont()
286                  * does not let us specify the desired timing behaviour.) */
287
288                 if (!BN_add(&kq, &kq, dsa->q)) goto err;
289                 if (BN_num_bits(&kq) <= BN_num_bits(dsa->q))
290                         {
291                         if (!BN_add(&kq, &kq, dsa->q)) goto err;
292                         }
293
294                 K = &kq;
295                 }
296         else
297                 {
298                 K = &k;
299                 }
300         DSA_BN_MOD_EXP(goto err, dsa, r, dsa->g, K, dsa->p, ctx,
301                         dsa->method_mont_p);
302         if (!BN_mod(r,r,dsa->q,ctx)) goto err;
303
304         /* Compute  part of 's = inv(k) (m + xr) mod q' */
305         if ((kinv=BN_mod_inverse(NULL,&k,dsa->q,ctx)) == NULL) goto err;
306
307         if (*kinvp != NULL) BN_clear_free(*kinvp);
308         *kinvp=kinv;
309         kinv=NULL;
310         if (*rp != NULL) BN_clear_free(*rp);
311         *rp=r;
312         ret=1;
313 err:
314         if (!ret)
315                 {
316                 DSAerr(DSA_F_DSA_SIGN_SETUP,ERR_R_BN_LIB);
317                 if (r != NULL)
318                         BN_clear_free(r);
319                 }
320         if (ctx_in == NULL) BN_CTX_free(ctx);
321         BN_clear_free(&k);
322         BN_clear_free(&kq);
323         return(ret);
324         }
325
326 static int dsa_do_verify(const unsigned char *dgst, int dgst_len, DSA_SIG *sig,
327                          DSA *dsa)
328         {
329         BN_CTX *ctx;
330         BIGNUM u1,u2,t1;
331         BN_MONT_CTX *mont=NULL;
332         int ret = -1, i;
333         if (!dsa->p || !dsa->q || !dsa->g)
334                 {
335                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_MISSING_PARAMETERS);
336                 return -1;
337                 }
338
339         i = BN_num_bits(dsa->q);
340         /* fips 186-3 allows only different sizes for q */
341         if (i != 160 && i != 224 && i != 256)
342                 {
343                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_BAD_Q_VALUE);
344                 return -1;
345                 }
346
347 #ifdef OPENSSL_FIPS
348         if(FIPS_selftest_failed())
349             {
350             FIPSerr(FIPS_F_DSA_DO_VERIFY,FIPS_R_FIPS_SELFTEST_FAILED);
351             return -1;
352             }
353
354         if (FIPS_mode() && (BN_num_bits(dsa->p) < OPENSSL_DSA_FIPS_MIN_MODULUS_BITS))
355                 {
356                 DSAerr(DSA_F_DSA_DO_VERIFY, DSA_R_KEY_SIZE_TOO_SMALL);
357                 return -1;
358                 }
359 #endif
360
361         if (BN_num_bits(dsa->p) > OPENSSL_DSA_MAX_MODULUS_BITS)
362                 {
363                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_MODULUS_TOO_LARGE);
364                 return -1;
365                 }
366         BN_init(&u1);
367         BN_init(&u2);
368         BN_init(&t1);
369
370         if ((ctx=BN_CTX_new()) == NULL) goto err;
371
372         if (BN_is_zero(sig->r) || BN_is_negative(sig->r) ||
373             BN_ucmp(sig->r, dsa->q) >= 0)
374                 {
375                 ret = 0;
376                 goto err;
377                 }
378         if (BN_is_zero(sig->s) || BN_is_negative(sig->s) ||
379             BN_ucmp(sig->s, dsa->q) >= 0)
380                 {
381                 ret = 0;
382                 goto err;
383                 }
384
385         /* Calculate W = inv(S) mod Q
386          * save W in u2 */
387         if ((BN_mod_inverse(&u2,sig->s,dsa->q,ctx)) == NULL) goto err;
388
389         /* save M in u1 */
390         if (dgst_len > (i >> 3))
391                 /* if the digest length is greater than the size of q use the
392                  * BN_num_bits(dsa->q) leftmost bits of the digest, see
393                  * fips 186-3, 4.2 */
394                 dgst_len = (i >> 3);
395         if (BN_bin2bn(dgst,dgst_len,&u1) == NULL) goto err;
396
397         /* u1 = M * w mod q */
398         if (!BN_mod_mul(&u1,&u1,&u2,dsa->q,ctx)) goto err;
399
400         /* u2 = r * w mod q */
401         if (!BN_mod_mul(&u2,sig->r,&u2,dsa->q,ctx)) goto err;
402
403
404         if (dsa->flags & DSA_FLAG_CACHE_MONT_P)
405                 {
406                 mont = BN_MONT_CTX_set_locked(&dsa->method_mont_p,
407                                         CRYPTO_LOCK_DSA, dsa->p, ctx);
408                 if (!mont)
409                         goto err;
410                 }
411
412
413         DSA_MOD_EXP(goto err, dsa, &t1, dsa->g, &u1, dsa->pub_key, &u2, dsa->p, ctx, mont);
414         /* BN_copy(&u1,&t1); */
415         /* let u1 = u1 mod q */
416         if (!BN_mod(&u1,&t1,dsa->q,ctx)) goto err;
417
418         /* V is now in u1.  If the signature is correct, it will be
419          * equal to R. */
420         ret=(BN_ucmp(&u1, sig->r) == 0);
421
422         err:
423         /* XXX: surely this is wrong - if ret is 0, it just didn't verify;
424            there is no error in BN. Test should be ret == -1 (Ben) */
425         if (ret != 1) DSAerr(DSA_F_DSA_DO_VERIFY,ERR_R_BN_LIB);
426         if (ctx != NULL) BN_CTX_free(ctx);
427         BN_free(&u1);
428         BN_free(&u2);
429         BN_free(&t1);
430         return(ret);
431         }
432
433 static int dsa_init(DSA *dsa)
434 {
435         dsa->flags|=DSA_FLAG_CACHE_MONT_P;
436         return(1);
437 }
438
439 static int dsa_finish(DSA *dsa)
440 {
441         if(dsa->method_mont_p)
442                 BN_MONT_CTX_free(dsa->method_mont_p);
443         return(1);
444 }
445