Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_free (3openssl)

Name

SSL_free - free an allocated SSL structure

Synopsis

#include <openssl/ssl.h>

void SSL_free(SSL *ssl);

Description

SSL_free(3openssl)                  OpenSSL                 SSL_free(3openssl)



NAME
       SSL_free - free an allocated SSL structure

SYNOPSIS
        #include <openssl/ssl.h>

        void SSL_free(SSL *ssl);

DESCRIPTION
       SSL_free() decrements the reference count of ssl, and removes the SSL
       structure pointed to by ssl and frees up the allocated memory if the
       reference count has reached 0.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

NOTES
       SSL_free() also calls the free()ing procedures for indirectly affected
       items, if applicable: the buffering BIO, the read and write BIOs,
       cipher lists specially created for this ssl, the SSL_SESSION.  Do not
       explicitly free these indirectly freed up items before or after calling
       SSL_free(), as trying to free things twice may lead to program failure.

       The ssl session has reference counts from two users: the SSL object,
       for which the reference count is removed by SSL_free() and the internal
       session cache. If the session is considered bad, because
       SSL_shutdown(3) was not called for the connection and
       SSL_set_shutdown(3) was not used to set the SSL_SENT_SHUTDOWN state,
       the session will also be removed from the session cache as required by
       RFC2246.

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.

RETURN VALUES
       SSL_free() does not provide diagnostic information.

       SSL_new(3), SSL_clear(3), SSL_shutdown(3), SSL_set_shutdown(3), ssl(3)




1.0.2ze                           2022-05-03                SSL_free(3openssl)