00b1b25aff296adcb27845c51b792ea76d56cb56
[openssl.git] / include / crypto / ec.h
1 /*
2  * Copyright 2018 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 # include <openssl/opensslconf.h>
15
16 # ifndef OPENSSL_NO_EC
17 #  include <openssl/ec.h>
18
19 /*-
20  * Computes the multiplicative inverse of x in the range
21  * [1,EC_GROUP::order), where EC_GROUP::order is the cardinality of the
22  * subgroup generated by the generator G:
23  *
24  *         res := x^(-1) (mod EC_GROUP::order).
25  *
26  * This function expects the following two conditions to hold:
27  *  - the EC_GROUP order is prime, and
28  *  - x is included in the range [1, EC_GROUP::order).
29  *
30  * This function returns 1 on success, 0 on error.
31  *
32  * If the EC_GROUP order is even, this function explicitly returns 0 as
33  * an error.
34  * In case any of the two conditions stated above is not satisfied,
35  * the correctness of its output is not guaranteed, even if the return
36  * value could still be 1 (as primality testing and a conditional modular
37  * reduction round on the input can be omitted by the underlying
38  * implementations for better SCA properties on regular input values).
39  */
40 __owur int ec_group_do_inverse_ord(const EC_GROUP *group, BIGNUM *res,
41                                    const BIGNUM *x, BN_CTX *ctx);
42
43 /*-
44  * ECDH Key Derivation Function as defined in ANSI X9.63
45  */
46 int ecdh_KDF_X9_63(unsigned char *out, size_t outlen,
47                    const unsigned char *Z, size_t Zlen,
48                    const unsigned char *sinfo, size_t sinfolen,
49                    const EVP_MD *md);
50
51 int ec_generate_key(OPENSSL_CTX *libctx, EC_KEY *eckey, int pairwise_test);
52 int ec_key_public_check(const EC_KEY *eckey, BN_CTX *ctx);
53 int ec_key_private_check(const EC_KEY *eckey);
54 int ec_key_pairwise_check(const EC_KEY *eckey, BN_CTX *ctx);
55 OPENSSL_CTX *ec_key_get_libctx(const EC_KEY *eckey);
56 const char *ec_curve_nid2name(int nid);
57 int ec_curve_name2nid(const char *name);
58 const unsigned char *ecdsa_algorithmidentifier_encoding(int md_nid, size_t *len);
59 # endif /* OPENSSL_NO_EC */
60 #endif