| 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 | # ifndef RT_WITHOUT_PRAGMA_ONCE /* VBOX */
|
|---|
| 13 | # pragma once
|
|---|
| 14 | # endif /* VBOX */
|
|---|
| 15 |
|
|---|
| 16 | # include <openssl/core.h>
|
|---|
| 17 | # include <openssl/bn.h>
|
|---|
| 18 | # include <openssl/evp.h>
|
|---|
| 19 | # include <openssl/dh.h> /* Uses Error codes from DH */
|
|---|
| 20 | # include <openssl/params.h>
|
|---|
| 21 | # include <openssl/param_build.h>
|
|---|
| 22 | # include "internal/sizes.h"
|
|---|
| 23 |
|
|---|
| 24 | /* Default value for gindex when canonical generation of g is not used */
|
|---|
| 25 | # define FFC_UNVERIFIABLE_GINDEX -1
|
|---|
| 26 |
|
|---|
| 27 | /* The different types of FFC keys */
|
|---|
| 28 | # define FFC_PARAM_TYPE_DSA 0
|
|---|
| 29 | # define FFC_PARAM_TYPE_DH 1
|
|---|
| 30 |
|
|---|
| 31 | /*
|
|---|
| 32 | * The mode used by functions that share code for both generation and
|
|---|
| 33 | * verification. See ossl_ffc_params_FIPS186_4_gen_verify().
|
|---|
| 34 | */
|
|---|
| 35 | #define FFC_PARAM_MODE_VERIFY 0
|
|---|
| 36 | #define FFC_PARAM_MODE_GENERATE 1
|
|---|
| 37 |
|
|---|
| 38 | /* Return codes for generation and validation of FFC parameters */
|
|---|
| 39 | #define FFC_PARAM_RET_STATUS_FAILED 0
|
|---|
| 40 | #define FFC_PARAM_RET_STATUS_SUCCESS 1
|
|---|
| 41 | /* Returned if validating and g is only partially verifiable */
|
|---|
| 42 | #define FFC_PARAM_RET_STATUS_UNVERIFIABLE_G 2
|
|---|
| 43 |
|
|---|
| 44 | /* Validation flags */
|
|---|
| 45 | # define FFC_PARAM_FLAG_VALIDATE_PQ 0x01
|
|---|
| 46 | # define FFC_PARAM_FLAG_VALIDATE_G 0x02
|
|---|
| 47 | # define FFC_PARAM_FLAG_VALIDATE_PQG \
|
|---|
| 48 | (FFC_PARAM_FLAG_VALIDATE_PQ | FFC_PARAM_FLAG_VALIDATE_G)
|
|---|
| 49 | #define FFC_PARAM_FLAG_VALIDATE_LEGACY 0x04
|
|---|
| 50 |
|
|---|
| 51 | /*
|
|---|
| 52 | * NB: These values must align with the equivalently named macros in
|
|---|
| 53 | * openssl/dh.h. We cannot use those macros here in case DH has been disabled.
|
|---|
| 54 | */
|
|---|
| 55 | # define FFC_CHECK_P_NOT_PRIME 0x00001
|
|---|
| 56 | # define FFC_CHECK_P_NOT_SAFE_PRIME 0x00002
|
|---|
| 57 | # define FFC_CHECK_UNKNOWN_GENERATOR 0x00004
|
|---|
| 58 | # define FFC_CHECK_NOT_SUITABLE_GENERATOR 0x00008
|
|---|
| 59 | # define FFC_CHECK_Q_NOT_PRIME 0x00010
|
|---|
| 60 | # define FFC_CHECK_INVALID_Q_VALUE 0x00020
|
|---|
| 61 | # define FFC_CHECK_INVALID_J_VALUE 0x00040
|
|---|
| 62 |
|
|---|
| 63 | /*
|
|---|
| 64 | * 0x80, 0x100 reserved by include/openssl/dh.h with check bits that are not
|
|---|
| 65 | * relevant for FFC.
|
|---|
| 66 | */
|
|---|
| 67 |
|
|---|
| 68 | # define FFC_CHECK_MISSING_SEED_OR_COUNTER 0x00200
|
|---|
| 69 | # define FFC_CHECK_INVALID_G 0x00400
|
|---|
| 70 | # define FFC_CHECK_INVALID_PQ 0x00800
|
|---|
| 71 | # define FFC_CHECK_INVALID_COUNTER 0x01000
|
|---|
| 72 | # define FFC_CHECK_P_MISMATCH 0x02000
|
|---|
| 73 | # define FFC_CHECK_Q_MISMATCH 0x04000
|
|---|
| 74 | # define FFC_CHECK_G_MISMATCH 0x08000
|
|---|
| 75 | # define FFC_CHECK_COUNTER_MISMATCH 0x10000
|
|---|
| 76 | # define FFC_CHECK_BAD_LN_PAIR 0x20000
|
|---|
| 77 | # define FFC_CHECK_INVALID_SEED_SIZE 0x40000
|
|---|
| 78 |
|
|---|
| 79 | /* Validation Return codes */
|
|---|
| 80 | # define FFC_ERROR_PUBKEY_TOO_SMALL 0x01
|
|---|
| 81 | # define FFC_ERROR_PUBKEY_TOO_LARGE 0x02
|
|---|
| 82 | # define FFC_ERROR_PUBKEY_INVALID 0x04
|
|---|
| 83 | # define FFC_ERROR_NOT_SUITABLE_GENERATOR 0x08
|
|---|
| 84 | # define FFC_ERROR_PRIVKEY_TOO_SMALL 0x10
|
|---|
| 85 | # define FFC_ERROR_PRIVKEY_TOO_LARGE 0x20
|
|---|
| 86 | # define FFC_ERROR_PASSED_NULL_PARAM 0x40
|
|---|
| 87 |
|
|---|
| 88 | /*
|
|---|
| 89 | * Finite field cryptography (FFC) domain parameters are used by DH and DSA.
|
|---|
| 90 | * Refer to FIPS186_4 Appendix A & B.
|
|---|
| 91 | */
|
|---|
| 92 | typedef struct ffc_params_st {
|
|---|
| 93 | /* Primes */
|
|---|
| 94 | BIGNUM *p;
|
|---|
| 95 | BIGNUM *q;
|
|---|
| 96 | /* Generator */
|
|---|
| 97 | BIGNUM *g;
|
|---|
| 98 | /* DH X9.42 Optional Subgroup factor j >= 2 where p = j * q + 1 */
|
|---|
| 99 | BIGNUM *j;
|
|---|
| 100 |
|
|---|
| 101 | /* Required for FIPS186_4 validation of p, q and optionally canonical g */
|
|---|
| 102 | unsigned char *seed;
|
|---|
| 103 | /* If this value is zero the hash size is used as the seed length */
|
|---|
| 104 | size_t seedlen;
|
|---|
| 105 | /* Required for FIPS186_4 validation of p and q */
|
|---|
| 106 | int pcounter;
|
|---|
| 107 | int nid; /* The identity of a named group */
|
|---|
| 108 |
|
|---|
| 109 | /*
|
|---|
| 110 | * Required for FIPS186_4 generation & validation of canonical g.
|
|---|
| 111 | * It uses unverifiable g if this value is -1.
|
|---|
| 112 | */
|
|---|
| 113 | int gindex;
|
|---|
| 114 | int h; /* loop counter for unverifiable g */
|
|---|
| 115 |
|
|---|
| 116 | unsigned int flags;
|
|---|
| 117 | /*
|
|---|
| 118 | * The digest to use for generation or validation. If this value is NULL,
|
|---|
| 119 | * then the digest is chosen using the value of N.
|
|---|
| 120 | */
|
|---|
| 121 | const char *mdname;
|
|---|
| 122 | const char *mdprops;
|
|---|
| 123 | /* Default key length for known named groups according to RFC7919 */
|
|---|
| 124 | int keylength;
|
|---|
| 125 | } FFC_PARAMS;
|
|---|
| 126 |
|
|---|
| 127 | void ossl_ffc_params_init(FFC_PARAMS *params);
|
|---|
| 128 | void ossl_ffc_params_cleanup(FFC_PARAMS *params);
|
|---|
| 129 | void ossl_ffc_params_set0_pqg(FFC_PARAMS *params, BIGNUM *p, BIGNUM *q,
|
|---|
| 130 | BIGNUM *g);
|
|---|
| 131 | void ossl_ffc_params_get0_pqg(const FFC_PARAMS *params, const BIGNUM **p,
|
|---|
| 132 | const BIGNUM **q, const BIGNUM **g);
|
|---|
| 133 | void ossl_ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j);
|
|---|
| 134 | int ossl_ffc_params_set_seed(FFC_PARAMS *params,
|
|---|
| 135 | const unsigned char *seed, size_t seedlen);
|
|---|
| 136 | void ossl_ffc_params_set_gindex(FFC_PARAMS *params, int index);
|
|---|
| 137 | void ossl_ffc_params_set_pcounter(FFC_PARAMS *params, int index);
|
|---|
| 138 | void ossl_ffc_params_set_h(FFC_PARAMS *params, int index);
|
|---|
| 139 | void ossl_ffc_params_set_flags(FFC_PARAMS *params, unsigned int flags);
|
|---|
| 140 | void ossl_ffc_params_enable_flags(FFC_PARAMS *params, unsigned int flags,
|
|---|
| 141 | int enable);
|
|---|
| 142 | int ossl_ffc_set_digest(FFC_PARAMS *params, const char *alg, const char *props);
|
|---|
| 143 |
|
|---|
| 144 | int ossl_ffc_params_set_validate_params(FFC_PARAMS *params,
|
|---|
| 145 | const unsigned char *seed,
|
|---|
| 146 | size_t seedlen, int counter);
|
|---|
| 147 | void ossl_ffc_params_get_validate_params(const FFC_PARAMS *params,
|
|---|
| 148 | unsigned char **seed, size_t *seedlen,
|
|---|
| 149 | int *pcounter);
|
|---|
| 150 |
|
|---|
| 151 | int ossl_ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src);
|
|---|
| 152 | int ossl_ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q);
|
|---|
| 153 |
|
|---|
| 154 | #ifndef FIPS_MODULE
|
|---|
| 155 | int ossl_ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent);
|
|---|
| 156 | #endif /* FIPS_MODULE */
|
|---|
| 157 |
|
|---|
| 158 |
|
|---|
| 159 | int ossl_ffc_params_FIPS186_4_generate(OSSL_LIB_CTX *libctx, FFC_PARAMS *params,
|
|---|
| 160 | int type, size_t L, size_t N,
|
|---|
| 161 | int *res, BN_GENCB *cb);
|
|---|
| 162 | int ossl_ffc_params_FIPS186_2_generate(OSSL_LIB_CTX *libctx, FFC_PARAMS *params,
|
|---|
| 163 | int type, size_t L, size_t N,
|
|---|
| 164 | int *res, BN_GENCB *cb);
|
|---|
| 165 |
|
|---|
| 166 | int ossl_ffc_params_FIPS186_4_gen_verify(OSSL_LIB_CTX *libctx,
|
|---|
| 167 | FFC_PARAMS *params, int mode, int type,
|
|---|
| 168 | size_t L, size_t N, int *res,
|
|---|
| 169 | BN_GENCB *cb);
|
|---|
| 170 | int ossl_ffc_params_FIPS186_2_gen_verify(OSSL_LIB_CTX *libctx,
|
|---|
| 171 | FFC_PARAMS *params, int mode, int type,
|
|---|
| 172 | size_t L, size_t N, int *res,
|
|---|
| 173 | BN_GENCB *cb);
|
|---|
| 174 |
|
|---|
| 175 | int ossl_ffc_params_simple_validate(OSSL_LIB_CTX *libctx,
|
|---|
| 176 | const FFC_PARAMS *params,
|
|---|
| 177 | int paramstype, int *res);
|
|---|
| 178 | int ossl_ffc_params_full_validate(OSSL_LIB_CTX *libctx,
|
|---|
| 179 | const FFC_PARAMS *params,
|
|---|
| 180 | int paramstype, int *res);
|
|---|
| 181 | int ossl_ffc_params_FIPS186_4_validate(OSSL_LIB_CTX *libctx,
|
|---|
| 182 | const FFC_PARAMS *params,
|
|---|
| 183 | int type, int *res, BN_GENCB *cb);
|
|---|
| 184 | int ossl_ffc_params_FIPS186_2_validate(OSSL_LIB_CTX *libctx,
|
|---|
| 185 | const FFC_PARAMS *params,
|
|---|
| 186 | int type, int *res, BN_GENCB *cb);
|
|---|
| 187 |
|
|---|
| 188 | int ossl_ffc_generate_private_key(BN_CTX *ctx, const FFC_PARAMS *params,
|
|---|
| 189 | int N, int s, BIGNUM *priv);
|
|---|
| 190 |
|
|---|
| 191 | int ossl_ffc_params_validate_unverifiable_g(BN_CTX *ctx, BN_MONT_CTX *mont,
|
|---|
| 192 | const BIGNUM *p, const BIGNUM *q,
|
|---|
| 193 | const BIGNUM *g, BIGNUM *tmp,
|
|---|
| 194 | int *ret);
|
|---|
| 195 |
|
|---|
| 196 | int ossl_ffc_validate_public_key(const FFC_PARAMS *params,
|
|---|
| 197 | const BIGNUM *pub_key, int *ret);
|
|---|
| 198 | int ossl_ffc_validate_public_key_partial(const FFC_PARAMS *params,
|
|---|
| 199 | const BIGNUM *pub_key, int *ret);
|
|---|
| 200 | int ossl_ffc_validate_private_key(const BIGNUM *upper, const BIGNUM *priv_key,
|
|---|
| 201 | int *ret);
|
|---|
| 202 |
|
|---|
| 203 | int ossl_ffc_params_todata(const FFC_PARAMS *ffc, OSSL_PARAM_BLD *tmpl,
|
|---|
| 204 | OSSL_PARAM params[]);
|
|---|
| 205 | int ossl_ffc_params_fromdata(FFC_PARAMS *ffc, const OSSL_PARAM params[]);
|
|---|
| 206 |
|
|---|
| 207 | typedef struct dh_named_group_st DH_NAMED_GROUP;
|
|---|
| 208 | const DH_NAMED_GROUP *ossl_ffc_name_to_dh_named_group(const char *name);
|
|---|
| 209 | const DH_NAMED_GROUP *ossl_ffc_uid_to_dh_named_group(int uid);
|
|---|
| 210 | #ifndef OPENSSL_NO_DH
|
|---|
| 211 | const DH_NAMED_GROUP *ossl_ffc_numbers_to_dh_named_group(const BIGNUM *p,
|
|---|
| 212 | const BIGNUM *q,
|
|---|
| 213 | const BIGNUM *g);
|
|---|
| 214 | #endif
|
|---|
| 215 | int ossl_ffc_named_group_get_uid(const DH_NAMED_GROUP *group);
|
|---|
| 216 | const char *ossl_ffc_named_group_get_name(const DH_NAMED_GROUP *);
|
|---|
| 217 | #ifndef OPENSSL_NO_DH
|
|---|
| 218 | int ossl_ffc_named_group_get_keylength(const DH_NAMED_GROUP *group);
|
|---|
| 219 | const BIGNUM *ossl_ffc_named_group_get_q(const DH_NAMED_GROUP *group);
|
|---|
| 220 | int ossl_ffc_named_group_set(FFC_PARAMS *ffc, const DH_NAMED_GROUP *group);
|
|---|
| 221 | #endif
|
|---|
| 222 |
|
|---|
| 223 | #endif /* OSSL_INTERNAL_FFC_H */
|
|---|
