SSL_SESSION_GET_TIME(3SSL)

📦
version 4.0.3 · 14 versions
, in ubuntu stonking

💖 SSL_SESSION_GET_TIME — the 3SSL manual page, but make it make sense 🎀

okay bestie, welcome to SSL_SESSION_GET_TIME(3SSL) — this is the one about the clock on your TLS sessions, and honestly? it's giving "time management but for handshakes" ⏰✨

🌸 NAME 🌸

SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout, SSL_SESSION_set_timeout, SSL_SESSION_get_time_ex, SSL_SESSION_set_time_ex, SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout — retrieve and manipulate session time and timeout settings 💅

like... it's the whole friend group of functions that read and write when a session was born and how long it gets to live. main character behavior fr fr.

✨ SYNOPSIS ✨

#include <openssl/ssl.h>

long SSL_SESSION_get_timeout(const SSL_SESSION *s);
long SSL_SESSION_set_timeout(SSL_SESSION *s, long tm);

long SSL_get_timeout(const SSL_SESSION *s);
long SSL_set_timeout(SSL_SESSION *s, long tm);

time_t SSL_SESSION_get_time_ex(const SSL_SESSION *s);
time_t SSL_SESSION_set_time_ex(SSL_SESSION *s, time_t tm);

The following functions have been deprecated since OpenSSL 3.4, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros(7):

long SSL_SESSION_get_time(const SSL_SESSION *s);
long SSL_SESSION_set_time(SSL_SESSION *s, long tm);
long SSL_get_time(const SSL_SESSION *s);
long SSL_set_time(SSL_SESSION *s, long tm);
⚠️ yes bestie, that second block is the old crew — deprecated since OpenSSL 3.4. they still show up to the party but everyone's side-eyeing them. define OPENSSL_API_COMPAT with a suitable version value if you wanna hide them completely.

🦋 DESCRIPTION 🦋

so here's the tea, one function at a time 🍓

SSL_SESSION_get_time_ex() returns the time at which the session s was established. the time is given in seconds since the Epoch, which means it's compatible with the time delivered by the time() call. iconic, consistent, no notes. 💖

SSL_SESSION_set_time_ex() replaces the creation time of the session s with the chosen value tm. you're literally rewriting history (the session's history, anyway). 🙈

SSL_SESSION_get_timeout() returns the timeout value set for session s, in seconds. ⏳

SSL_SESSION_set_timeout() sets the timeout value for session s in seconds to tm. slay.

SSL_SESSION_get_time() and SSL_SESSION_set_time() use the long datatype instead of time_t and are therefore deprecated due to not being Y2038-safe on 32 bit systems. note that such systems still need to be configured to use 64 bit time_t to be able to avoid overflow in system time. 😭 like, that's not a vibe, that's a bug waiting to happen.

The SSL_get_time(), SSL_set_time(), SSL_get_timeout(), and SSL_set_timeout() functions are synonyms for the SSL_SESSION_*() counterparts. same energy, shorter name, iykyk. 👑

🧚 NOTES 🧚

Sessions are expired by examining the creation time and the timeout value. Both are set at creation time of the session — to the actual time and to the default timeout value at creation, respectively — as set by SSL_CTX_set_timeout(3).

Using these functions it is possible to extend or shorten the lifetime of the session. so yes, you have the power. use it wisely, bestie. 🌈

💜 RETURN VALUES 💜

  • SSL_SESSION_get_time_ex() and SSL_SESSION_get_timeout() return the currently valid values. cute, helpful, no drama.
  • SSL_SESSION_set_time_ex() returns time on success.
  • SSL_SESSION_set_timeout() returns 1 on success.
  • If any of the functions is passed the NULL pointer for the session s, 0 is returned. 💀 null check first, always.

💀 BUGS 💀

The data type long is typically 32 bits on many systems, hence the old functions SSL_SESSION_get_time() and SSL_SESSION_set_time() are not always Y2038 safe.

not me gently reminding you that the year 2038 is a real threat and not just an aesthetic. 🔥 the old functions really said "we'll be fine" and they will not be fine.

🌟 SEE ALSO 🌟

ssl(7), SSL_CTX_set_timeout(3), SSL_get_default_timeout(3)

go read those next bestie, it's a whole reading list, very book club of us. 📚

👑 HISTORY 👑

The functions SSL_SESSION_get_time_ex() and SSL_SESSION_set_time_ex() were added in OpenSSL 3.3. the new girls on the block, and they ate. ✨

Copyright 2001-2024 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 🫶 this was SSL_SESSION_GET_TIME(3SSL) from the OpenSSL 4.0.3 era, dated 2026-09-29. go forth, set those timeouts responsibly, and remember: 64 bit time_t or bust. 💖✨🌸

📦 where this page comes from