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>
43 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
44 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
45 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
47 SSL_SESSION *SSL_get_session(const SSL *ssl)
48 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
50 return (ssl->session);
53 SSL_SESSION *SSL_get1_session(SSL *ssl)
54 /* variant of SSL_get_session: caller really gets something */
58 * Need to lock this all up rather than just use CRYPTO_add so that
59 * somebody doesn't free ssl->session between when we check it's non-null
60 * and when we up the reference count.
62 CRYPTO_THREAD_read_lock(ssl->lock);
65 SSL_SESSION_up_ref(sess);
66 CRYPTO_THREAD_unlock(ssl->lock);
70 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
72 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
75 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
77 return (CRYPTO_get_ex_data(&s->ex_data, idx));
80 SSL_SESSION *SSL_SESSION_new(void)
84 ss = OPENSSL_zalloc(sizeof(*ss));
86 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
90 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
92 ss->timeout = 60 * 5 + 4; /* 5 minute timeout by default */
93 ss->time = (unsigned long)time(NULL);
94 ss->lock = CRYPTO_THREAD_lock_new();
95 if (ss->lock == NULL) {
96 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
101 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data)) {
102 CRYPTO_THREAD_lock_free(ss->lock);
110 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
111 * ticket == 0 then no ticket information is duplicated, otherwise it is.
113 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
117 dest = OPENSSL_malloc(sizeof(*src));
121 memcpy(dest, src, sizeof(*dest));
124 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
125 * the case of an error whilst halfway through constructing dest
127 #ifndef OPENSSL_NO_PSK
128 dest->psk_identity_hint = NULL;
129 dest->psk_identity = NULL;
131 dest->ciphers = NULL;
132 dest->tlsext_hostname = NULL;
133 #ifndef OPENSSL_NO_EC
134 dest->tlsext_ecpointformatlist = NULL;
135 dest->tlsext_supportedgroupslist = NULL;
137 dest->tlsext_tick = NULL;
138 #ifndef OPENSSL_NO_SRP
139 dest->srp_username = NULL;
141 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
143 /* We deliberately don't copy the prev and next pointers */
147 dest->references = 1;
149 dest->lock = CRYPTO_THREAD_lock_new();
150 if (dest->lock == NULL)
153 if (src->peer != NULL)
154 X509_up_ref(src->peer);
156 if (src->peer_chain != NULL) {
157 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
158 if (dest->peer_chain == NULL)
161 #ifndef OPENSSL_NO_PSK
162 if (src->psk_identity_hint) {
163 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
164 if (dest->psk_identity_hint == NULL) {
168 if (src->psk_identity) {
169 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
170 if (dest->psk_identity == NULL) {
176 if (src->ciphers != NULL) {
177 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
178 if (dest->ciphers == NULL)
182 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
183 &dest->ex_data, &src->ex_data)) {
187 if (src->tlsext_hostname) {
188 dest->tlsext_hostname = OPENSSL_strdup(src->tlsext_hostname);
189 if (dest->tlsext_hostname == NULL) {
193 #ifndef OPENSSL_NO_EC
194 if (src->tlsext_ecpointformatlist) {
195 dest->tlsext_ecpointformatlist =
196 OPENSSL_memdup(src->tlsext_ecpointformatlist,
197 src->tlsext_ecpointformatlist_length);
198 if (dest->tlsext_ecpointformatlist == NULL)
201 if (src->tlsext_supportedgroupslist) {
202 dest->tlsext_supportedgroupslist =
203 OPENSSL_memdup(src->tlsext_supportedgroupslist,
204 src->tlsext_supportedgroupslist_length);
205 if (dest->tlsext_supportedgroupslist == NULL)
212 OPENSSL_memdup(src->tlsext_tick, src->tlsext_ticklen);
213 if (dest->tlsext_tick == NULL)
216 dest->tlsext_tick_lifetime_hint = 0;
217 dest->tlsext_ticklen = 0;
220 #ifndef OPENSSL_NO_SRP
221 if (src->srp_username) {
222 dest->srp_username = OPENSSL_strdup(src->srp_username);
223 if (dest->srp_username == NULL) {
231 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
232 SSL_SESSION_free(dest);
236 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
239 *len = (unsigned int)s->session_id_length;
240 return s->session_id;
242 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
246 *len = (unsigned int)s->sid_ctx_length;
250 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
252 return s->compress_meth;
256 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
257 * the ID with random junk repeatedly until we have no conflict is going to
258 * complete in one iteration pretty much "most" of the time (btw:
259 * understatement). So, if it takes us 10 iterations and we still can't avoid
260 * a conflict - well that's a reasonable point to call it quits. Either the
261 * RAND code is broken or someone is trying to open roughly very close to
262 * 2^256 SSL sessions to our server. How you might store that many sessions
263 * is perhaps a more interesting question ...
266 #define MAX_SESS_ID_ATTEMPTS 10
267 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
268 unsigned int *id_len)
270 unsigned int retry = 0;
272 if (RAND_bytes(id, *id_len) <= 0)
274 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
275 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
276 if (retry < MAX_SESS_ID_ATTEMPTS)
278 /* else - woops a session_id match */
280 * XXX We should also check the external cache -- but the probability of
281 * a collision is negligible, and we could not prevent the concurrent
282 * creation of sessions with identical IDs since we currently don't have
283 * means to atomically check whether a session ID already exists and make
284 * a reservation for it if it does not (this problem applies to the
285 * internal cache as well).
290 int ssl_get_new_session(SSL *s, int session)
292 /* This gets used by clients and servers. */
295 SSL_SESSION *ss = NULL;
296 GEN_SESSION_CB cb = def_generate_session_id;
298 if ((ss = SSL_SESSION_new()) == NULL)
301 /* If the context has a default timeout, use it */
302 if (s->session_ctx->session_timeout == 0)
303 ss->timeout = SSL_get_default_timeout(s);
305 ss->timeout = s->session_ctx->session_timeout;
307 SSL_SESSION_free(s->session);
311 if (s->version == SSL3_VERSION) {
312 ss->ssl_version = SSL3_VERSION;
313 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
314 } else if (s->version == TLS1_VERSION) {
315 ss->ssl_version = TLS1_VERSION;
316 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
317 } else if (s->version == TLS1_1_VERSION) {
318 ss->ssl_version = TLS1_1_VERSION;
319 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
320 } else if (s->version == TLS1_2_VERSION) {
321 ss->ssl_version = TLS1_2_VERSION;
322 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
323 } else if (s->version == TLS1_3_VERSION) {
324 ss->ssl_version = TLS1_3_VERSION;
325 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
326 } else if (s->version == DTLS1_BAD_VER) {
327 ss->ssl_version = DTLS1_BAD_VER;
328 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
329 } else if (s->version == DTLS1_VERSION) {
330 ss->ssl_version = DTLS1_VERSION;
331 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
332 } else if (s->version == DTLS1_2_VERSION) {
333 ss->ssl_version = DTLS1_2_VERSION;
334 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
336 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
337 SSL_SESSION_free(ss);
342 * If RFC5077 ticket, use empty session ID (as server).
344 * (a) ssl_get_prev_session() does lookahead into the
345 * ClientHello extensions to find the session ticket.
346 * When ssl_get_prev_session() fails, statem_srvr.c calls
347 * ssl_get_new_session() in tls_process_client_hello().
348 * At that point, it has not yet parsed the extensions,
349 * however, because of the lookahead, it already knows
350 * whether a ticket is expected or not.
352 * (b) statem_clnt.c calls ssl_get_new_session() before parsing
353 * ServerHello extensions, and before recording the session
354 * ID received from the server, so this block is a noop.
356 if (s->tlsext_ticket_expected) {
357 ss->session_id_length = 0;
361 /* Choose which callback will set the session ID */
362 CRYPTO_THREAD_read_lock(s->lock);
363 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
364 if (s->generate_session_id)
365 cb = s->generate_session_id;
366 else if (s->session_ctx->generate_session_id)
367 cb = s->session_ctx->generate_session_id;
368 CRYPTO_THREAD_unlock(s->session_ctx->lock);
369 CRYPTO_THREAD_unlock(s->lock);
370 /* Choose a session ID */
371 memset(ss->session_id, 0, ss->session_id_length);
372 tmp = (int)ss->session_id_length;
373 if (!cb(s, ss->session_id, &tmp)) {
374 /* The callback failed */
375 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
376 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
377 SSL_SESSION_free(ss);
381 * Don't allow the callback to set the session length to zero. nor
382 * set it higher than it was.
384 if (tmp == 0 || tmp > ss->session_id_length) {
385 /* The callback set an illegal length */
386 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
387 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
388 SSL_SESSION_free(ss);
391 ss->session_id_length = tmp;
392 /* Finally, check for a conflict */
393 if (SSL_has_matching_session_id(s, ss->session_id,
394 (unsigned int)ss->session_id_length)) {
395 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
396 SSL_SESSION_free(ss);
401 if (s->tlsext_hostname) {
402 ss->tlsext_hostname = OPENSSL_strdup(s->tlsext_hostname);
403 if (ss->tlsext_hostname == NULL) {
404 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
405 SSL_SESSION_free(ss);
410 ss->session_id_length = 0;
413 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
414 SSLerr(SSL_F_SSL_GET_NEW_SESSION, 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;
432 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
433 * connection. It is only called by servers.
435 * hello: The parsed ClientHello data
439 * 0: a session may have been found.
442 * - If a session is found then s->session is pointed at it (after freeing an
443 * existing session if need be) and s->verify_result is set from the session.
444 * - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
445 * if the server should issue a new session ticket (to 0 otherwise).
447 int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello)
449 /* This is used only by servers. */
451 SSL_SESSION *ret = NULL;
453 int try_session_cache = 1;
456 if (hello->session_id_len == 0)
457 try_session_cache = 0;
459 /* sets s->tlsext_ticket_expected */
460 r = tls_get_ticket_from_client(s, hello, &ret);
462 case -1: /* Error during processing */
465 case 0: /* No ticket found */
466 case 1: /* Zero length ticket found */
467 break; /* Ok to carry on processing session id. */
468 case 2: /* Ticket found but not decrypted. */
469 case 3: /* Ticket decrypted, *ret has been set. */
470 try_session_cache = 0;
476 if (try_session_cache &&
478 !(s->session_ctx->session_cache_mode &
479 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
482 data.ssl_version = s->version;
483 memset(data.session_id, 0, sizeof(data.session_id));
484 memcpy(data.session_id, hello->session_id, hello->session_id_len);
485 data.session_id_length = hello->session_id_len;
487 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
488 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
490 /* don't allow other threads to steal it: */
491 SSL_SESSION_up_ref(ret);
493 CRYPTO_THREAD_unlock(s->session_ctx->lock);
495 s->session_ctx->stats.sess_miss++;
498 if (try_session_cache &&
499 ret == NULL && s->session_ctx->get_session_cb != NULL) {
502 ret = s->session_ctx->get_session_cb(s, hello->session_id,
503 hello->session_id_len,
507 s->session_ctx->stats.sess_cb_hit++;
510 * Increment reference count now if the session callback asks us
511 * to do so (note that if the session structures returned by the
512 * callback are shared between threads, it must handle the
513 * reference count itself [i.e. copy == 0], or things won't be
517 SSL_SESSION_up_ref(ret);
520 * Add the externally cached session to the internal cache as
521 * well if and only if we are supposed to.
524 (s->session_ctx->session_cache_mode &
525 SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
527 * The following should not return 1, otherwise, things are
530 if (SSL_CTX_add_session(s->session_ctx, ret))
539 /* Now ret is non-NULL and we own one of its reference counts. */
541 if (ret->sid_ctx_length != s->sid_ctx_length
542 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
544 * We have the session requested by the client, but we don't want to
545 * use it in this context.
547 goto err; /* treat like cache miss */
550 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
552 * We can't be sure if this session is being used out of context,
553 * which is especially important for SSL_VERIFY_PEER. The application
554 * should have used SSL[_CTX]_set_session_id_context. For this error
555 * case, we generate an error instead of treating the event like a
556 * cache miss (otherwise it would be easy for applications to
557 * effectively disable the session cache by accident without anyone
561 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
562 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
567 if (ret->cipher == NULL) {
568 unsigned char buf[5], *p;
574 if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
575 ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
577 ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
578 if (ret->cipher == NULL)
582 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
583 s->session_ctx->stats.sess_timeout++;
584 if (try_session_cache) {
585 /* session was from the cache, so remove it */
586 SSL_CTX_remove_session(s->session_ctx, ret);
592 * TODO(TLS1.3): This is temporary, because TLSv1.3 resumption is completely
593 * different. For now though we're still using the old resumption logic, so
594 * to avoid test failures we need this. Remove this code!
596 * Check TLS version consistency. We can't resume <=TLSv1.2 session if we
597 * have negotiated TLSv1.3, and vice versa.
600 && ((ret->ssl_version <= TLS1_2_VERSION
601 && s->version >=TLS1_3_VERSION)
602 || (ret->ssl_version >= TLS1_3_VERSION
603 && s->version <= TLS1_2_VERSION))) {
604 /* Continue but do not resume */
608 /* Check extended master secret extension consistency */
609 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
610 /* If old session includes extms, but new does not: abort handshake */
611 if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
612 SSLerr(SSL_F_SSL_GET_PREV_SESSION, SSL_R_INCONSISTENT_EXTMS);
613 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
617 } else if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) {
618 /* If new session includes extms, but old does not: do not resume */
622 s->session_ctx->stats.sess_hit++;
624 SSL_SESSION_free(s->session);
626 s->verify_result = s->session->verify_result;
631 SSL_SESSION_free(ret);
633 if (!try_session_cache) {
635 * The session was from a ticket, so we should issue a ticket for
638 s->tlsext_ticket_expected = 1;
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)
683 /* Put at the head of the queue unless it is already in the cache */
685 SSL_SESSION_list_add(ctx, c);
689 * existing cache entry -- decrement previously incremented reference
690 * count because it already takes into account the cache
693 SSL_SESSION_free(s); /* s == c */
697 * new cache entry -- remove old ones if cache has become too large
702 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
703 while (SSL_CTX_sess_number(ctx) > SSL_CTX_sess_get_cache_size(ctx)) {
704 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
707 ctx->stats.sess_cache_full++;
711 CRYPTO_THREAD_unlock(ctx->lock);
715 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
717 return remove_session_lock(ctx, c, 1);
720 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
725 if ((c != NULL) && (c->session_id_length != 0)) {
727 CRYPTO_THREAD_write_lock(ctx->lock);
728 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
730 r = lh_SSL_SESSION_delete(ctx->sessions, c);
731 SSL_SESSION_list_remove(ctx, c);
733 c->not_resumable = 1;
736 CRYPTO_THREAD_unlock(ctx->lock);
741 if (ctx->remove_session_cb != NULL)
742 ctx->remove_session_cb(ctx, c);
748 void SSL_SESSION_free(SSL_SESSION *ss)
755 CRYPTO_atomic_add(&ss->references, -1, &i, ss->lock);
756 REF_PRINT_COUNT("SSL_SESSION", ss);
759 REF_ASSERT_ISNT(i < 0);
761 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
763 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
764 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
766 sk_X509_pop_free(ss->peer_chain, X509_free);
767 sk_SSL_CIPHER_free(ss->ciphers);
768 OPENSSL_free(ss->tlsext_hostname);
769 OPENSSL_free(ss->tlsext_tick);
770 #ifndef OPENSSL_NO_EC
771 ss->tlsext_ecpointformatlist_length = 0;
772 OPENSSL_free(ss->tlsext_ecpointformatlist);
773 ss->tlsext_supportedgroupslist_length = 0;
774 OPENSSL_free(ss->tlsext_supportedgroupslist);
775 #endif /* OPENSSL_NO_EC */
776 #ifndef OPENSSL_NO_PSK
777 OPENSSL_free(ss->psk_identity_hint);
778 OPENSSL_free(ss->psk_identity);
780 #ifndef OPENSSL_NO_SRP
781 OPENSSL_free(ss->srp_username);
783 CRYPTO_THREAD_lock_free(ss->lock);
784 OPENSSL_clear_free(ss, sizeof(*ss));
787 int SSL_SESSION_up_ref(SSL_SESSION *ss)
791 if (CRYPTO_atomic_add(&ss->references, 1, &i, ss->lock) <= 0)
794 REF_PRINT_COUNT("SSL_SESSION", ss);
795 REF_ASSERT_ISNT(i < 2);
796 return ((i > 1) ? 1 : 0);
799 int SSL_set_session(SSL *s, SSL_SESSION *session)
801 ssl_clear_bad_session(s);
802 if (s->ctx->method != s->method) {
803 if (!SSL_set_ssl_method(s, s->ctx->method))
807 if (session != NULL) {
808 SSL_SESSION_up_ref(session);
809 s->verify_result = session->verify_result;
811 SSL_SESSION_free(s->session);
812 s->session = session;
817 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
818 unsigned int sid_len)
820 if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
821 SSLerr(SSL_F_SSL_SESSION_SET1_ID,
822 SSL_R_SSL_SESSION_ID_TOO_LONG);
825 s->session_id_length = sid_len;
826 memcpy(s->session_id, sid, sid_len);
830 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
838 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
845 long SSL_SESSION_get_time(const SSL_SESSION *s)
852 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
860 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
862 return s->ssl_version;
865 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
870 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
872 return s->tlsext_hostname;
875 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
877 return (s->tlsext_ticklen > 0) ? 1 : 0;
880 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
882 return s->tlsext_tick_lifetime_hint;
885 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
888 *len = s->tlsext_ticklen;
890 *tick = s->tlsext_tick;
893 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
898 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
899 unsigned int sid_ctx_len)
901 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
902 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
903 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
906 s->sid_ctx_length = sid_ctx_len;
907 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
912 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
917 l = s->session_timeout;
918 s->session_timeout = t;
922 long SSL_CTX_get_timeout(const SSL_CTX *s)
926 return (s->session_timeout);
929 int SSL_set_session_secret_cb(SSL *s,
930 int (*tls_session_secret_cb) (SSL *s,
942 s->tls_session_secret_cb = tls_session_secret_cb;
943 s->tls_session_secret_cb_arg = arg;
947 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
952 s->tls_session_ticket_ext_cb = cb;
953 s->tls_session_ticket_ext_cb_arg = arg;
957 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
959 if (s->version >= TLS1_VERSION) {
960 OPENSSL_free(s->tlsext_session_ticket);
961 s->tlsext_session_ticket = NULL;
962 s->tlsext_session_ticket =
963 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
964 if (s->tlsext_session_ticket == NULL) {
965 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
970 s->tlsext_session_ticket->length = ext_len;
971 s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
972 memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
974 s->tlsext_session_ticket->length = 0;
975 s->tlsext_session_ticket->data = NULL;
984 typedef struct timeout_param_st {
987 LHASH_OF(SSL_SESSION) *cache;
990 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
992 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
994 * The reason we don't call SSL_CTX_remove_session() is to save on
997 (void)lh_SSL_SESSION_delete(p->cache, s);
998 SSL_SESSION_list_remove(p->ctx, s);
999 s->not_resumable = 1;
1000 if (p->ctx->remove_session_cb != NULL)
1001 p->ctx->remove_session_cb(p->ctx, s);
1002 SSL_SESSION_free(s);
1006 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
1008 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1014 tp.cache = s->sessions;
1015 if (tp.cache == NULL)
1018 CRYPTO_THREAD_write_lock(s->lock);
1019 i = lh_SSL_SESSION_get_down_load(s->sessions);
1020 lh_SSL_SESSION_set_down_load(s->sessions, 0);
1021 lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1022 lh_SSL_SESSION_set_down_load(s->sessions, i);
1023 CRYPTO_THREAD_unlock(s->lock);
1026 int ssl_clear_bad_session(SSL *s)
1028 if ((s->session != NULL) &&
1029 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1030 !(SSL_in_init(s) || SSL_in_before(s))) {
1031 SSL_CTX_remove_session(s->session_ctx, s->session);
1037 /* locked by SSL_CTX in the calling function */
1038 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1040 if ((s->next == NULL) || (s->prev == NULL))
1043 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1044 /* last element in list */
1045 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1046 /* only one element in list */
1047 ctx->session_cache_head = NULL;
1048 ctx->session_cache_tail = NULL;
1050 ctx->session_cache_tail = s->prev;
1051 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1054 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1055 /* first element in list */
1056 ctx->session_cache_head = s->next;
1057 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1059 /* middle of list */
1060 s->next->prev = s->prev;
1061 s->prev->next = s->next;
1064 s->prev = s->next = NULL;
1067 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1069 if ((s->next != NULL) && (s->prev != NULL))
1070 SSL_SESSION_list_remove(ctx, s);
1072 if (ctx->session_cache_head == NULL) {
1073 ctx->session_cache_head = s;
1074 ctx->session_cache_tail = s;
1075 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1076 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1078 s->next = ctx->session_cache_head;
1080 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1081 ctx->session_cache_head = s;
1085 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1086 int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1088 ctx->new_session_cb = cb;
1091 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1092 return ctx->new_session_cb;
1095 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1096 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1098 ctx->remove_session_cb = cb;
1101 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1102 SSL_SESSION *sess) {
1103 return ctx->remove_session_cb;
1106 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1107 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1108 const unsigned char *data,
1109 int len, int *copy))
1111 ctx->get_session_cb = cb;
1114 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1118 return ctx->get_session_cb;
1121 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1122 void (*cb) (const SSL *ssl, int type, int val))
1124 ctx->info_callback = cb;
1127 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1129 return ctx->info_callback;
1132 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1133 int (*cb) (SSL *ssl, X509 **x509,
1136 ctx->client_cert_cb = cb;
1139 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1141 return ctx->client_cert_cb;
1144 #ifndef OPENSSL_NO_ENGINE
1145 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1147 if (!ENGINE_init(e)) {
1148 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1151 if (!ENGINE_get_ssl_client_cert_function(e)) {
1152 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1153 SSL_R_NO_CLIENT_CERT_METHOD);
1157 ctx->client_cert_engine = e;
1162 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1163 int (*cb) (SSL *ssl,
1164 unsigned char *cookie,
1165 unsigned int *cookie_len))
1167 ctx->app_gen_cookie_cb = cb;
1170 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1171 int (*cb) (SSL *ssl,
1172 const unsigned char *cookie,
1173 unsigned int cookie_len))
1175 ctx->app_verify_cookie_cb = cb;
1178 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)