diff options
Diffstat (limited to 'src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3')
| -rw-r--r-- | src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | 69 |
1 files changed, 43 insertions, 26 deletions
diff --git a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 index 88ecef9768..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.16 2024/03/04 19:04:47 tb 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: March 4 2024 $ | 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 |
| @@ -64,6 +81,7 @@ | |||
| 64 | .\" because they are unused aliases. | 81 | .\" because they are unused aliases. |
| 65 | .Nd add algorithms to internal table | 82 | .Nd add algorithms to internal table |
| 66 | .Sh SYNOPSIS | 83 | .Sh SYNOPSIS |
| 84 | .Lb libcrypto | ||
| 67 | .In openssl/evp.h | 85 | .In openssl/evp.h |
| 68 | .Ft void | 86 | .Ft void |
| 69 | .Fn OpenSSL_add_all_algorithms void | 87 | .Fn OpenSSL_add_all_algorithms void |
| @@ -79,40 +97,43 @@ | |||
| 79 | These functions are deprecated. | 97 | These functions are deprecated. |
| 80 | It is never useful for any application program | 98 | It is never useful for any application program |
| 81 | to call any of them explicitly. | 99 | to call any of them explicitly. |
| 82 | The library automatically calls them internally whenever needed. | 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 | OpenSSL keeps an internal table of digest algorithms and ciphers. | 103 | The library contains internal tables of digest algorithms and ciphers. |
| 85 | It uses this table to look up ciphers via functions such as | 104 | It uses these tables to look up digests and ciphers via |
| 86 | .Xr EVP_get_cipherbyname 3 . | 105 | .Xr EVP_get_digestbyname 3 |
| 106 | and | ||
| 107 | .Xr EVP_get_cipherbyname 3 , | ||
| 108 | respectively. | ||
| 109 | In LibreSSL, these tables are static constants and do not require | ||
| 110 | initialization. | ||
| 87 | .Pp | 111 | .Pp |
| 88 | .Fn OpenSSL_add_all_algorithms | 112 | .Fn OpenSSL_add_all_algorithms |
| 89 | adds all algorithms to the table (digests and ciphers). | 113 | used to add all digests and ciphers to the tables. |
| 90 | If an application is compiled with the preprocessor symbol | 114 | If an application is compiled with the preprocessor symbol |
| 91 | .Dv OPENSSL_LOAD_CONF | 115 | .Dv OPENSSL_LOAD_CONF |
| 92 | #define'd, it also calls | 116 | defined, it also calls |
| 93 | .Xr OPENSSL_config 3 | 117 | .Xr OPENSSL_config 3 |
| 94 | with a | 118 | with a |
| 95 | .Dv NULL | 119 | .Dv NULL |
| 96 | 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. | ||
| 97 | .Pp | 127 | .Pp |
| 98 | .Fn OpenSSL_add_all_digests | 128 | .Fn OpenSSL_add_all_digests |
| 99 | adds all digest algorithms to the table. | 129 | used to add all digest algorithms to the table. |
| 100 | .Pp | 130 | .Pp |
| 101 | .Fn OpenSSL_add_all_ciphers | 131 | .Fn OpenSSL_add_all_ciphers |
| 102 | adds all encryption algorithms to the table including password based | 132 | used to add all encryption algorithms to the table. |
| 103 | encryption algorithms. | ||
| 104 | .Pp | ||
| 105 | If any of the above functions is called more than once, | ||
| 106 | only the first call has an effect. | ||
| 107 | .Pp | 133 | .Pp |
| 108 | .Fn EVP_cleanup | 134 | .Fn EVP_cleanup |
| 109 | removes all ciphers and digests from the table and also calls | 135 | has no effect; it used to remove various kinds of application-supplied |
| 110 | .Xr OBJ_NAME_cleanup 3 | 136 | data that is no longer supported in the first place. |
| 111 | with an argument of \-1 , | ||
| 112 | thus resetting the global associative array of names | ||
| 113 | and all signature algorithm definitions to their default states, | ||
| 114 | removing all application-defined types, key-value pairs, and aliases, | ||
| 115 | including any that are unrelated to the EVP library. | ||
| 116 | .Pp | 137 | .Pp |
| 117 | .Fn SSLeay_add_all_algorithms | 138 | .Fn SSLeay_add_all_algorithms |
| 118 | is a deprecated alias for | 139 | is a deprecated alias for |
| @@ -126,8 +147,6 @@ are implemented as macros. | |||
| 126 | .Xr evp 3 , | 147 | .Xr evp 3 , |
| 127 | .Xr EVP_DigestInit 3 , | 148 | .Xr EVP_DigestInit 3 , |
| 128 | .Xr EVP_EncryptInit 3 , | 149 | .Xr EVP_EncryptInit 3 , |
| 129 | .Xr OBJ_cleanup 3 , | ||
| 130 | .Xr OBJ_NAME_add 3 , | ||
| 131 | .Xr OPENSSL_config 3 | 150 | .Xr OPENSSL_config 3 |
| 132 | .Sh HISTORY | 151 | .Sh HISTORY |
| 133 | .Fn EVP_cleanup , | 152 | .Fn EVP_cleanup , |
| @@ -148,5 +167,3 @@ first appeared in OpenSSL 0.9.5 and have been available since | |||
| 148 | .Sh BUGS | 167 | .Sh BUGS |
| 149 | Although the functions do not return error codes, it is possible for them | 168 | Although the functions do not return error codes, it is possible for them |
| 150 | to fail. | 169 | to fail. |
| 151 | This will only happen as a result of a memory allocation failure so this | ||
| 152 | is not too much of a problem in practice. | ||
