diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EC_KEY_new.3')
-rw-r--r-- | secure/lib/libcrypto/man/man3/EC_KEY_new.3 | 204 |
1 files changed, 64 insertions, 140 deletions
diff --git a/secure/lib/libcrypto/man/man3/EC_KEY_new.3 b/secure/lib/libcrypto/man/man3/EC_KEY_new.3 index 326f0d38eaad..fd664afd5e43 100644 --- a/secure/lib/libcrypto/man/man3/EC_KEY_new.3 +++ b/secure/lib/libcrypto/man/man3/EC_KEY_new.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. 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\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,75 +52,15 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. 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 -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. 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 -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "EC_KEY_NEW 3ossl" -.TH EC_KEY_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EC_KEY_NEW 3ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME EVP_EC_gen, EC_KEY_get_method, EC_KEY_set_method, EC_KEY_new_ex, EC_KEY_new, EC_KEY_get_flags, EC_KEY_set_flags, EC_KEY_clear_flags, @@ -151,7 +75,7 @@ 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 -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ec.h> @@ -160,7 +84,7 @@ EC_KEY objects .Ve .PP The following functions have been deprecated since OpenSSL 3.0, and can be -hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, +hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 10 @@ -203,137 +127,137 @@ see \fBopenssl_user_macros\fR\|(7): \& size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf); \& int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -\&\fBEVP_EC_gen()\fR generates a new \s-1EC\s0 key pair on the given \fIcurve\fR. +\&\fBEVP_EC_gen()\fR generates a new EC key pair on the given \fIcurve\fR. .PP All of the functions described below are deprecated. Applications should instead use \fBEVP_EC_gen()\fR, \fBEVP_PKEY_Q_keygen\fR\|(3), or \&\fBEVP_PKEY_keygen_init\fR\|(3) and \fBEVP_PKEY_keygen\fR\|(3). .PP -An \s-1EC_KEY\s0 represents a public key and, optionally, the associated private +An EC_KEY 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 +A new EC_KEY with no associated curve can be constructed by calling \&\fBEC_KEY_new_ex()\fR and specifying the associated library context in \fIctx\fR -(see \s-1\fBOSSL_LIB_CTX\s0\fR\|(3)) and property query string \fIpropq\fR. -The \fIctx\fR parameter may be \s-1NULL\s0 in which case the default library context is +(see \fBOSSL_LIB_CTX\fR\|(3)) and property query string \fIpropq\fR. +The \fIctx\fR parameter may be NULL in which case the default library context is used. -The reference count for the newly created \s-1EC_KEY\s0 is initially +The reference count for the newly created EC_KEY is initially set to 1. -A curve can be associated with the \s-1EC_KEY\s0 by calling +A curve can be associated with the EC_KEY by calling \&\fBEC_KEY_set_group()\fR. .PP \&\fBEC_KEY_new()\fR is the same as \fBEC_KEY_new_ex()\fR except that the default library context is always used. .PP -Alternatively a new \s-1EC_KEY\s0 can be constructed by calling +Alternatively a new EC_KEY can be constructed by calling \&\fBEC_KEY_new_by_curve_name_ex()\fR and supplying the nid of the associated -curve, the library context to be used \fIctx\fR (see \s-1\fBOSSL_LIB_CTX\s0\fR\|(3)) and any +curve, the library context to be used \fIctx\fR (see \fBOSSL_LIB_CTX\fR\|(3)) and any property query string \fIpropq\fR. -The \fIctx\fR parameter may be \s-1NULL\s0 in which case the default library context is -used. The \fIpropq\fR value may also be \s-1NULL.\s0 +The \fIctx\fR parameter may be NULL in which case the default library context is +used. The \fIpropq\fR value may also be NULL. See \fBEC_GROUP_new\fR\|(3) for a description of curve names. This function simply wraps calls to \fBEC_KEY_new_ex()\fR and \&\fBEC_GROUP_new_by_curve_name_ex()\fR. .PP \&\fBEC_KEY_new_by_curve_name()\fR is the same as \fBEC_KEY_new_by_curve_name_ex()\fR -except that the default library context is always used and a \s-1NULL\s0 property query +except that the default library context is always used and a NULL property query string. .PP -Calling \fBEC_KEY_free()\fR decrements the reference count for the \s-1EC_KEY\s0 object, +Calling \fBEC_KEY_free()\fR decrements the reference count for the EC_KEY object, and if it has dropped to zero then frees the memory associated with it. If -\&\fIkey\fR is \s-1NULL\s0 nothing is done. +\&\fIkey\fR is NULL nothing is done. .PP -\&\fBEC_KEY_copy()\fR copies the contents of the \s-1EC_KEY\s0 in \fIsrc\fR into \fIdest\fR. +\&\fBEC_KEY_copy()\fR copies the contents of the EC_KEY in \fIsrc\fR into \fIdest\fR. .PP -\&\fBEC_KEY_dup()\fR creates a new \s-1EC_KEY\s0 object and copies \fIec_key\fR into it. +\&\fBEC_KEY_dup()\fR creates a new EC_KEY object and copies \fIec_key\fR into it. .PP -\&\fBEC_KEY_up_ref()\fR increments the reference count associated with the \s-1EC_KEY\s0 +\&\fBEC_KEY_up_ref()\fR increments the reference count associated with the EC_KEY object. .PP -\&\fBEC_KEY_get0_engine()\fR returns a handle to the \s-1ENGINE\s0 that has been set for -this \s-1EC_KEY\s0 object. +\&\fBEC_KEY_get0_engine()\fR returns a handle to the ENGINE that has been set for +this EC_KEY object. .PP \&\fBEC_KEY_generate_key()\fR generates a new public and private key for the supplied -\&\fIeckey\fR object. \fIeckey\fR must have an \s-1EC_GROUP\s0 object associated with it +\&\fIeckey\fR object. \fIeckey\fR must have an EC_GROUP object associated with it before calling this function. The private key is a random integer (0 < priv_key -< order, where \fIorder\fR 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 +< order, where \fIorder\fR is the order of the EC_GROUP object). The public key is +an EC_POINT on the curve calculated by multiplying the generator for the curve by the private key. .PP -\&\fBEC_KEY_check_key()\fR performs various sanity checks on the \s-1EC_KEY\s0 object to +\&\fBEC_KEY_check_key()\fR performs various sanity checks on the EC_KEY object to confirm that it is valid. .PP \&\fBEC_KEY_set_public_key_affine_coordinates()\fR sets the public key for \fIkey\fR based -on its affine coordinates; i.e., it constructs an \s-1EC_POINT\s0 object based on +on its affine coordinates; i.e., it constructs an EC_POINT object based on the supplied \fIx\fR and \fIy\fR values and sets the public key to be this -\&\s-1EC_POINT.\s0 It also performs certain sanity checks on the key to confirm +EC_POINT. It also performs certain sanity checks on the key to confirm that it is valid. .PP The functions \fBEC_KEY_get0_group()\fR, \fBEC_KEY_set_group()\fR, \&\fBEC_KEY_get0_private_key()\fR, \fBEC_KEY_set_private_key()\fR, \fBEC_KEY_get0_public_key()\fR, -and \fBEC_KEY_set_public_key()\fR get and set the \s-1EC_GROUP\s0 object, the private key, -and the \s-1EC_POINT\s0 public key for the \fBkey\fR respectively. The function -\&\fBEC_KEY_set_private_key()\fR accepts \s-1NULL\s0 as the priv_key argument to securely clear -the private key component from the \s-1EC_KEY.\s0 +and \fBEC_KEY_set_public_key()\fR get and set the EC_GROUP object, the private key, +and the EC_POINT public key for the \fBkey\fR respectively. The function +\&\fBEC_KEY_set_private_key()\fR accepts NULL as the priv_key argument to securely clear +the private key component from the EC_KEY. .PP The functions \fBEC_KEY_get_conv_form()\fR and \fBEC_KEY_set_conv_form()\fR get and set the point_conversion_form for the \fIkey\fR. For a description of point_conversion_forms please see \fBEC_POINT_new\fR\|(3). .PP -\&\fBEC_KEY_set_flags()\fR sets the flags in the \fIflags\fR parameter on the \s-1EC_KEY\s0 +\&\fBEC_KEY_set_flags()\fR sets the flags in the \fIflags\fR parameter on the EC_KEY 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()\fR returns the current flags that are set for this \s-1EC_KEY.\s0 +defined are EC_FLAG_NON_FIPS_ALLOW and EC_FLAG_FIPS_CHECKED. In +addition there is the flag EC_FLAG_COFACTOR_ECDH which is specific to ECDH. +\&\fBEC_KEY_get_flags()\fR returns the current flags that are set for this EC_KEY. \&\fBEC_KEY_clear_flags()\fR clears the flags indicated by the \fIflags\fR parameter; all other flags are left in their existing state. .PP -\&\fBEC_KEY_set_asn1_flag()\fR sets the asn1_flag on the underlying \s-1EC_GROUP\s0 object +\&\fBEC_KEY_set_asn1_flag()\fR sets the asn1_flag on the underlying EC_GROUP object (if set). Refer to \fBEC_GROUP_copy\fR\|(3) for further information on the asn1_flag. .PP \&\fBEC_KEY_decoded_from_explicit_params()\fR returns 1 if the group of the \fIkey\fR was decoded from data with explicitly encoded group parameters, \-1 if the \fIkey\fR -is \s-1NULL\s0 or the group parameters are missing, and 0 otherwise. +is NULL or the group parameters are missing, and 0 otherwise. .PP -\&\fBEC_KEY_precompute_mult()\fR stores multiples of the underlying \s-1EC_GROUP\s0 generator +\&\fBEC_KEY_precompute_mult()\fR stores multiples of the underlying EC_GROUP generator for faster point multiplication. See also \fBEC_POINT_add\fR\|(3). Modern versions should instead switch to named curves which OpenSSL has hardcoded lookup tables for. .PP \&\fBEC_KEY_oct2key()\fR and \fBEC_KEY_key2buf()\fR are identical to the functions \&\fBEC_POINT_oct2point()\fR and \fBEC_POINT_point2buf()\fR except they use the public key -\&\s-1EC_POINT\s0 in \fIeckey\fR. +EC_POINT in \fIeckey\fR. .PP \&\fBEC_KEY_oct2priv()\fR and \fBEC_KEY_priv2oct()\fR convert between the private key component of \fIeckey\fR and octet form. The octet form consists of the content -octets of the \fIprivateKey\fR \s-1OCTET STRING\s0 in an \fIECPrivateKey\fR \s-1ASN.1\s0 structure. +octets of the \fIprivateKey\fR OCTET STRING in an \fIECPrivateKey\fR ASN.1 structure. .PP The function \fBEC_KEY_priv2oct()\fR 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 +Calling the function with a NULL buffer will not perform the conversion but will just return the required buffer length. .PP The function \fBEC_KEY_priv2buf()\fR allocates a buffer of suitable length and writes -an \s-1EC_KEY\s0 to it in octet format. The allocated buffer is written to \fI*pbuf\fR +an EC_KEY to it in octet format. The allocated buffer is written to \fI*pbuf\fR and its length is returned. The caller must free up the allocated buffer with a call to \fBOPENSSL_free()\fR. Since the allocated buffer value is written to \fI*pbuf\fR -the \fIpbuf\fR parameter \fB\s-1MUST NOT\s0\fR be \fB\s-1NULL\s0\fR. +the \fIpbuf\fR parameter \fBMUST NOT\fR be \fBNULL\fR. .PP -\&\fBEC_KEY_priv2buf()\fR converts an \s-1EC_KEY\s0 private key into an allocated buffer. +\&\fBEC_KEY_priv2buf()\fR converts an EC_KEY private key into an allocated buffer. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBEC_KEY_new_ex()\fR, \fBEC_KEY_new()\fR, \fBEC_KEY_new_by_curve_name_ex()\fR, \&\fBEC_KEY_new_by_curve_name()\fR and \fBEC_KEY_dup()\fR return a pointer to the newly -created \s-1EC_KEY\s0 object, or \s-1NULL\s0 on error. +created EC_KEY object, or NULL on error. .PP -\&\fBEC_KEY_get_flags()\fR returns the flags associated with the \s-1EC_KEY\s0 object as an +\&\fBEC_KEY_get_flags()\fR returns the flags associated with the EC_KEY object as an integer. .PP -\&\fBEC_KEY_copy()\fR returns a pointer to the destination key, or \s-1NULL\s0 on error. +\&\fBEC_KEY_copy()\fR returns a pointer to the destination key, or NULL on error. .PP -\&\fBEC_KEY_get0_engine()\fR returns a pointer to an \s-1ENGINE,\s0 or \s-1NULL\s0 if it wasn't set. +\&\fBEC_KEY_get0_engine()\fR returns a pointer to an ENGINE, or NULL if it wasn't set. .PP \&\fBEC_KEY_up_ref()\fR, \fBEC_KEY_set_group()\fR, \fBEC_KEY_set_public_key()\fR, \&\fBEC_KEY_precompute_mult()\fR, \fBEC_KEY_generate_key()\fR, \fBEC_KEY_check_key()\fR, @@ -341,14 +265,14 @@ integer. \&\fBEC_KEY_oct2priv()\fR return 1 on success or 0 on error. .PP \&\fBEC_KEY_set_private_key()\fR 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, +priv_key argument is NULL, in that case it returns 0, for legacy compatibility, and should not be treated as an error. .PP -\&\fBEC_KEY_get0_group()\fR returns the \s-1EC_GROUP\s0 associated with the \s-1EC_KEY.\s0 +\&\fBEC_KEY_get0_group()\fR returns the EC_GROUP associated with the EC_KEY. .PP -\&\fBEC_KEY_get0_private_key()\fR returns the private key associated with the \s-1EC_KEY.\s0 +\&\fBEC_KEY_get0_private_key()\fR returns the private key associated with the EC_KEY. .PP -\&\fBEC_KEY_get_conv_form()\fR return the point_conversion_form for the \s-1EC_KEY.\s0 +\&\fBEC_KEY_get_conv_form()\fR return the point_conversion_form for the EC_KEY. .PP \&\fBEC_KEY_key2buf()\fR, \fBEC_KEY_priv2oct()\fR and \fBEC_KEY_priv2buf()\fR return the length of the buffer or 0 on error. @@ -360,17 +284,17 @@ of the buffer or 0 on error. \&\fBEC_POINT_add\fR\|(3), \&\fBEC_GFp_simple_method\fR\|(3), \&\fBd2i_ECPKParameters\fR\|(3), -\&\s-1\fBOSSL_LIB_CTX\s0\fR\|(3) -.SH "HISTORY" +\&\fBOSSL_LIB_CTX\fR\|(3) +.SH HISTORY .IX Header "HISTORY" \&\fBEVP_EC_gen()\fR was added in OpenSSL 3.0. All other functions described here were deprecated in OpenSSL 3.0. -For replacement see \s-1\fBEVP_PKEY\-EC\s0\fR\|(7). -.SH "COPYRIGHT" +For replacement see \fBEVP_PKEY\-EC\fR\|(7). +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2013\-2023 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). 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 +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |