2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
58 /* ====================================================================
59 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
111 /* ====================================================================
112 * Copyright 2005 Nokia. All rights reserved.
114 * The portions of the attached software ("Contribution") is developed by
115 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
118 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
119 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
120 * support (see RFC 4279) to OpenSSL.
122 * No patent licenses or other rights except those expressly stated in
123 * the OpenSSL open source license shall be deemed granted or received
124 * expressly, by implication, estoppel, or otherwise.
126 * No assurances are provided by Nokia that the Contribution does not
127 * infringe the patent or other intellectual property rights of any third
128 * party or that the license provides you with all the necessary rights
129 * to make use of the Contribution.
131 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
132 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
133 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
134 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
139 #include <openssl/lhash.h>
140 #include <openssl/rand.h>
141 #ifndef OPENSSL_NO_ENGINE
142 # include <openssl/engine.h>
144 #include "ssl_locl.h"
146 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
147 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
148 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
150 SSL_SESSION *SSL_get_session(const SSL *ssl)
151 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
153 return (ssl->session);
156 SSL_SESSION *SSL_get1_session(SSL *ssl)
157 /* variant of SSL_get_session: caller really gets something */
161 * Need to lock this all up rather than just use CRYPTO_add so that
162 * somebody doesn't free ssl->session between when we check it's non-null
163 * and when we up the reference count.
165 CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION);
169 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
173 int SSL_SESSION_get_ex_new_index(long argl, void *argp,
174 CRYPTO_EX_new *new_func,
175 CRYPTO_EX_dup *dup_func,
176 CRYPTO_EX_free *free_func)
178 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, argl, argp,
179 new_func, dup_func, free_func);
182 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
184 return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
187 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
189 return (CRYPTO_get_ex_data(&s->ex_data, idx));
192 SSL_SESSION *SSL_SESSION_new(void)
196 ss = OPENSSL_malloc(sizeof(*ss));
198 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
201 memset(ss, 0, sizeof(*ss));
203 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
205 ss->timeout = 60 * 5 + 4; /* 5 minute timeout by default */
206 ss->time = (unsigned long)time(NULL);
209 ss->compress_meth = 0;
210 ss->tlsext_hostname = NULL;
211 #ifndef OPENSSL_NO_EC
212 ss->tlsext_ecpointformatlist_length = 0;
213 ss->tlsext_ecpointformatlist = NULL;
214 ss->tlsext_ellipticcurvelist_length = 0;
215 ss->tlsext_ellipticcurvelist = NULL;
217 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
218 #ifndef OPENSSL_NO_PSK
219 ss->psk_identity_hint = NULL;
220 ss->psk_identity = NULL;
222 #ifndef OPENSSL_NO_SRP
223 ss->srp_username = NULL;
229 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
230 * ticket == 0 then no ticket information is duplicated, otherwise it is.
232 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
236 dest = OPENSSL_malloc(sizeof(*src));
240 memcpy(dest, src, sizeof(*dest));
243 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
244 * the case of an error whilst halfway through constructing dest
246 #ifndef OPENSSL_NO_PSK
247 dest->psk_identity_hint = NULL;
248 dest->psk_identity = NULL;
250 dest->ciphers = NULL;
251 dest->tlsext_hostname = NULL;
252 #ifndef OPENSSL_NO_EC
253 dest->tlsext_ecpointformatlist = NULL;
254 dest->tlsext_ellipticcurvelist = NULL;
256 dest->tlsext_tick = NULL;
257 #ifndef OPENSSL_NO_SRP
258 dest->srp_username = NULL;
260 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
262 /* We deliberately don't copy the prev and next pointers */
266 dest->references = 1;
268 if (src->sess_cert != NULL)
269 CRYPTO_add(&src->sess_cert->references, 1, CRYPTO_LOCK_SSL_SESS_CERT);
271 if (src->peer != NULL)
272 CRYPTO_add(&src->peer->references, 1, CRYPTO_LOCK_X509);
274 #ifndef OPENSSL_NO_PSK
275 if (src->psk_identity_hint) {
276 dest->psk_identity_hint = BUF_strdup(src->psk_identity_hint);
277 if (dest->psk_identity_hint == NULL) {
281 if (src->psk_identity) {
282 dest->psk_identity = BUF_strdup(src->psk_identity);
283 if (dest->psk_identity == NULL) {
289 if(src->ciphers != NULL) {
290 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
291 if (dest->ciphers == NULL)
295 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
296 &dest->ex_data, &src->ex_data)) {
300 if (src->tlsext_hostname) {
301 dest->tlsext_hostname = BUF_strdup(src->tlsext_hostname);
302 if (dest->tlsext_hostname == NULL) {
306 #ifndef OPENSSL_NO_EC
307 if (src->tlsext_ecpointformatlist) {
308 dest->tlsext_ecpointformatlist =
309 BUF_memdup(src->tlsext_ecpointformatlist,
310 src->tlsext_ecpointformatlist_length);
311 if (dest->tlsext_ecpointformatlist == NULL)
314 if (src->tlsext_ellipticcurvelist) {
315 dest->tlsext_ellipticcurvelist =
316 BUF_memdup(src->tlsext_ellipticcurvelist,
317 src->tlsext_ellipticcurvelist_length);
318 if (dest->tlsext_ellipticcurvelist == NULL)
324 dest->tlsext_tick = BUF_memdup(src->tlsext_tick, src->tlsext_ticklen);
325 if(dest->tlsext_tick == NULL)
328 dest->tlsext_tick_lifetime_hint = 0;
329 dest->tlsext_ticklen = 0;
332 #ifndef OPENSSL_NO_SRP
333 if (src->srp_username) {
334 dest->srp_username = BUF_strdup(src->srp_username);
335 if (dest->srp_username == NULL) {
343 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
344 SSL_SESSION_free(dest);
348 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
352 *len = s->session_id_length;
353 return s->session_id;
356 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
358 return s->compress_meth;
362 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
363 * the ID with random junk repeatedly until we have no conflict is going to
364 * complete in one iteration pretty much "most" of the time (btw:
365 * understatement). So, if it takes us 10 iterations and we still can't avoid
366 * a conflict - well that's a reasonable point to call it quits. Either the
367 * RAND code is broken or someone is trying to open roughly very close to
368 * 2^256 SSL sessions to our server. How you might store that many sessions
369 * is perhaps a more interesting question ...
372 #define MAX_SESS_ID_ATTEMPTS 10
373 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
374 unsigned int *id_len)
376 unsigned int retry = 0;
378 if (RAND_bytes(id, *id_len) <= 0)
380 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
381 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
382 if (retry < MAX_SESS_ID_ATTEMPTS)
384 /* else - woops a session_id match */
386 * XXX We should also check the external cache -- but the probability of
387 * a collision is negligible, and we could not prevent the concurrent
388 * creation of sessions with identical IDs since we currently don't have
389 * means to atomically check whether a session ID already exists and make
390 * a reservation for it if it does not (this problem applies to the
391 * internal cache as well).
396 int ssl_get_new_session(SSL *s, int session)
398 /* This gets used by clients and servers. */
401 SSL_SESSION *ss = NULL;
402 GEN_SESSION_CB cb = def_generate_session_id;
404 if ((ss = SSL_SESSION_new()) == NULL)
407 /* If the context has a default timeout, use it */
408 if (s->session_ctx->session_timeout == 0)
409 ss->timeout = SSL_get_default_timeout(s);
411 ss->timeout = s->session_ctx->session_timeout;
413 SSL_SESSION_free(s->session);
417 if (s->version == SSL3_VERSION) {
418 ss->ssl_version = SSL3_VERSION;
419 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
420 } else if (s->version == TLS1_VERSION) {
421 ss->ssl_version = TLS1_VERSION;
422 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
423 } else if (s->version == TLS1_1_VERSION) {
424 ss->ssl_version = TLS1_1_VERSION;
425 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
426 } else if (s->version == TLS1_2_VERSION) {
427 ss->ssl_version = TLS1_2_VERSION;
428 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
429 } else if (s->version == DTLS1_BAD_VER) {
430 ss->ssl_version = DTLS1_BAD_VER;
431 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
432 } else if (s->version == DTLS1_VERSION) {
433 ss->ssl_version = DTLS1_VERSION;
434 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
435 } else if (s->version == DTLS1_2_VERSION) {
436 ss->ssl_version = DTLS1_2_VERSION;
437 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
439 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
440 SSL_SESSION_free(ss);
445 * If RFC5077 ticket, use empty session ID (as server).
447 * (a) ssl_get_prev_session() does lookahead into the
448 * ClientHello extensions to find the session ticket.
449 * When ssl_get_prev_session() fails, s3_srvr.c calls
450 * ssl_get_new_session() in ssl3_get_client_hello().
451 * At that point, it has not yet parsed the extensions,
452 * however, because of the lookahead, it already knows
453 * whether a ticket is expected or not.
455 * (b) s3_clnt.c calls ssl_get_new_session() before parsing
456 * ServerHello extensions, and before recording the session
457 * ID received from the server, so this block is a noop.
459 if (s->tlsext_ticket_expected) {
460 ss->session_id_length = 0;
464 /* Choose which callback will set the session ID */
465 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
466 if (s->generate_session_id)
467 cb = s->generate_session_id;
468 else if (s->session_ctx->generate_session_id)
469 cb = s->session_ctx->generate_session_id;
470 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
471 /* Choose a session ID */
472 tmp = ss->session_id_length;
473 if (!cb(s, ss->session_id, &tmp)) {
474 /* The callback failed */
475 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
476 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
477 SSL_SESSION_free(ss);
481 * Don't allow the callback to set the session length to zero. nor
482 * set it higher than it was.
484 if (!tmp || (tmp > ss->session_id_length)) {
485 /* The callback set an illegal length */
486 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
487 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
488 SSL_SESSION_free(ss);
491 ss->session_id_length = tmp;
492 /* Finally, check for a conflict */
493 if (SSL_has_matching_session_id(s, ss->session_id,
494 ss->session_id_length)) {
495 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
496 SSL_SESSION_free(ss);
501 if (s->tlsext_hostname) {
502 ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
503 if (ss->tlsext_hostname == NULL) {
504 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
505 SSL_SESSION_free(ss);
510 ss->session_id_length = 0;
513 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
514 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
515 SSL_SESSION_free(ss);
518 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
519 ss->sid_ctx_length = s->sid_ctx_length;
521 ss->ssl_version = s->version;
522 ss->verify_result = X509_V_OK;
528 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
529 * connection. It is only called by servers.
531 * session_id: points at the session ID in the ClientHello. This code will
532 * read past the end of this in order to parse out the session ticket
534 * len: the length of the session ID.
535 * limit: a pointer to the first byte after the ClientHello.
539 * 0: a session may have been found.
542 * - If a session is found then s->session is pointed at it (after freeing an
543 * existing session if need be) and s->verify_result is set from the session.
544 * - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
545 * if the server should issue a new session ticket (to 0 otherwise).
547 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
548 const unsigned char *limit)
550 /* This is used only by servers. */
552 SSL_SESSION *ret = NULL;
554 int try_session_cache = 1;
557 if (len < 0 || len > SSL_MAX_SSL_SESSION_ID_LENGTH)
560 if (session_id + len > limit) {
566 try_session_cache = 0;
568 /* sets s->tlsext_ticket_expected */
569 r = tls1_process_ticket(s, session_id, len, limit, &ret);
571 case -1: /* Error during processing */
574 case 0: /* No ticket found */
575 case 1: /* Zero length ticket found */
576 break; /* Ok to carry on processing session id. */
577 case 2: /* Ticket found but not decrypted. */
578 case 3: /* Ticket decrypted, *ret has been set. */
579 try_session_cache = 0;
585 if (try_session_cache &&
587 !(s->session_ctx->session_cache_mode &
588 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
590 data.ssl_version = s->version;
591 data.session_id_length = len;
594 memcpy(data.session_id, session_id, len);
595 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
596 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
598 /* don't allow other threads to steal it: */
599 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
601 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
603 s->session_ctx->stats.sess_miss++;
606 if (try_session_cache &&
607 ret == NULL && s->session_ctx->get_session_cb != NULL) {
610 if ((ret = s->session_ctx->get_session_cb(s, session_id, len, ©))) {
611 s->session_ctx->stats.sess_cb_hit++;
614 * Increment reference count now if the session callback asks us
615 * to do so (note that if the session structures returned by the
616 * callback are shared between threads, it must handle the
617 * reference count itself [i.e. copy == 0], or things won't be
621 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
624 * Add the externally cached session to the internal cache as
625 * well if and only if we are supposed to.
628 (s->session_ctx->session_cache_mode &
629 SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
631 * The following should not return 1, otherwise, things are
634 if (SSL_CTX_add_session(s->session_ctx, ret))
643 /* Now ret is non-NULL and we own one of its reference counts. */
645 if (ret->sid_ctx_length != s->sid_ctx_length
646 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
648 * We have the session requested by the client, but we don't want to
649 * use it in this context.
651 goto err; /* treat like cache miss */
654 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
656 * We can't be sure if this session is being used out of context,
657 * which is especially important for SSL_VERIFY_PEER. The application
658 * should have used SSL[_CTX]_set_session_id_context. For this error
659 * case, we generate an error instead of treating the event like a
660 * cache miss (otherwise it would be easy for applications to
661 * effectively disable the session cache by accident without anyone
665 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
666 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
671 if (ret->cipher == NULL) {
672 unsigned char buf[5], *p;
678 if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
679 ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
681 ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
682 if (ret->cipher == NULL)
686 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
687 s->session_ctx->stats.sess_timeout++;
688 if (try_session_cache) {
689 /* session was from the cache, so remove it */
690 SSL_CTX_remove_session(s->session_ctx, ret);
695 s->session_ctx->stats.sess_hit++;
697 SSL_SESSION_free(s->session);
699 s->verify_result = s->session->verify_result;
704 SSL_SESSION_free(ret);
706 if (!try_session_cache) {
708 * The session was from a ticket, so we should issue a ticket for
711 s->tlsext_ticket_expected = 1;
720 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
726 * add just 1 reference count for the SSL_CTX's session cache even though
727 * it has two ways of access: each session is in a doubly linked list and
730 CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
732 * if session c is in already in cache, we take back the increment later
735 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
736 s = lh_SSL_SESSION_insert(ctx->sessions, c);
739 * s != NULL iff we already had a session with the given PID. In this
740 * case, s == c should hold (then we did not really modify
741 * ctx->sessions), or we're in trouble.
743 if (s != NULL && s != c) {
744 /* We *are* in trouble ... */
745 SSL_SESSION_list_remove(ctx, s);
748 * ... so pretend the other session did not exist in cache (we cannot
749 * handle two SSL_SESSION structures with identical session ID in the
750 * same cache, which could happen e.g. when two threads concurrently
751 * obtain the same session from an external cache)
756 /* Put at the head of the queue unless it is already in the cache */
758 SSL_SESSION_list_add(ctx, c);
762 * existing cache entry -- decrement previously incremented reference
763 * count because it already takes into account the cache
766 SSL_SESSION_free(s); /* s == c */
770 * new cache entry -- remove old ones if cache has become too large
775 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
776 while (SSL_CTX_sess_number(ctx) >
777 SSL_CTX_sess_get_cache_size(ctx)) {
778 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
781 ctx->stats.sess_cache_full++;
785 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
789 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
791 return remove_session_lock(ctx, c, 1);
794 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
799 if ((c != NULL) && (c->session_id_length != 0)) {
801 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
802 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
804 r = lh_SSL_SESSION_delete(ctx->sessions, c);
805 SSL_SESSION_list_remove(ctx, c);
809 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
812 r->not_resumable = 1;
813 if (ctx->remove_session_cb != NULL)
814 ctx->remove_session_cb(ctx, r);
822 void SSL_SESSION_free(SSL_SESSION *ss)
829 i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
831 REF_PRINT("SSL_SESSION", ss);
837 fprintf(stderr, "SSL_SESSION_free, bad reference count\n");
842 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
844 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
845 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
846 ssl_sess_cert_free(ss->sess_cert);
848 sk_SSL_CIPHER_free(ss->ciphers);
849 OPENSSL_free(ss->tlsext_hostname);
850 OPENSSL_free(ss->tlsext_tick);
851 #ifndef OPENSSL_NO_EC
852 ss->tlsext_ecpointformatlist_length = 0;
853 OPENSSL_free(ss->tlsext_ecpointformatlist);
854 ss->tlsext_ellipticcurvelist_length = 0;
855 OPENSSL_free(ss->tlsext_ellipticcurvelist);
856 #endif /* OPENSSL_NO_EC */
857 #ifndef OPENSSL_NO_PSK
858 OPENSSL_free(ss->psk_identity_hint);
859 OPENSSL_free(ss->psk_identity);
861 #ifndef OPENSSL_NO_SRP
862 OPENSSL_free(ss->srp_username);
864 OPENSSL_clear_free(ss, sizeof(*ss));
867 int SSL_set_session(SSL *s, SSL_SESSION *session)
870 const SSL_METHOD *meth;
872 if (session != NULL) {
873 meth = s->ctx->method->get_ssl_method(session->ssl_version);
875 meth = s->method->get_ssl_method(session->ssl_version);
877 SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
881 if (meth != s->method) {
882 if (!SSL_set_ssl_method(s, meth))
886 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
887 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
888 SSL_SESSION_free(s->session);
889 s->session = session;
890 s->verify_result = s->session->verify_result;
891 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
894 SSL_SESSION_free(s->session);
896 meth = s->ctx->method;
897 if (meth != s->method) {
898 if (!SSL_set_ssl_method(s, meth))
906 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
914 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
921 long SSL_SESSION_get_time(const SSL_SESSION *s)
928 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
936 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
938 return (s->tlsext_ticklen > 0) ? 1 : 0;
941 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
943 return s->tlsext_tick_lifetime_hint;
946 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, unsigned char **tick,
949 *len = s->tlsext_ticklen;
951 *tick = s->tlsext_tick;
954 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
959 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
960 unsigned int sid_ctx_len)
962 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
963 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
964 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
967 s->sid_ctx_length = sid_ctx_len;
968 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
973 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
978 l = s->session_timeout;
979 s->session_timeout = t;
983 long SSL_CTX_get_timeout(const SSL_CTX *s)
987 return (s->session_timeout);
990 int SSL_set_session_secret_cb(SSL *s,
991 int (*tls_session_secret_cb) (SSL *s,
1003 s->tls_session_secret_cb = tls_session_secret_cb;
1004 s->tls_session_secret_cb_arg = arg;
1008 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
1013 s->tls_session_ticket_ext_cb = cb;
1014 s->tls_session_ticket_ext_cb_arg = arg;
1018 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1020 if (s->version >= TLS1_VERSION) {
1021 OPENSSL_free(s->tlsext_session_ticket);
1022 s->tlsext_session_ticket = NULL;
1023 s->tlsext_session_ticket =
1024 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1025 if (!s->tlsext_session_ticket) {
1026 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
1031 s->tlsext_session_ticket->length = ext_len;
1032 s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
1033 memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
1035 s->tlsext_session_ticket->length = 0;
1036 s->tlsext_session_ticket->data = NULL;
1045 typedef struct timeout_param_st {
1048 LHASH_OF(SSL_SESSION) *cache;
1051 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
1053 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1055 * The reason we don't call SSL_CTX_remove_session() is to save on
1058 (void)lh_SSL_SESSION_delete(p->cache, s);
1059 SSL_SESSION_list_remove(p->ctx, s);
1060 s->not_resumable = 1;
1061 if (p->ctx->remove_session_cb != NULL)
1062 p->ctx->remove_session_cb(p->ctx, s);
1063 SSL_SESSION_free(s);
1067 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
1069 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1075 tp.cache = s->sessions;
1076 if (tp.cache == NULL)
1079 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
1080 i = CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
1081 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = 0;
1082 lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
1083 TIMEOUT_PARAM, &tp);
1084 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = i;
1085 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
1088 int ssl_clear_bad_session(SSL *s)
1090 if ((s->session != NULL) &&
1091 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1092 !(SSL_in_init(s) || SSL_in_before(s))) {
1093 SSL_CTX_remove_session(s->ctx, s->session);
1099 /* locked by SSL_CTX in the calling function */
1100 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1102 if ((s->next == NULL) || (s->prev == NULL))
1105 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1106 /* last element in list */
1107 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1108 /* only one element in list */
1109 ctx->session_cache_head = NULL;
1110 ctx->session_cache_tail = NULL;
1112 ctx->session_cache_tail = s->prev;
1113 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1116 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1117 /* first element in list */
1118 ctx->session_cache_head = s->next;
1119 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1121 /* middle of list */
1122 s->next->prev = s->prev;
1123 s->prev->next = s->next;
1126 s->prev = s->next = NULL;
1129 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1131 if ((s->next != NULL) && (s->prev != NULL))
1132 SSL_SESSION_list_remove(ctx, s);
1134 if (ctx->session_cache_head == NULL) {
1135 ctx->session_cache_head = s;
1136 ctx->session_cache_tail = s;
1137 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1138 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1140 s->next = ctx->session_cache_head;
1142 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1143 ctx->session_cache_head = s;
1147 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1148 int (*cb) (struct ssl_st *ssl,
1151 ctx->new_session_cb = cb;
1154 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1155 return ctx->new_session_cb;
1158 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1159 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1161 ctx->remove_session_cb = cb;
1164 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1165 SSL_SESSION *sess) {
1166 return ctx->remove_session_cb;
1169 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1170 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1171 unsigned char *data, int len,
1174 ctx->get_session_cb = cb;
1177 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1178 unsigned char *data,
1179 int len, int *copy) {
1180 return ctx->get_session_cb;
1183 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1184 void (*cb) (const SSL *ssl, int type, int val))
1186 ctx->info_callback = cb;
1189 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1191 return ctx->info_callback;
1194 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1195 int (*cb) (SSL *ssl, X509 **x509,
1198 ctx->client_cert_cb = cb;
1201 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1203 return ctx->client_cert_cb;
1206 #ifndef OPENSSL_NO_ENGINE
1207 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1209 if (!ENGINE_init(e)) {
1210 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1213 if (!ENGINE_get_ssl_client_cert_function(e)) {
1214 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1215 SSL_R_NO_CLIENT_CERT_METHOD);
1219 ctx->client_cert_engine = e;
1224 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1225 int (*cb) (SSL *ssl,
1226 unsigned char *cookie,
1227 unsigned int *cookie_len))
1229 ctx->app_gen_cookie_cb = cb;
1232 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1233 int (*cb) (SSL *ssl, unsigned char *cookie,
1234 unsigned int cookie_len))
1236 ctx->app_verify_cookie_cb = cb;
1239 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION,