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