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_w_lock(CRYPTO_LOCK_SSL_SESSION);
168 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
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 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
201 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
202 * ticket == 0 then no ticket information is duplicated, otherwise it is.
204 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
208 dest = OPENSSL_malloc(sizeof(*src));
212 memcpy(dest, src, sizeof(*dest));
215 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
216 * the case of an error whilst halfway through constructing dest
218 #ifndef OPENSSL_NO_PSK
219 dest->psk_identity_hint = NULL;
220 dest->psk_identity = NULL;
222 dest->ciphers = NULL;
223 dest->tlsext_hostname = NULL;
224 #ifndef OPENSSL_NO_EC
225 dest->tlsext_ecpointformatlist = NULL;
226 dest->tlsext_ellipticcurvelist = NULL;
228 dest->tlsext_tick = NULL;
229 #ifndef OPENSSL_NO_SRP
230 dest->srp_username = NULL;
232 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
234 /* We deliberately don't copy the prev and next pointers */
238 dest->references = 1;
240 if (src->peer != NULL)
241 X509_up_ref(src->peer);
243 if (src->peer_chain != NULL) {
244 dest->peer_chain = X509_chain_up_ref(src->peer_chain);
245 if (dest->peer_chain == NULL)
249 #ifndef OPENSSL_NO_PSK
250 if (src->psk_identity_hint) {
251 dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
252 if (dest->psk_identity_hint == NULL) {
256 if (src->psk_identity) {
257 dest->psk_identity = OPENSSL_strdup(src->psk_identity);
258 if (dest->psk_identity == NULL) {
264 if(src->ciphers != NULL) {
265 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
266 if (dest->ciphers == NULL)
270 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
271 &dest->ex_data, &src->ex_data)) {
275 if (src->tlsext_hostname) {
276 dest->tlsext_hostname = OPENSSL_strdup(src->tlsext_hostname);
277 if (dest->tlsext_hostname == NULL) {
281 #ifndef OPENSSL_NO_EC
282 if (src->tlsext_ecpointformatlist) {
283 dest->tlsext_ecpointformatlist =
284 OPENSSL_memdup(src->tlsext_ecpointformatlist,
285 src->tlsext_ecpointformatlist_length);
286 if (dest->tlsext_ecpointformatlist == NULL)
289 if (src->tlsext_ellipticcurvelist) {
290 dest->tlsext_ellipticcurvelist =
291 OPENSSL_memdup(src->tlsext_ellipticcurvelist,
292 src->tlsext_ellipticcurvelist_length);
293 if (dest->tlsext_ellipticcurvelist == NULL)
299 dest->tlsext_tick = OPENSSL_memdup(src->tlsext_tick, src->tlsext_ticklen);
300 if(dest->tlsext_tick == NULL)
303 dest->tlsext_tick_lifetime_hint = 0;
304 dest->tlsext_ticklen = 0;
307 #ifndef OPENSSL_NO_SRP
308 if (src->srp_username) {
309 dest->srp_username = OPENSSL_strdup(src->srp_username);
310 if (dest->srp_username == NULL) {
318 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
319 SSL_SESSION_free(dest);
323 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
327 *len = s->session_id_length;
328 return s->session_id;
331 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
333 return s->compress_meth;
337 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
338 * the ID with random junk repeatedly until we have no conflict is going to
339 * complete in one iteration pretty much "most" of the time (btw:
340 * understatement). So, if it takes us 10 iterations and we still can't avoid
341 * a conflict - well that's a reasonable point to call it quits. Either the
342 * RAND code is broken or someone is trying to open roughly very close to
343 * 2^256 SSL sessions to our server. How you might store that many sessions
344 * is perhaps a more interesting question ...
347 #define MAX_SESS_ID_ATTEMPTS 10
348 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
349 unsigned int *id_len)
351 unsigned int retry = 0;
353 if (RAND_bytes(id, *id_len) <= 0)
355 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
356 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
357 if (retry < MAX_SESS_ID_ATTEMPTS)
359 /* else - woops a session_id match */
361 * XXX We should also check the external cache -- but the probability of
362 * a collision is negligible, and we could not prevent the concurrent
363 * creation of sessions with identical IDs since we currently don't have
364 * means to atomically check whether a session ID already exists and make
365 * a reservation for it if it does not (this problem applies to the
366 * internal cache as well).
371 int ssl_get_new_session(SSL *s, int session)
373 /* This gets used by clients and servers. */
376 SSL_SESSION *ss = NULL;
377 GEN_SESSION_CB cb = def_generate_session_id;
379 if ((ss = SSL_SESSION_new()) == NULL)
382 /* If the context has a default timeout, use it */
383 if (s->session_ctx->session_timeout == 0)
384 ss->timeout = SSL_get_default_timeout(s);
386 ss->timeout = s->session_ctx->session_timeout;
388 SSL_SESSION_free(s->session);
392 if (s->version == SSL3_VERSION) {
393 ss->ssl_version = SSL3_VERSION;
394 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
395 } else if (s->version == TLS1_VERSION) {
396 ss->ssl_version = TLS1_VERSION;
397 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
398 } else if (s->version == TLS1_1_VERSION) {
399 ss->ssl_version = TLS1_1_VERSION;
400 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
401 } else if (s->version == TLS1_2_VERSION) {
402 ss->ssl_version = TLS1_2_VERSION;
403 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
404 } else if (s->version == DTLS1_BAD_VER) {
405 ss->ssl_version = DTLS1_BAD_VER;
406 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
407 } else if (s->version == DTLS1_VERSION) {
408 ss->ssl_version = DTLS1_VERSION;
409 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
410 } else if (s->version == DTLS1_2_VERSION) {
411 ss->ssl_version = DTLS1_2_VERSION;
412 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
414 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
415 SSL_SESSION_free(ss);
420 * If RFC5077 ticket, use empty session ID (as server).
422 * (a) ssl_get_prev_session() does lookahead into the
423 * ClientHello extensions to find the session ticket.
424 * When ssl_get_prev_session() fails, s3_srvr.c calls
425 * ssl_get_new_session() in ssl3_get_client_hello().
426 * At that point, it has not yet parsed the extensions,
427 * however, because of the lookahead, it already knows
428 * whether a ticket is expected or not.
430 * (b) s3_clnt.c calls ssl_get_new_session() before parsing
431 * ServerHello extensions, and before recording the session
432 * ID received from the server, so this block is a noop.
434 if (s->tlsext_ticket_expected) {
435 ss->session_id_length = 0;
439 /* Choose which callback will set the session ID */
440 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
441 if (s->generate_session_id)
442 cb = s->generate_session_id;
443 else if (s->session_ctx->generate_session_id)
444 cb = s->session_ctx->generate_session_id;
445 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
446 /* Choose a session ID */
447 tmp = ss->session_id_length;
448 if (!cb(s, ss->session_id, &tmp)) {
449 /* The callback failed */
450 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
451 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
452 SSL_SESSION_free(ss);
456 * Don't allow the callback to set the session length to zero. nor
457 * set it higher than it was.
459 if (tmp == 0 || tmp > ss->session_id_length) {
460 /* The callback set an illegal length */
461 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
462 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
463 SSL_SESSION_free(ss);
466 ss->session_id_length = tmp;
467 /* Finally, check for a conflict */
468 if (SSL_has_matching_session_id(s, ss->session_id,
469 ss->session_id_length)) {
470 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
471 SSL_SESSION_free(ss);
476 if (s->tlsext_hostname) {
477 ss->tlsext_hostname = OPENSSL_strdup(s->tlsext_hostname);
478 if (ss->tlsext_hostname == NULL) {
479 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
480 SSL_SESSION_free(ss);
485 ss->session_id_length = 0;
488 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
489 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
490 SSL_SESSION_free(ss);
493 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
494 ss->sid_ctx_length = s->sid_ctx_length;
496 ss->ssl_version = s->version;
497 ss->verify_result = X509_V_OK;
499 /* If client supports extended master secret set it in session */
500 if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)
501 ss->flags |= SSL_SESS_FLAG_EXTMS;
507 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
508 * connection. It is only called by servers.
510 * ext: ClientHello extensions (including length prefix)
511 * session_id: ClientHello session ID.
515 * 0: a session may have been found.
518 * - If a session is found then s->session is pointed at it (after freeing an
519 * existing session if need be) and s->verify_result is set from the session.
520 * - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
521 * if the server should issue a new session ticket (to 0 otherwise).
523 int ssl_get_prev_session(SSL *s, const PACKET *ext, const PACKET *session_id)
525 /* This is used only by servers. */
527 SSL_SESSION *ret = NULL;
529 int try_session_cache = 1;
532 if (PACKET_remaining(session_id) == 0)
533 try_session_cache = 0;
535 /* sets s->tlsext_ticket_expected and extended master secret flag */
536 r = tls_check_serverhello_tlsext_early(s, ext, session_id, &ret);
538 case -1: /* Error during processing */
541 case 0: /* No ticket found */
542 case 1: /* Zero length ticket found */
543 break; /* Ok to carry on processing session id. */
544 case 2: /* Ticket found but not decrypted. */
545 case 3: /* Ticket decrypted, *ret has been set. */
546 try_session_cache = 0;
552 if (try_session_cache &&
554 !(s->session_ctx->session_cache_mode &
555 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
558 data.ssl_version = s->version;
559 if (!PACKET_copy_all(session_id, data.session_id,
560 sizeof(data.session_id),
564 data.session_id_length = local_len;
565 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
566 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
568 /* don't allow other threads to steal it: */
569 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
571 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
573 s->session_ctx->stats.sess_miss++;
576 if (try_session_cache &&
577 ret == NULL && s->session_ctx->get_session_cb != NULL) {
579 ret = s->session_ctx->get_session_cb(s, PACKET_data(session_id),
580 PACKET_remaining(session_id),
584 s->session_ctx->stats.sess_cb_hit++;
587 * Increment reference count now if the session callback asks us
588 * to do so (note that if the session structures returned by the
589 * callback are shared between threads, it must handle the
590 * reference count itself [i.e. copy == 0], or things won't be
594 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
597 * Add the externally cached session to the internal cache as
598 * well if and only if we are supposed to.
601 (s->session_ctx->session_cache_mode &
602 SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
604 * The following should not return 1, otherwise, things are
607 if (SSL_CTX_add_session(s->session_ctx, ret))
616 /* Now ret is non-NULL and we own one of its reference counts. */
618 if (ret->sid_ctx_length != s->sid_ctx_length
619 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
621 * We have the session requested by the client, but we don't want to
622 * use it in this context.
624 goto err; /* treat like cache miss */
627 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
629 * We can't be sure if this session is being used out of context,
630 * which is especially important for SSL_VERIFY_PEER. The application
631 * should have used SSL[_CTX]_set_session_id_context. For this error
632 * case, we generate an error instead of treating the event like a
633 * cache miss (otherwise it would be easy for applications to
634 * effectively disable the session cache by accident without anyone
638 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
639 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
644 if (ret->cipher == NULL) {
645 unsigned char buf[5], *p;
651 if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
652 ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
654 ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
655 if (ret->cipher == NULL)
659 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
660 s->session_ctx->stats.sess_timeout++;
661 if (try_session_cache) {
662 /* session was from the cache, so remove it */
663 SSL_CTX_remove_session(s->session_ctx, ret);
668 /* Check extended master secret extension consistency */
669 if (ret->flags & SSL_SESS_FLAG_EXTMS) {
670 /* If old session includes extms, but new does not: abort handshake */
671 if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
672 SSLerr(SSL_F_SSL_GET_PREV_SESSION, SSL_R_INCONSISTENT_EXTMS);
673 ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
677 } else if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) {
678 /* If new session includes extms, but old does not: do not resume */
682 s->session_ctx->stats.sess_hit++;
684 SSL_SESSION_free(s->session);
686 s->verify_result = s->session->verify_result;
691 SSL_SESSION_free(ret);
693 if (!try_session_cache) {
695 * The session was from a ticket, so we should issue a ticket for
698 s->tlsext_ticket_expected = 1;
707 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
713 * add just 1 reference count for the SSL_CTX's session cache even though
714 * it has two ways of access: each session is in a doubly linked list and
717 CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
719 * if session c is in already in cache, we take back the increment later
722 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
723 s = lh_SSL_SESSION_insert(ctx->sessions, c);
726 * s != NULL iff we already had a session with the given PID. In this
727 * case, s == c should hold (then we did not really modify
728 * ctx->sessions), or we're in trouble.
730 if (s != NULL && s != c) {
731 /* We *are* in trouble ... */
732 SSL_SESSION_list_remove(ctx, s);
735 * ... so pretend the other session did not exist in cache (we cannot
736 * handle two SSL_SESSION structures with identical session ID in the
737 * same cache, which could happen e.g. when two threads concurrently
738 * obtain the same session from an external cache)
743 /* Put at the head of the queue unless it is already in the cache */
745 SSL_SESSION_list_add(ctx, c);
749 * existing cache entry -- decrement previously incremented reference
750 * count because it already takes into account the cache
753 SSL_SESSION_free(s); /* s == c */
757 * new cache entry -- remove old ones if cache has become too large
762 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
763 while (SSL_CTX_sess_number(ctx) >
764 SSL_CTX_sess_get_cache_size(ctx)) {
765 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
768 ctx->stats.sess_cache_full++;
772 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
776 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
778 return remove_session_lock(ctx, c, 1);
781 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
786 if ((c != NULL) && (c->session_id_length != 0)) {
788 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
789 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
791 r = lh_SSL_SESSION_delete(ctx->sessions, c);
792 SSL_SESSION_list_remove(ctx, c);
796 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
799 r->not_resumable = 1;
800 if (ctx->remove_session_cb != NULL)
801 ctx->remove_session_cb(ctx, r);
809 void SSL_SESSION_free(SSL_SESSION *ss)
816 i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
817 REF_PRINT_COUNT("SSL_SESSION", ss);
820 REF_ASSERT_ISNT(i < 0);
822 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
824 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
825 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
827 sk_X509_pop_free(ss->peer_chain, X509_free);
828 sk_SSL_CIPHER_free(ss->ciphers);
829 OPENSSL_free(ss->tlsext_hostname);
830 OPENSSL_free(ss->tlsext_tick);
831 #ifndef OPENSSL_NO_EC
832 ss->tlsext_ecpointformatlist_length = 0;
833 OPENSSL_free(ss->tlsext_ecpointformatlist);
834 ss->tlsext_ellipticcurvelist_length = 0;
835 OPENSSL_free(ss->tlsext_ellipticcurvelist);
836 #endif /* OPENSSL_NO_EC */
837 #ifndef OPENSSL_NO_PSK
838 OPENSSL_free(ss->psk_identity_hint);
839 OPENSSL_free(ss->psk_identity);
841 #ifndef OPENSSL_NO_SRP
842 OPENSSL_free(ss->srp_username);
844 OPENSSL_clear_free(ss, sizeof(*ss));
847 int SSL_set_session(SSL *s, SSL_SESSION *session)
850 const SSL_METHOD *meth;
852 if (session != NULL) {
853 meth = s->ctx->method->get_ssl_method(session->ssl_version);
855 meth = s->method->get_ssl_method(session->ssl_version);
857 SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
861 if (meth != s->method) {
862 if (!SSL_set_ssl_method(s, meth))
866 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
867 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
868 SSL_SESSION_free(s->session);
869 s->session = session;
870 s->verify_result = s->session->verify_result;
871 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
874 SSL_SESSION_free(s->session);
876 meth = s->ctx->method;
877 if (meth != s->method) {
878 if (!SSL_set_ssl_method(s, meth))
886 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
894 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
901 long SSL_SESSION_get_time(const SSL_SESSION *s)
908 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
916 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
918 return (s->tlsext_ticklen > 0) ? 1 : 0;
921 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
923 return s->tlsext_tick_lifetime_hint;
926 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, unsigned char **tick,
929 *len = s->tlsext_ticklen;
931 *tick = s->tlsext_tick;
934 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
939 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
940 unsigned int sid_ctx_len)
942 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
943 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
944 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
947 s->sid_ctx_length = sid_ctx_len;
948 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
953 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
958 l = s->session_timeout;
959 s->session_timeout = t;
963 long SSL_CTX_get_timeout(const SSL_CTX *s)
967 return (s->session_timeout);
970 int SSL_set_session_secret_cb(SSL *s,
971 int (*tls_session_secret_cb) (SSL *s,
983 s->tls_session_secret_cb = tls_session_secret_cb;
984 s->tls_session_secret_cb_arg = arg;
988 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
993 s->tls_session_ticket_ext_cb = cb;
994 s->tls_session_ticket_ext_cb_arg = arg;
998 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1000 if (s->version >= TLS1_VERSION) {
1001 OPENSSL_free(s->tlsext_session_ticket);
1002 s->tlsext_session_ticket = NULL;
1003 s->tlsext_session_ticket =
1004 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1005 if (s->tlsext_session_ticket == NULL) {
1006 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
1011 s->tlsext_session_ticket->length = ext_len;
1012 s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
1013 memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
1015 s->tlsext_session_ticket->length = 0;
1016 s->tlsext_session_ticket->data = NULL;
1025 typedef struct timeout_param_st {
1028 LHASH_OF(SSL_SESSION) *cache;
1031 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
1033 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1035 * The reason we don't call SSL_CTX_remove_session() is to save on
1038 (void)lh_SSL_SESSION_delete(p->cache, s);
1039 SSL_SESSION_list_remove(p->ctx, s);
1040 s->not_resumable = 1;
1041 if (p->ctx->remove_session_cb != NULL)
1042 p->ctx->remove_session_cb(p->ctx, s);
1043 SSL_SESSION_free(s);
1047 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
1049 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1055 tp.cache = s->sessions;
1056 if (tp.cache == NULL)
1059 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
1060 i = CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
1061 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = 0;
1062 lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1063 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = i;
1064 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
1067 int ssl_clear_bad_session(SSL *s)
1069 if ((s->session != NULL) &&
1070 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1071 !(SSL_in_init(s) || SSL_in_before(s))) {
1072 SSL_CTX_remove_session(s->ctx, s->session);
1078 /* locked by SSL_CTX in the calling function */
1079 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1081 if ((s->next == NULL) || (s->prev == NULL))
1084 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1085 /* last element in list */
1086 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1087 /* only one element in list */
1088 ctx->session_cache_head = NULL;
1089 ctx->session_cache_tail = NULL;
1091 ctx->session_cache_tail = s->prev;
1092 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1095 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1096 /* first element in list */
1097 ctx->session_cache_head = s->next;
1098 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1100 /* middle of list */
1101 s->next->prev = s->prev;
1102 s->prev->next = s->next;
1105 s->prev = s->next = NULL;
1108 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1110 if ((s->next != NULL) && (s->prev != NULL))
1111 SSL_SESSION_list_remove(ctx, s);
1113 if (ctx->session_cache_head == NULL) {
1114 ctx->session_cache_head = s;
1115 ctx->session_cache_tail = s;
1116 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1117 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1119 s->next = ctx->session_cache_head;
1121 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1122 ctx->session_cache_head = s;
1126 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1127 int (*cb) (struct ssl_st *ssl,
1130 ctx->new_session_cb = cb;
1133 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1134 return ctx->new_session_cb;
1137 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1138 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1140 ctx->remove_session_cb = cb;
1143 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1144 SSL_SESSION *sess) {
1145 return ctx->remove_session_cb;
1148 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1149 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1150 const unsigned char *data,
1151 int len, int *copy))
1153 ctx->get_session_cb = cb;
1156 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1157 const unsigned char *data,
1158 int len, int *copy) {
1159 return ctx->get_session_cb;
1162 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1163 void (*cb) (const SSL *ssl, int type, int val))
1165 ctx->info_callback = cb;
1168 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1170 return ctx->info_callback;
1173 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1174 int (*cb) (SSL *ssl, X509 **x509,
1177 ctx->client_cert_cb = cb;
1180 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1182 return ctx->client_cert_cb;
1185 #ifndef OPENSSL_NO_ENGINE
1186 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1188 if (!ENGINE_init(e)) {
1189 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1192 if (!ENGINE_get_ssl_client_cert_function(e)) {
1193 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1194 SSL_R_NO_CLIENT_CERT_METHOD);
1198 ctx->client_cert_engine = e;
1203 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1204 int (*cb) (SSL *ssl,
1205 unsigned char *cookie,
1206 unsigned int *cookie_len))
1208 ctx->app_gen_cookie_cb = cb;
1211 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1212 int (*cb) (SSL *ssl, const unsigned char *cookie,
1213 unsigned int cookie_len))
1215 ctx->app_verify_cookie_cb = cb;
1218 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION,