diff options
| author | Matt Caswell <matt@openssl.org> | 2016-02-10 16:17:01 +0000 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-02-10 17:40:59 +0000 |
| commit | 9cc55ddda5bbfde2e98fb94f312b960ab11a8c60 (patch) | |
| tree | 76a0b70c6d61ac934ac16d64ac0dc3be89ba88fe /doc | |
| parent | 068f07fe759856435b880c9c1a3bdcff62142c84 (diff) | |
Add some documentation about init after deinit
Attempting to init after deinit is an error. Update the documentation
accordingly.
Reviewed-by: Rich Salz <rsalz@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/crypto/OPENSSL_init_crypto.pod | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/crypto/OPENSSL_init_crypto.pod b/doc/crypto/OPENSSL_init_crypto.pod index 67c84913cd..943f44c253 100644 --- a/doc/crypto/OPENSSL_init_crypto.pod +++ b/doc/crypto/OPENSSL_init_crypto.pod @@ -146,14 +146,14 @@ engines. This not a default option. =back Multiple options may be combined together in a single call to -OPENSSL_INIT_start_library(). For example: +OPENSSL_init_crypto(). For example: - OPENSSL_INIT_start_library(OPENSSL_INIT_NO_ADD_ALL_CIPHERS - | OPENSSL_INIT_NO_ADD_ALL_DIGESTS, NULL); + OPENSSL_init_crypto(OPENSSL_INIT_NO_ADD_ALL_CIPHERS + | OPENSSL_INIT_NO_ADD_ALL_DIGESTS, NULL); -The B<settings> parameter to OPENSSL_INIT_start_library() may be used to -provide optional settings values to an option. Currently the only option this +The B<settings> parameter to OPENSSL_init_crypto() may be used to provide +optional settings values to an option. Currently the only option this applies to is OPENSSL_INIT_LOAD_CONFIG. This provides the optional OPENSSL_INIT_SET_CONF_FILENAME parameter to provide a filename to load configuration from. If no filename is provided then the system default @@ -180,6 +180,13 @@ on auto-deinitialisation. This is to avoid error conditions where both an application and a library it depends on both use OpenSSL, and the library deinitialises it before the application has finished using it. +Once OPENSSL_cleanup() has been called the library cannot be reinitialised. +Attempts to call OPENSSL_init_crypto() will fail and an ERR_R_INIT_FAIL error +will be added to the error stack. Note that because initialisation has failed +OpenSSL error strings will not be available, only an error code. This code can +be put through the openssl errstr command line application to produce a human +readable error (see L<errstr(1)>). + The OPENSSL_atexit() function enables the registration of a function to be called during OPENSSL_cleanup(). Stop handlers are called after deinitialisation of resources local to a thread, but before other |