2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2005 Nokia. All rights reserved.
13 * The portions of the attached software ("Contribution") is developed by
14 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
17 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
18 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
19 * support (see RFC 4279) to OpenSSL.
21 * No patent licenses or other rights except those expressly stated in
22 * the OpenSSL open source license shall be deemed granted or received
23 * expressly, by implication, estoppel, or otherwise.
25 * No assurances are provided by Nokia that the Contribution does not
26 * infringe the patent or other intellectual property rights of any third
27 * party or that the license provides you with all the necessary rights
28 * to make use of the Contribution.
30 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
31 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
32 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
33 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
38 #include <openssl/lhash.h>
39 #include <openssl/rand.h>
40 #include <openssl/engine.h>
42 #include "statem/statem_locl.h"
44 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
45 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
46 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
49 * TODO(TLS1.3): SSL_get_session() and SSL_get1_session() are problematic in
50 * TLS1.3 because, unlike in earlier protocol versions, the session ticket
51 * may not have been sent yet even though a handshake has finished. The session
52 * ticket data could come in sometime later...or even change if multiple session
53 * ticket messages are sent from the server. We need to work out how to deal
57 SSL_SESSION *SSL_get_session(const SSL *ssl)
58 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
60 return (ssl->session);
63 SSL_SESSION *SSL_get1_session(SSL *ssl)
64 /* variant of SSL_get_session: caller really gets something */
68 * Need to lock this all up rather than just use CRYPTO_add so that
69 * somebody doesn't free ssl->session between when we check it's non-null
70 * and when we up the reference count.
72 CRYPTO_THREAD_read_lock(ssl->lock);
75 SSL_SESSION_up_ref(sess);
76 CRYPTO_THREAD_unlock(ssl->lock);
80 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
82 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
85 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
87 return (CRYPTO_get_ex_data(&s->ex_data, idx));
90 SSL_SESSION *SSL_SESSION_new(void)
94 if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL))
97 ss = OPENSSL_zalloc(sizeof(*ss));
99 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
103 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
105 ss->timeout = 60 * 5 + 4; /* 5 minute timeout by default */
106 ss->time = (unsigned long)time(NULL);
107 ss->lock = CRYPTO_THREAD_lock_new();
108 if (ss->lock == NULL) {
109 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
114 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data)) {
115 CRYPTO_THREAD_lock_free(ss->lock);
123 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
124 * ticket == 0 then no ticket information is duplicated, otherwise it is.
126 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
130 dest = OPENSSL_malloc(sizeof(*src));
134 memcpy(dest, src, sizeof(*dest));
137 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
138 * the case of an error whilst halfway through constructing dest
140 #ifndef OPENSSL_NO_PSK
141 dest->psk_identity_hint = NULL;
142 dest->psk_identity = NULL;
144 dest->ciphers = NULL;
145 dest->ext.hostname = NULL;
146 #ifndef OPENSSL_NO_EC
147 dest->ext.ecpointformats = NULL;
148 dest->ext.supportedgroups = NULL;
150 dest->ext.tick = NULL;
151 #ifndef OPENSSL_NO_SRP
152 dest->srp_username = NULL;
154 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
156 /* We deliberately don't copy the prev and next pointers */
160 dest->references = 1;
162 dest->lock = CRYPTO_THREAD_lock_new();
163 if (dest->lock == NULL)
166 if (src->peer != NULL)
167 X509_up_ref(src->peer);
169 if (src->peer_chain != NULL) {
170 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
171 if (dest->peer_chain == NULL)
174 #ifndef OPENSSL_NO_PSK
175 if (src->psk_identity_hint) {
176 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
177 if (dest->psk_identity_hint == NULL) {
181 if (src->psk_identity) {
182 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
183 if (dest->psk_identity == NULL) {
189 if (src->ciphers != NULL) {
190 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
191 if (dest->ciphers == NULL)
195 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
196 &dest->ex_data, &src->ex_data)) {
200 if (src->ext.hostname) {
201 dest->ext.hostname = OPENSSL_strdup(src->ext.hostname);
202 if (dest->ext.hostname == NULL) {
206 #ifndef OPENSSL_NO_EC
207 if (src->ext.ecpointformats) {
208 dest->ext.ecpointformats =
209 OPENSSL_memdup(src->ext.ecpointformats,
210 src->ext.ecpointformats_len);
211 if (dest->ext.ecpointformats == NULL)
214 if (src->ext.supportedgroups) {
215 dest->ext.supportedgroups =
216 OPENSSL_memdup(src->ext.supportedgroups,
217 src->ext.supportedgroups_len);
218 if (dest->ext.supportedgroups == NULL)
225 OPENSSL_memdup(src->ext.tick, src->ext.ticklen);
226 if (dest->ext.tick == NULL)
229 dest->ext.tick_lifetime_hint = 0;
230 dest->ext.ticklen = 0;
233 #ifndef OPENSSL_NO_SRP
234 if (src->srp_username) {
235 dest->srp_username = OPENSSL_strdup(src->srp_username);
236 if (dest->srp_username == NULL) {
244 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
245 SSL_SESSION_free(dest);
249 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
252 *len = (unsigned int)s->session_id_length;
253 return s->session_id;
255 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
259 *len = (unsigned int)s->sid_ctx_length;
263 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
265 return s->compress_meth;
269 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
270 * the ID with random junk repeatedly until we have no conflict is going to
271 * complete in one iteration pretty much "most" of the time (btw:
272 * understatement). So, if it takes us 10 iterations and we still can't avoid
273 * a conflict - well that's a reasonable point to call it quits. Either the
274 * RAND code is broken or someone is trying to open roughly very close to
275 * 2^256 SSL sessions to our server. How you might store that many sessions
276 * is perhaps a more interesting question ...
279 #define MAX_SESS_ID_ATTEMPTS 10
280 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
281 unsigned int *id_len)
283 unsigned int retry = 0;
285 if (RAND_bytes(id, *id_len) <= 0)
287 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
288 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
289 if (retry < MAX_SESS_ID_ATTEMPTS)
291 /* else - woops a session_id match */
293 * XXX We should also check the external cache -- but the probability of
294 * a collision is negligible, and we could not prevent the concurrent
295 * creation of sessions with identical IDs since we currently don't have
296 * means to atomically check whether a session ID already exists and make
297 * a reservation for it if it does not (this problem applies to the
298 * internal cache as well).
303 int ssl_get_new_session(SSL *s, int session)
305 /* This gets used by clients and servers. */
308 SSL_SESSION *ss = NULL;
309 GEN_SESSION_CB cb = def_generate_session_id;
311 if ((ss = SSL_SESSION_new()) == NULL)
314 /* If the context has a default timeout, use it */
315 if (s->session_ctx->session_timeout == 0)
316 ss->timeout = SSL_get_default_timeout(s);
318 ss->timeout = s->session_ctx->session_timeout;
320 SSL_SESSION_free(s->session);
324 if (s->version == SSL3_VERSION) {
325 ss->ssl_version = SSL3_VERSION;
326 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
327 } else if (s->version == TLS1_VERSION) {
328 ss->ssl_version = TLS1_VERSION;
329 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
330 } else if (s->version == TLS1_1_VERSION) {
331 ss->ssl_version = TLS1_1_VERSION;
332 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
333 } else if (s->version == TLS1_2_VERSION) {
334 ss->ssl_version = TLS1_2_VERSION;
335 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
336 } else if (s->version == TLS1_3_VERSION) {
337 ss->ssl_version = TLS1_3_VERSION;
338 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
339 } else if (s->version == DTLS1_BAD_VER) {
340 ss->ssl_version = DTLS1_BAD_VER;
341 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
342 } else if (s->version == DTLS1_VERSION) {
343 ss->ssl_version = DTLS1_VERSION;
344 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
345 } else if (s->version == DTLS1_2_VERSION) {
346 ss->ssl_version = DTLS1_2_VERSION;
347 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
349 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
350 SSL_SESSION_free(ss);
355 * If RFC5077 ticket, use empty session ID (as server).
357 * (a) ssl_get_prev_session() does lookahead into the
358 * ClientHello extensions to find the session ticket.
359 * When ssl_get_prev_session() fails, statem_srvr.c calls
360 * ssl_get_new_session() in tls_process_client_hello().
361 * At that point, it has not yet parsed the extensions,
362 * however, because of the lookahead, it already knows
363 * whether a ticket is expected or not.
365 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
366 * ServerHello extensions, and before recording the session
367 * ID received from the server, so this block is a noop.
369 if (s->ext.ticket_expected) {
370 ss->session_id_length = 0;
374 /* Choose which callback will set the session ID */
375 CRYPTO_THREAD_read_lock(s->lock);
376 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
377 if (s->generate_session_id)
378 cb = s->generate_session_id;
379 else if (s->session_ctx->generate_session_id)
380 cb = s->session_ctx->generate_session_id;
381 CRYPTO_THREAD_unlock(s->session_ctx->lock);
382 CRYPTO_THREAD_unlock(s->lock);
383 /* Choose a session ID */
384 memset(ss->session_id, 0, ss->session_id_length);
385 tmp = (int)ss->session_id_length;
386 if (!cb(s, ss->session_id, &tmp)) {
387 /* The callback failed */
388 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
389 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
390 SSL_SESSION_free(ss);
394 * Don't allow the callback to set the session length to zero. nor
395 * set it higher than it was.
397 if (tmp == 0 || tmp > ss->session_id_length) {
398 /* The callback set an illegal length */
399 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
400 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
401 SSL_SESSION_free(ss);
404 ss->session_id_length = tmp;
405 /* Finally, check for a conflict */
406 if (SSL_has_matching_session_id(s, ss->session_id,
407 (unsigned int)ss->session_id_length)) {
408 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
409 SSL_SESSION_free(ss);
414 if (s->ext.hostname) {
415 ss->ext.hostname = OPENSSL_strdup(s->ext.hostname);
416 if (ss->ext.hostname == NULL) {
417 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
418 SSL_SESSION_free(ss);
423 ss->session_id_length = 0;
426 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
427 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
428 SSL_SESSION_free(ss);
431 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
432 ss->sid_ctx_length = s->sid_ctx_length;
434 ss->ssl_version = s->version;
435 ss->verify_result = X509_V_OK;
437 /* If client supports extended master secret set it in session */
438 if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)
439 ss->flags |= SSL_SESS_FLAG_EXTMS;
445 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
446 * connection. It is only called by servers.
448 * hello: The parsed ClientHello data
452 * 0: no session found
453 * 1: a session may have been found.
456 * - If a session is found then s->session is pointed at it (after freeing an
457 * existing session if need be) and s->verify_result is set from the session.
458 * - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
459 * if the server should issue a new session ticket (to 0 otherwise).
461 int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al)
463 /* This is used only by servers. */
465 SSL_SESSION *ret = NULL;
467 int try_session_cache = 0;
470 if (SSL_IS_TLS13(s)) {
471 if (!tls_parse_extension(s, TLSEXT_IDX_psk_kex_modes, EXT_CLIENT_HELLO,
472 hello->pre_proc_exts, NULL, 0, al)
473 || !tls_parse_extension(s, TLSEXT_IDX_psk, EXT_CLIENT_HELLO,
474 hello->pre_proc_exts, NULL, 0, al))
479 /* sets s->ext.ticket_expected */
480 r = tls_get_ticket_from_client(s, hello, &ret);
482 case TICKET_FATAL_ERR_MALLOC:
483 case TICKET_FATAL_ERR_OTHER:
488 try_session_cache = 1;
490 case TICKET_NO_DECRYPT:
492 case TICKET_SUCCESS_RENEW:
497 if (try_session_cache &&
499 !(s->session_ctx->session_cache_mode &
500 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
503 data.ssl_version = s->version;
504 memcpy(data.session_id, hello->session_id, hello->session_id_len);
505 data.session_id_length = hello->session_id_len;
507 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
508 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
510 /* don't allow other threads to steal it: */
511 SSL_SESSION_up_ref(ret);
513 CRYPTO_THREAD_unlock(s->session_ctx->lock);
515 s->session_ctx->stats.sess_miss++;
518 if (try_session_cache &&
519 ret == NULL && s->session_ctx->get_session_cb != NULL) {
522 ret = s->session_ctx->get_session_cb(s, hello->session_id,
523 hello->session_id_len,
527 s->session_ctx->stats.sess_cb_hit++;
530 * Increment reference count now if the session callback asks us
531 * to do so (note that if the session structures returned by the
532 * callback are shared between threads, it must handle the
533 * reference count itself [i.e. copy == 0], or things won't be
537 SSL_SESSION_up_ref(ret);
540 * Add the externally cached session to the internal cache as
541 * well if and only if we are supposed to.
544 (s->session_ctx->session_cache_mode &
545 SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
547 * The following should not return 1, otherwise, things are
550 if (SSL_CTX_add_session(s->session_ctx, ret))
559 /* Now ret is non-NULL and we own one of its reference counts. */
561 /* Check TLS version consistency */
562 if (ret->ssl_version != s->version)
565 if (ret->sid_ctx_length != s->sid_ctx_length
566 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
568 * We have the session requested by the client, but we don't want to
569 * use it in this context.
571 goto err; /* treat like cache miss */
574 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
576 * We can't be sure if this session is being used out of context,
577 * which is especially important for SSL_VERIFY_PEER. The application
578 * should have used SSL[_CTX]_set_session_id_context. For this error
579 * case, we generate an error instead of treating the event like a
580 * cache miss (otherwise it would be easy for applications to
581 * effectively disable the session cache by accident without anyone
585 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
586 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
591 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
592 s->session_ctx->stats.sess_timeout++;
593 if (try_session_cache) {
594 /* session was from the cache, so remove it */
595 SSL_CTX_remove_session(s->session_ctx, ret);
600 /* Check extended master secret extension consistency */
601 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
602 /* If old session includes extms, but new does not: abort handshake */
603 if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
604 SSLerr(SSL_F_SSL_GET_PREV_SESSION, SSL_R_INCONSISTENT_EXTMS);
605 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
609 } else if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) {
610 /* If new session includes extms, but old does not: do not resume */
614 if (!SSL_IS_TLS13(s)) {
615 /* We already did this for TLS1.3 */
616 SSL_SESSION_free(s->session);
620 s->session_ctx->stats.sess_hit++;
621 s->verify_result = s->session->verify_result;
626 SSL_SESSION_free(ret);
627 /* In TLSv1.3 s->session was already set to ret, so we NULL it out */
631 if (!try_session_cache) {
633 * The session was from a ticket, so we should issue a ticket for
636 s->ext.ticket_expected = 1;
640 *al = SSL_AD_INTERNAL_ERROR;
647 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
653 * add just 1 reference count for the SSL_CTX's session cache even though
654 * it has two ways of access: each session is in a doubly linked list and
657 SSL_SESSION_up_ref(c);
659 * if session c is in already in cache, we take back the increment later
662 CRYPTO_THREAD_write_lock(ctx->lock);
663 s = lh_SSL_SESSION_insert(ctx->sessions, c);
666 * s != NULL iff we already had a session with the given PID. In this
667 * case, s == c should hold (then we did not really modify
668 * ctx->sessions), or we're in trouble.
670 if (s != NULL && s != c) {
671 /* We *are* in trouble ... */
672 SSL_SESSION_list_remove(ctx, s);
675 * ... so pretend the other session did not exist in cache (we cannot
676 * handle two SSL_SESSION structures with identical session ID in the
677 * same cache, which could happen e.g. when two threads concurrently
678 * obtain the same session from an external cache)
681 } else if (s == NULL &&
682 lh_SSL_SESSION_retrieve(ctx->sessions, c) == NULL) {
683 /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
686 * ... so take back the extra reference and also don't add
687 * the session to the SSL_SESSION_list at this time
692 /* Put at the head of the queue unless it is already in the cache */
694 SSL_SESSION_list_add(ctx, c);
698 * existing cache entry -- decrement previously incremented reference
699 * count because it already takes into account the cache
702 SSL_SESSION_free(s); /* s == c */
706 * new cache entry -- remove old ones if cache has become too large
711 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
712 while (SSL_CTX_sess_number(ctx) > SSL_CTX_sess_get_cache_size(ctx)) {
713 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
716 ctx->stats.sess_cache_full++;
720 CRYPTO_THREAD_unlock(ctx->lock);
724 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
726 return remove_session_lock(ctx, c, 1);
729 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
734 if ((c != NULL) && (c->session_id_length != 0)) {
736 CRYPTO_THREAD_write_lock(ctx->lock);
737 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
739 r = lh_SSL_SESSION_delete(ctx->sessions, c);
740 SSL_SESSION_list_remove(ctx, c);
742 c->not_resumable = 1;
745 CRYPTO_THREAD_unlock(ctx->lock);
750 if (ctx->remove_session_cb != NULL)
751 ctx->remove_session_cb(ctx, c);
757 void SSL_SESSION_free(SSL_SESSION *ss)
764 CRYPTO_DOWN_REF(&ss->references, &i, ss->lock);
765 REF_PRINT_COUNT("SSL_SESSION", ss);
768 REF_ASSERT_ISNT(i < 0);
770 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
772 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
773 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
775 sk_X509_pop_free(ss->peer_chain, X509_free);
776 sk_SSL_CIPHER_free(ss->ciphers);
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 OPENSSL_free(ss->ext.supportedgroups);
784 ss->ext.supportedgroups = NULL;
785 ss->ext.supportedgroups_len = 0;
786 #endif /* OPENSSL_NO_EC */
787 #ifndef OPENSSL_NO_PSK
788 OPENSSL_free(ss->psk_identity_hint);
789 OPENSSL_free(ss->psk_identity);
791 #ifndef OPENSSL_NO_SRP
792 OPENSSL_free(ss->srp_username);
794 OPENSSL_free(ss->ext.alpn_selected);
795 CRYPTO_THREAD_lock_free(ss->lock);
796 OPENSSL_clear_free(ss, sizeof(*ss));
799 int SSL_SESSION_up_ref(SSL_SESSION *ss)
803 if (CRYPTO_UP_REF(&ss->references, &i, ss->lock) <= 0)
806 REF_PRINT_COUNT("SSL_SESSION", ss);
807 REF_ASSERT_ISNT(i < 2);
808 return ((i > 1) ? 1 : 0);
811 int SSL_set_session(SSL *s, SSL_SESSION *session)
813 ssl_clear_bad_session(s);
814 if (s->ctx->method != s->method) {
815 if (!SSL_set_ssl_method(s, s->ctx->method))
819 if (session != NULL) {
820 SSL_SESSION_up_ref(session);
821 s->verify_result = session->verify_result;
823 SSL_SESSION_free(s->session);
824 s->session = session;
829 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
830 unsigned int sid_len)
832 if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
833 SSLerr(SSL_F_SSL_SESSION_SET1_ID,
834 SSL_R_SSL_SESSION_ID_TOO_LONG);
837 s->session_id_length = sid_len;
838 memcpy(s->session_id, sid, sid_len);
842 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
850 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
857 long SSL_SESSION_get_time(const SSL_SESSION *s)
864 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
872 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
874 return s->ssl_version;
877 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
882 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
884 return s->ext.hostname;
887 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
889 return (s->ext.ticklen > 0) ? 1 : 0;
892 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
894 return s->ext.tick_lifetime_hint;
897 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
900 *len = s->ext.ticklen;
905 uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s)
907 return s->ext.max_early_data;
910 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
915 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
916 unsigned int sid_ctx_len)
918 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
919 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
920 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
923 s->sid_ctx_length = sid_ctx_len;
924 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
929 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
934 l = s->session_timeout;
935 s->session_timeout = t;
939 long SSL_CTX_get_timeout(const SSL_CTX *s)
943 return (s->session_timeout);
946 int SSL_set_session_secret_cb(SSL *s,
947 tls_session_secret_cb_fn tls_session_secret_cb,
952 s->ext.session_secret_cb = tls_session_secret_cb;
953 s->ext.session_secret_cb_arg = arg;
957 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
962 s->ext.session_ticket_cb = cb;
963 s->ext.session_ticket_cb_arg = arg;
967 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
969 if (s->version >= TLS1_VERSION) {
970 OPENSSL_free(s->ext.session_ticket);
971 s->ext.session_ticket = NULL;
972 s->ext.session_ticket =
973 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
974 if (s->ext.session_ticket == NULL) {
975 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
979 if (ext_data != NULL) {
980 s->ext.session_ticket->length = ext_len;
981 s->ext.session_ticket->data = s->ext.session_ticket + 1;
982 memcpy(s->ext.session_ticket->data, ext_data, ext_len);
984 s->ext.session_ticket->length = 0;
985 s->ext.session_ticket->data = NULL;
994 typedef struct timeout_param_st {
997 LHASH_OF(SSL_SESSION) *cache;
1000 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
1002 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1004 * The reason we don't call SSL_CTX_remove_session() is to save on
1007 (void)lh_SSL_SESSION_delete(p->cache, s);
1008 SSL_SESSION_list_remove(p->ctx, s);
1009 s->not_resumable = 1;
1010 if (p->ctx->remove_session_cb != NULL)
1011 p->ctx->remove_session_cb(p->ctx, s);
1012 SSL_SESSION_free(s);
1016 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
1018 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1024 tp.cache = s->sessions;
1025 if (tp.cache == NULL)
1028 CRYPTO_THREAD_write_lock(s->lock);
1029 i = lh_SSL_SESSION_get_down_load(s->sessions);
1030 lh_SSL_SESSION_set_down_load(s->sessions, 0);
1031 lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1032 lh_SSL_SESSION_set_down_load(s->sessions, i);
1033 CRYPTO_THREAD_unlock(s->lock);
1036 int ssl_clear_bad_session(SSL *s)
1038 if ((s->session != NULL) &&
1039 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1040 !(SSL_in_init(s) || SSL_in_before(s))) {
1041 SSL_CTX_remove_session(s->session_ctx, s->session);
1047 /* locked by SSL_CTX in the calling function */
1048 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1050 if ((s->next == NULL) || (s->prev == NULL))
1053 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1054 /* last element in list */
1055 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1056 /* only one element in list */
1057 ctx->session_cache_head = NULL;
1058 ctx->session_cache_tail = NULL;
1060 ctx->session_cache_tail = s->prev;
1061 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1064 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1065 /* first element in list */
1066 ctx->session_cache_head = s->next;
1067 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1069 /* middle of list */
1070 s->next->prev = s->prev;
1071 s->prev->next = s->next;
1074 s->prev = s->next = NULL;
1077 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1079 if ((s->next != NULL) && (s->prev != NULL))
1080 SSL_SESSION_list_remove(ctx, s);
1082 if (ctx->session_cache_head == NULL) {
1083 ctx->session_cache_head = s;
1084 ctx->session_cache_tail = s;
1085 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1086 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1088 s->next = ctx->session_cache_head;
1090 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1091 ctx->session_cache_head = s;
1095 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1096 int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1098 ctx->new_session_cb = cb;
1101 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1102 return ctx->new_session_cb;
1105 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1106 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1108 ctx->remove_session_cb = cb;
1111 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1112 SSL_SESSION *sess) {
1113 return ctx->remove_session_cb;
1116 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1117 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1118 const unsigned char *data,
1119 int len, int *copy))
1121 ctx->get_session_cb = cb;
1124 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1128 return ctx->get_session_cb;
1131 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1132 void (*cb) (const SSL *ssl, int type, int val))
1134 ctx->info_callback = cb;
1137 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1139 return ctx->info_callback;
1142 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1143 int (*cb) (SSL *ssl, X509 **x509,
1146 ctx->client_cert_cb = cb;
1149 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1151 return ctx->client_cert_cb;
1154 #ifndef OPENSSL_NO_ENGINE
1155 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1157 if (!ENGINE_init(e)) {
1158 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1161 if (!ENGINE_get_ssl_client_cert_function(e)) {
1162 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1163 SSL_R_NO_CLIENT_CERT_METHOD);
1167 ctx->client_cert_engine = e;
1172 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1173 int (*cb) (SSL *ssl,
1174 unsigned char *cookie,
1175 unsigned int *cookie_len))
1177 ctx->app_gen_cookie_cb = cb;
1180 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1181 int (*cb) (SSL *ssl,
1182 const unsigned char *cookie,
1183 unsigned int cookie_len))
1185 ctx->app_verify_cookie_cb = cb;
1188 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)