SSL_CTX_add_session - SSL_CTX_add_session, SSL_add_session, SSL_CTX_remove_session, manipulate session cache
#include <openssl/ssl.h> int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c); int SSL_add_session(SSL_CTX *ctx, SSL_SESSION *c); int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c); int SSL_remove_session(SSL_CTX *ctx, SSL_SESSION *c);
OpenSSL SSL_CTX_add_session(3openssl)
NAME
SSL_CTX_add_session, SSL_add_session, SSL_CTX_remove_session,
SSL_remove_session - manipulate session cache
SYNOPSIS
#include <openssl/ssl.h>
int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c);
int SSL_add_session(SSL_CTX *ctx, SSL_SESSION *c);
int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c);
int SSL_remove_session(SSL_CTX *ctx, SSL_SESSION *c);
DESCRIPTION
SSL_CTX_add_session() adds the session c to the context ctx. The
reference count for session c is incremented by 1. If a session with
the same session id already exists, the old session is removed by
calling SSL_SESSION_free(3).
SSL_CTX_remove_session() removes the session c from the context ctx.
SSL_SESSION_free(3) is called once for c.
SSL_add_session() and SSL_remove_session() are synonyms for their
SSL_CTX_*() counterparts.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | library/security/openssl |
+---------------+--------------------------+
|Stability | Pass-through uncommitted |
+---------------+--------------------------+
NOTES
When adding a new session to the internal session cache, it is examined
whether a session with the same session id already exists. In this case
it is assumed that both sessions are identical. If the same session is
stored in a different SSL_SESSION object, The old session is removed
and replaced by the new session. If the session is actually identical
(the SSL_SESSION object is identical), SSL_CTX_add_session() is a no-
op, and the return value is 0.
If a server SSL_CTX is configured with the
SSL_SESS_CACHE_NO_INTERNAL_STORE flag then the internal cache will not
be populated automatically by new sessions negotiated by the SSL/TLS
implementation, even though the internal cache will be searched
automatically for session-resume requests (the latter can be suppressed
by SSL_SESS_CACHE_NO_INTERNAL_LOOKUP). So the application can use
SSL_CTX_add_session() directly to have full control over the sessions
that can be resumed if desired.
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 values are returned by all functions:
0
The operation failed. In case of the add operation, it was tried to add
the same (identical) session twice. In case of the remove operation, the
session was not found in the cache.
1
The operation succeeded.
SEE ALSO
ssl(3), SSL_CTX_set_session_cache_mode(3), SSL_SESSION_free(3)
1.0.2ze 2022-05-03
SSL_CTX_add_session(3openssl)