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 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
));
110 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
114 ss
->verify_result
= 1; /* avoid 0 (= X509_V_OK) just in case */
116 /* 5 minute timeout by default */
117 ss
->timeout
= ossl_seconds2time(60 * 5 + 4);
118 ss
->time
= ossl_time_now();
119 ssl_session_calculate_timeout(ss
);
120 ss
->lock
= CRYPTO_THREAD_lock_new();
121 if (ss
->lock
== NULL
) {
122 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
127 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
)) {
128 CRYPTO_THREAD_lock_free(ss
->lock
);
135 SSL_SESSION
*SSL_SESSION_dup(const SSL_SESSION
*src
)
137 return ssl_session_dup(src
, 1);
141 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
142 * ticket == 0 then no ticket information is duplicated, otherwise it is.
144 SSL_SESSION
*ssl_session_dup(const SSL_SESSION
*src
, int ticket
)
148 dest
= OPENSSL_malloc(sizeof(*dest
));
152 memcpy(dest
, src
, sizeof(*dest
));
155 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
156 * the case of an error whilst halfway through constructing dest
158 #ifndef OPENSSL_NO_PSK
159 dest
->psk_identity_hint
= NULL
;
160 dest
->psk_identity
= NULL
;
162 dest
->ext
.hostname
= NULL
;
163 dest
->ext
.tick
= NULL
;
164 dest
->ext
.alpn_selected
= NULL
;
165 #ifndef OPENSSL_NO_SRP
166 dest
->srp_username
= NULL
;
168 dest
->peer_chain
= NULL
;
170 dest
->ticket_appdata
= NULL
;
171 memset(&dest
->ex_data
, 0, sizeof(dest
->ex_data
));
173 /* We deliberately don't copy the prev and next pointers */
177 dest
->references
= 1;
179 dest
->lock
= CRYPTO_THREAD_lock_new();
180 if (dest
->lock
== NULL
)
183 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, dest
, &dest
->ex_data
))
186 if (src
->peer
!= NULL
) {
187 if (!X509_up_ref(src
->peer
))
189 dest
->peer
= src
->peer
;
192 if (src
->peer_chain
!= NULL
) {
193 dest
->peer_chain
= X509_chain_up_ref(src
->peer_chain
);
194 if (dest
->peer_chain
== NULL
)
197 #ifndef OPENSSL_NO_PSK
198 if (src
->psk_identity_hint
) {
199 dest
->psk_identity_hint
= OPENSSL_strdup(src
->psk_identity_hint
);
200 if (dest
->psk_identity_hint
== NULL
) {
204 if (src
->psk_identity
) {
205 dest
->psk_identity
= OPENSSL_strdup(src
->psk_identity
);
206 if (dest
->psk_identity
== NULL
) {
212 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
,
213 &dest
->ex_data
, &src
->ex_data
)) {
217 if (src
->ext
.hostname
) {
218 dest
->ext
.hostname
= OPENSSL_strdup(src
->ext
.hostname
);
219 if (dest
->ext
.hostname
== NULL
) {
224 if (ticket
!= 0 && src
->ext
.tick
!= NULL
) {
226 OPENSSL_memdup(src
->ext
.tick
, src
->ext
.ticklen
);
227 if (dest
->ext
.tick
== NULL
)
230 dest
->ext
.tick_lifetime_hint
= 0;
231 dest
->ext
.ticklen
= 0;
234 if (src
->ext
.alpn_selected
!= NULL
) {
235 dest
->ext
.alpn_selected
= OPENSSL_memdup(src
->ext
.alpn_selected
,
236 src
->ext
.alpn_selected_len
);
237 if (dest
->ext
.alpn_selected
== NULL
)
241 #ifndef OPENSSL_NO_SRP
242 if (src
->srp_username
) {
243 dest
->srp_username
= OPENSSL_strdup(src
->srp_username
);
244 if (dest
->srp_username
== NULL
) {
250 if (src
->ticket_appdata
!= NULL
) {
251 dest
->ticket_appdata
=
252 OPENSSL_memdup(src
->ticket_appdata
, src
->ticket_appdata_len
);
253 if (dest
->ticket_appdata
== NULL
)
259 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
260 SSL_SESSION_free(dest
);
264 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION
*s
, unsigned int *len
)
267 *len
= (unsigned int)s
->session_id_length
;
268 return s
->session_id
;
270 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION
*s
,
274 *len
= (unsigned int)s
->sid_ctx_length
;
278 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION
*s
)
280 return s
->compress_meth
;
284 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
285 * the ID with random junk repeatedly until we have no conflict is going to
286 * complete in one iteration pretty much "most" of the time (btw:
287 * understatement). So, if it takes us 10 iterations and we still can't avoid
288 * a conflict - well that's a reasonable point to call it quits. Either the
289 * RAND code is broken or someone is trying to open roughly very close to
290 * 2^256 SSL sessions to our server. How you might store that many sessions
291 * is perhaps a more interesting question ...
294 #define MAX_SESS_ID_ATTEMPTS 10
295 static int def_generate_session_id(SSL
*ssl
, unsigned char *id
,
296 unsigned int *id_len
)
298 unsigned int retry
= 0;
300 if (RAND_bytes_ex(ssl
->ctx
->libctx
, id
, *id_len
, 0) <= 0)
302 while (SSL_has_matching_session_id(ssl
, id
, *id_len
) &&
303 (++retry
< MAX_SESS_ID_ATTEMPTS
)) ;
304 if (retry
< MAX_SESS_ID_ATTEMPTS
)
306 /* else - woops a session_id match */
308 * XXX We should also check the external cache -- but the probability of
309 * a collision is negligible, and we could not prevent the concurrent
310 * creation of sessions with identical IDs since we currently don't have
311 * means to atomically check whether a session ID already exists and make
312 * a reservation for it if it does not (this problem applies to the
313 * internal cache as well).
318 int ssl_generate_session_id(SSL_CONNECTION
*s
, SSL_SESSION
*ss
)
321 GEN_SESSION_CB cb
= def_generate_session_id
;
322 SSL
*ssl
= SSL_CONNECTION_GET_SSL(s
);
324 switch (s
->version
) {
332 case DTLS1_2_VERSION
:
333 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
336 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_UNSUPPORTED_SSL_VERSION
);
341 * If RFC5077 ticket, use empty session ID (as server).
343 * (a) ssl_get_prev_session() does lookahead into the
344 * ClientHello extensions to find the session ticket.
345 * When ssl_get_prev_session() fails, statem_srvr.c calls
346 * ssl_get_new_session() in tls_process_client_hello().
347 * At that point, it has not yet parsed the extensions,
348 * however, because of the lookahead, it already knows
349 * whether a ticket is expected or not.
351 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
352 * ServerHello extensions, and before recording the session
353 * ID received from the server, so this block is a noop.
355 if (s
->ext
.ticket_expected
) {
356 ss
->session_id_length
= 0;
360 /* Choose which callback will set the session ID */
361 if (!CRYPTO_THREAD_read_lock(SSL_CONNECTION_GET_SSL(s
)->lock
))
363 if (!CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
)) {
364 CRYPTO_THREAD_unlock(ssl
->lock
);
365 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
366 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
369 if (s
->generate_session_id
)
370 cb
= s
->generate_session_id
;
371 else if (s
->session_ctx
->generate_session_id
)
372 cb
= s
->session_ctx
->generate_session_id
;
373 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
374 CRYPTO_THREAD_unlock(ssl
->lock
);
375 /* Choose a session ID */
376 memset(ss
->session_id
, 0, ss
->session_id_length
);
377 tmp
= (int)ss
->session_id_length
;
378 if (!cb(ssl
, ss
->session_id
, &tmp
)) {
379 /* The callback failed */
380 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
381 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED
);
385 * Don't allow the callback to set the session length to zero. nor
386 * set it higher than it was.
388 if (tmp
== 0 || tmp
> ss
->session_id_length
) {
389 /* The callback set an illegal length */
390 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
391 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH
);
394 ss
->session_id_length
= tmp
;
395 /* Finally, check for a conflict */
396 if (SSL_has_matching_session_id(ssl
, ss
->session_id
,
397 (unsigned int)ss
->session_id_length
)) {
398 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_SSL_SESSION_ID_CONFLICT
);
405 int ssl_get_new_session(SSL_CONNECTION
*s
, int session
)
407 /* This gets used by clients and servers. */
409 SSL_SESSION
*ss
= NULL
;
411 if ((ss
= SSL_SESSION_new()) == NULL
) {
412 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
416 /* If the context has a default timeout, use it */
417 if (ossl_time_is_zero(s
->session_ctx
->session_timeout
))
418 ss
->timeout
= SSL_CONNECTION_GET_SSL(s
)->method
->get_timeout();
420 ss
->timeout
= s
->session_ctx
->session_timeout
;
421 ssl_session_calculate_timeout(ss
);
423 SSL_SESSION_free(s
->session
);
427 if (SSL_CONNECTION_IS_TLS13(s
)) {
429 * We generate the session id while constructing the
430 * NewSessionTicket in TLSv1.3.
432 ss
->session_id_length
= 0;
433 } else if (!ssl_generate_session_id(s
, ss
)) {
434 /* SSLfatal() already called */
435 SSL_SESSION_free(ss
);
440 ss
->session_id_length
= 0;
443 if (s
->sid_ctx_length
> sizeof(ss
->sid_ctx
)) {
444 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
445 SSL_SESSION_free(ss
);
448 memcpy(ss
->sid_ctx
, s
->sid_ctx
, s
->sid_ctx_length
);
449 ss
->sid_ctx_length
= s
->sid_ctx_length
;
451 ss
->ssl_version
= s
->version
;
452 ss
->verify_result
= X509_V_OK
;
454 /* If client supports extended master secret set it in session */
455 if (s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
)
456 ss
->flags
|= SSL_SESS_FLAG_EXTMS
;
461 SSL_SESSION
*lookup_sess_in_cache(SSL_CONNECTION
*s
,
462 const unsigned char *sess_id
,
465 SSL_SESSION
*ret
= NULL
;
467 if ((s
->session_ctx
->session_cache_mode
468 & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
) == 0) {
471 data
.ssl_version
= s
->version
;
472 if (!ossl_assert(sess_id_len
<= SSL_MAX_SSL_SESSION_ID_LENGTH
))
475 memcpy(data
.session_id
, sess_id
, sess_id_len
);
476 data
.session_id_length
= sess_id_len
;
478 if (!CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
))
480 ret
= lh_SSL_SESSION_retrieve(s
->session_ctx
->sessions
, &data
);
482 /* don't allow other threads to steal it: */
483 SSL_SESSION_up_ref(ret
);
485 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
487 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_miss
);
490 if (ret
== NULL
&& s
->session_ctx
->get_session_cb
!= NULL
) {
493 ret
= s
->session_ctx
->get_session_cb(SSL_CONNECTION_GET_SSL(s
),
494 sess_id
, sess_id_len
, ©
);
497 ssl_tsan_counter(s
->session_ctx
,
498 &s
->session_ctx
->stats
.sess_cb_hit
);
501 * Increment reference count now if the session callback asks us
502 * to do so (note that if the session structures returned by the
503 * callback are shared between threads, it must handle the
504 * reference count itself [i.e. copy == 0], or things won't be
508 SSL_SESSION_up_ref(ret
);
511 * Add the externally cached session to the internal cache as
512 * well if and only if we are supposed to.
514 if ((s
->session_ctx
->session_cache_mode
&
515 SSL_SESS_CACHE_NO_INTERNAL_STORE
) == 0) {
517 * Either return value of SSL_CTX_add_session should not
518 * interrupt the session resumption process. The return
519 * value is intentionally ignored.
521 (void)SSL_CTX_add_session(s
->session_ctx
, ret
);
530 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
531 * connection. It is only called by servers.
533 * hello: The parsed ClientHello data
537 * 0: no session found
538 * 1: a session may have been found.
541 * - If a session is found then s->session is pointed at it (after freeing an
542 * existing session if need be) and s->verify_result is set from the session.
543 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
544 * if the server should issue a new session ticket (to 0 otherwise).
546 int ssl_get_prev_session(SSL_CONNECTION
*s
, CLIENTHELLO_MSG
*hello
)
548 /* This is used only by servers. */
550 SSL_SESSION
*ret
= NULL
;
552 int try_session_cache
= 0;
555 if (SSL_CONNECTION_IS_TLS13(s
)) {
557 * By default we will send a new ticket. This can be overridden in the
560 s
->ext
.ticket_expected
= 1;
561 if (!tls_parse_extension(s
, TLSEXT_IDX_psk_kex_modes
,
562 SSL_EXT_CLIENT_HELLO
, hello
->pre_proc_exts
,
564 || !tls_parse_extension(s
, TLSEXT_IDX_psk
, SSL_EXT_CLIENT_HELLO
,
565 hello
->pre_proc_exts
, NULL
, 0))
570 /* sets s->ext.ticket_expected */
571 r
= tls_get_ticket_from_client(s
, hello
, &ret
);
573 case SSL_TICKET_FATAL_ERR_MALLOC
:
574 case SSL_TICKET_FATAL_ERR_OTHER
:
576 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
578 case SSL_TICKET_NONE
:
579 case SSL_TICKET_EMPTY
:
580 if (hello
->session_id_len
> 0) {
581 try_session_cache
= 1;
582 ret
= lookup_sess_in_cache(s
, hello
->session_id
,
583 hello
->session_id_len
);
586 case SSL_TICKET_NO_DECRYPT
:
587 case SSL_TICKET_SUCCESS
:
588 case SSL_TICKET_SUCCESS_RENEW
:
596 /* Now ret is non-NULL and we own one of its reference counts. */
598 /* Check TLS version consistency */
599 if (ret
->ssl_version
!= s
->version
)
602 if (ret
->sid_ctx_length
!= s
->sid_ctx_length
603 || memcmp(ret
->sid_ctx
, s
->sid_ctx
, ret
->sid_ctx_length
)) {
605 * We have the session requested by the client, but we don't want to
606 * use it in this context.
608 goto err
; /* treat like cache miss */
611 if ((s
->verify_mode
& SSL_VERIFY_PEER
) && s
->sid_ctx_length
== 0) {
613 * We can't be sure if this session is being used out of context,
614 * which is especially important for SSL_VERIFY_PEER. The application
615 * should have used SSL[_CTX]_set_session_id_context. For this error
616 * case, we generate an error instead of treating the event like a
617 * cache miss (otherwise it would be easy for applications to
618 * effectively disable the session cache by accident without anyone
622 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
,
623 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
628 if (sess_timedout(ossl_time_now(), ret
)) {
629 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_timeout
);
630 if (try_session_cache
) {
631 /* session was from the cache, so remove it */
632 SSL_CTX_remove_session(s
->session_ctx
, ret
);
637 /* Check extended master secret extension consistency */
638 if (ret
->flags
& SSL_SESS_FLAG_EXTMS
) {
639 /* If old session includes extms, but new does not: abort handshake */
640 if (!(s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
)) {
641 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_R_INCONSISTENT_EXTMS
);
645 } else if (s
->s3
.flags
& TLS1_FLAGS_RECEIVED_EXTMS
) {
646 /* If new session includes extms, but old does not: do not resume */
650 if (!SSL_CONNECTION_IS_TLS13(s
)) {
651 /* We already did this for TLS1.3 */
652 SSL_SESSION_free(s
->session
);
656 ssl_tsan_counter(s
->session_ctx
, &s
->session_ctx
->stats
.sess_hit
);
657 s
->verify_result
= s
->session
->verify_result
;
662 SSL_SESSION_free(ret
);
663 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
664 if (SSL_CONNECTION_IS_TLS13(s
))
667 if (!try_session_cache
) {
669 * The session was from a ticket, so we should issue a ticket for
672 s
->ext
.ticket_expected
= 1;
681 int SSL_CTX_add_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
687 * add just 1 reference count for the SSL_CTX's session cache even though
688 * it has two ways of access: each session is in a doubly linked list and
691 SSL_SESSION_up_ref(c
);
693 * if session c is in already in cache, we take back the increment later
696 if (!CRYPTO_THREAD_write_lock(ctx
->lock
)) {
700 s
= lh_SSL_SESSION_insert(ctx
->sessions
, c
);
703 * s != NULL iff we already had a session with the given PID. In this
704 * case, s == c should hold (then we did not really modify
705 * ctx->sessions), or we're in trouble.
707 if (s
!= NULL
&& s
!= c
) {
708 /* We *are* in trouble ... */
709 SSL_SESSION_list_remove(ctx
, s
);
712 * ... so pretend the other session did not exist in cache (we cannot
713 * handle two SSL_SESSION structures with identical session ID in the
714 * same cache, which could happen e.g. when two threads concurrently
715 * obtain the same session from an external cache)
718 } else if (s
== NULL
&&
719 lh_SSL_SESSION_retrieve(ctx
->sessions
, c
) == NULL
) {
720 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
723 * ... so take back the extra reference and also don't add
724 * the session to the SSL_SESSION_list at this time
729 /* Adjust last used time, and add back into the cache at the appropriate spot */
730 if (ctx
->session_cache_mode
& SSL_SESS_CACHE_UPDATE_TIME
) {
731 c
->time
= ossl_time_now();
732 ssl_session_calculate_timeout(c
);
737 * new cache entry -- remove old ones if cache has become too large
738 * delete cache entry *before* add, so we don't remove the one we're adding!
743 if (SSL_CTX_sess_get_cache_size(ctx
) > 0) {
744 while (SSL_CTX_sess_number(ctx
) >= SSL_CTX_sess_get_cache_size(ctx
)) {
745 if (!remove_session_lock(ctx
, ctx
->session_cache_tail
, 0))
748 ssl_tsan_counter(ctx
, &ctx
->stats
.sess_cache_full
);
753 SSL_SESSION_list_add(ctx
, c
);
757 * existing cache entry -- decrement previously incremented reference
758 * count because it already takes into account the cache
761 SSL_SESSION_free(s
); /* s == c */
764 CRYPTO_THREAD_unlock(ctx
->lock
);
768 int SSL_CTX_remove_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
770 return remove_session_lock(ctx
, c
, 1);
773 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
)
778 if ((c
!= NULL
) && (c
->session_id_length
!= 0)) {
780 if (!CRYPTO_THREAD_write_lock(ctx
->lock
))
783 if ((r
= lh_SSL_SESSION_retrieve(ctx
->sessions
, c
)) != NULL
) {
785 r
= lh_SSL_SESSION_delete(ctx
->sessions
, r
);
786 SSL_SESSION_list_remove(ctx
, r
);
788 c
->not_resumable
= 1;
791 CRYPTO_THREAD_unlock(ctx
->lock
);
793 if (ctx
->remove_session_cb
!= NULL
)
794 ctx
->remove_session_cb(ctx
, c
);
802 void SSL_SESSION_free(SSL_SESSION
*ss
)
808 CRYPTO_DOWN_REF(&ss
->references
, &i
, ss
->lock
);
809 REF_PRINT_COUNT("SSL_SESSION", ss
);
812 REF_ASSERT_ISNT(i
< 0);
814 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
);
816 OPENSSL_cleanse(ss
->master_key
, sizeof(ss
->master_key
));
817 OPENSSL_cleanse(ss
->session_id
, sizeof(ss
->session_id
));
819 OSSL_STACK_OF_X509_free(ss
->peer_chain
);
820 OPENSSL_free(ss
->ext
.hostname
);
821 OPENSSL_free(ss
->ext
.tick
);
822 #ifndef OPENSSL_NO_PSK
823 OPENSSL_free(ss
->psk_identity_hint
);
824 OPENSSL_free(ss
->psk_identity
);
826 #ifndef OPENSSL_NO_SRP
827 OPENSSL_free(ss
->srp_username
);
829 OPENSSL_free(ss
->ext
.alpn_selected
);
830 OPENSSL_free(ss
->ticket_appdata
);
831 CRYPTO_THREAD_lock_free(ss
->lock
);
832 OPENSSL_clear_free(ss
, sizeof(*ss
));
835 int SSL_SESSION_up_ref(SSL_SESSION
*ss
)
839 if (CRYPTO_UP_REF(&ss
->references
, &i
, ss
->lock
) <= 0)
842 REF_PRINT_COUNT("SSL_SESSION", ss
);
843 REF_ASSERT_ISNT(i
< 2);
844 return ((i
> 1) ? 1 : 0);
847 int SSL_set_session(SSL
*s
, SSL_SESSION
*session
)
849 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(s
);
854 ssl_clear_bad_session(sc
);
855 if (s
->ctx
->method
!= s
->method
) {
856 if (!SSL_set_ssl_method(s
, s
->ctx
->method
))
860 if (session
!= NULL
) {
861 SSL_SESSION_up_ref(session
);
862 sc
->verify_result
= session
->verify_result
;
864 SSL_SESSION_free(sc
->session
);
865 sc
->session
= session
;
870 int SSL_SESSION_set1_id(SSL_SESSION
*s
, const unsigned char *sid
,
871 unsigned int sid_len
)
873 if (sid_len
> SSL_MAX_SSL_SESSION_ID_LENGTH
) {
874 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_TOO_LONG
);
877 s
->session_id_length
= sid_len
;
878 if (sid
!= s
->session_id
)
879 memcpy(s
->session_id
, sid
, sid_len
);
883 long SSL_SESSION_set_timeout(SSL_SESSION
*s
, long t
)
885 OSSL_TIME new_timeout
= ossl_seconds2time(t
);
887 if (s
== NULL
|| t
< 0)
889 if (s
->owner
!= NULL
) {
890 if (!CRYPTO_THREAD_write_lock(s
->owner
->lock
))
892 s
->timeout
= new_timeout
;
893 ssl_session_calculate_timeout(s
);
894 SSL_SESSION_list_add(s
->owner
, s
);
895 CRYPTO_THREAD_unlock(s
->owner
->lock
);
897 s
->timeout
= new_timeout
;
898 ssl_session_calculate_timeout(s
);
903 long SSL_SESSION_get_timeout(const SSL_SESSION
*s
)
907 return (long)ossl_time_to_time_t(s
->timeout
);
910 long SSL_SESSION_get_time(const SSL_SESSION
*s
)
914 return (long)ossl_time_to_time_t(s
->time
);
917 long SSL_SESSION_set_time(SSL_SESSION
*s
, long t
)
919 OSSL_TIME new_time
= ossl_time_from_time_t((time_t)t
);
923 if (s
->owner
!= NULL
) {
924 if (!CRYPTO_THREAD_write_lock(s
->owner
->lock
))
927 ssl_session_calculate_timeout(s
);
928 SSL_SESSION_list_add(s
->owner
, s
);
929 CRYPTO_THREAD_unlock(s
->owner
->lock
);
932 ssl_session_calculate_timeout(s
);
937 int SSL_SESSION_get_protocol_version(const SSL_SESSION
*s
)
939 return s
->ssl_version
;
942 int SSL_SESSION_set_protocol_version(SSL_SESSION
*s
, int version
)
944 s
->ssl_version
= version
;
948 const SSL_CIPHER
*SSL_SESSION_get0_cipher(const SSL_SESSION
*s
)
953 int SSL_SESSION_set_cipher(SSL_SESSION
*s
, const SSL_CIPHER
*cipher
)
959 const char *SSL_SESSION_get0_hostname(const SSL_SESSION
*s
)
961 return s
->ext
.hostname
;
964 int SSL_SESSION_set1_hostname(SSL_SESSION
*s
, const char *hostname
)
966 OPENSSL_free(s
->ext
.hostname
);
967 if (hostname
== NULL
) {
968 s
->ext
.hostname
= NULL
;
971 s
->ext
.hostname
= OPENSSL_strdup(hostname
);
973 return s
->ext
.hostname
!= NULL
;
976 int SSL_SESSION_has_ticket(const SSL_SESSION
*s
)
978 return (s
->ext
.ticklen
> 0) ? 1 : 0;
981 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION
*s
)
983 return s
->ext
.tick_lifetime_hint
;
986 void SSL_SESSION_get0_ticket(const SSL_SESSION
*s
, const unsigned char **tick
,
989 *len
= s
->ext
.ticklen
;
994 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION
*s
)
996 return s
->ext
.max_early_data
;
999 int SSL_SESSION_set_max_early_data(SSL_SESSION
*s
, uint32_t max_early_data
)
1001 s
->ext
.max_early_data
= max_early_data
;
1006 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION
*s
,
1007 const unsigned char **alpn
,
1010 *alpn
= s
->ext
.alpn_selected
;
1011 *len
= s
->ext
.alpn_selected_len
;
1014 int SSL_SESSION_set1_alpn_selected(SSL_SESSION
*s
, const unsigned char *alpn
,
1017 OPENSSL_free(s
->ext
.alpn_selected
);
1018 if (alpn
== NULL
|| len
== 0) {
1019 s
->ext
.alpn_selected
= NULL
;
1020 s
->ext
.alpn_selected_len
= 0;
1023 s
->ext
.alpn_selected
= OPENSSL_memdup(alpn
, len
);
1024 if (s
->ext
.alpn_selected
== NULL
) {
1025 s
->ext
.alpn_selected_len
= 0;
1028 s
->ext
.alpn_selected_len
= len
;
1033 X509
*SSL_SESSION_get0_peer(SSL_SESSION
*s
)
1038 int SSL_SESSION_set1_id_context(SSL_SESSION
*s
, const unsigned char *sid_ctx
,
1039 unsigned int sid_ctx_len
)
1041 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
1042 ERR_raise(ERR_LIB_SSL
, SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
1045 s
->sid_ctx_length
= sid_ctx_len
;
1046 if (sid_ctx
!= s
->sid_ctx
)
1047 memcpy(s
->sid_ctx
, sid_ctx
, sid_ctx_len
);
1052 int SSL_SESSION_is_resumable(const SSL_SESSION
*s
)
1055 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
1058 return !s
->not_resumable
1059 && (s
->session_id_length
> 0 || s
->ext
.ticklen
> 0);
1062 long SSL_CTX_set_timeout(SSL_CTX
*s
, long t
)
1068 l
= (long)ossl_time2seconds(s
->session_timeout
);
1069 s
->session_timeout
= ossl_seconds2time(t
);
1073 long SSL_CTX_get_timeout(const SSL_CTX
*s
)
1077 return (long)ossl_time2seconds(s
->session_timeout
);
1080 int SSL_set_session_secret_cb(SSL
*s
,
1081 tls_session_secret_cb_fn tls_session_secret_cb
,
1084 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(s
);
1089 sc
->ext
.session_secret_cb
= tls_session_secret_cb
;
1090 sc
->ext
.session_secret_cb_arg
= arg
;
1094 int SSL_set_session_ticket_ext_cb(SSL
*s
, tls_session_ticket_ext_cb_fn cb
,
1097 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(s
);
1102 sc
->ext
.session_ticket_cb
= cb
;
1103 sc
->ext
.session_ticket_cb_arg
= arg
;
1107 int SSL_set_session_ticket_ext(SSL
*s
, void *ext_data
, int ext_len
)
1109 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(s
);
1114 if (sc
->version
>= TLS1_VERSION
) {
1115 OPENSSL_free(sc
->ext
.session_ticket
);
1116 sc
->ext
.session_ticket
= NULL
;
1117 sc
->ext
.session_ticket
=
1118 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT
) + ext_len
);
1119 if (sc
->ext
.session_ticket
== NULL
) {
1120 ERR_raise(ERR_LIB_SSL
, ERR_R_MALLOC_FAILURE
);
1124 if (ext_data
!= NULL
) {
1125 sc
->ext
.session_ticket
->length
= ext_len
;
1126 sc
->ext
.session_ticket
->data
= sc
->ext
.session_ticket
+ 1;
1127 memcpy(sc
->ext
.session_ticket
->data
, ext_data
, ext_len
);
1129 sc
->ext
.session_ticket
->length
= 0;
1130 sc
->ext
.session_ticket
->data
= NULL
;
1139 void SSL_CTX_flush_sessions(SSL_CTX
*s
, long t
)
1141 STACK_OF(SSL_SESSION
) *sk
;
1142 SSL_SESSION
*current
;
1144 const OSSL_TIME timeout
= ossl_time_from_time_t(t
);
1146 if (!CRYPTO_THREAD_write_lock(s
->lock
))
1149 sk
= sk_SSL_SESSION_new_null();
1150 i
= lh_SSL_SESSION_get_down_load(s
->sessions
);
1151 lh_SSL_SESSION_set_down_load(s
->sessions
, 0);
1154 * Iterate over the list from the back (oldest), and stop
1155 * when a session can no longer be removed.
1156 * Add the session to a temporary list to be freed outside
1158 * But still do the remove_session_cb() within the lock.
1160 while (s
->session_cache_tail
!= NULL
) {
1161 current
= s
->session_cache_tail
;
1162 if (t
== 0 || sess_timedout(timeout
, current
)) {
1163 lh_SSL_SESSION_delete(s
->sessions
, current
);
1164 SSL_SESSION_list_remove(s
, current
);
1165 current
->not_resumable
= 1;
1166 if (s
->remove_session_cb
!= NULL
)
1167 s
->remove_session_cb(s
, current
);
1169 * Throw the session on a stack, it's entirely plausible
1170 * that while freeing outside the critical section, the
1171 * session could be re-added, so avoid using the next/prev
1172 * pointers. If the stack failed to create, or the session
1173 * couldn't be put on the stack, just free it here
1175 if (sk
== NULL
|| !sk_SSL_SESSION_push(sk
, current
))
1176 SSL_SESSION_free(current
);
1182 lh_SSL_SESSION_set_down_load(s
->sessions
, i
);
1183 CRYPTO_THREAD_unlock(s
->lock
);
1185 sk_SSL_SESSION_pop_free(sk
, SSL_SESSION_free
);
1188 int ssl_clear_bad_session(SSL_CONNECTION
*s
)
1190 if ((s
->session
!= NULL
) &&
1191 !(s
->shutdown
& SSL_SENT_SHUTDOWN
) &&
1192 !(SSL_in_init(SSL_CONNECTION_GET_SSL(s
))
1193 || SSL_in_before(SSL_CONNECTION_GET_SSL(s
)))) {
1194 SSL_CTX_remove_session(s
->session_ctx
, s
->session
);
1200 /* locked by SSL_CTX in the calling function */
1201 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1203 if ((s
->next
== NULL
) || (s
->prev
== NULL
))
1206 if (s
->next
== (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1207 /* last element in list */
1208 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1209 /* only one element in list */
1210 ctx
->session_cache_head
= NULL
;
1211 ctx
->session_cache_tail
= NULL
;
1213 ctx
->session_cache_tail
= s
->prev
;
1214 s
->prev
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1217 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1218 /* first element in list */
1219 ctx
->session_cache_head
= s
->next
;
1220 s
->next
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1222 /* middle of list */
1223 s
->next
->prev
= s
->prev
;
1224 s
->prev
->next
= s
->next
;
1227 s
->prev
= s
->next
= NULL
;
1231 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1235 if ((s
->next
!= NULL
) && (s
->prev
!= NULL
))
1236 SSL_SESSION_list_remove(ctx
, s
);
1238 if (ctx
->session_cache_head
== NULL
) {
1239 ctx
->session_cache_head
= s
;
1240 ctx
->session_cache_tail
= s
;
1241 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1242 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1244 if (timeoutcmp(s
, ctx
->session_cache_head
) >= 0) {
1246 * if we timeout after (or the same time as) the first
1247 * session, put us first - usual case
1249 s
->next
= ctx
->session_cache_head
;
1251 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1252 ctx
->session_cache_head
= s
;
1253 } else if (timeoutcmp(s
, ctx
->session_cache_tail
) < 0) {
1254 /* if we timeout before the last session, put us last */
1255 s
->prev
= ctx
->session_cache_tail
;
1257 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1258 ctx
->session_cache_tail
= s
;
1261 * we timeout somewhere in-between - if there is only
1262 * one session in the cache it will be caught above
1264 next
= ctx
->session_cache_head
->next
;
1265 while (next
!= (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1266 if (timeoutcmp(s
, next
) >= 0) {
1268 s
->prev
= next
->prev
;
1269 next
->prev
->next
= s
;
1280 void SSL_CTX_sess_set_new_cb(SSL_CTX
*ctx
,
1281 int (*cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
))
1283 ctx
->new_session_cb
= cb
;
1286 int (*SSL_CTX_sess_get_new_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, SSL_SESSION
*sess
) {
1287 return ctx
->new_session_cb
;
1290 void SSL_CTX_sess_set_remove_cb(SSL_CTX
*ctx
,
1291 void (*cb
) (SSL_CTX
*ctx
, SSL_SESSION
*sess
))
1293 ctx
->remove_session_cb
= cb
;
1296 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX
*ctx
)) (SSL_CTX
*ctx
,
1297 SSL_SESSION
*sess
) {
1298 return ctx
->remove_session_cb
;
1301 void SSL_CTX_sess_set_get_cb(SSL_CTX
*ctx
,
1302 SSL_SESSION
*(*cb
) (SSL
*ssl
,
1303 const unsigned char *data
,
1304 int len
, int *copy
))
1306 ctx
->get_session_cb
= cb
;
1309 SSL_SESSION
*(*SSL_CTX_sess_get_get_cb(SSL_CTX
*ctx
)) (SSL
*ssl
,
1313 return ctx
->get_session_cb
;
1316 void SSL_CTX_set_info_callback(SSL_CTX
*ctx
,
1317 void (*cb
) (const SSL
*ssl
, int type
, int val
))
1319 ctx
->info_callback
= cb
;
1322 void (*SSL_CTX_get_info_callback(SSL_CTX
*ctx
)) (const SSL
*ssl
, int type
,
1324 return ctx
->info_callback
;
1327 void SSL_CTX_set_client_cert_cb(SSL_CTX
*ctx
,
1328 int (*cb
) (SSL
*ssl
, X509
**x509
,
1331 ctx
->client_cert_cb
= cb
;
1334 int (*SSL_CTX_get_client_cert_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, X509
**x509
,
1336 return ctx
->client_cert_cb
;
1339 void SSL_CTX_set_cookie_generate_cb(SSL_CTX
*ctx
,
1340 int (*cb
) (SSL
*ssl
,
1341 unsigned char *cookie
,
1342 unsigned int *cookie_len
))
1344 ctx
->app_gen_cookie_cb
= cb
;
1347 void SSL_CTX_set_cookie_verify_cb(SSL_CTX
*ctx
,
1348 int (*cb
) (SSL
*ssl
,
1349 const unsigned char *cookie
,
1350 unsigned int cookie_len
))
1352 ctx
->app_verify_cookie_cb
= cb
;
1355 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION
*ss
, const void *data
, size_t len
)
1357 OPENSSL_free(ss
->ticket_appdata
);
1358 ss
->ticket_appdata_len
= 0;
1359 if (data
== NULL
|| len
== 0) {
1360 ss
->ticket_appdata
= NULL
;
1363 ss
->ticket_appdata
= OPENSSL_memdup(data
, len
);
1364 if (ss
->ticket_appdata
!= NULL
) {
1365 ss
->ticket_appdata_len
= len
;
1371 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION
*ss
, void **data
, size_t *len
)
1373 *data
= ss
->ticket_appdata
;
1374 *len
= ss
->ticket_appdata_len
;
1378 void SSL_CTX_set_stateless_cookie_generate_cb(
1380 int (*cb
) (SSL
*ssl
,
1381 unsigned char *cookie
,
1382 size_t *cookie_len
))
1384 ctx
->gen_stateless_cookie_cb
= cb
;
1387 void SSL_CTX_set_stateless_cookie_verify_cb(
1389 int (*cb
) (SSL
*ssl
,
1390 const unsigned char *cookie
,
1393 ctx
->verify_stateless_cookie_cb
= cb
;
1396 IMPLEMENT_PEM_rw(SSL_SESSION
, SSL_SESSION
, PEM_STRING_SSL_SESSION
, SSL_SESSION
)