2 * Copyright 2019-2021 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
14 # include <openssl/core.h>
15 # include <openssl/bn.h>
16 # include <openssl/evp.h>
17 # include <openssl/dh.h> /* Uses Error codes from DH */
18 # include <openssl/params.h>
19 # include <openssl/param_build.h>
20 # include "internal/sizes.h"
22 /* Default value for gindex when canonical generation of g is not used */
23 # define FFC_UNVERIFIABLE_GINDEX -1
25 /* The different types of FFC keys */
26 # define FFC_PARAM_TYPE_DSA 0
27 # define FFC_PARAM_TYPE_DH 1
30 * The mode used by functions that share code for both generation and
31 * verification. See ossl_ffc_params_FIPS186_4_gen_verify().
33 #define FFC_PARAM_MODE_VERIFY 0
34 #define FFC_PARAM_MODE_GENERATE 1
36 /* Return codes for generation and validation of FFC parameters */
37 #define FFC_PARAM_RET_STATUS_FAILED 0
38 #define FFC_PARAM_RET_STATUS_SUCCESS 1
39 /* Returned if validating and g is only partially verifiable */
40 #define FFC_PARAM_RET_STATUS_UNVERIFIABLE_G 2
42 /* Validation flags */
43 # define FFC_PARAM_FLAG_VALIDATE_PQ 0x01
44 # define FFC_PARAM_FLAG_VALIDATE_G 0x02
45 # define FFC_PARAM_FLAG_VALIDATE_ALL \
46 (FFC_PARAM_FLAG_VALIDATE_PQ | FFC_PARAM_FLAG_VALIDATE_G)
47 #define FFC_PARAM_FLAG_VALIDATE_LEGACY 0x04
50 * NB: These values must align with the equivalently named macros in
51 * openssl/dh.h. We cannot use those macros here in case DH has been disabled.
53 # define FFC_CHECK_P_NOT_PRIME 0x00001
54 # define FFC_CHECK_P_NOT_SAFE_PRIME 0x00002
55 # define FFC_CHECK_UNKNOWN_GENERATOR 0x00004
56 # define FFC_CHECK_NOT_SUITABLE_GENERATOR 0x00008
57 # define FFC_CHECK_Q_NOT_PRIME 0x00010
58 # define FFC_CHECK_INVALID_Q_VALUE 0x00020
59 # define FFC_CHECK_INVALID_J_VALUE 0x00040
61 # define FFC_CHECK_BAD_LN_PAIR 0x00080
62 # define FFC_CHECK_INVALID_SEED_SIZE 0x00100
63 # define FFC_CHECK_MISSING_SEED_OR_COUNTER 0x00200
64 # define FFC_CHECK_INVALID_G 0x00400
65 # define FFC_CHECK_INVALID_PQ 0x00800
66 # define FFC_CHECK_INVALID_COUNTER 0x01000
67 # define FFC_CHECK_P_MISMATCH 0x02000
68 # define FFC_CHECK_Q_MISMATCH 0x04000
69 # define FFC_CHECK_G_MISMATCH 0x08000
70 # define FFC_CHECK_COUNTER_MISMATCH 0x10000
72 /* Validation Return codes */
73 # define FFC_ERROR_PUBKEY_TOO_SMALL 0x01
74 # define FFC_ERROR_PUBKEY_TOO_LARGE 0x02
75 # define FFC_ERROR_PUBKEY_INVALID 0x04
76 # define FFC_ERROR_NOT_SUITABLE_GENERATOR 0x08
77 # define FFC_ERROR_PRIVKEY_TOO_SMALL 0x10
78 # define FFC_ERROR_PRIVKEY_TOO_LARGE 0x20
81 * Finite field cryptography (FFC) domain parameters are used by DH and DSA.
82 * Refer to FIPS186_4 Appendix A & B.
84 typedef struct ffc_params_st
{
90 /* DH X9.42 Optional Subgroup factor j >= 2 where p = j * q + 1 */
93 /* Required for FIPS186_4 validation of p, q and optionally canonical g */
95 /* If this value is zero the hash size is used as the seed length */
97 /* Required for FIPS186_4 validation of p and q */
99 int nid
; /* The identity of a named group */
102 * Required for FIPS186_4 generation & validation of canonical g.
103 * It uses unverifiable g if this value is -1.
106 int h
; /* loop counter for unverifiable g */
108 unsigned int flags
; /* See FFC_PARAM_FLAG_VALIDATE_ALL */
110 * The digest to use for generation or validation. If this value is NULL,
111 * then the digest is chosen using the value of N.
117 void ossl_ffc_params_init(FFC_PARAMS
*params
);
118 void ossl_ffc_params_cleanup(FFC_PARAMS
*params
);
119 void ossl_ffc_params_set0_pqg(FFC_PARAMS
*params
, BIGNUM
*p
, BIGNUM
*q
,
121 void ossl_ffc_params_get0_pqg(const FFC_PARAMS
*params
, const BIGNUM
**p
,
122 const BIGNUM
**q
, const BIGNUM
**g
);
123 void ossl_ffc_params_set0_j(FFC_PARAMS
*d
, BIGNUM
*j
);
124 int ossl_ffc_params_set_seed(FFC_PARAMS
*params
,
125 const unsigned char *seed
, size_t seedlen
);
126 void ossl_ffc_params_set_gindex(FFC_PARAMS
*params
, int index
);
127 void ossl_ffc_params_set_pcounter(FFC_PARAMS
*params
, int index
);
128 void ossl_ffc_params_set_h(FFC_PARAMS
*params
, int index
);
129 void ossl_ffc_params_set_flags(FFC_PARAMS
*params
, unsigned int flags
);
130 void ossl_ffc_params_enable_flags(FFC_PARAMS
*params
, unsigned int flags
,
132 int ossl_ffc_set_digest(FFC_PARAMS
*params
, const char *alg
, const char *props
);
134 int ossl_ffc_params_set_validate_params(FFC_PARAMS
*params
,
135 const unsigned char *seed
,
136 size_t seedlen
, int counter
);
137 void ossl_ffc_params_get_validate_params(const FFC_PARAMS
*params
,
138 unsigned char **seed
, size_t *seedlen
,
141 int ossl_ffc_params_copy(FFC_PARAMS
*dst
, const FFC_PARAMS
*src
);
142 int ossl_ffc_params_cmp(const FFC_PARAMS
*a
, const FFC_PARAMS
*b
, int ignore_q
);
145 int ossl_ffc_params_print(BIO
*bp
, const FFC_PARAMS
*ffc
, int indent
);
146 #endif /* FIPS_MODULE */
149 int ossl_ffc_params_FIPS186_4_generate(OSSL_LIB_CTX
*libctx
, FFC_PARAMS
*params
,
150 int type
, size_t L
, size_t N
,
151 int *res
, BN_GENCB
*cb
);
152 int ossl_ffc_params_FIPS186_2_generate(OSSL_LIB_CTX
*libctx
, FFC_PARAMS
*params
,
153 int type
, size_t L
, size_t N
,
154 int *res
, BN_GENCB
*cb
);
156 int ossl_ffc_params_FIPS186_4_gen_verify(OSSL_LIB_CTX
*libctx
,
157 FFC_PARAMS
*params
, int mode
, int type
,
158 size_t L
, size_t N
, int *res
,
160 int ossl_ffc_params_FIPS186_2_gen_verify(OSSL_LIB_CTX
*libctx
,
161 FFC_PARAMS
*params
, int mode
, int type
,
162 size_t L
, size_t N
, int *res
,
165 int ossl_ffc_params_simple_validate(OSSL_LIB_CTX
*libctx
,
166 const FFC_PARAMS
*params
,
167 int paramstype
, int *res
);
168 int ossl_ffc_params_full_validate(OSSL_LIB_CTX
*libctx
,
169 const FFC_PARAMS
*params
,
170 int paramstype
, int *res
);
171 int ossl_ffc_params_FIPS186_4_validate(OSSL_LIB_CTX
*libctx
,
172 const FFC_PARAMS
*params
,
173 int type
, int *res
, BN_GENCB
*cb
);
174 int ossl_ffc_params_FIPS186_2_validate(OSSL_LIB_CTX
*libctx
,
175 const FFC_PARAMS
*params
,
176 int type
, int *res
, BN_GENCB
*cb
);
178 int ossl_ffc_generate_private_key(BN_CTX
*ctx
, const FFC_PARAMS
*params
,
179 int N
, int s
, BIGNUM
*priv
);
181 int ossl_ffc_params_validate_unverifiable_g(BN_CTX
*ctx
, BN_MONT_CTX
*mont
,
182 const BIGNUM
*p
, const BIGNUM
*q
,
183 const BIGNUM
*g
, BIGNUM
*tmp
,
186 int ossl_ffc_validate_public_key(const FFC_PARAMS
*params
,
187 const BIGNUM
*pub_key
, int *ret
);
188 int ossl_ffc_validate_public_key_partial(const FFC_PARAMS
*params
,
189 const BIGNUM
*pub_key
, int *ret
);
190 int ossl_ffc_validate_private_key(const BIGNUM
*upper
, const BIGNUM
*priv_key
,
193 int ossl_ffc_params_todata(const FFC_PARAMS
*ffc
, OSSL_PARAM_BLD
*tmpl
,
194 OSSL_PARAM params
[]);
195 int ossl_ffc_params_fromdata(FFC_PARAMS
*ffc
, const OSSL_PARAM params
[]);
197 typedef struct dh_named_group_st DH_NAMED_GROUP
;
198 const DH_NAMED_GROUP
*ossl_ffc_name_to_dh_named_group(const char *name
);
199 const DH_NAMED_GROUP
*ossl_ffc_uid_to_dh_named_group(int uid
);
200 #ifndef OPENSSL_NO_DH
201 const DH_NAMED_GROUP
*ossl_ffc_numbers_to_dh_named_group(const BIGNUM
*p
,
205 int ossl_ffc_named_group_get_uid(const DH_NAMED_GROUP
*group
);
206 const char *ossl_ffc_named_group_get_name(const DH_NAMED_GROUP
*);
207 #ifndef OPENSSL_NO_DH
208 const BIGNUM
*ossl_ffc_named_group_get_q(const DH_NAMED_GROUP
*group
);
209 int ossl_ffc_named_group_set_pqg(FFC_PARAMS
*ffc
, const DH_NAMED_GROUP
*group
);
212 const char *ossl_ffc_params_flags_to_name(int flags
);
213 int ossl_ffc_params_flags_from_name(const char *name
);
215 #endif /* OSSL_INTERNAL_FFC_H */