diff options
author | schwarze <> | 2025-06-12 15:59:30 +0000 |
---|---|---|
committer | schwarze <> | 2025-06-12 15:59:30 +0000 |
commit | b5a647fae341bc81062532b15ab89f2331f1f101 (patch) | |
tree | 122bf9b79c0263ce6fcbae8989efb58a65878d2e /src | |
parent | 3af56aa67c2ee450d5fe9bb9dd8b27ab96164ec4 (diff) | |
download | openbsd-b5a647fae341bc81062532b15ab89f2331f1f101.tar.gz openbsd-b5a647fae341bc81062532b15ab89f2331f1f101.tar.bz2 openbsd-b5a647fae341bc81062532b15ab89f2331f1f101.zip |
Bring the DESCRIPTION a bit closer to reality, in particular stop
claiming that the "add" functions add anything. Indicate that they
are mostly NOOPs nowadays, but without being overly specific.
Also, more explicitly discourage abusing OpenSSL_add_all_algorithms(3)
for loadiing a configuration file.
Guidance and OK tb@.
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | 38 |
1 files changed, 31 insertions, 7 deletions
diff --git a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 index 64f71590fe..68d8799bd4 100644 --- a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 +++ b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | |||
@@ -1,7 +1,24 @@ | |||
1 | .\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.18 2025/06/09 12:43:53 schwarze Exp $ | 1 | .\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.19 2025/06/12 15:59:30 schwarze Exp $ |
2 | .\" full merge up to: OpenSSL b3696a55 Sep 2 09:35:50 2017 -0400 | 2 | .\" full merge up to: OpenSSL b3696a55 Sep 2 09:35:50 2017 -0400 |
3 | .\" | 3 | .\" |
4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | 4 | .\" This file is a derived work. |
5 | .\" The changes are covered by the following Copyright and license: | ||
6 | .\" | ||
7 | .\" Copyright (c) 2018, 2019, 2023, 2025 Ingo Schwarze <schwarze@openbsd.org> | ||
8 | .\" | ||
9 | .\" Permission to use, copy, modify, and distribute this software for any | ||
10 | .\" purpose with or without fee is hereby granted, provided that the above | ||
11 | .\" copyright notice and this permission notice appear in all copies. | ||
12 | .\" | ||
13 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
14 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
15 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
16 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
17 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
18 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
19 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
20 | .\" | ||
21 | .\" The original file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
5 | .\" Copyright (c) 2000, 2003, 2013 The OpenSSL Project. All rights reserved. | 22 | .\" Copyright (c) 2000, 2003, 2013 The OpenSSL Project. All rights reserved. |
6 | .\" | 23 | .\" |
7 | .\" Redistribution and use in source and binary forms, with or without | 24 | .\" Redistribution and use in source and binary forms, with or without |
@@ -48,7 +65,7 @@ | |||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
50 | .\" | 67 | .\" |
51 | .Dd $Mdocdate: June 9 2025 $ | 68 | .Dd $Mdocdate: June 12 2025 $ |
52 | .Dt OPENSSL_ADD_ALL_ALGORITHMS 3 | 69 | .Dt OPENSSL_ADD_ALL_ALGORITHMS 3 |
53 | .Os | 70 | .Os |
54 | .Sh NAME | 71 | .Sh NAME |
@@ -80,6 +97,8 @@ | |||
80 | These functions are deprecated. | 97 | These functions are deprecated. |
81 | It is never useful for any application program | 98 | It is never useful for any application program |
82 | to call any of them explicitly. | 99 | to call any of them explicitly. |
100 | Most of them have no effect except that they may or may not call | ||
101 | .Xr OPENSSL_init_crypto 3 . | ||
83 | .Pp | 102 | .Pp |
84 | The library contains internal tables of digest algorithms and ciphers. | 103 | The library contains internal tables of digest algorithms and ciphers. |
85 | It uses these tables to look up digests and ciphers via | 104 | It uses these tables to look up digests and ciphers via |
@@ -91,7 +110,7 @@ In LibreSSL, these tables are static constants and do not require | |||
91 | initialization. | 110 | initialization. |
92 | .Pp | 111 | .Pp |
93 | .Fn OpenSSL_add_all_algorithms | 112 | .Fn OpenSSL_add_all_algorithms |
94 | adds all algorithms to the table (digests and ciphers). | 113 | used to add all digests and ciphers to the tables. |
95 | If an application is compiled with the preprocessor symbol | 114 | If an application is compiled with the preprocessor symbol |
96 | .Dv OPENSSL_LOAD_CONF | 115 | .Dv OPENSSL_LOAD_CONF |
97 | defined, it also calls | 116 | defined, it also calls |
@@ -99,13 +118,18 @@ defined, it also calls | |||
99 | with a | 118 | with a |
100 | .Dv NULL | 119 | .Dv NULL |
101 | argument, loading the default configuration file. | 120 | argument, loading the default configuration file. |
121 | Relying on this behaviour is not recommended. | ||
122 | If loading a configuration file is desired, call | ||
123 | .Xr OPENSSL_config 3 | ||
124 | or | ||
125 | .Xr CONF_modules_load_file 3 | ||
126 | directly. | ||
102 | .Pp | 127 | .Pp |
103 | .Fn OpenSSL_add_all_digests | 128 | .Fn OpenSSL_add_all_digests |
104 | adds all digest algorithms to the table. | 129 | used to add all digest algorithms to the table. |
105 | .Pp | 130 | .Pp |
106 | .Fn OpenSSL_add_all_ciphers | 131 | .Fn OpenSSL_add_all_ciphers |
107 | adds all encryption algorithms to the table including password based | 132 | used to add all encryption algorithms to the table. |
108 | encryption algorithms. | ||
109 | .Pp | 133 | .Pp |
110 | .Fn EVP_cleanup | 134 | .Fn EVP_cleanup |
111 | has no effect; it used to remove various kinds of application-supplied | 135 | has no effect; it used to remove various kinds of application-supplied |