EC_KEY_new_by_curve_name(3ssl)

1EC_KEY_NEW(3)                       OpenSSL                      EC_KEY_NEW(3)
2
3
4

NAME

6       EC_KEY_get_method, EC_KEY_set_method, EC_KEY_new, EC_KEY_get_flags,
7       EC_KEY_set_flags, EC_KEY_clear_flags, EC_KEY_new_by_curve_name,
8       EC_KEY_free, EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref,
9       EC_KEY_get0_engine, EC_KEY_get0_group, EC_KEY_set_group,
10       EC_KEY_get0_private_key, EC_KEY_set_private_key,
11       EC_KEY_get0_public_key, EC_KEY_set_public_key, EC_KEY_get_conv_form,
12       EC_KEY_set_conv_form, EC_KEY_set_asn1_flag,
13       EC_KEY_decoded_from_explicit_params, EC_KEY_precompute_mult,
14       EC_KEY_generate_key, EC_KEY_check_key,
15       EC_KEY_set_public_key_affine_coordinates, EC_KEY_oct2key,
16       EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct, EC_KEY_priv2buf -
17       Functions for creating, destroying and manipulating EC_KEY objects
18

SYNOPSIS

20        #include <openssl/ec.h>
21
22        EC_KEY *EC_KEY_new(void);
23        int EC_KEY_get_flags(const EC_KEY *key);
24        void EC_KEY_set_flags(EC_KEY *key, int flags);
25        void EC_KEY_clear_flags(EC_KEY *key, int flags);
26        EC_KEY *EC_KEY_new_by_curve_name(int nid);
27        void EC_KEY_free(EC_KEY *key);
28        EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
29        EC_KEY *EC_KEY_dup(const EC_KEY *src);
30        int EC_KEY_up_ref(EC_KEY *key);
31        ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey);
32        const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
33        int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
34        const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
35        int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
36        const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
37        int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
38        point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
39        void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
40        void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
41        int EC_KEY_decoded_from_explicit_params(const EC_KEY *key);
42        int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
43        int EC_KEY_generate_key(EC_KEY *key);
44        int EC_KEY_check_key(const EC_KEY *key);
45        int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y);
46        const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key);
47        int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth);
48
49        int EC_KEY_oct2key(EC_KEY *eckey, const unsigned char *buf, size_t len, BN_CTX *ctx);
50        size_t EC_KEY_key2buf(const EC_KEY *eckey, point_conversion_form_t form,
51                              unsigned char **pbuf, BN_CTX *ctx);
52
53        int EC_KEY_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len);
54        size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len);
55
56        size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf);
57

DESCRIPTION

59       An EC_KEY represents a public key and, optionally, the associated
60       private key. A new EC_KEY with no associated curve can be constructed
61       by calling EC_KEY_new(). The reference count for the newly created
62       EC_KEY is initially set to 1. A curve can be associated with the EC_KEY
63       by calling EC_KEY_set_group().
64
65       Alternatively a new EC_KEY can be constructed by calling
66       EC_KEY_new_by_curve_name() and supplying the nid of the associated
67       curve. See EC_GROUP_new(3) for a description of curve names. This
68       function simply wraps calls to EC_KEY_new() and
69       EC_GROUP_new_by_curve_name().
70
71       Calling EC_KEY_free() decrements the reference count for the EC_KEY
72       object, and if it has dropped to zero then frees the memory associated
73       with it.  If key is NULL nothing is done.
74
75       EC_KEY_copy() copies the contents of the EC_KEY in src into dest.
76
77       EC_KEY_dup() creates a new EC_KEY object and copies ec_key into it.
78
79       EC_KEY_up_ref() increments the reference count associated with the
80       EC_KEY object.
81
82       EC_KEY_get0_engine() returns a handle to the ENGINE that has been set
83       for this EC_KEY object.
84
85       EC_KEY_generate_key() generates a new public and private key for the
86       supplied eckey object. eckey must have an EC_GROUP object associated
87       with it before calling this function. The private key is a random
88       integer (0 < priv_key < order, where order is the order of the EC_GROUP
89       object). The public key is an EC_POINT on the curve calculated by
90       multiplying the generator for the curve by the private key.
91
92       EC_KEY_check_key() performs various sanity checks on the EC_KEY object
93       to confirm that it is valid.
94
95       EC_KEY_set_public_key_affine_coordinates() sets the public key for key
96       based on its affine co-ordinates; i.e., it constructs an EC_POINT
97       object based on the supplied x and y values and sets the public key to
98       be this EC_POINT. It also performs certain sanity checks on the key to
99       confirm that it is valid.
100
101       The functions EC_KEY_get0_group(), EC_KEY_set_group(),
102       EC_KEY_get0_private_key(), EC_KEY_set_private_key(),
103       EC_KEY_get0_public_key(), and EC_KEY_set_public_key() get and set the
104       EC_GROUP object, the private key, and the EC_POINT public key for the
105       key respectively.
106
107       The functions EC_KEY_get_conv_form() and EC_KEY_set_conv_form() get and
108       set the point_conversion_form for the key. For a description of
109       point_conversion_forms please see EC_POINT_new(3).
110
111       EC_KEY_set_flags() sets the flags in the flags parameter on the EC_KEY
112       object. Any flags that are already set are left set. The flags
113       currently defined are EC_FLAG_NON_FIPS_ALLOW and EC_FLAG_FIPS_CHECKED.
114       In addition there is the flag EC_FLAG_COFACTOR_ECDH which is specific
115       to ECDH.  EC_KEY_get_flags() returns the current flags that are set for
116       this EC_KEY.  EC_KEY_clear_flags() clears the flags indicated by the
117       flags parameter; all other flags are left in their existing state.
118
119       EC_KEY_set_asn1_flag() sets the asn1_flag on the underlying EC_GROUP
120       object (if set). Refer to EC_GROUP_copy(3) for further information on
121       the asn1_flag.
122
123       EC_KEY_decoded_from_explicit_params() returns 1 if the group of the key
124       was decoded from data with explicitly encoded group parameters, -1 if
125       the key is NULL or the group parameters are missing, and 0 otherwise.
126
127       EC_KEY_precompute_mult() stores multiples of the underlying EC_GROUP
128       generator for faster point multiplication. See also EC_POINT_add(3).
129
130       EC_KEY_oct2key() and EC_KEY_key2buf() are identical to the functions
131       EC_POINT_oct2point() and EC_POINT_point2buf() except they use the
132       public key EC_POINT in eckey.
133
134       EC_KEY_oct2priv() and EC_KEY_priv2oct() convert between the private key
135       component of eckey and octet form. The octet form consists of the
136       content octets of the privateKey OCTET STRING in an ECPrivateKey ASN.1
137       structure.
138
139       The function EC_KEY_priv2oct() must be supplied with a buffer long
140       enough to store the octet form. The return value provides the number of
141       octets stored.  Calling the function with a NULL buffer will not
142       perform the conversion but will just return the required buffer length.
143
144       The function EC_KEY_priv2buf() allocates a buffer of suitable length
145       and writes an EC_KEY to it in octet format. The allocated buffer is
146       written to *pbuf and its length is returned. The caller must free up
147       the allocated buffer with a call to OPENSSL_free(). Since the allocated
148       buffer value is written to *pbuf the pbuf parameter MUST NOT be NULL.
149
150       EC_KEY_priv2buf() converts an EC_KEY private key into an allocated
151       buffer.
152

RETURN VALUES

154       EC_KEY_new(), EC_KEY_new_by_curve_name() and EC_KEY_dup() return a
155       pointer to the newly created EC_KEY object, or NULL on error.
156
157       EC_KEY_get_flags() returns the flags associated with the EC_KEY object
158       as an integer.
159
160       EC_KEY_copy() returns a pointer to the destination key, or NULL on
161       error.
162
163       EC_KEY_get0_engine() returns a pointer to an ENGINE, or NULL if it
164       wasn't set.
165
166       EC_KEY_up_ref(), EC_KEY_set_group(), EC_KEY_set_private_key(),
167       EC_KEY_set_public_key(), EC_KEY_precompute_mult(),
168       EC_KEY_generate_key(), EC_KEY_check_key(),
169       EC_KEY_set_public_key_affine_coordinates(), EC_KEY_oct2key() and
170       EC_KEY_oct2priv() return 1 on success or 0 on error.
171
172       EC_KEY_get0_group() returns the EC_GROUP associated with the EC_KEY.
173
174       EC_KEY_get0_private_key() returns the private key associated with the
175       EC_KEY.
176
177       EC_KEY_get_conv_form() return the point_conversion_form for the EC_KEY.
178
179       EC_KEY_key2buf(), EC_KEY_priv2oct() and EC_KEY_priv2buf() return the
180       length of the buffer or 0 on error.
181

COPYRIGHT

187       Copyright 2013-2020 The OpenSSL Project Authors. All Rights Reserved.
188
189       Licensed under the OpenSSL license (the "License").  You may not use
190       this file except in compliance with the License.  You can obtain a copy
191       in the file LICENSE in the source distribution or at
192       <https://www.openssl.org/source/license.html>.
193
194
195
1961.1.1q                            2023-07-20                     EC_KEY_NEW(3)

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

SEE ALSO

COPYRIGHT