From 89729f590517fbb6e08bcdc72378bd9c85366a56 Mon Sep 17 00:00:00 2001 From: schwarze Date: Thu, 16 Nov 2023 20:27:43 +0000 Subject: [PATCH] Mention which functions are implemented as macros in the few cases where that information was missing. --- lib/libcrypto/man/BIO_get_data.3 | 15 ++++++++++++--- lib/libcrypto/man/BIO_get_ex_new_index.3 | 4 ++-- lib/libcrypto/man/DES_set_key.3 | 14 ++++++++------ lib/libcrypto/man/EVP_OpenInit.3 | 7 +++++-- lib/libcrypto/man/EVP_SealInit.3 | 7 +++++-- lib/libcrypto/man/EVP_SignInit.3 | 10 ++++++++-- lib/libcrypto/man/EVP_VerifyInit.3 | 10 ++++++++-- lib/libcrypto/man/EVP_aes_128_cbc.3 | 7 ++++--- lib/libcrypto/man/EVP_sm4_cbc.3 | 7 ++++--- lib/libcrypto/man/OPENSSL_malloc.3 | 8 ++++++-- lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | 9 +++++++-- lib/libcrypto/man/X509_STORE_get_by_subject.3 | 6 +++--- lib/libcrypto/man/X509_STORE_set1_param.3 | 6 ++++-- 13 files changed, 76 insertions(+), 34 deletions(-) diff --git a/lib/libcrypto/man/BIO_get_data.3 b/lib/libcrypto/man/BIO_get_data.3 index b4b0014d15b..63750ac37b1 100644 --- a/lib/libcrypto/man/BIO_get_data.3 +++ b/lib/libcrypto/man/BIO_get_data.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: BIO_get_data.3,v 1.7 2022/12/19 14:40:14 schwarze Exp $ +.\" $OpenBSD: BIO_get_data.3,v 1.8 2023/11/16 20:27:43 schwarze Exp $ .\" full merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 .\" .\" This file is a derived work. @@ -65,7 +65,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: December 19 2022 $ +.Dd $Mdocdate: November 16 2023 $ .Dt BIO_GET_DATA 3 .Os .Sh NAME @@ -204,7 +204,7 @@ Application programs usually call macros like those documented in rather than calling .Fn BIO_test_flags directly. -Flag bits correspond to accessor functions as follows: +Flag bits correspond to accessor macros as follows: .Pp .Bl -tag -width BIO_FLAGS_SHOULD_RETRY -compact .It Dv BIO_FLAGS_READ @@ -319,6 +319,15 @@ object, call and .Xr BIO_get_close 3 instead. +.Pp +.Fn BIO_get_flags , +.Fn BIO_set_retry_read , +.Fn BIO_set_retry_write , +.Fn BIO_set_retry_special , +.Fn BIO_clear_retry_flags , +and +.Fn BIO_get_retry_flags +are implemented as macros. .Sh RETURN VALUES .Fn BIO_get_data returns a pointer to the implementation specific custom data associated diff --git a/lib/libcrypto/man/BIO_get_ex_new_index.3 b/lib/libcrypto/man/BIO_get_ex_new_index.3 index c484591fcd3..e3bf7350a7d 100644 --- a/lib/libcrypto/man/BIO_get_ex_new_index.3 +++ b/lib/libcrypto/man/BIO_get_ex_new_index.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: BIO_get_ex_new_index.3,v 1.15 2023/11/16 15:39:32 schwarze Exp $ +.\" $OpenBSD: BIO_get_ex_new_index.3,v 1.16 2023/11/16 20:27:43 schwarze Exp $ .\" full merge up to: OpenSSL 61f805c1 Jan 16 01:01:46 2018 +0800 .\" .\" This file was written by Rich Salz . @@ -140,7 +140,7 @@ object. .Fn TYPE_set_app_data and .Fn TYPE_get_app_data -are deprecated wrappers that call +are deprecated wrapper macros that call .Fn TYPE_set_ex_data and .Fn TYPE_get_ex_data diff --git a/lib/libcrypto/man/DES_set_key.3 b/lib/libcrypto/man/DES_set_key.3 index e74c7c5e488..16188f1f289 100644 --- a/lib/libcrypto/man/DES_set_key.3 +++ b/lib/libcrypto/man/DES_set_key.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: DES_set_key.3,v 1.15 2022/03/31 17:27:16 naddy Exp $ +.\" $OpenBSD: DES_set_key.3,v 1.16 2023/11/16 20:27:43 schwarze Exp $ .\" full merge up to: .\" OpenSSL man3/DES_random_key 521738e9 Oct 5 14:58:30 2018 -0400 .\" @@ -115,7 +115,7 @@ .\" copied and put under another distribution licence .\" [including the GNU Public Licence.] .\" -.Dd $Mdocdate: March 31 2022 $ +.Dd $Mdocdate: November 16 2023 $ .Dt DES_SET_KEY 3 .Os .Sh NAME @@ -599,10 +599,11 @@ then update ivec and num. num contains "how far" we are though ivec. If this does not make much sense, read more about CFB mode of DES. .Pp +The .Fn DES_ede3_cfb64_encrypt -and +function and the .Fn DES_ede2_cfb64_encrypt -is the same as +macro are the same as .Fn DES_cfb64_encrypt except that Triple-DES is used. .Pp @@ -625,10 +626,11 @@ is the same as .Fn DES_cfb64_encrypt using Output Feed Back mode. .Pp +The .Fn DES_ede3_ofb64_encrypt -and +function and the .Fn DES_ede2_ofb64_encrypt -is the same as +macro are the same as .Fn DES_ofb64_encrypt , using Triple-DES. .Pp diff --git a/lib/libcrypto/man/EVP_OpenInit.3 b/lib/libcrypto/man/EVP_OpenInit.3 index 766d178cbd1..fbd0e75571a 100644 --- a/lib/libcrypto/man/EVP_OpenInit.3 +++ b/lib/libcrypto/man/EVP_OpenInit.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: EVP_OpenInit.3,v 1.8 2019/06/07 20:46:25 schwarze Exp $ +.\" $OpenBSD: EVP_OpenInit.3,v 1.9 2023/11/16 20:27:43 schwarze Exp $ .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 .\" .\" This file was written by Dr. Stephen Henson . @@ -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: June 7 2019 $ +.Dd $Mdocdate: November 16 2023 $ .Dt EVP_OPENINIT 3 .Os .Sh NAME @@ -131,6 +131,9 @@ parameter is a variable length cipher then the key length will be set to the value of the recovered key length. If the cipher is a fixed length cipher then the recovered key length must match the fixed cipher length. +.Pp +.Fn EVP_OpenUpdate +is implemented as a macro. .Sh RETURN VALUES .Fn EVP_OpenInit returns 0 on error or a non-zero integer (actually the recovered secret diff --git a/lib/libcrypto/man/EVP_SealInit.3 b/lib/libcrypto/man/EVP_SealInit.3 index 15938fcb33c..da53535274e 100644 --- a/lib/libcrypto/man/EVP_SealInit.3 +++ b/lib/libcrypto/man/EVP_SealInit.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: EVP_SealInit.3,v 1.8 2019/06/07 20:46:25 schwarze Exp $ +.\" $OpenBSD: EVP_SealInit.3,v 1.9 2023/11/16 20:27:43 schwarze Exp $ .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 .\" .\" This file was written by Dr. Stephen Henson . @@ -49,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: June 7 2019 $ +.Dd $Mdocdate: November 16 2023 $ .Dt EVP_SEALINIT 3 .Os .Sh NAME @@ -162,6 +162,9 @@ set to 0 and (after setting any cipher parameters) it should be called again with .Fa type set to NULL. +.Pp +.Fn EVP_SealUpdate +is implemented as a macro. .Sh RETURN VALUES .Fn EVP_SealInit returns 0 on error or diff --git a/lib/libcrypto/man/EVP_SignInit.3 b/lib/libcrypto/man/EVP_SignInit.3 index 59dbca1e5b6..dc042910bbe 100644 --- a/lib/libcrypto/man/EVP_SignInit.3 +++ b/lib/libcrypto/man/EVP_SignInit.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: EVP_SignInit.3,v 1.16 2022/07/13 19:10:40 schwarze Exp $ +.\" $OpenBSD: EVP_SignInit.3,v 1.17 2023/11/16 20:27:43 schwarze 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 .\" @@ -50,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 13 2022 $ +.Dd $Mdocdate: November 16 2023 $ .Dt EVP_SIGNINIT 3 .Os .Sh NAME @@ -157,6 +157,12 @@ Since only a copy of the digest context is ever finalized, the context must be cleaned up after use by calling .Xr EVP_MD_CTX_free 3 or a memory leak will occur. +.Pp +.Fn EVP_SignInit_ex , +.Fn EVP_SignUpdate , +and +.Fn EVP_SignInit +are implemented as macros. .Sh RETURN VALUES .Fn EVP_SignInit_ex , .Fn EVP_SignUpdate , diff --git a/lib/libcrypto/man/EVP_VerifyInit.3 b/lib/libcrypto/man/EVP_VerifyInit.3 index 5556f6c835d..90a774e5145 100644 --- a/lib/libcrypto/man/EVP_VerifyInit.3 +++ b/lib/libcrypto/man/EVP_VerifyInit.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: EVP_VerifyInit.3,v 1.10 2019/06/10 14:58:48 schwarze Exp $ +.\" $OpenBSD: EVP_VerifyInit.3,v 1.11 2023/11/16 20:27:43 schwarze 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 .\" @@ -50,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: June 10 2019 $ +.Dd $Mdocdate: November 16 2023 $ .Dt EVP_VERIFYINIT 3 .Os .Sh NAME @@ -147,6 +147,12 @@ Since only a copy of the digest context is ever finalized, the context must be cleaned up after use by calling .Xr EVP_MD_CTX_free 3 , or a memory leak will occur. +.Pp +.Fn EVP_VerifyInit_ex , +.Fn EVP_VerifyUpdate , +and +.Fn EVP_VerifyInit +are implemented as macros. .Sh RETURN VALUES .Fn EVP_VerifyInit_ex and diff --git a/lib/libcrypto/man/EVP_aes_128_cbc.3 b/lib/libcrypto/man/EVP_aes_128_cbc.3 index ac63f7f1f2e..4d153e5cbd5 100644 --- a/lib/libcrypto/man/EVP_aes_128_cbc.3 +++ b/lib/libcrypto/man/EVP_aes_128_cbc.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: EVP_aes_128_cbc.3,v 1.4 2020/06/24 18:15:00 jmc Exp $ +.\" $OpenBSD: EVP_aes_128_cbc.3,v 1.5 2023/11/16 20:27:43 schwarze Exp $ .\" selective merge up to: OpenSSL 7c6d372a Nov 20 13:20:01 2018 +0000 .\" .\" This file was written by Ronald Tse @@ -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: June 24 2020 $ +.Dd $Mdocdate: November 16 2023 $ .Dt EVP_AES_128_CBC 3 .Os .Sh NAME @@ -205,7 +205,8 @@ are aliases for .Fn EVP_aes_128_cfb128 , .Fn EVP_aes_192_cfb128 , and -.Fn EVP_aes_256_cfb128 . +.Fn EVP_aes_256_cfb128 , +implemented as macros. .Pp .Fn EVP_aes_128_cbc_hmac_sha1 and diff --git a/lib/libcrypto/man/EVP_sm4_cbc.3 b/lib/libcrypto/man/EVP_sm4_cbc.3 index 85ff88f54e3..0605a52faa2 100644 --- a/lib/libcrypto/man/EVP_sm4_cbc.3 +++ b/lib/libcrypto/man/EVP_sm4_cbc.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: EVP_sm4_cbc.3,v 1.1 2019/03/18 05:56:24 schwarze Exp $ +.\" $OpenBSD: EVP_sm4_cbc.3,v 1.2 2023/11/16 20:27:43 schwarze Exp $ .\" full merge up to: OpenSSL 87103969 Oct 1 14:11:57 2018 -0700 .\" .\" Copyright (c) 2017 Ribose Inc @@ -18,7 +18,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 18 2019 $ +.Dd $Mdocdate: November 16 2023 $ .Dt EVP_SM4_CBC 3 .Os .Sh NAME @@ -53,7 +53,8 @@ bits. .Pp .Fn EVP_sm4_cfb is an alias for -.Fn EVP_sm4_cfb128 . +.Fn EVP_sm4_cfb128 , +implemented as a macro. .Pp With an argument of .Qq sm4 diff --git a/lib/libcrypto/man/OPENSSL_malloc.3 b/lib/libcrypto/man/OPENSSL_malloc.3 index 87f8d81ed12..508867132c4 100644 --- a/lib/libcrypto/man/OPENSSL_malloc.3 +++ b/lib/libcrypto/man/OPENSSL_malloc.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: OPENSSL_malloc.3,v 1.10 2022/11/06 18:31:15 tb Exp $ +.\" $OpenBSD: OPENSSL_malloc.3,v 1.11 2023/11/16 20:27:43 schwarze Exp $ .\" .\" Copyright (c) 2016 Ingo Schwarze .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: November 6 2022 $ +.Dd $Mdocdate: November 16 2023 $ .Dt OPENSSL_MALLOC 3 .Os .Sh NAME @@ -83,6 +83,10 @@ standard and .Xr strdup 3 functions. +.Pp +The four +.Fn OPENSSL_* +functions are implemented as macros. .Sh RETURN VALUES These functions return the same type and value as the corresponding standard functions. diff --git a/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 b/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 index 0c4112087a8..4aeef4f084f 100644 --- a/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 +++ b/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.14 2023/09/10 14:39:58 schwarze Exp $ +.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.15 2023/11/16 20:27:43 schwarze Exp $ .\" full merge up to: OpenSSL b3696a55 Sep 2 09:35:50 2017 -0400 .\" .\" This file was written by Dr. Stephen Henson . @@ -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: September 10 2023 $ +.Dd $Mdocdate: November 16 2023 $ .Dt OPENSSL_ADD_ALL_ALGORITHMS 3 .Os .Sh NAME @@ -117,6 +117,11 @@ including any that are unrelated to the EVP library. .Fn SSLeay_add_all_algorithms is a deprecated alias for .Fn OpenSSL_add_all_algorithms . +.Pp +.Fn OpenSSL_add_all_algorithms +and +.Fn SSLeay_add_all_algorithms +are implemented as macros. .Sh SEE ALSO .Xr evp 3 , .Xr EVP_add_cipher 3 , diff --git a/lib/libcrypto/man/X509_STORE_get_by_subject.3 b/lib/libcrypto/man/X509_STORE_get_by_subject.3 index 3fb6c1c251b..ee2ba07b18c 100644 --- a/lib/libcrypto/man/X509_STORE_get_by_subject.3 +++ b/lib/libcrypto/man/X509_STORE_get_by_subject.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: X509_STORE_get_by_subject.3,v 1.4 2023/08/10 14:15:16 schwarze Exp $ +.\" $OpenBSD: X509_STORE_get_by_subject.3,v 1.5 2023/11/16 20:27:43 schwarze Exp $ .\" .\" Copyright (c) 2021, 2023 Ingo Schwarze .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: August 10 2023 $ +.Dd $Mdocdate: November 16 2023 $ .Dt X509_STORE_GET_BY_SUBJECT 3 .Os .Sh NAME @@ -160,7 +160,7 @@ encourage checking of validity times, CAs with a valid time are preferred, but if no matching CA has a valid time, one with an invalid time is accepted anyway. .Pp -The following are deprecated aliases: +The following are deprecated aliases implemented as macros: .Bl -column X509_STORE_get_by_subject F X509_STORE_CTX_get_by_subject .It Fn X509_STORE_get_by_subject Ta for Ta Fn X509_STORE_CTX_get_by_subject .It Fn X509_STORE_get1_certs Ta for Ta Fn X509_STORE_CTX_get1_certs diff --git a/lib/libcrypto/man/X509_STORE_set1_param.3 b/lib/libcrypto/man/X509_STORE_set1_param.3 index 354d8738541..538f22c7598 100644 --- a/lib/libcrypto/man/X509_STORE_set1_param.3 +++ b/lib/libcrypto/man/X509_STORE_set1_param.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: X509_STORE_set1_param.3,v 1.19 2021/10/18 18:20:39 schwarze Exp $ +.\" $OpenBSD: X509_STORE_set1_param.3,v 1.20 2023/11/16 20:27:43 schwarze Exp $ .\" content checked up to: .\" OpenSSL man3/X509_STORE_add_cert b0edda11 Mar 20 13:00:17 2018 +0000 .\" OpenSSL man3/X509_STORE_get0_param e90fc053 Jul 15 09:39:45 2017 -0400 @@ -17,7 +17,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: October 18 2021 $ +.Dd $Mdocdate: November 16 2023 $ .Dt X509_STORE_SET1_PARAM 3 .Os .Sh NAME @@ -145,6 +145,8 @@ Their usage is identical to that of .Xr RSA_set_ex_data 3 , and .Xr RSA_get_ex_data 3 . +.Fn X509_STORE_get_ex_new_index +is implemented as a macro. .Sh RETURN VALUES .Fn X509_STORE_set1_param , .Fn X509_STORE_set_purpose , -- 2.20.1