2 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright 2005 Nokia. All rights reserved.
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
11 #if defined(__TANDEM) && defined(_SPT_MODEL_)
12 # include <spthread.h>
13 # include <spt_extensions.h> /* timeval */
16 #include <openssl/rand.h>
17 #include <openssl/engine.h>
18 #include "internal/refcount.h"
19 #include "internal/cryptlib.h"
20 #include "ssl_local.h"
21 #include "statem/statem_local.h"
23 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
24 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
25 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
27 DEFINE_STACK_OF(SSL_SESSION)
29 __owur static ossl_inline int sess_timedout(OSSL_TIME t, SSL_SESSION *ss)
31 return ossl_time_compare(t, ss->calc_timeout) > 0;
35 * Returns -1/0/+1 as other XXXcmp-type functions
36 * Takes calculated timeout into consideration
38 __owur static ossl_inline int timeoutcmp(SSL_SESSION *a, SSL_SESSION *b)
40 return ossl_time_compare(a->calc_timeout, b->calc_timeout);
44 * Calculates effective timeout
45 * Locking must be done by the caller of this function
47 void ssl_session_calculate_timeout(SSL_SESSION *ss)
49 ss->calc_timeout = ossl_time_add(ss->time, ss->timeout);
53 * SSL_get_session() and SSL_get1_session() are problematic in TLS1.3 because,
54 * unlike in earlier protocol versions, the session ticket may not have been
55 * sent yet even though a handshake has finished. The session ticket data could
56 * come in sometime later...or even change if multiple session ticket messages
57 * are sent from the server. The preferred way for applications to obtain
58 * a resumable session is to use SSL_CTX_sess_set_new_cb().
61 SSL_SESSION *SSL_get_session(const SSL *ssl)
62 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
64 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
72 SSL_SESSION *SSL_get1_session(SSL *ssl)
73 /* variant of SSL_get_session: caller really gets something */
78 * Need to lock this all up rather than just use CRYPTO_add so that
79 * somebody doesn't free ssl->session between when we check it's non-null
80 * and when we up the reference count.
82 if (!CRYPTO_THREAD_read_lock(ssl->lock))
84 sess = SSL_get_session(ssl);
86 SSL_SESSION_up_ref(sess);
87 CRYPTO_THREAD_unlock(ssl->lock);
91 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
93 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
96 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
98 return CRYPTO_get_ex_data(&s->ex_data, idx);
101 SSL_SESSION *SSL_SESSION_new(void)
105 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
108 ss = OPENSSL_zalloc(sizeof(*ss));
112 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
113 /* 5 minute timeout by default */
114 ss->timeout = ossl_seconds2time(60 * 5 + 4);
115 ss->time = ossl_time_now();
116 ssl_session_calculate_timeout(ss);
117 if (!CRYPTO_NEW_REF(&ss->references, 1)) {
122 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data)) {
123 CRYPTO_FREE_REF(&ss->references);
131 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
132 * ticket == 0 then no ticket information is duplicated, otherwise it is.
134 static SSL_SESSION *ssl_session_dup_intern(const SSL_SESSION *src, int ticket)
138 dest = OPENSSL_malloc(sizeof(*dest));
141 memcpy(dest, src, sizeof(*dest));
144 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
145 * the case of an error whilst halfway through constructing dest
147 #ifndef OPENSSL_NO_PSK
148 dest->psk_identity_hint = NULL;
149 dest->psk_identity = NULL;
151 dest->ext.hostname = NULL;
152 dest->ext.tick = NULL;
153 dest->ext.alpn_selected = NULL;
154 #ifndef OPENSSL_NO_SRP
155 dest->srp_username = NULL;
157 dest->peer_chain = NULL;
159 dest->peer_rpk = NULL;
160 dest->ticket_appdata = NULL;
161 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
163 /* As the copy is not in the cache, we remove the associated pointers */
168 if (!CRYPTO_NEW_REF(&dest->references, 1)) {
173 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, dest, &dest->ex_data)) {
174 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
178 if (src->peer != NULL) {
179 if (!X509_up_ref(src->peer)) {
180 ERR_raise(ERR_LIB_SSL, ERR_R_X509_LIB);
183 dest->peer = src->peer;
186 if (src->peer_chain != NULL) {
187 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
188 if (dest->peer_chain == NULL) {
189 ERR_raise(ERR_LIB_SSL, ERR_R_X509_LIB);
194 if (src->peer_rpk != NULL) {
195 if (!EVP_PKEY_up_ref(src->peer_rpk))
197 dest->peer_rpk = src->peer_rpk;
200 #ifndef OPENSSL_NO_PSK
201 if (src->psk_identity_hint) {
202 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
203 if (dest->psk_identity_hint == NULL)
206 if (src->psk_identity) {
207 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
208 if (dest->psk_identity == NULL)
213 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
214 &dest->ex_data, &src->ex_data)) {
215 ERR_raise(ERR_LIB_SSL, ERR_R_CRYPTO_LIB);
219 if (src->ext.hostname) {
220 dest->ext.hostname = OPENSSL_strdup(src->ext.hostname);
221 if (dest->ext.hostname == NULL)
225 if (ticket != 0 && src->ext.tick != NULL) {
227 OPENSSL_memdup(src->ext.tick, src->ext.ticklen);
228 if (dest->ext.tick == NULL)
231 dest->ext.tick_lifetime_hint = 0;
232 dest->ext.ticklen = 0;
235 if (src->ext.alpn_selected != NULL) {
236 dest->ext.alpn_selected = OPENSSL_memdup(src->ext.alpn_selected,
237 src->ext.alpn_selected_len);
238 if (dest->ext.alpn_selected == NULL)
242 #ifndef OPENSSL_NO_SRP
243 if (src->srp_username) {
244 dest->srp_username = OPENSSL_strdup(src->srp_username);
245 if (dest->srp_username == NULL)
250 if (src->ticket_appdata != NULL) {
251 dest->ticket_appdata =
252 OPENSSL_memdup(src->ticket_appdata, src->ticket_appdata_len);
253 if (dest->ticket_appdata == NULL)
259 SSL_SESSION_free(dest);
263 SSL_SESSION *SSL_SESSION_dup(const SSL_SESSION *src)
265 return ssl_session_dup_intern(src, 1);
269 * Used internally when duplicating a session which might be already shared.
270 * We will have resumed the original session. Subsequently we might have marked
271 * it as non-resumable (e.g. in another thread) - but this copy should be ok to
274 SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket)
276 SSL_SESSION *sess = ssl_session_dup_intern(src, ticket);
279 sess->not_resumable = 0;
284 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
287 *len = (unsigned int)s->session_id_length;
288 return s->session_id;
290 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
294 *len = (unsigned int)s->sid_ctx_length;
298 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
300 return s->compress_meth;
304 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
305 * the ID with random junk repeatedly until we have no conflict is going to
306 * complete in one iteration pretty much "most" of the time (btw:
307 * understatement). So, if it takes us 10 iterations and we still can't avoid
308 * a conflict - well that's a reasonable point to call it quits. Either the
309 * RAND code is broken or someone is trying to open roughly very close to
310 * 2^256 SSL sessions to our server. How you might store that many sessions
311 * is perhaps a more interesting question ...
314 #define MAX_SESS_ID_ATTEMPTS 10
315 static int def_generate_session_id(SSL *ssl, unsigned char *id,
316 unsigned int *id_len)
318 unsigned int retry = 0;
320 if (RAND_bytes_ex(ssl->ctx->libctx, id, *id_len, 0) <= 0)
322 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
327 } while (SSL_has_matching_session_id(ssl, id, *id_len) &&
328 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
329 if (retry < MAX_SESS_ID_ATTEMPTS)
331 /* else - woops a session_id match */
333 * XXX We should also check the external cache -- but the probability of
334 * a collision is negligible, and we could not prevent the concurrent
335 * creation of sessions with identical IDs since we currently don't have
336 * means to atomically check whether a session ID already exists and make
337 * a reservation for it if it does not (this problem applies to the
338 * internal cache as well).
343 int ssl_generate_session_id(SSL_CONNECTION *s, SSL_SESSION *ss)
346 GEN_SESSION_CB cb = def_generate_session_id;
347 SSL *ssl = SSL_CONNECTION_GET_SSL(s);
349 switch (s->version) {
357 case DTLS1_2_VERSION:
358 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
361 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_UNSUPPORTED_SSL_VERSION);
366 * If RFC5077 ticket, use empty session ID (as server).
368 * (a) ssl_get_prev_session() does lookahead into the
369 * ClientHello extensions to find the session ticket.
370 * When ssl_get_prev_session() fails, statem_srvr.c calls
371 * ssl_get_new_session() in tls_process_client_hello().
372 * At that point, it has not yet parsed the extensions,
373 * however, because of the lookahead, it already knows
374 * whether a ticket is expected or not.
376 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
377 * ServerHello extensions, and before recording the session
378 * ID received from the server, so this block is a noop.
380 if (s->ext.ticket_expected) {
381 ss->session_id_length = 0;
385 /* Choose which callback will set the session ID */
386 if (!CRYPTO_THREAD_read_lock(SSL_CONNECTION_GET_SSL(s)->lock))
388 if (!CRYPTO_THREAD_read_lock(s->session_ctx->lock)) {
389 CRYPTO_THREAD_unlock(ssl->lock);
390 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
391 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
394 if (s->generate_session_id)
395 cb = s->generate_session_id;
396 else if (s->session_ctx->generate_session_id)
397 cb = s->session_ctx->generate_session_id;
398 CRYPTO_THREAD_unlock(s->session_ctx->lock);
399 CRYPTO_THREAD_unlock(ssl->lock);
400 /* Choose a session ID */
401 memset(ss->session_id, 0, ss->session_id_length);
402 tmp = (int)ss->session_id_length;
403 if (!cb(ssl, ss->session_id, &tmp)) {
404 /* The callback failed */
405 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
406 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
410 * Don't allow the callback to set the session length to zero. nor
411 * set it higher than it was.
413 if (tmp == 0 || tmp > ss->session_id_length) {
414 /* The callback set an illegal length */
415 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
416 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
419 ss->session_id_length = tmp;
420 /* Finally, check for a conflict */
421 if (SSL_has_matching_session_id(ssl, ss->session_id,
422 (unsigned int)ss->session_id_length)) {
423 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_SSL_SESSION_ID_CONFLICT);
430 int ssl_get_new_session(SSL_CONNECTION *s, int session)
432 /* This gets used by clients and servers. */
434 SSL_SESSION *ss = NULL;
436 if ((ss = SSL_SESSION_new()) == NULL) {
437 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_SSL_LIB);
441 /* If the context has a default timeout, use it */
442 if (ossl_time_is_zero(s->session_ctx->session_timeout))
443 ss->timeout = SSL_CONNECTION_GET_SSL(s)->method->get_timeout();
445 ss->timeout = s->session_ctx->session_timeout;
446 ssl_session_calculate_timeout(ss);
448 SSL_SESSION_free(s->session);
452 if (SSL_CONNECTION_IS_TLS13(s)) {
454 * We generate the session id while constructing the
455 * NewSessionTicket in TLSv1.3.
457 ss->session_id_length = 0;
458 } else if (!ssl_generate_session_id(s, ss)) {
459 /* SSLfatal() already called */
460 SSL_SESSION_free(ss);
465 ss->session_id_length = 0;
468 if (s->sid_ctx_length > sizeof(ss->sid_ctx)) {
469 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
470 SSL_SESSION_free(ss);
473 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
474 ss->sid_ctx_length = s->sid_ctx_length;
476 ss->ssl_version = s->version;
477 ss->verify_result = X509_V_OK;
479 /* If client supports extended master secret set it in session */
480 if (s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS)
481 ss->flags |= SSL_SESS_FLAG_EXTMS;
486 SSL_SESSION *lookup_sess_in_cache(SSL_CONNECTION *s,
487 const unsigned char *sess_id,
490 SSL_SESSION *ret = NULL;
492 if ((s->session_ctx->session_cache_mode
493 & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP) == 0) {
496 data.ssl_version = s->version;
497 if (!ossl_assert(sess_id_len <= SSL_MAX_SSL_SESSION_ID_LENGTH))
500 memcpy(data.session_id, sess_id, sess_id_len);
501 data.session_id_length = sess_id_len;
503 if (!CRYPTO_THREAD_read_lock(s->session_ctx->lock))
505 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
507 /* don't allow other threads to steal it: */
508 SSL_SESSION_up_ref(ret);
510 CRYPTO_THREAD_unlock(s->session_ctx->lock);
512 ssl_tsan_counter(s->session_ctx, &s->session_ctx->stats.sess_miss);
515 if (ret == NULL && s->session_ctx->get_session_cb != NULL) {
518 ret = s->session_ctx->get_session_cb(SSL_CONNECTION_GET_SSL(s),
519 sess_id, sess_id_len, ©);
522 if (ret->not_resumable) {
523 /* If its not resumable then ignore this session */
525 SSL_SESSION_free(ret);
528 ssl_tsan_counter(s->session_ctx,
529 &s->session_ctx->stats.sess_cb_hit);
532 * Increment reference count now if the session callback asks us
533 * to do so (note that if the session structures returned by the
534 * callback are shared between threads, it must handle the
535 * reference count itself [i.e. copy == 0], or things won't be
539 SSL_SESSION_up_ref(ret);
542 * Add the externally cached session to the internal cache as
543 * well if and only if we are supposed to.
545 if ((s->session_ctx->session_cache_mode &
546 SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0) {
548 * Either return value of SSL_CTX_add_session should not
549 * interrupt the session resumption process. The return
550 * value is intentionally ignored.
552 (void)SSL_CTX_add_session(s->session_ctx, ret);
561 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
562 * connection. It is only called by servers.
564 * hello: The parsed ClientHello data
568 * 0: no session found
569 * 1: a session may have been found.
572 * - If a session is found then s->session is pointed at it (after freeing an
573 * existing session if need be) and s->verify_result is set from the session.
574 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
575 * if the server should issue a new session ticket (to 0 otherwise).
577 int ssl_get_prev_session(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello)
579 /* This is used only by servers. */
581 SSL_SESSION *ret = NULL;
583 int try_session_cache = 0;
586 if (SSL_CONNECTION_IS_TLS13(s)) {
588 * By default we will send a new ticket. This can be overridden in the
591 s->ext.ticket_expected = 1;
592 if (!tls_parse_extension(s, TLSEXT_IDX_psk_kex_modes,
593 SSL_EXT_CLIENT_HELLO, hello->pre_proc_exts,
595 || !tls_parse_extension(s, TLSEXT_IDX_psk, SSL_EXT_CLIENT_HELLO,
596 hello->pre_proc_exts, NULL, 0))
601 /* sets s->ext.ticket_expected */
602 r = tls_get_ticket_from_client(s, hello, &ret);
604 case SSL_TICKET_FATAL_ERR_MALLOC:
605 case SSL_TICKET_FATAL_ERR_OTHER:
607 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
609 case SSL_TICKET_NONE:
610 case SSL_TICKET_EMPTY:
611 if (hello->session_id_len > 0) {
612 try_session_cache = 1;
613 ret = lookup_sess_in_cache(s, hello->session_id,
614 hello->session_id_len);
617 case SSL_TICKET_NO_DECRYPT:
618 case SSL_TICKET_SUCCESS:
619 case SSL_TICKET_SUCCESS_RENEW:
627 /* Now ret is non-NULL and we own one of its reference counts. */
629 /* Check TLS version consistency */
630 if (ret->ssl_version != s->version)
633 if (ret->sid_ctx_length != s->sid_ctx_length
634 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
636 * We have the session requested by the client, but we don't want to
637 * use it in this context.
639 goto err; /* treat like cache miss */
642 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
644 * We can't be sure if this session is being used out of context,
645 * which is especially important for SSL_VERIFY_PEER. The application
646 * should have used SSL[_CTX]_set_session_id_context. For this error
647 * case, we generate an error instead of treating the event like a
648 * cache miss (otherwise it would be easy for applications to
649 * effectively disable the session cache by accident without anyone
653 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
654 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
659 if (sess_timedout(ossl_time_now(), ret)) {
660 ssl_tsan_counter(s->session_ctx, &s->session_ctx->stats.sess_timeout);
661 if (try_session_cache) {
662 /* session was from the cache, so remove it */
663 SSL_CTX_remove_session(s->session_ctx, ret);
668 /* Check extended master secret extension consistency */
669 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
670 /* If old session includes extms, but new does not: abort handshake */
671 if (!(s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
672 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_R_INCONSISTENT_EXTMS);
676 } else if (s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS) {
677 /* If new session includes extms, but old does not: do not resume */
681 if (!SSL_CONNECTION_IS_TLS13(s)) {
682 /* We already did this for TLS1.3 */
683 SSL_SESSION_free(s->session);
687 ssl_tsan_counter(s->session_ctx, &s->session_ctx->stats.sess_hit);
688 s->verify_result = s->session->verify_result;
693 SSL_SESSION_free(ret);
694 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
695 if (SSL_CONNECTION_IS_TLS13(s))
698 if (!try_session_cache) {
700 * The session was from a ticket, so we should issue a ticket for
703 s->ext.ticket_expected = 1;
712 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
718 * add just 1 reference count for the SSL_CTX's session cache even though
719 * it has two ways of access: each session is in a doubly linked list and
722 SSL_SESSION_up_ref(c);
724 * if session c is in already in cache, we take back the increment later
727 if (!CRYPTO_THREAD_write_lock(ctx->lock)) {
731 s = lh_SSL_SESSION_insert(ctx->sessions, c);
734 * s != NULL iff we already had a session with the given PID. In this
735 * case, s == c should hold (then we did not really modify
736 * ctx->sessions), or we're in trouble.
738 if (s != NULL && s != c) {
739 /* We *are* in trouble ... */
740 SSL_SESSION_list_remove(ctx, s);
743 * ... so pretend the other session did not exist in cache (we cannot
744 * handle two SSL_SESSION structures with identical session ID in the
745 * same cache, which could happen e.g. when two threads concurrently
746 * obtain the same session from an external cache)
749 } else if (s == NULL &&
750 lh_SSL_SESSION_retrieve(ctx->sessions, c) == NULL) {
751 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
754 * ... so take back the extra reference and also don't add
755 * the session to the SSL_SESSION_list at this time
760 /* Adjust last used time, and add back into the cache at the appropriate spot */
761 if (ctx->session_cache_mode & SSL_SESS_CACHE_UPDATE_TIME) {
762 c->time = ossl_time_now();
763 ssl_session_calculate_timeout(c);
768 * new cache entry -- remove old ones if cache has become too large
769 * delete cache entry *before* add, so we don't remove the one we're adding!
774 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
775 while (SSL_CTX_sess_number(ctx) >= SSL_CTX_sess_get_cache_size(ctx)) {
776 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
779 ssl_tsan_counter(ctx, &ctx->stats.sess_cache_full);
784 SSL_SESSION_list_add(ctx, c);
788 * existing cache entry -- decrement previously incremented reference
789 * count because it already takes into account the cache
792 SSL_SESSION_free(s); /* s == c */
795 CRYPTO_THREAD_unlock(ctx->lock);
799 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
801 return remove_session_lock(ctx, c, 1);
804 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
809 if ((c != NULL) && (c->session_id_length != 0)) {
811 if (!CRYPTO_THREAD_write_lock(ctx->lock))
814 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) != NULL) {
816 r = lh_SSL_SESSION_delete(ctx->sessions, r);
817 SSL_SESSION_list_remove(ctx, r);
819 c->not_resumable = 1;
822 CRYPTO_THREAD_unlock(ctx->lock);
824 if (ctx->remove_session_cb != NULL)
825 ctx->remove_session_cb(ctx, c);
833 void SSL_SESSION_free(SSL_SESSION *ss)
839 CRYPTO_DOWN_REF(&ss->references, &i);
840 REF_PRINT_COUNT("SSL_SESSION", ss);
843 REF_ASSERT_ISNT(i < 0);
845 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
847 OPENSSL_cleanse(ss->master_key, sizeof(ss->master_key));
848 OPENSSL_cleanse(ss->session_id, sizeof(ss->session_id));
850 EVP_PKEY_free(ss->peer_rpk);
851 OSSL_STACK_OF_X509_free(ss->peer_chain);
852 OPENSSL_free(ss->ext.hostname);
853 OPENSSL_free(ss->ext.tick);
854 #ifndef OPENSSL_NO_PSK
855 OPENSSL_free(ss->psk_identity_hint);
856 OPENSSL_free(ss->psk_identity);
858 #ifndef OPENSSL_NO_SRP
859 OPENSSL_free(ss->srp_username);
861 OPENSSL_free(ss->ext.alpn_selected);
862 OPENSSL_free(ss->ticket_appdata);
863 CRYPTO_FREE_REF(&ss->references);
864 OPENSSL_clear_free(ss, sizeof(*ss));
867 int SSL_SESSION_up_ref(SSL_SESSION *ss)
871 if (CRYPTO_UP_REF(&ss->references, &i) <= 0)
874 REF_PRINT_COUNT("SSL_SESSION", ss);
875 REF_ASSERT_ISNT(i < 2);
876 return ((i > 1) ? 1 : 0);
879 int SSL_set_session(SSL *s, SSL_SESSION *session)
881 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
886 ssl_clear_bad_session(sc);
887 if (s->defltmeth != s->method) {
888 if (!SSL_set_ssl_method(s, s->defltmeth))
892 if (session != NULL) {
893 SSL_SESSION_up_ref(session);
894 sc->verify_result = session->verify_result;
896 SSL_SESSION_free(sc->session);
897 sc->session = session;
902 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
903 unsigned int sid_len)
905 if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
906 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_SESSION_ID_TOO_LONG);
909 s->session_id_length = sid_len;
910 if (sid != s->session_id)
911 memcpy(s->session_id, sid, sid_len);
915 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
917 OSSL_TIME new_timeout = ossl_seconds2time(t);
919 if (s == NULL || t < 0)
921 if (s->owner != NULL) {
922 if (!CRYPTO_THREAD_write_lock(s->owner->lock))
924 s->timeout = new_timeout;
925 ssl_session_calculate_timeout(s);
926 SSL_SESSION_list_add(s->owner, s);
927 CRYPTO_THREAD_unlock(s->owner->lock);
929 s->timeout = new_timeout;
930 ssl_session_calculate_timeout(s);
935 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
939 return (long)ossl_time_to_time_t(s->timeout);
942 long SSL_SESSION_get_time(const SSL_SESSION *s)
944 return (long) SSL_SESSION_get_time_ex(s);
947 time_t SSL_SESSION_get_time_ex(const SSL_SESSION *s)
951 return ossl_time_to_time_t(s->time);
954 time_t SSL_SESSION_set_time_ex(SSL_SESSION *s, time_t t)
956 OSSL_TIME new_time = ossl_time_from_time_t(t);
960 if (s->owner != NULL) {
961 if (!CRYPTO_THREAD_write_lock(s->owner->lock))
964 ssl_session_calculate_timeout(s);
965 SSL_SESSION_list_add(s->owner, s);
966 CRYPTO_THREAD_unlock(s->owner->lock);
969 ssl_session_calculate_timeout(s);
974 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
976 return (long) SSL_SESSION_set_time_ex(s, (time_t) t);
979 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
981 return s->ssl_version;
984 int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version)
986 s->ssl_version = version;
990 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
995 int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher)
1001 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
1003 return s->ext.hostname;
1006 int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname)
1008 OPENSSL_free(s->ext.hostname);
1009 if (hostname == NULL) {
1010 s->ext.hostname = NULL;
1013 s->ext.hostname = OPENSSL_strdup(hostname);
1015 return s->ext.hostname != NULL;
1018 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
1020 return (s->ext.ticklen > 0) ? 1 : 0;
1023 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
1025 return s->ext.tick_lifetime_hint;
1028 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
1031 *len = s->ext.ticklen;
1033 *tick = s->ext.tick;
1036 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s)
1038 return s->ext.max_early_data;
1041 int SSL_SESSION_set_max_early_data(SSL_SESSION *s, uint32_t max_early_data)
1043 s->ext.max_early_data = max_early_data;
1048 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
1049 const unsigned char **alpn,
1052 *alpn = s->ext.alpn_selected;
1053 *len = s->ext.alpn_selected_len;
1056 int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s, const unsigned char *alpn,
1059 OPENSSL_free(s->ext.alpn_selected);
1060 if (alpn == NULL || len == 0) {
1061 s->ext.alpn_selected = NULL;
1062 s->ext.alpn_selected_len = 0;
1065 s->ext.alpn_selected = OPENSSL_memdup(alpn, len);
1066 if (s->ext.alpn_selected == NULL) {
1067 s->ext.alpn_selected_len = 0;
1070 s->ext.alpn_selected_len = len;
1075 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
1080 EVP_PKEY *SSL_SESSION_get0_peer_rpk(SSL_SESSION *s)
1085 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
1086 unsigned int sid_ctx_len)
1088 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
1089 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
1092 s->sid_ctx_length = sid_ctx_len;
1093 if (sid_ctx != s->sid_ctx)
1094 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
1099 int SSL_SESSION_is_resumable(const SSL_SESSION *s)
1102 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
1105 return !s->not_resumable
1106 && (s->session_id_length > 0 || s->ext.ticklen > 0);
1109 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
1115 l = (long)ossl_time2seconds(s->session_timeout);
1116 s->session_timeout = ossl_seconds2time(t);
1120 long SSL_CTX_get_timeout(const SSL_CTX *s)
1124 return (long)ossl_time2seconds(s->session_timeout);
1127 int SSL_set_session_secret_cb(SSL *s,
1128 tls_session_secret_cb_fn tls_session_secret_cb,
1131 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1136 sc->ext.session_secret_cb = tls_session_secret_cb;
1137 sc->ext.session_secret_cb_arg = arg;
1141 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
1144 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1149 sc->ext.session_ticket_cb = cb;
1150 sc->ext.session_ticket_cb_arg = arg;
1154 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1156 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1161 if (sc->version >= TLS1_VERSION) {
1162 OPENSSL_free(sc->ext.session_ticket);
1163 sc->ext.session_ticket = NULL;
1164 sc->ext.session_ticket =
1165 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1166 if (sc->ext.session_ticket == NULL)
1169 if (ext_data != NULL) {
1170 sc->ext.session_ticket->length = ext_len;
1171 sc->ext.session_ticket->data = sc->ext.session_ticket + 1;
1172 memcpy(sc->ext.session_ticket->data, ext_data, ext_len);
1174 sc->ext.session_ticket->length = 0;
1175 sc->ext.session_ticket->data = NULL;
1184 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1186 STACK_OF(SSL_SESSION) *sk;
1187 SSL_SESSION *current;
1189 const OSSL_TIME timeout = ossl_time_from_time_t(t);
1191 if (!CRYPTO_THREAD_write_lock(s->lock))
1194 sk = sk_SSL_SESSION_new_null();
1195 i = lh_SSL_SESSION_get_down_load(s->sessions);
1196 lh_SSL_SESSION_set_down_load(s->sessions, 0);
1199 * Iterate over the list from the back (oldest), and stop
1200 * when a session can no longer be removed.
1201 * Add the session to a temporary list to be freed outside
1203 * But still do the remove_session_cb() within the lock.
1205 while (s->session_cache_tail != NULL) {
1206 current = s->session_cache_tail;
1207 if (t == 0 || sess_timedout(timeout, current)) {
1208 lh_SSL_SESSION_delete(s->sessions, current);
1209 SSL_SESSION_list_remove(s, current);
1210 current->not_resumable = 1;
1211 if (s->remove_session_cb != NULL)
1212 s->remove_session_cb(s, current);
1214 * Throw the session on a stack, it's entirely plausible
1215 * that while freeing outside the critical section, the
1216 * session could be re-added, so avoid using the next/prev
1217 * pointers. If the stack failed to create, or the session
1218 * couldn't be put on the stack, just free it here
1220 if (sk == NULL || !sk_SSL_SESSION_push(sk, current))
1221 SSL_SESSION_free(current);
1227 lh_SSL_SESSION_set_down_load(s->sessions, i);
1228 CRYPTO_THREAD_unlock(s->lock);
1230 sk_SSL_SESSION_pop_free(sk, SSL_SESSION_free);
1233 int ssl_clear_bad_session(SSL_CONNECTION *s)
1235 if ((s->session != NULL) &&
1236 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1237 !(SSL_in_init(SSL_CONNECTION_GET_SSL(s))
1238 || SSL_in_before(SSL_CONNECTION_GET_SSL(s)))) {
1239 SSL_CTX_remove_session(s->session_ctx, s->session);
1245 /* locked by SSL_CTX in the calling function */
1246 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1248 if ((s->next == NULL) || (s->prev == NULL))
1251 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1252 /* last element in list */
1253 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1254 /* only one element in list */
1255 ctx->session_cache_head = NULL;
1256 ctx->session_cache_tail = NULL;
1258 ctx->session_cache_tail = s->prev;
1259 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1262 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1263 /* first element in list */
1264 ctx->session_cache_head = s->next;
1265 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1267 /* middle of list */
1268 s->next->prev = s->prev;
1269 s->prev->next = s->next;
1272 s->prev = s->next = NULL;
1276 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1280 if ((s->next != NULL) && (s->prev != NULL))
1281 SSL_SESSION_list_remove(ctx, s);
1283 if (ctx->session_cache_head == NULL) {
1284 ctx->session_cache_head = s;
1285 ctx->session_cache_tail = s;
1286 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1287 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1289 if (timeoutcmp(s, ctx->session_cache_head) >= 0) {
1291 * if we timeout after (or the same time as) the first
1292 * session, put us first - usual case
1294 s->next = ctx->session_cache_head;
1296 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1297 ctx->session_cache_head = s;
1298 } else if (timeoutcmp(s, ctx->session_cache_tail) < 0) {
1299 /* if we timeout before the last session, put us last */
1300 s->prev = ctx->session_cache_tail;
1302 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1303 ctx->session_cache_tail = s;
1306 * we timeout somewhere in-between - if there is only
1307 * one session in the cache it will be caught above
1309 next = ctx->session_cache_head->next;
1310 while (next != (SSL_SESSION*)&(ctx->session_cache_tail)) {
1311 if (timeoutcmp(s, next) >= 0) {
1313 s->prev = next->prev;
1314 next->prev->next = s;
1325 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1326 int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1328 ctx->new_session_cb = cb;
1331 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1332 return ctx->new_session_cb;
1335 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1336 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1338 ctx->remove_session_cb = cb;
1341 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1342 SSL_SESSION *sess) {
1343 return ctx->remove_session_cb;
1346 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1347 SSL_SESSION *(*cb) (SSL *ssl,
1348 const unsigned char *data,
1349 int len, int *copy))
1351 ctx->get_session_cb = cb;
1354 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1358 return ctx->get_session_cb;
1361 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1362 void (*cb) (const SSL *ssl, int type, int val))
1364 ctx->info_callback = cb;
1367 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1369 return ctx->info_callback;
1372 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1373 int (*cb) (SSL *ssl, X509 **x509,
1376 ctx->client_cert_cb = cb;
1379 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1381 return ctx->client_cert_cb;
1384 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1385 int (*cb) (SSL *ssl,
1386 unsigned char *cookie,
1387 unsigned int *cookie_len))
1389 ctx->app_gen_cookie_cb = cb;
1392 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1393 int (*cb) (SSL *ssl,
1394 const unsigned char *cookie,
1395 unsigned int cookie_len))
1397 ctx->app_verify_cookie_cb = cb;
1400 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len)
1402 OPENSSL_free(ss->ticket_appdata);
1403 ss->ticket_appdata_len = 0;
1404 if (data == NULL || len == 0) {
1405 ss->ticket_appdata = NULL;
1408 ss->ticket_appdata = OPENSSL_memdup(data, len);
1409 if (ss->ticket_appdata != NULL) {
1410 ss->ticket_appdata_len = len;
1416 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len)
1418 *data = ss->ticket_appdata;
1419 *len = ss->ticket_appdata_len;
1423 void SSL_CTX_set_stateless_cookie_generate_cb(
1425 int (*cb) (SSL *ssl,
1426 unsigned char *cookie,
1427 size_t *cookie_len))
1429 ctx->gen_stateless_cookie_cb = cb;
1432 void SSL_CTX_set_stateless_cookie_verify_cb(
1434 int (*cb) (SSL *ssl,
1435 const unsigned char *cookie,
1438 ctx->verify_stateless_cookie_cb = cb;
1441 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)