openssl-devel/EC_KEY_new(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, EC_KEY_precompute_mult,
13       EC_KEY_generate_key, EC_KEY_check_key,
14       EC_KEY_set_public_key_affine_coordinates, EC_KEY_oct2key,
15       EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct, EC_KEY_priv2buf -
16       Functions for creating, destroying and manipulating EC_KEY objects
17

SYNOPSIS

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

DESCRIPTION

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

RETURN VALUES

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

COPYRIGHT

181       Copyright 2013-2017 The OpenSSL Project Authors. All Rights Reserved.
182
183       Licensed under the OpenSSL license (the "License").  You may not use
184       this file except in compliance with the License.  You can obtain a copy
185       in the file LICENSE in the source distribution or at
186       <https://www.openssl.org/source/license.html>.
187
188
189
1901.1.1c                            2019-05-28                     EC_KEY_NEW(3)

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

SEE ALSO

COPYRIGHT