2 * Copyright 1995-2022 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 int sess_timedout(time_t t, SSL_SESSION *ss)
31 /* if timeout overflowed, it can never timeout! */
34 return t > ss->calc_timeout;
38 * Returns -1/0/+1 as other XXXcmp-type functions
39 * Takes overflow of calculated timeout into consideration
41 __owur static int timeoutcmp(SSL_SESSION *a, SSL_SESSION *b)
43 /* if only one overflowed, then it is greater */
44 if (a->timeout_ovf && !b->timeout_ovf)
46 if (!a->timeout_ovf && b->timeout_ovf)
48 /* No overflow, or both overflowed, so straight compare is safe */
49 if (a->calc_timeout < b->calc_timeout)
51 if (a->calc_timeout > b->calc_timeout)
57 * Calculates effective timeout, saving overflow state
58 * Locking must be done by the caller of this function
60 void ssl_session_calculate_timeout(SSL_SESSION *ss)
62 /* Force positive timeout */
65 ss->calc_timeout = ss->time + ss->timeout;
67 * |timeout| is always zero or positive, so the check for
68 * overflow only needs to consider if |time| is positive
70 ss->timeout_ovf = ss->time > 0 && ss->calc_timeout < ss->time;
72 * N.B. Realistic overflow can only occur in our lifetimes on a
73 * 32-bit machine in January 2038.
74 * However, There are no controls to limit the |timeout|
75 * value, except to keep it positive.
80 * SSL_get_session() and SSL_get1_session() are problematic in TLS1.3 because,
81 * unlike in earlier protocol versions, the session ticket may not have been
82 * sent yet even though a handshake has finished. The session ticket data could
83 * come in sometime later...or even change if multiple session ticket messages
84 * are sent from the server. The preferred way for applications to obtain
85 * a resumable session is to use SSL_CTX_sess_set_new_cb().
88 SSL_SESSION *SSL_get_session(const SSL *ssl)
89 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
91 const SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(ssl);
99 SSL_SESSION *SSL_get1_session(SSL *ssl)
100 /* variant of SSL_get_session: caller really gets something */
105 * Need to lock this all up rather than just use CRYPTO_add so that
106 * somebody doesn't free ssl->session between when we check it's non-null
107 * and when we up the reference count.
109 if (!CRYPTO_THREAD_read_lock(ssl->lock))
111 sess = SSL_get_session(ssl);
113 SSL_SESSION_up_ref(sess);
114 CRYPTO_THREAD_unlock(ssl->lock);
118 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
120 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
123 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
125 return CRYPTO_get_ex_data(&s->ex_data, idx);
128 SSL_SESSION *SSL_SESSION_new(void)
132 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
135 ss = OPENSSL_zalloc(sizeof(*ss));
137 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
141 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
143 ss->timeout = 60 * 5 + 4; /* 5 minute timeout by default */
144 ss->time = time(NULL);
145 ssl_session_calculate_timeout(ss);
146 ss->lock = CRYPTO_THREAD_lock_new();
147 if (ss->lock == NULL) {
148 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
153 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data)) {
154 CRYPTO_THREAD_lock_free(ss->lock);
161 SSL_SESSION *SSL_SESSION_dup(const SSL_SESSION *src)
163 return ssl_session_dup(src, 1);
167 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
168 * ticket == 0 then no ticket information is duplicated, otherwise it is.
170 SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket)
174 dest = OPENSSL_malloc(sizeof(*dest));
178 memcpy(dest, src, sizeof(*dest));
181 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
182 * the case of an error whilst halfway through constructing dest
184 #ifndef OPENSSL_NO_PSK
185 dest->psk_identity_hint = NULL;
186 dest->psk_identity = NULL;
188 dest->ext.hostname = NULL;
189 dest->ext.tick = NULL;
190 dest->ext.alpn_selected = NULL;
191 #ifndef OPENSSL_NO_SRP
192 dest->srp_username = NULL;
194 dest->peer_chain = NULL;
196 dest->ticket_appdata = NULL;
197 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
199 /* We deliberately don't copy the prev and next pointers */
203 dest->references = 1;
205 dest->lock = CRYPTO_THREAD_lock_new();
206 if (dest->lock == NULL)
209 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, dest, &dest->ex_data))
212 if (src->peer != NULL) {
213 if (!X509_up_ref(src->peer))
215 dest->peer = src->peer;
218 if (src->peer_chain != NULL) {
219 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
220 if (dest->peer_chain == NULL)
223 #ifndef OPENSSL_NO_PSK
224 if (src->psk_identity_hint) {
225 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
226 if (dest->psk_identity_hint == NULL) {
230 if (src->psk_identity) {
231 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
232 if (dest->psk_identity == NULL) {
238 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
239 &dest->ex_data, &src->ex_data)) {
243 if (src->ext.hostname) {
244 dest->ext.hostname = OPENSSL_strdup(src->ext.hostname);
245 if (dest->ext.hostname == NULL) {
250 if (ticket != 0 && src->ext.tick != NULL) {
252 OPENSSL_memdup(src->ext.tick, src->ext.ticklen);
253 if (dest->ext.tick == NULL)
256 dest->ext.tick_lifetime_hint = 0;
257 dest->ext.ticklen = 0;
260 if (src->ext.alpn_selected != NULL) {
261 dest->ext.alpn_selected = OPENSSL_memdup(src->ext.alpn_selected,
262 src->ext.alpn_selected_len);
263 if (dest->ext.alpn_selected == NULL)
267 #ifndef OPENSSL_NO_SRP
268 if (src->srp_username) {
269 dest->srp_username = OPENSSL_strdup(src->srp_username);
270 if (dest->srp_username == NULL) {
276 if (src->ticket_appdata != NULL) {
277 dest->ticket_appdata =
278 OPENSSL_memdup(src->ticket_appdata, src->ticket_appdata_len);
279 if (dest->ticket_appdata == NULL)
285 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
286 SSL_SESSION_free(dest);
290 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
293 *len = (unsigned int)s->session_id_length;
294 return s->session_id;
296 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
300 *len = (unsigned int)s->sid_ctx_length;
304 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
306 return s->compress_meth;
310 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
311 * the ID with random junk repeatedly until we have no conflict is going to
312 * complete in one iteration pretty much "most" of the time (btw:
313 * understatement). So, if it takes us 10 iterations and we still can't avoid
314 * a conflict - well that's a reasonable point to call it quits. Either the
315 * RAND code is broken or someone is trying to open roughly very close to
316 * 2^256 SSL sessions to our server. How you might store that many sessions
317 * is perhaps a more interesting question ...
320 #define MAX_SESS_ID_ATTEMPTS 10
321 static int def_generate_session_id(SSL *ssl, unsigned char *id,
322 unsigned int *id_len)
324 unsigned int retry = 0;
326 if (RAND_bytes_ex(ssl->ctx->libctx, id, *id_len, 0) <= 0)
328 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
329 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
330 if (retry < MAX_SESS_ID_ATTEMPTS)
332 /* else - woops a session_id match */
334 * XXX We should also check the external cache -- but the probability of
335 * a collision is negligible, and we could not prevent the concurrent
336 * creation of sessions with identical IDs since we currently don't have
337 * means to atomically check whether a session ID already exists and make
338 * a reservation for it if it does not (this problem applies to the
339 * internal cache as well).
344 int ssl_generate_session_id(SSL_CONNECTION *s, SSL_SESSION *ss)
347 GEN_SESSION_CB cb = def_generate_session_id;
348 SSL *ssl = SSL_CONNECTION_GET_SSL(s);
350 switch (s->version) {
358 case DTLS1_2_VERSION:
359 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
362 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_UNSUPPORTED_SSL_VERSION);
367 * If RFC5077 ticket, use empty session ID (as server).
369 * (a) ssl_get_prev_session() does lookahead into the
370 * ClientHello extensions to find the session ticket.
371 * When ssl_get_prev_session() fails, statem_srvr.c calls
372 * ssl_get_new_session() in tls_process_client_hello().
373 * At that point, it has not yet parsed the extensions,
374 * however, because of the lookahead, it already knows
375 * whether a ticket is expected or not.
377 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
378 * ServerHello extensions, and before recording the session
379 * ID received from the server, so this block is a noop.
381 if (s->ext.ticket_expected) {
382 ss->session_id_length = 0;
386 /* Choose which callback will set the session ID */
387 if (!CRYPTO_THREAD_read_lock(SSL_CONNECTION_GET_SSL(s)->lock))
389 if (!CRYPTO_THREAD_read_lock(s->session_ctx->lock)) {
390 CRYPTO_THREAD_unlock(ssl->lock);
391 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
392 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
395 if (s->generate_session_id)
396 cb = s->generate_session_id;
397 else if (s->session_ctx->generate_session_id)
398 cb = s->session_ctx->generate_session_id;
399 CRYPTO_THREAD_unlock(s->session_ctx->lock);
400 CRYPTO_THREAD_unlock(ssl->lock);
401 /* Choose a session ID */
402 memset(ss->session_id, 0, ss->session_id_length);
403 tmp = (int)ss->session_id_length;
404 if (!cb(ssl, ss->session_id, &tmp)) {
405 /* The callback failed */
406 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
407 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
411 * Don't allow the callback to set the session length to zero. nor
412 * set it higher than it was.
414 if (tmp == 0 || tmp > ss->session_id_length) {
415 /* The callback set an illegal length */
416 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
417 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
420 ss->session_id_length = tmp;
421 /* Finally, check for a conflict */
422 if (SSL_has_matching_session_id(ssl, ss->session_id,
423 (unsigned int)ss->session_id_length)) {
424 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_SSL_SESSION_ID_CONFLICT);
431 int ssl_get_new_session(SSL_CONNECTION *s, int session)
433 /* This gets used by clients and servers. */
435 SSL_SESSION *ss = NULL;
437 if ((ss = SSL_SESSION_new()) == NULL) {
438 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
442 /* If the context has a default timeout, use it */
443 if (s->session_ctx->session_timeout == 0)
444 ss->timeout = SSL_get_default_timeout(SSL_CONNECTION_GET_SSL(s));
446 ss->timeout = s->session_ctx->session_timeout;
447 ssl_session_calculate_timeout(ss);
449 SSL_SESSION_free(s->session);
453 if (SSL_CONNECTION_IS_TLS13(s)) {
455 * We generate the session id while constructing the
456 * NewSessionTicket in TLSv1.3.
458 ss->session_id_length = 0;
459 } else if (!ssl_generate_session_id(s, ss)) {
460 /* SSLfatal() already called */
461 SSL_SESSION_free(ss);
466 ss->session_id_length = 0;
469 if (s->sid_ctx_length > sizeof(ss->sid_ctx)) {
470 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
471 SSL_SESSION_free(ss);
474 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
475 ss->sid_ctx_length = s->sid_ctx_length;
477 ss->ssl_version = s->version;
478 ss->verify_result = X509_V_OK;
480 /* If client supports extended master secret set it in session */
481 if (s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS)
482 ss->flags |= SSL_SESS_FLAG_EXTMS;
487 SSL_SESSION *lookup_sess_in_cache(SSL_CONNECTION *s,
488 const unsigned char *sess_id,
491 SSL_SESSION *ret = NULL;
493 if ((s->session_ctx->session_cache_mode
494 & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP) == 0) {
497 data.ssl_version = s->version;
498 if (!ossl_assert(sess_id_len <= SSL_MAX_SSL_SESSION_ID_LENGTH))
501 memcpy(data.session_id, sess_id, sess_id_len);
502 data.session_id_length = sess_id_len;
504 if (!CRYPTO_THREAD_read_lock(s->session_ctx->lock))
506 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
508 /* don't allow other threads to steal it: */
509 SSL_SESSION_up_ref(ret);
511 CRYPTO_THREAD_unlock(s->session_ctx->lock);
513 ssl_tsan_counter(s->session_ctx, &s->session_ctx->stats.sess_miss);
516 if (ret == NULL && s->session_ctx->get_session_cb != NULL) {
519 ret = s->session_ctx->get_session_cb(SSL_CONNECTION_GET_SSL(s),
520 sess_id, sess_id_len, ©);
523 ssl_tsan_counter(s->session_ctx,
524 &s->session_ctx->stats.sess_cb_hit);
527 * Increment reference count now if the session callback asks us
528 * to do so (note that if the session structures returned by the
529 * callback are shared between threads, it must handle the
530 * reference count itself [i.e. copy == 0], or things won't be
534 SSL_SESSION_up_ref(ret);
537 * Add the externally cached session to the internal cache as
538 * well if and only if we are supposed to.
540 if ((s->session_ctx->session_cache_mode &
541 SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0) {
543 * Either return value of SSL_CTX_add_session should not
544 * interrupt the session resumption process. The return
545 * value is intentionally ignored.
547 (void)SSL_CTX_add_session(s->session_ctx, ret);
556 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
557 * connection. It is only called by servers.
559 * hello: The parsed ClientHello data
563 * 0: no session found
564 * 1: a session may have been found.
567 * - If a session is found then s->session is pointed at it (after freeing an
568 * existing session if need be) and s->verify_result is set from the session.
569 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
570 * if the server should issue a new session ticket (to 0 otherwise).
572 int ssl_get_prev_session(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello)
574 /* This is used only by servers. */
576 SSL_SESSION *ret = NULL;
578 int try_session_cache = 0;
581 if (SSL_CONNECTION_IS_TLS13(s)) {
583 * By default we will send a new ticket. This can be overridden in the
586 s->ext.ticket_expected = 1;
587 if (!tls_parse_extension(s, TLSEXT_IDX_psk_kex_modes,
588 SSL_EXT_CLIENT_HELLO, hello->pre_proc_exts,
590 || !tls_parse_extension(s, TLSEXT_IDX_psk, SSL_EXT_CLIENT_HELLO,
591 hello->pre_proc_exts, NULL, 0))
596 /* sets s->ext.ticket_expected */
597 r = tls_get_ticket_from_client(s, hello, &ret);
599 case SSL_TICKET_FATAL_ERR_MALLOC:
600 case SSL_TICKET_FATAL_ERR_OTHER:
602 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
604 case SSL_TICKET_NONE:
605 case SSL_TICKET_EMPTY:
606 if (hello->session_id_len > 0) {
607 try_session_cache = 1;
608 ret = lookup_sess_in_cache(s, hello->session_id,
609 hello->session_id_len);
612 case SSL_TICKET_NO_DECRYPT:
613 case SSL_TICKET_SUCCESS:
614 case SSL_TICKET_SUCCESS_RENEW:
622 /* Now ret is non-NULL and we own one of its reference counts. */
624 /* Check TLS version consistency */
625 if (ret->ssl_version != s->version)
628 if (ret->sid_ctx_length != s->sid_ctx_length
629 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
631 * We have the session requested by the client, but we don't want to
632 * use it in this context.
634 goto err; /* treat like cache miss */
637 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
639 * We can't be sure if this session is being used out of context,
640 * which is especially important for SSL_VERIFY_PEER. The application
641 * should have used SSL[_CTX]_set_session_id_context. For this error
642 * case, we generate an error instead of treating the event like a
643 * cache miss (otherwise it would be easy for applications to
644 * effectively disable the session cache by accident without anyone
648 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
649 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
654 if (sess_timedout(time(NULL), ret)) {
655 ssl_tsan_counter(s->session_ctx, &s->session_ctx->stats.sess_timeout);
656 if (try_session_cache) {
657 /* session was from the cache, so remove it */
658 SSL_CTX_remove_session(s->session_ctx, ret);
663 /* Check extended master secret extension consistency */
664 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
665 /* If old session includes extms, but new does not: abort handshake */
666 if (!(s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
667 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_R_INCONSISTENT_EXTMS);
671 } else if (s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS) {
672 /* If new session includes extms, but old does not: do not resume */
676 if (!SSL_CONNECTION_IS_TLS13(s)) {
677 /* We already did this for TLS1.3 */
678 SSL_SESSION_free(s->session);
682 ssl_tsan_counter(s->session_ctx, &s->session_ctx->stats.sess_hit);
683 s->verify_result = s->session->verify_result;
688 SSL_SESSION_free(ret);
689 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
690 if (SSL_CONNECTION_IS_TLS13(s))
693 if (!try_session_cache) {
695 * The session was from a ticket, so we should issue a ticket for
698 s->ext.ticket_expected = 1;
707 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
713 * add just 1 reference count for the SSL_CTX's session cache even though
714 * it has two ways of access: each session is in a doubly linked list and
717 SSL_SESSION_up_ref(c);
719 * if session c is in already in cache, we take back the increment later
722 if (!CRYPTO_THREAD_write_lock(ctx->lock)) {
726 s = lh_SSL_SESSION_insert(ctx->sessions, c);
729 * s != NULL iff we already had a session with the given PID. In this
730 * case, s == c should hold (then we did not really modify
731 * ctx->sessions), or we're in trouble.
733 if (s != NULL && s != c) {
734 /* We *are* in trouble ... */
735 SSL_SESSION_list_remove(ctx, s);
738 * ... so pretend the other session did not exist in cache (we cannot
739 * handle two SSL_SESSION structures with identical session ID in the
740 * same cache, which could happen e.g. when two threads concurrently
741 * obtain the same session from an external cache)
744 } else if (s == NULL &&
745 lh_SSL_SESSION_retrieve(ctx->sessions, c) == NULL) {
746 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
749 * ... so take back the extra reference and also don't add
750 * the session to the SSL_SESSION_list at this time
755 /* Adjust last used time, and add back into the cache at the appropriate spot */
756 if (ctx->session_cache_mode & SSL_SESS_CACHE_UPDATE_TIME) {
757 c->time = time(NULL);
758 ssl_session_calculate_timeout(c);
760 SSL_SESSION_list_add(ctx, c);
764 * existing cache entry -- decrement previously incremented reference
765 * count because it already takes into account the cache
768 SSL_SESSION_free(s); /* s == c */
772 * new cache entry -- remove old ones if cache has become too large
777 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
778 while (SSL_CTX_sess_number(ctx) > SSL_CTX_sess_get_cache_size(ctx)) {
779 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
782 ssl_tsan_counter(ctx, &ctx->stats.sess_cache_full);
786 CRYPTO_THREAD_unlock(ctx->lock);
790 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
792 return remove_session_lock(ctx, c, 1);
795 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
800 if ((c != NULL) && (c->session_id_length != 0)) {
802 if (!CRYPTO_THREAD_write_lock(ctx->lock))
805 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) != NULL) {
807 r = lh_SSL_SESSION_delete(ctx->sessions, r);
808 SSL_SESSION_list_remove(ctx, r);
810 c->not_resumable = 1;
813 CRYPTO_THREAD_unlock(ctx->lock);
815 if (ctx->remove_session_cb != NULL)
816 ctx->remove_session_cb(ctx, c);
824 void SSL_SESSION_free(SSL_SESSION *ss)
830 CRYPTO_DOWN_REF(&ss->references, &i, ss->lock);
831 REF_PRINT_COUNT("SSL_SESSION", ss);
834 REF_ASSERT_ISNT(i < 0);
836 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
838 OPENSSL_cleanse(ss->master_key, sizeof(ss->master_key));
839 OPENSSL_cleanse(ss->session_id, sizeof(ss->session_id));
841 OSSL_STACK_OF_X509_free(ss->peer_chain);
842 OPENSSL_free(ss->ext.hostname);
843 OPENSSL_free(ss->ext.tick);
844 #ifndef OPENSSL_NO_PSK
845 OPENSSL_free(ss->psk_identity_hint);
846 OPENSSL_free(ss->psk_identity);
848 #ifndef OPENSSL_NO_SRP
849 OPENSSL_free(ss->srp_username);
851 OPENSSL_free(ss->ext.alpn_selected);
852 OPENSSL_free(ss->ticket_appdata);
853 CRYPTO_THREAD_lock_free(ss->lock);
854 OPENSSL_clear_free(ss, sizeof(*ss));
857 int SSL_SESSION_up_ref(SSL_SESSION *ss)
861 if (CRYPTO_UP_REF(&ss->references, &i, ss->lock) <= 0)
864 REF_PRINT_COUNT("SSL_SESSION", ss);
865 REF_ASSERT_ISNT(i < 2);
866 return ((i > 1) ? 1 : 0);
869 int SSL_set_session(SSL *s, SSL_SESSION *session)
871 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
876 ssl_clear_bad_session(sc);
877 if (s->ctx->method != s->method) {
878 if (!SSL_set_ssl_method(s, s->ctx->method))
882 if (session != NULL) {
883 SSL_SESSION_up_ref(session);
884 sc->verify_result = session->verify_result;
886 SSL_SESSION_free(sc->session);
887 sc->session = session;
892 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
893 unsigned int sid_len)
895 if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
896 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_SESSION_ID_TOO_LONG);
899 s->session_id_length = sid_len;
900 if (sid != s->session_id)
901 memcpy(s->session_id, sid, sid_len);
905 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
907 time_t new_timeout = (time_t)t;
909 if (s == NULL || t < 0)
911 if (s->owner != NULL) {
912 if (!CRYPTO_THREAD_write_lock(s->owner->lock))
914 s->timeout = new_timeout;
915 ssl_session_calculate_timeout(s);
916 SSL_SESSION_list_add(s->owner, s);
917 CRYPTO_THREAD_unlock(s->owner->lock);
919 s->timeout = new_timeout;
920 ssl_session_calculate_timeout(s);
925 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
929 return (long)s->timeout;
932 long SSL_SESSION_get_time(const SSL_SESSION *s)
936 return (long)s->time;
939 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
941 time_t new_time = (time_t)t;
945 if (s->owner != NULL) {
946 if (!CRYPTO_THREAD_write_lock(s->owner->lock))
949 ssl_session_calculate_timeout(s);
950 SSL_SESSION_list_add(s->owner, s);
951 CRYPTO_THREAD_unlock(s->owner->lock);
954 ssl_session_calculate_timeout(s);
959 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
961 return s->ssl_version;
964 int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version)
966 s->ssl_version = version;
970 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
975 int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher)
981 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
983 return s->ext.hostname;
986 int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname)
988 OPENSSL_free(s->ext.hostname);
989 if (hostname == NULL) {
990 s->ext.hostname = NULL;
993 s->ext.hostname = OPENSSL_strdup(hostname);
995 return s->ext.hostname != NULL;
998 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
1000 return (s->ext.ticklen > 0) ? 1 : 0;
1003 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
1005 return s->ext.tick_lifetime_hint;
1008 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
1011 *len = s->ext.ticklen;
1013 *tick = s->ext.tick;
1016 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s)
1018 return s->ext.max_early_data;
1021 int SSL_SESSION_set_max_early_data(SSL_SESSION *s, uint32_t max_early_data)
1023 s->ext.max_early_data = max_early_data;
1028 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
1029 const unsigned char **alpn,
1032 *alpn = s->ext.alpn_selected;
1033 *len = s->ext.alpn_selected_len;
1036 int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s, const unsigned char *alpn,
1039 OPENSSL_free(s->ext.alpn_selected);
1040 if (alpn == NULL || len == 0) {
1041 s->ext.alpn_selected = NULL;
1042 s->ext.alpn_selected_len = 0;
1045 s->ext.alpn_selected = OPENSSL_memdup(alpn, len);
1046 if (s->ext.alpn_selected == NULL) {
1047 s->ext.alpn_selected_len = 0;
1050 s->ext.alpn_selected_len = len;
1055 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
1060 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
1061 unsigned int sid_ctx_len)
1063 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
1064 ERR_raise(ERR_LIB_SSL, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
1067 s->sid_ctx_length = sid_ctx_len;
1068 if (sid_ctx != s->sid_ctx)
1069 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
1074 int SSL_SESSION_is_resumable(const SSL_SESSION *s)
1077 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
1080 return !s->not_resumable
1081 && (s->session_id_length > 0 || s->ext.ticklen > 0);
1084 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
1089 l = s->session_timeout;
1090 s->session_timeout = t;
1094 long SSL_CTX_get_timeout(const SSL_CTX *s)
1098 return s->session_timeout;
1101 int SSL_set_session_secret_cb(SSL *s,
1102 tls_session_secret_cb_fn tls_session_secret_cb,
1105 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1110 sc->ext.session_secret_cb = tls_session_secret_cb;
1111 sc->ext.session_secret_cb_arg = arg;
1115 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
1118 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1123 sc->ext.session_ticket_cb = cb;
1124 sc->ext.session_ticket_cb_arg = arg;
1128 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1130 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
1135 if (sc->version >= TLS1_VERSION) {
1136 OPENSSL_free(sc->ext.session_ticket);
1137 sc->ext.session_ticket = NULL;
1138 sc->ext.session_ticket =
1139 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1140 if (sc->ext.session_ticket == NULL) {
1141 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
1145 if (ext_data != NULL) {
1146 sc->ext.session_ticket->length = ext_len;
1147 sc->ext.session_ticket->data = sc->ext.session_ticket + 1;
1148 memcpy(sc->ext.session_ticket->data, ext_data, ext_len);
1150 sc->ext.session_ticket->length = 0;
1151 sc->ext.session_ticket->data = NULL;
1160 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1162 STACK_OF(SSL_SESSION) *sk;
1163 SSL_SESSION *current;
1166 if (!CRYPTO_THREAD_write_lock(s->lock))
1169 sk = sk_SSL_SESSION_new_null();
1170 i = lh_SSL_SESSION_get_down_load(s->sessions);
1171 lh_SSL_SESSION_set_down_load(s->sessions, 0);
1174 * Iterate over the list from the back (oldest), and stop
1175 * when a session can no longer be removed.
1176 * Add the session to a temporary list to be freed outside
1178 * But still do the remove_session_cb() within the lock.
1180 while (s->session_cache_tail != NULL) {
1181 current = s->session_cache_tail;
1182 if (t == 0 || sess_timedout((time_t)t, current)) {
1183 lh_SSL_SESSION_delete(s->sessions, current);
1184 SSL_SESSION_list_remove(s, current);
1185 current->not_resumable = 1;
1186 if (s->remove_session_cb != NULL)
1187 s->remove_session_cb(s, current);
1189 * Throw the session on a stack, it's entirely plausible
1190 * that while freeing outside the critical section, the
1191 * session could be re-added, so avoid using the next/prev
1192 * pointers. If the stack failed to create, or the session
1193 * couldn't be put on the stack, just free it here
1195 if (sk == NULL || !sk_SSL_SESSION_push(sk, current))
1196 SSL_SESSION_free(current);
1202 lh_SSL_SESSION_set_down_load(s->sessions, i);
1203 CRYPTO_THREAD_unlock(s->lock);
1205 sk_SSL_SESSION_pop_free(sk, SSL_SESSION_free);
1208 int ssl_clear_bad_session(SSL_CONNECTION *s)
1210 if ((s->session != NULL) &&
1211 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1212 !(SSL_in_init(SSL_CONNECTION_GET_SSL(s))
1213 || SSL_in_before(SSL_CONNECTION_GET_SSL(s)))) {
1214 SSL_CTX_remove_session(s->session_ctx, s->session);
1220 /* locked by SSL_CTX in the calling function */
1221 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1223 if ((s->next == NULL) || (s->prev == NULL))
1226 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1227 /* last element in list */
1228 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1229 /* only one element in list */
1230 ctx->session_cache_head = NULL;
1231 ctx->session_cache_tail = NULL;
1233 ctx->session_cache_tail = s->prev;
1234 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1237 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1238 /* first element in list */
1239 ctx->session_cache_head = s->next;
1240 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1242 /* middle of list */
1243 s->next->prev = s->prev;
1244 s->prev->next = s->next;
1247 s->prev = s->next = NULL;
1251 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1255 if ((s->next != NULL) && (s->prev != NULL))
1256 SSL_SESSION_list_remove(ctx, s);
1258 if (ctx->session_cache_head == NULL) {
1259 ctx->session_cache_head = s;
1260 ctx->session_cache_tail = s;
1261 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1262 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1264 if (timeoutcmp(s, ctx->session_cache_head) >= 0) {
1266 * if we timeout after (or the same time as) the first
1267 * session, put us first - usual case
1269 s->next = ctx->session_cache_head;
1271 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1272 ctx->session_cache_head = s;
1273 } else if (timeoutcmp(s, ctx->session_cache_tail) < 0) {
1274 /* if we timeout before the last session, put us last */
1275 s->prev = ctx->session_cache_tail;
1277 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1278 ctx->session_cache_tail = s;
1281 * we timeout somewhere in-between - if there is only
1282 * one session in the cache it will be caught above
1284 next = ctx->session_cache_head->next;
1285 while (next != (SSL_SESSION*)&(ctx->session_cache_tail)) {
1286 if (timeoutcmp(s, next) >= 0) {
1288 s->prev = next->prev;
1289 next->prev->next = s;
1300 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1301 int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1303 ctx->new_session_cb = cb;
1306 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1307 return ctx->new_session_cb;
1310 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1311 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1313 ctx->remove_session_cb = cb;
1316 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1317 SSL_SESSION *sess) {
1318 return ctx->remove_session_cb;
1321 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1322 SSL_SESSION *(*cb) (SSL *ssl,
1323 const unsigned char *data,
1324 int len, int *copy))
1326 ctx->get_session_cb = cb;
1329 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1333 return ctx->get_session_cb;
1336 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1337 void (*cb) (const SSL *ssl, int type, int val))
1339 ctx->info_callback = cb;
1342 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1344 return ctx->info_callback;
1347 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1348 int (*cb) (SSL *ssl, X509 **x509,
1351 ctx->client_cert_cb = cb;
1354 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1356 return ctx->client_cert_cb;
1359 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1360 int (*cb) (SSL *ssl,
1361 unsigned char *cookie,
1362 unsigned int *cookie_len))
1364 ctx->app_gen_cookie_cb = cb;
1367 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1368 int (*cb) (SSL *ssl,
1369 const unsigned char *cookie,
1370 unsigned int cookie_len))
1372 ctx->app_verify_cookie_cb = cb;
1375 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len)
1377 OPENSSL_free(ss->ticket_appdata);
1378 ss->ticket_appdata_len = 0;
1379 if (data == NULL || len == 0) {
1380 ss->ticket_appdata = NULL;
1383 ss->ticket_appdata = OPENSSL_memdup(data, len);
1384 if (ss->ticket_appdata != NULL) {
1385 ss->ticket_appdata_len = len;
1391 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len)
1393 *data = ss->ticket_appdata;
1394 *len = ss->ticket_appdata_len;
1398 void SSL_CTX_set_stateless_cookie_generate_cb(
1400 int (*cb) (SSL *ssl,
1401 unsigned char *cookie,
1402 size_t *cookie_len))
1404 ctx->gen_stateless_cookie_cb = cb;
1407 void SSL_CTX_set_stateless_cookie_verify_cb(
1409 int (*cb) (SSL *ssl,
1410 const unsigned char *cookie,
1413 ctx->verify_stateless_cookie_cb = cb;
1416 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)