summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/EC_POINT_add.3
diff options
context:
space:
mode:
authortb <>2025-04-25 19:57:12 +0000
committertb <>2025-04-25 19:57:12 +0000
commit60904c983d054a3655c2d3ac38828e2b8c9cc067 (patch)
tree861ff688d2e1eb96feb6980c81276954e5ebafe4 /src/lib/libcrypto/man/EC_POINT_add.3
parentd569ea3a7dd45ac021b0335a24722227abc9bd8d (diff)
downloadopenbsd-60904c983d054a3655c2d3ac38828e2b8c9cc067.tar.gz
openbsd-60904c983d054a3655c2d3ac38828e2b8c9cc067.tar.bz2
openbsd-60904c983d054a3655c2d3ac38828e2b8c9cc067.zip
Rework EC documentation
This replaces the giant, poor quality and outdated EC_GROUP_copy.3, EC_GROUP_new.3, and EC_POINT_new.3 manuals with seven new manuals written from scratch. * EC_GROUP_new_by_curve_name() is the entry point for builtin curves, * EC_GROUP_new_curve_GFp() describes lower level API that should not usually be needed apart from a handful of accessors. * EC_GROUP_check() contains two functions that applications should not need because either you know for certain something is an elliptic curve (so these checks are pointless) or you should not use it. * EC_GROUP_get_curve_name() describes some low level ASN.1 footguns and corresponding getters. * EC_POINT_new() contains the simple EC_POINT allocation and freeing API * EC_POINT_get_affine_coordinates() contains the coordinate accessors * EC_POINT_point2oct() is about encoding elliptic curve points While all this is quite far from perfect, the diff is getting too big and it will be easier to improve this in tree. It is definitely more repetitive than I would like it to be. Reviews, tweaks and general feedback are of course welcome. discussed with jsing
Diffstat (limited to 'src/lib/libcrypto/man/EC_POINT_add.3')
-rw-r--r--src/lib/libcrypto/man/EC_POINT_add.318
1 files changed, 12 insertions, 6 deletions
diff --git a/src/lib/libcrypto/man/EC_POINT_add.3 b/src/lib/libcrypto/man/EC_POINT_add.3
index cc35499c0e..9c75f0dcd3 100644
--- a/src/lib/libcrypto/man/EC_POINT_add.3
+++ b/src/lib/libcrypto/man/EC_POINT_add.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EC_POINT_add.3,v 1.15 2025/03/08 16:48:22 tb Exp $ 1.\" $OpenBSD: EC_POINT_add.3,v 1.16 2025/04/25 19:57:12 tb Exp $
2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
3.\" 3.\"
4.\" This file was written by Matt Caswell <matt@openssl.org>. 4.\" This file was written by Matt Caswell <matt@openssl.org>.
@@ -48,7 +48,7 @@
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\" 50.\"
51.Dd $Mdocdate: March 8 2025 $ 51.Dd $Mdocdate: April 25 2025 $
52.Dt EC_POINT_ADD 3 52.Dt EC_POINT_ADD 3
53.Os 53.Os
54.Sh NAME 54.Sh NAME
@@ -177,7 +177,7 @@ in which case the result is just
177.Dl q * m. 177.Dl q * m.
178.Pp 178.Pp
179See 179See
180.Xr EC_GROUP_copy 3 180.Xr EC_GROUP_new_curve_GFp 3
181for information about the generator. 181for information about the generator.
182.Sh RETURN VALUES 182.Sh RETURN VALUES
183The following functions return 1 on success or 0 on error: 183The following functions return 1 on success or 0 on error:
@@ -197,11 +197,17 @@ returns 1 if the point is on the curve, 0 if not, or -1 on error.
197.Fn EC_POINT_cmp 197.Fn EC_POINT_cmp
198returns 1 if the points are not equal, 0 if they are, or -1 on error. 198returns 1 if the points are not equal, 0 if they are, or -1 on error.
199.Sh SEE ALSO 199.Sh SEE ALSO
200.Xr crypto 3 ,
200.Xr d2i_ECPKParameters 3 , 201.Xr d2i_ECPKParameters 3 ,
201.Xr EC_GROUP_copy 3 , 202.Xr EC_GROUP_check 3 ,
202.Xr EC_GROUP_new 3 , 203.Xr EC_GROUP_get_curve_name 3 ,
204.Xr EC_GROUP_new_by_curve_name 3 ,
205.Xr EC_GROUP_new_curve_GFp 3 ,
206.Xr EC_KEY_METHOD_new 3 ,
203.Xr EC_KEY_new 3 , 207.Xr EC_KEY_new 3 ,
204.Xr EC_POINT_new 3 208.Xr EC_POINT_get_affine_coordinates 3 ,
209.Xr EC_POINT_new 3 ,
210.Xr EC_POINT_point2oct 3
205.Sh HISTORY 211.Sh HISTORY
206.Fn EC_POINT_add , 212.Fn EC_POINT_add ,
207.Fn EC_POINT_dbl , 213.Fn EC_POINT_dbl ,