diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EC_POINT_new.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EC_POINT_new.3 | 164 |
1 files changed, 44 insertions, 120 deletions
diff --git a/secure/lib/libcrypto/man/man3/EC_POINT_new.3 b/secure/lib/libcrypto/man/man3/EC_POINT_new.3 index 7fd7ce29e88c..87ee7b44e14c 100644 --- a/secure/lib/libcrypto/man/man3/EC_POINT_new.3 +++ b/secure/lib/libcrypto/man/man3/EC_POINT_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_POINT_NEW 3ossl" -.TH EC_POINT_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EC_POINT_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 EC_POINT_set_Jprojective_coordinates_GFp, EC_POINT_point2buf, EC_POINT_new, @@ -163,7 +87,7 @@ EC_POINT_bn2point, EC_POINT_point2hex, EC_POINT_hex2point \&\- Functions for creating, destroying and manipulating EC_POINT objects -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ec.h> @@ -197,7 +121,7 @@ EC_POINT_hex2point .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 @@ -236,26 +160,26 @@ see \fBopenssl_user_macros\fR\|(7): \& EC_POINT *EC_POINT_bn2point(const EC_GROUP *group, const BIGNUM *bn, \& EC_POINT *p, BN_CTX *ctx); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -An \fB\s-1EC_POINT\s0\fR structure represents a point on a curve. A new point is +An \fBEC_POINT\fR structure represents a point on a curve. A new point is constructed by calling the function \fBEC_POINT_new()\fR and providing the \&\fBgroup\fR object that the point relates to. .PP -\&\fBEC_POINT_free()\fR frees the memory associated with the \fB\s-1EC_POINT\s0\fR. -if \fBpoint\fR is \s-1NULL\s0 nothing is done. +\&\fBEC_POINT_free()\fR frees the memory associated with the \fBEC_POINT\fR. +if \fBpoint\fR is NULL nothing is done. .PP -\&\fBEC_POINT_clear_free()\fR destroys any sensitive data held within the \s-1EC_POINT\s0 and -then frees its memory. If \fBpoint\fR is \s-1NULL\s0 nothing is done. +\&\fBEC_POINT_clear_free()\fR destroys any sensitive data held within the EC_POINT and +then frees its memory. If \fBpoint\fR is NULL nothing is done. .PP \&\fBEC_POINT_copy()\fR copies the point \fBsrc\fR into \fBdst\fR. Both \fBsrc\fR and \fBdst\fR -must use the same \fB\s-1EC_METHOD\s0\fR. +must use the same \fBEC_METHOD\fR. .PP -\&\fBEC_POINT_dup()\fR creates a new \fB\s-1EC_POINT\s0\fR object and copies the content from -\&\fBsrc\fR to the newly created \fB\s-1EC_POINT\s0\fR object. +\&\fBEC_POINT_dup()\fR creates a new \fBEC_POINT\fR object and copies the content from +\&\fBsrc\fR to the newly created \fBEC_POINT\fR object. .PP -\&\fBEC_POINT_method_of()\fR obtains the \fB\s-1EC_METHOD\s0\fR associated with \fBpoint\fR. -This function was deprecated in OpenSSL 3.0, since \s-1EC_METHOD\s0 is no longer a +\&\fBEC_POINT_method_of()\fR obtains the \fBEC_METHOD\fR associated with \fBpoint\fR. +This function was deprecated in OpenSSL 3.0, since EC_METHOD is no longer a public concept. .PP A valid point on a curve is the special point at infinity. A point is set to @@ -265,7 +189,7 @@ The affine coordinates for a point describe a point in terms of its x and y position. The function \fBEC_POINT_set_affine_coordinates()\fR sets the \fBx\fR and \fBy\fR coordinates for the point \fBp\fR defined over the curve given in \fBgroup\fR. The function \fBEC_POINT_get_affine_coordinates()\fR sets \fBx\fR and \fBy\fR, either of which -may be \s-1NULL,\s0 to the corresponding coordinates of \fBp\fR. +may be NULL, to the corresponding coordinates of \fBp\fR. .PP The functions \fBEC_POINT_set_affine_coordinates_GFp()\fR and \&\fBEC_POINT_set_affine_coordinates_GF2m()\fR are synonyms for @@ -305,34 +229,34 @@ The functions \fBEC_POINT_set_compressed_coordinates_GFp()\fR and \&\fBEC_POINT_set_compressed_coordinates()\fR. They are defined for backwards compatibility only and should not be used. .PP -In addition \fB\s-1EC_POINT\s0\fR can be converted to and from various external +In addition \fBEC_POINT\fR can be converted to and from various external representations. The octet form is the binary encoding of the \fBECPoint\fR -structure (as defined in \s-1RFC5480\s0 and used in certificates and \s-1TLS\s0 records): -only the content octets are present, the \fB\s-1OCTET STRING\s0\fR tag and length are -not included. \fB\s-1BIGNUM\s0\fR form is the octet form interpreted as a big endian -integer converted to a \fB\s-1BIGNUM\s0\fR structure. Hexadecimal form is the octet -form converted to a \s-1NULL\s0 terminated character string where each character +structure (as defined in RFC5480 and used in certificates and TLS records): +only the content octets are present, the \fBOCTET STRING\fR tag and length are +not included. \fBBIGNUM\fR form is the octet form interpreted as a big endian +integer converted to a \fBBIGNUM\fR structure. Hexadecimal form is the octet +form converted to a NULL terminated character string where each character is one of the printable values 0\-9 or A\-F (or a\-f). .PP The functions \fBEC_POINT_point2oct()\fR, \fBEC_POINT_oct2point()\fR, \fBEC_POINT_point2bn()\fR, \&\fBEC_POINT_bn2point()\fR, \fBEC_POINT_point2hex()\fR and \fBEC_POINT_hex2point()\fR convert from -and to EC_POINTs for the formats: octet, \s-1BIGNUM\s0 and hexadecimal respectively. +and to EC_POINTs for the formats: octet, BIGNUM and hexadecimal respectively. .PP The function \fBEC_POINT_point2oct()\fR encodes the given curve point \fBp\fR as an octet string into the buffer \fBbuf\fR of size \fBlen\fR, using the specified conversion form \fBform\fR. -The encoding conforms with Sec. 2.3.3 of the \s-1SECG SEC 1\s0 (\*(L"Elliptic Curve -Cryptography\*(R") standard. +The encoding conforms with Sec. 2.3.3 of the SECG SEC 1 ("Elliptic Curve +Cryptography") standard. Similarly the function \fBEC_POINT_oct2point()\fR decodes a curve point into \fBp\fR from the octet string contained in the given buffer \fBbuf\fR of size \fBlen\fR, conforming -to Sec. 2.3.4 of the \s-1SECG SEC 1\s0 (\*(L"Elliptic Curve Cryptography\*(R") standard. +to Sec. 2.3.4 of the SECG SEC 1 ("Elliptic Curve Cryptography") standard. .PP The functions \fBEC_POINT_point2hex()\fR and \fBEC_POINT_point2bn()\fR convert a point \fBp\fR, -respectively, to the hexadecimal or \s-1BIGNUM\s0 representation of the same +respectively, to the hexadecimal or BIGNUM representation of the same encoding of the function \fBEC_POINT_point2oct()\fR. Vice versa, similarly to the function \fBEC_POINT_oct2point()\fR, the functions \&\fBEC_POINT_hex2point()\fR and \fBEC_POINT_point2bn()\fR decode the hexadecimal or -\&\s-1BIGNUM\s0 representation into the \s-1EC_POINT\s0 \fBp\fR. +BIGNUM representation into the EC_POINT \fBp\fR. .PP Notice that, according to the standard, the octet string encoding of the point at infinity for a given curve is fixed to a single octet of value zero and that, @@ -340,21 +264,21 @@ vice versa, a single octet of size zero is decoded as the point at infinity. .PP The function \fBEC_POINT_point2oct()\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 still return the required buffer length. .PP The function \fBEC_POINT_point2buf()\fR allocates a buffer of suitable length and -writes an \s-1EC_POINT\s0 to it in octet format. The allocated buffer is written to +writes an EC_POINT to it in octet format. The allocated buffer is written to \&\fB*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 \fB*pbuf\fR the \fBpbuf\fR parameter \fB\s-1MUST NOT\s0\fR be \fB\s-1NULL\s0\fR. +written to \fB*pbuf\fR the \fBpbuf\fR parameter \fBMUST NOT\fR be \fBNULL\fR. .PP The function \fBEC_POINT_point2hex()\fR will allocate sufficient memory to store the hexadecimal string. It is the caller's responsibility to free this memory with a subsequent call to \fBOPENSSL_free()\fR. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBEC_POINT_new()\fR and \fBEC_POINT_dup()\fR return the newly allocated \s-1EC_POINT\s0 or \s-1NULL\s0 +\&\fBEC_POINT_new()\fR and \fBEC_POINT_dup()\fR return the newly allocated EC_POINT or NULL on error. .PP The following functions return 1 on success or 0 on error: \fBEC_POINT_copy()\fR, @@ -365,27 +289,27 @@ The following functions return 1 on success or 0 on error: \fBEC_POINT_copy()\fR \&\fBEC_POINT_set_affine_coordinates_GF2m()\fR, \fBEC_POINT_get_affine_coordinates_GF2m()\fR, \&\fBEC_POINT_set_compressed_coordinates_GF2m()\fR and \fBEC_POINT_oct2point()\fR. .PP -EC_POINT_method_of returns the \s-1EC_METHOD\s0 associated with the supplied \s-1EC_POINT.\s0 +EC_POINT_method_of returns the EC_METHOD associated with the supplied EC_POINT. .PP \&\fBEC_POINT_point2oct()\fR and \fBEC_POINT_point2buf()\fR return the length of the required buffer or 0 on error. .PP -\&\fBEC_POINT_point2bn()\fR returns the pointer to the \s-1BIGNUM\s0 supplied, or \s-1NULL\s0 on +\&\fBEC_POINT_point2bn()\fR returns the pointer to the BIGNUM supplied, or NULL on error. .PP -\&\fBEC_POINT_bn2point()\fR returns the pointer to the \s-1EC_POINT\s0 supplied, or \s-1NULL\s0 on +\&\fBEC_POINT_bn2point()\fR returns the pointer to the EC_POINT supplied, or NULL on error. .PP -\&\fBEC_POINT_point2hex()\fR returns a pointer to the hex string, or \s-1NULL\s0 on error. +\&\fBEC_POINT_point2hex()\fR returns a pointer to the hex string, or NULL on error. .PP -\&\fBEC_POINT_hex2point()\fR returns the pointer to the \s-1EC_POINT\s0 supplied, or \s-1NULL\s0 on +\&\fBEC_POINT_hex2point()\fR returns the pointer to the EC_POINT supplied, or NULL on error. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBcrypto\fR\|(7), \fBEC_GROUP_new\fR\|(3), \fBEC_GROUP_copy\fR\|(3), \&\fBEC_POINT_add\fR\|(3), \fBEC_KEY_new\fR\|(3), \&\fBEC_GFp_simple_method\fR\|(3), \fBd2i_ECPKParameters\fR\|(3) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" \&\fBEC_POINT_method_of()\fR, \&\fBEC_POINT_set_Jprojective_coordinates_GFp()\fR, @@ -399,11 +323,11 @@ error. \&\fBEC_POINT_set_affine_coordinates\fR, \fBEC_POINT_get_affine_coordinates\fR, and \fBEC_POINT_set_compressed_coordinates\fR were added in OpenSSL 1.1.1. -.SH "COPYRIGHT" +.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>. |