2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright 2005 Nokia. All rights reserved.
5 * Licensed under the OpenSSL license (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
12 #include <openssl/lhash.h>
13 #include <openssl/rand.h>
14 #include <openssl/engine.h>
16 #include "statem/statem_locl.h"
18 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
);
19 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
);
20 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
);
23 * SSL_get_session() and SSL_get1_session() are problematic in TLS1.3 because,
24 * unlike in earlier protocol versions, the session ticket may not have been
25 * sent yet even though a handshake has finished. The session ticket data could
26 * come in sometime later...or even change if multiple session ticket messages
27 * are sent from the server. The preferred way for applications to obtain
28 * a resumable session is to use SSL_CTX_sess_set_new_cb().
31 SSL_SESSION
*SSL_get_session(const SSL
*ssl
)
32 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
34 return (ssl
->session
);
37 SSL_SESSION
*SSL_get1_session(SSL
*ssl
)
38 /* variant of SSL_get_session: caller really gets something */
42 * Need to lock this all up rather than just use CRYPTO_add so that
43 * somebody doesn't free ssl->session between when we check it's non-null
44 * and when we up the reference count.
46 CRYPTO_THREAD_read_lock(ssl
->lock
);
49 SSL_SESSION_up_ref(sess
);
50 CRYPTO_THREAD_unlock(ssl
->lock
);
54 int SSL_SESSION_set_ex_data(SSL_SESSION
*s
, int idx
, void *arg
)
56 return (CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
));
59 void *SSL_SESSION_get_ex_data(const SSL_SESSION
*s
, int idx
)
61 return (CRYPTO_get_ex_data(&s
->ex_data
, idx
));
64 SSL_SESSION
*SSL_SESSION_new(void)
68 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS
, NULL
))
71 ss
= OPENSSL_zalloc(sizeof(*ss
));
73 SSLerr(SSL_F_SSL_SESSION_NEW
, ERR_R_MALLOC_FAILURE
);
77 ss
->verify_result
= 1; /* avoid 0 (= X509_V_OK) just in case */
79 ss
->timeout
= 60 * 5 + 4; /* 5 minute timeout by default */
80 ss
->time
= (unsigned long)time(NULL
);
81 ss
->lock
= CRYPTO_THREAD_lock_new();
82 if (ss
->lock
== NULL
) {
83 SSLerr(SSL_F_SSL_SESSION_NEW
, ERR_R_MALLOC_FAILURE
);
88 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
)) {
89 CRYPTO_THREAD_lock_free(ss
->lock
);
97 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
98 * ticket == 0 then no ticket information is duplicated, otherwise it is.
100 SSL_SESSION
*ssl_session_dup(SSL_SESSION
*src
, int ticket
)
104 dest
= OPENSSL_malloc(sizeof(*src
));
108 memcpy(dest
, src
, sizeof(*dest
));
111 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
112 * the case of an error whilst halfway through constructing dest
114 #ifndef OPENSSL_NO_PSK
115 dest
->psk_identity_hint
= NULL
;
116 dest
->psk_identity
= NULL
;
118 dest
->ciphers
= NULL
;
119 dest
->ext
.hostname
= NULL
;
120 #ifndef OPENSSL_NO_EC
121 dest
->ext
.ecpointformats
= NULL
;
122 dest
->ext
.supportedgroups
= NULL
;
124 dest
->ext
.tick
= NULL
;
125 #ifndef OPENSSL_NO_SRP
126 dest
->srp_username
= NULL
;
128 dest
->peer_chain
= NULL
;
130 memset(&dest
->ex_data
, 0, sizeof(dest
->ex_data
));
132 /* We deliberately don't copy the prev and next pointers */
136 dest
->references
= 1;
138 dest
->lock
= CRYPTO_THREAD_lock_new();
139 if (dest
->lock
== NULL
)
142 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, dest
, &dest
->ex_data
))
145 if (src
->peer
!= NULL
) {
146 if (!X509_up_ref(src
->peer
))
148 dest
->peer
= src
->peer
;
151 if (src
->peer_chain
!= NULL
) {
152 dest
->peer_chain
= X509_chain_up_ref(src
->peer_chain
);
153 if (dest
->peer_chain
== NULL
)
156 #ifndef OPENSSL_NO_PSK
157 if (src
->psk_identity_hint
) {
158 dest
->psk_identity_hint
= OPENSSL_strdup(src
->psk_identity_hint
);
159 if (dest
->psk_identity_hint
== NULL
) {
163 if (src
->psk_identity
) {
164 dest
->psk_identity
= OPENSSL_strdup(src
->psk_identity
);
165 if (dest
->psk_identity
== NULL
) {
171 if (src
->ciphers
!= NULL
) {
172 dest
->ciphers
= sk_SSL_CIPHER_dup(src
->ciphers
);
173 if (dest
->ciphers
== NULL
)
177 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
,
178 &dest
->ex_data
, &src
->ex_data
)) {
182 if (src
->ext
.hostname
) {
183 dest
->ext
.hostname
= OPENSSL_strdup(src
->ext
.hostname
);
184 if (dest
->ext
.hostname
== NULL
) {
188 #ifndef OPENSSL_NO_EC
189 if (src
->ext
.ecpointformats
) {
190 dest
->ext
.ecpointformats
=
191 OPENSSL_memdup(src
->ext
.ecpointformats
,
192 src
->ext
.ecpointformats_len
);
193 if (dest
->ext
.ecpointformats
== NULL
)
196 if (src
->ext
.supportedgroups
) {
197 dest
->ext
.supportedgroups
=
198 OPENSSL_memdup(src
->ext
.supportedgroups
,
199 src
->ext
.supportedgroups_len
);
200 if (dest
->ext
.supportedgroups
== NULL
)
205 if (ticket
!= 0 && src
->ext
.tick
!= NULL
) {
207 OPENSSL_memdup(src
->ext
.tick
, src
->ext
.ticklen
);
208 if (dest
->ext
.tick
== NULL
)
211 dest
->ext
.tick_lifetime_hint
= 0;
212 dest
->ext
.ticklen
= 0;
215 #ifndef OPENSSL_NO_SRP
216 if (src
->srp_username
) {
217 dest
->srp_username
= OPENSSL_strdup(src
->srp_username
);
218 if (dest
->srp_username
== NULL
) {
226 SSLerr(SSL_F_SSL_SESSION_DUP
, ERR_R_MALLOC_FAILURE
);
227 SSL_SESSION_free(dest
);
231 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION
*s
, unsigned int *len
)
234 *len
= (unsigned int)s
->session_id_length
;
235 return s
->session_id
;
237 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION
*s
,
241 *len
= (unsigned int)s
->sid_ctx_length
;
245 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION
*s
)
247 return s
->compress_meth
;
251 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
252 * the ID with random junk repeatedly until we have no conflict is going to
253 * complete in one iteration pretty much "most" of the time (btw:
254 * understatement). So, if it takes us 10 iterations and we still can't avoid
255 * a conflict - well that's a reasonable point to call it quits. Either the
256 * RAND code is broken or someone is trying to open roughly very close to
257 * 2^256 SSL sessions to our server. How you might store that many sessions
258 * is perhaps a more interesting question ...
261 #define MAX_SESS_ID_ATTEMPTS 10
262 static int def_generate_session_id(const SSL
*ssl
, unsigned char *id
,
263 unsigned int *id_len
)
265 unsigned int retry
= 0;
267 if (RAND_bytes(id
, *id_len
) <= 0)
269 while (SSL_has_matching_session_id(ssl
, id
, *id_len
) &&
270 (++retry
< MAX_SESS_ID_ATTEMPTS
)) ;
271 if (retry
< MAX_SESS_ID_ATTEMPTS
)
273 /* else - woops a session_id match */
275 * XXX We should also check the external cache -- but the probability of
276 * a collision is negligible, and we could not prevent the concurrent
277 * creation of sessions with identical IDs since we currently don't have
278 * means to atomically check whether a session ID already exists and make
279 * a reservation for it if it does not (this problem applies to the
280 * internal cache as well).
285 int ssl_get_new_session(SSL
*s
, int session
)
287 /* This gets used by clients and servers. */
290 SSL_SESSION
*ss
= NULL
;
291 GEN_SESSION_CB cb
= def_generate_session_id
;
293 if ((ss
= SSL_SESSION_new()) == NULL
)
296 /* If the context has a default timeout, use it */
297 if (s
->session_ctx
->session_timeout
== 0)
298 ss
->timeout
= SSL_get_default_timeout(s
);
300 ss
->timeout
= s
->session_ctx
->session_timeout
;
302 SSL_SESSION_free(s
->session
);
306 if (s
->version
== SSL3_VERSION
) {
307 ss
->ssl_version
= SSL3_VERSION
;
308 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
309 } else if (s
->version
== TLS1_VERSION
) {
310 ss
->ssl_version
= TLS1_VERSION
;
311 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
312 } else if (s
->version
== TLS1_1_VERSION
) {
313 ss
->ssl_version
= TLS1_1_VERSION
;
314 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
315 } else if (s
->version
== TLS1_2_VERSION
) {
316 ss
->ssl_version
= TLS1_2_VERSION
;
317 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
318 } else if (s
->version
== TLS1_3_VERSION
) {
319 ss
->ssl_version
= TLS1_3_VERSION
;
320 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
321 } else if (s
->version
== DTLS1_BAD_VER
) {
322 ss
->ssl_version
= DTLS1_BAD_VER
;
323 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
324 } else if (s
->version
== DTLS1_VERSION
) {
325 ss
->ssl_version
= DTLS1_VERSION
;
326 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
327 } else if (s
->version
== DTLS1_2_VERSION
) {
328 ss
->ssl_version
= DTLS1_2_VERSION
;
329 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
331 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, SSL_R_UNSUPPORTED_SSL_VERSION
);
332 SSL_SESSION_free(ss
);
337 * If RFC5077 ticket, use empty session ID (as server).
339 * (a) ssl_get_prev_session() does lookahead into the
340 * ClientHello extensions to find the session ticket.
341 * When ssl_get_prev_session() fails, statem_srvr.c calls
342 * ssl_get_new_session() in tls_process_client_hello().
343 * At that point, it has not yet parsed the extensions,
344 * however, because of the lookahead, it already knows
345 * whether a ticket is expected or not.
347 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
348 * ServerHello extensions, and before recording the session
349 * ID received from the server, so this block is a noop.
351 if (s
->ext
.ticket_expected
) {
352 ss
->session_id_length
= 0;
356 /* Choose which callback will set the session ID */
357 CRYPTO_THREAD_read_lock(s
->lock
);
358 CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
);
359 if (s
->generate_session_id
)
360 cb
= s
->generate_session_id
;
361 else if (s
->session_ctx
->generate_session_id
)
362 cb
= s
->session_ctx
->generate_session_id
;
363 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
364 CRYPTO_THREAD_unlock(s
->lock
);
365 /* Choose a session ID */
366 memset(ss
->session_id
, 0, ss
->session_id_length
);
367 tmp
= (int)ss
->session_id_length
;
368 if (!cb(s
, ss
->session_id
, &tmp
)) {
369 /* The callback failed */
370 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,
371 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED
);
372 SSL_SESSION_free(ss
);
376 * Don't allow the callback to set the session length to zero. nor
377 * set it higher than it was.
379 if (tmp
== 0 || tmp
> ss
->session_id_length
) {
380 /* The callback set an illegal length */
381 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,
382 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH
);
383 SSL_SESSION_free(ss
);
386 ss
->session_id_length
= tmp
;
387 /* Finally, check for a conflict */
388 if (SSL_has_matching_session_id(s
, ss
->session_id
,
389 (unsigned int)ss
->session_id_length
)) {
390 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, SSL_R_SSL_SESSION_ID_CONFLICT
);
391 SSL_SESSION_free(ss
);
396 if (s
->ext
.hostname
) {
397 ss
->ext
.hostname
= OPENSSL_strdup(s
->ext
.hostname
);
398 if (ss
->ext
.hostname
== NULL
) {
399 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_INTERNAL_ERROR
);
400 SSL_SESSION_free(ss
);
405 ss
->session_id_length
= 0;
408 if (s
->sid_ctx_length
> sizeof ss
->sid_ctx
) {
409 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_INTERNAL_ERROR
);
410 SSL_SESSION_free(ss
);
413 memcpy(ss
->sid_ctx
, s
->sid_ctx
, s
->sid_ctx_length
);
414 ss
->sid_ctx_length
= s
->sid_ctx_length
;
416 ss
->ssl_version
= s
->version
;
417 ss
->verify_result
= X509_V_OK
;
419 /* If client supports extended master secret set it in session */
420 if (s
->s3
->flags
& TLS1_FLAGS_RECEIVED_EXTMS
)
421 ss
->flags
|= SSL_SESS_FLAG_EXTMS
;
427 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
428 * connection. It is only called by servers.
430 * hello: The parsed ClientHello data
434 * 0: no session found
435 * 1: a session may have been found.
438 * - If a session is found then s->session is pointed at it (after freeing an
439 * existing session if need be) and s->verify_result is set from the session.
440 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
441 * if the server should issue a new session ticket (to 0 otherwise).
443 int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
, int *al
)
445 /* This is used only by servers. */
447 SSL_SESSION
*ret
= NULL
;
449 int try_session_cache
= 0;
452 if (SSL_IS_TLS13(s
)) {
453 if (!tls_parse_extension(s
, TLSEXT_IDX_psk_kex_modes
,
454 SSL_EXT_CLIENT_HELLO
, hello
->pre_proc_exts
,
456 || !tls_parse_extension(s
, TLSEXT_IDX_psk
, SSL_EXT_CLIENT_HELLO
,
457 hello
->pre_proc_exts
, NULL
, 0, al
))
462 /* sets s->ext.ticket_expected */
463 r
= tls_get_ticket_from_client(s
, hello
, &ret
);
465 case TICKET_FATAL_ERR_MALLOC
:
466 case TICKET_FATAL_ERR_OTHER
:
471 try_session_cache
= 1;
473 case TICKET_NO_DECRYPT
:
475 case TICKET_SUCCESS_RENEW
:
480 if (try_session_cache
&&
482 !(s
->session_ctx
->session_cache_mode
&
483 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
)) {
486 data
.ssl_version
= s
->version
;
487 memcpy(data
.session_id
, hello
->session_id
, hello
->session_id_len
);
488 data
.session_id_length
= hello
->session_id_len
;
490 CRYPTO_THREAD_read_lock(s
->session_ctx
->lock
);
491 ret
= lh_SSL_SESSION_retrieve(s
->session_ctx
->sessions
, &data
);
493 /* don't allow other threads to steal it: */
494 SSL_SESSION_up_ref(ret
);
496 CRYPTO_THREAD_unlock(s
->session_ctx
->lock
);
498 s
->session_ctx
->stats
.sess_miss
++;
501 if (try_session_cache
&&
502 ret
== NULL
&& s
->session_ctx
->get_session_cb
!= NULL
) {
505 ret
= s
->session_ctx
->get_session_cb(s
, hello
->session_id
,
506 hello
->session_id_len
,
510 s
->session_ctx
->stats
.sess_cb_hit
++;
513 * Increment reference count now if the session callback asks us
514 * to do so (note that if the session structures returned by the
515 * callback are shared between threads, it must handle the
516 * reference count itself [i.e. copy == 0], or things won't be
520 SSL_SESSION_up_ref(ret
);
523 * Add the externally cached session to the internal cache as
524 * well if and only if we are supposed to.
527 (s
->session_ctx
->session_cache_mode
&
528 SSL_SESS_CACHE_NO_INTERNAL_STORE
)) {
530 * The following should not return 1, otherwise, things are
533 if (SSL_CTX_add_session(s
->session_ctx
, ret
))
542 /* Now ret is non-NULL and we own one of its reference counts. */
544 /* Check TLS version consistency */
545 if (ret
->ssl_version
!= s
->version
)
548 if (ret
->sid_ctx_length
!= s
->sid_ctx_length
549 || memcmp(ret
->sid_ctx
, s
->sid_ctx
, ret
->sid_ctx_length
)) {
551 * We have the session requested by the client, but we don't want to
552 * use it in this context.
554 goto err
; /* treat like cache miss */
557 if ((s
->verify_mode
& SSL_VERIFY_PEER
) && s
->sid_ctx_length
== 0) {
559 * We can't be sure if this session is being used out of context,
560 * which is especially important for SSL_VERIFY_PEER. The application
561 * should have used SSL[_CTX]_set_session_id_context. For this error
562 * case, we generate an error instead of treating the event like a
563 * cache miss (otherwise it would be easy for applications to
564 * effectively disable the session cache by accident without anyone
568 SSLerr(SSL_F_SSL_GET_PREV_SESSION
,
569 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
574 if (ret
->timeout
< (long)(time(NULL
) - ret
->time
)) { /* timeout */
575 s
->session_ctx
->stats
.sess_timeout
++;
576 if (try_session_cache
) {
577 /* session was from the cache, so remove it */
578 SSL_CTX_remove_session(s
->session_ctx
, ret
);
583 /* Check extended master secret extension consistency */
584 if (ret
->flags
& SSL_SESS_FLAG_EXTMS
) {
585 /* If old session includes extms, but new does not: abort handshake */
586 if (!(s
->s3
->flags
& TLS1_FLAGS_RECEIVED_EXTMS
)) {
587 SSLerr(SSL_F_SSL_GET_PREV_SESSION
, SSL_R_INCONSISTENT_EXTMS
);
588 ssl3_send_alert(s
, SSL3_AL_FATAL
, SSL_AD_ILLEGAL_PARAMETER
);
592 } else if (s
->s3
->flags
& TLS1_FLAGS_RECEIVED_EXTMS
) {
593 /* If new session includes extms, but old does not: do not resume */
597 if (!SSL_IS_TLS13(s
)) {
598 /* We already did this for TLS1.3 */
599 SSL_SESSION_free(s
->session
);
603 s
->session_ctx
->stats
.sess_hit
++;
604 s
->verify_result
= s
->session
->verify_result
;
609 SSL_SESSION_free(ret
);
610 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
614 if (!try_session_cache
) {
616 * The session was from a ticket, so we should issue a ticket for
619 s
->ext
.ticket_expected
= 1;
623 *al
= SSL_AD_INTERNAL_ERROR
;
630 int SSL_CTX_add_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
636 * add just 1 reference count for the SSL_CTX's session cache even though
637 * it has two ways of access: each session is in a doubly linked list and
640 SSL_SESSION_up_ref(c
);
642 * if session c is in already in cache, we take back the increment later
645 CRYPTO_THREAD_write_lock(ctx
->lock
);
646 s
= lh_SSL_SESSION_insert(ctx
->sessions
, c
);
649 * s != NULL iff we already had a session with the given PID. In this
650 * case, s == c should hold (then we did not really modify
651 * ctx->sessions), or we're in trouble.
653 if (s
!= NULL
&& s
!= c
) {
654 /* We *are* in trouble ... */
655 SSL_SESSION_list_remove(ctx
, s
);
658 * ... so pretend the other session did not exist in cache (we cannot
659 * handle two SSL_SESSION structures with identical session ID in the
660 * same cache, which could happen e.g. when two threads concurrently
661 * obtain the same session from an external cache)
664 } else if (s
== NULL
&&
665 lh_SSL_SESSION_retrieve(ctx
->sessions
, c
) == NULL
) {
666 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
669 * ... so take back the extra reference and also don't add
670 * the session to the SSL_SESSION_list at this time
675 /* Put at the head of the queue unless it is already in the cache */
677 SSL_SESSION_list_add(ctx
, c
);
681 * existing cache entry -- decrement previously incremented reference
682 * count because it already takes into account the cache
685 SSL_SESSION_free(s
); /* s == c */
689 * new cache entry -- remove old ones if cache has become too large
694 if (SSL_CTX_sess_get_cache_size(ctx
) > 0) {
695 while (SSL_CTX_sess_number(ctx
) > SSL_CTX_sess_get_cache_size(ctx
)) {
696 if (!remove_session_lock(ctx
, ctx
->session_cache_tail
, 0))
699 ctx
->stats
.sess_cache_full
++;
703 CRYPTO_THREAD_unlock(ctx
->lock
);
707 int SSL_CTX_remove_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
709 return remove_session_lock(ctx
, c
, 1);
712 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
)
717 if ((c
!= NULL
) && (c
->session_id_length
!= 0)) {
719 CRYPTO_THREAD_write_lock(ctx
->lock
);
720 if ((r
= lh_SSL_SESSION_retrieve(ctx
->sessions
, c
)) == c
) {
722 r
= lh_SSL_SESSION_delete(ctx
->sessions
, c
);
723 SSL_SESSION_list_remove(ctx
, c
);
725 c
->not_resumable
= 1;
728 CRYPTO_THREAD_unlock(ctx
->lock
);
733 if (ctx
->remove_session_cb
!= NULL
)
734 ctx
->remove_session_cb(ctx
, c
);
740 void SSL_SESSION_free(SSL_SESSION
*ss
)
747 CRYPTO_DOWN_REF(&ss
->references
, &i
, ss
->lock
);
748 REF_PRINT_COUNT("SSL_SESSION", ss
);
751 REF_ASSERT_ISNT(i
< 0);
753 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
);
755 OPENSSL_cleanse(ss
->master_key
, sizeof ss
->master_key
);
756 OPENSSL_cleanse(ss
->session_id
, sizeof ss
->session_id
);
758 sk_X509_pop_free(ss
->peer_chain
, X509_free
);
759 sk_SSL_CIPHER_free(ss
->ciphers
);
760 OPENSSL_free(ss
->ext
.hostname
);
761 OPENSSL_free(ss
->ext
.tick
);
762 #ifndef OPENSSL_NO_EC
763 OPENSSL_free(ss
->ext
.ecpointformats
);
764 ss
->ext
.ecpointformats
= NULL
;
765 ss
->ext
.ecpointformats_len
= 0;
766 OPENSSL_free(ss
->ext
.supportedgroups
);
767 ss
->ext
.supportedgroups
= NULL
;
768 ss
->ext
.supportedgroups_len
= 0;
769 #endif /* OPENSSL_NO_EC */
770 #ifndef OPENSSL_NO_PSK
771 OPENSSL_free(ss
->psk_identity_hint
);
772 OPENSSL_free(ss
->psk_identity
);
774 #ifndef OPENSSL_NO_SRP
775 OPENSSL_free(ss
->srp_username
);
777 OPENSSL_free(ss
->ext
.alpn_selected
);
778 CRYPTO_THREAD_lock_free(ss
->lock
);
779 OPENSSL_clear_free(ss
, sizeof(*ss
));
782 int SSL_SESSION_up_ref(SSL_SESSION
*ss
)
786 if (CRYPTO_UP_REF(&ss
->references
, &i
, ss
->lock
) <= 0)
789 REF_PRINT_COUNT("SSL_SESSION", ss
);
790 REF_ASSERT_ISNT(i
< 2);
791 return ((i
> 1) ? 1 : 0);
794 int SSL_set_session(SSL
*s
, SSL_SESSION
*session
)
796 ssl_clear_bad_session(s
);
797 if (s
->ctx
->method
!= s
->method
) {
798 if (!SSL_set_ssl_method(s
, s
->ctx
->method
))
802 if (session
!= NULL
) {
803 SSL_SESSION_up_ref(session
);
804 s
->verify_result
= session
->verify_result
;
806 SSL_SESSION_free(s
->session
);
807 s
->session
= session
;
812 int SSL_SESSION_set1_id(SSL_SESSION
*s
, const unsigned char *sid
,
813 unsigned int sid_len
)
815 if (sid_len
> SSL_MAX_SSL_SESSION_ID_LENGTH
) {
816 SSLerr(SSL_F_SSL_SESSION_SET1_ID
,
817 SSL_R_SSL_SESSION_ID_TOO_LONG
);
820 s
->session_id_length
= sid_len
;
821 if (sid
!= s
->session_id
)
822 memcpy(s
->session_id
, sid
, sid_len
);
826 long SSL_SESSION_set_timeout(SSL_SESSION
*s
, long t
)
834 long SSL_SESSION_get_timeout(const SSL_SESSION
*s
)
841 long SSL_SESSION_get_time(const SSL_SESSION
*s
)
848 long SSL_SESSION_set_time(SSL_SESSION
*s
, long t
)
856 int SSL_SESSION_get_protocol_version(const SSL_SESSION
*s
)
858 return s
->ssl_version
;
861 int SSL_SESSION_set_protocol_version(SSL_SESSION
*s
, int version
)
863 s
->ssl_version
= version
;
867 const SSL_CIPHER
*SSL_SESSION_get0_cipher(const SSL_SESSION
*s
)
872 int SSL_SESSION_set_cipher(SSL_SESSION
*s
, const SSL_CIPHER
*cipher
)
878 const char *SSL_SESSION_get0_hostname(const SSL_SESSION
*s
)
880 return s
->ext
.hostname
;
883 int SSL_SESSION_has_ticket(const SSL_SESSION
*s
)
885 return (s
->ext
.ticklen
> 0) ? 1 : 0;
888 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION
*s
)
890 return s
->ext
.tick_lifetime_hint
;
893 void SSL_SESSION_get0_ticket(const SSL_SESSION
*s
, const unsigned char **tick
,
896 *len
= s
->ext
.ticklen
;
901 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION
*s
)
903 return s
->ext
.max_early_data
;
906 X509
*SSL_SESSION_get0_peer(SSL_SESSION
*s
)
911 int SSL_SESSION_set1_id_context(SSL_SESSION
*s
, const unsigned char *sid_ctx
,
912 unsigned int sid_ctx_len
)
914 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
915 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT
,
916 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
919 s
->sid_ctx_length
= sid_ctx_len
;
920 if (sid_ctx
!= s
->sid_ctx
)
921 memcpy(s
->sid_ctx
, sid_ctx
, sid_ctx_len
);
926 int SSL_SESSION_is_resumable(const SSL_SESSION
*s
)
929 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
932 return !s
->not_resumable
933 && (s
->session_id_length
> 0 || s
->ext
.ticklen
> 0);
936 long SSL_CTX_set_timeout(SSL_CTX
*s
, long t
)
941 l
= s
->session_timeout
;
942 s
->session_timeout
= t
;
946 long SSL_CTX_get_timeout(const SSL_CTX
*s
)
950 return (s
->session_timeout
);
953 int SSL_set_session_secret_cb(SSL
*s
,
954 tls_session_secret_cb_fn tls_session_secret_cb
,
959 s
->ext
.session_secret_cb
= tls_session_secret_cb
;
960 s
->ext
.session_secret_cb_arg
= arg
;
964 int SSL_set_session_ticket_ext_cb(SSL
*s
, tls_session_ticket_ext_cb_fn cb
,
969 s
->ext
.session_ticket_cb
= cb
;
970 s
->ext
.session_ticket_cb_arg
= arg
;
974 int SSL_set_session_ticket_ext(SSL
*s
, void *ext_data
, int ext_len
)
976 if (s
->version
>= TLS1_VERSION
) {
977 OPENSSL_free(s
->ext
.session_ticket
);
978 s
->ext
.session_ticket
= NULL
;
979 s
->ext
.session_ticket
=
980 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT
) + ext_len
);
981 if (s
->ext
.session_ticket
== NULL
) {
982 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT
, ERR_R_MALLOC_FAILURE
);
986 if (ext_data
!= NULL
) {
987 s
->ext
.session_ticket
->length
= ext_len
;
988 s
->ext
.session_ticket
->data
= s
->ext
.session_ticket
+ 1;
989 memcpy(s
->ext
.session_ticket
->data
, ext_data
, ext_len
);
991 s
->ext
.session_ticket
->length
= 0;
992 s
->ext
.session_ticket
->data
= NULL
;
1001 typedef struct timeout_param_st
{
1004 LHASH_OF(SSL_SESSION
) *cache
;
1007 static void timeout_cb(SSL_SESSION
*s
, TIMEOUT_PARAM
*p
)
1009 if ((p
->time
== 0) || (p
->time
> (s
->time
+ s
->timeout
))) { /* timeout */
1011 * The reason we don't call SSL_CTX_remove_session() is to save on
1014 (void)lh_SSL_SESSION_delete(p
->cache
, s
);
1015 SSL_SESSION_list_remove(p
->ctx
, s
);
1016 s
->not_resumable
= 1;
1017 if (p
->ctx
->remove_session_cb
!= NULL
)
1018 p
->ctx
->remove_session_cb(p
->ctx
, s
);
1019 SSL_SESSION_free(s
);
1023 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION
, TIMEOUT_PARAM
);
1025 void SSL_CTX_flush_sessions(SSL_CTX
*s
, long t
)
1031 tp
.cache
= s
->sessions
;
1032 if (tp
.cache
== NULL
)
1035 CRYPTO_THREAD_write_lock(s
->lock
);
1036 i
= lh_SSL_SESSION_get_down_load(s
->sessions
);
1037 lh_SSL_SESSION_set_down_load(s
->sessions
, 0);
1038 lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp
.cache
, timeout_cb
, &tp
);
1039 lh_SSL_SESSION_set_down_load(s
->sessions
, i
);
1040 CRYPTO_THREAD_unlock(s
->lock
);
1043 int ssl_clear_bad_session(SSL
*s
)
1045 if ((s
->session
!= NULL
) &&
1046 !(s
->shutdown
& SSL_SENT_SHUTDOWN
) &&
1047 !(SSL_in_init(s
) || SSL_in_before(s
))) {
1048 SSL_CTX_remove_session(s
->session_ctx
, s
->session
);
1054 /* locked by SSL_CTX in the calling function */
1055 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1057 if ((s
->next
== NULL
) || (s
->prev
== NULL
))
1060 if (s
->next
== (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1061 /* last element in list */
1062 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1063 /* only one element in list */
1064 ctx
->session_cache_head
= NULL
;
1065 ctx
->session_cache_tail
= NULL
;
1067 ctx
->session_cache_tail
= s
->prev
;
1068 s
->prev
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1071 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1072 /* first element in list */
1073 ctx
->session_cache_head
= s
->next
;
1074 s
->next
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1076 /* middle of list */
1077 s
->next
->prev
= s
->prev
;
1078 s
->prev
->next
= s
->next
;
1081 s
->prev
= s
->next
= NULL
;
1084 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1086 if ((s
->next
!= NULL
) && (s
->prev
!= NULL
))
1087 SSL_SESSION_list_remove(ctx
, s
);
1089 if (ctx
->session_cache_head
== NULL
) {
1090 ctx
->session_cache_head
= s
;
1091 ctx
->session_cache_tail
= s
;
1092 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1093 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1095 s
->next
= ctx
->session_cache_head
;
1097 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1098 ctx
->session_cache_head
= s
;
1102 void SSL_CTX_sess_set_new_cb(SSL_CTX
*ctx
,
1103 int (*cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
))
1105 ctx
->new_session_cb
= cb
;
1108 int (*SSL_CTX_sess_get_new_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, SSL_SESSION
*sess
) {
1109 return ctx
->new_session_cb
;
1112 void SSL_CTX_sess_set_remove_cb(SSL_CTX
*ctx
,
1113 void (*cb
) (SSL_CTX
*ctx
, SSL_SESSION
*sess
))
1115 ctx
->remove_session_cb
= cb
;
1118 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX
*ctx
)) (SSL_CTX
*ctx
,
1119 SSL_SESSION
*sess
) {
1120 return ctx
->remove_session_cb
;
1123 void SSL_CTX_sess_set_get_cb(SSL_CTX
*ctx
,
1124 SSL_SESSION
*(*cb
) (struct ssl_st
*ssl
,
1125 const unsigned char *data
,
1126 int len
, int *copy
))
1128 ctx
->get_session_cb
= cb
;
1131 SSL_SESSION
*(*SSL_CTX_sess_get_get_cb(SSL_CTX
*ctx
)) (SSL
*ssl
,
1135 return ctx
->get_session_cb
;
1138 void SSL_CTX_set_info_callback(SSL_CTX
*ctx
,
1139 void (*cb
) (const SSL
*ssl
, int type
, int val
))
1141 ctx
->info_callback
= cb
;
1144 void (*SSL_CTX_get_info_callback(SSL_CTX
*ctx
)) (const SSL
*ssl
, int type
,
1146 return ctx
->info_callback
;
1149 void SSL_CTX_set_client_cert_cb(SSL_CTX
*ctx
,
1150 int (*cb
) (SSL
*ssl
, X509
**x509
,
1153 ctx
->client_cert_cb
= cb
;
1156 int (*SSL_CTX_get_client_cert_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, X509
**x509
,
1158 return ctx
->client_cert_cb
;
1161 #ifndef OPENSSL_NO_ENGINE
1162 int SSL_CTX_set_client_cert_engine(SSL_CTX
*ctx
, ENGINE
*e
)
1164 if (!ENGINE_init(e
)) {
1165 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE
, ERR_R_ENGINE_LIB
);
1168 if (!ENGINE_get_ssl_client_cert_function(e
)) {
1169 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE
,
1170 SSL_R_NO_CLIENT_CERT_METHOD
);
1174 ctx
->client_cert_engine
= e
;
1179 void SSL_CTX_set_cookie_generate_cb(SSL_CTX
*ctx
,
1180 int (*cb
) (SSL
*ssl
,
1181 unsigned char *cookie
,
1182 unsigned int *cookie_len
))
1184 ctx
->app_gen_cookie_cb
= cb
;
1187 void SSL_CTX_set_cookie_verify_cb(SSL_CTX
*ctx
,
1188 int (*cb
) (SSL
*ssl
,
1189 const unsigned char *cookie
,
1190 unsigned int cookie_len
))
1192 ctx
->app_verify_cookie_cb
= cb
;
1195 IMPLEMENT_PEM_rw(SSL_SESSION
, SSL_SESSION
, PEM_STRING_SSL_SESSION
, SSL_SESSION
)