aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2018-07-30 16:56:41 +0100
committerMatt Caswell <matt@openssl.org>2018-07-31 09:08:50 +0100
commit50db81633ece00593b245afed0ed9480d7ffb334 (patch)
tree9df6418adae90f1e60557cba2be3abce81b441b3 /doc
parent9cc570d4c419e2ca97e2173dc14c484195502dd4 (diff)
downloadopenssl-50db81633ece00593b245afed0ed9480d7ffb334.zip
openssl-50db81633ece00593b245afed0ed9480d7ffb334.tar.gz
openssl-50db81633ece00593b245afed0ed9480d7ffb334.tar.bz2
Deprecate the EC curve type specific functions in 1.2.0
Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/6815)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/EC_GROUP_new.pod6
-rw-r--r--doc/man3/EC_POINT_new.pod9
2 files changed, 10 insertions, 5 deletions
diff --git a/doc/man3/EC_GROUP_new.pod b/doc/man3/EC_GROUP_new.pod
index 02caba8..2a722ce 100644
--- a/doc/man3/EC_GROUP_new.pod
+++ b/doc/man3/EC_GROUP_new.pod
@@ -84,9 +84,11 @@ the polynomial is a trinomial or a pentanomial.
EC_group_get_curve() obtains the previously set curve parameters.
-EC_GROUP_set_curve_GFp() and EC_GROUP_set_curve_GF2m are synonyms for EC_GROUP_set_curve().
+EC_GROUP_set_curve_GFp() and EC_GROUP_set_curve_GF2m() are synonyms for EC_GROUP_set_curve(). They are defined for
+backwards compatibility only and should not be used.
-EC_GROUP_get_curve_GFp() and EC_GROUP_get_curve_GF2m are synonyms for EC_GROUP_get_curve().
+EC_GROUP_get_curve_GFp() and EC_GROUP_get_curve_GF2m() are synonyms for EC_GROUP_get_curve(). They are defined for
+backwards compatibility only and should not be used.
The functions EC_GROUP_new_curve_GFp and EC_GROUP_new_curve_GF2m are shortcuts for calling EC_GROUP_new and then the
EC_GROUP_set_curve function. An appropriate default implementation method will be used.
diff --git a/doc/man3/EC_POINT_new.pod b/doc/man3/EC_POINT_new.pod
index b4faf4d..796f666 100644
--- a/doc/man3/EC_POINT_new.pod
+++ b/doc/man3/EC_POINT_new.pod
@@ -126,11 +126,13 @@ may be NULL, to the corresponding coordinates of B<p>.
The functions EC_POINT_set_affine_coordinates_GFp() and
EC_POINT_set_affine_coordinates_GF2m() are synonyms for
-EC_POINT_set_affine_coordinates().
+EC_POINT_set_affine_coordinates(). They are defined for backwards compatibility
+only and should not be used.
The functions EC_POINT_get_affine_coordinates_GFp() and
EC_POINT_get_affine_coordinates_GF2m() are synonyms for
-EC_POINT_get_affine_coordinates().
+EC_POINT_get_affine_coordinates(). They are defined for backwards compatibility
+only and should not be used.
As well as the affine co-ordinates, a point can alternatively be described in
terms of its Jacobian projective co-ordinates (for Fp curves only). Jacobian
@@ -153,7 +155,8 @@ possible values for y should be used.
The functions EC_POINT_set_compressed_coordinates_GFp() and
EC_POINT_set_compressed_coordinates_GF2m() are synonyms for
-EC_POINT_set_compressed_coordinates().
+EC_POINT_set_compressed_coordinates(). They are defined for backwards
+compatibility only and should not be used.
In addition B<EC_POINT> can be converted to and from various external
representations. The octet form is the binary encoding of the B<ECPoint>