]>
Commit | Line | Data |
---|---|---|
aafbe1cc MC |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
d8652be0 | 5 | EC_KEY_get_method, EC_KEY_set_method, EC_KEY_new_ex, |
80757ad4 | 6 | EC_KEY_new, EC_KEY_get_flags, EC_KEY_set_flags, EC_KEY_clear_flags, |
d8652be0 | 7 | EC_KEY_new_by_curve_name_ex, EC_KEY_new_by_curve_name, EC_KEY_free, |
2da8d4eb | 8 | EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref, EC_KEY_get0_engine, |
80757ad4 DSH |
9 | EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key, |
10 | EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key, | |
8162f6f5 | 11 | EC_KEY_get_conv_form, |
fe2f8aec TM |
12 | EC_KEY_set_conv_form, EC_KEY_set_asn1_flag, |
13 | EC_KEY_decoded_from_explicit_params, EC_KEY_precompute_mult, | |
80757ad4 DSH |
14 | EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates, |
15 | EC_KEY_oct2key, EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct, | |
16 | EC_KEY_priv2buf - Functions for creating, destroying and manipulating | |
bb9ad09e | 17 | EC_KEY objects |
aafbe1cc MC |
18 | |
19 | =head1 SYNOPSIS | |
20 | ||
21 | #include <openssl/ec.h> | |
aafbe1cc | 22 | |
d8652be0 | 23 | EC_KEY *EC_KEY_new_ex(OPENSSL_CTX *ctx, const char *propq); |
aafbe1cc MC |
24 | EC_KEY *EC_KEY_new(void); |
25 | int EC_KEY_get_flags(const EC_KEY *key); | |
26 | void EC_KEY_set_flags(EC_KEY *key, int flags); | |
27 | void EC_KEY_clear_flags(EC_KEY *key, int flags); | |
d8652be0 MC |
28 | EC_KEY *EC_KEY_new_by_curve_name_ex(OPENSSL_CTX *ctx, const char *propq, |
29 | int nid); | |
aafbe1cc MC |
30 | EC_KEY *EC_KEY_new_by_curve_name(int nid); |
31 | void EC_KEY_free(EC_KEY *key); | |
32 | EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src); | |
33 | EC_KEY *EC_KEY_dup(const EC_KEY *src); | |
34 | int EC_KEY_up_ref(EC_KEY *key); | |
d1da335c | 35 | ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey); |
aafbe1cc MC |
36 | const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key); |
37 | int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group); | |
38 | const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key); | |
39 | int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv); | |
40 | const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key); | |
41 | int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub); | |
aafbe1cc MC |
42 | point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key); |
43 | void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform); | |
aafbe1cc | 44 | void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag); |
fe2f8aec | 45 | int EC_KEY_decoded_from_explicit_params(const EC_KEY *key); |
aafbe1cc MC |
46 | int EC_KEY_generate_key(EC_KEY *key); |
47 | int EC_KEY_check_key(const EC_KEY *key); | |
e9b77246 | 48 | int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y); |
3aef36ff RS |
49 | const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key); |
50 | int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth); | |
aafbe1cc | 51 | |
e9b77246 | 52 | int EC_KEY_oct2key(EC_KEY *eckey, const unsigned char *buf, size_t len, BN_CTX *ctx); |
80757ad4 DSH |
53 | size_t EC_KEY_key2buf(const EC_KEY *eckey, point_conversion_form_t form, |
54 | unsigned char **pbuf, BN_CTX *ctx); | |
55 | ||
25d57dc7 | 56 | int EC_KEY_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len); |
80757ad4 DSH |
57 | size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len); |
58 | ||
59 | size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf); | |
60 | ||
6b4eb933 BB |
61 | Deprecated since OpenSSL 3.0: |
62 | ||
63 | int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx); | |
64 | ||
aafbe1cc MC |
65 | =head1 DESCRIPTION |
66 | ||
80757ad4 | 67 | An EC_KEY represents a public key and, optionally, the associated private |
f585cefc MC |
68 | key. |
69 | A new EC_KEY with no associated curve can be constructed by calling | |
2da8d4eb MC |
70 | EC_KEY_new_ex() and specifying the associated library context in I<ctx> |
71 | (see L<OPENSSL_CTX(3)>) and property query string I<propq>. | |
72 | The I<ctx> parameter may be NULL in which case the default library context is | |
f585cefc MC |
73 | used. |
74 | The reference count for the newly created EC_KEY is initially | |
75 | set to 1. | |
76 | A curve can be associated with the EC_KEY by calling | |
3aef36ff | 77 | EC_KEY_set_group(). |
aafbe1cc | 78 | |
f585cefc MC |
79 | EC_KEY_new() is the same as EC_KEY_new_ex() except that the default library |
80 | context is always used. | |
81 | ||
80757ad4 | 82 | Alternatively a new EC_KEY can be constructed by calling |
d8652be0 | 83 | EC_KEY_new_by_curve_name_ex() and supplying the nid of the associated |
2da8d4eb MC |
84 | curve, the library context to be used I<ctx> (see L<OPENSSL_CTX(3)>) and any |
85 | property query string I<propq>. | |
86 | The I<ctx> parameter may be NULL in which case the default library context is | |
87 | used. The I<propq> value may also be NULL. | |
f585cefc MC |
88 | See L<EC_GROUP_new(3)> for a description of curve names. |
89 | This function simply wraps calls to EC_KEY_new_ex() and | |
d8652be0 | 90 | EC_GROUP_new_by_curve_name_ex(). |
f585cefc | 91 | |
d8652be0 | 92 | EC_KEY_new_by_curve_name() is the same as EC_KEY_new_by_curve_name_ex() |
2da8d4eb MC |
93 | except that the default library context is always used and a NULL property query |
94 | string. | |
aafbe1cc | 95 | |
80757ad4 DSH |
96 | Calling EC_KEY_free() decrements the reference count for the EC_KEY object, |
97 | and if it has dropped to zero then frees the memory associated with it. If | |
2da8d4eb | 98 | I<key> is NULL nothing is done. |
aafbe1cc | 99 | |
2da8d4eb | 100 | EC_KEY_copy() copies the contents of the EC_KEY in I<src> into I<dest>. |
aafbe1cc | 101 | |
2da8d4eb | 102 | EC_KEY_dup() creates a new EC_KEY object and copies I<ec_key> into it. |
aafbe1cc | 103 | |
80757ad4 DSH |
104 | EC_KEY_up_ref() increments the reference count associated with the EC_KEY |
105 | object. | |
106 | ||
d1da335c RL |
107 | EC_KEY_get0_engine() returns a handle to the ENGINE that has been set for |
108 | this EC_KEY object. | |
109 | ||
80757ad4 | 110 | EC_KEY_generate_key() generates a new public and private key for the supplied |
2da8d4eb | 111 | I<eckey> object. I<eckey> must have an EC_GROUP object associated with it |
80757ad4 DSH |
112 | before calling this function. The private key is a random integer (0 < priv_key |
113 | < order, where I<order> is the order of the EC_GROUP object). The public key is | |
114 | an EC_POINT on the curve calculated by multiplying the generator for the | |
115 | curve by the private key. | |
116 | ||
117 | EC_KEY_check_key() performs various sanity checks on the EC_KEY object to | |
118 | confirm that it is valid. | |
119 | ||
2da8d4eb | 120 | EC_KEY_set_public_key_affine_coordinates() sets the public key for I<key> based |
80757ad4 | 121 | on its affine co-ordinates; i.e., it constructs an EC_POINT object based on |
2da8d4eb | 122 | the supplied I<x> and I<y> values and sets the public key to be this |
80757ad4 DSH |
123 | EC_POINT. It also performs certain sanity checks on the key to confirm |
124 | that it is valid. | |
125 | ||
126 | The functions EC_KEY_get0_group(), EC_KEY_set_group(), | |
127 | EC_KEY_get0_private_key(), EC_KEY_set_private_key(), EC_KEY_get0_public_key(), | |
128 | and EC_KEY_set_public_key() get and set the EC_GROUP object, the private key, | |
2da8d4eb | 129 | and the EC_POINT public key for the I<key> respectively. |
80757ad4 DSH |
130 | |
131 | The functions EC_KEY_get_conv_form() and EC_KEY_set_conv_form() get and set the | |
2da8d4eb | 132 | point_conversion_form for the I<key>. For a description of |
80757ad4 DSH |
133 | point_conversion_forms please see L<EC_POINT_new(3)>. |
134 | ||
2da8d4eb | 135 | EC_KEY_set_flags() sets the flags in the I<flags> parameter on the EC_KEY |
80757ad4 DSH |
136 | object. Any flags that are already set are left set. The flags currently |
137 | defined are EC_FLAG_NON_FIPS_ALLOW and EC_FLAG_FIPS_CHECKED. In | |
138 | addition there is the flag EC_FLAG_COFACTOR_ECDH which is specific to ECDH. | |
139 | EC_KEY_get_flags() returns the current flags that are set for this EC_KEY. | |
2da8d4eb | 140 | EC_KEY_clear_flags() clears the flags indicated by the I<flags> parameter; all |
80757ad4 DSH |
141 | other flags are left in their existing state. |
142 | ||
143 | EC_KEY_set_asn1_flag() sets the asn1_flag on the underlying EC_GROUP object | |
144 | (if set). Refer to L<EC_GROUP_copy(3)> for further information on the | |
145 | asn1_flag. | |
146 | ||
fe2f8aec TM |
147 | EC_KEY_decoded_from_explicit_params() returns 1 if the group of the I<key> was |
148 | decoded from data with explicitly encoded group parameters, -1 if the I<key> | |
149 | is NULL or the group parameters are missing, and 0 otherwise. | |
150 | ||
6b4eb933 | 151 | Although deprecated in OpenSSL 3.0 and should no longer be used, |
80757ad4 DSH |
152 | EC_KEY_precompute_mult() stores multiples of the underlying EC_GROUP generator |
153 | for faster point multiplication. See also L<EC_POINT_add(3)>. | |
6b4eb933 BB |
154 | Modern versions should instead switch to named curves which OpenSSL has |
155 | hardcoded lookup tables for. | |
80757ad4 DSH |
156 | |
157 | EC_KEY_oct2key() and EC_KEY_key2buf() are identical to the functions | |
a5a87011 | 158 | EC_POINT_oct2point() and EC_POINT_point2buf() except they use the public key |
2da8d4eb | 159 | EC_POINT in I<eckey>. |
80757ad4 DSH |
160 | |
161 | EC_KEY_oct2priv() and EC_KEY_priv2oct() convert between the private key | |
2da8d4eb MC |
162 | component of I<eckey> and octet form. The octet form consists of the content |
163 | octets of the I<privateKey> OCTET STRING in an I<ECPrivateKey> ASN.1 structure. | |
80757ad4 DSH |
164 | |
165 | The function EC_KEY_priv2oct() must be supplied with a buffer long enough to | |
166 | store the octet form. The return value provides the number of octets stored. | |
167 | Calling the function with a NULL buffer will not perform the conversion but | |
168 | will just return the required buffer length. | |
169 | ||
170 | The function EC_KEY_priv2buf() allocates a buffer of suitable length and writes | |
2da8d4eb | 171 | an EC_KEY to it in octet format. The allocated buffer is written to I<*pbuf> |
80757ad4 | 172 | and its length is returned. The caller must free up the allocated buffer with a |
2da8d4eb MC |
173 | call to OPENSSL_free(). Since the allocated buffer value is written to I<*pbuf> |
174 | the I<pbuf> parameter B<MUST NOT> be B<NULL>. | |
80757ad4 DSH |
175 | |
176 | EC_KEY_priv2buf() converts an EC_KEY private key into an allocated buffer. | |
aafbe1cc MC |
177 | |
178 | =head1 RETURN VALUES | |
179 | ||
746f3674 | 180 | EC_KEY_new_ex(), EC_KEY_new(), EC_KEY_new_by_curve_name_ex(), |
2da8d4eb MC |
181 | EC_KEY_new_by_curve_name() and EC_KEY_dup() return a pointer to the newly |
182 | created EC_KEY object, or NULL on error. | |
aafbe1cc | 183 | |
80757ad4 DSH |
184 | EC_KEY_get_flags() returns the flags associated with the EC_KEY object as an |
185 | integer. | |
aafbe1cc | 186 | |
3aef36ff | 187 | EC_KEY_copy() returns a pointer to the destination key, or NULL on error. |
aafbe1cc | 188 | |
d1da335c RL |
189 | EC_KEY_get0_engine() returns a pointer to an ENGINE, or NULL if it wasn't set. |
190 | ||
80757ad4 DSH |
191 | EC_KEY_up_ref(), EC_KEY_set_group(), EC_KEY_set_private_key(), |
192 | EC_KEY_set_public_key(), EC_KEY_precompute_mult(), EC_KEY_generate_key(), | |
193 | EC_KEY_check_key(), EC_KEY_set_public_key_affine_coordinates(), | |
194 | EC_KEY_oct2key() and EC_KEY_oct2priv() return 1 on success or 0 on error. | |
aafbe1cc | 195 | |
3aef36ff | 196 | EC_KEY_get0_group() returns the EC_GROUP associated with the EC_KEY. |
aafbe1cc | 197 | |
3aef36ff | 198 | EC_KEY_get0_private_key() returns the private key associated with the EC_KEY. |
aafbe1cc | 199 | |
3aef36ff | 200 | EC_KEY_get_conv_form() return the point_conversion_form for the EC_KEY. |
aafbe1cc | 201 | |
80757ad4 DSH |
202 | EC_KEY_key2buf(), EC_KEY_priv2oct() and EC_KEY_priv2buf() return the length |
203 | of the buffer or 0 on error. | |
aafbe1cc MC |
204 | |
205 | =head1 SEE ALSO | |
206 | ||
9e183d22 | 207 | L<crypto(7)>, L<EC_GROUP_new(3)>, |
9b86974e RS |
208 | L<EC_GROUP_copy(3)>, L<EC_POINT_new(3)>, |
209 | L<EC_POINT_add(3)>, | |
210 | L<EC_GFp_simple_method(3)>, | |
f585cefc MC |
211 | L<d2i_ECPKParameters(3)>, |
212 | L<OPENSSL_CTX(3)> | |
aafbe1cc | 213 | |
6b4eb933 BB |
214 | =head1 HISTORY |
215 | ||
216 | EC_KEY_precompute_mult() was deprecated in OpenSSL 3.0. | |
217 | ||
e2f92610 RS |
218 | =head1 COPYRIGHT |
219 | ||
00c405b3 | 220 | Copyright 2013-2020 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 221 | |
4746f25a | 222 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
223 | this file except in compliance with the License. You can obtain a copy |
224 | in the file LICENSE in the source distribution or at | |
225 | L<https://www.openssl.org/source/license.html>. | |
226 | ||
227 | =cut |