Timing vulnerability in DSA signature generation (CVE-2018-0734).
[openssl.git] / crypto / dsa / dsa_ossl.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <stdio.h>
11 #include "internal/cryptlib.h"
12 #include "internal/bn_int.h"
13 #include <openssl/bn.h>
14 #include <openssl/sha.h>
15 #include "dsa_locl.h"
16 #include <openssl/asn1.h>
17
18 static DSA_SIG *dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
19 static int dsa_sign_setup_no_digest(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
20                                     BIGNUM **rp);
21 static int dsa_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
22                           BIGNUM **rp, const unsigned char *dgst, int dlen);
23 static int dsa_do_verify(const unsigned char *dgst, int dgst_len,
24                          DSA_SIG *sig, DSA *dsa);
25 static int dsa_init(DSA *dsa);
26 static int dsa_finish(DSA *dsa);
27 static BIGNUM *dsa_mod_inverse_fermat(const BIGNUM *k, const BIGNUM *q,
28                                       BN_CTX *ctx);
29
30 static DSA_METHOD openssl_dsa_meth = {
31     "OpenSSL DSA method",
32     dsa_do_sign,
33     dsa_sign_setup_no_digest,
34     dsa_do_verify,
35     NULL,                       /* dsa_mod_exp, */
36     NULL,                       /* dsa_bn_mod_exp, */
37     dsa_init,
38     dsa_finish,
39     DSA_FLAG_FIPS_METHOD,
40     NULL,
41     NULL,
42     NULL
43 };
44
45 static const DSA_METHOD *default_DSA_method = &openssl_dsa_meth;
46
47 void DSA_set_default_method(const DSA_METHOD *meth)
48 {
49     default_DSA_method = meth;
50 }
51
52 const DSA_METHOD *DSA_get_default_method(void)
53 {
54     return default_DSA_method;
55 }
56
57 const DSA_METHOD *DSA_OpenSSL(void)
58 {
59     return &openssl_dsa_meth;
60 }
61
62 static DSA_SIG *dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa)
63 {
64     BIGNUM *kinv = NULL;
65     BIGNUM *m, *blind, *blindm, *tmp;
66     BN_CTX *ctx = NULL;
67     int reason = ERR_R_BN_LIB;
68     DSA_SIG *ret = NULL;
69     int rv = 0;
70
71     if (dsa->p == NULL || dsa->q == NULL || dsa->g == NULL) {
72         reason = DSA_R_MISSING_PARAMETERS;
73         goto err;
74     }
75
76     ret = DSA_SIG_new();
77     if (ret == NULL)
78         goto err;
79     ret->r = BN_new();
80     ret->s = BN_new();
81     if (ret->r == NULL || ret->s == NULL)
82         goto err;
83
84     ctx = BN_CTX_new();
85     if (ctx == NULL)
86         goto err;
87     m = BN_CTX_get(ctx);
88     blind = BN_CTX_get(ctx);
89     blindm = BN_CTX_get(ctx);
90     tmp = BN_CTX_get(ctx);
91     if (tmp == NULL)
92         goto err;
93
94  redo:
95     if (!dsa_sign_setup(dsa, ctx, &kinv, &ret->r, dgst, dlen))
96         goto err;
97
98     if (dlen > BN_num_bytes(dsa->q))
99         /*
100          * if the digest length is greater than the size of q use the
101          * BN_num_bits(dsa->q) leftmost bits of the digest, see fips 186-3,
102          * 4.2
103          */
104         dlen = BN_num_bytes(dsa->q);
105     if (BN_bin2bn(dgst, dlen, m) == NULL)
106         goto err;
107
108     /*
109      * The normal signature calculation is:
110      *
111      *   s := k^-1 * (m + r * priv_key) mod q
112      *
113      * We will blind this to protect against side channel attacks
114      *
115      *   s := blind^-1 * k^-1 * (blind * m + blind * r * priv_key) mod q
116      */
117
118     /* Generate a blinding value */
119     do {
120         if (!BN_priv_rand(blind, BN_num_bits(dsa->q) - 1,
121                           BN_RAND_TOP_ANY, BN_RAND_BOTTOM_ANY))
122             goto err;
123     } while (BN_is_zero(blind));
124     BN_set_flags(blind, BN_FLG_CONSTTIME);
125     BN_set_flags(blindm, BN_FLG_CONSTTIME);
126     BN_set_flags(tmp, BN_FLG_CONSTTIME);
127
128     /* tmp := blind * priv_key * r mod q */
129     if (!BN_mod_mul(tmp, blind, dsa->priv_key, dsa->q, ctx))
130         goto err;
131     if (!BN_mod_mul(tmp, tmp, ret->r, dsa->q, ctx))
132         goto err;
133
134     /* blindm := blind * m mod q */
135     if (!BN_mod_mul(blindm, blind, m, dsa->q, ctx))
136         goto err;
137
138     /* s : = (blind * priv_key * r) + (blind * m) mod q */
139     if (!BN_mod_add_quick(ret->s, tmp, blindm, dsa->q))
140         goto err;
141
142     /* s := s * k^-1 mod q */
143     if (!BN_mod_mul(ret->s, ret->s, kinv, dsa->q, ctx))
144         goto err;
145
146     /* s:= s * blind^-1 mod q */
147     if (BN_mod_inverse(blind, blind, dsa->q, ctx) == NULL)
148         goto err;
149     if (!BN_mod_mul(ret->s, ret->s, blind, dsa->q, ctx))
150         goto err;
151
152     /*
153      * Redo if r or s is zero as required by FIPS 186-3: this is very
154      * unlikely.
155      */
156     if (BN_is_zero(ret->r) || BN_is_zero(ret->s))
157         goto redo;
158
159     rv = 1;
160
161  err:
162     if (rv == 0) {
163         DSAerr(DSA_F_DSA_DO_SIGN, reason);
164         DSA_SIG_free(ret);
165         ret = NULL;
166     }
167     BN_CTX_free(ctx);
168     BN_clear_free(kinv);
169     return ret;
170 }
171
172 static int dsa_sign_setup_no_digest(DSA *dsa, BN_CTX *ctx_in,
173                                     BIGNUM **kinvp, BIGNUM **rp)
174 {
175     return dsa_sign_setup(dsa, ctx_in, kinvp, rp, NULL, 0);
176 }
177
178 static int dsa_sign_setup(DSA *dsa, BN_CTX *ctx_in,
179                           BIGNUM **kinvp, BIGNUM **rp,
180                           const unsigned char *dgst, int dlen)
181 {
182     BN_CTX *ctx = NULL;
183     BIGNUM *k, *kinv = NULL, *r = *rp;
184     BIGNUM *l;
185     int ret = 0;
186     int q_bits, q_words;
187
188     if (!dsa->p || !dsa->q || !dsa->g) {
189         DSAerr(DSA_F_DSA_SIGN_SETUP, DSA_R_MISSING_PARAMETERS);
190         return 0;
191     }
192
193     k = BN_new();
194     l = BN_new();
195     if (k == NULL || l == NULL)
196         goto err;
197
198     if (ctx_in == NULL) {
199         if ((ctx = BN_CTX_new()) == NULL)
200             goto err;
201     } else
202         ctx = ctx_in;
203
204     /* Preallocate space */
205     q_bits = BN_num_bits(dsa->q);
206     q_words = bn_get_top(dsa->q);
207     if (!bn_wexpand(k, q_words + 2)
208         || !bn_wexpand(l, q_words + 2))
209         goto err;
210
211     /* Get random k */
212     do {
213         if (dgst != NULL) {
214             /*
215              * We calculate k from SHA512(private_key + H(message) + random).
216              * This protects the private key from a weak PRNG.
217              */
218             if (!BN_generate_dsa_nonce(k, dsa->q, dsa->priv_key, dgst,
219                                        dlen, ctx))
220                 goto err;
221         } else if (!BN_priv_rand_range(k, dsa->q))
222             goto err;
223     } while (BN_is_zero(k));
224
225     BN_set_flags(k, BN_FLG_CONSTTIME);
226
227     if (dsa->flags & DSA_FLAG_CACHE_MONT_P) {
228         if (!BN_MONT_CTX_set_locked(&dsa->method_mont_p,
229                                     dsa->lock, dsa->p, ctx))
230             goto err;
231     }
232
233     /* Compute r = (g^k mod p) mod q */
234
235     /*
236      * We do not want timing information to leak the length of k, so we
237      * compute G^k using an equivalent scalar of fixed bit-length.
238      *
239      * We unconditionally perform both of these additions to prevent a
240      * small timing information leakage.  We then choose the sum that is
241      * one bit longer than the modulus.
242      *
243      * There are some concerns about the efficacy of doing this.  More
244      * specificly refer to the discussion starting with:
245      *     https://github.com/openssl/openssl/pull/7486#discussion_r228323705
246      * The fix is to rework BN so these gymnastics aren't required.
247      */
248     if (!BN_add(l, k, dsa->q)
249         || !BN_add(k, l, dsa->q))
250         goto err;
251
252     BN_consttime_swap(BN_is_bit_set(l, q_bits), k, l, q_words + 2);
253
254     if ((dsa)->meth->bn_mod_exp != NULL) {
255             if (!dsa->meth->bn_mod_exp(dsa, r, dsa->g, k, dsa->p, ctx,
256                                        dsa->method_mont_p))
257                 goto err;
258     } else {
259             if (!BN_mod_exp_mont(r, dsa->g, k, dsa->p, ctx, dsa->method_mont_p))
260                 goto err;
261     }
262
263     if (!BN_mod(r, r, dsa->q, ctx))
264         goto err;
265
266     /* Compute part of 's = inv(k) (m + xr) mod q' */
267     if ((kinv = dsa_mod_inverse_fermat(k, dsa->q, ctx)) == NULL)
268         goto err;
269
270     BN_clear_free(*kinvp);
271     *kinvp = kinv;
272     kinv = NULL;
273     ret = 1;
274  err:
275     if (!ret)
276         DSAerr(DSA_F_DSA_SIGN_SETUP, ERR_R_BN_LIB);
277     if (ctx != ctx_in)
278         BN_CTX_free(ctx);
279     BN_clear_free(k);
280     BN_clear_free(l);
281     return ret;
282 }
283
284 static int dsa_do_verify(const unsigned char *dgst, int dgst_len,
285                          DSA_SIG *sig, DSA *dsa)
286 {
287     BN_CTX *ctx;
288     BIGNUM *u1, *u2, *t1;
289     BN_MONT_CTX *mont = NULL;
290     const BIGNUM *r, *s;
291     int ret = -1, i;
292     if (!dsa->p || !dsa->q || !dsa->g) {
293         DSAerr(DSA_F_DSA_DO_VERIFY, DSA_R_MISSING_PARAMETERS);
294         return -1;
295     }
296
297     i = BN_num_bits(dsa->q);
298     /* fips 186-3 allows only different sizes for q */
299     if (i != 160 && i != 224 && i != 256) {
300         DSAerr(DSA_F_DSA_DO_VERIFY, DSA_R_BAD_Q_VALUE);
301         return -1;
302     }
303
304     if (BN_num_bits(dsa->p) > OPENSSL_DSA_MAX_MODULUS_BITS) {
305         DSAerr(DSA_F_DSA_DO_VERIFY, DSA_R_MODULUS_TOO_LARGE);
306         return -1;
307     }
308     u1 = BN_new();
309     u2 = BN_new();
310     t1 = BN_new();
311     ctx = BN_CTX_new();
312     if (u1 == NULL || u2 == NULL || t1 == NULL || ctx == NULL)
313         goto err;
314
315     DSA_SIG_get0(sig, &r, &s);
316
317     if (BN_is_zero(r) || BN_is_negative(r) ||
318         BN_ucmp(r, dsa->q) >= 0) {
319         ret = 0;
320         goto err;
321     }
322     if (BN_is_zero(s) || BN_is_negative(s) ||
323         BN_ucmp(s, dsa->q) >= 0) {
324         ret = 0;
325         goto err;
326     }
327
328     /*
329      * Calculate W = inv(S) mod Q save W in u2
330      */
331     if ((BN_mod_inverse(u2, s, dsa->q, ctx)) == NULL)
332         goto err;
333
334     /* save M in u1 */
335     if (dgst_len > (i >> 3))
336         /*
337          * if the digest length is greater than the size of q use the
338          * BN_num_bits(dsa->q) leftmost bits of the digest, see fips 186-3,
339          * 4.2
340          */
341         dgst_len = (i >> 3);
342     if (BN_bin2bn(dgst, dgst_len, u1) == NULL)
343         goto err;
344
345     /* u1 = M * w mod q */
346     if (!BN_mod_mul(u1, u1, u2, dsa->q, ctx))
347         goto err;
348
349     /* u2 = r * w mod q */
350     if (!BN_mod_mul(u2, r, u2, dsa->q, ctx))
351         goto err;
352
353     if (dsa->flags & DSA_FLAG_CACHE_MONT_P) {
354         mont = BN_MONT_CTX_set_locked(&dsa->method_mont_p,
355                                       dsa->lock, dsa->p, ctx);
356         if (!mont)
357             goto err;
358     }
359
360     if (dsa->meth->dsa_mod_exp != NULL) {
361         if (!dsa->meth->dsa_mod_exp(dsa, t1, dsa->g, u1, dsa->pub_key, u2,
362                                     dsa->p, ctx, mont))
363             goto err;
364     } else {
365         if (!BN_mod_exp2_mont(t1, dsa->g, u1, dsa->pub_key, u2, dsa->p, ctx,
366                               mont))
367             goto err;
368     }
369
370     /* let u1 = u1 mod q */
371     if (!BN_mod(u1, t1, dsa->q, ctx))
372         goto err;
373
374     /*
375      * V is now in u1.  If the signature is correct, it will be equal to R.
376      */
377     ret = (BN_ucmp(u1, r) == 0);
378
379  err:
380     if (ret < 0)
381         DSAerr(DSA_F_DSA_DO_VERIFY, ERR_R_BN_LIB);
382     BN_CTX_free(ctx);
383     BN_free(u1);
384     BN_free(u2);
385     BN_free(t1);
386     return ret;
387 }
388
389 static int dsa_init(DSA *dsa)
390 {
391     dsa->flags |= DSA_FLAG_CACHE_MONT_P;
392     return 1;
393 }
394
395 static int dsa_finish(DSA *dsa)
396 {
397     BN_MONT_CTX_free(dsa->method_mont_p);
398     return 1;
399 }
400
401 /*
402  * Compute the inverse of k modulo q.
403  * Since q is prime, Fermat's Little Theorem applies, which reduces this to
404  * mod-exp operation.  Both the exponent and modulus are public information
405  * so a mod-exp that doesn't leak the base is sufficient.  A newly allocated
406  * BIGNUM is returned which the caller must free.
407  */
408 static BIGNUM *dsa_mod_inverse_fermat(const BIGNUM *k, const BIGNUM *q,
409                                       BN_CTX *ctx)
410 {
411     BIGNUM *res = NULL;
412     BIGNUM *r, *e;
413
414     if ((r = BN_new()) == NULL)
415         return NULL;
416
417     BN_CTX_start(ctx);
418     if ((e = BN_CTX_get(ctx)) != NULL
419             && BN_set_word(r, 2)
420             && BN_sub(e, q, r)
421             && BN_mod_exp_mont(r, k, e, q, ctx, NULL))
422         res = r;
423     else
424         BN_free(r);
425     BN_CTX_end(ctx);
426     return res;
427 }