summaryrefslogtreecommitdiff
path: root/lib/libcrypto
diff options
context:
space:
mode:
authorTheo Buehler <tb@cvs.openbsd.org>2021-05-10 20:00:59 +0000
committerTheo Buehler <tb@cvs.openbsd.org>2021-05-10 20:00:59 +0000
commit48fd35b9ef3a981c932437a65fc08255f7f748a0 (patch)
tree56a6b3d0257dc5d52e69ee2f661cdcc4a392c28c /lib/libcrypto
parent405b3d4402434a7427ba0135b9c95946ca569c46 (diff)
Merge documentation for EC_POINT_{get,set}_coordinates and
for EC_POINT_set_compressed_coordinates from OpenSSL 1.1.1.
Diffstat (limited to 'lib/libcrypto')
-rw-r--r--lib/libcrypto/man/EC_POINT_new.390
1 files changed, 70 insertions, 20 deletions
diff --git a/lib/libcrypto/man/EC_POINT_new.3 b/lib/libcrypto/man/EC_POINT_new.3
index 94ab9054bf6..718d041a133 100644
--- a/lib/libcrypto/man/EC_POINT_new.3
+++ b/lib/libcrypto/man/EC_POINT_new.3
@@ -1,5 +1,5 @@
-.\" $OpenBSD: EC_POINT_new.3,v 1.11 2019/08/19 13:08:26 schwarze Exp $
-.\" full merge up to: OpenSSL ddc1caac Mar 6 14:00:24 2018 -0500
+.\" $OpenBSD: EC_POINT_new.3,v 1.12 2021/05/10 20:00:58 tb Exp $
+.\" full merge up to: OpenSSL 50db8163 Jul 30 16:56:41 2018 +0100
.\"
.\" This file was written by Matt Caswell <matt@openssl.org>.
.\" Copyright (c) 2013, 2016 The OpenSSL Project. All rights reserved.
@@ -48,7 +48,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: August 19 2019 $
+.Dd $Mdocdate: May 10 2021 $
.Dt EC_POINT_NEW 3
.Os
.Sh NAME
@@ -59,12 +59,15 @@
.Nm EC_POINT_dup ,
.Nm EC_POINT_method_of ,
.Nm EC_POINT_set_to_infinity ,
+.Nm EC_POINT_set_affine_coordinates ,
.Nm EC_POINT_set_affine_coordinates_GFp ,
.Nm EC_POINT_set_affine_coordinates_GF2m ,
+.Nm EC_POINT_get_affine_coordinates ,
.Nm EC_POINT_get_affine_coordinates_GFp ,
.Nm EC_POINT_get_affine_coordinates_GF2m ,
.Nm EC_POINT_set_Jprojective_coordinates_GFp ,
.Nm EC_POINT_get_Jprojective_coordinates_GFp ,
+.Nm EC_POINT_set_compressed_coordinates ,
.Nm EC_POINT_set_compressed_coordinates_GFp ,
.Nm EC_POINT_set_compressed_coordinates_GF2m ,
.Nm EC_POINT_point2oct ,
@@ -109,6 +112,14 @@
.Fa "EC_POINT *point"
.Fc
.Ft int
+.Fo EC_POINT_set_affine_coordinates
+.Fa "const EC_GROUP *group"
+.Fa "EC_POINT *p"
+.Fa "const BIGNUM *x"
+.Fa "const BIGNUM *y"
+.Fa "BN_CTX *ctx"
+.Fc
+.Ft int
.Fo EC_POINT_set_affine_coordinates_GFp
.Fa "const EC_GROUP *group"
.Fa "EC_POINT *p"
@@ -125,6 +136,14 @@
.Fa "BN_CTX *ctx"
.Fc
.Ft int
+.Fo EC_POINT_get_affine_coordinates
+.Fa "const EC_GROUP *group"
+.Fa "const EC_POINT *p"
+.Fa "BIGNUM *x"
+.Fa "BIGNUM *y"
+.Fa "BN_CTX *ctx"
+.Fc
+.Ft int
.Fo EC_POINT_get_affine_coordinates_GFp
.Fa "const EC_GROUP *group"
.Fa "const EC_POINT *p"
@@ -159,6 +178,14 @@
.Fa "BN_CTX *ctx"
.Fc
.Ft int
+.Fo EC_POINT_set_compressed_coordinates
+.Fa "const EC_GROUP *group"
+.Fa "EC_POINT *p"
+.Fa "const BIGNUM *x"
+.Fa "int y_bit"
+.Fa "BN_CTX *ctx"
+.Fc
+.Ft int
.Fo EC_POINT_set_compressed_coordinates_GFp
.Fa "const EC_GROUP *group"
.Fa "EC_POINT *p"
@@ -290,11 +317,9 @@ The affine coordinates for a point describe a point in terms of its
and
.Fa y
position.
-The functions
-.Fn EC_POINT_set_affine_coordinates_GFp
-and
-.Fn EC_POINT_set_affine_coordinates_GF2m
-set the
+The function
+.Fn EC_POINT_set_affine_coordinates
+sets the
.Fa x
and
.Fa y
@@ -302,11 +327,9 @@ coordinates for the point
.Fa p
defined over the curve given in
.Fa group .
-The functions
-.Fn EC_POINT_get_affine_coordinates_GFp
-and
-.Fn EC_POINT_get_affine_coordinates_GF2m
-set
+The function
+.Fn EC_POINT_get_affine_coordinates
+sets
.Fa x
and
.Fa y ,
@@ -315,6 +338,19 @@ either of which may be
to the corresponding coordinates of
.Fa p .
.Pp
+The functions
+.Fn EC_POINT_set_affine_coordinates_GFp
+and
+.Fn EC_POINT_set_affine_coordinates_GF2m
+are deprecated synonyms for
+.Fn EC_POINT_set_affine_coordinates
+and the functions
+.Fn EC_POINT_get_affine_coordinates_GFp
+and
+.Fn EC_POINT_get_affine_coordinates_GF2m
+are deprecated synonyms for
+.Fn EC_POINT_get_affine_coordinates .
+.Pp
As well as the affine coordinates, a point can alternatively be
described in terms of its Jacobian projective coordinates (for Fp
curves only).
@@ -352,17 +388,22 @@ for any given value for
such that the point is on the curve, there will only ever be two
possible values for
.Fa y .
-Therefore a point can be set using the
-.Fn EC_POINT_set_compressed_coordinates_GFp
-and
-.Fn EC_POINT_set_compressed_coordinates_GF2m
-functions where
+Therefore, a point can be set using the
+.Fn EC_POINT_set_compressed_coordinates
+function where
.Fa x
is the x coordinate and
.Fa y_bit
is a value 0 or 1 to identify which of the two possible values for y
should be used.
.Pp
+The functions
+.Fn EC_POINT_set_compressed_coordinates_GFp
+and
+.Fn EC_POINT_set_compressed_coordinates_GF2m
+are deprecated synonyms for
+.Fn EC_POINT_set_compressed_coordinates .
+.Pp
In addition
.Vt EC_POINT Ns s
can be converted to and from various external representations.
@@ -433,11 +474,14 @@ The following functions return 1 on success or 0 on error:
.Fn EC_POINT_set_to_infinity ,
.Fn EC_POINT_set_Jprojective_coordinates_GFp ,
.Fn EC_POINT_get_Jprojective_coordinates_GFp ,
+.Fn EC_POINT_set_affine_coordinates ,
.Fn EC_POINT_set_affine_coordinates_GFp ,
-.Fn EC_POINT_get_affine_coordinates_GFp ,
-.Fn EC_POINT_set_compressed_coordinates_GFp ,
.Fn EC_POINT_set_affine_coordinates_GF2m ,
+.Fn EC_POINT_get_affine_coordinates ,
+.Fn EC_POINT_get_affine_coordinates_GFp ,
.Fn EC_POINT_get_affine_coordinates_GF2m ,
+.Fn EC_POINT_set_compressed_coordinates ,
+.Fn EC_POINT_set_compressed_coordinates_GFp ,
.Fn EC_POINT_set_compressed_coordinates_GF2m ,
and
.Fn EC_POINT_oct2point .
@@ -513,3 +557,9 @@ and
.Fn EC_POINT_hex2point
first appeared in OpenSSL 0.9.8 and have been available since
.Ox 4.5 .
+.Fn EC_POINT_set_affine_coordinates ,
+.Fn EC_POINT_get_affine_coordinates ,
+and
+.Fn EC_POINT_set_compressed_coordinates
+first appeared in OpenSSL 1.1.1 and have been available since
+.Ox 7.0 .