diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2024-11-08 22:23:36 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2024-11-08 22:23:36 +0000 |
commit | 80ee43b12974ebdd793e7d3cc28a484082be67ba (patch) | |
tree | c52c5955c41fe3d841133ac2104488df4e5d65df | |
parent | 5fb7b25b6b31b4b3a48894fcb189c64c7a5e9195 (diff) |
Weed out the last remaining refences to the obsolete
function EVP_MD_CTX_init(3) and talk about EVP_MD_CTX_new(3) instead.
This is similar in spirit to OpenSSL commit 25191fff (Dec 1, 2015),
but i'm also mentioning EVP_MD_CTX_reset(3), slightly reordering some
sentences in a more systematic way, and improving some related wordings
to be more precise and read better.
-rw-r--r-- | lib/libcrypto/man/EVP_DigestSignInit.3 | 41 | ||||
-rw-r--r-- | lib/libcrypto/man/EVP_DigestVerifyInit.3 | 55 | ||||
-rw-r--r-- | lib/libcrypto/man/EVP_SignInit.3 | 24 | ||||
-rw-r--r-- | lib/libcrypto/man/EVP_VerifyInit.3 | 24 |
4 files changed, 77 insertions, 67 deletions
diff --git a/lib/libcrypto/man/EVP_DigestSignInit.3 b/lib/libcrypto/man/EVP_DigestSignInit.3 index 92b656a106a..22a06762784 100644 --- a/lib/libcrypto/man/EVP_DigestSignInit.3 +++ b/lib/libcrypto/man/EVP_DigestSignInit.3 @@ -1,8 +1,9 @@ -.\" $OpenBSD: EVP_DigestSignInit.3,v 1.13 2024/07/21 08:36:43 tb Exp $ -.\" OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400 +.\" $OpenBSD: EVP_DigestSignInit.3,v 1.14 2024/11/08 22:23:35 schwarze Exp $ +.\" full merge up to: OpenSSL 28428130 Apr 17 15:18:40 2018 +0200 +.\" selective merge up to: OpenSSL 6328d367 Jul 4 21:58:30 2020 +0200 .\" .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. -.\" Copyright (c) 2006, 2009, 2015, 2016 The OpenSSL Project. +.\" Copyright (c) 2006, 2009, 2015, 2016, 2017 The OpenSSL Project. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -49,7 +50,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: July 21 2024 $ +.Dd $Mdocdate: November 8 2024 $ .Dt EVP_DIGESTSIGNINIT 3 .Os .Sh NAME @@ -97,33 +98,35 @@ sets up the signing context .Fa ctx to use the digest .Fa type -and private key +and the private key .Fa pkey . +Before calling this function, obtain +.Fa ctx +from +.Xr EVP_MD_CTX_new 3 +or call +.Xr EVP_MD_CTX_reset 3 +on it. The -.Fa ENGINE *engine +.Fa engine argument is always ignored and passing .Dv NULL is recommended. -.Fa ctx -must be initialized with -.Xr EVP_MD_CTX_init 3 -before calling this function. +.Pp If .Fa pctx is not .Dv NULL , -the +any pointer passed in as +.Pf * Fa pctx +is ignored and overwritten by an internal pointer to the .Vt EVP_PKEY_CTX -of the signing operation will be written to -.Pf * Fa pctx : +used by the signing operation: this can be used to set alternative signing options. -Any existing value in -.Pf * Fa pctx -will be overwritten. -The +The returned .Vt EVP_PKEY_CTX -value returned must not be freed directly by the application. -It will be freed automatically when the +must not be freed by the application. +It is freed automatically when the .Vt EVP_MD_CTX is freed. .Pp diff --git a/lib/libcrypto/man/EVP_DigestVerifyInit.3 b/lib/libcrypto/man/EVP_DigestVerifyInit.3 index b3286bf201e..7ecd7e94e3c 100644 --- a/lib/libcrypto/man/EVP_DigestVerifyInit.3 +++ b/lib/libcrypto/man/EVP_DigestVerifyInit.3 @@ -1,8 +1,9 @@ -.\" $OpenBSD: EVP_DigestVerifyInit.3,v 1.15 2024/07/21 08:36:43 tb Exp $ -.\" OpenSSL fb552ac6 Sep 30 23:43:01 2009 +0000 +.\" $OpenBSD: EVP_DigestVerifyInit.3,v 1.16 2024/11/08 22:23:35 schwarze Exp $ +.\" full merge up to OpenSSL f097e875 Aug 23 11:37:22 2018 +0100 +.\" selective merge up to 24a535ea Sep 22 13:14:20 2020 +0100 .\" .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. -.\" Copyright (c) 2006, 2009, 2014, 2015, 2016 The OpenSSL Project. +.\" Copyright (c) 2006, 2009, 2014, 2015, 2016, 2017 The OpenSSL Project. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -49,7 +50,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: July 21 2024 $ +.Dd $Mdocdate: November 8 2024 $ .Dt EVP_DIGESTVERIFYINIT 3 .Os .Sh NAME @@ -93,39 +94,41 @@ The EVP signature routines are a high-level interface to digital signatures. .Pp .Fn EVP_DigestVerifyInit -sets up verification context +sets up the verification context .Fa ctx -to use digest +to use the digest .Fa type -and public key +and the public key .Fa pkey . +Before calling this function, obtain .Fa ctx -must be initialized with -.Xr EVP_MD_CTX_init 3 -before calling this function. +from +.Xr EVP_MD_CTX_new 3 +or call +.Xr EVP_MD_CTX_reset 3 +on it. +The +.Fa engine +argument is always ignored and passing +.Dv NULL +is recommended. +.Pp If .Fa pctx is not .Dv NULL , -the +any pointer passed in as +.Pf * Fa pctx +is ignored and overwritten by an internal pointer to the .Vt EVP_PKEY_CTX -of the verification operation will be written to -.Pf * Fa pctx : -this can be used to set alternative verification options. -Any existing value in -.Pf * .Fa pctx -is overwritten. -The +used by the verification operation: +this can be used to set alternative signing options. +The returned .Vt EVP_PKEY_CTX -value returned must not be freed directly by the application. -It will be freed automatically when the +must not be freed by the application. +It is freed automatically when the .Vt EVP_MD_CTX is freed. -The -.Fa ENGINE *engine -argument is always ignored and passing -.Dv NULL -is recommended. .Pp .Fn EVP_DigestVerifyUpdate hashes @@ -168,7 +171,7 @@ and .\" it is the only way to verify data. .Pp The EVP interface to digital signatures should almost always be -used in preference to the low level interfaces. +used in preference to the low-level interfaces. This is because the code then becomes transparent to the algorithm used and much more flexible. .Pp diff --git a/lib/libcrypto/man/EVP_SignInit.3 b/lib/libcrypto/man/EVP_SignInit.3 index 6064bc79400..9a6c743876c 100644 --- a/lib/libcrypto/man/EVP_SignInit.3 +++ b/lib/libcrypto/man/EVP_SignInit.3 @@ -1,6 +1,5 @@ -.\" $OpenBSD: EVP_SignInit.3,v 1.19 2024/07/21 09:24:07 tb Exp $ -.\" full merge up to: OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 -.\" selective merge up to: OpenSSL 79b49fb0 Mar 20 10:03:10 2018 +1000 +.\" $OpenBSD: EVP_SignInit.3,v 1.20 2024/11/08 22:23:35 schwarze Exp $ +.\" full merge up to: OpenSSL 6328d367 Jul 4 21:58:30 2020 +0200 .\" .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. .\" Copyright (c) 2000-2002, 2005, 2006, 2014-2016 The OpenSSL Project. @@ -50,7 +49,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: July 21 2024 $ +.Dd $Mdocdate: November 8 2024 $ .Dt EVP_SIGNINIT 3 .Os .Sh NAME @@ -86,20 +85,23 @@ .Fa "const EVP_MD *type" .Fc .Sh DESCRIPTION -The EVP signature routines are a high level interface to digital +The EVP signature routines are a high-level interface to digital signatures. .Pp .Fn EVP_SignInit_ex -sets up a signing context +sets up the signing context .Fa ctx to use the digest .Fa type . +Before calling this function, obtain .Fa ctx -must be initialized with -.Xr EVP_MD_CTX_init 3 -before calling this function. +from +.Xr EVP_MD_CTX_new 3 +or call +.Xr EVP_MD_CTX_reset 3 +on it. The -.Fa ENGINE *engine +.Fa engine argument is always ignored and passing .Dv NULL is recommended. @@ -142,7 +144,7 @@ to use the default implementation of digest .Fa type . .Pp The EVP interface to digital signatures should almost always be -used in preference to the low level interfaces. +used in preference to the low-level interfaces. This is because the code then becomes transparent to the algorithm used and much more flexible. .Pp diff --git a/lib/libcrypto/man/EVP_VerifyInit.3 b/lib/libcrypto/man/EVP_VerifyInit.3 index dfebe8f2bfb..0baadfb9fb8 100644 --- a/lib/libcrypto/man/EVP_VerifyInit.3 +++ b/lib/libcrypto/man/EVP_VerifyInit.3 @@ -1,6 +1,5 @@ -.\" $OpenBSD: EVP_VerifyInit.3,v 1.12 2024/07/21 08:36:43 tb Exp $ -.\" full merge up to: OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 -.\" selective merge up to: OpenSSL 79b49fb0 Mar 20 10:03:10 2018 +1000 +.\" $OpenBSD: EVP_VerifyInit.3,v 1.13 2024/11/08 22:23:35 schwarze Exp $ +.\" full merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 .\" .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. .\" Copyright (c) 2000, 2001, 2006, 2016 The OpenSSL Project. @@ -50,7 +49,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: July 21 2024 $ +.Dd $Mdocdate: November 8 2024 $ .Dt EVP_VERIFYINIT 3 .Os .Sh NAME @@ -86,20 +85,23 @@ .Fa "const EVP_MD *type" .Fc .Sh DESCRIPTION -The EVP signature verification routines are a high level interface to +The EVP signature verification routines are a high-level interface to digital signatures. .Pp .Fn EVP_VerifyInit_ex -sets up a verification context +sets up the verification context .Fa ctx to use the digest .Fa type . +Before calling this function, obtain .Fa ctx -must be initialized by calling -.Xr EVP_MD_CTX_init 3 -before calling this function. +from +.Xr EVP_MD_CTX_new 3 +or call +.Xr EVP_MD_CTX_reset 3 +on it. The -.Fa ENGINE *engine +.Fa engine argument is always ignored and passing .Dv NULL is recommended. @@ -132,7 +134,7 @@ to use the default implementation of digest .Fa type . .Pp The EVP interface to digital signatures should almost always be -used in preference to the low level interfaces. +used in preference to the low-level interfaces. This is because the code then becomes transparent to the algorithm used and much more flexible. .Pp |