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