diff options
| author | tb <> | 2025-04-25 19:57:12 +0000 |
|---|---|---|
| committer | tb <> | 2025-04-25 19:57:12 +0000 |
| commit | 60904c983d054a3655c2d3ac38828e2b8c9cc067 (patch) | |
| tree | 861ff688d2e1eb96feb6980c81276954e5ebafe4 /src/lib/libcrypto/man/EC_KEY_METHOD_new.3 | |
| parent | d569ea3a7dd45ac021b0335a24722227abc9bd8d (diff) | |
| download | openbsd-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_KEY_METHOD_new.3')
| -rw-r--r-- | src/lib/libcrypto/man/EC_KEY_METHOD_new.3 | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/src/lib/libcrypto/man/EC_KEY_METHOD_new.3 b/src/lib/libcrypto/man/EC_KEY_METHOD_new.3 index 79c16ef014..5f5795d5cc 100644 --- a/src/lib/libcrypto/man/EC_KEY_METHOD_new.3 +++ b/src/lib/libcrypto/man/EC_KEY_METHOD_new.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: EC_KEY_METHOD_new.3,v 1.4 2024/07/21 08:36:43 tb Exp $ | 1 | .\" $OpenBSD: EC_KEY_METHOD_new.3,v 1.5 2025/04/25 19:57:12 tb Exp $ |
| 2 | .\" Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org> | 2 | .\" Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org> |
| 3 | .\" | 3 | .\" |
| 4 | .\" Permission to use, copy, modify, and distribute this software for any | 4 | .\" Permission to use, copy, modify, and distribute this software for any |
| @@ -13,7 +13,7 @@ | |||
| 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 15 | .\" | 15 | .\" |
| 16 | .Dd $Mdocdate: July 21 2024 $ | 16 | .Dd $Mdocdate: April 25 2025 $ |
| 17 | .Dt EC_KEY_METHOD_NEW 3 | 17 | .Dt EC_KEY_METHOD_NEW 3 |
| 18 | .Os | 18 | .Os |
| 19 | .Sh NAME | 19 | .Sh NAME |
| @@ -312,7 +312,16 @@ returns 1 for success or 0 for failure. | |||
| 312 | returns the EC_KEY implementation used by the given | 312 | returns the EC_KEY implementation used by the given |
| 313 | .Fa key . | 313 | .Fa key . |
| 314 | .Sh SEE ALSO | 314 | .Sh SEE ALSO |
| 315 | .Xr crypto 3 , | ||
| 316 | .Xr EC_GROUP_check 3 , | ||
| 317 | .Xr EC_GROUP_get_curve_name 3 , | ||
| 318 | .Xr EC_GROUP_new_by_curve_name 3 , | ||
| 319 | .Xr EC_GROUP_new_curve_GFp 3 , | ||
| 315 | .Xr EC_KEY_new 3 , | 320 | .Xr EC_KEY_new 3 , |
| 321 | .Xr EC_POINT_add 3 , | ||
| 322 | .Xr EC_POINT_get_affine_coordinates 3 , | ||
| 323 | .Xr EC_POINT_new 3 , | ||
| 324 | .Xr EC_POINT_point2oct 3 , | ||
| 316 | .Xr ECDSA_sign 3 | 325 | .Xr ECDSA_sign 3 |
| 317 | .Sh HISTORY | 326 | .Sh HISTORY |
| 318 | These functions first appeared in OpenSSL 1.1.0 | 327 | These functions first appeared in OpenSSL 1.1.0 |
