secure/lib/libcrypto/man/man3/EC_KEY_new.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "EC_KEY_NEW 3"
 136 .TH EC_KEY_NEW 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 EC_KEY_get_method, EC_KEY_set_method, EC_KEY_new, EC_KEY_get_flags, EC_KEY_set_flags, EC_KEY_clear_flags, EC_KEY_new_by_curve_name, EC_KEY_free, EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref, EC_KEY_get0_engine, EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key, EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key, EC_KEY_get_conv_form, EC_KEY_set_conv_form, EC_KEY_set_asn1_flag, EC_KEY_decoded_from_explicit_params, EC_KEY_precompute_mult, EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates, EC_KEY_oct2key, EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct, EC_KEY_priv2buf \- Functions for creating, destroying and manipulating EC_KEY objects
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ec.h>
 147 \&
 148 \& EC_KEY *EC_KEY_new(void);
 149 \& int EC_KEY_get_flags(const EC_KEY *key);
 150 \& void EC_KEY_set_flags(EC_KEY *key, int flags);
 151 \& void EC_KEY_clear_flags(EC_KEY *key, int flags);
 152 \& EC_KEY *EC_KEY_new_by_curve_name(int nid);
 153 \& void EC_KEY_free(EC_KEY *key);
 154 \& EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
 155 \& EC_KEY *EC_KEY_dup(const EC_KEY *src);
 156 \& int EC_KEY_up_ref(EC_KEY *key);
 157 \& ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey);
 158 \& const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
 159 \& int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
 160 \& const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
 161 \& int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
 162 \& const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
 163 \& int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
 164 \& point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
 165 \& void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
 166 \& void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
 167 \& int EC_KEY_decoded_from_explicit_params(const EC_KEY *key);
 168 \& int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
 169 \& int EC_KEY_generate_key(EC_KEY *key);
 170 \& int EC_KEY_check_key(const EC_KEY *key);
 171 \& int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y);
 172 \& const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key);
 173 \& int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth);
 174 \&
 175 \& int EC_KEY_oct2key(EC_KEY *eckey, const unsigned char *buf, size_t len, BN_CTX *ctx);
 176 \& size_t EC_KEY_key2buf(const EC_KEY *eckey, point_conversion_form_t form,
 177 \&                       unsigned char **pbuf, BN_CTX *ctx);
 178 \&
 179 \& int EC_KEY_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len);
 180 \& size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len);
 181 \&
 182 \& size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf);
 183 .Ve
 184 .SH "DESCRIPTION"
 185 .IX Header "DESCRIPTION"
 186 An \s-1EC_KEY\s0 represents a public key and, optionally, the associated private
 187 key. A new \s-1EC_KEY\s0 with no associated curve can be constructed by calling
 188 \&\fBEC_KEY_new()\fR. The reference count for the newly created \s-1EC_KEY\s0 is initially
 189 set to 1. A curve can be associated with the \s-1EC_KEY\s0 by calling
 190 \&\fBEC_KEY_set_group()\fR.
 191 .PP
 192 Alternatively a new \s-1EC_KEY\s0 can be constructed by calling
 193 \&\fBEC_KEY_new_by_curve_name()\fR and supplying the nid of the associated curve. See
 194 \&\fBEC_GROUP_new\fR\|(3) for a description of curve names. This function simply
 195 wraps calls to \fBEC_KEY_new()\fR and \fBEC_GROUP_new_by_curve_name()\fR.
 196 .PP
 197 Calling \fBEC_KEY_free()\fR decrements the reference count for the \s-1EC_KEY\s0 object,
 198 and if it has dropped to zero then frees the memory associated with it.  If
 199 \&\fBkey\fR is \s-1NULL\s0 nothing is done.
 200 .PP
 201 \&\fBEC_KEY_copy()\fR copies the contents of the \s-1EC_KEY\s0 in \fBsrc\fR into \fBdest\fR.
 202 .PP
 203 \&\fBEC_KEY_dup()\fR creates a new \s-1EC_KEY\s0 object and copies \fBec_key\fR into it.
 204 .PP
 205 \&\fBEC_KEY_up_ref()\fR increments the reference count associated with the \s-1EC_KEY\s0
 206 object.
 207 .PP
 208 \&\fBEC_KEY_get0_engine()\fR returns a handle to the \s-1ENGINE\s0 that has been set for
 209 this \s-1EC_KEY\s0 object.
 210 .PP
 211 \&\fBEC_KEY_generate_key()\fR generates a new public and private key for the supplied
 212 \&\fBeckey\fR object. \fBeckey\fR must have an \s-1EC_GROUP\s0 object associated with it
 213 before calling this function. The private key is a random integer (0 < priv_key
 214 < order, where \fIorder\fR is the order of the \s-1EC_GROUP\s0 object). The public key is
 215 an \s-1EC_POINT\s0 on the curve calculated by multiplying the generator for the
 216 curve by the private key.
 217 .PP
 218 \&\fBEC_KEY_check_key()\fR performs various sanity checks on the \s-1EC_KEY\s0 object to
 219 confirm that it is valid.
 220 .PP
 221 \&\fBEC_KEY_set_public_key_affine_coordinates()\fR sets the public key for \fBkey\fR based
 222 on its affine co-ordinates; i.e., it constructs an \s-1EC_POINT\s0 object based on
 223 the supplied \fBx\fR and \fBy\fR values and sets the public key to be this
 224 \&\s-1EC_POINT.\s0 It also performs certain sanity checks on the key to confirm
 225 that it is valid.
 226 .PP
 227 The functions \fBEC_KEY_get0_group()\fR, \fBEC_KEY_set_group()\fR,
 228 \&\fBEC_KEY_get0_private_key()\fR, \fBEC_KEY_set_private_key()\fR, \fBEC_KEY_get0_public_key()\fR,
 229 and \fBEC_KEY_set_public_key()\fR get and set the \s-1EC_GROUP\s0 object, the private key,
 230 and the \s-1EC_POINT\s0 public key for the \fBkey\fR respectively.
 231 .PP
 232 The functions \fBEC_KEY_get_conv_form()\fR and \fBEC_KEY_set_conv_form()\fR get and set the
 233 point_conversion_form for the \fBkey\fR. For a description of
 234 point_conversion_forms please see \fBEC_POINT_new\fR\|(3).
 235 .PP
 236 \&\fBEC_KEY_set_flags()\fR sets the flags in the \fBflags\fR parameter on the \s-1EC_KEY\s0
 237 object. Any flags that are already set are left set. The flags currently
 238 defined are \s-1EC_FLAG_NON_FIPS_ALLOW\s0 and \s-1EC_FLAG_FIPS_CHECKED.\s0 In
 239 addition there is the flag \s-1EC_FLAG_COFACTOR_ECDH\s0 which is specific to \s-1ECDH.\s0
 240 \&\fBEC_KEY_get_flags()\fR returns the current flags that are set for this \s-1EC_KEY.\s0
 241 \&\fBEC_KEY_clear_flags()\fR clears the flags indicated by the \fBflags\fR parameter; all
 242 other flags are left in their existing state.
 243 .PP
 244 \&\fBEC_KEY_set_asn1_flag()\fR sets the asn1_flag on the underlying \s-1EC_GROUP\s0 object
 245 (if set). Refer to \fBEC_GROUP_copy\fR\|(3) for further information on the
 246 asn1_flag.
 247 .PP
 248 \&\fBEC_KEY_decoded_from_explicit_params()\fR returns 1 if the group of the \fIkey\fR was
 249 decoded from data with explicitly encoded group parameters, \-1 if the \fIkey\fR
 250 is \s-1NULL\s0 or the group parameters are missing, and 0 otherwise.
 251 .PP
 252 \&\fBEC_KEY_precompute_mult()\fR stores multiples of the underlying \s-1EC_GROUP\s0 generator
 253 for faster point multiplication. See also \fBEC_POINT_add\fR\|(3).
 254 .PP
 255 \&\fBEC_KEY_oct2key()\fR and \fBEC_KEY_key2buf()\fR are identical to the functions
 256 \&\fBEC_POINT_oct2point()\fR and \fBEC_POINT_point2buf()\fR except they use the public key
 257 \&\s-1EC_POINT\s0 in \fBeckey\fR.
 258 .PP
 259 \&\fBEC_KEY_oct2priv()\fR and \fBEC_KEY_priv2oct()\fR convert between the private key
 260 component of \fBeckey\fR and octet form. The octet form consists of the content
 261 octets of the \fBprivateKey\fR \s-1OCTET STRING\s0 in an \fBECPrivateKey\fR \s-1ASN.1\s0 structure.
 262 .PP
 263 The function \fBEC_KEY_priv2oct()\fR must be supplied with a buffer long enough to
 264 store the octet form. The return value provides the number of octets stored.
 265 Calling the function with a \s-1NULL\s0 buffer will not perform the conversion but
 266 will just return the required buffer length.
 267 .PP
 268 The function \fBEC_KEY_priv2buf()\fR allocates a buffer of suitable length and writes
 269 an \s-1EC_KEY\s0 to it in octet format. The allocated buffer is written to \fB*pbuf\fR
 270 and its length is returned. The caller must free up the allocated buffer with a
 271 call to \fBOPENSSL_free()\fR. Since the allocated buffer value is written to \fB*pbuf\fR
 272 the \fBpbuf\fR parameter \fB\s-1MUST NOT\s0\fR be \fB\s-1NULL\s0\fR.
 273 .PP
 274 \&\fBEC_KEY_priv2buf()\fR converts an \s-1EC_KEY\s0 private key into an allocated buffer.
 275 .SH "RETURN VALUES"
 276 .IX Header "RETURN VALUES"
 277 \&\fBEC_KEY_new()\fR, \fBEC_KEY_new_by_curve_name()\fR and \fBEC_KEY_dup()\fR return a pointer to
 278 the newly created \s-1EC_KEY\s0 object, or \s-1NULL\s0 on error.
 279 .PP
 280 \&\fBEC_KEY_get_flags()\fR returns the flags associated with the \s-1EC_KEY\s0 object as an
 281 integer.
 282 .PP
 283 \&\fBEC_KEY_copy()\fR returns a pointer to the destination key, or \s-1NULL\s0 on error.
 284 .PP
 285 \&\fBEC_KEY_get0_engine()\fR returns a pointer to an \s-1ENGINE,\s0 or \s-1NULL\s0 if it wasn't set.
 286 .PP
 287 \&\fBEC_KEY_up_ref()\fR, \fBEC_KEY_set_group()\fR, \fBEC_KEY_set_private_key()\fR,
 288 \&\fBEC_KEY_set_public_key()\fR, \fBEC_KEY_precompute_mult()\fR, \fBEC_KEY_generate_key()\fR,
 289 \&\fBEC_KEY_check_key()\fR, \fBEC_KEY_set_public_key_affine_coordinates()\fR,
 290 \&\fBEC_KEY_oct2key()\fR and \fBEC_KEY_oct2priv()\fR return 1 on success or 0 on error.
 291 .PP
 292 \&\fBEC_KEY_get0_group()\fR returns the \s-1EC_GROUP\s0 associated with the \s-1EC_KEY.\s0
 293 .PP
 294 \&\fBEC_KEY_get0_private_key()\fR returns the private key associated with the \s-1EC_KEY.\s0
 295 .PP
 296 \&\fBEC_KEY_get_conv_form()\fR return the point_conversion_form for the \s-1EC_KEY.\s0
 297 .PP
 298 \&\fBEC_KEY_key2buf()\fR, \fBEC_KEY_priv2oct()\fR and \fBEC_KEY_priv2buf()\fR return the length
 299 of the buffer or 0 on error.
 300 .SH "SEE ALSO"
 301 .IX Header "SEE ALSO"
 302 \&\fBcrypto\fR\|(7), \fBEC_GROUP_new\fR\|(3),
 303 \&\fBEC_GROUP_copy\fR\|(3), \fBEC_POINT_new\fR\|(3),
 304 \&\fBEC_POINT_add\fR\|(3),
 305 \&\fBEC_GFp_simple_method\fR\|(3),
 306 \&\fBd2i_ECPKParameters\fR\|(3)
 307 .SH "COPYRIGHT"
 308 .IX Header "COPYRIGHT"
 309 Copyright 2013\-2020 The OpenSSL Project Authors. All Rights Reserved.
 310 .PP
 311 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 312 this file except in compliance with the License.  You can obtain a copy
 313 in the file \s-1LICENSE\s0 in the source distribution or at
 314 <https://www.openssl.org/source/license.html>.