diff options
author | Matt Caswell <matt@openssl.org> | 2016-04-04 15:49:21 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2016-04-13 08:52:33 +0100 |
commit | 7b8cc9b3458ec3f18b4d4d9ca2a72b6b3e3744c8 (patch) | |
tree | da9131b97fb33b3ae50e5d79665a8bdef5eee16c /doc/crypto | |
parent | 22c84afa773559279af928652a2d9f3489cc7d73 (diff) |
Deprecate OBJ_cleanup() and make it a no-op
OBJ_cleanup() should not be called expicitly - we should leave
auto-deinit to clean this up instead.
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/crypto')
-rw-r--r-- | doc/crypto/OBJ_nid2obj.pod | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/crypto/OBJ_nid2obj.pod b/doc/crypto/OBJ_nid2obj.pod index b2b815db65..2db96a132f 100644 --- a/doc/crypto/OBJ_nid2obj.pod +++ b/doc/crypto/OBJ_nid2obj.pod @@ -27,11 +27,16 @@ functions ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o); int OBJ_create(const char *oid,const char *sn,const char *ln); - void OBJ_cleanup(void); size_t OBJ_length(const ASN1_OBJECT *obj); const unsigned char *OBJ_get0_data(const ASN1_OBJECT *obj); +Deprecated: + + #if OPENSSL_API_COMPAT < 0x10100000L + # define OBJ_cleanup() + #endif + =head1 DESCRIPTION The ASN1 object utility functions process ASN1_OBJECT structures which are @@ -69,15 +74,17 @@ OBJ_create() adds a new object to the internal table. B<oid> is the numerical form of the object, B<sn> the short name and B<ln> the long name. A new NID is returned for the created object. -OBJ_cleanup() cleans up OpenSSLs internal object table: this should -be called before an application exits if any new objects were added -using OBJ_create(). - OBJ_length() returns the size of the content octets of B<obj>. OBJ_get0_data() returns a pointer to the content octets of B<obj>. The returned pointer is an internal pointer which B<must not> be freed. +In OpenSSL versions prior to 1.1.0 OBJ_cleanup() cleaned up OpenSSLs internal +object table and was called before an application exits if any new objects were +added using OBJ_create(). This function is deprecated in version 1.1.0 and now +does nothing if called. No explicit de-initialisation is now required. See +L<OPENSSL_init_crypto(3)> for further information. + =head1 NOTES Objects in OpenSSL can have a short name, a long name and a numerical @@ -160,6 +167,6 @@ L<ERR_get_error(3)> =head1 HISTORY -TBA +OBJ_cleanup() was deprecated in OpenSSL 1.1.0. =cut |