ffc.h revision 1.1.1.1 
1/*
2 * Copyright 2019-2023 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#ifndef OSSL_INTERNAL_FFC_H
11# define OSSL_INTERNAL_FFC_H
12# pragma once
13
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"
21
22/* Default value for gindex when canonical generation of g is not used */
23# define FFC_UNVERIFIABLE_GINDEX -1
24
25/* The different types of FFC keys */
26# define FFC_PARAM_TYPE_DSA  0
27# define FFC_PARAM_TYPE_DH   1
28
29/*
30 * The mode used by functions that share code for both generation and
31 * verification. See ossl_ffc_params_FIPS186_4_gen_verify().
32 */
33#define FFC_PARAM_MODE_VERIFY   0
34#define FFC_PARAM_MODE_GENERATE 1
35
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
41
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_PQG                                           \
46    (FFC_PARAM_FLAG_VALIDATE_PQ | FFC_PARAM_FLAG_VALIDATE_G)
47#define FFC_PARAM_FLAG_VALIDATE_LEGACY 0x04
48
49/*
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.
52 */
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
60
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
71
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
79# define FFC_ERROR_PASSED_NULL_PARAM      0x40
80
81/*
82 * Finite field cryptography (FFC) domain parameters are used by DH and DSA.
83 * Refer to FIPS186_4 Appendix A & B.
84 */
85typedef struct ffc_params_st {
86    /* Primes */
87    BIGNUM *p;
88    BIGNUM *q;
89    /* Generator */
90    BIGNUM *g;
91    /* DH X9.42 Optional Subgroup factor j >= 2 where p = j * q + 1 */
92    BIGNUM *j;
93
94    /* Required for FIPS186_4 validation of p, q and optionally canonical g */
95    unsigned char *seed;
96    /* If this value is zero the hash size is used as the seed length */
97    size_t seedlen;
98    /* Required for FIPS186_4 validation of p and q */
99    int pcounter;
100    int nid; /* The identity of a named group */
101
102    /*
103     * Required for FIPS186_4 generation & validation of canonical g.
104     * It uses unverifiable g if this value is -1.
105     */
106    int gindex;
107    int h; /* loop counter for unverifiable g */
108
109    unsigned int flags;
110    /*
111     * The digest to use for generation or validation. If this value is NULL,
112     * then the digest is chosen using the value of N.
113     */
114    const char *mdname;
115    const char *mdprops;
116    /* Default key length for known named groups according to RFC7919 */
117    int keylength;
118} FFC_PARAMS;
119
120void ossl_ffc_params_init(FFC_PARAMS *params);
121void ossl_ffc_params_cleanup(FFC_PARAMS *params);
122void ossl_ffc_params_set0_pqg(FFC_PARAMS *params, BIGNUM *p, BIGNUM *q,
123                              BIGNUM *g);
124void ossl_ffc_params_get0_pqg(const FFC_PARAMS *params, const BIGNUM **p,
125                              const BIGNUM **q, const BIGNUM **g);
126void ossl_ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j);
127int ossl_ffc_params_set_seed(FFC_PARAMS *params,
128                             const unsigned char *seed, size_t seedlen);
129void ossl_ffc_params_set_gindex(FFC_PARAMS *params, int index);
130void ossl_ffc_params_set_pcounter(FFC_PARAMS *params, int index);
131void ossl_ffc_params_set_h(FFC_PARAMS *params, int index);
132void ossl_ffc_params_set_flags(FFC_PARAMS *params, unsigned int flags);
133void ossl_ffc_params_enable_flags(FFC_PARAMS *params, unsigned int flags,
134                                  int enable);
135int ossl_ffc_set_digest(FFC_PARAMS *params, const char *alg, const char *props);
136
137int ossl_ffc_params_set_validate_params(FFC_PARAMS *params,
138                                        const unsigned char *seed,
139                                        size_t seedlen, int counter);
140void ossl_ffc_params_get_validate_params(const FFC_PARAMS *params,
141                                         unsigned char **seed, size_t *seedlen,
142                                         int *pcounter);
143
144int ossl_ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src);
145int ossl_ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q);
146
147#ifndef FIPS_MODULE
148int ossl_ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent);
149#endif /* FIPS_MODULE */
150
151
152int ossl_ffc_params_FIPS186_4_generate(OSSL_LIB_CTX *libctx, FFC_PARAMS *params,
153                                       int type, size_t L, size_t N,
154                                       int *res, BN_GENCB *cb);
155int ossl_ffc_params_FIPS186_2_generate(OSSL_LIB_CTX *libctx, FFC_PARAMS *params,
156                                       int type, size_t L, size_t N,
157                                       int *res, BN_GENCB *cb);
158
159int ossl_ffc_params_FIPS186_4_gen_verify(OSSL_LIB_CTX *libctx,
160                                         FFC_PARAMS *params, int mode, int type,
161                                         size_t L, size_t N, int *res,
162                                         BN_GENCB *cb);
163int ossl_ffc_params_FIPS186_2_gen_verify(OSSL_LIB_CTX *libctx,
164                                         FFC_PARAMS *params, int mode, int type,
165                                         size_t L, size_t N, int *res,
166                                         BN_GENCB *cb);
167
168int ossl_ffc_params_simple_validate(OSSL_LIB_CTX *libctx,
169                                    const FFC_PARAMS *params,
170                                    int paramstype, int *res);
171int ossl_ffc_params_full_validate(OSSL_LIB_CTX *libctx,
172                                  const FFC_PARAMS *params,
173                                  int paramstype, int *res);
174int ossl_ffc_params_FIPS186_4_validate(OSSL_LIB_CTX *libctx,
175                                       const FFC_PARAMS *params,
176                                       int type, int *res, BN_GENCB *cb);
177int ossl_ffc_params_FIPS186_2_validate(OSSL_LIB_CTX *libctx,
178                                       const FFC_PARAMS *params,
179                                       int type, int *res, BN_GENCB *cb);
180
181int ossl_ffc_generate_private_key(BN_CTX *ctx, const FFC_PARAMS *params,
182                                  int N, int s, BIGNUM *priv);
183
184int ossl_ffc_params_validate_unverifiable_g(BN_CTX *ctx, BN_MONT_CTX *mont,
185                                            const BIGNUM *p, const BIGNUM *q,
186                                            const BIGNUM *g, BIGNUM *tmp,
187                                            int *ret);
188
189int ossl_ffc_validate_public_key(const FFC_PARAMS *params,
190                                 const BIGNUM *pub_key, int *ret);
191int ossl_ffc_validate_public_key_partial(const FFC_PARAMS *params,
192                                         const BIGNUM *pub_key, int *ret);
193int ossl_ffc_validate_private_key(const BIGNUM *upper, const BIGNUM *priv_key,
194                                 int *ret);
195
196int ossl_ffc_params_todata(const FFC_PARAMS *ffc, OSSL_PARAM_BLD *tmpl,
197                           OSSL_PARAM params[]);
198int ossl_ffc_params_fromdata(FFC_PARAMS *ffc, const OSSL_PARAM params[]);
199
200typedef struct dh_named_group_st DH_NAMED_GROUP;
201const DH_NAMED_GROUP *ossl_ffc_name_to_dh_named_group(const char *name);
202const DH_NAMED_GROUP *ossl_ffc_uid_to_dh_named_group(int uid);
203#ifndef OPENSSL_NO_DH
204const DH_NAMED_GROUP *ossl_ffc_numbers_to_dh_named_group(const BIGNUM *p,
205                                                         const BIGNUM *q,
206                                                         const BIGNUM *g);
207#endif
208int ossl_ffc_named_group_get_uid(const DH_NAMED_GROUP *group);
209const char *ossl_ffc_named_group_get_name(const DH_NAMED_GROUP *);
210#ifndef OPENSSL_NO_DH
211int ossl_ffc_named_group_get_keylength(const DH_NAMED_GROUP *group);
212const BIGNUM *ossl_ffc_named_group_get_q(const DH_NAMED_GROUP *group);
213int ossl_ffc_named_group_set(FFC_PARAMS *ffc, const DH_NAMED_GROUP *group);
214#endif
215
216#endif /* OSSL_INTERNAL_FFC_H */
217