2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
58 /* ====================================================================
59 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
111 /* ====================================================================
112 * Copyright 2005 Nokia. All rights reserved.
114 * The portions of the attached software ("Contribution") is developed by
115 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
118 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
119 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
120 * support (see RFC 4279) to OpenSSL.
122 * No patent licenses or other rights except those expressly stated in
123 * the OpenSSL open source license shall be deemed granted or received
124 * expressly, by implication, estoppel, or otherwise.
126 * No assurances are provided by Nokia that the Contribution does not
127 * infringe the patent or other intellectual property rights of any third
128 * party or that the license provides you with all the necessary rights
129 * to make use of the Contribution.
131 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
132 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
133 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
134 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
139 #include <openssl/lhash.h>
140 #include <openssl/rand.h>
141 #ifndef OPENSSL_NO_ENGINE
142 # include <openssl/engine.h>
144 #include "ssl_locl.h"
146 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
);
147 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
);
148 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
);
150 SSL_SESSION
*SSL_get_session(const SSL
*ssl
)
151 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
153 return (ssl
->session
);
156 SSL_SESSION
*SSL_get1_session(SSL
*ssl
)
157 /* variant of SSL_get_session: caller really gets something */
161 * Need to lock this all up rather than just use CRYPTO_add so that
162 * somebody doesn't free ssl->session between when we check it's non-null
163 * and when we up the reference count.
165 CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION
);
169 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION
);
173 int SSL_SESSION_get_ex_new_index(long argl
, void *argp
,
174 CRYPTO_EX_new
*new_func
,
175 CRYPTO_EX_dup
*dup_func
,
176 CRYPTO_EX_free
*free_func
)
178 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION
, argl
, argp
,
179 new_func
, dup_func
, free_func
);
182 int SSL_SESSION_set_ex_data(SSL_SESSION
*s
, int idx
, void *arg
)
184 return (CRYPTO_set_ex_data(&s
->ex_data
, idx
, arg
));
187 void *SSL_SESSION_get_ex_data(const SSL_SESSION
*s
, int idx
)
189 return (CRYPTO_get_ex_data(&s
->ex_data
, idx
));
192 SSL_SESSION
*SSL_SESSION_new(void)
196 ss
= OPENSSL_malloc(sizeof(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 * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
245 * the ID with random junk repeatedly until we have no conflict is going to
246 * complete in one iteration pretty much "most" of the time (btw:
247 * understatement). So, if it takes us 10 iterations and we still can't avoid
248 * a conflict - well that's a reasonable point to call it quits. Either the
249 * RAND code is broken or someone is trying to open roughly very close to
250 * 2^256 SSL sessions to our server. How you might store that many sessions
251 * is perhaps a more interesting question ...
254 #define MAX_SESS_ID_ATTEMPTS 10
255 static int def_generate_session_id(const SSL
*ssl
, unsigned char *id
,
256 unsigned int *id_len
)
258 unsigned int retry
= 0;
260 if (RAND_bytes(id
, *id_len
) <= 0)
262 while (SSL_has_matching_session_id(ssl
, id
, *id_len
) &&
263 (++retry
< MAX_SESS_ID_ATTEMPTS
)) ;
264 if (retry
< MAX_SESS_ID_ATTEMPTS
)
266 /* else - woops a session_id match */
268 * XXX We should also check the external cache -- but the probability of
269 * a collision is negligible, and we could not prevent the concurrent
270 * creation of sessions with identical IDs since we currently don't have
271 * means to atomically check whether a session ID already exists and make
272 * a reservation for it if it does not (this problem applies to the
273 * internal cache as well).
278 int ssl_get_new_session(SSL
*s
, int session
)
280 /* This gets used by clients and servers. */
283 SSL_SESSION
*ss
= NULL
;
284 GEN_SESSION_CB cb
= def_generate_session_id
;
286 if ((ss
= SSL_SESSION_new()) == NULL
)
289 /* If the context has a default timeout, use it */
290 if (s
->session_ctx
->session_timeout
== 0)
291 ss
->timeout
= SSL_get_default_timeout(s
);
293 ss
->timeout
= s
->session_ctx
->session_timeout
;
295 SSL_SESSION_free(s
->session
);
299 if (s
->version
== SSL3_VERSION
) {
300 ss
->ssl_version
= SSL3_VERSION
;
301 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
302 } else if (s
->version
== TLS1_VERSION
) {
303 ss
->ssl_version
= TLS1_VERSION
;
304 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
305 } else if (s
->version
== TLS1_1_VERSION
) {
306 ss
->ssl_version
= TLS1_1_VERSION
;
307 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
308 } else if (s
->version
== TLS1_2_VERSION
) {
309 ss
->ssl_version
= TLS1_2_VERSION
;
310 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
311 } else if (s
->version
== DTLS1_BAD_VER
) {
312 ss
->ssl_version
= DTLS1_BAD_VER
;
313 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
314 } else if (s
->version
== DTLS1_VERSION
) {
315 ss
->ssl_version
= DTLS1_VERSION
;
316 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
317 } else if (s
->version
== DTLS1_2_VERSION
) {
318 ss
->ssl_version
= DTLS1_2_VERSION
;
319 ss
->session_id_length
= SSL3_SSL_SESSION_ID_LENGTH
;
321 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, SSL_R_UNSUPPORTED_SSL_VERSION
);
322 SSL_SESSION_free(ss
);
325 #ifndef OPENSSL_NO_TLSEXT
327 * If RFC5077 ticket, use empty session ID (as server).
329 * (a) ssl_get_prev_session() does lookahead into the
330 * ClientHello extensions to find the session ticket.
331 * When ssl_get_prev_session() fails, s3_srvr.c calls
332 * ssl_get_new_session() in ssl3_get_client_hello().
333 * At that point, it has not yet parsed the extensions,
334 * however, because of the lookahead, it already knows
335 * whether a ticket is expected or not.
337 * (b) s3_clnt.c calls ssl_get_new_session() before parsing
338 * ServerHello extensions, and before recording the session
339 * ID received from the server, so this block is a noop.
341 if (s
->tlsext_ticket_expected
) {
342 ss
->session_id_length
= 0;
346 /* Choose which callback will set the session ID */
347 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX
);
348 if (s
->generate_session_id
)
349 cb
= s
->generate_session_id
;
350 else if (s
->session_ctx
->generate_session_id
)
351 cb
= s
->session_ctx
->generate_session_id
;
352 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX
);
353 /* Choose a session ID */
354 tmp
= ss
->session_id_length
;
355 if (!cb(s
, ss
->session_id
, &tmp
)) {
356 /* The callback failed */
357 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,
358 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED
);
359 SSL_SESSION_free(ss
);
363 * Don't allow the callback to set the session length to zero. nor
364 * set it higher than it was.
366 if (!tmp
|| (tmp
> ss
->session_id_length
)) {
367 /* The callback set an illegal length */
368 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,
369 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH
);
370 SSL_SESSION_free(ss
);
373 ss
->session_id_length
= tmp
;
374 /* Finally, check for a conflict */
375 if (SSL_has_matching_session_id(s
, ss
->session_id
,
376 ss
->session_id_length
)) {
377 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, SSL_R_SSL_SESSION_ID_CONFLICT
);
378 SSL_SESSION_free(ss
);
381 #ifndef OPENSSL_NO_TLSEXT
383 if (s
->tlsext_hostname
) {
384 ss
->tlsext_hostname
= BUF_strdup(s
->tlsext_hostname
);
385 if (ss
->tlsext_hostname
== NULL
) {
386 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_INTERNAL_ERROR
);
387 SSL_SESSION_free(ss
);
393 ss
->session_id_length
= 0;
396 if (s
->sid_ctx_length
> sizeof ss
->sid_ctx
) {
397 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_INTERNAL_ERROR
);
398 SSL_SESSION_free(ss
);
401 memcpy(ss
->sid_ctx
, s
->sid_ctx
, s
->sid_ctx_length
);
402 ss
->sid_ctx_length
= s
->sid_ctx_length
;
404 ss
->ssl_version
= s
->version
;
405 ss
->verify_result
= X509_V_OK
;
411 * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
412 * connection. It is only called by servers.
414 * session_id: points at the session ID in the ClientHello. This code will
415 * read past the end of this in order to parse out the session ticket
417 * len: the length of the session ID.
418 * limit: a pointer to the first byte after the ClientHello.
422 * 0: a session may have been found.
425 * - If a session is found then s->session is pointed at it (after freeing an
426 * existing session if need be) and s->verify_result is set from the session.
427 * - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
428 * if the server should issue a new session ticket (to 0 otherwise).
430 int ssl_get_prev_session(SSL
*s
, unsigned char *session_id
, int len
,
431 const unsigned char *limit
)
433 /* This is used only by servers. */
435 SSL_SESSION
*ret
= NULL
;
437 int try_session_cache
= 1;
438 #ifndef OPENSSL_NO_TLSEXT
442 if (len
< 0 || len
> SSL_MAX_SSL_SESSION_ID_LENGTH
)
445 if (session_id
+ len
> limit
) {
451 try_session_cache
= 0;
453 #ifndef OPENSSL_NO_TLSEXT
454 /* sets s->tlsext_ticket_expected */
455 r
= tls1_process_ticket(s
, session_id
, len
, limit
, &ret
);
457 case -1: /* Error during processing */
460 case 0: /* No ticket found */
461 case 1: /* Zero length ticket found */
462 break; /* Ok to carry on processing session id. */
463 case 2: /* Ticket found but not decrypted. */
464 case 3: /* Ticket decrypted, *ret has been set. */
465 try_session_cache
= 0;
472 if (try_session_cache
&&
474 !(s
->session_ctx
->session_cache_mode
&
475 SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
)) {
477 data
.ssl_version
= s
->version
;
478 data
.session_id_length
= len
;
481 memcpy(data
.session_id
, session_id
, len
);
482 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX
);
483 ret
= lh_SSL_SESSION_retrieve(s
->session_ctx
->sessions
, &data
);
485 /* don't allow other threads to steal it: */
486 CRYPTO_add(&ret
->references
, 1, CRYPTO_LOCK_SSL_SESSION
);
488 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX
);
490 s
->session_ctx
->stats
.sess_miss
++;
493 if (try_session_cache
&&
494 ret
== NULL
&& s
->session_ctx
->get_session_cb
!= NULL
) {
497 if ((ret
= s
->session_ctx
->get_session_cb(s
, session_id
, len
, ©
))) {
498 s
->session_ctx
->stats
.sess_cb_hit
++;
501 * Increment reference count now if the session callback asks us
502 * to do so (note that if the session structures returned by the
503 * callback are shared between threads, it must handle the
504 * reference count itself [i.e. copy == 0], or things won't be
508 CRYPTO_add(&ret
->references
, 1, CRYPTO_LOCK_SSL_SESSION
);
511 * Add the externally cached session to the internal cache as
512 * well if and only if we are supposed to.
515 (s
->session_ctx
->session_cache_mode
&
516 SSL_SESS_CACHE_NO_INTERNAL_STORE
)) {
518 * The following should not return 1, otherwise, things are
521 if (SSL_CTX_add_session(s
->session_ctx
, ret
))
530 /* Now ret is non-NULL and we own one of its reference counts. */
532 if (ret
->sid_ctx_length
!= s
->sid_ctx_length
533 || memcmp(ret
->sid_ctx
, s
->sid_ctx
, ret
->sid_ctx_length
)) {
535 * We have the session requested by the client, but we don't want to
536 * use it in this context.
538 goto err
; /* treat like cache miss */
541 if ((s
->verify_mode
& SSL_VERIFY_PEER
) && s
->sid_ctx_length
== 0) {
543 * We can't be sure if this session is being used out of context,
544 * which is especially important for SSL_VERIFY_PEER. The application
545 * should have used SSL[_CTX]_set_session_id_context. For this error
546 * case, we generate an error instead of treating the event like a
547 * cache miss (otherwise it would be easy for applications to
548 * effectively disable the session cache by accident without anyone
552 SSLerr(SSL_F_SSL_GET_PREV_SESSION
,
553 SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
558 if (ret
->cipher
== NULL
) {
559 unsigned char buf
[5], *p
;
565 if ((ret
->ssl_version
>> 8) >= SSL3_VERSION_MAJOR
)
566 ret
->cipher
= ssl_get_cipher_by_char(s
, &(buf
[2]));
568 ret
->cipher
= ssl_get_cipher_by_char(s
, &(buf
[1]));
569 if (ret
->cipher
== NULL
)
573 if (ret
->timeout
< (long)(time(NULL
) - ret
->time
)) { /* timeout */
574 s
->session_ctx
->stats
.sess_timeout
++;
575 if (try_session_cache
) {
576 /* session was from the cache, so remove it */
577 SSL_CTX_remove_session(s
->session_ctx
, ret
);
582 s
->session_ctx
->stats
.sess_hit
++;
584 SSL_SESSION_free(s
->session
);
586 s
->verify_result
= s
->session
->verify_result
;
591 SSL_SESSION_free(ret
);
592 #ifndef OPENSSL_NO_TLSEXT
593 if (!try_session_cache
) {
595 * The session was from a ticket, so we should issue a ticket for
598 s
->tlsext_ticket_expected
= 1;
608 int SSL_CTX_add_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
614 * add just 1 reference count for the SSL_CTX's session cache even though
615 * it has two ways of access: each session is in a doubly linked list and
618 CRYPTO_add(&c
->references
, 1, CRYPTO_LOCK_SSL_SESSION
);
620 * if session c is in already in cache, we take back the increment later
623 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX
);
624 s
= lh_SSL_SESSION_insert(ctx
->sessions
, c
);
627 * s != NULL iff we already had a session with the given PID. In this
628 * case, s == c should hold (then we did not really modify
629 * ctx->sessions), or we're in trouble.
631 if (s
!= NULL
&& s
!= c
) {
632 /* We *are* in trouble ... */
633 SSL_SESSION_list_remove(ctx
, s
);
636 * ... so pretend the other session did not exist in cache (we cannot
637 * handle two SSL_SESSION structures with identical session ID in the
638 * same cache, which could happen e.g. when two threads concurrently
639 * obtain the same session from an external cache)
644 /* Put at the head of the queue unless it is already in the cache */
646 SSL_SESSION_list_add(ctx
, c
);
650 * existing cache entry -- decrement previously incremented reference
651 * count because it already takes into account the cache
654 SSL_SESSION_free(s
); /* s == c */
658 * new cache entry -- remove old ones if cache has become too large
663 if (SSL_CTX_sess_get_cache_size(ctx
) > 0) {
664 while (SSL_CTX_sess_number(ctx
) >
665 SSL_CTX_sess_get_cache_size(ctx
)) {
666 if (!remove_session_lock(ctx
, ctx
->session_cache_tail
, 0))
669 ctx
->stats
.sess_cache_full
++;
673 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX
);
677 int SSL_CTX_remove_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
679 return remove_session_lock(ctx
, c
, 1);
682 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
)
687 if ((c
!= NULL
) && (c
->session_id_length
!= 0)) {
689 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX
);
690 if ((r
= lh_SSL_SESSION_retrieve(ctx
->sessions
, c
)) == c
) {
692 r
= lh_SSL_SESSION_delete(ctx
->sessions
, c
);
693 SSL_SESSION_list_remove(ctx
, c
);
697 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX
);
700 r
->not_resumable
= 1;
701 if (ctx
->remove_session_cb
!= NULL
)
702 ctx
->remove_session_cb(ctx
, r
);
710 void SSL_SESSION_free(SSL_SESSION
*ss
)
717 i
= CRYPTO_add(&ss
->references
, -1, CRYPTO_LOCK_SSL_SESSION
);
719 REF_PRINT("SSL_SESSION", ss
);
725 fprintf(stderr
, "SSL_SESSION_free, bad reference count\n");
730 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
);
732 OPENSSL_cleanse(ss
->master_key
, sizeof ss
->master_key
);
733 OPENSSL_cleanse(ss
->session_id
, sizeof ss
->session_id
);
734 ssl_sess_cert_free(ss
->sess_cert
);
736 sk_SSL_CIPHER_free(ss
->ciphers
);
737 #ifndef OPENSSL_NO_TLSEXT
738 OPENSSL_free(ss
->tlsext_hostname
);
739 OPENSSL_free(ss
->tlsext_tick
);
740 # ifndef OPENSSL_NO_EC
741 ss
->tlsext_ecpointformatlist_length
= 0;
742 OPENSSL_free(ss
->tlsext_ecpointformatlist
);
743 ss
->tlsext_ellipticcurvelist_length
= 0;
744 OPENSSL_free(ss
->tlsext_ellipticcurvelist
);
745 # endif /* OPENSSL_NO_EC */
747 #ifndef OPENSSL_NO_PSK
748 OPENSSL_free(ss
->psk_identity_hint
);
749 OPENSSL_free(ss
->psk_identity
);
751 #ifndef OPENSSL_NO_SRP
752 OPENSSL_free(ss
->srp_username
);
754 OPENSSL_clear_free(ss
, sizeof(*ss
));
757 int SSL_set_session(SSL
*s
, SSL_SESSION
*session
)
760 const SSL_METHOD
*meth
;
762 if (session
!= NULL
) {
763 meth
= s
->ctx
->method
->get_ssl_method(session
->ssl_version
);
765 meth
= s
->method
->get_ssl_method(session
->ssl_version
);
767 SSLerr(SSL_F_SSL_SET_SESSION
, SSL_R_UNABLE_TO_FIND_SSL_METHOD
);
771 if (meth
!= s
->method
) {
772 if (!SSL_set_ssl_method(s
, meth
))
775 #ifndef OPENSSL_NO_KRB5
776 if (s
->kssl_ctx
&& !s
->kssl_ctx
->client_princ
&&
777 session
->krb5_client_princ_len
> 0) {
778 s
->kssl_ctx
->client_princ
=
779 OPENSSL_malloc(session
->krb5_client_princ_len
+ 1);
780 if (s
->kssl_ctx
->client_princ
== NULL
) {
781 SSLerr(SSL_F_SSL_SET_SESSION
, ERR_R_MALLOC_FAILURE
);
784 memcpy(s
->kssl_ctx
->client_princ
, session
->krb5_client_princ
,
785 session
->krb5_client_princ_len
);
786 s
->kssl_ctx
->client_princ
[session
->krb5_client_princ_len
] = '\0';
788 #endif /* OPENSSL_NO_KRB5 */
790 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
791 CRYPTO_add(&session
->references
, 1, CRYPTO_LOCK_SSL_SESSION
);
792 SSL_SESSION_free(s
->session
);
793 s
->session
= session
;
794 s
->verify_result
= s
->session
->verify_result
;
795 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
798 SSL_SESSION_free(s
->session
);
800 meth
= s
->ctx
->method
;
801 if (meth
!= s
->method
) {
802 if (!SSL_set_ssl_method(s
, meth
))
810 long SSL_SESSION_set_timeout(SSL_SESSION
*s
, long t
)
818 long SSL_SESSION_get_timeout(const SSL_SESSION
*s
)
825 long SSL_SESSION_get_time(const SSL_SESSION
*s
)
832 long SSL_SESSION_set_time(SSL_SESSION
*s
, long t
)
840 int SSL_SESSION_has_ticket(const SSL_SESSION
*s
)
842 return (s
->tlsext_ticklen
> 0) ? 1 : 0;
845 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION
*s
)
847 return s
->tlsext_tick_lifetime_hint
;
850 void SSL_SESSION_get0_ticket(const SSL_SESSION
*s
, unsigned char **tick
,
853 *len
= s
->tlsext_ticklen
;
855 *tick
= s
->tlsext_tick
;
858 X509
*SSL_SESSION_get0_peer(SSL_SESSION
*s
)
863 int SSL_SESSION_set1_id_context(SSL_SESSION
*s
, const unsigned char *sid_ctx
,
864 unsigned int sid_ctx_len
)
866 if (sid_ctx_len
> SSL_MAX_SID_CTX_LENGTH
) {
867 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT
,
868 SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG
);
871 s
->sid_ctx_length
= sid_ctx_len
;
872 memcpy(s
->sid_ctx
, sid_ctx
, sid_ctx_len
);
877 long SSL_CTX_set_timeout(SSL_CTX
*s
, long t
)
882 l
= s
->session_timeout
;
883 s
->session_timeout
= t
;
887 long SSL_CTX_get_timeout(const SSL_CTX
*s
)
891 return (s
->session_timeout
);
894 #ifndef OPENSSL_NO_TLSEXT
895 int SSL_set_session_secret_cb(SSL
*s
,
896 int (*tls_session_secret_cb
) (SSL
*s
,
908 s
->tls_session_secret_cb
= tls_session_secret_cb
;
909 s
->tls_session_secret_cb_arg
= arg
;
913 int SSL_set_session_ticket_ext_cb(SSL
*s
, tls_session_ticket_ext_cb_fn cb
,
918 s
->tls_session_ticket_ext_cb
= cb
;
919 s
->tls_session_ticket_ext_cb_arg
= arg
;
923 int SSL_set_session_ticket_ext(SSL
*s
, void *ext_data
, int ext_len
)
925 if (s
->version
>= TLS1_VERSION
) {
926 OPENSSL_free(s
->tlsext_session_ticket
);
927 s
->tlsext_session_ticket
= NULL
;
928 s
->tlsext_session_ticket
=
929 OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT
) + ext_len
);
930 if (!s
->tlsext_session_ticket
) {
931 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT
, ERR_R_MALLOC_FAILURE
);
936 s
->tlsext_session_ticket
->length
= ext_len
;
937 s
->tlsext_session_ticket
->data
= s
->tlsext_session_ticket
+ 1;
938 memcpy(s
->tlsext_session_ticket
->data
, ext_data
, ext_len
);
940 s
->tlsext_session_ticket
->length
= 0;
941 s
->tlsext_session_ticket
->data
= NULL
;
949 #endif /* OPENSSL_NO_TLSEXT */
951 typedef struct timeout_param_st
{
954 LHASH_OF(SSL_SESSION
) *cache
;
957 static void timeout_doall_arg(SSL_SESSION
*s
, TIMEOUT_PARAM
*p
)
959 if ((p
->time
== 0) || (p
->time
> (s
->time
+ s
->timeout
))) { /* timeout */
961 * The reason we don't call SSL_CTX_remove_session() is to save on
964 (void)lh_SSL_SESSION_delete(p
->cache
, s
);
965 SSL_SESSION_list_remove(p
->ctx
, s
);
966 s
->not_resumable
= 1;
967 if (p
->ctx
->remove_session_cb
!= NULL
)
968 p
->ctx
->remove_session_cb(p
->ctx
, s
);
973 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout
, SSL_SESSION
, TIMEOUT_PARAM
)
975 void SSL_CTX_flush_sessions(SSL_CTX
*s
, long t
)
981 tp
.cache
= s
->sessions
;
982 if (tp
.cache
== NULL
)
985 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX
);
986 i
= CHECKED_LHASH_OF(SSL_SESSION
, tp
.cache
)->down_load
;
987 CHECKED_LHASH_OF(SSL_SESSION
, tp
.cache
)->down_load
= 0;
988 lh_SSL_SESSION_doall_arg(tp
.cache
, LHASH_DOALL_ARG_FN(timeout
),
990 CHECKED_LHASH_OF(SSL_SESSION
, tp
.cache
)->down_load
= i
;
991 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX
);
994 int ssl_clear_bad_session(SSL
*s
)
996 if ((s
->session
!= NULL
) &&
997 !(s
->shutdown
& SSL_SENT_SHUTDOWN
) &&
998 !(SSL_in_init(s
) || SSL_in_before(s
))) {
999 SSL_CTX_remove_session(s
->ctx
, s
->session
);
1005 /* locked by SSL_CTX in the calling function */
1006 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1008 if ((s
->next
== NULL
) || (s
->prev
== NULL
))
1011 if (s
->next
== (SSL_SESSION
*)&(ctx
->session_cache_tail
)) {
1012 /* last element in list */
1013 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1014 /* only one element in list */
1015 ctx
->session_cache_head
= NULL
;
1016 ctx
->session_cache_tail
= NULL
;
1018 ctx
->session_cache_tail
= s
->prev
;
1019 s
->prev
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1022 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
)) {
1023 /* first element in list */
1024 ctx
->session_cache_head
= s
->next
;
1025 s
->next
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1027 /* middle of list */
1028 s
->next
->prev
= s
->prev
;
1029 s
->prev
->next
= s
->next
;
1032 s
->prev
= s
->next
= NULL
;
1035 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
)
1037 if ((s
->next
!= NULL
) && (s
->prev
!= NULL
))
1038 SSL_SESSION_list_remove(ctx
, s
);
1040 if (ctx
->session_cache_head
== NULL
) {
1041 ctx
->session_cache_head
= s
;
1042 ctx
->session_cache_tail
= s
;
1043 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1044 s
->next
= (SSL_SESSION
*)&(ctx
->session_cache_tail
);
1046 s
->next
= ctx
->session_cache_head
;
1048 s
->prev
= (SSL_SESSION
*)&(ctx
->session_cache_head
);
1049 ctx
->session_cache_head
= s
;
1053 void SSL_CTX_sess_set_new_cb(SSL_CTX
*ctx
,
1054 int (*cb
) (struct ssl_st
*ssl
,
1057 ctx
->new_session_cb
= cb
;
1060 int (*SSL_CTX_sess_get_new_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, SSL_SESSION
*sess
) {
1061 return ctx
->new_session_cb
;
1064 void SSL_CTX_sess_set_remove_cb(SSL_CTX
*ctx
,
1065 void (*cb
) (SSL_CTX
*ctx
, SSL_SESSION
*sess
))
1067 ctx
->remove_session_cb
= cb
;
1070 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX
*ctx
)) (SSL_CTX
*ctx
,
1071 SSL_SESSION
*sess
) {
1072 return ctx
->remove_session_cb
;
1075 void SSL_CTX_sess_set_get_cb(SSL_CTX
*ctx
,
1076 SSL_SESSION
*(*cb
) (struct ssl_st
*ssl
,
1077 unsigned char *data
, int len
,
1080 ctx
->get_session_cb
= cb
;
1083 SSL_SESSION
*(*SSL_CTX_sess_get_get_cb(SSL_CTX
*ctx
)) (SSL
*ssl
,
1084 unsigned char *data
,
1085 int len
, int *copy
) {
1086 return ctx
->get_session_cb
;
1089 void SSL_CTX_set_info_callback(SSL_CTX
*ctx
,
1090 void (*cb
) (const SSL
*ssl
, int type
, int val
))
1092 ctx
->info_callback
= cb
;
1095 void (*SSL_CTX_get_info_callback(SSL_CTX
*ctx
)) (const SSL
*ssl
, int type
,
1097 return ctx
->info_callback
;
1100 void SSL_CTX_set_client_cert_cb(SSL_CTX
*ctx
,
1101 int (*cb
) (SSL
*ssl
, X509
**x509
,
1104 ctx
->client_cert_cb
= cb
;
1107 int (*SSL_CTX_get_client_cert_cb(SSL_CTX
*ctx
)) (SSL
*ssl
, X509
**x509
,
1109 return ctx
->client_cert_cb
;
1112 #ifndef OPENSSL_NO_ENGINE
1113 int SSL_CTX_set_client_cert_engine(SSL_CTX
*ctx
, ENGINE
*e
)
1115 if (!ENGINE_init(e
)) {
1116 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE
, ERR_R_ENGINE_LIB
);
1119 if (!ENGINE_get_ssl_client_cert_function(e
)) {
1120 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE
,
1121 SSL_R_NO_CLIENT_CERT_METHOD
);
1125 ctx
->client_cert_engine
= e
;
1130 void SSL_CTX_set_cookie_generate_cb(SSL_CTX
*ctx
,
1131 int (*cb
) (SSL
*ssl
,
1132 unsigned char *cookie
,
1133 unsigned int *cookie_len
))
1135 ctx
->app_gen_cookie_cb
= cb
;
1138 void SSL_CTX_set_cookie_verify_cb(SSL_CTX
*ctx
,
1139 int (*cb
) (SSL
*ssl
, unsigned char *cookie
,
1140 unsigned int cookie_len
))
1142 ctx
->app_verify_cookie_cb
= cb
;
1145 IMPLEMENT_PEM_rw(SSL_SESSION
, SSL_SESSION
, PEM_STRING_SSL_SESSION
,