From 1d5099dec648ba1d4f5cca6596dac5c7e2037560 Mon Sep 17 00:00:00 2001 From: Matt Caswell Date: Wed, 6 Apr 2016 11:13:25 +0100 Subject: [PATCH] Misc fix ups to deprecate explicit de-init documentation Documentation fix ups as a result of feedback received. Reviewed-by: Tim Hudson Reviewed-by: Richard Levitte --- doc/crypto/CONF_modules_free.pod | 8 ++--- doc/crypto/ERR_load_crypto_strings.pod | 11 +++---- doc/crypto/OBJ_nid2obj.pod | 2 +- doc/crypto/OpenSSL_add_all_algorithms.pod | 34 +++++---------------- doc/crypto/RAND_cleanup.pod | 2 +- doc/crypto/engine.pod | 4 +-- doc/crypto/err.pod | 2 +- doc/crypto/rand.pod | 2 +- doc/ssl/SSL_COMP_add_compression_method.pod | 2 +- 9 files changed, 22 insertions(+), 45 deletions(-) diff --git a/doc/crypto/CONF_modules_free.pod b/doc/crypto/CONF_modules_free.pod index 12e594dace..4a8580c40b 100644 --- a/doc/crypto/CONF_modules_free.pod +++ b/doc/crypto/CONF_modules_free.pod @@ -15,7 +15,7 @@ Deprecated: #if OPENSSL_API_COMPAT < 0x10100000L - # define CONF_modules_free() + void CONF_modules_free(void) #endif =head1 DESCRIPTION @@ -33,9 +33,9 @@ B is B<1> all modules, including builtin modules will be unloaded. =head1 NOTES Normally in versions of OpenSSL prior to 1.1.0 applications will only call -CONF_modules_free() at application to tidy up any configuration performed. From -1.1.0 CONF_modules_free() is deprecated an no explicit CONF cleanup as required -at all. For more information see L. +CONF_modules_free() at application exit to tidy up any configuration performed. +From 1.1.0 CONF_modules_free() is deprecated and no explicit CONF cleanup is +required at all. For more information see L. =head1 RETURN VALUE diff --git a/doc/crypto/ERR_load_crypto_strings.pod b/doc/crypto/ERR_load_crypto_strings.pod index 9e960d94c9..68c006fd3c 100644 --- a/doc/crypto/ERR_load_crypto_strings.pod +++ b/doc/crypto/ERR_load_crypto_strings.pod @@ -12,19 +12,16 @@ Deprecated: #include #if OPENSSL_API_COMPAT < 0x10100000L - # define ERR_load_crypto_strings() \ - OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL) - # define ERR_free_strings() + void ERR_load_crypto_strings(void); + void ERR_free_strings(void); #endif #include #if OPENSSL_API_COMPAT < 0x10100000L - # define SSL_load_error_strings() \ - OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \ - | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL) + void SSL_load_error_strings(void); #endif - + =head1 DESCRIPTION All of the following functions are deprecated from OpenSSL 1.1.0. No explicit diff --git a/doc/crypto/OBJ_nid2obj.pod b/doc/crypto/OBJ_nid2obj.pod index 2db96a132f..d777d7ca53 100644 --- a/doc/crypto/OBJ_nid2obj.pod +++ b/doc/crypto/OBJ_nid2obj.pod @@ -34,7 +34,7 @@ functions Deprecated: #if OPENSSL_API_COMPAT < 0x10100000L - # define OBJ_cleanup() + void OBJ_cleanup(void) #endif =head1 DESCRIPTION diff --git a/doc/crypto/OpenSSL_add_all_algorithms.pod b/doc/crypto/OpenSSL_add_all_algorithms.pod index 78fe12aa3f..10f3b8fbab 100644 --- a/doc/crypto/OpenSSL_add_all_algorithms.pod +++ b/doc/crypto/OpenSSL_add_all_algorithms.pod @@ -12,31 +12,11 @@ add algorithms to internal table Deprecated: # if OPENSSL_API_COMPAT < 0x10100000L - # define OPENSSL_add_all_algorithms_conf() \ - OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \ - | OPENSSL_INIT_ADD_ALL_DIGESTS \ - | OPENSSL_INIT_LOAD_CONFIG, NULL) - # define OPENSSL_add_all_algorithms_noconf() \ - OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \ - | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL) - - # ifdef OPENSSL_LOAD_CONF - # define OpenSSL_add_all_algorithms() \ - OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \ - | OPENSSL_INIT_ADD_ALL_DIGESTS \ - | OPENSSL_INIT_LOAD_CONFIG, NULL) - # else - # define OpenSSL_add_all_algorithms() \ - OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \ - | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL) - # endif - - # define OpenSSL_add_all_ciphers() \ - OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS, NULL) - # define OpenSSL_add_all_digests() \ - OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_DIGESTS, NULL) - - # define EVP_cleanup() + void OpenSSL_add_all_algorithms(void); + void OpenSSL_add_all_ciphers(void); + void OpenSSL_add_all_digests(void); + + void EVP_cleanup(void) # endif =head1 DESCRIPTION @@ -44,8 +24,8 @@ Deprecated: OpenSSL keeps an internal table of digest algorithms and ciphers. It uses this table to lookup ciphers via functions such as EVP_get_cipher_byname(). In OpenSSL versions prior to 1.1.0 these functions initialised and de-initialised -this table. From OpenSSL 1.1.0 are deprecated. No explicit initialisation or -de-initialisation is required. See L for further +this table. From OpenSSL 1.1.0 they are deprecated. No explicit initialisation +or de-initialisation is required. See L for further information. OpenSSL_add_all_digests() adds all digest algorithms to the table. diff --git a/doc/crypto/RAND_cleanup.pod b/doc/crypto/RAND_cleanup.pod index b5c43eab36..fd3f81c5f6 100644 --- a/doc/crypto/RAND_cleanup.pod +++ b/doc/crypto/RAND_cleanup.pod @@ -9,7 +9,7 @@ RAND_cleanup - erase the PRNG state #include #if OPENSSL_API_COMPAT < 0x10100000L - # define RAND_cleanup() + void RAND_cleanup(void) #endif =head1 DESCRIPTION diff --git a/doc/crypto/engine.pod b/doc/crypto/engine.pod index cb9308df83..8d1b3dfc31 100644 --- a/doc/crypto/engine.pod +++ b/doc/crypto/engine.pod @@ -135,7 +135,7 @@ engine - ENGINE cryptographic module support Deprecated: #if OPENSSL_API_COMPAT < 0x10100000L - # define ENGINE_cleanup() + void ENGINE_cleanup(void) #endif =head1 DESCRIPTION @@ -304,7 +304,7 @@ dynamically allocated and populated with these implementations and linked into OpenSSL's internal linked list. At this point it is important to mention an important API function; - ENGINE_cleanup() + void ENGINE_cleanup(void) If no ENGINE API functions are called at all in an application, then there are no inherent memory leaks to worry about from the ENGINE functionality. diff --git a/doc/crypto/err.pod b/doc/crypto/err.pod index 0313aa38b8..33cb19d0cf 100644 --- a/doc/crypto/err.pod +++ b/doc/crypto/err.pod @@ -49,7 +49,7 @@ Deprecated: #endif #if OPENSSL_API_COMPAT < 0x10100000L - # define ERR_free_strings() + void ERR_free_strings(void) #endif diff --git a/doc/crypto/rand.pod b/doc/crypto/rand.pod index 7d9605011b..46de8f775a 100644 --- a/doc/crypto/rand.pod +++ b/doc/crypto/rand.pod @@ -34,7 +34,7 @@ rand - pseudo-random number generator Deprecated: #if OPENSSL_API_COMPAT < 0x10100000L - # define RAND_cleanup() + void RAND_cleanup(void) #endif =head1 DESCRIPTION diff --git a/doc/ssl/SSL_COMP_add_compression_method.pod b/doc/ssl/SSL_COMP_add_compression_method.pod index b08a4247cc..fe10e1b45d 100644 --- a/doc/ssl/SSL_COMP_add_compression_method.pod +++ b/doc/ssl/SSL_COMP_add_compression_method.pod @@ -13,7 +13,7 @@ SSL_COMP_add_compression_method, SSL_COMP_free_compression_methods - handle SSL/ Deprecated: #if OPENSSL_API_COMPAT < 0x10100000L - # define SSL_COMP_free_compression_methods() + void SSL_COMP_free_compression_methods(void) #endif =head1 DESCRIPTION -- 2.34.1