1/*
2 * Copyright 2018-2021 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/* Internal EC functions for other submodules: not for application use */
11
12#ifndef OSSL_CRYPTO_EC_H
13# define OSSL_CRYPTO_EC_H
14# pragma once
15
16# include <openssl/opensslconf.h>
17# include <openssl/evp.h>
18
19int ossl_ec_curve_name2nid(const char *name);
20const char *ossl_ec_curve_nid2nist_int(int nid);
21int ossl_ec_curve_nist2nid_int(const char *name);
22int evp_pkey_ctx_set_ec_param_enc_prov(EVP_PKEY_CTX *ctx, int param_enc);
23
24# ifndef OPENSSL_NO_EC
25#  include <openssl/core.h>
26#  include <openssl/ec.h>
27#  include "crypto/types.h"
28
29/*-
30 * Computes the multiplicative inverse of x in the range
31 * [1,EC_GROUP::order), where EC_GROUP::order is the cardinality of the
32 * subgroup generated by the generator G:
33 *
34 *         res := x^(-1) (mod EC_GROUP::order).
35 *
36 * This function expects the following two conditions to hold:
37 *  - the EC_GROUP order is prime, and
38 *  - x is included in the range [1, EC_GROUP::order).
39 *
40 * This function returns 1 on success, 0 on error.
41 *
42 * If the EC_GROUP order is even, this function explicitly returns 0 as
43 * an error.
44 * In case any of the two conditions stated above is not satisfied,
45 * the correctness of its output is not guaranteed, even if the return
46 * value could still be 1 (as primality testing and a conditional modular
47 * reduction round on the input can be omitted by the underlying
48 * implementations for better SCA properties on regular input values).
49 */
50__owur int ossl_ec_group_do_inverse_ord(const EC_GROUP *group, BIGNUM *res,
51                                        const BIGNUM *x, BN_CTX *ctx);
52
53/*-
54 * ECDH Key Derivation Function as defined in ANSI X9.63
55 */
56int ossl_ecdh_kdf_X9_63(unsigned char *out, size_t outlen,
57                        const unsigned char *Z, size_t Zlen,
58                        const unsigned char *sinfo, size_t sinfolen,
59                        const EVP_MD *md, OSSL_LIB_CTX *libctx,
60                        const char *propq);
61
62int ossl_ec_key_public_check(const EC_KEY *eckey, BN_CTX *ctx);
63int ossl_ec_key_public_check_quick(const EC_KEY *eckey, BN_CTX *ctx);
64int ossl_ec_key_private_check(const EC_KEY *eckey);
65int ossl_ec_key_pairwise_check(const EC_KEY *eckey, BN_CTX *ctx);
66OSSL_LIB_CTX *ossl_ec_key_get_libctx(const EC_KEY *eckey);
67const char *ossl_ec_key_get0_propq(const EC_KEY *eckey);
68void ossl_ec_key_set0_libctx(EC_KEY *key, OSSL_LIB_CTX *libctx);
69
70/* Backend support */
71int ossl_ec_group_todata(const EC_GROUP *group, OSSL_PARAM_BLD *tmpl,
72                         OSSL_PARAM params[], OSSL_LIB_CTX *libctx,
73                         const char *propq,
74                         BN_CTX *bnctx, unsigned char **genbuf);
75int ossl_ec_group_fromdata(EC_KEY *ec, const OSSL_PARAM params[]);
76int ossl_ec_group_set_params(EC_GROUP *group, const OSSL_PARAM params[]);
77int ossl_ec_key_fromdata(EC_KEY *ecx, const OSSL_PARAM params[],
78                         int include_private);
79int ossl_ec_key_otherparams_fromdata(EC_KEY *ec, const OSSL_PARAM params[]);
80int ossl_ec_key_is_foreign(const EC_KEY *ec);
81EC_KEY *ossl_ec_key_dup(const EC_KEY *key, int selection);
82int ossl_x509_algor_is_sm2(const X509_ALGOR *palg);
83EC_KEY *ossl_ec_key_param_from_x509_algor(const X509_ALGOR *palg,
84                                          OSSL_LIB_CTX *libctx,
85                                          const char *propq);
86EC_KEY *ossl_ec_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO *p8inf,
87                               OSSL_LIB_CTX *libctx, const char *propq);
88
89int ossl_ec_set_ecdh_cofactor_mode(EC_KEY *ec, int mode);
90int ossl_ec_encoding_name2id(const char *name);
91int ossl_ec_encoding_param2id(const OSSL_PARAM *p, int *id);
92int ossl_ec_pt_format_name2id(const char *name);
93int ossl_ec_pt_format_param2id(const OSSL_PARAM *p, int *id);
94char *ossl_ec_pt_format_id2name(int id);
95
96char *ossl_ec_check_group_type_id2name(int flags);
97int ossl_ec_set_check_group_type_from_name(EC_KEY *ec, const char *name);
98
99# endif /* OPENSSL_NO_EC */
100#endif
101