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 */
114 /* 5 minute timeout by default */
115 ss
->timeout
= ossl_seconds2time(60 * 5 + 4);
116 ss
->time
= ossl_time_now();
117 ssl_session_calculate_timeout(ss
);
118 ss
->lock
= CRYPTO_THREAD_lock_new();
119 if (ss
->lock
== NULL
) {
120 ERR_raise(ERR_LIB_SSL
, ERR_R_CRYPTO_LIB
);
125 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
)) {
126 CRYPTO_THREAD_lock_free(ss
->lock
);
133 SSL_SESSION
*SSL_SESSION_dup(const SSL_SESSION
*src
)
135 return ssl_session_dup(src
, 1);
139 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
140 * ticket == 0 then no ticket information is duplicated, otherwise it is.
142 SSL_SESSION
*ssl_session_dup(const SSL_SESSION
*src
, int ticket
)
146 dest
= OPENSSL_malloc(sizeof(*dest
));
150 memcpy(dest
, src
, sizeof(*dest
));
153 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
154 * the case of an error whilst halfway through constructing dest
156 #ifndef OPENSSL_NO_PSK
157 dest
->psk_identity_hint
= NULL
;
158 dest
->psk_identity
= NULL
;
160 dest
->ext
.hostname
= NULL
;
161 dest
->ext
.tick
= NULL
;
162 dest
->ext
.alpn_selected
= NULL
;
163 #ifndef OPENSSL_NO_SRP
164 dest
->srp_username
= NULL
;
166 dest
->peer_chain
= NULL
;
168 dest
->peer_rpk
= NULL
;
169 dest
->ticket_appdata
= NULL
;
170 memset(&dest
->ex_data
, 0, sizeof(dest
->ex_data
));
172 /* We deliberately don't copy the prev and next pointers */
176 dest
->references
= 1;
178 dest
->lock
= CRYPTO_THREAD_lock_new();
179 if (dest
->lock
== NULL
) {
180 ERR_raise(ERR_LIB_SSL
, ERR_R_CRYPTO_LIB
);
184 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, dest
, &dest
->ex_data
)) {
185 ERR_raise(ERR_LIB_SSL
, ERR_R_CRYPTO_LIB
);
189 if (src
->peer
!= NULL
) {
190 if (!X509_up_ref(src
->peer
)) {
191 ERR_raise(ERR_LIB_SSL
, ERR_R_X509_LIB
);
194 dest
->peer
= src
->peer
;
197 if (src
->peer_chain
!= NULL
) {
198 dest
->peer_chain
= X509_chain_up_ref(src
->peer_chain
);
199 if (dest
->peer_chain
== NULL
) {
200 ERR_raise(ERR_LIB_SSL
, ERR_R_X509_LIB
);
205 if (src
->peer_rpk
!= NULL
) {
206 if (!EVP_PKEY_up_ref(src
->peer_rpk
))
208 dest
->peer_rpk
= src
->peer_rpk
;
211 #ifndef OPENSSL_NO_PSK
212 if (src
->psk_identity_hint
) {
213 dest
->psk_identity_hint
= OPENSSL_strdup(src
->psk_identity_hint
);
214 if (dest
->psk_identity_hint
== NULL
)
217 if (src
->psk_identity
) {
218 dest
->psk_identity
= OPENSSL_strdup(src
->psk_identity
);
219 if (dest
->psk_identity
== NULL
)
224 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
,
225 &dest
->ex_data
, &src
->ex_data
)) {
226 ERR_raise(ERR_LIB_SSL
, ERR_R_CRYPTO_LIB
);
230 if (src
->ext
.hostname
) {
231 dest
->ext
.hostname
= OPENSSL_strdup(src
->ext
.hostname
);
232 if (dest
->ext
.hostname
== NULL
)
236 if (ticket
!= 0 && src
->ext
.tick
!= NULL
) {
238 OPENSSL_memdup(src
->ext
.tick
, src
->ext
.ticklen
);
239 if (dest
->ext
.tick
== NULL
)
242 dest
->ext
.tick_lifetime_hint
= 0;
243 dest
->ext
.ticklen
= 0;
246 if (src
->ext
.alpn_selected
!= NULL
) {
247 dest
->ext
.alpn_selected
= OPENSSL_memdup(src
->ext
.alpn_selected
,
248 src
->ext
.alpn_selected_len
);
249 if (dest
->ext
.alpn_selected
== NULL
)
253 #ifndef OPENSSL_NO_SRP
254 if (src
->srp_username
) {
255 dest
->srp_username
= OPENSSL_strdup(src
->srp_username
);
256 if (dest
->srp_username
== NULL
)
261 if (src
->ticket_appdata
!= NULL
) {
262 dest
->ticket_appdata
=
263 OPENSSL_memdup(src
->ticket_appdata
, src
->ticket_appdata_len
);
264 if (dest
->ticket_appdata
== NULL
)
270 SSL_SESSION_free(dest
);
274 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION
*s
, unsigned int *len
)
277 *len
= (unsigned int)s
->session_id_length
;
278 return s
->session_id
;
280 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION
*s
,
284 *len
= (unsigned int)s
->sid_ctx_length
;
288 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION
*s
)
290 return s
->compress_meth
;
294 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
295 * the ID with random junk repeatedly until we have no conflict is going to
296 * complete in one iteration pretty much "most" of the time (btw:
297 * understatement). So, if it takes us 10 iterations and we still can't avoid
298 * a conflict - well that's a reasonable point to call it quits. Either the
299 * RAND code is broken or someone is trying to open roughly very close to
300 * 2^256 SSL sessions to our server. How you might store that many sessions
301 * is perhaps a more interesting question ...
304 #define MAX_SESS_ID_ATTEMPTS 10
305 static int def_generate_session_id(SSL
*ssl
, unsigned char *id
,
306 unsigned int *id_len
)
308 unsigned int retry
= 0;
310 if (RAND_bytes_ex(ssl
->ctx
->libctx
, id
, *id_len
, 0) <= 0)
312 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
317 } while (SSL_has_matching_session_id(ssl
, id
, *id_len
) &&
318 (++retry
< MAX_SESS_ID_ATTEMPTS
)) ;
319 if (retry
< MAX_SESS_ID_ATTEMPTS
)
321 /* else - woops a session_id match */
323 * XXX We should also check the external cache -- but the probability of
324 * a collision is negligible, and we could not prevent the concurrent
325 * creation of sessions with identical IDs since we currently don't have
326 * means to atomically check whether a session ID already exists and make
327 * a reservation for it if it does not (this problem applies to the
328 * internal cache as well).
333 int ssl_generate_session_id(SSL_CONNECTION
*s
, SSL_SESSION
*ss
)
336 GEN_SESSION_CB cb
= def_generate_session_id
;
337 SSL
*ssl
= SSL_CONNECTION_GET_SSL(s
);
339 switch (s
->version
) {
347 case DTLS1_2_VERSION
:
348 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
351 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_UNSUPPORTED_SSL_VERSION
);
356 * If RFC5077 ticket, use empty session ID (as server).
358 * (a) ssl_get_prev_session() does lookahead into the
359 * ClientHello extensions to find the session ticket.
360 * When ssl_get_prev_session() fails, statem_srvr.c calls
361 * ssl_get_new_session() in tls_process_client_hello().
362 * At that point, it has not yet parsed the extensions,
363 * however, because of the lookahead, it already knows
364 * whether a ticket is expected or not.
366 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
367 * ServerHello extensions, and before recording the session
368 * ID received from the server, so this block is a noop.
370 if (s
->ext
.ticket_expected
) {
371 ss
->session_id_length
= 0;
375 /* Choose which callback will set the session ID */
376 if (!CRYPTO_THREAD_read_lock(SSL_CONNECTION_GET_SSL(s
)->lock
))
378 if (!CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
)) {
379 CRYPTO_THREAD_unlock(ssl
->lock
);
380 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
381 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
384 if (s
->generate_session_id
)
385 cb
= s
->generate_session_id
;
386 else if (s
->session_ctx
->generate_session_id
)
387 cb
= s
->session_ctx
->generate_session_id
;
388 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
389 CRYPTO_THREAD_unlock(ssl
->lock
);
390 /* Choose a session ID */
391 memset(ss
->session_id
, 0, ss
->session_id_length
);
392 tmp
= (int)ss
->session_id_length
;
393 if (!cb(ssl
, ss
->session_id
, &tmp
)) {
394 /* The callback failed */
395 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
396 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED
);
400 * Don't allow the callback to set the session length to zero. nor
401 * set it higher than it was.
403 if (tmp
== 0 || tmp
> ss
->session_id_length
) {
404 /* The callback set an illegal length */
405 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
406 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH
);
409 ss
->session_id_length
= tmp
;
410 /* Finally, check for a conflict */
411 if (SSL_has_matching_session_id(ssl
, ss
->session_id
,
412 (unsigned int)ss
->session_id_length
)) {
413 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_SSL_SESSION_ID_CONFLICT
);
420 int ssl_get_new_session(SSL_CONNECTION
*s
, int session
)
422 /* This gets used by clients and servers. */
424 SSL_SESSION
*ss
= NULL
;
426 if ((ss
= SSL_SESSION_new()) == NULL
) {
427 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_SSL_LIB
);
431 /* If the context has a default timeout, use it */
432 if (ossl_time_is_zero(s
->session_ctx
->session_timeout
))
433 ss
->timeout
= SSL_CONNECTION_GET_SSL(s
)->method
->get_timeout();
435 ss
->timeout
= s
->session_ctx
->session_timeout
;
436 ssl_session_calculate_timeout(ss
);
438 SSL_SESSION_free(s
->session
);
442 if (SSL_CONNECTION_IS_TLS13(s
)) {
444 * We generate the session id while constructing the
445 * NewSessionTicket in TLSv1.3.
447 ss
->session_id_length
= 0;
448 } else if (!ssl_generate_session_id(s
, ss
)) {
449 /* SSLfatal() already called */
450 SSL_SESSION_free(ss
);
455 ss
->session_id_length
= 0;
458 if (s
->sid_ctx_length
> sizeof(ss
->sid_ctx
)) {
459 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
460 SSL_SESSION_free(ss
);
463 memcpy(ss
->sid_ctx
, s
->sid_ctx
, s
->sid_ctx_length
);
464 ss
->sid_ctx_length
= s
->sid_ctx_length
;
466 ss
->ssl_version
= s
->version
;
467 ss
->verify_result
= X509_V_OK
;
469 /* If client supports extended master secret set it in session */
470 if (s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
)
471 ss
->flags
|= SSL_SESS_FLAG_EXTMS
;
476 SSL_SESSION
*lookup_sess_in_cache(SSL_CONNECTION
*s
,
477 const unsigned char *sess_id
,
480 SSL_SESSION
*ret
= NULL
;
482 if ((s
->session_ctx
->session_cache_mode
483 & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
) == 0) {
486 data
.ssl_version
= s
->version
;
487 if (!ossl_assert(sess_id_len
<= SSL_MAX_SSL_SESSION_ID_LENGTH
))
490 memcpy(data
.session_id
, sess_id
, sess_id_len
);
491 data
.session_id_length
= sess_id_len
;
493 if (!CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
))
495 ret
= lh_SSL_SESSION_retrieve(s
->session_ctx
->sessions
, &data
);
497 /* don't allow other threads to steal it: */
498 SSL_SESSION_up_ref(ret
);
500 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
502 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_miss
);
505 if (ret
== NULL
&& s
->session_ctx
->get_session_cb
!= NULL
) {
508 ret
= s
->session_ctx
->get_session_cb(SSL_CONNECTION_GET_SSL(s
),
509 sess_id
, sess_id_len
, ©
);
512 ssl_tsan_counter(s
->session_ctx
,
513 &s
->session_ctx
->stats
.sess_cb_hit
);
516 * Increment reference count now if the session callback asks us
517 * to do so (note that if the session structures returned by the
518 * callback are shared between threads, it must handle the
519 * reference count itself [i.e. copy == 0], or things won't be
523 SSL_SESSION_up_ref(ret
);
526 * Add the externally cached session to the internal cache as
527 * well if and only if we are supposed to.
529 if ((s
->session_ctx
->session_cache_mode
&
530 SSL_SESS_CACHE_NO_INTERNAL_STORE
) == 0) {
532 * Either return value of SSL_CTX_add_session should not
533 * interrupt the session resumption process. The return
534 * value is intentionally ignored.
536 (void)SSL_CTX_add_session(s
->session_ctx
, ret
);
545 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
546 * connection. It is only called by servers.
548 * hello: The parsed ClientHello data
552 * 0: no session found
553 * 1: a session may have been found.
556 * - If a session is found then s->session is pointed at it (after freeing an
557 * existing session if need be) and s->verify_result is set from the session.
558 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
559 * if the server should issue a new session ticket (to 0 otherwise).
561 int ssl_get_prev_session(SSL_CONNECTION
*s
, CLIENTHELLO_MSG
*hello
)
563 /* This is used only by servers. */
565 SSL_SESSION
*ret
= NULL
;
567 int try_session_cache
= 0;
570 if (SSL_CONNECTION_IS_TLS13(s
)) {
572 * By default we will send a new ticket. This can be overridden in the
575 s
->ext
.ticket_expected
= 1;
576 if (!tls_parse_extension(s
, TLSEXT_IDX_psk_kex_modes
,
577 SSL_EXT_CLIENT_HELLO
, hello
->pre_proc_exts
,
579 || !tls_parse_extension(s
, TLSEXT_IDX_psk
, SSL_EXT_CLIENT_HELLO
,
580 hello
->pre_proc_exts
, NULL
, 0))
585 /* sets s->ext.ticket_expected */
586 r
= tls_get_ticket_from_client(s
, hello
, &ret
);
588 case SSL_TICKET_FATAL_ERR_MALLOC
:
589 case SSL_TICKET_FATAL_ERR_OTHER
:
591 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
593 case SSL_TICKET_NONE
:
594 case SSL_TICKET_EMPTY
:
595 if (hello
->session_id_len
> 0) {
596 try_session_cache
= 1;
597 ret
= lookup_sess_in_cache(s
, hello
->session_id
,
598 hello
->session_id_len
);
601 case SSL_TICKET_NO_DECRYPT
:
602 case SSL_TICKET_SUCCESS
:
603 case SSL_TICKET_SUCCESS_RENEW
:
611 /* Now ret is non-NULL and we own one of its reference counts. */
613 /* Check TLS version consistency */
614 if (ret
->ssl_version
!= s
->version
)
617 if (ret
->sid_ctx_length
!= s
->sid_ctx_length
618 || memcmp(ret
->sid_ctx
, s
->sid_ctx
, ret
->sid_ctx_length
)) {
620 * We have the session requested by the client, but we don't want to
621 * use it in this context.
623 goto err
; /* treat like cache miss */
626 if ((s
->verify_mode
& SSL_VERIFY_PEER
) && s
->sid_ctx_length
== 0) {
628 * We can't be sure if this session is being used out of context,
629 * which is especially important for SSL_VERIFY_PEER. The application
630 * should have used SSL[_CTX]_set_session_id_context. For this error
631 * case, we generate an error instead of treating the event like a
632 * cache miss (otherwise it would be easy for applications to
633 * effectively disable the session cache by accident without anyone
637 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
638 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
643 if (sess_timedout(ossl_time_now(), ret
)) {
644 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_timeout
);
645 if (try_session_cache
) {
646 /* session was from the cache, so remove it */
647 SSL_CTX_remove_session(s
->session_ctx
, ret
);
652 /* Check extended master secret extension consistency */
653 if (ret
->flags
& SSL_SESS_FLAG_EXTMS
) {
654 /* If old session includes extms, but new does not: abort handshake */
655 if (!(s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
)) {
656 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_INCONSISTENT_EXTMS
);
660 } else if (s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
) {
661 /* If new session includes extms, but old does not: do not resume */
665 if (!SSL_CONNECTION_IS_TLS13(s
)) {
666 /* We already did this for TLS1.3 */
667 SSL_SESSION_free(s
->session
);
671 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_hit
);
672 s
->verify_result
= s
->session
->verify_result
;
677 SSL_SESSION_free(ret
);
678 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
679 if (SSL_CONNECTION_IS_TLS13(s
))
682 if (!try_session_cache
) {
684 * The session was from a ticket, so we should issue a ticket for
687 s
->ext
.ticket_expected
= 1;
696 int SSL_CTX_add_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
702 * add just 1 reference count for the SSL_CTX's session cache even though
703 * it has two ways of access: each session is in a doubly linked list and
706 SSL_SESSION_up_ref(c
);
708 * if session c is in already in cache, we take back the increment later
711 if (!CRYPTO_THREAD_write_lock(ctx
->lock
)) {
715 s
= lh_SSL_SESSION_insert(ctx
->sessions
, c
);
718 * s != NULL iff we already had a session with the given PID. In this
719 * case, s == c should hold (then we did not really modify
720 * ctx->sessions), or we're in trouble.
722 if (s
!= NULL
&& s
!= c
) {
723 /* We *are* in trouble ... */
724 SSL_SESSION_list_remove(ctx
, s
);
727 * ... so pretend the other session did not exist in cache (we cannot
728 * handle two SSL_SESSION structures with identical session ID in the
729 * same cache, which could happen e.g. when two threads concurrently
730 * obtain the same session from an external cache)
733 } else if (s
== NULL
&&
734 lh_SSL_SESSION_retrieve(ctx
->sessions
, c
) == NULL
) {
735 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
738 * ... so take back the extra reference and also don't add
739 * the session to the SSL_SESSION_list at this time
744 /* Adjust last used time, and add back into the cache at the appropriate spot */
745 if (ctx
->session_cache_mode
& SSL_SESS_CACHE_UPDATE_TIME
) {
746 c
->time
= ossl_time_now();
747 ssl_session_calculate_timeout(c
);
752 * new cache entry -- remove old ones if cache has become too large
753 * delete cache entry *before* add, so we don't remove the one we're adding!
758 if (SSL_CTX_sess_get_cache_size(ctx
) > 0) {
759 while (SSL_CTX_sess_number(ctx
) >= SSL_CTX_sess_get_cache_size(ctx
)) {
760 if (!remove_session_lock(ctx
, ctx
->session_cache_tail
, 0))
763 ssl_tsan_counter(ctx
, &ctx
->stats
.sess_cache_full
);
768 SSL_SESSION_list_add(ctx
, c
);
772 * existing cache entry -- decrement previously incremented reference
773 * count because it already takes into account the cache
776 SSL_SESSION_free(s
); /* s == c */
779 CRYPTO_THREAD_unlock(ctx
->lock
);
783 int SSL_CTX_remove_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
785 return remove_session_lock(ctx
, c
, 1);
788 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
)
793 if ((c
!= NULL
) && (c
->session_id_length
!= 0)) {
795 if (!CRYPTO_THREAD_write_lock(ctx
->lock
))
798 if ((r
= lh_SSL_SESSION_retrieve(ctx
->sessions
, c
)) != NULL
) {
800 r
= lh_SSL_SESSION_delete(ctx
->sessions
, r
);
801 SSL_SESSION_list_remove(ctx
, r
);
803 c
->not_resumable
= 1;
806 CRYPTO_THREAD_unlock(ctx
->lock
);
808 if (ctx
->remove_session_cb
!= NULL
)
809 ctx
->remove_session_cb(ctx
, c
);
817 void SSL_SESSION_free(SSL_SESSION
*ss
)
823 CRYPTO_DOWN_REF(&ss
->references
, &i
, ss
->lock
);
824 REF_PRINT_COUNT("SSL_SESSION", ss
);
827 REF_ASSERT_ISNT(i
< 0);
829 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
);
831 OPENSSL_cleanse(ss
->master_key
, sizeof(ss
->master_key
));
832 OPENSSL_cleanse(ss
->session_id
, sizeof(ss
->session_id
));
834 EVP_PKEY_free(ss
->peer_rpk
);
835 OSSL_STACK_OF_X509_free(ss
->peer_chain
);
836 OPENSSL_free(ss
->ext
.hostname
);
837 OPENSSL_free(ss
->ext
.tick
);
838 #ifndef OPENSSL_NO_PSK
839 OPENSSL_free(ss
->psk_identity_hint
);
840 OPENSSL_free(ss
->psk_identity
);
842 #ifndef OPENSSL_NO_SRP
843 OPENSSL_free(ss
->srp_username
);
845 OPENSSL_free(ss
->ext
.alpn_selected
);
846 OPENSSL_free(ss
->ticket_appdata
);
847 CRYPTO_THREAD_lock_free(ss
->lock
);
848 OPENSSL_clear_free(ss
, sizeof(*ss
));
851 int SSL_SESSION_up_ref(SSL_SESSION
*ss
)
855 if (CRYPTO_UP_REF(&ss
->references
, &i
, ss
->lock
) <= 0)
858 REF_PRINT_COUNT("SSL_SESSION", ss
);
859 REF_ASSERT_ISNT(i
< 2);
860 return ((i
> 1) ? 1 : 0);
863 int SSL_set_session(SSL
*s
, SSL_SESSION
*session
)
865 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(s
);
870 ssl_clear_bad_session(sc
);
871 if (s
->defltmeth
!= s
->method
) {
872 if (!SSL_set_ssl_method(s
, s
->defltmeth
))
876 if (session
!= NULL
) {
877 SSL_SESSION_up_ref(session
);
878 sc
->verify_result
= session
->verify_result
;
880 SSL_SESSION_free(sc
->session
);
881 sc
->session
= session
;
886 int SSL_SESSION_set1_id(SSL_SESSION
*s
, const unsigned char *sid
,
887 unsigned int sid_len
)
889 if (sid_len
> SSL_MAX_SSL_SESSION_ID_LENGTH
) {
890 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_TOO_LONG
);
893 s
->session_id_length
= sid_len
;
894 if (sid
!= s
->session_id
)
895 memcpy(s
->session_id
, sid
, sid_len
);
899 long SSL_SESSION_set_timeout(SSL_SESSION
*s
, long t
)
901 OSSL_TIME new_timeout
= ossl_seconds2time(t
);
903 if (s
== NULL
|| t
< 0)
905 if (s
->owner
!= NULL
) {
906 if (!CRYPTO_THREAD_write_lock(s
->owner
->lock
))
908 s
->timeout
= new_timeout
;
909 ssl_session_calculate_timeout(s
);
910 SSL_SESSION_list_add(s
->owner
, s
);
911 CRYPTO_THREAD_unlock(s
->owner
->lock
);
913 s
->timeout
= new_timeout
;
914 ssl_session_calculate_timeout(s
);
919 long SSL_SESSION_get_timeout(const SSL_SESSION
*s
)
923 return (long)ossl_time_to_time_t(s
->timeout
);
926 long SSL_SESSION_get_time(const SSL_SESSION
*s
)
930 return (long)ossl_time_to_time_t(s
->time
);
933 long SSL_SESSION_set_time(SSL_SESSION
*s
, long t
)
935 OSSL_TIME new_time
= ossl_time_from_time_t((time_t)t
);
939 if (s
->owner
!= NULL
) {
940 if (!CRYPTO_THREAD_write_lock(s
->owner
->lock
))
943 ssl_session_calculate_timeout(s
);
944 SSL_SESSION_list_add(s
->owner
, s
);
945 CRYPTO_THREAD_unlock(s
->owner
->lock
);
948 ssl_session_calculate_timeout(s
);
953 int SSL_SESSION_get_protocol_version(const SSL_SESSION
*s
)
955 return s
->ssl_version
;
958 int SSL_SESSION_set_protocol_version(SSL_SESSION
*s
, int version
)
960 s
->ssl_version
= version
;
964 const SSL_CIPHER
*SSL_SESSION_get0_cipher(const SSL_SESSION
*s
)
969 int SSL_SESSION_set_cipher(SSL_SESSION
*s
, const SSL_CIPHER
*cipher
)
975 const char *SSL_SESSION_get0_hostname(const SSL_SESSION
*s
)
977 return s
->ext
.hostname
;
980 int SSL_SESSION_set1_hostname(SSL_SESSION
*s
, const char *hostname
)
982 OPENSSL_free(s
->ext
.hostname
);
983 if (hostname
== NULL
) {
984 s
->ext
.hostname
= NULL
;
987 s
->ext
.hostname
= OPENSSL_strdup(hostname
);
989 return s
->ext
.hostname
!= NULL
;
992 int SSL_SESSION_has_ticket(const SSL_SESSION
*s
)
994 return (s
->ext
.ticklen
> 0) ? 1 : 0;
997 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION
*s
)
999 return s
->ext
.tick_lifetime_hint
;
1002 void SSL_SESSION_get0_ticket(const SSL_SESSION
*s
, const unsigned char **tick
,
1005 *len
= s
->ext
.ticklen
;
1007 *tick
= s
->ext
.tick
;
1010 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION
*s
)
1012 return s
->ext
.max_early_data
;
1015 int SSL_SESSION_set_max_early_data(SSL_SESSION
*s
, uint32_t max_early_data
)
1017 s
->ext
.max_early_data
= max_early_data
;
1022 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION
*s
,
1023 const unsigned char **alpn
,
1026 *alpn
= s
->ext
.alpn_selected
;
1027 *len
= s
->ext
.alpn_selected_len
;
1030 int SSL_SESSION_set1_alpn_selected(SSL_SESSION
*s
, const unsigned char *alpn
,
1033 OPENSSL_free(s
->ext
.alpn_selected
);
1034 if (alpn
== NULL
|| len
== 0) {
1035 s
->ext
.alpn_selected
= NULL
;
1036 s
->ext
.alpn_selected_len
= 0;
1039 s
->ext
.alpn_selected
= OPENSSL_memdup(alpn
, len
);
1040 if (s
->ext
.alpn_selected
== NULL
) {
1041 s
->ext
.alpn_selected_len
= 0;
1044 s
->ext
.alpn_selected_len
= len
;
1049 X509
*SSL_SESSION_get0_peer(SSL_SESSION
*s
)
1054 EVP_PKEY
*SSL_SESSION_get0_peer_rpk(SSL_SESSION
*s
)
1059 int SSL_SESSION_set1_id_context(SSL_SESSION
*s
, const unsigned char *sid_ctx
,
1060 unsigned int sid_ctx_len
)
1062 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
1063 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
1066 s
->sid_ctx_length
= sid_ctx_len
;
1067 if (sid_ctx
!= s
->sid_ctx
)
1068 memcpy(s
->sid_ctx
, sid_ctx
, sid_ctx_len
);
1073 int SSL_SESSION_is_resumable(const SSL_SESSION
*s
)
1076 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
1079 return !s
->not_resumable
1080 && (s
->session_id_length
> 0 || s
->ext
.ticklen
> 0);
1083 long SSL_CTX_set_timeout(SSL_CTX
*s
, long t
)
1089 l
= (long)ossl_time2seconds(s
->session_timeout
);
1090 s
->session_timeout
= ossl_seconds2time(t
);
1094 long SSL_CTX_get_timeout(const SSL_CTX
*s
)
1098 return (long)ossl_time2seconds(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
)
1143 if (ext_data
!= NULL
) {
1144 sc
->ext
.session_ticket
->length
= ext_len
;
1145 sc
->ext
.session_ticket
->data
= sc
->ext
.session_ticket
+ 1;
1146 memcpy(sc
->ext
.session_ticket
->data
, ext_data
, ext_len
);
1148 sc
->ext
.session_ticket
->length
= 0;
1149 sc
->ext
.session_ticket
->data
= NULL
;
1158 void SSL_CTX_flush_sessions(SSL_CTX
*s
, long t
)
1160 STACK_OF(SSL_SESSION
) *sk
;
1161 SSL_SESSION
*current
;
1163 const OSSL_TIME timeout
= ossl_time_from_time_t(t
);
1165 if (!CRYPTO_THREAD_write_lock(s
->lock
))
1168 sk
= sk_SSL_SESSION_new_null();
1169 i
= lh_SSL_SESSION_get_down_load(s
->sessions
);
1170 lh_SSL_SESSION_set_down_load(s
->sessions
, 0);
1173 * Iterate over the list from the back (oldest), and stop
1174 * when a session can no longer be removed.
1175 * Add the session to a temporary list to be freed outside
1177 * But still do the remove_session_cb() within the lock.
1179 while (s
->session_cache_tail
!= NULL
) {
1180 current
= s
->session_cache_tail
;
1181 if (t
== 0 || sess_timedout(timeout
, current
)) {
1182 lh_SSL_SESSION_delete(s
->sessions
, current
);
1183 SSL_SESSION_list_remove(s
, current
);
1184 current
->not_resumable
= 1;
1185 if (s
->remove_session_cb
!= NULL
)
1186 s
->remove_session_cb(s
, current
);
1188 * Throw the session on a stack, it's entirely plausible
1189 * that while freeing outside the critical section, the
1190 * session could be re-added, so avoid using the next/prev
1191 * pointers. If the stack failed to create, or the session
1192 * couldn't be put on the stack, just free it here
1194 if (sk
== NULL
|| !sk_SSL_SESSION_push(sk
, current
))
1195 SSL_SESSION_free(current
);
1201 lh_SSL_SESSION_set_down_load(s
->sessions
, i
);
1202 CRYPTO_THREAD_unlock(s
->lock
);
1204 sk_SSL_SESSION_pop_free(sk
, SSL_SESSION_free
);
1207 int ssl_clear_bad_session(SSL_CONNECTION
*s
)
1209 if ((s
->session
!= NULL
) &&
1210 !(s
->shutdown
& SSL_SENT_SHUTDOWN
) &&
1211 !(SSL_in_init(SSL_CONNECTION_GET_SSL(s
))
1212 || SSL_in_before(SSL_CONNECTION_GET_SSL(s
)))) {
1213 SSL_CTX_remove_session(s
->session_ctx
, s
->session
);
1219 /* locked by SSL_CTX in the calling function */
1220 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1222 if ((s
->next
== NULL
) || (s
->prev
== NULL
))
1225 if (s
->next
== (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1226 /* last element in list */
1227 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1228 /* only one element in list */
1229 ctx
->session_cache_head
= NULL
;
1230 ctx
->session_cache_tail
= NULL
;
1232 ctx
->session_cache_tail
= s
->prev
;
1233 s
->prev
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1236 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1237 /* first element in list */
1238 ctx
->session_cache_head
= s
->next
;
1239 s
->next
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1241 /* middle of list */
1242 s
->next
->prev
= s
->prev
;
1243 s
->prev
->next
= s
->next
;
1246 s
->prev
= s
->next
= NULL
;
1250 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1254 if ((s
->next
!= NULL
) && (s
->prev
!= NULL
))
1255 SSL_SESSION_list_remove(ctx
, s
);
1257 if (ctx
->session_cache_head
== NULL
) {
1258 ctx
->session_cache_head
= s
;
1259 ctx
->session_cache_tail
= s
;
1260 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1261 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1263 if (timeoutcmp(s
, ctx
->session_cache_head
) >= 0) {
1265 * if we timeout after (or the same time as) the first
1266 * session, put us first - usual case
1268 s
->next
= ctx
->session_cache_head
;
1270 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1271 ctx
->session_cache_head
= s
;
1272 } else if (timeoutcmp(s
, ctx
->session_cache_tail
) < 0) {
1273 /* if we timeout before the last session, put us last */
1274 s
->prev
= ctx
->session_cache_tail
;
1276 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1277 ctx
->session_cache_tail
= s
;
1280 * we timeout somewhere in-between - if there is only
1281 * one session in the cache it will be caught above
1283 next
= ctx
->session_cache_head
->next
;
1284 while (next
!= (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1285 if (timeoutcmp(s
, next
) >= 0) {
1287 s
->prev
= next
->prev
;
1288 next
->prev
->next
= s
;
1299 void SSL_CTX_sess_set_new_cb(SSL_CTX
*ctx
,
1300 int (*cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
))
1302 ctx
->new_session_cb
= cb
;
1305 int (*SSL_CTX_sess_get_new_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, SSL_SESSION
*sess
) {
1306 return ctx
->new_session_cb
;
1309 void SSL_CTX_sess_set_remove_cb(SSL_CTX
*ctx
,
1310 void (*cb
) (SSL_CTX
*ctx
, SSL_SESSION
*sess
))
1312 ctx
->remove_session_cb
= cb
;
1315 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX
*ctx
)) (SSL_CTX
*ctx
,
1316 SSL_SESSION
*sess
) {
1317 return ctx
->remove_session_cb
;
1320 void SSL_CTX_sess_set_get_cb(SSL_CTX
*ctx
,
1321 SSL_SESSION
*(*cb
) (SSL
*ssl
,
1322 const unsigned char *data
,
1323 int len
, int *copy
))
1325 ctx
->get_session_cb
= cb
;
1328 SSL_SESSION
*(*SSL_CTX_sess_get_get_cb(SSL_CTX
*ctx
)) (SSL
*ssl
,
1332 return ctx
->get_session_cb
;
1335 void SSL_CTX_set_info_callback(SSL_CTX
*ctx
,
1336 void (*cb
) (const SSL
*ssl
, int type
, int val
))
1338 ctx
->info_callback
= cb
;
1341 void (*SSL_CTX_get_info_callback(SSL_CTX
*ctx
)) (const SSL
*ssl
, int type
,
1343 return ctx
->info_callback
;
1346 void SSL_CTX_set_client_cert_cb(SSL_CTX
*ctx
,
1347 int (*cb
) (SSL
*ssl
, X509
**x509
,
1350 ctx
->client_cert_cb
= cb
;
1353 int (*SSL_CTX_get_client_cert_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, X509
**x509
,
1355 return ctx
->client_cert_cb
;
1358 void SSL_CTX_set_cookie_generate_cb(SSL_CTX
*ctx
,
1359 int (*cb
) (SSL
*ssl
,
1360 unsigned char *cookie
,
1361 unsigned int *cookie_len
))
1363 ctx
->app_gen_cookie_cb
= cb
;
1366 void SSL_CTX_set_cookie_verify_cb(SSL_CTX
*ctx
,
1367 int (*cb
) (SSL
*ssl
,
1368 const unsigned char *cookie
,
1369 unsigned int cookie_len
))
1371 ctx
->app_verify_cookie_cb
= cb
;
1374 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION
*ss
, const void *data
, size_t len
)
1376 OPENSSL_free(ss
->ticket_appdata
);
1377 ss
->ticket_appdata_len
= 0;
1378 if (data
== NULL
|| len
== 0) {
1379 ss
->ticket_appdata
= NULL
;
1382 ss
->ticket_appdata
= OPENSSL_memdup(data
, len
);
1383 if (ss
->ticket_appdata
!= NULL
) {
1384 ss
->ticket_appdata_len
= len
;
1390 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION
*ss
, void **data
, size_t *len
)
1392 *data
= ss
->ticket_appdata
;
1393 *len
= ss
->ticket_appdata_len
;
1397 void SSL_CTX_set_stateless_cookie_generate_cb(
1399 int (*cb
) (SSL
*ssl
,
1400 unsigned char *cookie
,
1401 size_t *cookie_len
))
1403 ctx
->gen_stateless_cookie_cb
= cb
;
1406 void SSL_CTX_set_stateless_cookie_verify_cb(
1408 int (*cb
) (SSL
*ssl
,
1409 const unsigned char *cookie
,
1412 ctx
->verify_stateless_cookie_cb
= cb
;
1415 IMPLEMENT_PEM_rw(SSL_SESSION
, SSL_SESSION
, PEM_STRING_SSL_SESSION
, SSL_SESSION
)