diff options
author | schwarze <> | 2018-03-21 22:08:04 +0000 |
---|---|---|
committer | schwarze <> | 2018-03-21 22:08:04 +0000 |
commit | 06cedd6f2ac65939a767213f243a7c11aef2d0be (patch) | |
tree | c98fb17ad7143964c99a5e0a0e600ecd5d16e061 /src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | |
parent | a270a496c5b6eff7217e0ad875c170ba530c6dd9 (diff) | |
download | openbsd-06cedd6f2ac65939a767213f243a7c11aef2d0be.tar.gz openbsd-06cedd6f2ac65939a767213f243a7c11aef2d0be.tar.bz2 openbsd-06cedd6f2ac65939a767213f243a7c11aef2d0be.zip |
Catch up after beck@ fixed autoconfiguration:
* Say more precisely what OPENSSL_config(3) and OPENSSL_no_config(3) do.
* Revert the deprecation notice for them, nothing wrong with them.
* Document OPENSSL_INIT_LOAD_CONFIG.
* Deprecate OpenSSL_add_all_algorithms(3), it's now automatic.
* Add OpenSSL_add_all_algorithms(3) HISTORY.
Substantial feedback and OK beck@.
Diffstat (limited to 'src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3')
-rw-r--r-- | src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | 53 |
1 files changed, 23 insertions, 30 deletions
diff --git a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 index 270298cb85..329fef8130 100644 --- a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 +++ b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | |||
@@ -1,5 +1,5 @@ | |||
1 | .\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.4 2016/11/28 16:40:27 schwarze Exp $ | 1 | .\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.5 2018/03/21 22:08:04 schwarze Exp $ |
2 | .\" OpenSSL f672aee4 Feb 9 11:52:40 2016 -0500 | 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 was written by Dr. Stephen Henson <steve@openssl.org>. |
5 | .\" Copyright (c) 2000, 2003, 2013 The OpenSSL Project. All rights reserved. | 5 | .\" Copyright (c) 2000, 2003, 2013 The OpenSSL Project. All rights reserved. |
@@ -48,7 +48,7 @@ | |||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
50 | .\" | 50 | .\" |
51 | .Dd $Mdocdate: November 28 2016 $ | 51 | .Dd $Mdocdate: March 21 2018 $ |
52 | .Dt OPENSSL_ADD_ALL_ALGORITHMS 3 | 52 | .Dt OPENSSL_ADD_ALL_ALGORITHMS 3 |
53 | .Os | 53 | .Os |
54 | .Sh NAME | 54 | .Sh NAME |
@@ -68,6 +68,11 @@ | |||
68 | .Ft void | 68 | .Ft void |
69 | .Fn EVP_cleanup void | 69 | .Fn EVP_cleanup void |
70 | .Sh DESCRIPTION | 70 | .Sh DESCRIPTION |
71 | These functions are deprecated. | ||
72 | It is never useful for any application program | ||
73 | to call any of them explicitly. | ||
74 | The library automatically calls them internally whenever needed. | ||
75 | .Pp | ||
71 | OpenSSL keeps an internal table of digest algorithms and ciphers. | 76 | OpenSSL keeps an internal table of digest algorithms and ciphers. |
72 | It uses this table to look up ciphers via functions such as | 77 | It uses this table to look up ciphers via functions such as |
73 | .Xr EVP_get_cipherbyname 3 . | 78 | .Xr EVP_get_cipherbyname 3 . |
@@ -82,38 +87,26 @@ adds all digest algorithms to the table. | |||
82 | adds all encryption algorithms to the table including password based | 87 | adds all encryption algorithms to the table including password based |
83 | encryption algorithms. | 88 | encryption algorithms. |
84 | .Pp | 89 | .Pp |
85 | .Fn EVP_cleanup | 90 | If any of the above functions is called more than once, |
86 | removes all ciphers and digests from the table. | 91 | only the first call has an effect. |
87 | .Pp | 92 | .Pp |
88 | A typical application will call | ||
89 | .Fn OpenSSL_add_all_algorithms | ||
90 | initially and | ||
91 | .Fn EVP_cleanup | 93 | .Fn EVP_cleanup |
92 | before exiting. | 94 | removes all ciphers and digests from the table. |
93 | .Pp | ||
94 | An application does not need to add algorithms to use them explicitly, | ||
95 | for example by | ||
96 | .Xr EVP_sha1 3 . | ||
97 | It just needs to add them if it (or any of the functions it calls) needs | ||
98 | to look up algorithms. | ||
99 | .Pp | ||
100 | The cipher and digest lookup functions are used in many parts of the | ||
101 | library. | ||
102 | If the table is not initialized, several functions will misbehave and | ||
103 | complain they cannot find algorithms. | ||
104 | This includes the PEM, PKCS#12, SSL and S/MIME libraries. | ||
105 | This is a common query in the OpenSSL mailing lists. | ||
106 | .Pp | ||
107 | Calling | ||
108 | .Fn OpenSSL_add_all_algorithms | ||
109 | links in all algorithms: as a result a statically linked executable can | ||
110 | be quite large. | ||
111 | If this is important, it is possible to just add the required ciphers and | ||
112 | digests. | ||
113 | .Sh SEE ALSO | 95 | .Sh SEE ALSO |
114 | .Xr evp 3 , | 96 | .Xr evp 3 , |
115 | .Xr EVP_DigestInit 3 , | 97 | .Xr EVP_DigestInit 3 , |
116 | .Xr EVP_EncryptInit 3 | 98 | .Xr EVP_EncryptInit 3 , |
99 | .Xr OPENSSL_config 3 , | ||
100 | .Xr OPENSSL_init_crypto 3 | ||
101 | .Sh HISTORY | ||
102 | .Fn EVP_cleanup | ||
103 | and precursor functions | ||
104 | .Fn SSLeay_add_all_algorithms , | ||
105 | .Fn SSLeay_add_all_ciphers , | ||
106 | and | ||
107 | .Fn SSLeay_add_all_digests | ||
108 | appeared in SSLeay 0.8.1b or earlier and have been available since | ||
109 | .Ox 2.4 . | ||
117 | .Sh BUGS | 110 | .Sh BUGS |
118 | Although the functions do not return error codes, it is possible for them | 111 | Although the functions do not return error codes, it is possible for them |
119 | to fail. | 112 | to fail. |