f8cda1b7e9f9939b78a6bd2ac7aabf8da83814f9
[openssl.git] / crypto / dh / dh_gen.c
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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 /*
11  * NB: These functions have been upgraded - the previous prototypes are in
12  * dh_depr.c as wrappers to these ones.  - Geoff
13  */
14
15 /*
16  * DH low level APIs are deprecated for public use, but still ok for
17  * internal use.
18  *
19  * NOTE: When generating keys for key-agreement schemes - FIPS 140-2 IG 9.9
20  * states that no additional pairwise tests are required (apart from the tests
21  * specified in SP800-56A) when generating keys. Hence DH pairwise tests are
22  * omitted here.
23  */
24 #include "internal/deprecated.h"
25
26 #include <stdio.h>
27 #include "internal/cryptlib.h"
28 #include <openssl/bn.h>
29 #include "crypto/dh.h"
30 #include "dh_local.h"
31
32 #ifndef FIPS_MODE
33 static int dh_builtin_genparams(DH *ret, int prime_len, int generator,
34                                 BN_GENCB *cb);
35 #endif /* FIPS_MODE */
36
37 /*
38  * TODO(3.0): keygen should be able to use this method to do a FIPS186-4 style
39  * paramgen.
40  */
41 int dh_generate_ffc_parameters(DH *dh, int bits,
42                                int qbits, int gindex, BN_GENCB *cb)
43 {
44     int ret, res;
45
46     if (qbits <= 0) {
47         const EVP_MD *evpmd = bits >= 2048 ? EVP_sha256() : EVP_sha1();
48
49         qbits = EVP_MD_size(evpmd) * 8;
50     }
51     dh->params.gindex = gindex;
52     ret = ffc_params_FIPS186_4_generate(dh->libctx, &dh->params,
53                                         FFC_PARAM_TYPE_DH,
54                                         bits, qbits, NULL, &res, cb);
55     if (ret > 0)
56         dh->dirty_cnt++;
57     return ret;
58 }
59
60 int DH_generate_parameters_ex(DH *ret, int prime_len, int generator,
61                               BN_GENCB *cb)
62 {
63 #ifdef FIPS_MODE
64     /*
65      * Just choose an approved safe prime group.
66      * The alternative to this is to generate FIPS186-4 domain parameters i.e.
67      * return dh_generate_ffc_parameters(ret, prime_len, -1, -1, cb);
68      * As the FIPS186-4 generated params are for backwards compatability,
69      * the safe prime group should be used as the default.
70      */
71     DH *dh = NULL;
72     int ok = 0, nid;
73
74     if (generator != 2)
75         return 0;
76
77     switch (prime_len) {
78     case 2048:
79         nid = NID_ffdhe2048;
80         break;
81     case 3072:
82         nid = NID_ffdhe3072;
83         break;
84     case 4096:
85         nid = NID_ffdhe4096;
86         break;
87     case 6144:
88         nid = NID_ffdhe6144;
89         break;
90     case 8192:
91         nid = NID_ffdhe8192;
92         break;
93     /* unsupported prime_len */
94     default:
95         return 0;
96     }
97     dh = DH_new_by_nid(nid);
98     if (dh != NULL && ffc_params_copy(&ret->params, &dh->params)) {
99         ok = 1;
100         ret->dirty_cnt++;
101     }
102     DH_free(dh);
103     return ok;
104 #else
105     if (ret->meth->generate_params)
106         return ret->meth->generate_params(ret, prime_len, generator, cb);
107     return dh_builtin_genparams(ret, prime_len, generator, cb);
108 #endif /* FIPS_MODE */
109 }
110
111 #ifndef FIPS_MODE
112 /*-
113  * We generate DH parameters as follows
114  * find a prime p which is prime_len bits long,
115  * where q=(p-1)/2 is also prime.
116  * In the following we assume that g is not 0, 1 or p-1, since it
117  * would generate only trivial subgroups.
118  * For this case, g is a generator of the order-q subgroup if
119  * g^q mod p == 1.
120  * Or in terms of the Legendre symbol: (g/p) == 1.
121  *
122  * Having said all that,
123  * there is another special case method for the generators 2, 3 and 5.
124  * Using the quadratic reciprocity law it is possible to solve
125  * (g/p) == 1 for the special values 2, 3, 5:
126  * (2/p) == 1 if p mod 8 == 1 or 7.
127  * (3/p) == 1 if p mod 12 == 1 or 11.
128  * (5/p) == 1 if p mod 5 == 1 or 4.
129  * See for instance: https://en.wikipedia.org/wiki/Legendre_symbol
130  *
131  * Since all safe primes > 7 must satisfy p mod 12 == 11
132  * and all safe primes > 11 must satisfy p mod 5 != 1
133  * we can further improve the condition for g = 2, 3 and 5:
134  * for 2, p mod 24 == 23
135  * for 3, p mod 12 == 11
136  * for 5, p mod 60 == 59
137  */
138 static int dh_builtin_genparams(DH *ret, int prime_len, int generator,
139                                 BN_GENCB *cb)
140 {
141     BIGNUM *t1, *t2;
142     int g, ok = -1;
143     BN_CTX *ctx = NULL;
144
145     if (prime_len > OPENSSL_DH_MAX_MODULUS_BITS) {
146         DHerr(DH_F_DH_BUILTIN_GENPARAMS, DH_R_MODULUS_TOO_LARGE);
147         return 0;
148     }
149
150     if (prime_len < DH_MIN_MODULUS_BITS) {
151         DHerr(DH_F_DH_BUILTIN_GENPARAMS, DH_R_MODULUS_TOO_SMALL);
152         return 0;
153     }
154
155     ctx = BN_CTX_new();
156     if (ctx == NULL)
157         goto err;
158     BN_CTX_start(ctx);
159     t1 = BN_CTX_get(ctx);
160     t2 = BN_CTX_get(ctx);
161     if (t2 == NULL)
162         goto err;
163
164     /* Make sure 'ret' has the necessary elements */
165     if (ret->params.p == NULL && ((ret->params.p = BN_new()) == NULL))
166         goto err;
167     if (ret->params.g == NULL && ((ret->params.g = BN_new()) == NULL))
168         goto err;
169
170     if (generator <= 1) {
171         DHerr(DH_F_DH_BUILTIN_GENPARAMS, DH_R_BAD_GENERATOR);
172         goto err;
173     }
174     if (generator == DH_GENERATOR_2) {
175         if (!BN_set_word(t1, 24))
176             goto err;
177         if (!BN_set_word(t2, 23))
178             goto err;
179         g = 2;
180     } else if (generator == DH_GENERATOR_5) {
181         if (!BN_set_word(t1, 60))
182             goto err;
183         if (!BN_set_word(t2, 59))
184             goto err;
185         g = 5;
186     } else {
187         /*
188          * in the general case, don't worry if 'generator' is a generator or
189          * not: since we are using safe primes, it will generate either an
190          * order-q or an order-2q group, which both is OK
191          */
192         if (!BN_set_word(t1, 12))
193             goto err;
194         if (!BN_set_word(t2, 11))
195             goto err;
196         g = generator;
197     }
198
199     if (!BN_generate_prime_ex(ret->params.p, prime_len, 1, t1, t2, cb))
200         goto err;
201     if (!BN_GENCB_call(cb, 3, 0))
202         goto err;
203     if (!BN_set_word(ret->params.g, g))
204         goto err;
205     ret->dirty_cnt++;
206     ok = 1;
207  err:
208     if (ok == -1) {
209         DHerr(DH_F_DH_BUILTIN_GENPARAMS, ERR_R_BN_LIB);
210         ok = 0;
211     }
212
213     BN_CTX_end(ctx);
214     BN_CTX_free(ctx);
215     return ok;
216 }
217 #endif /* FIPS_MODE */