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;
230 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
234 *len = s->session_id_length;
235 return s->session_id;
238 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
240 return s->compress_meth;
244 * Even with SSLv2, we have 16 bytes (128 bits) of session ID space.
245 * SSLv3/TLSv1 has 32 bytes (256 bits). As such, filling the ID with random
246 * gunk repeatedly until we have no conflict is going to complete in one
247 * iteration pretty much "most" of the time (btw: understatement). So, if it
248 * takes us 10 iterations and we still can't avoid a conflict - well that's a
249 * reasonable point to call it quits. Either the RAND code is broken or
250 * someone is trying to open roughly very close to 2^128 (or 2^256) SSL
251 * sessions to our server. How you might store that many sessions is perhaps
252 * a more interesting question ...
255 #define MAX_SESS_ID_ATTEMPTS 10
256 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
257 unsigned int *id_len)
259 unsigned int retry = 0;
261 if (RAND_pseudo_bytes(id, *id_len) <= 0)
263 while (SSL_has_matching_session_id(ssl, id, *id_len) &&
264 (++retry < MAX_SESS_ID_ATTEMPTS)) ;
265 if (retry < MAX_SESS_ID_ATTEMPTS)
267 /* else - woops a session_id match */
269 * XXX We should also check the external cache -- but the probability of
270 * a collision is negligible, and we could not prevent the concurrent
271 * creation of sessions with identical IDs since we currently don't have
272 * means to atomically check whether a session ID already exists and make
273 * a reservation for it if it does not (this problem applies to the
274 * internal cache as well).
279 int ssl_get_new_session(SSL *s, int session)
281 /* This gets used by clients and servers. */
284 SSL_SESSION *ss = NULL;
285 GEN_SESSION_CB cb = def_generate_session_id;
287 if ((ss = SSL_SESSION_new()) == NULL)
290 /* If the context has a default timeout, use it */
291 if (s->session_ctx->session_timeout == 0)
292 ss->timeout = SSL_get_default_timeout(s);
294 ss->timeout = s->session_ctx->session_timeout;
296 if (s->session != NULL) {
297 SSL_SESSION_free(s->session);
302 if (s->version == SSL2_VERSION) {
303 ss->ssl_version = SSL2_VERSION;
304 ss->session_id_length = SSL2_SSL_SESSION_ID_LENGTH;
305 } else if (s->version == SSL3_VERSION) {
306 ss->ssl_version = SSL3_VERSION;
307 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
308 } else if (s->version == TLS1_VERSION) {
309 ss->ssl_version = TLS1_VERSION;
310 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
311 } else if (s->version == TLS1_1_VERSION) {
312 ss->ssl_version = TLS1_1_VERSION;
313 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
314 } else if (s->version == TLS1_2_VERSION) {
315 ss->ssl_version = TLS1_2_VERSION;
316 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
317 } else if (s->version == DTLS1_BAD_VER) {
318 ss->ssl_version = DTLS1_BAD_VER;
319 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
320 } else if (s->version == DTLS1_VERSION) {
321 ss->ssl_version = DTLS1_VERSION;
322 ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
324 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
325 SSL_SESSION_free(ss);
328 #ifndef OPENSSL_NO_TLSEXT
330 * If RFC5077 ticket, use empty session ID (as server).
332 * (a) ssl_get_prev_session() does lookahead into the
333 * ClientHello extensions to find the session ticket.
334 * When ssl_get_prev_session() fails, s3_srvr.c calls
335 * ssl_get_new_session() in ssl3_get_client_hello().
336 * At that point, it has not yet parsed the extensions,
337 * however, because of the lookahead, it already knows
338 * whether a ticket is expected or not.
340 * (b) s3_clnt.c calls ssl_get_new_session() before parsing
341 * ServerHello extensions, and before recording the session
342 * ID received from the server, so this block is a noop.
344 if (s->tlsext_ticket_expected) {
345 ss->session_id_length = 0;
349 /* Choose which callback will set the session ID */
350 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
351 if (s->generate_session_id)
352 cb = s->generate_session_id;
353 else if (s->session_ctx->generate_session_id)
354 cb = s->session_ctx->generate_session_id;
355 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
356 /* Choose a session ID */
357 tmp = ss->session_id_length;
358 if (!cb(s, ss->session_id, &tmp)) {
359 /* The callback failed */
360 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
361 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
362 SSL_SESSION_free(ss);
366 * Don't allow the callback to set the session length to zero. nor
367 * set it higher than it was.
369 if (!tmp || (tmp > ss->session_id_length)) {
370 /* The callback set an illegal length */
371 SSLerr(SSL_F_SSL_GET_NEW_SESSION,
372 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
373 SSL_SESSION_free(ss);
376 /* If the session length was shrunk and we're SSLv2, pad it */
377 if ((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
378 memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
380 ss->session_id_length = tmp;
381 /* Finally, check for a conflict */
382 if (SSL_has_matching_session_id(s, ss->session_id,
383 ss->session_id_length)) {
384 SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
385 SSL_SESSION_free(ss);
388 #ifndef OPENSSL_NO_TLSEXT
390 if (s->tlsext_hostname) {
391 ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
392 if (ss->tlsext_hostname == NULL) {
393 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
394 SSL_SESSION_free(ss);
398 # ifndef OPENSSL_NO_EC
399 if (s->tlsext_ecpointformatlist) {
400 if (ss->tlsext_ecpointformatlist != NULL)
401 OPENSSL_free(ss->tlsext_ecpointformatlist);
402 if ((ss->tlsext_ecpointformatlist =
403 OPENSSL_malloc(s->tlsext_ecpointformatlist_length)) ==
405 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
406 SSL_SESSION_free(ss);
409 ss->tlsext_ecpointformatlist_length =
410 s->tlsext_ecpointformatlist_length;
411 memcpy(ss->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist,
412 s->tlsext_ecpointformatlist_length);
414 if (s->tlsext_ellipticcurvelist) {
415 if (ss->tlsext_ellipticcurvelist != NULL)
416 OPENSSL_free(ss->tlsext_ellipticcurvelist);
417 if ((ss->tlsext_ellipticcurvelist =
418 OPENSSL_malloc(s->tlsext_ellipticcurvelist_length)) ==
420 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
421 SSL_SESSION_free(ss);
424 ss->tlsext_ellipticcurvelist_length =
425 s->tlsext_ellipticcurvelist_length;
426 memcpy(ss->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist,
427 s->tlsext_ellipticcurvelist_length);
432 ss->session_id_length = 0;
435 if (s->sid_ctx_length > sizeof ss->sid_ctx) {
436 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
437 SSL_SESSION_free(ss);
440 memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
441 ss->sid_ctx_length = s->sid_ctx_length;
443 ss->ssl_version = s->version;
444 ss->verify_result = X509_V_OK;
450 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
451 * connection. It is only called by servers.
453 * session_id: points at the session ID in the ClientHello. This code will
454 * read past the end of this in order to parse out the session ticket
456 * len: the length of the session ID.
457 * limit: a pointer to the first byte after the ClientHello.
461 * 0: a session may have been found.
464 * - If a session is found then s->session is pointed at it (after freeing an
465 * existing session if need be) and s->verify_result is set from the session.
466 * - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
467 * if the server should issue a new session ticket (to 0 otherwise).
469 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
470 const unsigned char *limit)
472 /* This is used only by servers. */
474 SSL_SESSION *ret = NULL;
476 int try_session_cache = 1;
477 #ifndef OPENSSL_NO_TLSEXT
481 if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
484 if (session_id + len > limit) {
490 try_session_cache = 0;
492 #ifndef OPENSSL_NO_TLSEXT
493 /* sets s->tlsext_ticket_expected */
494 r = tls1_process_ticket(s, session_id, len, limit, &ret);
496 case -1: /* Error during processing */
499 case 0: /* No ticket found */
500 case 1: /* Zero length ticket found */
501 break; /* Ok to carry on processing session id. */
502 case 2: /* Ticket found but not decrypted. */
503 case 3: /* Ticket decrypted, *ret has been set. */
504 try_session_cache = 0;
511 if (try_session_cache &&
513 !(s->session_ctx->session_cache_mode &
514 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
516 data.ssl_version = s->version;
517 data.session_id_length = len;
520 memcpy(data.session_id, session_id, len);
521 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
522 ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
524 /* don't allow other threads to steal it: */
525 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
527 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
529 s->session_ctx->stats.sess_miss++;
532 if (try_session_cache &&
533 ret == NULL && s->session_ctx->get_session_cb != NULL) {
536 if ((ret = s->session_ctx->get_session_cb(s, session_id, len, ©))) {
537 s->session_ctx->stats.sess_cb_hit++;
540 * Increment reference count now if the session callback asks us
541 * to do so (note that if the session structures returned by the
542 * callback are shared between threads, it must handle the
543 * reference count itself [i.e. copy == 0], or things won't be
547 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
550 * Add the externally cached session to the internal cache as
551 * well if and only if we are supposed to.
554 (s->session_ctx->session_cache_mode &
555 SSL_SESS_CACHE_NO_INTERNAL_STORE))
557 * The following should not return 1, otherwise, things are
560 SSL_CTX_add_session(s->session_ctx, ret);
567 /* Now ret is non-NULL and we own one of its reference counts. */
569 if (ret->sid_ctx_length != s->sid_ctx_length
570 || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
572 * We have the session requested by the client, but we don't want to
573 * use it in this context.
575 goto err; /* treat like cache miss */
578 if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
580 * We can't be sure if this session is being used out of context,
581 * which is especially important for SSL_VERIFY_PEER. The application
582 * should have used SSL[_CTX]_set_session_id_context. For this error
583 * case, we generate an error instead of treating the event like a
584 * cache miss (otherwise it would be easy for applications to
585 * effectively disable the session cache by accident without anyone
589 SSLerr(SSL_F_SSL_GET_PREV_SESSION,
590 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
595 if (ret->cipher == NULL) {
596 unsigned char buf[5], *p;
602 if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
603 ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
605 ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
606 if (ret->cipher == NULL)
610 if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
611 s->session_ctx->stats.sess_timeout++;
612 if (try_session_cache) {
613 /* session was from the cache, so remove it */
614 SSL_CTX_remove_session(s->session_ctx, ret);
619 s->session_ctx->stats.sess_hit++;
621 if (s->session != NULL)
622 SSL_SESSION_free(s->session);
624 s->verify_result = s->session->verify_result;
629 SSL_SESSION_free(ret);
630 #ifndef OPENSSL_NO_TLSEXT
631 if (!try_session_cache) {
633 * The session was from a ticket, so we should issue a ticket for
636 s->tlsext_ticket_expected = 1;
646 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
652 * add just 1 reference count for the SSL_CTX's session cache even though
653 * it has two ways of access: each session is in a doubly linked list and
656 CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
658 * if session c is in already in cache, we take back the increment later
661 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
662 s = lh_SSL_SESSION_insert(ctx->sessions, c);
665 * s != NULL iff we already had a session with the given PID. In this
666 * case, s == c should hold (then we did not really modify
667 * ctx->sessions), or we're in trouble.
669 if (s != NULL && s != c) {
670 /* We *are* in trouble ... */
671 SSL_SESSION_list_remove(ctx, s);
674 * ... so pretend the other session did not exist in cache (we cannot
675 * handle two SSL_SESSION structures with identical session ID in the
676 * same cache, which could happen e.g. when two threads concurrently
677 * obtain the same session from an external cache)
682 /* Put at the head of the queue unless it is already in the cache */
684 SSL_SESSION_list_add(ctx, c);
688 * existing cache entry -- decrement previously incremented reference
689 * count because it already takes into account the cache
692 SSL_SESSION_free(s); /* s == c */
696 * new cache entry -- remove old ones if cache has become too large
701 if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
702 while (SSL_CTX_sess_number(ctx) >
703 SSL_CTX_sess_get_cache_size(ctx)) {
704 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
707 ctx->stats.sess_cache_full++;
711 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
715 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
717 return remove_session_lock(ctx, c, 1);
720 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
725 if ((c != NULL) && (c->session_id_length != 0)) {
727 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
728 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
730 r = lh_SSL_SESSION_delete(ctx->sessions, c);
731 SSL_SESSION_list_remove(ctx, c);
735 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
738 r->not_resumable = 1;
739 if (ctx->remove_session_cb != NULL)
740 ctx->remove_session_cb(ctx, r);
748 void SSL_SESSION_free(SSL_SESSION *ss)
755 i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
757 REF_PRINT("SSL_SESSION", ss);
763 fprintf(stderr, "SSL_SESSION_free, bad reference count\n");
768 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
770 OPENSSL_cleanse(ss->key_arg, sizeof ss->key_arg);
771 OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
772 OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
773 if (ss->sess_cert != NULL)
774 ssl_sess_cert_free(ss->sess_cert);
775 if (ss->peer != NULL)
777 if (ss->ciphers != NULL)
778 sk_SSL_CIPHER_free(ss->ciphers);
779 #ifndef OPENSSL_NO_TLSEXT
780 if (ss->tlsext_hostname != NULL)
781 OPENSSL_free(ss->tlsext_hostname);
782 if (ss->tlsext_tick != NULL)
783 OPENSSL_free(ss->tlsext_tick);
784 # ifndef OPENSSL_NO_EC
785 ss->tlsext_ecpointformatlist_length = 0;
786 if (ss->tlsext_ecpointformatlist != NULL)
787 OPENSSL_free(ss->tlsext_ecpointformatlist);
788 ss->tlsext_ellipticcurvelist_length = 0;
789 if (ss->tlsext_ellipticcurvelist != NULL)
790 OPENSSL_free(ss->tlsext_ellipticcurvelist);
791 # endif /* OPENSSL_NO_EC */
793 #ifndef OPENSSL_NO_PSK
794 if (ss->psk_identity_hint != NULL)
795 OPENSSL_free(ss->psk_identity_hint);
796 if (ss->psk_identity != NULL)
797 OPENSSL_free(ss->psk_identity);
799 #ifndef OPENSSL_NO_SRP
800 if (ss->srp_username != NULL)
801 OPENSSL_free(ss->srp_username);
803 OPENSSL_cleanse(ss, sizeof(*ss));
807 int SSL_set_session(SSL *s, SSL_SESSION *session)
810 const SSL_METHOD *meth;
812 if (session != NULL) {
813 meth = s->ctx->method->get_ssl_method(session->ssl_version);
815 meth = s->method->get_ssl_method(session->ssl_version);
817 SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
821 if (meth != s->method) {
822 if (!SSL_set_ssl_method(s, meth))
825 #ifndef OPENSSL_NO_KRB5
826 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
827 session->krb5_client_princ_len > 0) {
828 s->kssl_ctx->client_princ =
829 (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
830 memcpy(s->kssl_ctx->client_princ, session->krb5_client_princ,
831 session->krb5_client_princ_len);
832 s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
834 #endif /* OPENSSL_NO_KRB5 */
836 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
837 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
838 if (s->session != NULL)
839 SSL_SESSION_free(s->session);
840 s->session = session;
841 s->verify_result = s->session->verify_result;
842 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
845 if (s->session != NULL) {
846 SSL_SESSION_free(s->session);
850 meth = s->ctx->method;
851 if (meth != s->method) {
852 if (!SSL_set_ssl_method(s, meth))
860 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
868 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
875 long SSL_SESSION_get_time(const SSL_SESSION *s)
882 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
890 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
895 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
896 unsigned int sid_ctx_len)
898 if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
899 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
900 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
903 s->sid_ctx_length = sid_ctx_len;
904 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
909 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
914 l = s->session_timeout;
915 s->session_timeout = t;
919 long SSL_CTX_get_timeout(const SSL_CTX *s)
923 return (s->session_timeout);
926 #ifndef OPENSSL_NO_TLSEXT
927 int SSL_set_session_secret_cb(SSL *s,
928 int (*tls_session_secret_cb) (SSL *s,
940 s->tls_session_secret_cb = tls_session_secret_cb;
941 s->tls_session_secret_cb_arg = arg;
945 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
950 s->tls_session_ticket_ext_cb = cb;
951 s->tls_session_ticket_ext_cb_arg = arg;
955 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
957 if (s->version >= TLS1_VERSION) {
958 if (s->tlsext_session_ticket) {
959 OPENSSL_free(s->tlsext_session_ticket);
960 s->tlsext_session_ticket = NULL;
963 s->tlsext_session_ticket =
964 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
965 if (!s->tlsext_session_ticket) {
966 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
971 s->tlsext_session_ticket->length = ext_len;
972 s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
973 memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
975 s->tlsext_session_ticket->length = 0;
976 s->tlsext_session_ticket->data = NULL;
984 #endif /* OPENSSL_NO_TLSEXT */
986 typedef struct timeout_param_st {
989 LHASH_OF(SSL_SESSION) *cache;
992 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
994 if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
996 * The reason we don't call SSL_CTX_remove_session() is to save on
999 (void)lh_SSL_SESSION_delete(p->cache, s);
1000 SSL_SESSION_list_remove(p->ctx, s);
1001 s->not_resumable = 1;
1002 if (p->ctx->remove_session_cb != NULL)
1003 p->ctx->remove_session_cb(p->ctx, s);
1004 SSL_SESSION_free(s);
1008 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
1010 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1016 tp.cache = s->sessions;
1017 if (tp.cache == NULL)
1020 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
1021 i = CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
1022 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = 0;
1023 lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
1024 TIMEOUT_PARAM, &tp);
1025 CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = i;
1026 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
1029 int ssl_clear_bad_session(SSL *s)
1031 if ((s->session != NULL) &&
1032 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1033 !(SSL_in_init(s) || SSL_in_before(s))) {
1034 SSL_CTX_remove_session(s->ctx, s->session);
1040 /* locked by SSL_CTX in the calling function */
1041 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1043 if ((s->next == NULL) || (s->prev == NULL))
1046 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1047 /* last element in list */
1048 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1049 /* only one element in list */
1050 ctx->session_cache_head = NULL;
1051 ctx->session_cache_tail = NULL;
1053 ctx->session_cache_tail = s->prev;
1054 s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1057 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1058 /* first element in list */
1059 ctx->session_cache_head = s->next;
1060 s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1062 /* middle of list */
1063 s->next->prev = s->prev;
1064 s->prev->next = s->next;
1067 s->prev = s->next = NULL;
1070 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1072 if ((s->next != NULL) && (s->prev != NULL))
1073 SSL_SESSION_list_remove(ctx, s);
1075 if (ctx->session_cache_head == NULL) {
1076 ctx->session_cache_head = s;
1077 ctx->session_cache_tail = s;
1078 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1079 s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1081 s->next = ctx->session_cache_head;
1083 s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1084 ctx->session_cache_head = s;
1088 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1089 int (*cb) (struct ssl_st *ssl,
1092 ctx->new_session_cb = cb;
1095 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1096 return ctx->new_session_cb;
1099 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1100 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1102 ctx->remove_session_cb = cb;
1105 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1106 SSL_SESSION *sess) {
1107 return ctx->remove_session_cb;
1110 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1111 SSL_SESSION *(*cb) (struct ssl_st *ssl,
1112 unsigned char *data, int len,
1115 ctx->get_session_cb = cb;
1118 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1119 unsigned char *data,
1120 int len, int *copy) {
1121 return ctx->get_session_cb;
1124 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1125 void (*cb) (const SSL *ssl, int type, int val))
1127 ctx->info_callback = cb;
1130 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1132 return ctx->info_callback;
1135 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1136 int (*cb) (SSL *ssl, X509 **x509,
1139 ctx->client_cert_cb = cb;
1142 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1144 return ctx->client_cert_cb;
1147 #ifndef OPENSSL_NO_ENGINE
1148 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1150 if (!ENGINE_init(e)) {
1151 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1154 if (!ENGINE_get_ssl_client_cert_function(e)) {
1155 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1156 SSL_R_NO_CLIENT_CERT_METHOD);
1160 ctx->client_cert_engine = e;
1165 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1166 int (*cb) (SSL *ssl,
1167 unsigned char *cookie,
1168 unsigned int *cookie_len))
1170 ctx->app_gen_cookie_cb = cb;
1173 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1174 int (*cb) (SSL *ssl, unsigned char *cookie,
1175 unsigned int cookie_len))
1177 ctx->app_verify_cookie_cb = cb;
1180 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION,