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 = (SSL_SESSION *)OPENSSL_malloc(sizeof(SSL_SESSION));
198 SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
201 memset(ss, 0, sizeof(SSL_SESSION));
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 #ifndef OPENSSL_NO_TLSEXT
211 ss->tlsext_hostname = NULL;
212 # ifndef OPENSSL_NO_EC
213 ss->tlsext_ecpointformatlist_length = 0;
214 ss->tlsext_ecpointformatlist = NULL;
215 ss->tlsext_ellipticcurvelist_length = 0;
216 ss->tlsext_ellipticcurvelist = NULL;
219 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
220 #ifndef OPENSSL_NO_PSK
221 ss->psk_identity_hint = NULL;
222 ss->psk_identity = NULL;
224 #ifndef OPENSSL_NO_SRP
225 ss->srp_username = NULL;
231 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
232 * ticket == 0 then no ticket information is duplicated, otherwise it is.
234 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
238 dest = OPENSSL_malloc(sizeof(*src));
242 memcpy(dest, src, sizeof(*dest));
244 #ifndef OPENSSL_NO_KRB5
245 dest->krb5_client_princ_len = src->krb5_client_princ_len;
246 if (src->krb5_client_princ_len > 0)
247 memcpy(dest->krb5_client_princ, src->krb5_client_princ,
248 src->krb5_client_princ_len);
251 #ifndef OPENSSL_NO_PSK
252 if (src->psk_identity_hint) {
253 dest->psk_identity_hint = BUF_strdup(src->psk_identity_hint);
254 if (dest->psk_identity_hint == NULL) {
258 dest->psk_identity_hint = NULL;
260 if (src->psk_identity) {
261 dest->psk_identity = BUF_strdup(src->psk_identity);
262 if (dest->psk_identity == NULL) {
266 dest->psk_identity = NULL;
270 if (src->sess_cert != NULL)
271 CRYPTO_add(&src->sess_cert->references, 1, CRYPTO_LOCK_SSL_SESS_CERT);
273 if (src->peer != NULL)
274 CRYPTO_add(&src->peer->references, 1, CRYPTO_LOCK_X509);
276 dest->references = 1;
278 if(src->ciphers != NULL) {
279 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
280 if (dest->ciphers == NULL)
283 dest->ciphers = NULL;
286 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
287 &dest->ex_data, &src->ex_data)) {
291 /* We deliberately don't copy the prev and next pointers */
295 #ifndef OPENSSL_NO_TLSEXT
296 if (src->tlsext_hostname) {
297 dest->tlsext_hostname = BUF_strdup(src->tlsext_hostname);
298 if (dest->tlsext_hostname == NULL) {
302 dest->tlsext_hostname = NULL;
304 # ifndef OPENSSL_NO_EC
305 if (src->tlsext_ecpointformatlist) {
306 dest->tlsext_ecpointformatlist =
307 BUF_memdup(src->tlsext_ecpointformatlist,
308 src->tlsext_ecpointformatlist_length);
309 if (dest->tlsext_ecpointformatlist == NULL)
311 dest->tlsext_ecpointformatlist_length =
312 src->tlsext_ecpointformatlist_length;
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)
320 dest->tlsext_ellipticcurvelist_length =
321 src->tlsext_ellipticcurvelist_length;
327 dest->tlsext_tick_lifetime_hint = src->tlsext_tick_lifetime_hint;
328 dest->tlsext_ticklen = src->tlsext_ticklen;
329 if((dest->tlsext_tick = OPENSSL_malloc(src->tlsext_ticklen)) == NULL) {
334 #ifndef OPENSSL_NO_SRP
335 dest->srp_username = NULL;
336 if (src->srp_username) {
337 dest->srp_username = BUF_strdup(src->srp_username);
338 if (dest->srp_username == NULL) {
342 dest->srp_username = NULL;
348 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
349 SSL_SESSION_free(dest);
353 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
357 *len = s->session_id_length;
358 return s->session_id;
361 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
363 return s->compress_meth;
367 * Even with SSLv2, we have 16 bytes (128 bits) of session ID space.
368 * SSLv3/TLSv1 has 32 bytes (256 bits). As such, filling the ID with random
369 * gunk repeatedly until we have no conflict is going to complete in one
370 * iteration pretty much "most" of the time (btw: understatement). So, if it
371 * takes us 10 iterations and we still can't avoid a conflict - well that's a
372 * reasonable point to call it quits. Either the RAND code is broken or
373 * someone is trying to open roughly very close to 2^128 (or 2^256) SSL
374 * sessions to our server. How you might store that many sessions is perhaps
375 * a more interesting question ...
378 #define MAX_SESS_ID_ATTEMPTS 10
379 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
380 unsigned int *id_len)
382 unsigned int retry = 0;
384 if (RAND_pseudo_bytes(id, *id_len) <= 0)
386 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
387 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
388 if (retry < MAX_SESS_ID_ATTEMPTS)
390 /* else - woops a session_id match */
392 * XXX We should also check the external cache -- but the probability of
393 * a collision is negligible, and we could not prevent the concurrent
394 * creation of sessions with identical IDs since we currently don't have
395 * means to atomically check whether a session ID already exists and make
396 * a reservation for it if it does not (this problem applies to the
397 * internal cache as well).
402 int ssl_get_new_session(SSL *s, int session)
404 /* This gets used by clients and servers. */
407 SSL_SESSION *ss = NULL;
408 GEN_SESSION_CB cb = def_generate_session_id;
410 if ((ss = SSL_SESSION_new()) == NULL)
413 /* If the context has a default timeout, use it */
414 if (s->session_ctx->session_timeout == 0)
415 ss->timeout = SSL_get_default_timeout(s);
417 ss->timeout = s->session_ctx->session_timeout;
419 if (s->session != NULL) {
420 SSL_SESSION_free(s->session);
425 if (s->version == SSL2_VERSION) {
426 ss->ssl_version = SSL2_VERSION;
427 ss->session_id_length = SSL2_SSL_SESSION_ID_LENGTH;
428 } else if (s->version == SSL3_VERSION) {
429 ss->ssl_version = SSL3_VERSION;
430 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
431 } else if (s->version == TLS1_VERSION) {
432 ss->ssl_version = TLS1_VERSION;
433 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
434 } else if (s->version == TLS1_1_VERSION) {
435 ss->ssl_version = TLS1_1_VERSION;
436 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
437 } else if (s->version == TLS1_2_VERSION) {
438 ss->ssl_version = TLS1_2_VERSION;
439 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
440 } else if (s->version == DTLS1_BAD_VER) {
441 ss->ssl_version = DTLS1_BAD_VER;
442 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
443 } else if (s->version == DTLS1_VERSION) {
444 ss->ssl_version = DTLS1_VERSION;
445 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
446 } else if (s->version == DTLS1_2_VERSION) {
447 ss->ssl_version = DTLS1_2_VERSION;
448 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
450 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
451 SSL_SESSION_free(ss);
454 #ifndef OPENSSL_NO_TLSEXT
456 * If RFC5077 ticket, use empty session ID (as server).
458 * (a) ssl_get_prev_session() does lookahead into the
459 * ClientHello extensions to find the session ticket.
460 * When ssl_get_prev_session() fails, s3_srvr.c calls
461 * ssl_get_new_session() in ssl3_get_client_hello().
462 * At that point, it has not yet parsed the extensions,
463 * however, because of the lookahead, it already knows
464 * whether a ticket is expected or not.
466 * (b) s3_clnt.c calls ssl_get_new_session() before parsing
467 * ServerHello extensions, and before recording the session
468 * ID received from the server, so this block is a noop.
470 if (s->tlsext_ticket_expected) {
471 ss->session_id_length = 0;
475 /* Choose which callback will set the session ID */
476 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
477 if (s->generate_session_id)
478 cb = s->generate_session_id;
479 else if (s->session_ctx->generate_session_id)
480 cb = s->session_ctx->generate_session_id;
481 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
482 /* Choose a session ID */
483 tmp = ss->session_id_length;
484 if (!cb(s, ss->session_id, &tmp)) {
485 /* The callback failed */
486 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
487 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
488 SSL_SESSION_free(ss);
492 * Don't allow the callback to set the session length to zero. nor
493 * set it higher than it was.
495 if (!tmp || (tmp > ss->session_id_length)) {
496 /* The callback set an illegal length */
497 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
498 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
499 SSL_SESSION_free(ss);
502 /* If the session length was shrunk and we're SSLv2, pad it */
503 if ((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
504 memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
506 ss->session_id_length = tmp;
507 /* Finally, check for a conflict */
508 if (SSL_has_matching_session_id(s, ss->session_id,
509 ss->session_id_length)) {
510 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
511 SSL_SESSION_free(ss);
514 #ifndef OPENSSL_NO_TLSEXT
516 if (s->tlsext_hostname) {
517 ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
518 if (ss->tlsext_hostname == NULL) {
519 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
520 SSL_SESSION_free(ss);
526 ss->session_id_length = 0;
529 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
530 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
531 SSL_SESSION_free(ss);
534 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
535 ss->sid_ctx_length = s->sid_ctx_length;
537 ss->ssl_version = s->version;
538 ss->verify_result = X509_V_OK;
544 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
545 * connection. It is only called by servers.
547 * session_id: points at the session ID in the ClientHello. This code will
548 * read past the end of this in order to parse out the session ticket
550 * len: the length of the session ID.
551 * limit: a pointer to the first byte after the ClientHello.
555 * 0: a session may have been found.
558 * - If a session is found then s->session is pointed at it (after freeing an
559 * existing session if need be) and s->verify_result is set from the session.
560 * - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
561 * if the server should issue a new session ticket (to 0 otherwise).
563 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
564 const unsigned char *limit)
566 /* This is used only by servers. */
568 SSL_SESSION *ret = NULL;
570 int try_session_cache = 1;
571 #ifndef OPENSSL_NO_TLSEXT
575 if (len < 0 || len > SSL_MAX_SSL_SESSION_ID_LENGTH)
578 if (session_id + len > limit) {
584 try_session_cache = 0;
586 #ifndef OPENSSL_NO_TLSEXT
587 /* sets s->tlsext_ticket_expected */
588 r = tls1_process_ticket(s, session_id, len, limit, &ret);
590 case -1: /* Error during processing */
593 case 0: /* No ticket found */
594 case 1: /* Zero length ticket found */
595 break; /* Ok to carry on processing session id. */
596 case 2: /* Ticket found but not decrypted. */
597 case 3: /* Ticket decrypted, *ret has been set. */
598 try_session_cache = 0;
605 if (try_session_cache &&
607 !(s->session_ctx->session_cache_mode &
608 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
610 data.ssl_version = s->version;
611 data.session_id_length = len;
614 memcpy(data.session_id, session_id, len);
615 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
616 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
618 /* don't allow other threads to steal it: */
619 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
621 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
623 s->session_ctx->stats.sess_miss++;
626 if (try_session_cache &&
627 ret == NULL && s->session_ctx->get_session_cb != NULL) {
630 if ((ret = s->session_ctx->get_session_cb(s, session_id, len, ©))) {
631 s->session_ctx->stats.sess_cb_hit++;
634 * Increment reference count now if the session callback asks us
635 * to do so (note that if the session structures returned by the
636 * callback are shared between threads, it must handle the
637 * reference count itself [i.e. copy == 0], or things won't be
641 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
644 * Add the externally cached session to the internal cache as
645 * well if and only if we are supposed to.
648 (s->session_ctx->session_cache_mode &
649 SSL_SESS_CACHE_NO_INTERNAL_STORE))
651 * The following should not return 1, otherwise, things are
654 SSL_CTX_add_session(s->session_ctx, ret);
661 /* Now ret is non-NULL and we own one of its reference counts. */
663 if (ret->sid_ctx_length != s->sid_ctx_length
664 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
666 * We have the session requested by the client, but we don't want to
667 * use it in this context.
669 goto err; /* treat like cache miss */
672 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
674 * We can't be sure if this session is being used out of context,
675 * which is especially important for SSL_VERIFY_PEER. The application
676 * should have used SSL[_CTX]_set_session_id_context. For this error
677 * case, we generate an error instead of treating the event like a
678 * cache miss (otherwise it would be easy for applications to
679 * effectively disable the session cache by accident without anyone
683 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
684 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
689 if (ret->cipher == NULL) {
690 unsigned char buf[5], *p;
696 if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
697 ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
699 ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
700 if (ret->cipher == NULL)
704 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
705 s->session_ctx->stats.sess_timeout++;
706 if (try_session_cache) {
707 /* session was from the cache, so remove it */
708 SSL_CTX_remove_session(s->session_ctx, ret);
713 s->session_ctx->stats.sess_hit++;
715 if (s->session != NULL)
716 SSL_SESSION_free(s->session);
718 s->verify_result = s->session->verify_result;
723 SSL_SESSION_free(ret);
724 #ifndef OPENSSL_NO_TLSEXT
725 if (!try_session_cache) {
727 * The session was from a ticket, so we should issue a ticket for
730 s->tlsext_ticket_expected = 1;
740 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
746 * add just 1 reference count for the SSL_CTX's session cache even though
747 * it has two ways of access: each session is in a doubly linked list and
750 CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
752 * if session c is in already in cache, we take back the increment later
755 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
756 s = lh_SSL_SESSION_insert(ctx->sessions, c);
759 * s != NULL iff we already had a session with the given PID. In this
760 * case, s == c should hold (then we did not really modify
761 * ctx->sessions), or we're in trouble.
763 if (s != NULL && s != c) {
764 /* We *are* in trouble ... */
765 SSL_SESSION_list_remove(ctx, s);
768 * ... so pretend the other session did not exist in cache (we cannot
769 * handle two SSL_SESSION structures with identical session ID in the
770 * same cache, which could happen e.g. when two threads concurrently
771 * obtain the same session from an external cache)
776 /* Put at the head of the queue unless it is already in the cache */
778 SSL_SESSION_list_add(ctx, c);
782 * existing cache entry -- decrement previously incremented reference
783 * count because it already takes into account the cache
786 SSL_SESSION_free(s); /* s == c */
790 * new cache entry -- remove old ones if cache has become too large
795 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
796 while (SSL_CTX_sess_number(ctx) >
797 SSL_CTX_sess_get_cache_size(ctx)) {
798 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
801 ctx->stats.sess_cache_full++;
805 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
809 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
811 return remove_session_lock(ctx, c, 1);
814 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
819 if ((c != NULL) && (c->session_id_length != 0)) {
821 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
822 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
824 r = lh_SSL_SESSION_delete(ctx->sessions, c);
825 SSL_SESSION_list_remove(ctx, c);
829 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
832 r->not_resumable = 1;
833 if (ctx->remove_session_cb != NULL)
834 ctx->remove_session_cb(ctx, r);
842 void SSL_SESSION_free(SSL_SESSION *ss)
849 i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
851 REF_PRINT("SSL_SESSION", ss);
857 fprintf(stderr, "SSL_SESSION_free, bad reference count\n");
862 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
864 OPENSSL_cleanse(ss->key_arg, sizeof ss->key_arg);
865 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
866 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
867 if (ss->sess_cert != NULL)
868 ssl_sess_cert_free(ss->sess_cert);
869 if (ss->peer != NULL)
871 if (ss->ciphers != NULL)
872 sk_SSL_CIPHER_free(ss->ciphers);
873 #ifndef OPENSSL_NO_TLSEXT
874 if (ss->tlsext_hostname != NULL)
875 OPENSSL_free(ss->tlsext_hostname);
876 if (ss->tlsext_tick != NULL)
877 OPENSSL_free(ss->tlsext_tick);
878 # ifndef OPENSSL_NO_EC
879 ss->tlsext_ecpointformatlist_length = 0;
880 if (ss->tlsext_ecpointformatlist != NULL)
881 OPENSSL_free(ss->tlsext_ecpointformatlist);
882 ss->tlsext_ellipticcurvelist_length = 0;
883 if (ss->tlsext_ellipticcurvelist != NULL)
884 OPENSSL_free(ss->tlsext_ellipticcurvelist);
885 # endif /* OPENSSL_NO_EC */
887 #ifndef OPENSSL_NO_PSK
888 if (ss->psk_identity_hint != NULL)
889 OPENSSL_free(ss->psk_identity_hint);
890 if (ss->psk_identity != NULL)
891 OPENSSL_free(ss->psk_identity);
893 #ifndef OPENSSL_NO_SRP
894 if (ss->srp_username != NULL)
895 OPENSSL_free(ss->srp_username);
897 OPENSSL_cleanse(ss, sizeof(*ss));
901 int SSL_set_session(SSL *s, SSL_SESSION *session)
904 const SSL_METHOD *meth;
906 if (session != NULL) {
907 meth = s->ctx->method->get_ssl_method(session->ssl_version);
909 meth = s->method->get_ssl_method(session->ssl_version);
911 SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
915 if (meth != s->method) {
916 if (!SSL_set_ssl_method(s, meth))
919 #ifndef OPENSSL_NO_KRB5
920 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
921 session->krb5_client_princ_len > 0) {
922 s->kssl_ctx->client_princ =
923 (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
924 memcpy(s->kssl_ctx->client_princ, session->krb5_client_princ,
925 session->krb5_client_princ_len);
926 s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
928 #endif /* OPENSSL_NO_KRB5 */
930 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
931 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
932 if (s->session != NULL)
933 SSL_SESSION_free(s->session);
934 s->session = session;
935 s->verify_result = s->session->verify_result;
936 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
939 if (s->session != NULL) {
940 SSL_SESSION_free(s->session);
944 meth = s->ctx->method;
945 if (meth != s->method) {
946 if (!SSL_set_ssl_method(s, meth))
954 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
962 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
969 long SSL_SESSION_get_time(const SSL_SESSION *s)
976 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
984 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
989 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
990 unsigned int sid_ctx_len)
992 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
993 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
994 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
997 s->sid_ctx_length = sid_ctx_len;
998 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
1003 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
1008 l = s->session_timeout;
1009 s->session_timeout = t;
1013 long SSL_CTX_get_timeout(const SSL_CTX *s)
1017 return (s->session_timeout);
1020 #ifndef OPENSSL_NO_TLSEXT
1021 int SSL_set_session_secret_cb(SSL *s,
1022 int (*tls_session_secret_cb) (SSL *s,
1025 STACK_OF(SSL_CIPHER)
1034 s->tls_session_secret_cb = tls_session_secret_cb;
1035 s->tls_session_secret_cb_arg = arg;
1039 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
1044 s->tls_session_ticket_ext_cb = cb;
1045 s->tls_session_ticket_ext_cb_arg = arg;
1049 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1051 if (s->version >= TLS1_VERSION) {
1052 if (s->tlsext_session_ticket) {
1053 OPENSSL_free(s->tlsext_session_ticket);
1054 s->tlsext_session_ticket = NULL;
1057 s->tlsext_session_ticket =
1058 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1059 if (!s->tlsext_session_ticket) {
1060 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
1065 s->tlsext_session_ticket->length = ext_len;
1066 s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
1067 memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
1069 s->tlsext_session_ticket->length = 0;
1070 s->tlsext_session_ticket->data = NULL;
1078 #endif /* OPENSSL_NO_TLSEXT */
1080 typedef struct timeout_param_st {
1083 LHASH_OF(SSL_SESSION) *cache;
1086 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
1088 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1090 * The reason we don't call SSL_CTX_remove_session() is to save on
1093 (void)lh_SSL_SESSION_delete(p->cache, s);
1094 SSL_SESSION_list_remove(p->ctx, s);
1095 s->not_resumable = 1;
1096 if (p->ctx->remove_session_cb != NULL)
1097 p->ctx->remove_session_cb(p->ctx, s);
1098 SSL_SESSION_free(s);
1102 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
1104 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1110 tp.cache = s->sessions;
1111 if (tp.cache == NULL)
1114 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
1115 i = CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
1116 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = 0;
1117 lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
1118 TIMEOUT_PARAM, &tp);
1119 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = i;
1120 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
1123 int ssl_clear_bad_session(SSL *s)
1125 if ((s->session != NULL) &&
1126 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1127 !(SSL_in_init(s) || SSL_in_before(s))) {
1128 SSL_CTX_remove_session(s->ctx, s->session);
1134 /* locked by SSL_CTX in the calling function */
1135 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1137 if ((s->next == NULL) || (s->prev == NULL))
1140 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1141 /* last element in list */
1142 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1143 /* only one element in list */
1144 ctx->session_cache_head = NULL;
1145 ctx->session_cache_tail = NULL;
1147 ctx->session_cache_tail = s->prev;
1148 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1151 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1152 /* first element in list */
1153 ctx->session_cache_head = s->next;
1154 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1156 /* middle of list */
1157 s->next->prev = s->prev;
1158 s->prev->next = s->next;
1161 s->prev = s->next = NULL;
1164 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1166 if ((s->next != NULL) && (s->prev != NULL))
1167 SSL_SESSION_list_remove(ctx, s);
1169 if (ctx->session_cache_head == NULL) {
1170 ctx->session_cache_head = s;
1171 ctx->session_cache_tail = s;
1172 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1173 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1175 s->next = ctx->session_cache_head;
1177 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1178 ctx->session_cache_head = s;
1182 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1183 int (*cb) (struct ssl_st *ssl,
1186 ctx->new_session_cb = cb;
1189 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1190 return ctx->new_session_cb;
1193 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1194 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1196 ctx->remove_session_cb = cb;
1199 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1200 SSL_SESSION *sess) {
1201 return ctx->remove_session_cb;
1204 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1205 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1206 unsigned char *data, int len,
1209 ctx->get_session_cb = cb;
1212 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1213 unsigned char *data,
1214 int len, int *copy) {
1215 return ctx->get_session_cb;
1218 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1219 void (*cb) (const SSL *ssl, int type, int val))
1221 ctx->info_callback = cb;
1224 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1226 return ctx->info_callback;
1229 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1230 int (*cb) (SSL *ssl, X509 **x509,
1233 ctx->client_cert_cb = cb;
1236 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1238 return ctx->client_cert_cb;
1241 #ifndef OPENSSL_NO_ENGINE
1242 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1244 if (!ENGINE_init(e)) {
1245 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1248 if (!ENGINE_get_ssl_client_cert_function(e)) {
1249 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1250 SSL_R_NO_CLIENT_CERT_METHOD);
1254 ctx->client_cert_engine = e;
1259 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1260 int (*cb) (SSL *ssl,
1261 unsigned char *cookie,
1262 unsigned int *cookie_len))
1264 ctx->app_gen_cookie_cb = cb;
1267 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1268 int (*cb) (SSL *ssl, unsigned char *cookie,
1269 unsigned int cookie_len))
1271 ctx->app_verify_cookie_cb = cb;
1274 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION,