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 */
94 SSL_SESSION
*SSL_get1_session(SSL
*ssl
)
95 /* variant of SSL_get_session: caller really gets something */
99 * Need to lock this all up rather than just use CRYPTO_add so that
100 * somebody doesn't free ssl->session between when we check it's non-null
101 * and when we up the reference count.
103 if (!CRYPTO_THREAD_read_lock(ssl
->lock
))
107 SSL_SESSION_up_ref(sess
);
108 CRYPTO_THREAD_unlock(ssl
->lock
);
112 int SSL_SESSION_set_ex_data(SSL_SESSION
*s
, int idx
, void *arg
)
114 return CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
);
117 void *SSL_SESSION_get_ex_data(const SSL_SESSION
*s
, int idx
)
119 return CRYPTO_get_ex_data(&s
->ex_data
, idx
);
122 SSL_SESSION
*SSL_SESSION_new(void)
126 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
129 ss
= OPENSSL_zalloc(sizeof(*ss
));
131 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
135 ss
->verify_result
= 1; /* avoid 0 (= X509_V_OK) just in case */
137 ss
->timeout
= 60 * 5 + 4; /* 5 minute timeout by default */
138 ss
->time
= time(NULL
);
139 ssl_session_calculate_timeout(ss
);
140 ss
->lock
= CRYPTO_THREAD_lock_new();
141 if (ss
->lock
== NULL
) {
142 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
147 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
)) {
148 CRYPTO_THREAD_lock_free(ss
->lock
);
155 SSL_SESSION
*SSL_SESSION_dup(const SSL_SESSION
*src
)
157 return ssl_session_dup(src
, 1);
161 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
162 * ticket == 0 then no ticket information is duplicated, otherwise it is.
164 SSL_SESSION
*ssl_session_dup(const SSL_SESSION
*src
, int ticket
)
168 dest
= OPENSSL_malloc(sizeof(*dest
));
172 memcpy(dest
, src
, sizeof(*dest
));
175 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
176 * the case of an error whilst halfway through constructing dest
178 #ifndef OPENSSL_NO_PSK
179 dest
->psk_identity_hint
= NULL
;
180 dest
->psk_identity
= NULL
;
182 dest
->ext
.hostname
= NULL
;
183 dest
->ext
.tick
= NULL
;
184 dest
->ext
.alpn_selected
= NULL
;
185 #ifndef OPENSSL_NO_SRP
186 dest
->srp_username
= NULL
;
188 dest
->peer_chain
= NULL
;
190 dest
->ticket_appdata
= NULL
;
191 memset(&dest
->ex_data
, 0, sizeof(dest
->ex_data
));
193 /* We deliberately don't copy the prev and next pointers */
197 dest
->references
= 1;
199 dest
->lock
= CRYPTO_THREAD_lock_new();
200 if (dest
->lock
== NULL
)
203 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, dest
, &dest
->ex_data
))
206 if (src
->peer
!= NULL
) {
207 if (!X509_up_ref(src
->peer
))
209 dest
->peer
= src
->peer
;
212 if (src
->peer_chain
!= NULL
) {
213 dest
->peer_chain
= X509_chain_up_ref(src
->peer_chain
);
214 if (dest
->peer_chain
== NULL
)
217 #ifndef OPENSSL_NO_PSK
218 if (src
->psk_identity_hint
) {
219 dest
->psk_identity_hint
= OPENSSL_strdup(src
->psk_identity_hint
);
220 if (dest
->psk_identity_hint
== NULL
) {
224 if (src
->psk_identity
) {
225 dest
->psk_identity
= OPENSSL_strdup(src
->psk_identity
);
226 if (dest
->psk_identity
== NULL
) {
232 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
,
233 &dest
->ex_data
, &src
->ex_data
)) {
237 if (src
->ext
.hostname
) {
238 dest
->ext
.hostname
= OPENSSL_strdup(src
->ext
.hostname
);
239 if (dest
->ext
.hostname
== NULL
) {
244 if (ticket
!= 0 && src
->ext
.tick
!= NULL
) {
246 OPENSSL_memdup(src
->ext
.tick
, src
->ext
.ticklen
);
247 if (dest
->ext
.tick
== NULL
)
250 dest
->ext
.tick_lifetime_hint
= 0;
251 dest
->ext
.ticklen
= 0;
254 if (src
->ext
.alpn_selected
!= NULL
) {
255 dest
->ext
.alpn_selected
= OPENSSL_memdup(src
->ext
.alpn_selected
,
256 src
->ext
.alpn_selected_len
);
257 if (dest
->ext
.alpn_selected
== NULL
)
261 #ifndef OPENSSL_NO_SRP
262 if (src
->srp_username
) {
263 dest
->srp_username
= OPENSSL_strdup(src
->srp_username
);
264 if (dest
->srp_username
== NULL
) {
270 if (src
->ticket_appdata
!= NULL
) {
271 dest
->ticket_appdata
=
272 OPENSSL_memdup(src
->ticket_appdata
, src
->ticket_appdata_len
);
273 if (dest
->ticket_appdata
== NULL
)
279 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
280 SSL_SESSION_free(dest
);
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 while (SSL_has_matching_session_id(ssl
, id
, *id_len
) &&
323 (++retry
< MAX_SESS_ID_ATTEMPTS
)) ;
324 if (retry
< MAX_SESS_ID_ATTEMPTS
)
326 /* else - woops a session_id match */
328 * XXX We should also check the external cache -- but the probability of
329 * a collision is negligible, and we could not prevent the concurrent
330 * creation of sessions with identical IDs since we currently don't have
331 * means to atomically check whether a session ID already exists and make
332 * a reservation for it if it does not (this problem applies to the
333 * internal cache as well).
338 int ssl_generate_session_id(SSL
*s
, SSL_SESSION
*ss
)
341 GEN_SESSION_CB cb
= def_generate_session_id
;
343 switch (s
->version
) {
351 case DTLS1_2_VERSION
:
352 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
355 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_UNSUPPORTED_SSL_VERSION
);
360 * If RFC5077 ticket, use empty session ID (as server).
362 * (a) ssl_get_prev_session() does lookahead into the
363 * ClientHello extensions to find the session ticket.
364 * When ssl_get_prev_session() fails, statem_srvr.c calls
365 * ssl_get_new_session() in tls_process_client_hello().
366 * At that point, it has not yet parsed the extensions,
367 * however, because of the lookahead, it already knows
368 * whether a ticket is expected or not.
370 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
371 * ServerHello extensions, and before recording the session
372 * ID received from the server, so this block is a noop.
374 if (s
->ext
.ticket_expected
) {
375 ss
->session_id_length
= 0;
379 /* Choose which callback will set the session ID */
380 if (!CRYPTO_THREAD_read_lock(s
->lock
))
382 if (!CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
)) {
383 CRYPTO_THREAD_unlock(s
->lock
);
384 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
385 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
388 if (s
->generate_session_id
)
389 cb
= s
->generate_session_id
;
390 else if (s
->session_ctx
->generate_session_id
)
391 cb
= s
->session_ctx
->generate_session_id
;
392 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
393 CRYPTO_THREAD_unlock(s
->lock
);
394 /* Choose a session ID */
395 memset(ss
->session_id
, 0, ss
->session_id_length
);
396 tmp
= (int)ss
->session_id_length
;
397 if (!cb(s
, ss
->session_id
, &tmp
)) {
398 /* The callback failed */
399 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
400 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED
);
404 * Don't allow the callback to set the session length to zero. nor
405 * set it higher than it was.
407 if (tmp
== 0 || tmp
> ss
->session_id_length
) {
408 /* The callback set an illegal length */
409 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
410 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH
);
413 ss
->session_id_length
= tmp
;
414 /* Finally, check for a conflict */
415 if (SSL_has_matching_session_id(s
, ss
->session_id
,
416 (unsigned int)ss
->session_id_length
)) {
417 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_SSL_SESSION_ID_CONFLICT
);
424 int ssl_get_new_session(SSL
*s
, int session
)
426 /* This gets used by clients and servers. */
428 SSL_SESSION
*ss
= NULL
;
430 if ((ss
= SSL_SESSION_new()) == NULL
) {
431 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
435 /* If the context has a default timeout, use it */
436 if (s
->session_ctx
->session_timeout
== 0)
437 ss
->timeout
= SSL_get_default_timeout(s
);
439 ss
->timeout
= s
->session_ctx
->session_timeout
;
440 ssl_session_calculate_timeout(ss
);
442 SSL_SESSION_free(s
->session
);
446 if (SSL_IS_TLS13(s
)) {
448 * We generate the session id while constructing the
449 * NewSessionTicket in TLSv1.3.
451 ss
->session_id_length
= 0;
452 } else if (!ssl_generate_session_id(s
, ss
)) {
453 /* SSLfatal() already called */
454 SSL_SESSION_free(ss
);
459 ss
->session_id_length
= 0;
462 if (s
->sid_ctx_length
> sizeof(ss
->sid_ctx
)) {
463 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
464 SSL_SESSION_free(ss
);
467 memcpy(ss
->sid_ctx
, s
->sid_ctx
, s
->sid_ctx_length
);
468 ss
->sid_ctx_length
= s
->sid_ctx_length
;
470 ss
->ssl_version
= s
->version
;
471 ss
->verify_result
= X509_V_OK
;
473 /* If client supports extended master secret set it in session */
474 if (s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
)
475 ss
->flags
|= SSL_SESS_FLAG_EXTMS
;
480 SSL_SESSION
*lookup_sess_in_cache(SSL
*s
, const unsigned char *sess_id
,
483 SSL_SESSION
*ret
= NULL
;
485 if ((s
->session_ctx
->session_cache_mode
486 & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
) == 0) {
489 data
.ssl_version
= s
->version
;
490 if (!ossl_assert(sess_id_len
<= SSL_MAX_SSL_SESSION_ID_LENGTH
))
493 memcpy(data
.session_id
, sess_id
, sess_id_len
);
494 data
.session_id_length
= sess_id_len
;
496 if (!CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
))
498 ret
= lh_SSL_SESSION_retrieve(s
->session_ctx
->sessions
, &data
);
500 /* don't allow other threads to steal it: */
501 SSL_SESSION_up_ref(ret
);
503 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
505 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_miss
);
508 if (ret
== NULL
&& s
->session_ctx
->get_session_cb
!= NULL
) {
511 ret
= s
->session_ctx
->get_session_cb(s
, sess_id
, sess_id_len
, ©
);
514 ssl_tsan_counter(s
->session_ctx
,
515 &s
->session_ctx
->stats
.sess_cb_hit
);
518 * Increment reference count now if the session callback asks us
519 * to do so (note that if the session structures returned by the
520 * callback are shared between threads, it must handle the
521 * reference count itself [i.e. copy == 0], or things won't be
525 SSL_SESSION_up_ref(ret
);
528 * Add the externally cached session to the internal cache as
529 * well if and only if we are supposed to.
531 if ((s
->session_ctx
->session_cache_mode
&
532 SSL_SESS_CACHE_NO_INTERNAL_STORE
) == 0) {
534 * Either return value of SSL_CTX_add_session should not
535 * interrupt the session resumption process. The return
536 * value is intentionally ignored.
538 (void)SSL_CTX_add_session(s
->session_ctx
, ret
);
547 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
548 * connection. It is only called by servers.
550 * hello: The parsed ClientHello data
554 * 0: no session found
555 * 1: a session may have been found.
558 * - If a session is found then s->session is pointed at it (after freeing an
559 * existing session if need be) and s->verify_result is set from the session.
560 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
561 * if the server should issue a new session ticket (to 0 otherwise).
563 int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
)
565 /* This is used only by servers. */
567 SSL_SESSION
*ret
= NULL
;
569 int try_session_cache
= 0;
572 if (SSL_IS_TLS13(s
)) {
574 * By default we will send a new ticket. This can be overridden in the
577 s
->ext
.ticket_expected
= 1;
578 if (!tls_parse_extension(s
, TLSEXT_IDX_psk_kex_modes
,
579 SSL_EXT_CLIENT_HELLO
, hello
->pre_proc_exts
,
581 || !tls_parse_extension(s
, TLSEXT_IDX_psk
, SSL_EXT_CLIENT_HELLO
,
582 hello
->pre_proc_exts
, NULL
, 0))
587 /* sets s->ext.ticket_expected */
588 r
= tls_get_ticket_from_client(s
, hello
, &ret
);
590 case SSL_TICKET_FATAL_ERR_MALLOC
:
591 case SSL_TICKET_FATAL_ERR_OTHER
:
593 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
595 case SSL_TICKET_NONE
:
596 case SSL_TICKET_EMPTY
:
597 if (hello
->session_id_len
> 0) {
598 try_session_cache
= 1;
599 ret
= lookup_sess_in_cache(s
, hello
->session_id
,
600 hello
->session_id_len
);
603 case SSL_TICKET_NO_DECRYPT
:
604 case SSL_TICKET_SUCCESS
:
605 case SSL_TICKET_SUCCESS_RENEW
:
613 /* Now ret is non-NULL and we own one of its reference counts. */
615 /* Check TLS version consistency */
616 if (ret
->ssl_version
!= s
->version
)
619 if (ret
->sid_ctx_length
!= s
->sid_ctx_length
620 || memcmp(ret
->sid_ctx
, s
->sid_ctx
, ret
->sid_ctx_length
)) {
622 * We have the session requested by the client, but we don't want to
623 * use it in this context.
625 goto err
; /* treat like cache miss */
628 if ((s
->verify_mode
& SSL_VERIFY_PEER
) && s
->sid_ctx_length
== 0) {
630 * We can't be sure if this session is being used out of context,
631 * which is especially important for SSL_VERIFY_PEER. The application
632 * should have used SSL[_CTX]_set_session_id_context. For this error
633 * case, we generate an error instead of treating the event like a
634 * cache miss (otherwise it would be easy for applications to
635 * effectively disable the session cache by accident without anyone
639 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
640 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
645 if (sess_timedout(time(NULL
), ret
)) {
646 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_timeout
);
647 if (try_session_cache
) {
648 /* session was from the cache, so remove it */
649 SSL_CTX_remove_session(s
->session_ctx
, ret
);
654 /* Check extended master secret extension consistency */
655 if (ret
->flags
& SSL_SESS_FLAG_EXTMS
) {
656 /* If old session includes extms, but new does not: abort handshake */
657 if (!(s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
)) {
658 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_INCONSISTENT_EXTMS
);
662 } else if (s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
) {
663 /* If new session includes extms, but old does not: do not resume */
667 if (!SSL_IS_TLS13(s
)) {
668 /* We already did this for TLS1.3 */
669 SSL_SESSION_free(s
->session
);
673 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_hit
);
674 s
->verify_result
= s
->session
->verify_result
;
679 SSL_SESSION_free(ret
);
680 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
684 if (!try_session_cache
) {
686 * The session was from a ticket, so we should issue a ticket for
689 s
->ext
.ticket_expected
= 1;
698 int SSL_CTX_add_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
704 * add just 1 reference count for the SSL_CTX's session cache even though
705 * it has two ways of access: each session is in a doubly linked list and
708 SSL_SESSION_up_ref(c
);
710 * if session c is in already in cache, we take back the increment later
713 if (!CRYPTO_THREAD_write_lock(ctx
->lock
)) {
717 s
= lh_SSL_SESSION_insert(ctx
->sessions
, c
);
720 * s != NULL iff we already had a session with the given PID. In this
721 * case, s == c should hold (then we did not really modify
722 * ctx->sessions), or we're in trouble.
724 if (s
!= NULL
&& s
!= c
) {
725 /* We *are* in trouble ... */
726 SSL_SESSION_list_remove(ctx
, s
);
729 * ... so pretend the other session did not exist in cache (we cannot
730 * handle two SSL_SESSION structures with identical session ID in the
731 * same cache, which could happen e.g. when two threads concurrently
732 * obtain the same session from an external cache)
735 } else if (s
== NULL
&&
736 lh_SSL_SESSION_retrieve(ctx
->sessions
, c
) == NULL
) {
737 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
740 * ... so take back the extra reference and also don't add
741 * the session to the SSL_SESSION_list at this time
746 /* Adjust last used time, and add back into the cache at the appropriate spot */
747 if (ctx
->session_cache_mode
& SSL_SESS_CACHE_UPDATE_TIME
) {
748 c
->time
= time(NULL
);
749 ssl_session_calculate_timeout(c
);
751 SSL_SESSION_list_add(ctx
, c
);
755 * existing cache entry -- decrement previously incremented reference
756 * count because it already takes into account the cache
759 SSL_SESSION_free(s
); /* s == c */
763 * new cache entry -- remove old ones if cache has become too large
768 if (SSL_CTX_sess_get_cache_size(ctx
) > 0) {
769 while (SSL_CTX_sess_number(ctx
) > SSL_CTX_sess_get_cache_size(ctx
)) {
770 if (!remove_session_lock(ctx
, ctx
->session_cache_tail
, 0))
773 ssl_tsan_counter(ctx
, &ctx
->stats
.sess_cache_full
);
777 CRYPTO_THREAD_unlock(ctx
->lock
);
781 int SSL_CTX_remove_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
783 return remove_session_lock(ctx
, c
, 1);
786 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
)
791 if ((c
!= NULL
) && (c
->session_id_length
!= 0)) {
793 if (!CRYPTO_THREAD_write_lock(ctx
->lock
))
796 if ((r
= lh_SSL_SESSION_retrieve(ctx
->sessions
, c
)) != NULL
) {
798 r
= lh_SSL_SESSION_delete(ctx
->sessions
, r
);
799 SSL_SESSION_list_remove(ctx
, r
);
801 c
->not_resumable
= 1;
804 CRYPTO_THREAD_unlock(ctx
->lock
);
806 if (ctx
->remove_session_cb
!= NULL
)
807 ctx
->remove_session_cb(ctx
, c
);
815 void SSL_SESSION_free(SSL_SESSION
*ss
)
821 CRYPTO_DOWN_REF(&ss
->references
, &i
, ss
->lock
);
822 REF_PRINT_COUNT("SSL_SESSION", ss
);
825 REF_ASSERT_ISNT(i
< 0);
827 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
);
829 OPENSSL_cleanse(ss
->master_key
, sizeof(ss
->master_key
));
830 OPENSSL_cleanse(ss
->session_id
, sizeof(ss
->session_id
));
832 OSSL_STACK_OF_X509_free(ss
->peer_chain
);
833 OPENSSL_free(ss
->ext
.hostname
);
834 OPENSSL_free(ss
->ext
.tick
);
835 #ifndef OPENSSL_NO_PSK
836 OPENSSL_free(ss
->psk_identity_hint
);
837 OPENSSL_free(ss
->psk_identity
);
839 #ifndef OPENSSL_NO_SRP
840 OPENSSL_free(ss
->srp_username
);
842 OPENSSL_free(ss
->ext
.alpn_selected
);
843 OPENSSL_free(ss
->ticket_appdata
);
844 CRYPTO_THREAD_lock_free(ss
->lock
);
845 OPENSSL_clear_free(ss
, sizeof(*ss
));
848 int SSL_SESSION_up_ref(SSL_SESSION
*ss
)
852 if (CRYPTO_UP_REF(&ss
->references
, &i
, ss
->lock
) <= 0)
855 REF_PRINT_COUNT("SSL_SESSION", ss
);
856 REF_ASSERT_ISNT(i
< 2);
857 return ((i
> 1) ? 1 : 0);
860 int SSL_set_session(SSL
*s
, SSL_SESSION
*session
)
862 ssl_clear_bad_session(s
);
863 if (s
->ctx
->method
!= s
->method
) {
864 if (!SSL_set_ssl_method(s
, s
->ctx
->method
))
868 if (session
!= NULL
) {
869 SSL_SESSION_up_ref(session
);
870 s
->verify_result
= session
->verify_result
;
872 SSL_SESSION_free(s
->session
);
873 s
->session
= session
;
878 int SSL_SESSION_set1_id(SSL_SESSION
*s
, const unsigned char *sid
,
879 unsigned int sid_len
)
881 if (sid_len
> SSL_MAX_SSL_SESSION_ID_LENGTH
) {
882 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_TOO_LONG
);
885 s
->session_id_length
= sid_len
;
886 if (sid
!= s
->session_id
)
887 memcpy(s
->session_id
, sid
, sid_len
);
891 long SSL_SESSION_set_timeout(SSL_SESSION
*s
, long t
)
893 time_t new_timeout
= (time_t)t
;
895 if (s
== NULL
|| t
< 0)
897 if (s
->owner
!= NULL
) {
898 if (!CRYPTO_THREAD_write_lock(s
->owner
->lock
))
900 s
->timeout
= new_timeout
;
901 ssl_session_calculate_timeout(s
);
902 SSL_SESSION_list_add(s
->owner
, s
);
903 CRYPTO_THREAD_unlock(s
->owner
->lock
);
905 s
->timeout
= new_timeout
;
906 ssl_session_calculate_timeout(s
);
911 long SSL_SESSION_get_timeout(const SSL_SESSION
*s
)
915 return (long)s
->timeout
;
918 long SSL_SESSION_get_time(const SSL_SESSION
*s
)
922 return (long)s
->time
;
925 long SSL_SESSION_set_time(SSL_SESSION
*s
, long t
)
927 time_t new_time
= (time_t)t
;
931 if (s
->owner
!= NULL
) {
932 if (!CRYPTO_THREAD_write_lock(s
->owner
->lock
))
935 ssl_session_calculate_timeout(s
);
936 SSL_SESSION_list_add(s
->owner
, s
);
937 CRYPTO_THREAD_unlock(s
->owner
->lock
);
940 ssl_session_calculate_timeout(s
);
945 int SSL_SESSION_get_protocol_version(const SSL_SESSION
*s
)
947 return s
->ssl_version
;
950 int SSL_SESSION_set_protocol_version(SSL_SESSION
*s
, int version
)
952 s
->ssl_version
= version
;
956 const SSL_CIPHER
*SSL_SESSION_get0_cipher(const SSL_SESSION
*s
)
961 int SSL_SESSION_set_cipher(SSL_SESSION
*s
, const SSL_CIPHER
*cipher
)
967 const char *SSL_SESSION_get0_hostname(const SSL_SESSION
*s
)
969 return s
->ext
.hostname
;
972 int SSL_SESSION_set1_hostname(SSL_SESSION
*s
, const char *hostname
)
974 OPENSSL_free(s
->ext
.hostname
);
975 if (hostname
== NULL
) {
976 s
->ext
.hostname
= NULL
;
979 s
->ext
.hostname
= OPENSSL_strdup(hostname
);
981 return s
->ext
.hostname
!= NULL
;
984 int SSL_SESSION_has_ticket(const SSL_SESSION
*s
)
986 return (s
->ext
.ticklen
> 0) ? 1 : 0;
989 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION
*s
)
991 return s
->ext
.tick_lifetime_hint
;
994 void SSL_SESSION_get0_ticket(const SSL_SESSION
*s
, const unsigned char **tick
,
997 *len
= s
->ext
.ticklen
;
1002 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION
*s
)
1004 return s
->ext
.max_early_data
;
1007 int SSL_SESSION_set_max_early_data(SSL_SESSION
*s
, uint32_t max_early_data
)
1009 s
->ext
.max_early_data
= max_early_data
;
1014 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION
*s
,
1015 const unsigned char **alpn
,
1018 *alpn
= s
->ext
.alpn_selected
;
1019 *len
= s
->ext
.alpn_selected_len
;
1022 int SSL_SESSION_set1_alpn_selected(SSL_SESSION
*s
, const unsigned char *alpn
,
1025 OPENSSL_free(s
->ext
.alpn_selected
);
1026 if (alpn
== NULL
|| len
== 0) {
1027 s
->ext
.alpn_selected
= NULL
;
1028 s
->ext
.alpn_selected_len
= 0;
1031 s
->ext
.alpn_selected
= OPENSSL_memdup(alpn
, len
);
1032 if (s
->ext
.alpn_selected
== NULL
) {
1033 s
->ext
.alpn_selected_len
= 0;
1036 s
->ext
.alpn_selected_len
= len
;
1041 X509
*SSL_SESSION_get0_peer(SSL_SESSION
*s
)
1046 int SSL_SESSION_set1_id_context(SSL_SESSION
*s
, const unsigned char *sid_ctx
,
1047 unsigned int sid_ctx_len
)
1049 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
1050 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
1053 s
->sid_ctx_length
= sid_ctx_len
;
1054 if (sid_ctx
!= s
->sid_ctx
)
1055 memcpy(s
->sid_ctx
, sid_ctx
, sid_ctx_len
);
1060 int SSL_SESSION_is_resumable(const SSL_SESSION
*s
)
1063 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
1066 return !s
->not_resumable
1067 && (s
->session_id_length
> 0 || s
->ext
.ticklen
> 0);
1070 long SSL_CTX_set_timeout(SSL_CTX
*s
, long t
)
1075 l
= s
->session_timeout
;
1076 s
->session_timeout
= t
;
1080 long SSL_CTX_get_timeout(const SSL_CTX
*s
)
1084 return s
->session_timeout
;
1087 int SSL_set_session_secret_cb(SSL
*s
,
1088 tls_session_secret_cb_fn tls_session_secret_cb
,
1093 s
->ext
.session_secret_cb
= tls_session_secret_cb
;
1094 s
->ext
.session_secret_cb_arg
= arg
;
1098 int SSL_set_session_ticket_ext_cb(SSL
*s
, tls_session_ticket_ext_cb_fn cb
,
1103 s
->ext
.session_ticket_cb
= cb
;
1104 s
->ext
.session_ticket_cb_arg
= arg
;
1108 int SSL_set_session_ticket_ext(SSL
*s
, void *ext_data
, int ext_len
)
1110 if (s
->version
>= TLS1_VERSION
) {
1111 OPENSSL_free(s
->ext
.session_ticket
);
1112 s
->ext
.session_ticket
= NULL
;
1113 s
->ext
.session_ticket
=
1114 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT
) + ext_len
);
1115 if (s
->ext
.session_ticket
== NULL
) {
1116 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
1120 if (ext_data
!= NULL
) {
1121 s
->ext
.session_ticket
->length
= ext_len
;
1122 s
->ext
.session_ticket
->data
= s
->ext
.session_ticket
+ 1;
1123 memcpy(s
->ext
.session_ticket
->data
, ext_data
, ext_len
);
1125 s
->ext
.session_ticket
->length
= 0;
1126 s
->ext
.session_ticket
->data
= NULL
;
1135 void SSL_CTX_flush_sessions(SSL_CTX
*s
, long t
)
1137 STACK_OF(SSL_SESSION
) *sk
;
1138 SSL_SESSION
*current
;
1141 if (!CRYPTO_THREAD_write_lock(s
->lock
))
1144 sk
= sk_SSL_SESSION_new_null();
1145 i
= lh_SSL_SESSION_get_down_load(s
->sessions
);
1146 lh_SSL_SESSION_set_down_load(s
->sessions
, 0);
1149 * Iterate over the list from the back (oldest), and stop
1150 * when a session can no longer be removed.
1151 * Add the session to a temporary list to be freed outside
1153 * But still do the remove_session_cb() within the lock.
1155 while (s
->session_cache_tail
!= NULL
) {
1156 current
= s
->session_cache_tail
;
1157 if (t
== 0 || sess_timedout((time_t)t
, current
)) {
1158 lh_SSL_SESSION_delete(s
->sessions
, current
);
1159 SSL_SESSION_list_remove(s
, current
);
1160 current
->not_resumable
= 1;
1161 if (s
->remove_session_cb
!= NULL
)
1162 s
->remove_session_cb(s
, current
);
1164 * Throw the session on a stack, it's entirely plausible
1165 * that while freeing outside the critical section, the
1166 * session could be re-added, so avoid using the next/prev
1167 * pointers. If the stack failed to create, or the session
1168 * couldn't be put on the stack, just free it here
1170 if (sk
== NULL
|| !sk_SSL_SESSION_push(sk
, current
))
1171 SSL_SESSION_free(current
);
1177 lh_SSL_SESSION_set_down_load(s
->sessions
, i
);
1178 CRYPTO_THREAD_unlock(s
->lock
);
1180 sk_SSL_SESSION_pop_free(sk
, SSL_SESSION_free
);
1183 int ssl_clear_bad_session(SSL
*s
)
1185 if ((s
->session
!= NULL
) &&
1186 !(s
->shutdown
& SSL_SENT_SHUTDOWN
) &&
1187 !(SSL_in_init(s
) || SSL_in_before(s
))) {
1188 SSL_CTX_remove_session(s
->session_ctx
, s
->session
);
1194 /* locked by SSL_CTX in the calling function */
1195 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1197 if ((s
->next
== NULL
) || (s
->prev
== NULL
))
1200 if (s
->next
== (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1201 /* last element in list */
1202 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1203 /* only one element in list */
1204 ctx
->session_cache_head
= NULL
;
1205 ctx
->session_cache_tail
= NULL
;
1207 ctx
->session_cache_tail
= s
->prev
;
1208 s
->prev
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1211 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1212 /* first element in list */
1213 ctx
->session_cache_head
= s
->next
;
1214 s
->next
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1216 /* middle of list */
1217 s
->next
->prev
= s
->prev
;
1218 s
->prev
->next
= s
->next
;
1221 s
->prev
= s
->next
= NULL
;
1225 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1229 if ((s
->next
!= NULL
) && (s
->prev
!= NULL
))
1230 SSL_SESSION_list_remove(ctx
, s
);
1232 if (ctx
->session_cache_head
== NULL
) {
1233 ctx
->session_cache_head
= s
;
1234 ctx
->session_cache_tail
= s
;
1235 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1236 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1238 if (timeoutcmp(s
, ctx
->session_cache_head
) >= 0) {
1240 * if we timeout after (or the same time as) the first
1241 * session, put us first - usual case
1243 s
->next
= ctx
->session_cache_head
;
1245 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1246 ctx
->session_cache_head
= s
;
1247 } else if (timeoutcmp(s
, ctx
->session_cache_tail
) < 0) {
1248 /* if we timeout before the last session, put us last */
1249 s
->prev
= ctx
->session_cache_tail
;
1251 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1252 ctx
->session_cache_tail
= s
;
1255 * we timeout somewhere in-between - if there is only
1256 * one session in the cache it will be caught above
1258 next
= ctx
->session_cache_head
->next
;
1259 while (next
!= (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1260 if (timeoutcmp(s
, next
) >= 0) {
1262 s
->prev
= next
->prev
;
1263 next
->prev
->next
= s
;
1274 void SSL_CTX_sess_set_new_cb(SSL_CTX
*ctx
,
1275 int (*cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
))
1277 ctx
->new_session_cb
= cb
;
1280 int (*SSL_CTX_sess_get_new_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, SSL_SESSION
*sess
) {
1281 return ctx
->new_session_cb
;
1284 void SSL_CTX_sess_set_remove_cb(SSL_CTX
*ctx
,
1285 void (*cb
) (SSL_CTX
*ctx
, SSL_SESSION
*sess
))
1287 ctx
->remove_session_cb
= cb
;
1290 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX
*ctx
)) (SSL_CTX
*ctx
,
1291 SSL_SESSION
*sess
) {
1292 return ctx
->remove_session_cb
;
1295 void SSL_CTX_sess_set_get_cb(SSL_CTX
*ctx
,
1296 SSL_SESSION
*(*cb
) (struct ssl_st
*ssl
,
1297 const unsigned char *data
,
1298 int len
, int *copy
))
1300 ctx
->get_session_cb
= cb
;
1303 SSL_SESSION
*(*SSL_CTX_sess_get_get_cb(SSL_CTX
*ctx
)) (SSL
*ssl
,
1307 return ctx
->get_session_cb
;
1310 void SSL_CTX_set_info_callback(SSL_CTX
*ctx
,
1311 void (*cb
) (const SSL
*ssl
, int type
, int val
))
1313 ctx
->info_callback
= cb
;
1316 void (*SSL_CTX_get_info_callback(SSL_CTX
*ctx
)) (const SSL
*ssl
, int type
,
1318 return ctx
->info_callback
;
1321 void SSL_CTX_set_client_cert_cb(SSL_CTX
*ctx
,
1322 int (*cb
) (SSL
*ssl
, X509
**x509
,
1325 ctx
->client_cert_cb
= cb
;
1328 int (*SSL_CTX_get_client_cert_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, X509
**x509
,
1330 return ctx
->client_cert_cb
;
1333 void SSL_CTX_set_cookie_generate_cb(SSL_CTX
*ctx
,
1334 int (*cb
) (SSL
*ssl
,
1335 unsigned char *cookie
,
1336 unsigned int *cookie_len
))
1338 ctx
->app_gen_cookie_cb
= cb
;
1341 void SSL_CTX_set_cookie_verify_cb(SSL_CTX
*ctx
,
1342 int (*cb
) (SSL
*ssl
,
1343 const unsigned char *cookie
,
1344 unsigned int cookie_len
))
1346 ctx
->app_verify_cookie_cb
= cb
;
1349 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION
*ss
, const void *data
, size_t len
)
1351 OPENSSL_free(ss
->ticket_appdata
);
1352 ss
->ticket_appdata_len
= 0;
1353 if (data
== NULL
|| len
== 0) {
1354 ss
->ticket_appdata
= NULL
;
1357 ss
->ticket_appdata
= OPENSSL_memdup(data
, len
);
1358 if (ss
->ticket_appdata
!= NULL
) {
1359 ss
->ticket_appdata_len
= len
;
1365 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION
*ss
, void **data
, size_t *len
)
1367 *data
= ss
->ticket_appdata
;
1368 *len
= ss
->ticket_appdata_len
;
1372 void SSL_CTX_set_stateless_cookie_generate_cb(
1374 int (*cb
) (SSL
*ssl
,
1375 unsigned char *cookie
,
1376 size_t *cookie_len
))
1378 ctx
->gen_stateless_cookie_cb
= cb
;
1381 void SSL_CTX_set_stateless_cookie_verify_cb(
1383 int (*cb
) (SSL
*ssl
,
1384 const unsigned char *cookie
,
1387 ctx
->verify_stateless_cookie_cb
= cb
;
1390 IMPLEMENT_PEM_rw(SSL_SESSION
, SSL_SESSION
, PEM_STRING_SSL_SESSION
, SSL_SESSION
)