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;
228 * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
229 * ticket == 0 then no ticket information is duplicated, otherwise it is.
231 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
235 dest = OPENSSL_malloc(sizeof(*src));
239 memcpy(dest, src, sizeof(*dest));
242 * Set the various pointers to NULL so that we can call SSL_SESSION_free in
243 * the case of an error whilst halfway through constructing dest
245 #ifndef OPENSSL_NO_PSK
246 dest->psk_identity_hint = NULL;
247 dest->psk_identity = NULL;
249 dest->ciphers = NULL;
250 #ifndef OPENSSL_NO_TLSEXT
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;
258 memset(&dest->ex_data, 0, sizeof(dest->ex_data));
260 /* We deliberately don't copy the prev and next pointers */
264 dest->references = 1;
266 if (src->sess_cert != NULL)
267 CRYPTO_add(&src->sess_cert->references, 1, CRYPTO_LOCK_SSL_SESS_CERT);
269 if (src->peer != NULL)
270 CRYPTO_add(&src->peer->references, 1, CRYPTO_LOCK_X509);
272 #ifndef OPENSSL_NO_PSK
273 if (src->psk_identity_hint) {
274 dest->psk_identity_hint = BUF_strdup(src->psk_identity_hint);
275 if (dest->psk_identity_hint == NULL) {
279 if (src->psk_identity) {
280 dest->psk_identity = BUF_strdup(src->psk_identity);
281 if (dest->psk_identity == NULL) {
287 if(src->ciphers != NULL) {
288 dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
289 if (dest->ciphers == NULL)
293 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
294 &dest->ex_data, &src->ex_data)) {
298 #ifndef OPENSSL_NO_TLSEXT
299 if (src->tlsext_hostname) {
300 dest->tlsext_hostname = BUF_strdup(src->tlsext_hostname);
301 if (dest->tlsext_hostname == NULL) {
305 # ifndef OPENSSL_NO_EC
306 if (src->tlsext_ecpointformatlist) {
307 dest->tlsext_ecpointformatlist =
308 BUF_memdup(src->tlsext_ecpointformatlist,
309 src->tlsext_ecpointformatlist_length);
310 if (dest->tlsext_ecpointformatlist == NULL)
313 if (src->tlsext_ellipticcurvelist) {
314 dest->tlsext_ellipticcurvelist =
315 BUF_memdup(src->tlsext_ellipticcurvelist,
316 src->tlsext_ellipticcurvelist_length);
317 if (dest->tlsext_ellipticcurvelist == NULL)
323 dest->tlsext_tick = BUF_memdup(src->tlsext_tick, src->tlsext_ticklen);
324 if(dest->tlsext_tick == NULL)
327 dest->tlsext_tick_lifetime_hint = 0;
328 dest->tlsext_ticklen = 0;
334 SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
335 SSL_SESSION_free(dest);
339 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
343 *len = s->session_id_length;
344 return s->session_id;
348 * Even with SSLv2, we have 16 bytes (128 bits) of session ID space.
349 * SSLv3/TLSv1 has 32 bytes (256 bits). As such, filling the ID with random
350 * gunk repeatedly until we have no conflict is going to complete in one
351 * iteration pretty much "most" of the time (btw: understatement). So, if it
352 * takes us 10 iterations and we still can't avoid a conflict - well that's a
353 * reasonable point to call it quits. Either the RAND code is broken or
354 * someone is trying to open roughly very close to 2^128 (or 2^256) SSL
355 * sessions to our server. How you might store that many sessions is perhaps
356 * a more interesting question ...
359 #define MAX_SESS_ID_ATTEMPTS 10
360 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
361 unsigned int *id_len)
363 unsigned int retry = 0;
365 if (RAND_pseudo_bytes(id, *id_len) <= 0)
367 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
368 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
369 if (retry < MAX_SESS_ID_ATTEMPTS)
371 /* else - woops a session_id match */
373 * XXX We should also check the external cache -- but the probability of
374 * a collision is negligible, and we could not prevent the concurrent
375 * creation of sessions with identical IDs since we currently don't have
376 * means to atomically check whether a session ID already exists and make
377 * a reservation for it if it does not (this problem applies to the
378 * internal cache as well).
383 int ssl_get_new_session(SSL *s, int session)
385 /* This gets used by clients and servers. */
388 SSL_SESSION *ss = NULL;
389 GEN_SESSION_CB cb = def_generate_session_id;
391 if ((ss = SSL_SESSION_new()) == NULL)
394 /* If the context has a default timeout, use it */
395 if (s->session_ctx->session_timeout == 0)
396 ss->timeout = SSL_get_default_timeout(s);
398 ss->timeout = s->session_ctx->session_timeout;
400 if (s->session != NULL) {
401 SSL_SESSION_free(s->session);
406 if (s->version == SSL2_VERSION) {
407 ss->ssl_version = SSL2_VERSION;
408 ss->session_id_length = SSL2_SSL_SESSION_ID_LENGTH;
409 } else if (s->version == SSL3_VERSION) {
410 ss->ssl_version = SSL3_VERSION;
411 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
412 } else if (s->version == TLS1_VERSION) {
413 ss->ssl_version = TLS1_VERSION;
414 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
415 } else if (s->version == DTLS1_BAD_VER) {
416 ss->ssl_version = DTLS1_BAD_VER;
417 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
418 } else if (s->version == DTLS1_VERSION) {
419 ss->ssl_version = DTLS1_VERSION;
420 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
422 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
423 SSL_SESSION_free(ss);
426 #ifndef OPENSSL_NO_TLSEXT
427 /* If RFC4507 ticket use empty session ID */
428 if (s->tlsext_ticket_expected) {
429 ss->session_id_length = 0;
433 /* Choose which callback will set the session ID */
434 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
435 if (s->generate_session_id)
436 cb = s->generate_session_id;
437 else if (s->session_ctx->generate_session_id)
438 cb = s->session_ctx->generate_session_id;
439 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
440 /* Choose a session ID */
441 tmp = ss->session_id_length;
442 if (!cb(s, ss->session_id, &tmp)) {
443 /* The callback failed */
444 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
445 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
446 SSL_SESSION_free(ss);
450 * Don't allow the callback to set the session length to zero. nor
451 * set it higher than it was.
453 if (!tmp || (tmp > ss->session_id_length)) {
454 /* The callback set an illegal length */
455 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
456 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
457 SSL_SESSION_free(ss);
460 /* If the session length was shrunk and we're SSLv2, pad it */
461 if ((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
462 memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
464 ss->session_id_length = tmp;
465 /* Finally, check for a conflict */
466 if (SSL_has_matching_session_id(s, ss->session_id,
467 ss->session_id_length)) {
468 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
469 SSL_SESSION_free(ss);
472 #ifndef OPENSSL_NO_TLSEXT
474 if (s->tlsext_hostname) {
475 ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
476 if (ss->tlsext_hostname == NULL) {
477 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
478 SSL_SESSION_free(ss);
482 # ifndef OPENSSL_NO_EC
483 if (s->tlsext_ecpointformatlist) {
484 if (ss->tlsext_ecpointformatlist != NULL)
485 OPENSSL_free(ss->tlsext_ecpointformatlist);
486 if ((ss->tlsext_ecpointformatlist =
487 OPENSSL_malloc(s->tlsext_ecpointformatlist_length)) ==
489 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
490 SSL_SESSION_free(ss);
493 ss->tlsext_ecpointformatlist_length =
494 s->tlsext_ecpointformatlist_length;
495 memcpy(ss->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist,
496 s->tlsext_ecpointformatlist_length);
498 if (s->tlsext_ellipticcurvelist) {
499 if (ss->tlsext_ellipticcurvelist != NULL)
500 OPENSSL_free(ss->tlsext_ellipticcurvelist);
501 if ((ss->tlsext_ellipticcurvelist =
502 OPENSSL_malloc(s->tlsext_ellipticcurvelist_length)) ==
504 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
505 SSL_SESSION_free(ss);
508 ss->tlsext_ellipticcurvelist_length =
509 s->tlsext_ellipticcurvelist_length;
510 memcpy(ss->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist,
511 s->tlsext_ellipticcurvelist_length);
516 ss->session_id_length = 0;
519 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
520 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
521 SSL_SESSION_free(ss);
524 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
525 ss->sid_ctx_length = s->sid_ctx_length;
527 ss->ssl_version = s->version;
528 ss->verify_result = X509_V_OK;
533 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
534 const unsigned char *limit)
536 /* This is used only by servers. */
538 SSL_SESSION *ret = NULL;
540 #ifndef OPENSSL_NO_TLSEXT
544 if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
547 if (session_id + len > limit) {
552 #ifndef OPENSSL_NO_TLSEXT
553 r = tls1_process_ticket(s, session_id, len, limit, &ret);
557 } else if (r == 0 || (!ret && !len))
560 && !(s->session_ctx->session_cache_mode &
561 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
567 session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
571 data.ssl_version = s->version;
572 data.session_id_length = len;
575 memcpy(data.session_id, session_id, len);
576 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
577 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
579 /* don't allow other threads to steal it: */
580 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
581 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
587 s->session_ctx->stats.sess_miss++;
589 if (s->session_ctx->get_session_cb != NULL
591 s->session_ctx->get_session_cb(s, session_id, len, ©))
593 s->session_ctx->stats.sess_cb_hit++;
596 * Increment reference count now if the session callback asks us
597 * to do so (note that if the session structures returned by the
598 * callback are shared between threads, it must handle the
599 * reference count itself [i.e. copy == 0], or things won't be
603 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
606 * Add the externally cached session to the internal cache as
607 * well if and only if we are supposed to.
610 (s->session_ctx->session_cache_mode &
611 SSL_SESS_CACHE_NO_INTERNAL_STORE))
613 * The following should not return 1, otherwise, things are
616 SSL_CTX_add_session(s->session_ctx, ret);
622 /* Now ret is non-NULL, and we own one of its reference counts. */
624 if (ret->sid_ctx_length != s->sid_ctx_length
625 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
627 * We've found the session named by the client, but we don't want to
628 * use it in this context.
631 #if 0 /* The client cannot always know when a
632 * session is not appropriate, so we
633 * shouldn't generate an error message. */
635 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
636 SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
638 goto err; /* treat like cache miss */
641 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
643 * We can't be sure if this session is being used out of context,
644 * which is especially important for SSL_VERIFY_PEER. The application
645 * should have used SSL[_CTX]_set_session_id_context. For this error
646 * case, we generate an error instead of treating the event like a
647 * cache miss (otherwise it would be easy for applications to
648 * effectively disable the session cache by accident without anyone
652 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
653 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
658 if (ret->cipher == NULL) {
659 unsigned char buf[5], *p;
665 if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
666 ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
668 ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
669 if (ret->cipher == NULL)
672 #if 0 /* This is way too late. */
675 * If a thread got the session, then 'swaped', and another got it and
676 * then due to a time-out decided to 'OPENSSL_free' it we could be in
677 * trouble. So I'll increment it now, then double decrement later - am I
680 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
683 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
684 s->session_ctx->stats.sess_timeout++;
685 /* remove it from the cache */
686 SSL_CTX_remove_session(s->session_ctx, ret);
690 s->session_ctx->stats.sess_hit++;
692 /*- ret->time=time(NULL); *//*
696 * again, just leave the session if it is the same session, we have just
697 * incremented and then decremented the reference count :-)
699 if (s->session != NULL)
700 SSL_SESSION_free(s->session);
702 s->verify_result = s->session->verify_result;
707 SSL_SESSION_free(ret);
714 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
720 * add just 1 reference count for the SSL_CTX's session cache even though
721 * it has two ways of access: each session is in a doubly linked list and
724 CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
726 * if session c is in already in cache, we take back the increment later
729 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
730 s = lh_SSL_SESSION_insert(ctx->sessions, c);
733 * s != NULL iff we already had a session with the given PID. In this
734 * case, s == c should hold (then we did not really modify
735 * ctx->sessions), or we're in trouble.
737 if (s != NULL && s != c) {
738 /* We *are* in trouble ... */
739 SSL_SESSION_list_remove(ctx, s);
742 * ... so pretend the other session did not exist in cache (we cannot
743 * handle two SSL_SESSION structures with identical session ID in the
744 * same cache, which could happen e.g. when two threads concurrently
745 * obtain the same session from an external cache)
750 /* Put at the head of the queue unless it is already in the cache */
752 SSL_SESSION_list_add(ctx, c);
756 * existing cache entry -- decrement previously incremented reference
757 * count because it already takes into account the cache
760 SSL_SESSION_free(s); /* s == c */
764 * new cache entry -- remove old ones if cache has become too large
769 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
770 while (SSL_CTX_sess_number(ctx) >
771 SSL_CTX_sess_get_cache_size(ctx)) {
772 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
775 ctx->stats.sess_cache_full++;
779 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
783 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
785 return remove_session_lock(ctx, c, 1);
788 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
793 if ((c != NULL) && (c->session_id_length != 0)) {
795 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
796 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
798 r = lh_SSL_SESSION_delete(ctx->sessions, c);
799 SSL_SESSION_list_remove(ctx, c);
803 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
806 r->not_resumable = 1;
807 if (ctx->remove_session_cb != NULL)
808 ctx->remove_session_cb(ctx, r);
816 void SSL_SESSION_free(SSL_SESSION *ss)
823 i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
825 REF_PRINT("SSL_SESSION", ss);
831 fprintf(stderr, "SSL_SESSION_free, bad reference count\n");
836 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
838 OPENSSL_cleanse(ss->key_arg, sizeof ss->key_arg);
839 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
840 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
841 if (ss->sess_cert != NULL)
842 ssl_sess_cert_free(ss->sess_cert);
843 if (ss->peer != NULL)
845 if (ss->ciphers != NULL)
846 sk_SSL_CIPHER_free(ss->ciphers);
847 #ifndef OPENSSL_NO_TLSEXT
848 if (ss->tlsext_hostname != NULL)
849 OPENSSL_free(ss->tlsext_hostname);
850 if (ss->tlsext_tick != NULL)
851 OPENSSL_free(ss->tlsext_tick);
852 # ifndef OPENSSL_NO_EC
853 ss->tlsext_ecpointformatlist_length = 0;
854 if (ss->tlsext_ecpointformatlist != NULL)
855 OPENSSL_free(ss->tlsext_ecpointformatlist);
856 ss->tlsext_ellipticcurvelist_length = 0;
857 if (ss->tlsext_ellipticcurvelist != NULL)
858 OPENSSL_free(ss->tlsext_ellipticcurvelist);
859 # endif /* OPENSSL_NO_EC */
861 #ifndef OPENSSL_NO_PSK
862 if (ss->psk_identity_hint != NULL)
863 OPENSSL_free(ss->psk_identity_hint);
864 if (ss->psk_identity != NULL)
865 OPENSSL_free(ss->psk_identity);
867 OPENSSL_cleanse(ss, sizeof(*ss));
871 int SSL_set_session(SSL *s, SSL_SESSION *session)
874 const SSL_METHOD *meth;
876 if (session != NULL) {
877 meth = s->ctx->method->get_ssl_method(session->ssl_version);
879 meth = s->method->get_ssl_method(session->ssl_version);
881 SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
885 if (meth != s->method) {
886 if (!SSL_set_ssl_method(s, meth))
888 if (s->ctx->session_timeout == 0)
889 session->timeout = SSL_get_default_timeout(s);
891 session->timeout = s->ctx->session_timeout;
893 #ifndef OPENSSL_NO_KRB5
894 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
895 session->krb5_client_princ_len > 0) {
896 s->kssl_ctx->client_princ =
897 (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
898 memcpy(s->kssl_ctx->client_princ, session->krb5_client_princ,
899 session->krb5_client_princ_len);
900 s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
902 #endif /* OPENSSL_NO_KRB5 */
904 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
905 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
906 if (s->session != NULL)
907 SSL_SESSION_free(s->session);
908 s->session = session;
909 s->verify_result = s->session->verify_result;
910 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
913 if (s->session != NULL) {
914 SSL_SESSION_free(s->session);
918 meth = s->ctx->method;
919 if (meth != s->method) {
920 if (!SSL_set_ssl_method(s, meth))
928 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
936 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
943 long SSL_SESSION_get_time(const SSL_SESSION *s)
950 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
958 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
963 l = s->session_timeout;
964 s->session_timeout = t;
968 long SSL_CTX_get_timeout(const SSL_CTX *s)
972 return (s->session_timeout);
975 #ifndef OPENSSL_NO_TLSEXT
976 int SSL_set_session_secret_cb(SSL *s,
977 int (*tls_session_secret_cb) (SSL *s,
989 s->tls_session_secret_cb = tls_session_secret_cb;
990 s->tls_session_secret_cb_arg = arg;
994 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
999 s->tls_session_ticket_ext_cb = cb;
1000 s->tls_session_ticket_ext_cb_arg = arg;
1004 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
1006 if (s->version >= TLS1_VERSION) {
1007 if (s->tlsext_session_ticket) {
1008 OPENSSL_free(s->tlsext_session_ticket);
1009 s->tlsext_session_ticket = NULL;
1012 s->tlsext_session_ticket =
1013 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
1014 if (!s->tlsext_session_ticket) {
1015 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
1020 s->tlsext_session_ticket->length = ext_len;
1021 s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
1022 memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
1024 s->tlsext_session_ticket->length = 0;
1025 s->tlsext_session_ticket->data = NULL;
1033 #endif /* OPENSSL_NO_TLSEXT */
1035 typedef struct timeout_param_st {
1038 LHASH_OF(SSL_SESSION) *cache;
1041 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
1043 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
1045 * The reason we don't call SSL_CTX_remove_session() is to save on
1048 (void)lh_SSL_SESSION_delete(p->cache, s);
1049 SSL_SESSION_list_remove(p->ctx, s);
1050 s->not_resumable = 1;
1051 if (p->ctx->remove_session_cb != NULL)
1052 p->ctx->remove_session_cb(p->ctx, s);
1053 SSL_SESSION_free(s);
1057 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
1059 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1065 tp.cache = s->sessions;
1066 if (tp.cache == NULL)
1069 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
1070 i = CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
1071 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = 0;
1072 lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
1073 TIMEOUT_PARAM, &tp);
1074 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = i;
1075 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
1078 int ssl_clear_bad_session(SSL *s)
1080 if ((s->session != NULL) &&
1081 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1082 !(SSL_in_init(s) || SSL_in_before(s))) {
1083 SSL_CTX_remove_session(s->ctx, s->session);
1089 /* locked by SSL_CTX in the calling function */
1090 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1092 if ((s->next == NULL) || (s->prev == NULL))
1095 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1096 /* last element in list */
1097 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1098 /* only one element in list */
1099 ctx->session_cache_head = NULL;
1100 ctx->session_cache_tail = NULL;
1102 ctx->session_cache_tail = s->prev;
1103 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1106 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1107 /* first element in list */
1108 ctx->session_cache_head = s->next;
1109 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1111 /* middle of list */
1112 s->next->prev = s->prev;
1113 s->prev->next = s->next;
1116 s->prev = s->next = NULL;
1119 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1121 if ((s->next != NULL) && (s->prev != NULL))
1122 SSL_SESSION_list_remove(ctx, s);
1124 if (ctx->session_cache_head == NULL) {
1125 ctx->session_cache_head = s;
1126 ctx->session_cache_tail = s;
1127 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1128 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1130 s->next = ctx->session_cache_head;
1132 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1133 ctx->session_cache_head = s;
1137 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1138 int (*cb) (struct ssl_st *ssl,
1141 ctx->new_session_cb = cb;
1144 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1145 return ctx->new_session_cb;
1148 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1149 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1151 ctx->remove_session_cb = cb;
1154 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1155 SSL_SESSION *sess) {
1156 return ctx->remove_session_cb;
1159 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1160 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1161 unsigned char *data, int len,
1164 ctx->get_session_cb = cb;
1167 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1168 unsigned char *data,
1169 int len, int *copy) {
1170 return ctx->get_session_cb;
1173 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1174 void (*cb) (const SSL *ssl, int type, int val))
1176 ctx->info_callback = cb;
1179 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1181 return ctx->info_callback;
1184 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1185 int (*cb) (SSL *ssl, X509 **x509,
1188 ctx->client_cert_cb = cb;
1191 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1193 return ctx->client_cert_cb;
1196 #ifndef OPENSSL_NO_ENGINE
1197 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1199 if (!ENGINE_init(e)) {
1200 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1203 if (!ENGINE_get_ssl_client_cert_function(e)) {
1204 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1205 SSL_R_NO_CLIENT_CERT_METHOD);
1209 ctx->client_cert_engine = e;
1214 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1215 int (*cb) (SSL *ssl,
1216 unsigned char *cookie,
1217 unsigned int *cookie_len))
1219 ctx->app_gen_cookie_cb = cb;
1222 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1223 int (*cb) (SSL *ssl, unsigned char *cookie,
1224 unsigned int cookie_len))
1226 ctx->app_verify_cookie_cb = cb;
1229 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION,