Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_set_session (3openssl)

Name

SSL_set_session - set a TLS/SSL session to be used during TLS/SSL connect

Synopsis

#include <openssl/ssl.h>

int SSL_set_session(SSL *ssl, SSL_SESSION *session);

Description

SSL_set_session(3openssl)           OpenSSL          SSL_set_session(3openssl)



NAME
       SSL_set_session - set a TLS/SSL session to be used during TLS/SSL
       connect

SYNOPSIS
        #include <openssl/ssl.h>

        int SSL_set_session(SSL *ssl, SSL_SESSION *session);

DESCRIPTION
       SSL_set_session() sets session to be used when the TLS/SSL connection
       is to be established. SSL_set_session() is only useful for TLS/SSL
       clients.  When the session is set, the reference count of session is
       incremented by 1. If the session is not reused, the reference count is
       decremented again during SSL_connect(). Whether the session was reused
       can be queried with the SSL_session_reused(3) call.

       If there is already a session set inside ssl (because it was set with
       SSL_set_session() before or because the same ssl was already used for a
       connection), SSL_SESSION_free() will be called for that session.


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


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

NOTES
       SSL_SESSION objects keep internal link information about the session
       cache list, when being inserted into one SSL_CTX object's session
       cache.  One SSL_SESSION object, regardless of its reference count, must
       therefore only be used with one SSL_CTX object (and the SSL objects
       created from this SSL_CTX object).

       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
       The following return values can occur:

       0   The operation failed; check the error stack to find out the reason.

       1   The operation succeeded.

SEE ALSO
       ssl(3), SSL_SESSION_free(3), SSL_get_session(3), SSL_session_reused(3),
       SSL_CTX_set_session_cache_mode(3)




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