diff options
| author | schwarze <> | 2019-06-14 13:41:31 +0000 |
|---|---|---|
| committer | schwarze <> | 2019-06-14 13:41:31 +0000 |
| commit | 1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67 (patch) | |
| tree | e256db7268ff96a8a7913497240af58ac3423a15 | |
| parent | 5a7670f6ffe1fa2cc36ecf3077067c03cad025ea (diff) | |
| download | openbsd-1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67.tar.gz openbsd-1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67.tar.bz2 openbsd-1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67.zip | |
Further improve the documentation of library initialization and configuration.
Among other improvements:
* Use a uniform wording at the top of the DECSRIPTION for obsolete pages.
* Better explain how to use a non-standard configuration file.
* Remove obsolete functions from SEE ALSO.
Triggered by some suggestions from tb@.
Tweaks and OK tb@.
| -rw-r--r-- | src/lib/libcrypto/man/CONF_modules_load_file.3 | 32 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/ERR_load_crypto_strings.3 | 29 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/OPENSSL_config.3 | 25 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/OPENSSL_init_crypto.3 | 34 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/OPENSSL_load_builtin_modules.3 | 12 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | 14 | ||||
| -rw-r--r-- | src/lib/libssl/man/OPENSSL_init_ssl.3 | 30 | ||||
| -rw-r--r-- | src/lib/libssl/man/SSL_library_init.3 | 32 | ||||
| -rw-r--r-- | src/lib/libssl/man/ssl.3 | 12 |
9 files changed, 126 insertions, 94 deletions
diff --git a/src/lib/libcrypto/man/CONF_modules_load_file.3 b/src/lib/libcrypto/man/CONF_modules_load_file.3 index d0401d520b..972752f7a3 100644 --- a/src/lib/libcrypto/man/CONF_modules_load_file.3 +++ b/src/lib/libcrypto/man/CONF_modules_load_file.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: CONF_modules_load_file.3,v 1.8 2019/03/20 04:02:07 schwarze Exp $ | 1 | .\" $OpenBSD: CONF_modules_load_file.3,v 1.9 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 |
| 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>. |
| @@ -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: March 20 2019 $ | 51 | .Dd $Mdocdate: June 14 2019 $ |
| 52 | .Dt CONF_MODULES_LOAD_FILE 3 | 52 | .Dt CONF_MODULES_LOAD_FILE 3 |
| 53 | .Os | 53 | .Os |
| 54 | .Sh NAME | 54 | .Sh NAME |
| @@ -95,6 +95,13 @@ is used. | |||
| 95 | The behaviour can be customized using | 95 | The behaviour can be customized using |
| 96 | .Fa flags . | 96 | .Fa flags . |
| 97 | .Pp | 97 | .Pp |
| 98 | See the | ||
| 99 | .Sx EXAMPLES | ||
| 100 | section for additional functions that may need to be called. | ||
| 101 | Calling configuration functions in the right order for the intended | ||
| 102 | effect can be tricky because many configuration functions internally | ||
| 103 | call each other. | ||
| 104 | .Pp | ||
| 98 | .Fn CONF_modules_load | 105 | .Fn CONF_modules_load |
| 99 | is identical to | 106 | is identical to |
| 100 | .Fn CONF_modules_load_file | 107 | .Fn CONF_modules_load_file |
| @@ -180,9 +187,12 @@ if (CONF_modules_load_file(NULL, "myapp", | |||
| 180 | } | 187 | } |
| 181 | .Ed | 188 | .Ed |
| 182 | .Pp | 189 | .Pp |
| 183 | Load custom configuration file and section, only print warnings on | 190 | Load custom configuration file and section instead of the standard one, |
| 184 | error, missing configuration file ignored: | 191 | only print warnings on error, missing configuration file ignored: |
| 185 | .Bd -literal | 192 | .Bd -literal |
| 193 | OPENSSL_no_config(); | ||
| 194 | ENGINE_load_builtin_engines(); | ||
| 195 | OPENSSL_load_builtin_modules(); | ||
| 186 | if (CONF_modules_load_file("/something/app.cnf", "myapp", | 196 | if (CONF_modules_load_file("/something/app.cnf", "myapp", |
| 187 | CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) { | 197 | CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) { |
| 188 | fprintf(stderr, "WARNING: error loading configuration file\en"); | 198 | fprintf(stderr, "WARNING: error loading configuration file\en"); |
| @@ -190,6 +200,17 @@ if (CONF_modules_load_file("/something/app.cnf", "myapp", | |||
| 190 | } | 200 | } |
| 191 | .Ed | 201 | .Ed |
| 192 | .Pp | 202 | .Pp |
| 203 | In the previous example, the call to | ||
| 204 | .Xr OPENSSL_no_config 3 | ||
| 205 | is required first to suppress automatic loading | ||
| 206 | of the standard configuration file, and the calls to | ||
| 207 | .Xr ENGINE_load_builtin_engines 3 | ||
| 208 | and | ||
| 209 | .Xr OPENSSL_load_builtin_modules 3 | ||
| 210 | are needed so that the configuration of builtin modules and engines | ||
| 211 | is also loaded in addition to the configuration of | ||
| 212 | .Qq myapp . | ||
| 213 | .Pp | ||
| 193 | Load and parse configuration file manually, custom error handling: | 214 | Load and parse configuration file manually, custom error handling: |
| 194 | .Bd -literal | 215 | .Bd -literal |
| 195 | FILE *fp; | 216 | FILE *fp; |
| @@ -218,9 +239,10 @@ if (fp == NULL) { | |||
| 218 | .Ed | 239 | .Ed |
| 219 | .Sh SEE ALSO | 240 | .Sh SEE ALSO |
| 220 | .Xr CONF_modules_free 3 , | 241 | .Xr CONF_modules_free 3 , |
| 242 | .Xr ENGINE_load_builtin_engines 3 , | ||
| 221 | .Xr ERR 3 , | 243 | .Xr ERR 3 , |
| 222 | .Xr OPENSSL_config 3 , | 244 | .Xr OPENSSL_config 3 , |
| 223 | .Xr OPENSSL_init_crypto 3 | 245 | .Xr OPENSSL_load_builtin_modules 3 |
| 224 | .Sh HISTORY | 246 | .Sh HISTORY |
| 225 | .Fn CONF_modules_load_file | 247 | .Fn CONF_modules_load_file |
| 226 | and | 248 | and |
diff --git a/src/lib/libcrypto/man/ERR_load_crypto_strings.3 b/src/lib/libcrypto/man/ERR_load_crypto_strings.3 index 5421781bcc..e3d60527d7 100644 --- a/src/lib/libcrypto/man/ERR_load_crypto_strings.3 +++ b/src/lib/libcrypto/man/ERR_load_crypto_strings.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: ERR_load_crypto_strings.3,v 1.7 2018/03/27 17:35:50 schwarze Exp $ | 1 | .\" $OpenBSD: ERR_load_crypto_strings.3,v 1.8 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400 | 2 | .\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file is a derived work. | 4 | .\" This file is a derived work. |
| @@ -65,13 +65,12 @@ | |||
| 65 | .\" 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 |
| 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 67 | .\" | 67 | .\" |
| 68 | .Dd $Mdocdate: March 27 2018 $ | 68 | .Dd $Mdocdate: June 14 2019 $ |
| 69 | .Dt ERR_LOAD_CRYPTO_STRINGS 3 | 69 | .Dt ERR_LOAD_CRYPTO_STRINGS 3 |
| 70 | .Os | 70 | .Os |
| 71 | .Sh NAME | 71 | .Sh NAME |
| 72 | .Nm ERR_load_crypto_strings , | 72 | .Nm ERR_load_crypto_strings , |
| 73 | .Nm ERR_free_strings , | 73 | .Nm ERR_free_strings , |
| 74 | .Nm ERR_load_BN_strings , | ||
| 75 | .Nm SSL_load_error_strings | 74 | .Nm SSL_load_error_strings |
| 76 | .Nd load and free OpenSSL error strings | 75 | .Nd load and free OpenSSL error strings |
| 77 | .Sh SYNOPSIS | 76 | .Sh SYNOPSIS |
| @@ -80,13 +79,14 @@ | |||
| 80 | .Fn ERR_load_crypto_strings void | 79 | .Fn ERR_load_crypto_strings void |
| 81 | .Ft void | 80 | .Ft void |
| 82 | .Fn ERR_free_strings void | 81 | .Fn ERR_free_strings void |
| 83 | .In openssl/bn.h | ||
| 84 | .Ft void | ||
| 85 | .Fn ERR_load_BN_strings void | ||
| 86 | .In openssl/ssl.h | 82 | .In openssl/ssl.h |
| 87 | .Ft void | 83 | .Ft void |
| 88 | .Fn SSL_load_error_strings void | 84 | .Fn SSL_load_error_strings void |
| 89 | .Sh DESCRIPTION | 85 | .Sh DESCRIPTION |
| 86 | These functions are deprecated. | ||
| 87 | It is never useful for any application program to call any of them explicitly. | ||
| 88 | The library automatically calls them internally whenever needed. | ||
| 89 | .Pp | ||
| 90 | .Fn ERR_load_crypto_strings | 90 | .Fn ERR_load_crypto_strings |
| 91 | registers the error strings for all | 91 | registers the error strings for all |
| 92 | .Xr crypto 3 | 92 | .Xr crypto 3 |
| @@ -96,23 +96,8 @@ does the same, but also registers the | |||
| 96 | .Xr ssl 3 | 96 | .Xr ssl 3 |
| 97 | error strings. | 97 | error strings. |
| 98 | .Pp | 98 | .Pp |
| 99 | .Fn ERR_load_BN_strings | ||
| 100 | only registers the error strings for the | ||
| 101 | .Vt BIGNUM | ||
| 102 | part of the library, i.e. the functions documented in | ||
| 103 | .Xr BN_new 3 | ||
| 104 | and in the manual pages referenced from there. | ||
| 105 | That may be useful if no other parts of the crypto library | ||
| 106 | are used by the program. | ||
| 107 | Similar functions exist for other parts of the crypto library, | ||
| 108 | but they are not yet documented. | ||
| 109 | .Pp | ||
| 110 | If the error strings were already loaded before, no action occurs. | 99 | If the error strings were already loaded before, no action occurs. |
| 111 | .Pp | 100 | .Pp |
| 112 | One of these functions should be called before generating textual error | ||
| 113 | messages. | ||
| 114 | However, this is not required when memory usage is an issue. | ||
| 115 | .Pp | ||
| 116 | .Fn ERR_free_strings | 101 | .Fn ERR_free_strings |
| 117 | frees all previously loaded error strings. | 102 | frees all previously loaded error strings. |
| 118 | .Sh SEE ALSO | 103 | .Sh SEE ALSO |
| @@ -124,8 +109,6 @@ and | |||
| 124 | .Fn SSL_load_error_strings | 109 | .Fn SSL_load_error_strings |
| 125 | first appeared in SSLeay 0.4.4. | 110 | first appeared in SSLeay 0.4.4. |
| 126 | .Fn ERR_free_strings | 111 | .Fn ERR_free_strings |
| 127 | and | ||
| 128 | .Fn ERR_load_BN_strings | ||
| 129 | first appeared in SSLeay 0.5.1. | 112 | first appeared in SSLeay 0.5.1. |
| 130 | These functions been available since | 113 | These functions been available since |
| 131 | .Ox 2.4 . | 114 | .Ox 2.4 . |
diff --git a/src/lib/libcrypto/man/OPENSSL_config.3 b/src/lib/libcrypto/man/OPENSSL_config.3 index e74f697dc4..2960e2389a 100644 --- a/src/lib/libcrypto/man/OPENSSL_config.3 +++ b/src/lib/libcrypto/man/OPENSSL_config.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: OPENSSL_config.3,v 1.14 2019/06/10 09:49:48 schwarze Exp $ | 1 | .\" $OpenBSD: OPENSSL_config.3,v 1.15 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" full merge up to: OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" full merge up to: OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file is a derived work. | 4 | .\" This file is a derived work. |
| @@ -65,7 +65,7 @@ | |||
| 65 | .\" 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 |
| 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 67 | .\" | 67 | .\" |
| 68 | .Dd $Mdocdate: June 10 2019 $ | 68 | .Dd $Mdocdate: June 14 2019 $ |
| 69 | .Dt OPENSSL_CONFIG 3 | 69 | .Dt OPENSSL_CONFIG 3 |
| 70 | .Os | 70 | .Os |
| 71 | .Sh NAME | 71 | .Sh NAME |
| @@ -82,12 +82,7 @@ | |||
| 82 | .Fn OPENSSL_no_config void | 82 | .Fn OPENSSL_no_config void |
| 83 | .Sh DESCRIPTION | 83 | .Sh DESCRIPTION |
| 84 | .Fn OPENSSL_config | 84 | .Fn OPENSSL_config |
| 85 | initializes the crypto library with | 85 | initializes the crypto library and calls |
| 86 | .Xr OPENSSL_init_crypto 3 | ||
| 87 | and then calls | ||
| 88 | .Xr OPENSSL_load_builtin_modules 3 , | ||
| 89 | .Xr ENGINE_load_builtin_engines 3 , | ||
| 90 | and | ||
| 91 | .Xr CONF_modules_load_file 3 | 86 | .Xr CONF_modules_load_file 3 |
| 92 | with the standard configuration file and the given | 87 | with the standard configuration file and the given |
| 93 | .Fa appname . | 88 | .Fa appname . |
| @@ -104,7 +99,7 @@ Further calls to | |||
| 104 | have no effect. | 99 | have no effect. |
| 105 | .Pp | 100 | .Pp |
| 106 | .Fn OPENSSL_no_config | 101 | .Fn OPENSSL_no_config |
| 107 | suppresses the loading of any configuration file, so that any | 102 | suppresses the loading of the standard configuration file, so that any |
| 108 | future calls to | 103 | future calls to |
| 109 | .Fn OPENSSL_config | 104 | .Fn OPENSSL_config |
| 110 | or to | 105 | or to |
| @@ -116,6 +111,17 @@ Calling these functions is optional. | |||
| 116 | All required initialization of the crypto libraries happens | 111 | All required initialization of the crypto libraries happens |
| 117 | automatically when needed. | 112 | automatically when needed. |
| 118 | .Pp | 113 | .Pp |
| 114 | To use a non-standard configuration file, refer to | ||
| 115 | .Xr CONF_modules_load_file 3 . | ||
| 116 | .Pp | ||
| 117 | Internally, | ||
| 118 | .Fn OPENSSL_config | ||
| 119 | calls | ||
| 120 | .Xr OPENSSL_init_crypto 3 , | ||
| 121 | .Xr OPENSSL_load_builtin_modules 3 , | ||
| 122 | and | ||
| 123 | .Xr ENGINE_load_builtin_engines 3 . | ||
| 124 | .Pp | ||
| 119 | If an application is compiled with the preprocessor symbol | 125 | If an application is compiled with the preprocessor symbol |
| 120 | .Dv OPENSSL_LOAD_CONF | 126 | .Dv OPENSSL_LOAD_CONF |
| 121 | #define'd, | 127 | #define'd, |
| @@ -135,7 +141,6 @@ standard configuration file | |||
| 135 | .Xr CONF_modules_free 3 , | 141 | .Xr CONF_modules_free 3 , |
| 136 | .Xr CONF_modules_load_file 3 , | 142 | .Xr CONF_modules_load_file 3 , |
| 137 | .Xr crypto 3 , | 143 | .Xr crypto 3 , |
| 138 | .Xr OPENSSL_init_crypto 3 , | ||
| 139 | .Xr OPENSSL_load_builtin_modules 3 , | 144 | .Xr OPENSSL_load_builtin_modules 3 , |
| 140 | .Xr OPENSSL_VERSION_NUMBER 3 , | 145 | .Xr OPENSSL_VERSION_NUMBER 3 , |
| 141 | .Xr openssl.cnf 5 , | 146 | .Xr openssl.cnf 5 , |
diff --git a/src/lib/libcrypto/man/OPENSSL_init_crypto.3 b/src/lib/libcrypto/man/OPENSSL_init_crypto.3 index 3a532550ae..e6dac13fed 100644 --- a/src/lib/libcrypto/man/OPENSSL_init_crypto.3 +++ b/src/lib/libcrypto/man/OPENSSL_init_crypto.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: OPENSSL_init_crypto.3,v 1.3 2018/03/23 23:18:17 schwarze Exp $ | 1 | .\" $OpenBSD: OPENSSL_init_crypto.3,v 1.4 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> | 2 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> |
| 3 | .\" | 3 | .\" |
| 4 | .\" Permission to use, copy, modify, and distribute this software for any | 4 | .\" Permission to use, copy, modify, and distribute this software for any |
| @@ -13,7 +13,7 @@ | |||
| 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 15 | .\" | 15 | .\" |
| 16 | .Dd $Mdocdate: March 23 2018 $ | 16 | .Dd $Mdocdate: June 14 2019 $ |
| 17 | .Dt OPENSSL_INIT_CRYPTO 3 | 17 | .Dt OPENSSL_INIT_CRYPTO 3 |
| 18 | .Os | 18 | .Os |
| 19 | .Sh NAME | 19 | .Sh NAME |
| @@ -27,10 +27,30 @@ | |||
| 27 | .Fa "const void *dummy" | 27 | .Fa "const void *dummy" |
| 28 | .Fc | 28 | .Fc |
| 29 | .Sh DESCRIPTION | 29 | .Sh DESCRIPTION |
| 30 | This function is deprecated. | ||
| 31 | It is never useful for any application program to call it explicitly. | ||
| 32 | The library automatically calls it internally with an | ||
| 33 | .Fa options | ||
| 34 | argument of 0 whenever needed. | ||
| 35 | It is safest to assume that any function may do so. | ||
| 36 | .Pp | ||
| 37 | To enable or disable the standard configuration file, instead use | ||
| 38 | .Xr OPENSSL_config 3 | ||
| 39 | or | ||
| 40 | .Xr OPENSSL_no_config 3 , | ||
| 41 | respectively. | ||
| 42 | To load a non-standard configuration file, refer to | ||
| 43 | .Xr CONF_modules_load_file 3 . | ||
| 44 | .Pp | ||
| 30 | If | 45 | If |
| 31 | .Fn OPENSSL_init_crypto | 46 | .Fn OPENSSL_init_crypto |
| 32 | is called before any other crypto or ssl functions, the crypto | 47 | is called before any other crypto or ssl functions, the crypto |
| 33 | library is initialised by allocating various internal resources. | 48 | library is initialised by allocating various internal resources, |
| 49 | in particular calling | ||
| 50 | .Xr ERR_load_crypto_strings 3 , | ||
| 51 | .Xr OpenSSL_add_all_ciphers 3 , | ||
| 52 | and | ||
| 53 | .Xr OpenSSL_add_all_digests 3 . | ||
| 34 | .Pp | 54 | .Pp |
| 35 | The following | 55 | The following |
| 36 | .Fa options | 56 | .Fa options |
| @@ -54,13 +74,6 @@ The | |||
| 54 | .Fa dummy | 74 | .Fa dummy |
| 55 | argument has no effect. | 75 | argument has no effect. |
| 56 | .Pp | 76 | .Pp |
| 57 | Calling this function is almost never useful because it is internally | ||
| 58 | called with an | ||
| 59 | .Fa options | ||
| 60 | argument of 0 by those functions in the crypto and ssl libraries | ||
| 61 | that require it. | ||
| 62 | It is safest to assume that any function may do so. | ||
| 63 | .Pp | ||
| 64 | If this function is called more than once, none of the calls except | 77 | If this function is called more than once, none of the calls except |
| 65 | the first one have any effect. | 78 | the first one have any effect. |
| 66 | .Sh RETURN VALUES | 79 | .Sh RETURN VALUES |
| @@ -69,7 +82,6 @@ is intended to return 1 on success or 0 on error. | |||
| 69 | .Sh SEE ALSO | 82 | .Sh SEE ALSO |
| 70 | .Xr CONF_modules_load_file 3 , | 83 | .Xr CONF_modules_load_file 3 , |
| 71 | .Xr OPENSSL_config 3 , | 84 | .Xr OPENSSL_config 3 , |
| 72 | .Xr OPENSSL_init_ssl 3 , | ||
| 73 | .Xr OPENSSL_load_builtin_modules 3 , | 85 | .Xr OPENSSL_load_builtin_modules 3 , |
| 74 | .Xr openssl.cnf 5 | 86 | .Xr openssl.cnf 5 |
| 75 | .Sh HISTORY | 87 | .Sh HISTORY |
diff --git a/src/lib/libcrypto/man/OPENSSL_load_builtin_modules.3 b/src/lib/libcrypto/man/OPENSSL_load_builtin_modules.3 index fd9e656bce..bcfb363ca4 100644 --- a/src/lib/libcrypto/man/OPENSSL_load_builtin_modules.3 +++ b/src/lib/libcrypto/man/OPENSSL_load_builtin_modules.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: OPENSSL_load_builtin_modules.3,v 1.5 2018/03/22 21:08:22 schwarze Exp $ | 1 | .\" $OpenBSD: OPENSSL_load_builtin_modules.3,v 1.6 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 |
| 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>. |
| @@ -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: March 22 2018 $ | 51 | .Dd $Mdocdate: June 14 2019 $ |
| 52 | .Dt OPENSSL_LOAD_BUILTIN_MODULES 3 | 52 | .Dt OPENSSL_LOAD_BUILTIN_MODULES 3 |
| 53 | .Os | 53 | .Os |
| 54 | .Sh NAME | 54 | .Sh NAME |
| @@ -83,19 +83,23 @@ is called then | |||
| 83 | .Fn OPENSSL_load_builtin_modules | 83 | .Fn OPENSSL_load_builtin_modules |
| 84 | is called automatically. | 84 | is called automatically. |
| 85 | .Pp | 85 | .Pp |
| 86 | Applications which use the configuration functions directly will need to | 86 | Applications which use configuration functions like |
| 87 | call | 87 | .Xr CONF_modules_load_file 3 |
| 88 | directly need to call | ||
| 88 | .Fn OPENSSL_load_builtin_modules | 89 | .Fn OPENSSL_load_builtin_modules |
| 89 | themselves | 90 | themselves |
| 90 | .Em before | 91 | .Em before |
| 91 | any other configuration code. | 92 | any other configuration code. |
| 92 | .Pp | 93 | .Pp |
| 93 | Applications should call | 94 | Applications should call |
| 95 | .Xr OPENSSL_config 3 | ||
| 96 | or | ||
| 94 | .Fn OPENSSL_load_builtin_modules | 97 | .Fn OPENSSL_load_builtin_modules |
| 95 | to load all configuration modules instead of adding modules selectively: | 98 | to load all configuration modules instead of adding modules selectively: |
| 96 | otherwise functionality may be missing from the application when | 99 | otherwise functionality may be missing from the application when |
| 97 | new modules are added. | 100 | new modules are added. |
| 98 | .Sh SEE ALSO | 101 | .Sh SEE ALSO |
| 102 | .Xr CONF_modules_load_file 3 , | ||
| 99 | .Xr OPENSSL_config 3 | 103 | .Xr OPENSSL_config 3 |
| 100 | .Sh HISTORY | 104 | .Sh HISTORY |
| 101 | These functions first appeared in OpenSSL 0.9.7 | 105 | These functions first appeared in OpenSSL 0.9.7 |
diff --git a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 index aa884d8eff..9ef19e7163 100644 --- a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 +++ b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.7 2018/03/27 17:35:50 schwarze Exp $ | 1 | .\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.8 2019/06/14 13:41:31 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 was written by Dr. Stephen Henson <steve@openssl.org>. |
| @@ -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: March 27 2018 $ | 51 | .Dd $Mdocdate: June 14 2019 $ |
| 52 | .Dt OPENSSL_ADD_ALL_ALGORITHMS 3 | 52 | .Dt OPENSSL_ADD_ALL_ALGORITHMS 3 |
| 53 | .Os | 53 | .Os |
| 54 | .Sh NAME | 54 | .Sh NAME |
| @@ -79,6 +79,13 @@ It uses this table to look up ciphers via functions such as | |||
| 79 | .Pp | 79 | .Pp |
| 80 | .Fn OpenSSL_add_all_algorithms | 80 | .Fn OpenSSL_add_all_algorithms |
| 81 | adds all algorithms to the table (digests and ciphers). | 81 | adds all algorithms to the table (digests and ciphers). |
| 82 | If an application is compiled with the preprocessor symbol | ||
| 83 | .Dv OPENSSL_LOAD_CONF | ||
| 84 | #define'd, it also calls | ||
| 85 | .Xr OPENSSL_config 3 | ||
| 86 | with a | ||
| 87 | .Dv NULL | ||
| 88 | argument, loading the default configuration file. | ||
| 82 | .Pp | 89 | .Pp |
| 83 | .Fn OpenSSL_add_all_digests | 90 | .Fn OpenSSL_add_all_digests |
| 84 | adds all digest algorithms to the table. | 91 | adds all digest algorithms to the table. |
| @@ -96,8 +103,7 @@ removes all ciphers and digests from the table. | |||
| 96 | .Xr evp 3 , | 103 | .Xr evp 3 , |
| 97 | .Xr EVP_DigestInit 3 , | 104 | .Xr EVP_DigestInit 3 , |
| 98 | .Xr EVP_EncryptInit 3 , | 105 | .Xr EVP_EncryptInit 3 , |
| 99 | .Xr OPENSSL_config 3 , | 106 | .Xr OPENSSL_config 3 |
| 100 | .Xr OPENSSL_init_crypto 3 | ||
| 101 | .Sh HISTORY | 107 | .Sh HISTORY |
| 102 | .Fn EVP_cleanup | 108 | .Fn EVP_cleanup |
| 103 | and precursor functions | 109 | and precursor functions |
diff --git a/src/lib/libssl/man/OPENSSL_init_ssl.3 b/src/lib/libssl/man/OPENSSL_init_ssl.3 index 5c9f51fe49..f37dccfaac 100644 --- a/src/lib/libssl/man/OPENSSL_init_ssl.3 +++ b/src/lib/libssl/man/OPENSSL_init_ssl.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: OPENSSL_init_ssl.3,v 1.3 2019/06/12 09:36:30 schwarze Exp $ | 1 | .\" $OpenBSD: OPENSSL_init_ssl.3,v 1.4 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> | 2 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> |
| 3 | .\" | 3 | .\" |
| 4 | .\" Permission to use, copy, modify, and distribute this software for any | 4 | .\" Permission to use, copy, modify, and distribute this software for any |
| @@ -13,7 +13,7 @@ | |||
| 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 15 | .\" | 15 | .\" |
| 16 | .Dd $Mdocdate: June 12 2019 $ | 16 | .Dd $Mdocdate: June 14 2019 $ |
| 17 | .Dt OPENSSL_INIT_SSL 3 | 17 | .Dt OPENSSL_INIT_SSL 3 |
| 18 | .Os | 18 | .Os |
| 19 | .Sh NAME | 19 | .Sh NAME |
| @@ -27,13 +27,27 @@ | |||
| 27 | .Fa "const void *dummy" | 27 | .Fa "const void *dummy" |
| 28 | .Fc | 28 | .Fc |
| 29 | .Sh DESCRIPTION | 29 | .Sh DESCRIPTION |
| 30 | This function is deprecated. | ||
| 31 | It is never useful for any application program to call it explicitly. | ||
| 32 | The library automatically calls it internally with an | ||
| 33 | .Fa options | ||
| 34 | argument of 0 whenever needed. | ||
| 35 | It is safest to assume that any function may do so. | ||
| 36 | .Pp | ||
| 37 | To enable or disable the standard configuration file, instead use | ||
| 38 | .Xr OPENSSL_config 3 | ||
| 39 | or | ||
| 40 | .Xr OPENSSL_no_config 3 , | ||
| 41 | respectively. | ||
| 42 | To load a non-standard configuration file, refer to | ||
| 43 | .Xr CONF_modules_load_file 3 . | ||
| 44 | .Pp | ||
| 30 | .Fn OPENSSL_init_ssl | 45 | .Fn OPENSSL_init_ssl |
| 31 | calls | 46 | calls |
| 32 | .Xr OPENSSL_init_crypto 3 | 47 | .Xr OPENSSL_init_crypto 3 , |
| 33 | and also allocates various resources used internally by the ssl library. | 48 | .Xr SSL_load_error_strings 3 , |
| 34 | .Pp | 49 | and |
| 35 | Calling it is never useful because it is automatically called | 50 | .Xr SSL_library_init 3 . |
| 36 | internally when needed. | ||
| 37 | .Pp | 51 | .Pp |
| 38 | The | 52 | The |
| 39 | .Fa options | 53 | .Fa options |
| @@ -50,7 +64,7 @@ none of the calls except the first one have any effect. | |||
| 50 | is intended to return 1 on success or 0 on error. | 64 | is intended to return 1 on success or 0 on error. |
| 51 | .Sh SEE ALSO | 65 | .Sh SEE ALSO |
| 52 | .Xr CONF_modules_load_file 3 , | 66 | .Xr CONF_modules_load_file 3 , |
| 53 | .Xr OPENSSL_init_crypto 3 , | 67 | .Xr OPENSSL_config 3 , |
| 54 | .Xr ssl 3 | 68 | .Xr ssl 3 |
| 55 | .Sh HISTORY | 69 | .Sh HISTORY |
| 56 | .Fn OPENSSL_init_ssl | 70 | .Fn OPENSSL_init_ssl |
diff --git a/src/lib/libssl/man/SSL_library_init.3 b/src/lib/libssl/man/SSL_library_init.3 index 42f19adc28..053c1e6fcb 100644 --- a/src/lib/libssl/man/SSL_library_init.3 +++ b/src/lib/libssl/man/SSL_library_init.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: SSL_library_init.3,v 1.6 2018/03/27 17:35:50 schwarze Exp $ | 1 | .\" $OpenBSD: SSL_library_init.3,v 1.7 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. | 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. |
| @@ -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: March 27 2018 $ | 51 | .Dd $Mdocdate: June 14 2019 $ |
| 52 | .Dt SSL_LIBRARY_INIT 3 | 52 | .Dt SSL_LIBRARY_INIT 3 |
| 53 | .Os | 53 | .Os |
| 54 | .Sh NAME | 54 | .Sh NAME |
| @@ -65,8 +65,13 @@ | |||
| 65 | .Ft int | 65 | .Ft int |
| 66 | .Fn SSLeay_add_ssl_algorithms void | 66 | .Fn SSLeay_add_ssl_algorithms void |
| 67 | .Sh DESCRIPTION | 67 | .Sh DESCRIPTION |
| 68 | These functions are deprecated. | ||
| 69 | It is never useful for any application program to call any of them explicitly. | ||
| 70 | The library automatically calls them internally whenever needed. | ||
| 71 | .Pp | ||
| 68 | .Fn SSL_library_init | 72 | .Fn SSL_library_init |
| 69 | registers the available SSL/TLS ciphers and digests. | 73 | registers the available ciphers and digests |
| 74 | which are used directly or indirectly by TLS. | ||
| 70 | .Pp | 75 | .Pp |
| 71 | .Fn OpenSSL_add_ssl_algorithms | 76 | .Fn OpenSSL_add_ssl_algorithms |
| 72 | and | 77 | and |
| @@ -74,28 +79,11 @@ and | |||
| 74 | are synonyms for | 79 | are synonyms for |
| 75 | .Fn SSL_library_init | 80 | .Fn SSL_library_init |
| 76 | and are implemented as macros. | 81 | and are implemented as macros. |
| 77 | .Pp | ||
| 78 | .Fn SSL_library_init | ||
| 79 | must be called before any other action takes place. | ||
| 80 | .Fn SSL_library_init | ||
| 81 | is not reentrant. | ||
| 82 | .Pp | ||
| 83 | .Fn SSL_library_init | ||
| 84 | adds ciphers and digests used directly and indirectly by SSL/TLS. | ||
| 85 | .Sh RETURN VALUES | 82 | .Sh RETURN VALUES |
| 86 | .Fn SSL_library_init | 83 | .Fn SSL_library_init |
| 87 | always returns 1, so it is safe to discard the return value. | 84 | always returns 1. |
| 88 | .Sh EXAMPLES | ||
| 89 | A typical TLS/SSL application will start with the library initialization, and | ||
| 90 | provide readable error messages. | ||
| 91 | .Bd -literal | ||
| 92 | SSL_load_error_strings(); /* readable error messages */ | ||
| 93 | SSL_library_init(); /* initialize library */ | ||
| 94 | .Ed | ||
| 95 | .Sh SEE ALSO | 85 | .Sh SEE ALSO |
| 96 | .Xr RAND_add 3 , | 86 | .Xr ssl 3 |
| 97 | .Xr ssl 3 , | ||
| 98 | .Xr SSL_load_error_strings 3 | ||
| 99 | .Sh HISTORY | 87 | .Sh HISTORY |
| 100 | .Fn SSLeay_add_ssl_algorithms | 88 | .Fn SSLeay_add_ssl_algorithms |
| 101 | first appeared in SSLeay 0.8.0 and has been available since | 89 | first appeared in SSLeay 0.8.0 and has been available since |
diff --git a/src/lib/libssl/man/ssl.3 b/src/lib/libssl/man/ssl.3 index 7683599652..6e7914c8b4 100644 --- a/src/lib/libssl/man/ssl.3 +++ b/src/lib/libssl/man/ssl.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: ssl.3,v 1.16 2019/06/12 09:03:43 schwarze Exp $ | 1 | .\" $OpenBSD: ssl.3,v 1.17 2019/06/14 13:41:31 schwarze Exp $ |
| 2 | .\" full merge up to: OpenSSL e330f55d Nov 11 00:51:04 2016 +0100 | 2 | .\" full merge up to: OpenSSL e330f55d Nov 11 00:51:04 2016 +0100 |
| 3 | .\" selective merge up to: OpenSSL cbade361 Dec 12 13:14:45 2017 +0100 | 3 | .\" selective merge up to: OpenSSL cbade361 Dec 12 13:14:45 2017 +0100 |
| 4 | .\" | 4 | .\" |
| @@ -51,7 +51,7 @@ | |||
| 51 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 51 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 52 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 52 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 53 | .\" | 53 | .\" |
| 54 | .Dd $Mdocdate: June 12 2019 $ | 54 | .Dd $Mdocdate: June 14 2019 $ |
| 55 | .Dt SSL 3 | 55 | .Dt SSL 3 |
| 56 | .Os | 56 | .Os |
| 57 | .Sh NAME | 57 | .Sh NAME |
| @@ -62,10 +62,7 @@ The OpenSSL | |||
| 62 | .Nm ssl | 62 | .Nm ssl |
| 63 | library implements the Transport Layer Security (TLS v1) protocols. | 63 | library implements the Transport Layer Security (TLS v1) protocols. |
| 64 | .Pp | 64 | .Pp |
| 65 | At first the library must be initialized; see | 65 | An |
| 66 | .Xr SSL_library_init 3 . | ||
| 67 | .Pp | ||
| 68 | Then an | ||
| 69 | .Vt SSL_CTX | 66 | .Vt SSL_CTX |
| 70 | object is created as a framework to establish TLS/SSL enabled connections (see | 67 | object is created as a framework to establish TLS/SSL enabled connections (see |
| 71 | .Xr SSL_CTX_new 3 ) . | 68 | .Xr SSL_CTX_new 3 ) . |
| @@ -354,11 +351,12 @@ To inspect the state during ongoing communication: | |||
| 354 | .Xr OPENSSL_init_ssl 3 , | 351 | .Xr OPENSSL_init_ssl 3 , |
| 355 | .Xr SSL_COMP_add_compression_method 3 , | 352 | .Xr SSL_COMP_add_compression_method 3 , |
| 356 | .Xr SSL_CTX_set_tmp_rsa_callback 3 , | 353 | .Xr SSL_CTX_set_tmp_rsa_callback 3 , |
| 354 | .Xr SSL_library_init 3 , | ||
| 357 | .Xr SSL_set_tmp_ecdh 3 | 355 | .Xr SSL_set_tmp_ecdh 3 |
| 358 | .Sh SEE ALSO | 356 | .Sh SEE ALSO |
| 359 | .Xr openssl 1 , | 357 | .Xr openssl 1 , |
| 360 | .Xr crypto 3 , | 358 | .Xr crypto 3 , |
| 361 | .Xr SSL_load_error_strings 3 | 359 | .Xr tls_init 3 |
| 362 | .Sh HISTORY | 360 | .Sh HISTORY |
| 363 | The | 361 | The |
| 364 | .Nm | 362 | .Nm |
