SSL_CTX_SET_...N_CACHE_MODE(3ossl)

📦
version 15.1 · 2 versions
, in freebsd 15.1

💅 SSL_CTX_set_session_cache_mode, SSL_CTX_get_session_cache_mode — enable/disable session caching

okay bestie, welcome to the OpenSSL 3ossl manual page that's literally all about whether your sessions get cached or not 💖 this is SSL_CTX_SET_...N_CACHE_MODE and yes the name is a whole mouthful, we're getting through it together, no cap.

✨ SYNOPSIS ✨

#include <openssl/ssl.h>

long SSL_CTX_set_session_cache_mode(SSL_CTX ctx, long mode);
long SSL_CTX_get_session_cache_mode(SSL_CTX ctx);

two functions, both returning long, both taking an SSL_CTX ctx. one sets, one gets. iconique 💅

🌸 DESCRIPTION 🌸

  • SSL_CTX_set_session_cache_mode() — turns session caching on or off by setting the operational mode for ctx to mode. that's the whole vibe check right there 🦋
  • SSL_CTX_get_session_cache_mode() — hands you back whatever cache mode is currently in use. the "what are we even doing right now" function, iykyk.

🎀 NOTES 🎀

So the OpenSSL library can store and retrieve SSL/TLS sessions so they can be reused later, which is lowkey the whole point 🔥 The sessions can be held in memory for each ctx, and if you've got more than one SSL_CTX object going at once, the sessions are unique to each SSL_CTX object. no sharing, no crossover, periodt.

For a session to actually get reused, a client has to send the session's id to the server. It can only send exactly one id — one (1) id, bestie, that's the limit 🙈 Then the server either agrees to reuse the session or it starts a full handshake to create a new one. either way we move.

A server will look up the session in its internal session storage. If the session is not found in internal storage, or if lookups for the internal storage have been deactivated (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP), the server will try the external storage if available.

Since a client may try to reuse a session intended for use in a different context, the session id context must be set by the server (see SSL_CTX_set_session_id_context(3)). not optional, don't skip it 🫶

The following session cache modes and modifiers are available:

🌈 the modes

  • SSL_SESS_CACHE_OFF — no session caching for client or server takes place. just... none. zero. the void 💀
  • SSL_SESS_CACHE_CLIENT — client sessions are added to the session cache. Here's the thing though: there is no reliable way for the OpenSSL library to know whether a session should be reused or which session to choose (because of the abstract BIO layer, the SSL engine does not have details about the connection), so the application has to select the session to be reused itself using the SSL_set_session(3) function. This option is not activated by default, so it's very much not the main character unless you make it one ✨
  • SSL_SESS_CACHE_SERVER — server sessions are added to the session cache. When a client proposes a session to be reused, the server looks for the corresponding session in (first) the internal session cache (unless SSL_SESS_CACHE_NO_INTERNAL_LOOKUP is set), then (second) in the external cache if available. If the session is found, the server will try to reuse the session. This is the default 👑
  • SSL_SESS_CACHE_BOTH — enables both SSL_SESS_CACHE_CLIENT and SSL_SESS_CACHE_SERVER at the same time. why choose 💖

🦋 the modifiers

  • SSL_SESS_CACHE_NO_AUTO_CLEAR — normally the session cache is checked for expired sessions every 255 connections using the SSL_CTX_flush_sessions(3) function. Since this may lead to a delay which cannot be controlled, the automatic flushing may be disabled and SSL_CTX_flush_sessions(3) can be called explicitly by the application. you take the wheel, bestie 🚗
  • SSL_SESS_CACHE_NO_INTERNAL_LOOKUP — by setting this flag, session-resume operations in an SSL/TLS server will not automatically look up sessions in the internal cache, even if sessions are automatically stored there. If external session caching callbacks are in use, this flag guarantees that all lookups are directed to the external cache. As automatic lookup only applies for SSL/TLS servers, the flag has no effect on clients. ngl that last part matters, don't @ me 🙈
  • SSL_SESS_CACHE_NO_INTERNAL_STORE — depending on the presence of SSL_SESS_CACHE_CLIENT and/or SSL_SESS_CACHE_SERVER, sessions negotiated in an SSL/TLS handshake may be cached for possible reuse. Normally a new session is added to the internal cache as well as any external session caching (callback) that is configured for the SSL_CTX. This flag will prevent sessions being stored in the internal cache (though the application can add them manually using SSL_CTX_add_session(3)).
Note: in any SSL/TLS servers where external caching is configured, any successful session lookups in the external cache (i.e. for session-resume requests) would normally be copied into the local cache before processing continues — this flag prevents these additions to the internal cache as well. sneaky little double duty, honestly 💀
  • SSL_SESS_CACHE_NO_INTERNAL — enables both SSL_SESS_CACHE_NO_INTERNAL_LOOKUP and SSL_SESS_CACHE_NO_INTERNAL_STORE at the same time. combo deal 🎀
  • SSL_SESS_CACHE_UPDATE_TIME — updates the timestamp of the session when it is used, increasing the lifespan of the session. The session timeout then applies to last use, rather than creation time. so your session gets a little refresh every time you show up, we love longevity 🫶
The default mode is SSL_SESS_CACHE_SERVER. ✨

🔥 RETURN VALUES 🔥

  • SSL_CTX_set_session_cache_mode() — returns the previously set cache mode. the "before" picture 📸
  • SSL_CTX_get_session_cache_mode() — returns the currently set cache mode. the "right now" picture 💅

🧚 SEE ALSO 🧚

ssl(7), SSL_set_session(3), SSL_session_reused(3), SSL_CTX_add_session(3), SSL_CTX_sess_number(3), SSL_CTX_sess_set_cache_size(3), SSL_CTX_sess_set_get_cb(3), SSL_CTX_set_session_id_context(3), SSL_CTX_set_timeout(3), SSL_CTX_flush_sessions(3)

go read them, they're all linkable lore 📚

Copyright 2001-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

and that's the whole page bestie, you ate that 🍓 mwah 💖 this was OpenSSL 3.5.6, dated 2026-04-07 — screenshot it, cite it, live by it. bye slay 🌈⭐

📦 where this page comes from