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 #ifndef OSSL_INTERNAL_FFC_H
11 # define OSSL_INTERNAL_FFC_H
13 # include <openssl/core.h>
14 # include <openssl/bn.h>
15 # include <openssl/evp.h>
16 # include <openssl/dh.h> /* Uses Error codes from DH */
17 # include <openssl/params.h>
18 # include <openssl/param_build.h>
19 # include "internal/sizes.h"
21 /* Default value for gindex when canonical generation of g is not used */
22 # define FFC_UNVERIFIABLE_GINDEX -1
24 /* The different types of FFC keys */
25 # define FFC_PARAM_TYPE_DSA 0
26 # define FFC_PARAM_TYPE_DH 1
29 * The mode used by functions that share code for both generation and
30 * verification. See ossl_ffc_params_FIPS186_4_gen_verify().
32 #define FFC_PARAM_MODE_VERIFY 0
33 #define FFC_PARAM_MODE_GENERATE 1
35 /* Return codes for generation and validation of FFC parameters */
36 #define FFC_PARAM_RET_STATUS_FAILED 0
37 #define FFC_PARAM_RET_STATUS_SUCCESS 1
38 /* Returned if validating and g is only partially verifiable */
39 #define FFC_PARAM_RET_STATUS_UNVERIFIABLE_G 2
41 /* Validation flags */
42 # define FFC_PARAM_FLAG_VALIDATE_PQ 0x01
43 # define FFC_PARAM_FLAG_VALIDATE_G 0x02
44 # define FFC_PARAM_FLAG_VALIDATE_ALL \
45 (FFC_PARAM_FLAG_VALIDATE_PQ | FFC_PARAM_FLAG_VALIDATE_G)
46 #define FFC_PARAM_FLAG_VALIDATE_LEGACY 0x04
49 * NB: These values must align with the equivalently named macros in
50 * openssl/dh.h. We cannot use those macros here in case DH has been disabled.
52 # define FFC_CHECK_P_NOT_PRIME 0x00001
53 # define FFC_CHECK_P_NOT_SAFE_PRIME 0x00002
54 # define FFC_CHECK_UNKNOWN_GENERATOR 0x00004
55 # define FFC_CHECK_NOT_SUITABLE_GENERATOR 0x00008
56 # define FFC_CHECK_Q_NOT_PRIME 0x00010
57 # define FFC_CHECK_INVALID_Q_VALUE 0x00020
58 # define FFC_CHECK_INVALID_J_VALUE 0x00040
60 # define FFC_CHECK_BAD_LN_PAIR 0x00080
61 # define FFC_CHECK_INVALID_SEED_SIZE 0x00100
62 # define FFC_CHECK_MISSING_SEED_OR_COUNTER 0x00200
63 # define FFC_CHECK_INVALID_G 0x00400
64 # define FFC_CHECK_INVALID_PQ 0x00800
65 # define FFC_CHECK_INVALID_COUNTER 0x01000
66 # define FFC_CHECK_P_MISMATCH 0x02000
67 # define FFC_CHECK_Q_MISMATCH 0x04000
68 # define FFC_CHECK_G_MISMATCH 0x08000
69 # define FFC_CHECK_COUNTER_MISMATCH 0x10000
71 /* Validation Return codes */
72 # define FFC_ERROR_PUBKEY_TOO_SMALL 0x01
73 # define FFC_ERROR_PUBKEY_TOO_LARGE 0x02
74 # define FFC_ERROR_PUBKEY_INVALID 0x04
75 # define FFC_ERROR_NOT_SUITABLE_GENERATOR 0x08
76 # define FFC_ERROR_PRIVKEY_TOO_SMALL 0x10
77 # define FFC_ERROR_PRIVKEY_TOO_LARGE 0x20
80 * Finite field cryptography (FFC) domain parameters are used by DH and DSA.
81 * Refer to FIPS186_4 Appendix A & B.
83 typedef struct ffc_params_st {
89 /* DH X9.42 Optional Subgroup factor j >= 2 where p = j * q + 1 */
92 /* Required for FIPS186_4 validation of p, q and optionally canonical g */
94 /* If this value is zero the hash size is used as the seed length */
96 /* Required for FIPS186_4 validation of p and q */
98 int nid; /* The identity of a named group */
101 * Required for FIPS186_4 generation & validation of canonical g.
102 * It uses unverifiable g if this value is -1.
105 int h; /* loop counter for unverifiable g */
107 unsigned int flags; /* See FFC_PARAM_FLAG_VALIDATE_ALL */
109 * The digest to use for generation or validation. If this value is NULL,
110 * then the digest is chosen using the value of N.
116 void ossl_ffc_params_init(FFC_PARAMS *params);
117 void ossl_ffc_params_cleanup(FFC_PARAMS *params);
118 void ossl_ffc_params_set0_pqg(FFC_PARAMS *params, BIGNUM *p, BIGNUM *q,
120 void ossl_ffc_params_get0_pqg(const FFC_PARAMS *params, const BIGNUM **p,
121 const BIGNUM **q, const BIGNUM **g);
122 void ossl_ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j);
123 int ossl_ffc_params_set_seed(FFC_PARAMS *params,
124 const unsigned char *seed, size_t seedlen);
125 void ossl_ffc_params_set_gindex(FFC_PARAMS *params, int index);
126 void ossl_ffc_params_set_pcounter(FFC_PARAMS *params, int index);
127 void ossl_ffc_params_set_h(FFC_PARAMS *params, int index);
128 void ossl_ffc_params_set_flags(FFC_PARAMS *params, unsigned int flags);
129 void ossl_ffc_params_enable_flags(FFC_PARAMS *params, unsigned int flags,
131 int ossl_ffc_set_digest(FFC_PARAMS *params, const char *alg, const char *props);
133 int ossl_ffc_params_set_validate_params(FFC_PARAMS *params,
134 const unsigned char *seed,
135 size_t seedlen, int counter);
136 void ossl_ffc_params_get_validate_params(const FFC_PARAMS *params,
137 unsigned char **seed, size_t *seedlen,
140 int ossl_ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src);
141 int ossl_ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q);
144 int ossl_ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent);
145 #endif /* FIPS_MODULE */
148 int ossl_ffc_params_FIPS186_4_generate(OSSL_LIB_CTX *libctx, FFC_PARAMS *params,
149 int type, size_t L, size_t N,
150 int *res, BN_GENCB *cb);
151 int ossl_ffc_params_FIPS186_2_generate(OSSL_LIB_CTX *libctx, FFC_PARAMS *params,
152 int type, size_t L, size_t N,
153 int *res, BN_GENCB *cb);
155 int ossl_ffc_params_FIPS186_4_gen_verify(OSSL_LIB_CTX *libctx,
156 FFC_PARAMS *params, int mode, int type,
157 size_t L, size_t N, int *res,
159 int ossl_ffc_params_FIPS186_2_gen_verify(OSSL_LIB_CTX *libctx,
160 FFC_PARAMS *params, int mode, int type,
161 size_t L, size_t N, int *res,
164 int ossl_ffc_params_simple_validate(OSSL_LIB_CTX *libctx, FFC_PARAMS *params,
166 int ossl_ffc_params_FIPS186_4_validate(OSSL_LIB_CTX *libctx,
167 const FFC_PARAMS *params,
168 int type, int *res, BN_GENCB *cb);
169 int ossl_ffc_params_FIPS186_2_validate(OSSL_LIB_CTX *libctx,
170 const FFC_PARAMS *params,
171 int type, int *res, BN_GENCB *cb);
173 int ossl_ffc_generate_private_key(BN_CTX *ctx, const FFC_PARAMS *params,
174 int N, int s, BIGNUM *priv);
176 int ossl_ffc_params_validate_unverifiable_g(BN_CTX *ctx, BN_MONT_CTX *mont,
177 const BIGNUM *p, const BIGNUM *q,
178 const BIGNUM *g, BIGNUM *tmp,
181 int ossl_ffc_validate_public_key(const FFC_PARAMS *params,
182 const BIGNUM *pub_key, int *ret);
183 int ossl_ffc_validate_public_key_partial(const FFC_PARAMS *params,
184 const BIGNUM *pub_key, int *ret);
185 int ossl_ffc_validate_private_key(const BIGNUM *upper, const BIGNUM *priv_key,
188 int ossl_ffc_params_todata(const FFC_PARAMS *ffc, OSSL_PARAM_BLD *tmpl,
189 OSSL_PARAM params[]);
190 int ossl_ffc_params_fromdata(FFC_PARAMS *ffc, const OSSL_PARAM params[]);
191 int ossl_ffc_set_group_pqg(FFC_PARAMS *ffc, const char *group_name);
192 int ossl_ffc_named_group_to_uid(const char *name);
193 const char *ossl_ffc_named_group_from_uid(int nid);
194 int ossl_ffc_set_group_pqg(FFC_PARAMS *ffc, const char *group_name);
195 const char *ossl_ffc_params_flags_to_name(int flags);
196 int ossl_ffc_params_flags_from_name(const char *name);
198 #endif /* OSSL_INTERNAL_FFC_H */