Standard preamble:
========================================================================
..
.... Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "EC_KEY_NEW 3ossl"
way too many mistakes in technical documents.
The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):
.Vb 10 EC_KEY *EC_KEY_new_ex(OSSL_LIB_CTX *ctx, const char *propq); EC_KEY *EC_KEY_new(void); int EC_KEY_get_flags(const EC_KEY *key); void EC_KEY_set_flags(EC_KEY *key, int flags); void EC_KEY_clear_flags(EC_KEY *key, int flags); EC_KEY *EC_KEY_new_by_curve_name_ex(OSSL_LIB_CTX *ctx, const char *propq, int nid); EC_KEY *EC_KEY_new_by_curve_name(int nid); void EC_KEY_free(EC_KEY *key); EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src); EC_KEY *EC_KEY_dup(const EC_KEY *src); int EC_KEY_up_ref(EC_KEY *key); ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey); const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key); int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group); const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key); int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key); const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key); int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub); point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key); void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform); void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag); int EC_KEY_decoded_from_explicit_params(const EC_KEY *key); int EC_KEY_generate_key(EC_KEY *key); int EC_KEY_check_key(const EC_KEY *key); int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y); const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key); int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth); \& int EC_KEY_oct2key(EC_KEY *eckey, const unsigned char *buf, size_t len, BN_CTX *ctx); size_t EC_KEY_key2buf(const EC_KEY *eckey, point_conversion_form_t form, unsigned char **pbuf, BN_CTX *ctx); \& int EC_KEY_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len); size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len); \& size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf); int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx); .Ve
All of the functions described below are deprecated. Applications should instead use EVP_EC_gen(), EVP_PKEY_Q_keygen\|(3), or \fBEVP_PKEY_keygen_init\|(3) and EVP_PKEY_keygen\|(3).
An \s-1EC_KEY\s0 represents a public key and, optionally, the associated private key. A new \s-1EC_KEY\s0 with no associated curve can be constructed by calling \fBEC_KEY_new_ex() and specifying the associated library context in ctx (see \s-1OSSL_LIB_CTX\s0\|(3)) and property query string propq. The ctx parameter may be \s-1NULL\s0 in which case the default library context is used. The reference count for the newly created \s-1EC_KEY\s0 is initially set to 1. A curve can be associated with the \s-1EC_KEY\s0 by calling \fBEC_KEY_set_group().
\fBEC_KEY_new() is the same as EC_KEY_new_ex() except that the default library context is always used.
Alternatively a new \s-1EC_KEY\s0 can be constructed by calling \fBEC_KEY_new_by_curve_name_ex() and supplying the nid of the associated curve, the library context to be used ctx (see \s-1OSSL_LIB_CTX\s0\|(3)) and any property query string propq. The ctx parameter may be \s-1NULL\s0 in which case the default library context is used. The propq value may also be \s-1NULL.\s0 See EC_GROUP_new\|(3) for a description of curve names. This function simply wraps calls to EC_KEY_new_ex() and \fBEC_GROUP_new_by_curve_name_ex().
\fBEC_KEY_new_by_curve_name() is the same as EC_KEY_new_by_curve_name_ex() except that the default library context is always used and a \s-1NULL\s0 property query string.
Calling EC_KEY_free() decrements the reference count for the \s-1EC_KEY\s0 object, and if it has dropped to zero then frees the memory associated with it. If \fIkey is \s-1NULL\s0 nothing is done.
\fBEC_KEY_copy() copies the contents of the \s-1EC_KEY\s0 in src into dest.
\fBEC_KEY_dup() creates a new \s-1EC_KEY\s0 object and copies ec_key into it.
\fBEC_KEY_up_ref() increments the reference count associated with the \s-1EC_KEY\s0 object.
\fBEC_KEY_get0_engine() returns a handle to the \s-1ENGINE\s0 that has been set for this \s-1EC_KEY\s0 object.
\fBEC_KEY_generate_key() generates a new public and private key for the supplied \fIeckey object. eckey must have an \s-1EC_GROUP\s0 object associated with it before calling this function. The private key is a random integer (0 < priv_key < order, where order is the order of the \s-1EC_GROUP\s0 object). The public key is an \s-1EC_POINT\s0 on the curve calculated by multiplying the generator for the curve by the private key.
\fBEC_KEY_check_key() performs various sanity checks on the \s-1EC_KEY\s0 object to confirm that it is valid.
\fBEC_KEY_set_public_key_affine_coordinates() sets the public key for key based on its affine coordinates; i.e., it constructs an \s-1EC_POINT\s0 object based on the supplied x and y values and sets the public key to be this \s-1EC_POINT.\s0 It also performs certain sanity checks on the key to confirm that it is valid.
The functions EC_KEY_get0_group(), EC_KEY_set_group(), \fBEC_KEY_get0_private_key(), EC_KEY_set_private_key(), EC_KEY_get0_public_key(), and EC_KEY_set_public_key() get and set the \s-1EC_GROUP\s0 object, the private key, and the \s-1EC_POINT\s0 public key for the key respectively. The function \fBEC_KEY_set_private_key() accepts \s-1NULL\s0 as the priv_key argument to securely clear the private key component from the \s-1EC_KEY.\s0
The functions EC_KEY_get_conv_form() and EC_KEY_set_conv_form() get and set the point_conversion_form for the key. For a description of point_conversion_forms please see EC_POINT_new\|(3).
\fBEC_KEY_set_flags() sets the flags in the flags parameter on the \s-1EC_KEY\s0 object. Any flags that are already set are left set. The flags currently defined are \s-1EC_FLAG_NON_FIPS_ALLOW\s0 and \s-1EC_FLAG_FIPS_CHECKED.\s0 In addition there is the flag \s-1EC_FLAG_COFACTOR_ECDH\s0 which is specific to \s-1ECDH.\s0 \fBEC_KEY_get_flags() returns the current flags that are set for this \s-1EC_KEY.\s0 \fBEC_KEY_clear_flags() clears the flags indicated by the flags parameter; all other flags are left in their existing state.
\fBEC_KEY_set_asn1_flag() sets the asn1_flag on the underlying \s-1EC_GROUP\s0 object (if set). Refer to EC_GROUP_copy\|(3) for further information on the asn1_flag.
\fBEC_KEY_decoded_from_explicit_params() returns 1 if the group of the key was decoded from data with explicitly encoded group parameters, -1 if the key is \s-1NULL\s0 or the group parameters are missing, and 0 otherwise.
\fBEC_KEY_precompute_mult() stores multiples of the underlying \s-1EC_GROUP\s0 generator for faster point multiplication. See also EC_POINT_add\|(3). Modern versions should instead switch to named curves which OpenSSL has hardcoded lookup tables for.
\fBEC_KEY_oct2key() and EC_KEY_key2buf() are identical to the functions \fBEC_POINT_oct2point() and EC_POINT_point2buf() except they use the public key \s-1EC_POINT\s0 in eckey.
\fBEC_KEY_oct2priv() and EC_KEY_priv2oct() convert between the private key component of eckey and octet form. The octet form consists of the content octets of the privateKey \s-1OCTET STRING\s0 in an ECPrivateKey \s-1ASN.1\s0 structure.
The function EC_KEY_priv2oct() must be supplied with a buffer long enough to store the octet form. The return value provides the number of octets stored. Calling the function with a \s-1NULL\s0 buffer will not perform the conversion but will just return the required buffer length.
The function EC_KEY_priv2buf() allocates a buffer of suitable length and writes an \s-1EC_KEY\s0 to it in octet format. The allocated buffer is written to *pbuf and its length is returned. The caller must free up the allocated buffer with a call to OPENSSL_free(). Since the allocated buffer value is written to *pbuf the pbuf parameter \s-1MUST NOT\s0 be \s-1NULL\s0.
\fBEC_KEY_priv2buf() converts an \s-1EC_KEY\s0 private key into an allocated buffer.
\fBEC_KEY_get_flags() returns the flags associated with the \s-1EC_KEY\s0 object as an integer.
\fBEC_KEY_copy() returns a pointer to the destination key, or \s-1NULL\s0 on error.
\fBEC_KEY_get0_engine() returns a pointer to an \s-1ENGINE,\s0 or \s-1NULL\s0 if it wasn't set.
\fBEC_KEY_up_ref(), EC_KEY_set_group(), EC_KEY_set_public_key(), \fBEC_KEY_precompute_mult(), EC_KEY_generate_key(), EC_KEY_check_key(), \fBEC_KEY_set_public_key_affine_coordinates(), EC_KEY_oct2key() and \fBEC_KEY_oct2priv() return 1 on success or 0 on error.
\fBEC_KEY_set_private_key() returns 1 on success or 0 on error except when the priv_key argument is \s-1NULL,\s0 in that case it returns 0, for legacy compatibility, and should not be treated as an error.
\fBEC_KEY_get0_group() returns the \s-1EC_GROUP\s0 associated with the \s-1EC_KEY.\s0
\fBEC_KEY_get0_private_key() returns the private key associated with the \s-1EC_KEY.\s0
\fBEC_KEY_get_conv_form() return the point_conversion_form for the \s-1EC_KEY.\s0
\fBEC_KEY_key2buf(), EC_KEY_priv2oct() and EC_KEY_priv2buf() return the length of the buffer or 0 on error.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.