/src/openssl36/crypto/ffc/ffc_params.c
Line | Count | Source |
1 | | /* |
2 | | * Copyright 2019-2024 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 | | #include <string.h> /* memset */ |
11 | | #include <openssl/core_names.h> |
12 | | #include "internal/ffc.h" |
13 | | #include "internal/param_build_set.h" |
14 | | #include "internal/nelem.h" |
15 | | |
16 | | #ifndef FIPS_MODULE |
17 | | #include <openssl/asn1.h> /* ossl_ffc_params_print */ |
18 | | #endif |
19 | | |
20 | | void ossl_ffc_params_init(FFC_PARAMS *params) |
21 | 1.86M | { |
22 | 1.86M | memset(params, 0, sizeof(*params)); |
23 | 1.86M | params->pcounter = -1; |
24 | 1.86M | params->gindex = FFC_UNVERIFIABLE_GINDEX; |
25 | 1.86M | params->flags = FFC_PARAM_FLAG_VALIDATE_PQG; |
26 | 1.86M | } |
27 | | |
28 | | void ossl_ffc_params_cleanup(FFC_PARAMS *params) |
29 | 935k | { |
30 | | #ifdef OPENSSL_PEDANTIC_ZEROIZATION |
31 | | BN_clear_free(params->p); |
32 | | BN_clear_free(params->q); |
33 | | BN_clear_free(params->g); |
34 | | BN_clear_free(params->j); |
35 | | OPENSSL_clear_free(params->seed, params->seedlen); |
36 | | #else |
37 | 935k | BN_free(params->p); |
38 | 935k | BN_free(params->q); |
39 | 935k | BN_free(params->g); |
40 | 935k | BN_free(params->j); |
41 | 935k | OPENSSL_free(params->seed); |
42 | 935k | #endif |
43 | 935k | ossl_ffc_params_init(params); |
44 | 935k | } |
45 | | |
46 | | void ossl_ffc_params_set0_pqg(FFC_PARAMS *d, BIGNUM *p, BIGNUM *q, BIGNUM *g) |
47 | 148k | { |
48 | 148k | if (p != NULL && p != d->p) { |
49 | 148k | BN_free(d->p); |
50 | 148k | d->p = p; |
51 | 148k | } |
52 | 148k | if (q != NULL && q != d->q) { |
53 | 137k | BN_free(d->q); |
54 | 137k | d->q = q; |
55 | 137k | } |
56 | 148k | if (g != NULL && g != d->g) { |
57 | 148k | BN_free(d->g); |
58 | 148k | d->g = g; |
59 | 148k | } |
60 | 148k | } |
61 | | |
62 | | void ossl_ffc_params_get0_pqg(const FFC_PARAMS *d, const BIGNUM **p, |
63 | | const BIGNUM **q, const BIGNUM **g) |
64 | 83.8k | { |
65 | 83.8k | if (p != NULL) |
66 | 83.8k | *p = d->p; |
67 | 83.8k | if (q != NULL) |
68 | 72.3k | *q = d->q; |
69 | 83.8k | if (g != NULL) |
70 | 72.3k | *g = d->g; |
71 | 83.8k | } |
72 | | |
73 | | /* j is the 'cofactor' that is optionally output for ASN1. */ |
74 | | void ossl_ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j) |
75 | 144k | { |
76 | 144k | BN_free(d->j); |
77 | 144k | d->j = NULL; |
78 | 144k | if (j != NULL) |
79 | 7.86k | d->j = j; |
80 | 144k | } |
81 | | |
82 | | int ossl_ffc_params_set_seed(FFC_PARAMS *params, |
83 | | const unsigned char *seed, size_t seedlen) |
84 | 4.70k | { |
85 | 4.70k | if (params->seed != NULL) { |
86 | 0 | if (params->seed == seed) |
87 | 0 | return 1; |
88 | 0 | OPENSSL_free(params->seed); |
89 | 0 | } |
90 | | |
91 | 4.70k | if (seed != NULL && seedlen > 0) { |
92 | 355 | params->seed = OPENSSL_memdup(seed, seedlen); |
93 | 355 | if (params->seed == NULL) |
94 | 0 | return 0; |
95 | 355 | params->seedlen = seedlen; |
96 | 4.34k | } else { |
97 | 4.34k | params->seed = NULL; |
98 | 4.34k | params->seedlen = 0; |
99 | 4.34k | } |
100 | 4.70k | return 1; |
101 | 4.70k | } |
102 | | |
103 | | void ossl_ffc_params_set_gindex(FFC_PARAMS *params, int index) |
104 | 0 | { |
105 | 0 | params->gindex = index; |
106 | 0 | } |
107 | | |
108 | | void ossl_ffc_params_set_pcounter(FFC_PARAMS *params, int index) |
109 | 0 | { |
110 | 0 | params->pcounter = index; |
111 | 0 | } |
112 | | |
113 | | void ossl_ffc_params_set_h(FFC_PARAMS *params, int index) |
114 | 0 | { |
115 | 0 | params->h = index; |
116 | 0 | } |
117 | | |
118 | | void ossl_ffc_params_set_flags(FFC_PARAMS *params, unsigned int flags) |
119 | 0 | { |
120 | 0 | params->flags = flags; |
121 | 0 | } |
122 | | |
123 | | void ossl_ffc_params_enable_flags(FFC_PARAMS *params, unsigned int flags, |
124 | | int enable) |
125 | 159k | { |
126 | 159k | if (enable) |
127 | 102k | params->flags |= flags; |
128 | 56.6k | else |
129 | 56.6k | params->flags &= ~flags; |
130 | 159k | } |
131 | | |
132 | | void ossl_ffc_set_digest(FFC_PARAMS *params, const char *alg, const char *props) |
133 | 0 | { |
134 | 0 | params->mdname = alg; |
135 | 0 | params->mdprops = props; |
136 | 0 | } |
137 | | |
138 | | int ossl_ffc_params_set_validate_params(FFC_PARAMS *params, |
139 | | const unsigned char *seed, |
140 | | size_t seedlen, int counter) |
141 | 437 | { |
142 | 437 | if (!ossl_ffc_params_set_seed(params, seed, seedlen)) |
143 | 0 | return 0; |
144 | 437 | params->pcounter = counter; |
145 | 437 | return 1; |
146 | 437 | } |
147 | | |
148 | | void ossl_ffc_params_get_validate_params(const FFC_PARAMS *params, |
149 | | unsigned char **seed, size_t *seedlen, |
150 | | int *pcounter) |
151 | 399 | { |
152 | 399 | if (seed != NULL) |
153 | 399 | *seed = params->seed; |
154 | 399 | if (seedlen != NULL) |
155 | 399 | *seedlen = params->seedlen; |
156 | 399 | if (pcounter != NULL) |
157 | 399 | *pcounter = params->pcounter; |
158 | 399 | } |
159 | | |
160 | | static int ffc_bn_cpy(BIGNUM **dst, const BIGNUM *src) |
161 | 78.2k | { |
162 | 78.2k | BIGNUM *a; |
163 | | |
164 | | /* |
165 | | * If source is read only just copy the pointer, so |
166 | | * we don't have to reallocate it. |
167 | | */ |
168 | 78.2k | if (src == NULL) |
169 | 25.3k | a = NULL; |
170 | 52.9k | else if (BN_get_flags(src, BN_FLG_STATIC_DATA) |
171 | 3.08k | && !BN_get_flags(src, BN_FLG_MALLOCED)) |
172 | 3.08k | a = (BIGNUM *)src; |
173 | 49.8k | else if ((a = BN_dup(src)) == NULL) |
174 | 0 | return 0; |
175 | 78.2k | BN_clear_free(*dst); |
176 | 78.2k | *dst = a; |
177 | 78.2k | return 1; |
178 | 78.2k | } |
179 | | |
180 | | int ossl_ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src) |
181 | 19.5k | { |
182 | 19.5k | if (!ffc_bn_cpy(&dst->p, src->p) |
183 | 19.5k | || !ffc_bn_cpy(&dst->g, src->g) |
184 | 19.5k | || !ffc_bn_cpy(&dst->q, src->q) |
185 | 19.5k | || !ffc_bn_cpy(&dst->j, src->j)) |
186 | 0 | return 0; |
187 | | |
188 | 19.5k | dst->mdname = src->mdname; |
189 | 19.5k | dst->mdprops = src->mdprops; |
190 | 19.5k | OPENSSL_free(dst->seed); |
191 | 19.5k | dst->seedlen = src->seedlen; |
192 | 19.5k | if (src->seed != NULL) { |
193 | 220 | dst->seed = OPENSSL_memdup(src->seed, src->seedlen); |
194 | 220 | if (dst->seed == NULL) |
195 | 0 | return 0; |
196 | 19.3k | } else { |
197 | 19.3k | dst->seed = NULL; |
198 | 19.3k | } |
199 | 19.5k | dst->nid = src->nid; |
200 | 19.5k | dst->pcounter = src->pcounter; |
201 | 19.5k | dst->h = src->h; |
202 | 19.5k | dst->gindex = src->gindex; |
203 | 19.5k | dst->flags = src->flags; |
204 | 19.5k | dst->keylength = src->keylength; |
205 | 19.5k | return 1; |
206 | 19.5k | } |
207 | | |
208 | | int ossl_ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q) |
209 | 111k | { |
210 | 111k | return BN_cmp(a->p, b->p) == 0 |
211 | 111k | && BN_cmp(a->g, b->g) == 0 |
212 | 111k | && (ignore_q || BN_cmp(a->q, b->q) == 0); /* Note: q may be NULL */ |
213 | 111k | } |
214 | | |
215 | | int ossl_ffc_params_todata(const FFC_PARAMS *ffc, OSSL_PARAM_BLD *bld, |
216 | | OSSL_PARAM params[]) |
217 | 181k | { |
218 | 181k | int test_flags; |
219 | | |
220 | 181k | if (ffc->p != NULL |
221 | 181k | && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_P, ffc->p)) |
222 | 0 | return 0; |
223 | 181k | if (ffc->q != NULL |
224 | 159k | && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_Q, ffc->q)) |
225 | 0 | return 0; |
226 | 181k | if (ffc->g != NULL |
227 | 181k | && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_G, ffc->g)) |
228 | 0 | return 0; |
229 | 181k | if (ffc->j != NULL |
230 | 6.85k | && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_COFACTOR, |
231 | 6.85k | ffc->j)) |
232 | 0 | return 0; |
233 | 181k | if (!ossl_param_build_set_int(bld, params, OSSL_PKEY_PARAM_FFC_GINDEX, |
234 | 181k | ffc->gindex)) |
235 | 0 | return 0; |
236 | 181k | if (!ossl_param_build_set_int(bld, params, OSSL_PKEY_PARAM_FFC_PCOUNTER, |
237 | 181k | ffc->pcounter)) |
238 | 0 | return 0; |
239 | 181k | if (!ossl_param_build_set_int(bld, params, OSSL_PKEY_PARAM_FFC_H, ffc->h)) |
240 | 0 | return 0; |
241 | 181k | if (ffc->seed != NULL |
242 | 434 | && !ossl_param_build_set_octet_string(bld, params, |
243 | 434 | OSSL_PKEY_PARAM_FFC_SEED, |
244 | 434 | ffc->seed, ffc->seedlen)) |
245 | 0 | return 0; |
246 | 181k | if (ffc->nid != NID_undef) { |
247 | 2.86k | const DH_NAMED_GROUP *group = ossl_ffc_uid_to_dh_named_group(ffc->nid); |
248 | 2.86k | const char *name = ossl_ffc_named_group_get_name(group); |
249 | | |
250 | 2.86k | if (name == NULL |
251 | 2.86k | || !ossl_param_build_set_utf8_string(bld, params, |
252 | 2.86k | OSSL_PKEY_PARAM_GROUP_NAME, |
253 | 2.86k | name)) |
254 | 0 | return 0; |
255 | 2.86k | } |
256 | 181k | test_flags = ((ffc->flags & FFC_PARAM_FLAG_VALIDATE_PQ) != 0); |
257 | 181k | if (!ossl_param_build_set_int(bld, params, |
258 | 181k | OSSL_PKEY_PARAM_FFC_VALIDATE_PQ, test_flags)) |
259 | 0 | return 0; |
260 | 181k | test_flags = ((ffc->flags & FFC_PARAM_FLAG_VALIDATE_G) != 0); |
261 | 181k | if (!ossl_param_build_set_int(bld, params, |
262 | 181k | OSSL_PKEY_PARAM_FFC_VALIDATE_G, test_flags)) |
263 | 0 | return 0; |
264 | 181k | test_flags = ((ffc->flags & FFC_PARAM_FLAG_VALIDATE_LEGACY) != 0); |
265 | 181k | if (!ossl_param_build_set_int(bld, params, |
266 | 181k | OSSL_PKEY_PARAM_FFC_VALIDATE_LEGACY, |
267 | 181k | test_flags)) |
268 | 0 | return 0; |
269 | | |
270 | 181k | if (ffc->mdname != NULL |
271 | 0 | && !ossl_param_build_set_utf8_string(bld, params, |
272 | 0 | OSSL_PKEY_PARAM_FFC_DIGEST, |
273 | 0 | ffc->mdname)) |
274 | 0 | return 0; |
275 | 181k | if (ffc->mdprops != NULL |
276 | 0 | && !ossl_param_build_set_utf8_string(bld, params, |
277 | 0 | OSSL_PKEY_PARAM_FFC_DIGEST_PROPS, |
278 | 0 | ffc->mdprops)) |
279 | 0 | return 0; |
280 | 181k | return 1; |
281 | 181k | } |
282 | | |
283 | | #ifndef FIPS_MODULE |
284 | | int ossl_ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent) |
285 | 115 | { |
286 | 115 | if (!ASN1_bn_print(bp, "prime P:", ffc->p, NULL, indent)) |
287 | 0 | goto err; |
288 | 115 | if (!ASN1_bn_print(bp, "generator G:", ffc->g, NULL, indent)) |
289 | 0 | goto err; |
290 | 115 | if (ffc->q != NULL |
291 | 115 | && !ASN1_bn_print(bp, "subgroup order Q:", ffc->q, NULL, indent)) |
292 | 0 | goto err; |
293 | 115 | if (ffc->j != NULL |
294 | 0 | && !ASN1_bn_print(bp, "subgroup factor:", ffc->j, NULL, indent)) |
295 | 0 | goto err; |
296 | 115 | if (ffc->seed != NULL) { |
297 | 0 | size_t i; |
298 | |
|
299 | 0 | if (!BIO_indent(bp, indent, 128) |
300 | 0 | || BIO_puts(bp, "seed:") <= 0) |
301 | 0 | goto err; |
302 | 0 | for (i = 0; i < ffc->seedlen; i++) { |
303 | 0 | if ((i % 15) == 0) { |
304 | 0 | if (BIO_puts(bp, "\n") <= 0 |
305 | 0 | || !BIO_indent(bp, indent + 4, 128)) |
306 | 0 | goto err; |
307 | 0 | } |
308 | 0 | if (BIO_printf(bp, "%02x%s", ffc->seed[i], |
309 | 0 | ((i + 1) == ffc->seedlen) ? "" : ":") |
310 | 0 | <= 0) |
311 | 0 | goto err; |
312 | 0 | } |
313 | 0 | if (BIO_write(bp, "\n", 1) <= 0) |
314 | 0 | return 0; |
315 | 0 | } |
316 | 115 | if (ffc->pcounter != -1) { |
317 | 0 | if (!BIO_indent(bp, indent, 128) |
318 | 0 | || BIO_printf(bp, "counter: %d\n", ffc->pcounter) <= 0) |
319 | 0 | goto err; |
320 | 0 | } |
321 | 115 | return 1; |
322 | 0 | err: |
323 | 0 | return 0; |
324 | 115 | } |
325 | | #endif /* FIPS_MODULE */ |