1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
57 /* ====================================================================
58 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
86 * 6. Redistributions of any form whatsoever must retain the following
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
110 /* ====================================================================
111 * Copyright 2005 Nokia. All rights reserved.
113 * The portions of the attached software ("Contribution") is developed by
114 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
117 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
118 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
119 * support (see RFC 4279) to OpenSSL.
121 * No patent licenses or other rights except those expressly stated in
122 * the OpenSSL open source license shall be deemed granted or received
123 * expressly, by implication, estoppel, or otherwise.
125 * No assurances are provided by Nokia that the Contribution does not
126 * infringe the patent or other intellectual property rights of any third
127 * party or that the license provides you with all the necessary rights
128 * to make use of the Contribution.
130 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
131 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
132 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
133 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
138 #include <openssl/lhash.h>
139 #include <openssl/rand.h>
140 #ifndef OPENSSL_NO_ENGINE
141 # include <openssl/engine.h>
143 #include "ssl_locl.h"
145 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
146 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
147 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
149 SSL_SESSION *SSL_get_session(const SSL *ssl)
150 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
152 return (ssl->session);
155 SSL_SESSION *SSL_get1_session(SSL *ssl)
156 /* variant of SSL_get_session: caller really gets something */
160 * Need to lock this all up rather than just use CRYPTO_add so that
161 * somebody doesn't free ssl->session between when we check it's non-null
162 * and when we up the reference count.
164 CRYPTO_THREAD_read_lock(ssl->lock);
167 SSL_SESSION_up_ref(sess);
168 CRYPTO_THREAD_unlock(ssl->lock);
172 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
174 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
177 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
179 return (CRYPTO_get_ex_data(&s->ex_data, idx));
182 SSL_SESSION *SSL_SESSION_new(void)
186 ss = OPENSSL_zalloc(sizeof(*ss));
188 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
192 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
194 ss->timeout = 60 * 5 + 4; /* 5 minute timeout by default */
195 ss->time = (unsigned long)time(NULL);
196 ss->lock = CRYPTO_THREAD_lock_new();
197 if (ss->lock == NULL) {
198 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
203 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
209 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
210 * ticket == 0 then no ticket information is duplicated, otherwise it is.
212 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
216 dest = OPENSSL_malloc(sizeof(*src));
220 memcpy(dest, src, sizeof(*dest));
223 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
224 * the case of an error whilst halfway through constructing dest
226 #ifndef OPENSSL_NO_PSK
227 dest->psk_identity_hint = NULL;
228 dest->psk_identity = NULL;
230 dest->ciphers = NULL;
231 dest->tlsext_hostname = NULL;
232 #ifndef OPENSSL_NO_EC
233 dest->tlsext_ecpointformatlist = NULL;
234 dest->tlsext_ellipticcurvelist = NULL;
236 dest->tlsext_tick = NULL;
237 #ifndef OPENSSL_NO_SRP
238 dest->srp_username = NULL;
240 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
242 /* We deliberately don't copy the prev and next pointers */
246 dest->references = 1;
248 dest->lock = CRYPTO_THREAD_lock_new();
249 if (dest->lock == NULL)
252 if (src->peer != NULL)
253 X509_up_ref(src->peer);
255 if (src->peer_chain != NULL) {
256 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
257 if (dest->peer_chain == NULL)
261 #ifndef OPENSSL_NO_PSK
262 if (src->psk_identity_hint) {
263 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
264 if (dest->psk_identity_hint == NULL) {
268 if (src->psk_identity) {
269 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
270 if (dest->psk_identity == NULL) {
276 if(src->ciphers != NULL) {
277 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
278 if (dest->ciphers == NULL)
282 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
283 &dest->ex_data, &src->ex_data)) {
287 if (src->tlsext_hostname) {
288 dest->tlsext_hostname = OPENSSL_strdup(src->tlsext_hostname);
289 if (dest->tlsext_hostname == NULL) {
293 #ifndef OPENSSL_NO_EC
294 if (src->tlsext_ecpointformatlist) {
295 dest->tlsext_ecpointformatlist =
296 OPENSSL_memdup(src->tlsext_ecpointformatlist,
297 src->tlsext_ecpointformatlist_length);
298 if (dest->tlsext_ecpointformatlist == NULL)
301 if (src->tlsext_ellipticcurvelist) {
302 dest->tlsext_ellipticcurvelist =
303 OPENSSL_memdup(src->tlsext_ellipticcurvelist,
304 src->tlsext_ellipticcurvelist_length);
305 if (dest->tlsext_ellipticcurvelist == NULL)
311 dest->tlsext_tick = OPENSSL_memdup(src->tlsext_tick, src->tlsext_ticklen);
312 if(dest->tlsext_tick == NULL)
315 dest->tlsext_tick_lifetime_hint = 0;
316 dest->tlsext_ticklen = 0;
319 #ifndef OPENSSL_NO_SRP
320 if (src->srp_username) {
321 dest->srp_username = OPENSSL_strdup(src->srp_username);
322 if (dest->srp_username == NULL) {
330 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
331 SSL_SESSION_free(dest);
335 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
339 *len = s->session_id_length;
340 return s->session_id;
343 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
345 return s->compress_meth;
349 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
350 * the ID with random junk repeatedly until we have no conflict is going to
351 * complete in one iteration pretty much "most" of the time (btw:
352 * understatement). So, if it takes us 10 iterations and we still can't avoid
353 * a conflict - well that's a reasonable point to call it quits. Either the
354 * RAND code is broken or someone is trying to open roughly very close to
355 * 2^256 SSL sessions to our server. How you might store that many sessions
356 * is perhaps a more interesting question ...
359 #define MAX_SESS_ID_ATTEMPTS 10
360 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
361 unsigned int *id_len)
363 unsigned int retry = 0;
365 if (RAND_bytes(id, *id_len) <= 0)
367 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
368 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
369 if (retry < MAX_SESS_ID_ATTEMPTS)
371 /* else - woops a session_id match */
373 * XXX We should also check the external cache -- but the probability of
374 * a collision is negligible, and we could not prevent the concurrent
375 * creation of sessions with identical IDs since we currently don't have
376 * means to atomically check whether a session ID already exists and make
377 * a reservation for it if it does not (this problem applies to the
378 * internal cache as well).
383 int ssl_get_new_session(SSL *s, int session)
385 /* This gets used by clients and servers. */
388 SSL_SESSION *ss = NULL;
389 GEN_SESSION_CB cb = def_generate_session_id;
391 if ((ss = SSL_SESSION_new()) == NULL)
394 /* If the context has a default timeout, use it */
395 if (s->session_ctx->session_timeout == 0)
396 ss->timeout = SSL_get_default_timeout(s);
398 ss->timeout = s->session_ctx->session_timeout;
400 SSL_SESSION_free(s->session);
404 if (s->version == SSL3_VERSION) {
405 ss->ssl_version = SSL3_VERSION;
406 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
407 } else if (s->version == TLS1_VERSION) {
408 ss->ssl_version = TLS1_VERSION;
409 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
410 } else if (s->version == TLS1_1_VERSION) {
411 ss->ssl_version = TLS1_1_VERSION;
412 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
413 } else if (s->version == TLS1_2_VERSION) {
414 ss->ssl_version = TLS1_2_VERSION;
415 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
416 } else if (s->version == DTLS1_BAD_VER) {
417 ss->ssl_version = DTLS1_BAD_VER;
418 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
419 } else if (s->version == DTLS1_VERSION) {
420 ss->ssl_version = DTLS1_VERSION;
421 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
422 } else if (s->version == DTLS1_2_VERSION) {
423 ss->ssl_version = DTLS1_2_VERSION;
424 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
426 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
427 SSL_SESSION_free(ss);
432 * If RFC5077 ticket, use empty session ID (as server).
434 * (a) ssl_get_prev_session() does lookahead into the
435 * ClientHello extensions to find the session ticket.
436 * When ssl_get_prev_session() fails, s3_srvr.c calls
437 * ssl_get_new_session() in ssl3_get_client_hello().
438 * At that point, it has not yet parsed the extensions,
439 * however, because of the lookahead, it already knows
440 * whether a ticket is expected or not.
442 * (b) s3_clnt.c calls ssl_get_new_session() before parsing
443 * ServerHello extensions, and before recording the session
444 * ID received from the server, so this block is a noop.
446 if (s->tlsext_ticket_expected) {
447 ss->session_id_length = 0;
451 /* Choose which callback will set the session ID */
452 CRYPTO_THREAD_read_lock(s->lock);
453 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
454 if (s->generate_session_id)
455 cb = s->generate_session_id;
456 else if (s->session_ctx->generate_session_id)
457 cb = s->session_ctx->generate_session_id;
458 CRYPTO_THREAD_unlock(s->session_ctx->lock);
459 CRYPTO_THREAD_unlock(s->lock);
460 /* Choose a session ID */
461 tmp = ss->session_id_length;
462 if (!cb(s, ss->session_id, &tmp)) {
463 /* The callback failed */
464 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
465 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
466 SSL_SESSION_free(ss);
470 * Don't allow the callback to set the session length to zero. nor
471 * set it higher than it was.
473 if (tmp == 0 || tmp > ss->session_id_length) {
474 /* The callback set an illegal length */
475 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
476 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
477 SSL_SESSION_free(ss);
480 ss->session_id_length = tmp;
481 /* Finally, check for a conflict */
482 if (SSL_has_matching_session_id(s, ss->session_id,
483 ss->session_id_length)) {
484 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
485 SSL_SESSION_free(ss);
490 if (s->tlsext_hostname) {
491 ss->tlsext_hostname = OPENSSL_strdup(s->tlsext_hostname);
492 if (ss->tlsext_hostname == NULL) {
493 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
494 SSL_SESSION_free(ss);
499 ss->session_id_length = 0;
502 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
503 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
504 SSL_SESSION_free(ss);
507 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
508 ss->sid_ctx_length = s->sid_ctx_length;
510 ss->ssl_version = s->version;
511 ss->verify_result = X509_V_OK;
513 /* If client supports extended master secret set it in session */
514 if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)
515 ss->flags |= SSL_SESS_FLAG_EXTMS;
521 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
522 * connection. It is only called by servers.
524 * ext: ClientHello extensions (including length prefix)
525 * session_id: ClientHello session ID.
529 * 0: a session may have been found.
532 * - If a session is found then s->session is pointed at it (after freeing an
533 * existing session if need be) and s->verify_result is set from the session.
534 * - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
535 * if the server should issue a new session ticket (to 0 otherwise).
537 int ssl_get_prev_session(SSL *s, const PACKET *ext, const PACKET *session_id)
539 /* This is used only by servers. */
541 SSL_SESSION *ret = NULL;
543 int try_session_cache = 1;
546 if (PACKET_remaining(session_id) == 0)
547 try_session_cache = 0;
549 /* sets s->tlsext_ticket_expected and extended master secret flag */
550 r = tls_check_serverhello_tlsext_early(s, ext, session_id, &ret);
552 case -1: /* Error during processing */
555 case 0: /* No ticket found */
556 case 1: /* Zero length ticket found */
557 break; /* Ok to carry on processing session id. */
558 case 2: /* Ticket found but not decrypted. */
559 case 3: /* Ticket decrypted, *ret has been set. */
560 try_session_cache = 0;
566 if (try_session_cache &&
568 !(s->session_ctx->session_cache_mode &
569 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
572 data.ssl_version = s->version;
573 if (!PACKET_copy_all(session_id, data.session_id,
574 sizeof(data.session_id),
578 data.session_id_length = local_len;
579 CRYPTO_THREAD_read_lock(s->session_ctx->lock);
580 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
582 /* don't allow other threads to steal it: */
583 SSL_SESSION_up_ref(ret);
585 CRYPTO_THREAD_unlock(s->session_ctx->lock);
587 s->session_ctx->stats.sess_miss++;
590 if (try_session_cache &&
591 ret == NULL && s->session_ctx->get_session_cb != NULL) {
593 ret = s->session_ctx->get_session_cb(s, PACKET_data(session_id),
594 PACKET_remaining(session_id),
598 s->session_ctx->stats.sess_cb_hit++;
601 * Increment reference count now if the session callback asks us
602 * to do so (note that if the session structures returned by the
603 * callback are shared between threads, it must handle the
604 * reference count itself [i.e. copy == 0], or things won't be
608 SSL_SESSION_up_ref(ret);
611 * Add the externally cached session to the internal cache as
612 * well if and only if we are supposed to.
615 (s->session_ctx->session_cache_mode &
616 SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
618 * The following should not return 1, otherwise, things are
621 if (SSL_CTX_add_session(s->session_ctx, ret))
630 /* Now ret is non-NULL and we own one of its reference counts. */
632 if (ret->sid_ctx_length != s->sid_ctx_length
633 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
635 * We have the session requested by the client, but we don't want to
636 * use it in this context.
638 goto err; /* treat like cache miss */
641 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
643 * We can't be sure if this session is being used out of context,
644 * which is especially important for SSL_VERIFY_PEER. The application
645 * should have used SSL[_CTX]_set_session_id_context. For this error
646 * case, we generate an error instead of treating the event like a
647 * cache miss (otherwise it would be easy for applications to
648 * effectively disable the session cache by accident without anyone
652 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
653 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
658 if (ret->cipher == NULL) {
659 unsigned char buf[5], *p;
665 if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
666 ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
668 ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
669 if (ret->cipher == NULL)
673 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
674 s->session_ctx->stats.sess_timeout++;
675 if (try_session_cache) {
676 /* session was from the cache, so remove it */
677 SSL_CTX_remove_session(s->session_ctx, ret);
682 /* Check extended master secret extension consistency */
683 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
684 /* If old session includes extms, but new does not: abort handshake */
685 if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
686 SSLerr(SSL_F_SSL_GET_PREV_SESSION, SSL_R_INCONSISTENT_EXTMS);
687 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
691 } else if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) {
692 /* If new session includes extms, but old does not: do not resume */
696 s->session_ctx->stats.sess_hit++;
698 SSL_SESSION_free(s->session);
700 s->verify_result = s->session->verify_result;
705 SSL_SESSION_free(ret);
707 if (!try_session_cache) {
709 * The session was from a ticket, so we should issue a ticket for
712 s->tlsext_ticket_expected = 1;
721 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
727 * add just 1 reference count for the SSL_CTX's session cache even though
728 * it has two ways of access: each session is in a doubly linked list and
731 SSL_SESSION_up_ref(c);
733 * if session c is in already in cache, we take back the increment later
736 CRYPTO_THREAD_write_lock(ctx->lock);
737 s = lh_SSL_SESSION_insert(ctx->sessions, c);
740 * s != NULL iff we already had a session with the given PID. In this
741 * case, s == c should hold (then we did not really modify
742 * ctx->sessions), or we're in trouble.
744 if (s != NULL && s != c) {
745 /* We *are* in trouble ... */
746 SSL_SESSION_list_remove(ctx, s);
749 * ... so pretend the other session did not exist in cache (we cannot
750 * handle two SSL_SESSION structures with identical session ID in the
751 * same cache, which could happen e.g. when two threads concurrently
752 * obtain the same session from an external cache)
757 /* Put at the head of the queue unless it is already in the cache */
759 SSL_SESSION_list_add(ctx, c);
763 * existing cache entry -- decrement previously incremented reference
764 * count because it already takes into account the cache
767 SSL_SESSION_free(s); /* s == c */
771 * new cache entry -- remove old ones if cache has become too large
776 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
777 while (SSL_CTX_sess_number(ctx) >
778 SSL_CTX_sess_get_cache_size(ctx)) {
779 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
782 ctx->stats.sess_cache_full++;
786 CRYPTO_THREAD_unlock(ctx->lock);
790 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
792 return remove_session_lock(ctx, c, 1);
795 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
800 if ((c != NULL) && (c->session_id_length != 0)) {
802 CRYPTO_THREAD_write_lock(ctx->lock);
803 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
805 r = lh_SSL_SESSION_delete(ctx->sessions, c);
806 SSL_SESSION_list_remove(ctx, c);
810 CRYPTO_THREAD_unlock(ctx->lock);
813 r->not_resumable = 1;
814 if (ctx->remove_session_cb != NULL)
815 ctx->remove_session_cb(ctx, r);
823 void SSL_SESSION_free(SSL_SESSION *ss)
830 CRYPTO_atomic_add(&ss->references, -1, &i, ss->lock);
831 REF_PRINT_COUNT("SSL_SESSION", ss);
834 REF_ASSERT_ISNT(i < 0);
836 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
838 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
839 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
841 sk_X509_pop_free(ss->peer_chain, X509_free);
842 sk_SSL_CIPHER_free(ss->ciphers);
843 OPENSSL_free(ss->tlsext_hostname);
844 OPENSSL_free(ss->tlsext_tick);
845 #ifndef OPENSSL_NO_EC
846 ss->tlsext_ecpointformatlist_length = 0;
847 OPENSSL_free(ss->tlsext_ecpointformatlist);
848 ss->tlsext_ellipticcurvelist_length = 0;
849 OPENSSL_free(ss->tlsext_ellipticcurvelist);
850 #endif /* OPENSSL_NO_EC */
851 #ifndef OPENSSL_NO_PSK
852 OPENSSL_free(ss->psk_identity_hint);
853 OPENSSL_free(ss->psk_identity);
855 #ifndef OPENSSL_NO_SRP
856 OPENSSL_free(ss->srp_username);
858 CRYPTO_THREAD_lock_free(ss->lock);
859 OPENSSL_clear_free(ss, sizeof(*ss));
862 int SSL_SESSION_up_ref(SSL_SESSION *ss)
866 if (CRYPTO_atomic_add(&ss->references, 1, &i, ss->lock) <= 0)
869 REF_PRINT_COUNT("SSL_SESSION", ss);
870 REF_ASSERT_ISNT(i < 2);
871 return ((i > 1) ? 1 : 0);
874 int SSL_set_session(SSL *s, SSL_SESSION *session)
877 const SSL_METHOD *meth;
879 if (session != NULL) {
880 meth = s->ctx->method->get_ssl_method(session->ssl_version);
882 meth = s->method->get_ssl_method(session->ssl_version);
884 SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
888 if (meth != s->method) {
889 if (!SSL_set_ssl_method(s, meth))
893 SSL_SESSION_up_ref(session);
894 SSL_SESSION_free(s->session);
895 s->session = session;
896 s->verify_result = s->session->verify_result;
899 SSL_SESSION_free(s->session);
901 meth = s->ctx->method;
902 if (meth != s->method) {
903 if (!SSL_set_ssl_method(s, meth))
911 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
919 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
926 long SSL_SESSION_get_time(const SSL_SESSION *s)
933 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
941 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
943 return (s->tlsext_ticklen > 0) ? 1 : 0;
946 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
948 return s->tlsext_tick_lifetime_hint;
951 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, unsigned char **tick,
954 *len = s->tlsext_ticklen;
956 *tick = s->tlsext_tick;
959 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
964 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
965 unsigned int sid_ctx_len)
967 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
968 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
969 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
972 s->sid_ctx_length = sid_ctx_len;
973 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
978 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
983 l = s->session_timeout;
984 s->session_timeout = t;
988 long SSL_CTX_get_timeout(const SSL_CTX *s)
992 return (s->session_timeout);
995 int SSL_set_session_secret_cb(SSL *s,
996 int (*tls_session_secret_cb) (SSL *s,
1008 s->tls_session_secret_cb = tls_session_secret_cb;
1009 s->tls_session_secret_cb_arg = arg;
1013 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
1018 s->tls_session_ticket_ext_cb = cb;
1019 s->tls_session_ticket_ext_cb_arg = arg;
1023 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1025 if (s->version >= TLS1_VERSION) {
1026 OPENSSL_free(s->tlsext_session_ticket);
1027 s->tlsext_session_ticket = NULL;
1028 s->tlsext_session_ticket =
1029 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1030 if (s->tlsext_session_ticket == NULL) {
1031 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
1036 s->tlsext_session_ticket->length = ext_len;
1037 s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
1038 memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
1040 s->tlsext_session_ticket->length = 0;
1041 s->tlsext_session_ticket->data = NULL;
1050 typedef struct timeout_param_st {
1053 LHASH_OF(SSL_SESSION) *cache;
1056 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
1058 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1060 * The reason we don't call SSL_CTX_remove_session() is to save on
1063 (void)lh_SSL_SESSION_delete(p->cache, s);
1064 SSL_SESSION_list_remove(p->ctx, s);
1065 s->not_resumable = 1;
1066 if (p->ctx->remove_session_cb != NULL)
1067 p->ctx->remove_session_cb(p->ctx, s);
1068 SSL_SESSION_free(s);
1072 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
1074 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1080 tp.cache = s->sessions;
1081 if (tp.cache == NULL)
1084 CRYPTO_THREAD_write_lock(s->lock);
1085 i = CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
1086 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = 0;
1087 lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1088 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = i;
1089 CRYPTO_THREAD_unlock(s->lock);
1092 int ssl_clear_bad_session(SSL *s)
1094 if ((s->session != NULL) &&
1095 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1096 !(SSL_in_init(s) || SSL_in_before(s))) {
1097 SSL_CTX_remove_session(s->ctx, s->session);
1103 /* locked by SSL_CTX in the calling function */
1104 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1106 if ((s->next == NULL) || (s->prev == NULL))
1109 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1110 /* last element in list */
1111 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1112 /* only one element in list */
1113 ctx->session_cache_head = NULL;
1114 ctx->session_cache_tail = NULL;
1116 ctx->session_cache_tail = s->prev;
1117 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1120 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1121 /* first element in list */
1122 ctx->session_cache_head = s->next;
1123 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1125 /* middle of list */
1126 s->next->prev = s->prev;
1127 s->prev->next = s->next;
1130 s->prev = s->next = NULL;
1133 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1135 if ((s->next != NULL) && (s->prev != NULL))
1136 SSL_SESSION_list_remove(ctx, s);
1138 if (ctx->session_cache_head == NULL) {
1139 ctx->session_cache_head = s;
1140 ctx->session_cache_tail = s;
1141 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1142 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1144 s->next = ctx->session_cache_head;
1146 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1147 ctx->session_cache_head = s;
1151 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1152 int (*cb) (struct ssl_st *ssl,
1155 ctx->new_session_cb = cb;
1158 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1159 return ctx->new_session_cb;
1162 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1163 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1165 ctx->remove_session_cb = cb;
1168 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1169 SSL_SESSION *sess) {
1170 return ctx->remove_session_cb;
1173 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1174 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1175 const unsigned char *data,
1176 int len, int *copy))
1178 ctx->get_session_cb = cb;
1181 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1182 const unsigned char *data,
1183 int len, int *copy) {
1184 return ctx->get_session_cb;
1187 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1188 void (*cb) (const SSL *ssl, int type, int val))
1190 ctx->info_callback = cb;
1193 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1195 return ctx->info_callback;
1198 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1199 int (*cb) (SSL *ssl, X509 **x509,
1202 ctx->client_cert_cb = cb;
1205 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1207 return ctx->client_cert_cb;
1210 #ifndef OPENSSL_NO_ENGINE
1211 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1213 if (!ENGINE_init(e)) {
1214 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1217 if (!ENGINE_get_ssl_client_cert_function(e)) {
1218 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1219 SSL_R_NO_CLIENT_CERT_METHOD);
1223 ctx->client_cert_engine = e;
1228 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1229 int (*cb) (SSL *ssl,
1230 unsigned char *cookie,
1231 unsigned int *cookie_len))
1233 ctx->app_gen_cookie_cb = cb;
1236 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1237 int (*cb) (SSL *ssl, const unsigned char *cookie,
1238 unsigned int cookie_len))
1240 ctx->app_verify_cookie_cb = cb;
1243 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION,