2 * Copyright 1995-2018 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
12 #include <openssl/rand.h>
13 #include <openssl/engine.h>
14 #include "internal/refcount.h"
15 #include "internal/cryptlib.h"
17 #include "statem/statem_locl.h"
19 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
20 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
21 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
24 * SSL_get_session() and SSL_get1_session() are problematic in TLS1.3 because,
25 * unlike in earlier protocol versions, the session ticket may not have been
26 * sent yet even though a handshake has finished. The session ticket data could
27 * come in sometime later...or even change if multiple session ticket messages
28 * are sent from the server. The preferred way for applications to obtain
29 * a resumable session is to use SSL_CTX_sess_set_new_cb().
32 SSL_SESSION *SSL_get_session(const SSL *ssl)
33 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
38 SSL_SESSION *SSL_get1_session(SSL *ssl)
39 /* variant of SSL_get_session: caller really gets something */
43 * Need to lock this all up rather than just use CRYPTO_add so that
44 * somebody doesn't free ssl->session between when we check it's non-null
45 * and when we up the reference count.
47 CRYPTO_THREAD_read_lock(ssl->lock);
50 SSL_SESSION_up_ref(sess);
51 CRYPTO_THREAD_unlock(ssl->lock);
55 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
57 return CRYPTO_set_ex_data(&s->ex_data, idx, arg);
60 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
62 return CRYPTO_get_ex_data(&s->ex_data, idx);
65 SSL_SESSION *SSL_SESSION_new(void)
69 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
72 ss = OPENSSL_zalloc(sizeof(*ss));
74 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
78 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
80 ss->timeout = 60 * 5 + 4; /* 5 minute timeout by default */
81 ss->time = (unsigned long)time(NULL);
82 ss->lock = CRYPTO_THREAD_lock_new();
83 if (ss->lock == NULL) {
84 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
89 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data)) {
90 CRYPTO_THREAD_lock_free(ss->lock);
97 SSL_SESSION *SSL_SESSION_dup(const SSL_SESSION *src)
99 return ssl_session_dup(src, 1);
103 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
104 * ticket == 0 then no ticket information is duplicated, otherwise it is.
106 SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket)
110 dest = OPENSSL_malloc(sizeof(*src));
114 memcpy(dest, src, sizeof(*dest));
117 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
118 * the case of an error whilst halfway through constructing dest
120 #ifndef OPENSSL_NO_PSK
121 dest->psk_identity_hint = NULL;
122 dest->psk_identity = NULL;
124 dest->ext.hostname = NULL;
125 #ifndef OPENSSL_NO_EC
126 dest->ext.ecpointformats = NULL;
128 dest->ext.tick = NULL;
129 dest->ext.alpn_selected = NULL;
130 #ifndef OPENSSL_NO_SRP
131 dest->srp_username = NULL;
133 dest->peer_chain = NULL;
135 dest->ticket_appdata = NULL;
136 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
138 /* We deliberately don't copy the prev and next pointers */
142 dest->references = 1;
144 dest->lock = CRYPTO_THREAD_lock_new();
145 if (dest->lock == NULL)
148 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, dest, &dest->ex_data))
151 if (src->peer != NULL) {
152 if (!X509_up_ref(src->peer))
154 dest->peer = src->peer;
157 if (src->peer_chain != NULL) {
158 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
159 if (dest->peer_chain == NULL)
162 #ifndef OPENSSL_NO_PSK
163 if (src->psk_identity_hint) {
164 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
165 if (dest->psk_identity_hint == NULL) {
169 if (src->psk_identity) {
170 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
171 if (dest->psk_identity == 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)
198 if (ticket != 0 && src->ext.tick != NULL) {
200 OPENSSL_memdup(src->ext.tick, src->ext.ticklen);
201 if (dest->ext.tick == NULL)
204 dest->ext.tick_lifetime_hint = 0;
205 dest->ext.ticklen = 0;
208 if (src->ext.alpn_selected != NULL) {
209 dest->ext.alpn_selected = OPENSSL_memdup(src->ext.alpn_selected,
210 src->ext.alpn_selected_len);
211 if (dest->ext.alpn_selected == NULL)
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) {
224 if (src->ticket_appdata != NULL) {
225 dest->ticket_appdata =
226 OPENSSL_memdup(src->ticket_appdata, src->ticket_appdata_len);
227 if (dest->ticket_appdata == NULL)
233 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
234 SSL_SESSION_free(dest);
238 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
241 *len = (unsigned int)s->session_id_length;
242 return s->session_id;
244 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
248 *len = (unsigned int)s->sid_ctx_length;
252 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
254 return s->compress_meth;
258 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
259 * the ID with random junk repeatedly until we have no conflict is going to
260 * complete in one iteration pretty much "most" of the time (btw:
261 * understatement). So, if it takes us 10 iterations and we still can't avoid
262 * a conflict - well that's a reasonable point to call it quits. Either the
263 * RAND code is broken or someone is trying to open roughly very close to
264 * 2^256 SSL sessions to our server. How you might store that many sessions
265 * is perhaps a more interesting question ...
268 #define MAX_SESS_ID_ATTEMPTS 10
269 static int def_generate_session_id(SSL *ssl, unsigned char *id,
270 unsigned int *id_len)
272 unsigned int retry = 0;
274 if (RAND_bytes(id, *id_len) <= 0)
276 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
277 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
278 if (retry < MAX_SESS_ID_ATTEMPTS)
280 /* else - woops a session_id match */
282 * XXX We should also check the external cache -- but the probability of
283 * a collision is negligible, and we could not prevent the concurrent
284 * creation of sessions with identical IDs since we currently don't have
285 * means to atomically check whether a session ID already exists and make
286 * a reservation for it if it does not (this problem applies to the
287 * internal cache as well).
292 int ssl_generate_session_id(SSL *s, SSL_SESSION *ss)
295 GEN_SESSION_CB cb = def_generate_session_id;
297 switch (s->version) {
305 case DTLS1_2_VERSION:
306 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
309 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
310 SSL_R_UNSUPPORTED_SSL_VERSION);
315 * If RFC5077 ticket, use empty session ID (as server).
317 * (a) ssl_get_prev_session() does lookahead into the
318 * ClientHello extensions to find the session ticket.
319 * When ssl_get_prev_session() fails, statem_srvr.c calls
320 * ssl_get_new_session() in tls_process_client_hello().
321 * At that point, it has not yet parsed the extensions,
322 * however, because of the lookahead, it already knows
323 * whether a ticket is expected or not.
325 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
326 * ServerHello extensions, and before recording the session
327 * ID received from the server, so this block is a noop.
329 if (s->ext.ticket_expected) {
330 ss->session_id_length = 0;
334 /* Choose which callback will set the session ID */
335 CRYPTO_THREAD_read_lock(s->lock);
336 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
337 if (s->generate_session_id)
338 cb = s->generate_session_id;
339 else if (s->session_ctx->generate_session_id)
340 cb = s->session_ctx->generate_session_id;
341 CRYPTO_THREAD_unlock(s->session_ctx->lock);
342 CRYPTO_THREAD_unlock(s->lock);
343 /* Choose a session ID */
344 memset(ss->session_id, 0, ss->session_id_length);
345 tmp = (int)ss->session_id_length;
346 if (!cb(s, ss->session_id, &tmp)) {
347 /* The callback failed */
348 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
349 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
353 * Don't allow the callback to set the session length to zero. nor
354 * set it higher than it was.
356 if (tmp == 0 || tmp > ss->session_id_length) {
357 /* The callback set an illegal length */
358 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
359 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
362 ss->session_id_length = tmp;
363 /* Finally, check for a conflict */
364 if (SSL_has_matching_session_id(s, ss->session_id,
365 (unsigned int)ss->session_id_length)) {
366 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GENERATE_SESSION_ID,
367 SSL_R_SSL_SESSION_ID_CONFLICT);
374 int ssl_get_new_session(SSL *s, int session)
376 /* This gets used by clients and servers. */
378 SSL_SESSION *ss = NULL;
380 if ((ss = SSL_SESSION_new()) == NULL) {
381 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_NEW_SESSION,
382 ERR_R_MALLOC_FAILURE);
386 /* If the context has a default timeout, use it */
387 if (s->session_ctx->session_timeout == 0)
388 ss->timeout = SSL_get_default_timeout(s);
390 ss->timeout = s->session_ctx->session_timeout;
392 SSL_SESSION_free(s->session);
396 if (SSL_IS_TLS13(s)) {
398 * We generate the session id while constructing the
399 * NewSessionTicket in TLSv1.3.
401 ss->session_id_length = 0;
402 } else if (!ssl_generate_session_id(s, ss)) {
403 /* SSLfatal() already called */
404 SSL_SESSION_free(ss);
409 ss->session_id_length = 0;
412 if (s->sid_ctx_length > sizeof(ss->sid_ctx)) {
413 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_NEW_SESSION,
414 ERR_R_INTERNAL_ERROR);
415 SSL_SESSION_free(ss);
418 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
419 ss->sid_ctx_length = s->sid_ctx_length;
421 ss->ssl_version = s->version;
422 ss->verify_result = X509_V_OK;
424 /* If client supports extended master secret set it in session */
425 if (s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS)
426 ss->flags |= SSL_SESS_FLAG_EXTMS;
431 SSL_SESSION *lookup_sess_in_cache(SSL *s, const unsigned char *sess_id,
434 SSL_SESSION *ret = NULL;
436 if ((s->session_ctx->session_cache_mode
437 & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP) == 0) {
440 data.ssl_version = s->version;
441 if (!ossl_assert(sess_id_len <= SSL_MAX_SSL_SESSION_ID_LENGTH))
444 memcpy(data.session_id, sess_id, sess_id_len);
445 data.session_id_length = sess_id_len;
447 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
448 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
450 /* don't allow other threads to steal it: */
451 SSL_SESSION_up_ref(ret);
453 CRYPTO_THREAD_unlock(s->session_ctx->lock);
455 tsan_counter(&s->session_ctx->stats.sess_miss);
458 if (ret == NULL && s->session_ctx->get_session_cb != NULL) {
461 ret = s->session_ctx->get_session_cb(s, sess_id, sess_id_len, ©);
464 tsan_counter(&s->session_ctx->stats.sess_cb_hit);
467 * Increment reference count now if the session callback asks us
468 * to do so (note that if the session structures returned by the
469 * callback are shared between threads, it must handle the
470 * reference count itself [i.e. copy == 0], or things won't be
474 SSL_SESSION_up_ref(ret);
477 * Add the externally cached session to the internal cache as
478 * well if and only if we are supposed to.
480 if ((s->session_ctx->session_cache_mode &
481 SSL_SESS_CACHE_NO_INTERNAL_STORE) == 0) {
483 * Either return value of SSL_CTX_add_session should not
484 * interrupt the session resumption process. The return
485 * value is intentionally ignored.
487 (void)SSL_CTX_add_session(s->session_ctx, ret);
496 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
497 * connection. It is only called by servers.
499 * hello: The parsed ClientHello data
503 * 0: no session found
504 * 1: a session may have been found.
507 * - If a session is found then s->session is pointed at it (after freeing an
508 * existing session if need be) and s->verify_result is set from the session.
509 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
510 * if the server should issue a new session ticket (to 0 otherwise).
512 int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello)
514 /* This is used only by servers. */
516 SSL_SESSION *ret = NULL;
518 int try_session_cache = 0;
521 if (SSL_IS_TLS13(s)) {
523 * By default we will send a new ticket. This can be overridden in the
526 s->ext.ticket_expected = 1;
527 if (!tls_parse_extension(s, TLSEXT_IDX_psk_kex_modes,
528 SSL_EXT_CLIENT_HELLO, hello->pre_proc_exts,
530 || !tls_parse_extension(s, TLSEXT_IDX_psk, SSL_EXT_CLIENT_HELLO,
531 hello->pre_proc_exts, NULL, 0))
536 /* sets s->ext.ticket_expected */
537 r = tls_get_ticket_from_client(s, hello, &ret);
539 case SSL_TICKET_FATAL_ERR_MALLOC:
540 case SSL_TICKET_FATAL_ERR_OTHER:
542 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_PREV_SESSION,
543 ERR_R_INTERNAL_ERROR);
545 case SSL_TICKET_NONE:
546 case SSL_TICKET_EMPTY:
547 if (hello->session_id_len > 0) {
548 try_session_cache = 1;
549 ret = lookup_sess_in_cache(s, hello->session_id,
550 hello->session_id_len);
553 case SSL_TICKET_NO_DECRYPT:
554 case SSL_TICKET_SUCCESS:
555 case SSL_TICKET_SUCCESS_RENEW:
563 /* Now ret is non-NULL and we own one of its reference counts. */
565 /* Check TLS version consistency */
566 if (ret->ssl_version != s->version)
569 if (ret->sid_ctx_length != s->sid_ctx_length
570 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
572 * We have the session requested by the client, but we don't want to
573 * use it in this context.
575 goto err; /* treat like cache miss */
578 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
580 * We can't be sure if this session is being used out of context,
581 * which is especially important for SSL_VERIFY_PEER. The application
582 * should have used SSL[_CTX]_set_session_id_context. For this error
583 * case, we generate an error instead of treating the event like a
584 * cache miss (otherwise it would be easy for applications to
585 * effectively disable the session cache by accident without anyone
589 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_GET_PREV_SESSION,
590 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
595 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
596 tsan_counter(&s->session_ctx->stats.sess_timeout);
597 if (try_session_cache) {
598 /* session was from the cache, so remove it */
599 SSL_CTX_remove_session(s->session_ctx, ret);
604 /* Check extended master secret extension consistency */
605 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
606 /* If old session includes extms, but new does not: abort handshake */
607 if (!(s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
608 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL_GET_PREV_SESSION,
609 SSL_R_INCONSISTENT_EXTMS);
613 } else if (s->s3.flags & TLS1_FLAGS_RECEIVED_EXTMS) {
614 /* If new session includes extms, but old does not: do not resume */
618 if (!SSL_IS_TLS13(s)) {
619 /* We already did this for TLS1.3 */
620 SSL_SESSION_free(s->session);
624 tsan_counter(&s->session_ctx->stats.sess_hit);
625 s->verify_result = s->session->verify_result;
630 SSL_SESSION_free(ret);
631 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
635 if (!try_session_cache) {
637 * The session was from a ticket, so we should issue a ticket for
640 s->ext.ticket_expected = 1;
649 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
655 * add just 1 reference count for the SSL_CTX's session cache even though
656 * it has two ways of access: each session is in a doubly linked list and
659 SSL_SESSION_up_ref(c);
661 * if session c is in already in cache, we take back the increment later
664 CRYPTO_THREAD_write_lock(ctx->lock);
665 s = lh_SSL_SESSION_insert(ctx->sessions, c);
668 * s != NULL iff we already had a session with the given PID. In this
669 * case, s == c should hold (then we did not really modify
670 * ctx->sessions), or we're in trouble.
672 if (s != NULL && s != c) {
673 /* We *are* in trouble ... */
674 SSL_SESSION_list_remove(ctx, s);
677 * ... so pretend the other session did not exist in cache (we cannot
678 * handle two SSL_SESSION structures with identical session ID in the
679 * same cache, which could happen e.g. when two threads concurrently
680 * obtain the same session from an external cache)
683 } else if (s == NULL &&
684 lh_SSL_SESSION_retrieve(ctx->sessions, c) == NULL) {
685 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
688 * ... so take back the extra reference and also don't add
689 * the session to the SSL_SESSION_list at this time
694 /* Put at the head of the queue unless it is already in the cache */
696 SSL_SESSION_list_add(ctx, c);
700 * existing cache entry -- decrement previously incremented reference
701 * count because it already takes into account the cache
704 SSL_SESSION_free(s); /* s == c */
708 * new cache entry -- remove old ones if cache has become too large
713 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
714 while (SSL_CTX_sess_number(ctx) > SSL_CTX_sess_get_cache_size(ctx)) {
715 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
718 tsan_counter(&ctx->stats.sess_cache_full);
722 CRYPTO_THREAD_unlock(ctx->lock);
726 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
728 return remove_session_lock(ctx, c, 1);
731 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
736 if ((c != NULL) && (c->session_id_length != 0)) {
738 CRYPTO_THREAD_write_lock(ctx->lock);
739 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) != NULL) {
741 r = lh_SSL_SESSION_delete(ctx->sessions, r);
742 SSL_SESSION_list_remove(ctx, r);
744 c->not_resumable = 1;
747 CRYPTO_THREAD_unlock(ctx->lock);
749 if (ctx->remove_session_cb != NULL)
750 ctx->remove_session_cb(ctx, c);
759 void SSL_SESSION_free(SSL_SESSION *ss)
765 CRYPTO_DOWN_REF(&ss->references, &i, ss->lock);
766 REF_PRINT_COUNT("SSL_SESSION", ss);
769 REF_ASSERT_ISNT(i < 0);
771 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
773 OPENSSL_cleanse(ss->master_key, sizeof(ss->master_key));
774 OPENSSL_cleanse(ss->session_id, sizeof(ss->session_id));
776 sk_X509_pop_free(ss->peer_chain, X509_free);
777 OPENSSL_free(ss->ext.hostname);
778 OPENSSL_free(ss->ext.tick);
779 #ifndef OPENSSL_NO_EC
780 OPENSSL_free(ss->ext.ecpointformats);
781 ss->ext.ecpointformats = NULL;
782 ss->ext.ecpointformats_len = 0;
783 #endif /* OPENSSL_NO_EC */
784 #ifndef OPENSSL_NO_PSK
785 OPENSSL_free(ss->psk_identity_hint);
786 OPENSSL_free(ss->psk_identity);
788 #ifndef OPENSSL_NO_SRP
789 OPENSSL_free(ss->srp_username);
791 OPENSSL_free(ss->ext.alpn_selected);
792 OPENSSL_free(ss->ticket_appdata);
793 CRYPTO_THREAD_lock_free(ss->lock);
794 OPENSSL_clear_free(ss, sizeof(*ss));
797 int SSL_SESSION_up_ref(SSL_SESSION *ss)
801 if (CRYPTO_UP_REF(&ss->references, &i, ss->lock) <= 0)
804 REF_PRINT_COUNT("SSL_SESSION", ss);
805 REF_ASSERT_ISNT(i < 2);
806 return ((i > 1) ? 1 : 0);
809 int SSL_set_session(SSL *s, SSL_SESSION *session)
811 ssl_clear_bad_session(s);
812 if (s->ctx->method != s->method) {
813 if (!SSL_set_ssl_method(s, s->ctx->method))
817 if (session != NULL) {
818 SSL_SESSION_up_ref(session);
819 s->verify_result = session->verify_result;
821 SSL_SESSION_free(s->session);
822 s->session = session;
827 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
828 unsigned int sid_len)
830 if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
831 SSLerr(SSL_F_SSL_SESSION_SET1_ID,
832 SSL_R_SSL_SESSION_ID_TOO_LONG);
835 s->session_id_length = sid_len;
836 if (sid != s->session_id)
837 memcpy(s->session_id, sid, sid_len);
841 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
849 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
856 long SSL_SESSION_get_time(const SSL_SESSION *s)
863 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
871 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
873 return s->ssl_version;
876 int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version)
878 s->ssl_version = version;
882 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
887 int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher)
893 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
895 return s->ext.hostname;
898 int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname)
900 OPENSSL_free(s->ext.hostname);
901 if (hostname == NULL) {
902 s->ext.hostname = NULL;
905 s->ext.hostname = OPENSSL_strdup(hostname);
907 return s->ext.hostname != NULL;
910 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
912 return (s->ext.ticklen > 0) ? 1 : 0;
915 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
917 return s->ext.tick_lifetime_hint;
920 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
923 *len = s->ext.ticklen;
928 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s)
930 return s->ext.max_early_data;
933 int SSL_SESSION_set_max_early_data(SSL_SESSION *s, uint32_t max_early_data)
935 s->ext.max_early_data = max_early_data;
940 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
941 const unsigned char **alpn,
944 *alpn = s->ext.alpn_selected;
945 *len = s->ext.alpn_selected_len;
948 int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s, const unsigned char *alpn,
951 OPENSSL_free(s->ext.alpn_selected);
952 if (alpn == NULL || len == 0) {
953 s->ext.alpn_selected = NULL;
954 s->ext.alpn_selected_len = 0;
957 s->ext.alpn_selected = OPENSSL_memdup(alpn, len);
958 if (s->ext.alpn_selected == NULL) {
959 s->ext.alpn_selected_len = 0;
962 s->ext.alpn_selected_len = len;
967 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
972 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
973 unsigned int sid_ctx_len)
975 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
976 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
977 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
980 s->sid_ctx_length = sid_ctx_len;
981 if (sid_ctx != s->sid_ctx)
982 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
987 int SSL_SESSION_is_resumable(const SSL_SESSION *s)
990 * In the case of EAP-FAST, we can have a pre-shared "ticket" without a
993 return !s->not_resumable
994 && (s->session_id_length > 0 || s->ext.ticklen > 0);
997 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
1002 l = s->session_timeout;
1003 s->session_timeout = t;
1007 long SSL_CTX_get_timeout(const SSL_CTX *s)
1011 return s->session_timeout;
1014 int SSL_set_session_secret_cb(SSL *s,
1015 tls_session_secret_cb_fn tls_session_secret_cb,
1020 s->ext.session_secret_cb = tls_session_secret_cb;
1021 s->ext.session_secret_cb_arg = arg;
1025 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
1030 s->ext.session_ticket_cb = cb;
1031 s->ext.session_ticket_cb_arg = arg;
1035 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1037 if (s->version >= TLS1_VERSION) {
1038 OPENSSL_free(s->ext.session_ticket);
1039 s->ext.session_ticket = NULL;
1040 s->ext.session_ticket =
1041 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1042 if (s->ext.session_ticket == NULL) {
1043 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
1047 if (ext_data != NULL) {
1048 s->ext.session_ticket->length = ext_len;
1049 s->ext.session_ticket->data = s->ext.session_ticket + 1;
1050 memcpy(s->ext.session_ticket->data, ext_data, ext_len);
1052 s->ext.session_ticket->length = 0;
1053 s->ext.session_ticket->data = NULL;
1062 typedef struct timeout_param_st {
1065 LHASH_OF(SSL_SESSION) *cache;
1068 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
1070 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1072 * The reason we don't call SSL_CTX_remove_session() is to save on
1075 (void)lh_SSL_SESSION_delete(p->cache, s);
1076 SSL_SESSION_list_remove(p->ctx, s);
1077 s->not_resumable = 1;
1078 if (p->ctx->remove_session_cb != NULL)
1079 p->ctx->remove_session_cb(p->ctx, s);
1080 SSL_SESSION_free(s);
1084 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
1086 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1092 tp.cache = s->sessions;
1093 if (tp.cache == NULL)
1096 CRYPTO_THREAD_write_lock(s->lock);
1097 i = lh_SSL_SESSION_get_down_load(s->sessions);
1098 lh_SSL_SESSION_set_down_load(s->sessions, 0);
1099 lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1100 lh_SSL_SESSION_set_down_load(s->sessions, i);
1101 CRYPTO_THREAD_unlock(s->lock);
1104 int ssl_clear_bad_session(SSL *s)
1106 if ((s->session != NULL) &&
1107 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1108 !(SSL_in_init(s) || SSL_in_before(s))) {
1109 SSL_CTX_remove_session(s->session_ctx, s->session);
1115 /* locked by SSL_CTX in the calling function */
1116 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1118 if ((s->next == NULL) || (s->prev == NULL))
1121 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1122 /* last element in list */
1123 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1124 /* only one element in list */
1125 ctx->session_cache_head = NULL;
1126 ctx->session_cache_tail = NULL;
1128 ctx->session_cache_tail = s->prev;
1129 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1132 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1133 /* first element in list */
1134 ctx->session_cache_head = s->next;
1135 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1137 /* middle of list */
1138 s->next->prev = s->prev;
1139 s->prev->next = s->next;
1142 s->prev = s->next = NULL;
1145 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1147 if ((s->next != NULL) && (s->prev != NULL))
1148 SSL_SESSION_list_remove(ctx, s);
1150 if (ctx->session_cache_head == NULL) {
1151 ctx->session_cache_head = s;
1152 ctx->session_cache_tail = s;
1153 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1154 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1156 s->next = ctx->session_cache_head;
1158 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1159 ctx->session_cache_head = s;
1163 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1164 int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1166 ctx->new_session_cb = cb;
1169 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1170 return ctx->new_session_cb;
1173 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1174 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1176 ctx->remove_session_cb = cb;
1179 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1180 SSL_SESSION *sess) {
1181 return ctx->remove_session_cb;
1184 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1185 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1186 const unsigned char *data,
1187 int len, int *copy))
1189 ctx->get_session_cb = cb;
1192 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1196 return ctx->get_session_cb;
1199 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1200 void (*cb) (const SSL *ssl, int type, int val))
1202 ctx->info_callback = cb;
1205 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1207 return ctx->info_callback;
1210 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1211 int (*cb) (SSL *ssl, X509 **x509,
1214 ctx->client_cert_cb = cb;
1217 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1219 return ctx->client_cert_cb;
1222 #ifndef OPENSSL_NO_ENGINE
1223 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1225 if (!ENGINE_init(e)) {
1226 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1229 if (!ENGINE_get_ssl_client_cert_function(e)) {
1230 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1231 SSL_R_NO_CLIENT_CERT_METHOD);
1235 ctx->client_cert_engine = e;
1240 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1241 int (*cb) (SSL *ssl,
1242 unsigned char *cookie,
1243 unsigned int *cookie_len))
1245 ctx->app_gen_cookie_cb = cb;
1248 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1249 int (*cb) (SSL *ssl,
1250 const unsigned char *cookie,
1251 unsigned int cookie_len))
1253 ctx->app_verify_cookie_cb = cb;
1256 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len)
1258 OPENSSL_free(ss->ticket_appdata);
1259 ss->ticket_appdata_len = 0;
1260 if (data == NULL || len == 0) {
1261 ss->ticket_appdata = NULL;
1264 ss->ticket_appdata = OPENSSL_memdup(data, len);
1265 if (ss->ticket_appdata != NULL) {
1266 ss->ticket_appdata_len = len;
1272 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len)
1274 *data = ss->ticket_appdata;
1275 *len = ss->ticket_appdata_len;
1279 void SSL_CTX_set_stateless_cookie_generate_cb(
1281 int (*cb) (SSL *ssl,
1282 unsigned char *cookie,
1283 size_t *cookie_len))
1285 ctx->gen_stateless_cookie_cb = cb;
1288 void SSL_CTX_set_stateless_cookie_verify_cb(
1290 int (*cb) (SSL *ssl,
1291 const unsigned char *cookie,
1294 ctx->verify_stateless_cookie_cb = cb;
1297 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)