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