2 * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
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
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 #include "e_os.h" /* strcasecmp */
18 # include <openssl/asn1.h> /* ffc_params_print */
21 void ffc_params_init(FFC_PARAMS *params)
23 memset(params, 0, sizeof(*params));
24 params->pcounter = -1;
25 params->gindex = FFC_UNVERIFIABLE_GINDEX;
26 params->flags = FFC_PARAM_FLAG_VALIDATE_ALL;
29 void ffc_params_cleanup(FFC_PARAMS *params)
35 OPENSSL_free(params->seed);
36 ffc_params_init(params);
39 void ffc_params_set0_pqg(FFC_PARAMS *d, BIGNUM *p, BIGNUM *q, BIGNUM *g)
41 if (p != NULL && p != d->p) {
45 if (q != NULL && q != d->q) {
49 if (g != NULL && g != d->g) {
55 void ffc_params_get0_pqg(const FFC_PARAMS *d, const BIGNUM **p,
56 const BIGNUM **q, const BIGNUM **g)
67 /* j is the 'cofactor' that is optionally output for ASN1. */
68 void ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j)
76 int ffc_params_set_seed(FFC_PARAMS *params,
77 const unsigned char *seed, size_t seedlen)
82 if (params->seed != NULL) {
83 if (params->seed == seed)
85 OPENSSL_free(params->seed);
88 if (seed != NULL && seedlen > 0) {
89 params->seed = OPENSSL_memdup(seed, seedlen);
90 if (params->seed == NULL)
92 params->seedlen = seedlen;
100 void ffc_params_set_gindex(FFC_PARAMS *params, int index)
102 params->gindex = index;
105 void ffc_params_set_pcounter(FFC_PARAMS *params, int index)
107 params->pcounter = index;
110 void ffc_params_set_h(FFC_PARAMS *params, int index)
115 void ffc_params_set_flags(FFC_PARAMS *params, unsigned int flags)
117 params->flags = flags;
120 int ffc_set_digest(FFC_PARAMS *params, const char *alg, const char *props)
122 params->mdname = alg;
123 params->mdprops = props;
127 int ffc_params_set_validate_params(FFC_PARAMS *params,
128 const unsigned char *seed, size_t seedlen,
131 if (!ffc_params_set_seed(params, seed, seedlen))
133 params->pcounter = counter;
137 void ffc_params_get_validate_params(const FFC_PARAMS *params,
138 unsigned char **seed, size_t *seedlen,
142 *seed = params->seed;
144 *seedlen = params->seedlen;
145 if (pcounter != NULL)
146 *pcounter = params->pcounter;
149 static int ffc_bn_cpy(BIGNUM **dst, const BIGNUM *src)
154 * If source is read only just copy the pointer, so
155 * we don't have to reallocate it.
159 else if (BN_get_flags(src, BN_FLG_STATIC_DATA)
160 && !BN_get_flags(src, BN_FLG_MALLOCED))
162 else if ((a = BN_dup(src)) == NULL)
169 int ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src)
171 if (!ffc_bn_cpy(&dst->p, src->p)
172 || !ffc_bn_cpy(&dst->g, src->g)
173 || !ffc_bn_cpy(&dst->q, src->q)
174 || !ffc_bn_cpy(&dst->j, src->j))
177 OPENSSL_free(dst->seed);
178 dst->seedlen = src->seedlen;
179 if (src->seed != NULL) {
180 dst->seed = OPENSSL_memdup(src->seed, src->seedlen);
181 if (dst->seed == NULL)
187 dst->pcounter = src->pcounter;
189 dst->gindex = src->gindex;
193 int ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q)
195 return BN_cmp(a->p, b->p) == 0
196 && BN_cmp(a->g, b->g) == 0
197 && (ignore_q || BN_cmp(a->q, b->q) == 0); /* Note: q may be NULL */
200 static const OSSL_ITEM flag_map[] = {
201 { FFC_PARAM_FLAG_VALIDATE_PQ, OSSL_FFC_PARAM_VALIDATE_PQ },
202 { FFC_PARAM_FLAG_VALIDATE_G, OSSL_FFC_PARAM_VALIDATE_G },
203 { FFC_PARAM_FLAG_VALIDATE_ALL, OSSL_FFC_PARAM_VALIDATE_PQG },
207 int ffc_params_flags_from_name(const char *name)
211 for (i = 0; i < OSSL_NELEM(flag_map); ++i) {
212 if (strcasecmp(flag_map[i].ptr, name) == 0)
213 return flag_map[i].id;
218 const char *ffc_params_flags_to_name(int flags)
222 flags &= FFC_PARAM_FLAG_VALIDATE_ALL;
223 for (i = 0; i < OSSL_NELEM(flag_map); ++i) {
224 if ((int)flag_map[i].id == flags)
225 return flag_map[i].ptr;
230 int ffc_params_todata(const FFC_PARAMS *ffc, OSSL_PARAM_BLD *bld,
237 && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_P, ffc->p))
240 && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_Q, ffc->q))
243 && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_G, ffc->g))
246 && !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_FFC_COFACTOR,
249 if (!ossl_param_build_set_int(bld, params, OSSL_PKEY_PARAM_FFC_GINDEX,
252 if (!ossl_param_build_set_int(bld, params, OSSL_PKEY_PARAM_FFC_PCOUNTER,
255 if (!ossl_param_build_set_int(bld, params, OSSL_PKEY_PARAM_FFC_H, ffc->h))
257 if (ffc->seed != NULL
258 && !ossl_param_build_set_octet_string(bld, params,
259 OSSL_PKEY_PARAM_FFC_SEED,
260 ffc->seed, ffc->seedlen))
262 if (ffc->nid != NID_undef) {
263 #ifndef OPENSSL_NO_DH
264 const char *name = ffc_named_group_from_uid(ffc->nid);
267 || !ossl_param_build_set_utf8_string(bld, params,
268 OSSL_PKEY_PARAM_DH_GROUP,
272 /* How could this be? We should not have a nid in a no-dh build. */
276 if (!ossl_param_build_set_utf8_string(bld, params,
277 OSSL_PKEY_PARAM_FFC_VALIDATE_TYPE,
278 ffc_params_flags_to_name(ffc->flags)))
280 if (ffc->mdname != NULL
281 && !ossl_param_build_set_utf8_string(bld, params,
282 OSSL_PKEY_PARAM_FFC_DIGEST,
285 if (ffc->mdprops != NULL
286 && !ossl_param_build_set_utf8_string(bld, params,
287 OSSL_PKEY_PARAM_FFC_DIGEST_PROPS,
294 int ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent)
296 if (!ASN1_bn_print(bp, "prime P:", ffc->p, NULL, indent))
298 if (!ASN1_bn_print(bp, "generator G:", ffc->g, NULL, indent))
301 && !ASN1_bn_print(bp, "subgroup order Q:", ffc->q, NULL, indent))
304 && !ASN1_bn_print(bp, "subgroup factor:", ffc->j, NULL, indent))
306 if (ffc->seed != NULL) {
308 BIO_indent(bp, indent, 128);
309 BIO_puts(bp, "seed:");
310 for (i = 0; i < ffc->seedlen; i++) {
312 if (BIO_puts(bp, "\n") <= 0
313 || !BIO_indent(bp, indent + 4, 128))
316 if (BIO_printf(bp, "%02x%s", ffc->seed[i],
317 ((i + 1) == ffc->seedlen) ? "" : ":") <= 0)
320 if (BIO_write(bp, "\n", 1) <= 0)
323 if (ffc->pcounter != -1) {
324 BIO_indent(bp, indent, 128);
325 if (BIO_printf(bp, "counter: %d\n", ffc->pcounter) <= 0)
332 #endif /* FIPS_MODULE */