2 * Copyright 1995-2017 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/rand.h>
13 #include <openssl/engine.h>
14 #include "internal/refcount.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 */
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);
96 SSL_SESSION *SSL_SESSION_dup(SSL_SESSION *src)
98 return ssl_session_dup(src, 1);
102 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
103 * ticket == 0 then no ticket information is duplicated, otherwise it is.
105 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
109 dest = OPENSSL_malloc(sizeof(*src));
113 memcpy(dest, src, sizeof(*dest));
116 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
117 * the case of an error whilst halfway through constructing dest
119 #ifndef OPENSSL_NO_PSK
120 dest->psk_identity_hint = NULL;
121 dest->psk_identity = NULL;
123 dest->ciphers = NULL;
124 dest->ext.hostname = NULL;
125 #ifndef OPENSSL_NO_EC
126 dest->ext.ecpointformats = NULL;
127 dest->ext.supportedgroups = NULL;
129 dest->ext.tick = NULL;
130 dest->ext.alpn_selected = NULL;
131 #ifndef OPENSSL_NO_SRP
132 dest->srp_username = NULL;
134 dest->peer_chain = NULL;
136 dest->ext.tick_nonce = NULL;
137 dest->ticket_appdata = NULL;
138 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
140 /* We deliberately don't copy the prev and next pointers */
144 dest->references = 1;
146 dest->lock = CRYPTO_THREAD_lock_new();
147 if (dest->lock == NULL)
150 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, dest, &dest->ex_data))
153 if (src->peer != NULL) {
154 if (!X509_up_ref(src->peer))
156 dest->peer = src->peer;
159 if (src->peer_chain != NULL) {
160 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
161 if (dest->peer_chain == NULL)
164 #ifndef OPENSSL_NO_PSK
165 if (src->psk_identity_hint) {
166 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
167 if (dest->psk_identity_hint == NULL) {
171 if (src->psk_identity) {
172 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
173 if (dest->psk_identity == NULL) {
179 if (src->ciphers != NULL) {
180 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
181 if (dest->ciphers == NULL)
185 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
186 &dest->ex_data, &src->ex_data)) {
190 if (src->ext.hostname) {
191 dest->ext.hostname = OPENSSL_strdup(src->ext.hostname);
192 if (dest->ext.hostname == NULL) {
196 #ifndef OPENSSL_NO_EC
197 if (src->ext.ecpointformats) {
198 dest->ext.ecpointformats =
199 OPENSSL_memdup(src->ext.ecpointformats,
200 src->ext.ecpointformats_len);
201 if (dest->ext.ecpointformats == NULL)
204 if (src->ext.supportedgroups) {
205 dest->ext.supportedgroups =
206 OPENSSL_memdup(src->ext.supportedgroups,
207 src->ext.supportedgroups_len);
208 if (dest->ext.supportedgroups == NULL)
213 if (ticket != 0 && src->ext.tick != NULL) {
215 OPENSSL_memdup(src->ext.tick, src->ext.ticklen);
216 if (dest->ext.tick == NULL)
219 dest->ext.tick_lifetime_hint = 0;
220 dest->ext.ticklen = 0;
223 if (src->ext.alpn_selected) {
224 dest->ext.alpn_selected =
225 (unsigned char*)OPENSSL_strndup((char*)src->ext.alpn_selected,
226 src->ext.alpn_selected_len);
227 if (dest->ext.alpn_selected == NULL) {
232 if (src->ext.tick_nonce != NULL) {
233 dest->ext.tick_nonce = OPENSSL_memdup(src->ext.tick_nonce,
234 src->ext.tick_nonce_len);
235 if (dest->ext.tick_nonce == NULL)
239 #ifndef OPENSSL_NO_SRP
240 if (src->srp_username) {
241 dest->srp_username = OPENSSL_strdup(src->srp_username);
242 if (dest->srp_username == NULL) {
248 if (src->ticket_appdata != NULL) {
249 dest->ticket_appdata =
250 OPENSSL_memdup(src->ticket_appdata, src->ticket_appdata_len);
251 if (dest->ticket_appdata == NULL)
257 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
258 SSL_SESSION_free(dest);
262 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
265 *len = (unsigned int)s->session_id_length;
266 return s->session_id;
268 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
272 *len = (unsigned int)s->sid_ctx_length;
276 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
278 return s->compress_meth;
282 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
283 * the ID with random junk repeatedly until we have no conflict is going to
284 * complete in one iteration pretty much "most" of the time (btw:
285 * understatement). So, if it takes us 10 iterations and we still can't avoid
286 * a conflict - well that's a reasonable point to call it quits. Either the
287 * RAND code is broken or someone is trying to open roughly very close to
288 * 2^256 SSL sessions to our server. How you might store that many sessions
289 * is perhaps a more interesting question ...
292 #define MAX_SESS_ID_ATTEMPTS 10
293 static int def_generate_session_id(SSL *ssl, unsigned char *id,
294 unsigned int *id_len)
296 unsigned int retry = 0;
298 if (ssl_randbytes(ssl, id, *id_len) <= 0)
300 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
301 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
302 if (retry < MAX_SESS_ID_ATTEMPTS)
304 /* else - woops a session_id match */
306 * XXX We should also check the external cache -- but the probability of
307 * a collision is negligible, and we could not prevent the concurrent
308 * creation of sessions with identical IDs since we currently don't have
309 * means to atomically check whether a session ID already exists and make
310 * a reservation for it if it does not (this problem applies to the
311 * internal cache as well).
316 int ssl_generate_session_id(SSL *s, SSL_SESSION *ss)
319 GEN_SESSION_CB cb = def_generate_session_id;
321 switch (s->version) {
329 case DTLS1_2_VERSION:
330 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
333 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
334 SSL_R_UNSUPPORTED_SSL_VERSION);
339 * If RFC5077 ticket, use empty session ID (as server).
341 * (a) ssl_get_prev_session() does lookahead into the
342 * ClientHello extensions to find the session ticket.
343 * When ssl_get_prev_session() fails, statem_srvr.c calls
344 * ssl_get_new_session() in tls_process_client_hello().
345 * At that point, it has not yet parsed the extensions,
346 * however, because of the lookahead, it already knows
347 * whether a ticket is expected or not.
349 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
350 * ServerHello extensions, and before recording the session
351 * ID received from the server, so this block is a noop.
353 if (s->ext.ticket_expected) {
354 ss->session_id_length = 0;
358 /* Choose which callback will set the session ID */
359 CRYPTO_THREAD_read_lock(s->lock);
360 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
361 if (s->generate_session_id)
362 cb = s->generate_session_id;
363 else if (s->session_ctx->generate_session_id)
364 cb = s->session_ctx->generate_session_id;
365 CRYPTO_THREAD_unlock(s->session_ctx->lock);
366 CRYPTO_THREAD_unlock(s->lock);
367 /* Choose a session ID */
368 memset(ss->session_id, 0, ss->session_id_length);
369 tmp = (int)ss->session_id_length;
370 if (!cb(s, ss->session_id, &tmp)) {
371 /* The callback failed */
372 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
373 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
377 * Don't allow the callback to set the session length to zero. nor
378 * set it higher than it was.
380 if (tmp == 0 || tmp > ss->session_id_length) {
381 /* The callback set an illegal length */
382 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
383 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
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 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
391 SSL_R_SSL_SESSION_ID_CONFLICT);
398 int ssl_get_new_session(SSL *s, int session)
400 /* This gets used by clients and servers. */
402 SSL_SESSION *ss = NULL;
404 if ((ss = SSL_SESSION_new()) == NULL) {
405 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_NEW_SESSION,
406 ERR_R_MALLOC_FAILURE);
410 /* If the context has a default timeout, use it */
411 if (s->session_ctx->session_timeout == 0)
412 ss->timeout = SSL_get_default_timeout(s);
414 ss->timeout = s->session_ctx->session_timeout;
416 SSL_SESSION_free(s->session);
420 if (SSL_IS_TLS13(s)) {
422 * We generate the session id while constructing the
423 * NewSessionTicket in TLSv1.3.
425 ss->session_id_length = 0;
426 } else if (!ssl_generate_session_id(s, ss)) {
427 /* SSLfatal() already called */
428 SSL_SESSION_free(ss);
432 if (s->ext.hostname) {
433 ss->ext.hostname = OPENSSL_strdup(s->ext.hostname);
434 if (ss->ext.hostname == NULL) {
435 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_NEW_SESSION,
436 ERR_R_INTERNAL_ERROR);
437 SSL_SESSION_free(ss);
442 ss->session_id_length = 0;
445 if (s->sid_ctx_length > sizeof(ss->sid_ctx)) {
446 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_NEW_SESSION,
447 ERR_R_INTERNAL_ERROR);
448 SSL_SESSION_free(ss);
451 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
452 ss->sid_ctx_length = s->sid_ctx_length;
454 ss->ssl_version = s->version;
455 ss->verify_result = X509_V_OK;
457 /* If client supports extended master secret set it in session */
458 if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)
459 ss->flags |= SSL_SESS_FLAG_EXTMS;
465 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
466 * connection. It is only called by servers.
468 * hello: The parsed ClientHello data
472 * 0: no session found
473 * 1: a session may have been found.
476 * - If a session is found then s->session is pointed at it (after freeing an
477 * existing session if need be) and s->verify_result is set from the session.
478 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
479 * if the server should issue a new session ticket (to 0 otherwise).
481 int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello)
483 /* This is used only by servers. */
485 SSL_SESSION *ret = NULL;
486 int fatal = 0, discard;
487 int try_session_cache = 0;
490 if (SSL_IS_TLS13(s)) {
491 if (!tls_parse_extension(s, TLSEXT_IDX_psk_kex_modes,
492 SSL_EXT_CLIENT_HELLO, hello->pre_proc_exts,
494 || !tls_parse_extension(s, TLSEXT_IDX_psk, SSL_EXT_CLIENT_HELLO,
495 hello->pre_proc_exts, NULL, 0))
500 /* sets s->ext.ticket_expected */
501 r = tls_get_ticket_from_client(s, hello, &ret);
503 case SSL_TICKET_FATAL_ERR_MALLOC:
504 case SSL_TICKET_FATAL_ERR_OTHER:
506 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_PREV_SESSION,
507 ERR_R_INTERNAL_ERROR);
509 case SSL_TICKET_NONE:
510 case SSL_TICKET_EMPTY:
511 if (hello->session_id_len > 0)
512 try_session_cache = 1;
514 case SSL_TICKET_NO_DECRYPT:
515 case SSL_TICKET_SUCCESS:
516 case SSL_TICKET_SUCCESS_RENEW:
521 if (try_session_cache &&
523 !(s->session_ctx->session_cache_mode &
524 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
527 data.ssl_version = s->version;
528 memcpy(data.session_id, hello->session_id, hello->session_id_len);
529 data.session_id_length = hello->session_id_len;
531 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
532 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
534 /* don't allow other threads to steal it: */
535 SSL_SESSION_up_ref(ret);
537 CRYPTO_THREAD_unlock(s->session_ctx->lock);
539 CRYPTO_atomic_add(&s->session_ctx->stats.sess_miss, 1, &discard,
540 s->session_ctx->lock);
543 if (try_session_cache &&
544 ret == NULL && s->session_ctx->get_session_cb != NULL) {
547 ret = s->session_ctx->get_session_cb(s, hello->session_id,
548 hello->session_id_len,
552 CRYPTO_atomic_add(&s->session_ctx->stats.sess_cb_hit, 1, &discard,
553 s->session_ctx->lock);
556 * Increment reference count now if the session callback asks us
557 * to do so (note that if the session structures returned by the
558 * callback are shared between threads, it must handle the
559 * reference count itself [i.e. copy == 0], or things won't be
563 SSL_SESSION_up_ref(ret);
566 * Add the externally cached session to the internal cache as
567 * well if and only if we are supposed to.
570 (s->session_ctx->session_cache_mode &
571 SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
573 * Either return value of SSL_CTX_add_session should not
574 * interrupt the session resumption process. The return
575 * value is intentionally ignored.
577 SSL_CTX_add_session(s->session_ctx, ret);
585 /* Now ret is non-NULL and we own one of its reference counts. */
587 /* Check TLS version consistency */
588 if (ret->ssl_version != s->version)
591 if (ret->sid_ctx_length != s->sid_ctx_length
592 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
594 * We have the session requested by the client, but we don't want to
595 * use it in this context.
597 goto err; /* treat like cache miss */
600 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
602 * We can't be sure if this session is being used out of context,
603 * which is especially important for SSL_VERIFY_PEER. The application
604 * should have used SSL[_CTX]_set_session_id_context. For this error
605 * case, we generate an error instead of treating the event like a
606 * cache miss (otherwise it would be easy for applications to
607 * effectively disable the session cache by accident without anyone
611 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_PREV_SESSION,
612 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
617 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
618 CRYPTO_atomic_add(&s->session_ctx->stats.sess_timeout, 1, &discard,
619 s->session_ctx->lock);
620 if (try_session_cache) {
621 /* session was from the cache, so remove it */
622 SSL_CTX_remove_session(s->session_ctx, ret);
627 /* Check extended master secret extension consistency */
628 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
629 /* If old session includes extms, but new does not: abort handshake */
630 if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
631 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_GET_PREV_SESSION,
632 SSL_R_INCONSISTENT_EXTMS);
636 } else if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) {
637 /* If new session includes extms, but old does not: do not resume */
641 if (!SSL_IS_TLS13(s)) {
642 /* We already did this for TLS1.3 */
643 SSL_SESSION_free(s->session);
647 CRYPTO_atomic_add(&s->session_ctx->stats.sess_hit, 1, &discard,
648 s->session_ctx->lock);
649 s->verify_result = s->session->verify_result;
654 SSL_SESSION_free(ret);
655 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
659 if (!try_session_cache) {
661 * The session was from a ticket, so we should issue a ticket for
664 s->ext.ticket_expected = 1;
673 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
675 int ret = 0, discard;
679 * add just 1 reference count for the SSL_CTX's session cache even though
680 * it has two ways of access: each session is in a doubly linked list and
683 SSL_SESSION_up_ref(c);
685 * if session c is in already in cache, we take back the increment later
688 CRYPTO_THREAD_write_lock(ctx->lock);
689 s = lh_SSL_SESSION_insert(ctx->sessions, c);
692 * s != NULL iff we already had a session with the given PID. In this
693 * case, s == c should hold (then we did not really modify
694 * ctx->sessions), or we're in trouble.
696 if (s != NULL && s != c) {
697 /* We *are* in trouble ... */
698 SSL_SESSION_list_remove(ctx, s);
701 * ... so pretend the other session did not exist in cache (we cannot
702 * handle two SSL_SESSION structures with identical session ID in the
703 * same cache, which could happen e.g. when two threads concurrently
704 * obtain the same session from an external cache)
707 } else if (s == NULL &&
708 lh_SSL_SESSION_retrieve(ctx->sessions, c) == NULL) {
709 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
712 * ... so take back the extra reference and also don't add
713 * the session to the SSL_SESSION_list at this time
718 /* Put at the head of the queue unless it is already in the cache */
720 SSL_SESSION_list_add(ctx, c);
724 * existing cache entry -- decrement previously incremented reference
725 * count because it already takes into account the cache
728 SSL_SESSION_free(s); /* s == c */
732 * new cache entry -- remove old ones if cache has become too large
737 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
738 while (SSL_CTX_sess_number(ctx) > SSL_CTX_sess_get_cache_size(ctx)) {
739 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
742 CRYPTO_atomic_add(&ctx->stats.sess_cache_full, 1, &discard,
747 CRYPTO_THREAD_unlock(ctx->lock);
751 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
753 return remove_session_lock(ctx, c, 1);
756 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
761 if ((c != NULL) && (c->session_id_length != 0)) {
763 CRYPTO_THREAD_write_lock(ctx->lock);
764 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
766 r = lh_SSL_SESSION_delete(ctx->sessions, c);
767 SSL_SESSION_list_remove(ctx, c);
769 c->not_resumable = 1;
772 CRYPTO_THREAD_unlock(ctx->lock);
777 if (ctx->remove_session_cb != NULL)
778 ctx->remove_session_cb(ctx, c);
784 void SSL_SESSION_free(SSL_SESSION *ss)
791 CRYPTO_DOWN_REF(&ss->references, &i, ss->lock);
792 REF_PRINT_COUNT("SSL_SESSION", ss);
795 REF_ASSERT_ISNT(i < 0);
797 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
799 OPENSSL_cleanse(ss->master_key, sizeof(ss->master_key));
800 OPENSSL_cleanse(ss->session_id, sizeof(ss->session_id));
802 sk_X509_pop_free(ss->peer_chain, X509_free);
803 sk_SSL_CIPHER_free(ss->ciphers);
804 OPENSSL_free(ss->ext.hostname);
805 OPENSSL_free(ss->ext.tick);
806 #ifndef OPENSSL_NO_EC
807 OPENSSL_free(ss->ext.ecpointformats);
808 ss->ext.ecpointformats = NULL;
809 ss->ext.ecpointformats_len = 0;
810 OPENSSL_free(ss->ext.supportedgroups);
811 ss->ext.supportedgroups = NULL;
812 ss->ext.supportedgroups_len = 0;
813 #endif /* OPENSSL_NO_EC */
814 #ifndef OPENSSL_NO_PSK
815 OPENSSL_free(ss->psk_identity_hint);
816 OPENSSL_free(ss->psk_identity);
818 #ifndef OPENSSL_NO_SRP
819 OPENSSL_free(ss->srp_username);
821 OPENSSL_free(ss->ext.alpn_selected);
822 OPENSSL_free(ss->ext.tick_nonce);
823 OPENSSL_free(ss->ticket_appdata);
824 CRYPTO_THREAD_lock_free(ss->lock);
825 OPENSSL_clear_free(ss, sizeof(*ss));
828 int SSL_SESSION_up_ref(SSL_SESSION *ss)
832 if (CRYPTO_UP_REF(&ss->references, &i, ss->lock) <= 0)
835 REF_PRINT_COUNT("SSL_SESSION", ss);
836 REF_ASSERT_ISNT(i < 2);
837 return ((i > 1) ? 1 : 0);
840 int SSL_set_session(SSL *s, SSL_SESSION *session)
842 ssl_clear_bad_session(s);
843 if (s->ctx->method != s->method) {
844 if (!SSL_set_ssl_method(s, s->ctx->method))
848 if (session != NULL) {
849 SSL_SESSION_up_ref(session);
850 s->verify_result = session->verify_result;
852 SSL_SESSION_free(s->session);
853 s->session = session;
858 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
859 unsigned int sid_len)
861 if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
862 SSLerr(SSL_F_SSL_SESSION_SET1_ID,
863 SSL_R_SSL_SESSION_ID_TOO_LONG);
866 s->session_id_length = sid_len;
867 if (sid != s->session_id)
868 memcpy(s->session_id, sid, sid_len);
872 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
880 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
887 long SSL_SESSION_get_time(const SSL_SESSION *s)
894 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
902 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
904 return s->ssl_version;
907 int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version)
909 s->ssl_version = version;
913 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
918 int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher)
924 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
926 return s->ext.hostname;
929 int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname)
931 OPENSSL_free(s->ext.hostname);
932 if (hostname == NULL) {
933 s->ext.hostname = NULL;
936 s->ext.hostname = OPENSSL_strdup(hostname);
938 return s->ext.hostname != NULL;
941 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
943 return (s->ext.ticklen > 0) ? 1 : 0;
946 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
948 return s->ext.tick_lifetime_hint;
951 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
954 *len = s->ext.ticklen;
959 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s)
961 return s->ext.max_early_data;
964 int SSL_SESSION_set_max_early_data(SSL_SESSION *s, uint32_t max_early_data)
966 s->ext.max_early_data = max_early_data;
971 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
972 const unsigned char **alpn,
975 *alpn = s->ext.alpn_selected;
976 *len = s->ext.alpn_selected_len;
979 int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s, const unsigned char *alpn,
982 OPENSSL_free(s->ext.alpn_selected);
983 if (alpn == NULL || len == 0) {
984 s->ext.alpn_selected = NULL;
985 s->ext.alpn_selected_len = 0;
988 s->ext.alpn_selected = OPENSSL_memdup(alpn, len);
989 if (s->ext.alpn_selected == NULL) {
990 s->ext.alpn_selected_len = 0;
993 s->ext.alpn_selected_len = len;
998 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
1003 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
1004 unsigned int sid_ctx_len)
1006 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
1007 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
1008 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
1011 s->sid_ctx_length = sid_ctx_len;
1012 if (sid_ctx != s->sid_ctx)
1013 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
1018 int SSL_SESSION_is_resumable(const SSL_SESSION *s)
1021 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
1024 return !s->not_resumable
1025 && (s->session_id_length > 0 || s->ext.ticklen > 0);
1028 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
1033 l = s->session_timeout;
1034 s->session_timeout = t;
1038 long SSL_CTX_get_timeout(const SSL_CTX *s)
1042 return s->session_timeout;
1045 int SSL_set_session_secret_cb(SSL *s,
1046 tls_session_secret_cb_fn tls_session_secret_cb,
1051 s->ext.session_secret_cb = tls_session_secret_cb;
1052 s->ext.session_secret_cb_arg = arg;
1056 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
1061 s->ext.session_ticket_cb = cb;
1062 s->ext.session_ticket_cb_arg = arg;
1066 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1068 if (s->version >= TLS1_VERSION) {
1069 OPENSSL_free(s->ext.session_ticket);
1070 s->ext.session_ticket = NULL;
1071 s->ext.session_ticket =
1072 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1073 if (s->ext.session_ticket == NULL) {
1074 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
1078 if (ext_data != NULL) {
1079 s->ext.session_ticket->length = ext_len;
1080 s->ext.session_ticket->data = s->ext.session_ticket + 1;
1081 memcpy(s->ext.session_ticket->data, ext_data, ext_len);
1083 s->ext.session_ticket->length = 0;
1084 s->ext.session_ticket->data = NULL;
1093 typedef struct timeout_param_st {
1096 LHASH_OF(SSL_SESSION) *cache;
1099 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
1101 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1103 * The reason we don't call SSL_CTX_remove_session() is to save on
1106 (void)lh_SSL_SESSION_delete(p->cache, s);
1107 SSL_SESSION_list_remove(p->ctx, s);
1108 s->not_resumable = 1;
1109 if (p->ctx->remove_session_cb != NULL)
1110 p->ctx->remove_session_cb(p->ctx, s);
1111 SSL_SESSION_free(s);
1115 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
1117 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1123 tp.cache = s->sessions;
1124 if (tp.cache == NULL)
1127 CRYPTO_THREAD_write_lock(s->lock);
1128 i = lh_SSL_SESSION_get_down_load(s->sessions);
1129 lh_SSL_SESSION_set_down_load(s->sessions, 0);
1130 lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1131 lh_SSL_SESSION_set_down_load(s->sessions, i);
1132 CRYPTO_THREAD_unlock(s->lock);
1135 int ssl_clear_bad_session(SSL *s)
1137 if ((s->session != NULL) &&
1138 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1139 !(SSL_in_init(s) || SSL_in_before(s))) {
1140 SSL_CTX_remove_session(s->session_ctx, s->session);
1146 /* locked by SSL_CTX in the calling function */
1147 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1149 if ((s->next == NULL) || (s->prev == NULL))
1152 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1153 /* last element in list */
1154 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1155 /* only one element in list */
1156 ctx->session_cache_head = NULL;
1157 ctx->session_cache_tail = NULL;
1159 ctx->session_cache_tail = s->prev;
1160 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1163 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1164 /* first element in list */
1165 ctx->session_cache_head = s->next;
1166 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1168 /* middle of list */
1169 s->next->prev = s->prev;
1170 s->prev->next = s->next;
1173 s->prev = s->next = NULL;
1176 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1178 if ((s->next != NULL) && (s->prev != NULL))
1179 SSL_SESSION_list_remove(ctx, s);
1181 if (ctx->session_cache_head == NULL) {
1182 ctx->session_cache_head = s;
1183 ctx->session_cache_tail = s;
1184 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1185 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1187 s->next = ctx->session_cache_head;
1189 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1190 ctx->session_cache_head = s;
1194 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1195 int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1197 ctx->new_session_cb = cb;
1200 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1201 return ctx->new_session_cb;
1204 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1205 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1207 ctx->remove_session_cb = cb;
1210 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1211 SSL_SESSION *sess) {
1212 return ctx->remove_session_cb;
1215 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1216 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1217 const unsigned char *data,
1218 int len, int *copy))
1220 ctx->get_session_cb = cb;
1223 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1227 return ctx->get_session_cb;
1230 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1231 void (*cb) (const SSL *ssl, int type, int val))
1233 ctx->info_callback = cb;
1236 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1238 return ctx->info_callback;
1241 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1242 int (*cb) (SSL *ssl, X509 **x509,
1245 ctx->client_cert_cb = cb;
1248 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1250 return ctx->client_cert_cb;
1253 #ifndef OPENSSL_NO_ENGINE
1254 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1256 if (!ENGINE_init(e)) {
1257 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1260 if (!ENGINE_get_ssl_client_cert_function(e)) {
1261 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1262 SSL_R_NO_CLIENT_CERT_METHOD);
1266 ctx->client_cert_engine = e;
1271 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1272 int (*cb) (SSL *ssl,
1273 unsigned char *cookie,
1274 unsigned int *cookie_len))
1276 ctx->app_gen_cookie_cb = cb;
1279 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1280 int (*cb) (SSL *ssl,
1281 const unsigned char *cookie,
1282 unsigned int cookie_len))
1284 ctx->app_verify_cookie_cb = cb;
1287 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len)
1289 OPENSSL_free(ss->ticket_appdata);
1290 ss->ticket_appdata_len = 0;
1291 if (data == NULL || len == 0) {
1292 ss->ticket_appdata = NULL;
1295 ss->ticket_appdata = OPENSSL_memdup(data, len);
1296 if (ss->ticket_appdata != NULL) {
1297 ss->ticket_appdata_len = len;
1303 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len)
1305 *data = ss->ticket_appdata;
1306 *len = ss->ticket_appdata_len;
1310 void SSL_CTX_set_stateless_cookie_generate_cb(
1312 int (*cb) (SSL *ssl,
1313 unsigned char *cookie,
1314 size_t *cookie_len))
1316 ctx->gen_stateless_cookie_cb = cb;
1319 void SSL_CTX_set_stateless_cookie_verify_cb(
1321 int (*cb) (SSL *ssl,
1322 const unsigned char *cookie,
1325 ctx->verify_stateless_cookie_cb = cb;
1328 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)