Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_CTX_set_timeout (3openssl)

Name

SSL_CTX_set_timeout - manipulate timeout values for session caching

Synopsis

#include <openssl/ssl.h>

long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
long SSL_CTX_get_timeout(SSL_CTX *ctx);

Description

OpenSSL                                          SSL_CTX_set_timeout(3openssl)



NAME
       SSL_CTX_set_timeout, SSL_CTX_get_timeout - manipulate timeout values
       for session caching

SYNOPSIS
        #include <openssl/ssl.h>

        long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
        long SSL_CTX_get_timeout(SSL_CTX *ctx);

DESCRIPTION
       SSL_CTX_set_timeout() sets the timeout for newly created sessions for
       ctx to t. The timeout value t must be given in seconds.

       SSL_CTX_get_timeout() returns the currently set timeout value for ctx.


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


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

NOTES
       Whenever a new session is created, it is assigned a maximum lifetime.
       This lifetime is specified by storing the creation time of the session
       and the timeout value valid at this time. If the actual time is later
       than creation time plus timeout, the session is not reused.

       Due to this realization, all sessions behave according to the timeout
       value valid at the time of the session negotiation. Changes of the
       timeout value do not affect already established sessions.

       The expiration time of a single session can be modified using the
       SSL_SESSION_get_time(3) family of functions.

       Expired sessions are removed from the internal session cache, whenever
       SSL_CTX_flush_sessions(3) is called, either directly by the application
       or automatically (see SSL_CTX_set_session_cache_mode(3))

       The default value for session timeout is decided on a per protocol
       basis, see SSL_get_default_timeout(3).  All currently supported
       protocols have the same default timeout value of 300 seconds.

       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_CTX_set_timeout() returns the previously set timeout value.

       SSL_CTX_get_timeout() returns the currently set timeout value.

SEE ALSO
       ssl(3), SSL_CTX_set_session_cache_mode(3), SSL_SESSION_get_time(3),
       SSL_CTX_flush_sessions(3), SSL_get_default_timeout(3)




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