diff options
author | Matt Caswell <matt@openssl.org> | 2016-02-09 13:12:34 +0000 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2016-02-09 15:12:02 +0000 |
commit | 35d8fa563c9abc80c6e8d87396ab48dbd1a4c78d (patch) | |
tree | c9607dad528f347acd79d322e4d4b88dbc115c7a /doc | |
parent | 722cba232150ff4d7c3ea5cae0d1e90e38a5d7d3 (diff) |
Updates for auto init/deinit review comments
Fixes for the auto-init/deinit code based on review comments
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/crypto/OPENSSL_INIT_crypto_library_start.pod | 17 | ||||
-rw-r--r-- | doc/ssl/OPENSSL_INIT_ssl_library_start.pod | 12 |
2 files changed, 16 insertions, 13 deletions
diff --git a/doc/crypto/OPENSSL_INIT_crypto_library_start.pod b/doc/crypto/OPENSSL_INIT_crypto_library_start.pod index bea0e62f93..16f95fe604 100644 --- a/doc/crypto/OPENSSL_INIT_crypto_library_start.pod +++ b/doc/crypto/OPENSSL_INIT_crypto_library_start.pod @@ -2,7 +2,7 @@ =head1 NAME -OPENSSL_INIT_library_stop, OPENSSL_INIT_crypto_library_start, +OPENSSL_INIT_crypto_library_start, OPENSSL_INIT_library_stop, OPENSSL_INIT_register_stop_handler, OPENSSL_INIT_thread_stop - OpenSSL initialisation and deinitialisation functions @@ -32,10 +32,12 @@ However, there way be situations when explicit initialisation is desirable or needed, for example when some non-default initialisation is required. The function OPENSSL_INIT_crypto_library_start() can be used for this purpose for libcrypto (see also L<OPENSSL_INIT_ssl_library_start(3)> for the libssl -equivalent). In order to perform non-default initialisation it MUST be called -prior to any other calls of this function. As numerous internal OpenSSL -functions also call this, this usually means you should call it prior to ANY -other OpenSSL function calls. +equivalent). + +Numerous internal OpenSSL functions call OPENSSL_INIT_crypto_library_start(). +Therefore, in order to perform non-default initialisation, +OPENSSL_INIT_crypto_library_start() MUST be called by application code prior to +any other OpenSSL function calls. The B<opts> parameter specifies which aspects of libcrypto should be initialised. Valid options are: @@ -166,8 +168,7 @@ configuration file is assumed. For example { OPENSSL_INIT_SET_CONF_FILENAME, .value.type_string = "myconf.cnf" }, { OPENSSL_INIT_SET_END, .value.type_int = 0 } }; - OPENSSL_INIT_crypto_library_start(OPENSSL_INIT_LOAD_CONFIG, - (const OPENSSL_INIT_SETTINGS *)&settings); + OPENSSL_INIT_crypto_library_start(OPENSSL_INIT_LOAD_CONFIG, settings); The B<settings> parameter must be an array of OPENSSL_INIT_SETTINGS values terminated with an OPENSSL_INIT_SET_END entry. @@ -221,6 +222,6 @@ L<OPENSSL_INIT_ssl_library_start(3)> The OPENSSL_INIT_library_stop, OPENSSL_INIT_crypto_library_start, OPENSSL_INIT_register_stop_handler and OPENSSL_INIT_thread_stop functions were -first added in OpenSSL 1.1.0. +added in OpenSSL 1.1.0. =cut diff --git a/doc/ssl/OPENSSL_INIT_ssl_library_start.pod b/doc/ssl/OPENSSL_INIT_ssl_library_start.pod index bcd39127f7..c0f598df30 100644 --- a/doc/ssl/OPENSSL_INIT_ssl_library_start.pod +++ b/doc/ssl/OPENSSL_INIT_ssl_library_start.pod @@ -28,10 +28,12 @@ needed, for example when some non-default initialisation is required. The function OPENSSL_INIT_ssl_library_start() can be used for this purpose. Calling this function will explicitly initialise BOTH libcrypto and libssl. To explicitly initialise ONLY libcrypto see the -L<OPENSSL_INIT_crypto_library_start(3)> function. In order to perform -non-default initialisation it MUST be called prior to any other calls of this -function. As numerous internal OpenSSL functions also call this, this usually -means you should call it prior to ANY other OpenSSL function calls. +L<OPENSSL_INIT_crypto_library_start(3)> function. + +Numerous internal OpenSSL functions call OPENSSL_INIT_ssl_library_start(). +Therefore, in order to perform non-default initialisation, +OPENSSL_INIT_ssl_library_start() MUST be called by application code prior to +any other OpenSSL function calls. The B<opts> parameter specifies which aspects of libssl and libcrypto should be initialised. Valid options for libcrypto are described on the @@ -73,6 +75,6 @@ L<OPENSSL_INIT_crypto_library_start(3)> =head1 HISTORY -The OPENSSL_INIT_ssl_library_start function was first added in OpenSSL 1.1.0. +The OPENSSL_INIT_ssl_library_start function was added in OpenSSL 1.1.0. =cut |