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 */
160 /* Need to lock this all up rather than just use CRYPTO_add so that
161 * somebody doesn't free ssl->session between when we check it's
162 * non-null and when we up the reference count. */
163 CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION
);
167 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION
);
171 int SSL_SESSION_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
172 CRYPTO_EX_dup
*dup_func
, CRYPTO_EX_free
*free_func
)
174 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION
, argl
, argp
,
175 new_func
, dup_func
, free_func
);
178 int SSL_SESSION_set_ex_data(SSL_SESSION
*s
, int idx
, void *arg
)
180 return(CRYPTO_set_ex_data(&s
->ex_data
,idx
,arg
));
183 void *SSL_SESSION_get_ex_data(const SSL_SESSION
*s
, int idx
)
185 return(CRYPTO_get_ex_data(&s
->ex_data
,idx
));
188 SSL_SESSION
*SSL_SESSION_new(void)
192 ss
=(SSL_SESSION
*)OPENSSL_malloc(sizeof(SSL_SESSION
));
195 SSLerr(SSL_F_SSL_SESSION_NEW
,ERR_R_MALLOC_FAILURE
);
198 memset(ss
,0,sizeof(SSL_SESSION
));
200 ss
->verify_result
= 1; /* avoid 0 (= X509_V_OK) just in case */
202 ss
->timeout
=60*5+4; /* 5 minute timeout by default */
203 ss
->time
=(unsigned long)time(NULL
);
207 #ifndef OPENSSL_NO_TLSEXT
208 ss
->tlsext_hostname
= NULL
;
209 #ifndef OPENSSL_NO_EC
210 ss
->tlsext_ecpointformatlist_length
= 0;
211 ss
->tlsext_ecpointformatlist
= NULL
;
212 ss
->tlsext_ellipticcurvelist_length
= 0;
213 ss
->tlsext_ellipticcurvelist
= NULL
;
216 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
);
217 #ifndef OPENSSL_NO_PSK
218 ss
->psk_identity_hint
=NULL
;
219 ss
->psk_identity
=NULL
;
224 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION
*s
, unsigned int *len
)
227 *len
= s
->session_id_length
;
228 return s
->session_id
;
231 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
232 * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
233 * until we have no conflict is going to complete in one iteration pretty much
234 * "most" of the time (btw: understatement). So, if it takes us 10 iterations
235 * and we still can't avoid a conflict - well that's a reasonable point to call
236 * it quits. Either the RAND code is broken or someone is trying to open roughly
237 * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
238 * store that many sessions is perhaps a more interesting question ... */
240 #define MAX_SESS_ID_ATTEMPTS 10
241 static int def_generate_session_id(const SSL
*ssl
, unsigned char *id
,
242 unsigned int *id_len
)
244 unsigned int retry
= 0;
246 if (RAND_pseudo_bytes(id
, *id_len
) <= 0)
248 while(SSL_has_matching_session_id(ssl
, id
, *id_len
) &&
249 (++retry
< MAX_SESS_ID_ATTEMPTS
));
250 if(retry
< MAX_SESS_ID_ATTEMPTS
)
252 /* else - woops a session_id match */
253 /* XXX We should also check the external cache --
254 * but the probability of a collision is negligible, and
255 * we could not prevent the concurrent creation of sessions
256 * with identical IDs since we currently don't have means
257 * to atomically check whether a session ID already exists
258 * and make a reservation for it if it does not
259 * (this problem applies to the internal cache as well).
264 int ssl_get_new_session(SSL
*s
, int session
)
266 /* This gets used by clients and servers. */
269 SSL_SESSION
*ss
=NULL
;
270 GEN_SESSION_CB cb
= def_generate_session_id
;
272 if ((ss
=SSL_SESSION_new()) == NULL
) return(0);
274 /* If the context has a default timeout, use it */
275 if (s
->session_ctx
->session_timeout
== 0)
276 ss
->timeout
=SSL_get_default_timeout(s
);
278 ss
->timeout
=s
->session_ctx
->session_timeout
;
280 if (s
->session
!= NULL
)
282 SSL_SESSION_free(s
->session
);
288 if (s
->version
== SSL2_VERSION
)
290 ss
->ssl_version
=SSL2_VERSION
;
291 ss
->session_id_length
=SSL2_SSL_SESSION_ID_LENGTH
;
293 else if (s
->version
== SSL3_VERSION
)
295 ss
->ssl_version
=SSL3_VERSION
;
296 ss
->session_id_length
=SSL3_SSL_SESSION_ID_LENGTH
;
298 else if (s
->version
== TLS1_VERSION
)
300 ss
->ssl_version
=TLS1_VERSION
;
301 ss
->session_id_length
=SSL3_SSL_SESSION_ID_LENGTH
;
303 else if (s
->version
== DTLS1_VERSION
)
305 ss
->ssl_version
=DTLS1_VERSION
;
306 ss
->session_id_length
=SSL3_SSL_SESSION_ID_LENGTH
;
310 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,SSL_R_UNSUPPORTED_SSL_VERSION
);
311 SSL_SESSION_free(ss
);
314 #ifndef OPENSSL_NO_TLSEXT
315 /* If RFC4507 ticket use empty session ID */
316 if (s
->tlsext_ticket_expected
)
318 ss
->session_id_length
= 0;
322 /* Choose which callback will set the session ID */
323 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX
);
324 if(s
->generate_session_id
)
325 cb
= s
->generate_session_id
;
326 else if(s
->session_ctx
->generate_session_id
)
327 cb
= s
->session_ctx
->generate_session_id
;
328 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX
);
329 /* Choose a session ID */
330 tmp
= ss
->session_id_length
;
331 if(!cb(s
, ss
->session_id
, &tmp
))
333 /* The callback failed */
334 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,
335 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED
);
336 SSL_SESSION_free(ss
);
339 /* Don't allow the callback to set the session length to zero.
340 * nor set it higher than it was. */
341 if(!tmp
|| (tmp
> ss
->session_id_length
))
343 /* The callback set an illegal length */
344 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,
345 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH
);
346 SSL_SESSION_free(ss
);
349 /* If the session length was shrunk and we're SSLv2, pad it */
350 if((tmp
< ss
->session_id_length
) && (s
->version
== SSL2_VERSION
))
351 memset(ss
->session_id
+ tmp
, 0, ss
->session_id_length
- tmp
);
353 ss
->session_id_length
= tmp
;
354 /* Finally, check for a conflict */
355 if(SSL_has_matching_session_id(s
, ss
->session_id
,
356 ss
->session_id_length
))
358 SSLerr(SSL_F_SSL_GET_NEW_SESSION
,
359 SSL_R_SSL_SESSION_ID_CONFLICT
);
360 SSL_SESSION_free(ss
);
363 #ifndef OPENSSL_NO_TLSEXT
365 if (s
->tlsext_hostname
) {
366 ss
->tlsext_hostname
= BUF_strdup(s
->tlsext_hostname
);
367 if (ss
->tlsext_hostname
== NULL
) {
368 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_INTERNAL_ERROR
);
369 SSL_SESSION_free(ss
);
373 #ifndef OPENSSL_NO_EC
374 if (s
->tlsext_ecpointformatlist
)
376 if (ss
->tlsext_ecpointformatlist
!= NULL
) OPENSSL_free(ss
->tlsext_ecpointformatlist
);
377 if ((ss
->tlsext_ecpointformatlist
= OPENSSL_malloc(s
->tlsext_ecpointformatlist_length
)) == NULL
)
379 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_MALLOC_FAILURE
);
380 SSL_SESSION_free(ss
);
383 ss
->tlsext_ecpointformatlist_length
= s
->tlsext_ecpointformatlist_length
;
384 memcpy(ss
->tlsext_ecpointformatlist
, s
->tlsext_ecpointformatlist
, s
->tlsext_ecpointformatlist_length
);
386 if (s
->tlsext_ellipticcurvelist
)
388 if (ss
->tlsext_ellipticcurvelist
!= NULL
) OPENSSL_free(ss
->tlsext_ellipticcurvelist
);
389 if ((ss
->tlsext_ellipticcurvelist
= OPENSSL_malloc(s
->tlsext_ellipticcurvelist_length
)) == NULL
)
391 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_MALLOC_FAILURE
);
392 SSL_SESSION_free(ss
);
395 ss
->tlsext_ellipticcurvelist_length
= s
->tlsext_ellipticcurvelist_length
;
396 memcpy(ss
->tlsext_ellipticcurvelist
, s
->tlsext_ellipticcurvelist
, s
->tlsext_ellipticcurvelist_length
);
403 ss
->session_id_length
=0;
406 if (s
->sid_ctx_length
> sizeof ss
->sid_ctx
)
408 SSLerr(SSL_F_SSL_GET_NEW_SESSION
, ERR_R_INTERNAL_ERROR
);
409 SSL_SESSION_free(ss
);
412 memcpy(ss
->sid_ctx
,s
->sid_ctx
,s
->sid_ctx_length
);
413 ss
->sid_ctx_length
=s
->sid_ctx_length
;
415 ss
->ssl_version
=s
->version
;
416 ss
->verify_result
= X509_V_OK
;
421 int ssl_get_prev_session(SSL
*s
, unsigned char *session_id
, int len
,
422 const unsigned char *limit
)
424 /* This is used only by servers. */
426 SSL_SESSION
*ret
=NULL
;
428 #ifndef OPENSSL_NO_TLSEXT
432 if (len
> SSL_MAX_SSL_SESSION_ID_LENGTH
)
434 #ifndef OPENSSL_NO_TLSEXT
435 r
= tls1_process_ticket(s
, session_id
, len
, limit
, &ret
);
441 else if (r
== 0 || (!ret
&& !len
))
443 else if (!ret
&& !(s
->session_ctx
->session_cache_mode
& SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
))
447 if (!(s
->session_ctx
->session_cache_mode
& SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
))
451 data
.ssl_version
=s
->version
;
452 data
.session_id_length
=len
;
455 memcpy(data
.session_id
,session_id
,len
);
456 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX
);
457 ret
=lh_SSL_SESSION_retrieve(s
->session_ctx
->sessions
,&data
);
459 /* don't allow other threads to steal it: */
460 CRYPTO_add(&ret
->references
,1,CRYPTO_LOCK_SSL_SESSION
);
461 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX
);
468 s
->session_ctx
->stats
.sess_miss
++;
470 if (s
->session_ctx
->get_session_cb
!= NULL
471 && (ret
=s
->session_ctx
->get_session_cb(s
,session_id
,len
,©
))
474 s
->session_ctx
->stats
.sess_cb_hit
++;
476 /* Increment reference count now if the session callback
477 * asks us to do so (note that if the session structures
478 * returned by the callback are shared between threads,
479 * it must handle the reference count itself [i.e. copy == 0],
480 * or things won't be thread-safe). */
482 CRYPTO_add(&ret
->references
,1,CRYPTO_LOCK_SSL_SESSION
);
484 /* Add the externally cached session to the internal
485 * cache as well if and only if we are supposed to. */
486 if(!(s
->session_ctx
->session_cache_mode
& SSL_SESS_CACHE_NO_INTERNAL_STORE
))
487 /* The following should not return 1, otherwise,
488 * things are very strange */
489 SSL_CTX_add_session(s
->session_ctx
,ret
);
495 /* Now ret is non-NULL, and we own one of its reference counts. */
497 if (ret
->sid_ctx_length
!= s
->sid_ctx_length
498 || memcmp(ret
->sid_ctx
,s
->sid_ctx
,ret
->sid_ctx_length
))
500 /* We've found the session named by the client, but we don't
501 * want to use it in this context. */
503 #if 0 /* The client cannot always know when a session is not appropriate,
504 * so we shouldn't generate an error message. */
506 SSLerr(SSL_F_SSL_GET_PREV_SESSION
,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT
);
508 goto err
; /* treat like cache miss */
511 if((s
->verify_mode
& SSL_VERIFY_PEER
) && s
->sid_ctx_length
== 0)
513 /* We can't be sure if this session is being used out of
514 * context, which is especially important for SSL_VERIFY_PEER.
515 * The application should have used SSL[_CTX]_set_session_id_context.
517 * For this error case, we generate an error instead of treating
518 * the event like a cache miss (otherwise it would be easy for
519 * applications to effectively disable the session cache by
520 * accident without anyone noticing).
523 SSLerr(SSL_F_SSL_GET_PREV_SESSION
,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED
);
528 if (ret
->cipher
== NULL
)
530 unsigned char buf
[5],*p
;
536 if ((ret
->ssl_version
>>8) == SSL3_VERSION_MAJOR
)
537 ret
->cipher
=ssl_get_cipher_by_char(s
,&(buf
[2]));
539 ret
->cipher
=ssl_get_cipher_by_char(s
,&(buf
[1]));
540 if (ret
->cipher
== NULL
)
545 #if 0 /* This is way too late. */
547 /* If a thread got the session, then 'swaped', and another got
548 * it and then due to a time-out decided to 'OPENSSL_free' it we could
549 * be in trouble. So I'll increment it now, then double decrement
550 * later - am I speaking rubbish?. */
551 CRYPTO_add(&ret
->references
,1,CRYPTO_LOCK_SSL_SESSION
);
554 if (ret
->timeout
< (long)(time(NULL
) - ret
->time
)) /* timeout */
556 s
->session_ctx
->stats
.sess_timeout
++;
557 /* remove it from the cache */
558 SSL_CTX_remove_session(s
->session_ctx
,ret
);
562 s
->session_ctx
->stats
.sess_hit
++;
564 /* ret->time=time(NULL); */ /* rezero timeout? */
565 /* again, just leave the session
566 * if it is the same session, we have just incremented and
567 * then decremented the reference count :-) */
568 if (s
->session
!= NULL
)
569 SSL_SESSION_free(s
->session
);
571 s
->verify_result
= s
->session
->verify_result
;
576 SSL_SESSION_free(ret
);
583 int SSL_CTX_add_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
588 /* add just 1 reference count for the SSL_CTX's session cache
589 * even though it has two ways of access: each session is in a
590 * doubly linked list and an lhash */
591 CRYPTO_add(&c
->references
,1,CRYPTO_LOCK_SSL_SESSION
);
592 /* if session c is in already in cache, we take back the increment later */
594 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX
);
595 s
=lh_SSL_SESSION_insert(ctx
->sessions
,c
);
597 /* s != NULL iff we already had a session with the given PID.
598 * In this case, s == c should hold (then we did not really modify
599 * ctx->sessions), or we're in trouble. */
600 if (s
!= NULL
&& s
!= c
)
602 /* We *are* in trouble ... */
603 SSL_SESSION_list_remove(ctx
,s
);
605 /* ... so pretend the other session did not exist in cache
606 * (we cannot handle two SSL_SESSION structures with identical
607 * session ID in the same cache, which could happen e.g. when
608 * two threads concurrently obtain the same session from an external
613 /* Put at the head of the queue unless it is already in the cache */
615 SSL_SESSION_list_add(ctx
,c
);
619 /* existing cache entry -- decrement previously incremented reference
620 * count because it already takes into account the cache */
622 SSL_SESSION_free(s
); /* s == c */
627 /* new cache entry -- remove old ones if cache has become too large */
631 if (SSL_CTX_sess_get_cache_size(ctx
) > 0)
633 while (SSL_CTX_sess_number(ctx
) >
634 SSL_CTX_sess_get_cache_size(ctx
))
636 if (!remove_session_lock(ctx
,
637 ctx
->session_cache_tail
, 0))
640 ctx
->stats
.sess_cache_full
++;
644 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX
);
648 int SSL_CTX_remove_session(SSL_CTX
*ctx
, SSL_SESSION
*c
)
650 return remove_session_lock(ctx
, c
, 1);
653 static int remove_session_lock(SSL_CTX
*ctx
, SSL_SESSION
*c
, int lck
)
658 if ((c
!= NULL
) && (c
->session_id_length
!= 0))
660 if(lck
) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX
);
661 if ((r
= lh_SSL_SESSION_retrieve(ctx
->sessions
,c
)) == c
)
664 r
=lh_SSL_SESSION_delete(ctx
->sessions
,c
);
665 SSL_SESSION_list_remove(ctx
,c
);
668 if(lck
) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX
);
673 if (ctx
->remove_session_cb
!= NULL
)
674 ctx
->remove_session_cb(ctx
,r
);
683 void SSL_SESSION_free(SSL_SESSION
*ss
)
690 i
=CRYPTO_add(&ss
->references
,-1,CRYPTO_LOCK_SSL_SESSION
);
692 REF_PRINT("SSL_SESSION",ss
);
698 fprintf(stderr
,"SSL_SESSION_free, bad reference count\n");
703 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION
, ss
, &ss
->ex_data
);
705 OPENSSL_cleanse(ss
->key_arg
,sizeof ss
->key_arg
);
706 OPENSSL_cleanse(ss
->master_key
,sizeof ss
->master_key
);
707 OPENSSL_cleanse(ss
->session_id
,sizeof ss
->session_id
);
708 if (ss
->sess_cert
!= NULL
) ssl_sess_cert_free(ss
->sess_cert
);
709 if (ss
->peer
!= NULL
) X509_free(ss
->peer
);
710 if (ss
->ciphers
!= NULL
) sk_SSL_CIPHER_free(ss
->ciphers
);
711 #ifndef OPENSSL_NO_TLSEXT
712 if (ss
->tlsext_hostname
!= NULL
) OPENSSL_free(ss
->tlsext_hostname
);
713 if (ss
->tlsext_tick
!= NULL
) OPENSSL_free(ss
->tlsext_tick
);
714 #ifndef OPENSSL_NO_EC
715 ss
->tlsext_ecpointformatlist_length
= 0;
716 if (ss
->tlsext_ecpointformatlist
!= NULL
) OPENSSL_free(ss
->tlsext_ecpointformatlist
);
717 ss
->tlsext_ellipticcurvelist_length
= 0;
718 if (ss
->tlsext_ellipticcurvelist
!= NULL
) OPENSSL_free(ss
->tlsext_ellipticcurvelist
);
719 #endif /* OPENSSL_NO_EC */
721 #ifndef OPENSSL_NO_PSK
722 if (ss
->psk_identity_hint
!= NULL
)
723 OPENSSL_free(ss
->psk_identity_hint
);
724 if (ss
->psk_identity
!= NULL
)
725 OPENSSL_free(ss
->psk_identity
);
727 OPENSSL_cleanse(ss
,sizeof(*ss
));
731 int SSL_set_session(SSL
*s
, SSL_SESSION
*session
)
734 const SSL_METHOD
*meth
;
738 meth
=s
->ctx
->method
->get_ssl_method(session
->ssl_version
);
740 meth
=s
->method
->get_ssl_method(session
->ssl_version
);
743 SSLerr(SSL_F_SSL_SET_SESSION
,SSL_R_UNABLE_TO_FIND_SSL_METHOD
);
747 if (meth
!= s
->method
)
749 if (!SSL_set_ssl_method(s
,meth
))
751 if (s
->ctx
->session_timeout
== 0)
752 session
->timeout
=SSL_get_default_timeout(s
);
754 session
->timeout
=s
->ctx
->session_timeout
;
757 #ifndef OPENSSL_NO_KRB5
758 if (s
->kssl_ctx
&& !s
->kssl_ctx
->client_princ
&&
759 session
->krb5_client_princ_len
> 0)
761 s
->kssl_ctx
->client_princ
= (char *)OPENSSL_malloc(session
->krb5_client_princ_len
+ 1);
762 memcpy(s
->kssl_ctx
->client_princ
,session
->krb5_client_princ
,
763 session
->krb5_client_princ_len
);
764 s
->kssl_ctx
->client_princ
[session
->krb5_client_princ_len
] = '\0';
766 #endif /* OPENSSL_NO_KRB5 */
768 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
769 CRYPTO_add(&session
->references
,1,CRYPTO_LOCK_SSL_SESSION
);
770 if (s
->session
!= NULL
)
771 SSL_SESSION_free(s
->session
);
773 s
->verify_result
= s
->session
->verify_result
;
774 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
779 if (s
->session
!= NULL
)
781 SSL_SESSION_free(s
->session
);
786 if (meth
!= s
->method
)
788 if (!SSL_set_ssl_method(s
,meth
))
796 long SSL_SESSION_set_timeout(SSL_SESSION
*s
, long t
)
798 if (s
== NULL
) return(0);
803 long SSL_SESSION_get_timeout(const SSL_SESSION
*s
)
805 if (s
== NULL
) return(0);
809 long SSL_SESSION_get_time(const SSL_SESSION
*s
)
811 if (s
== NULL
) return(0);
815 long SSL_SESSION_set_time(SSL_SESSION
*s
, long t
)
817 if (s
== NULL
) return(0);
822 long SSL_CTX_set_timeout(SSL_CTX
*s
, long t
)
825 if (s
== NULL
) return(0);
826 l
=s
->session_timeout
;
827 s
->session_timeout
=t
;
831 long SSL_CTX_get_timeout(const SSL_CTX
*s
)
833 if (s
== NULL
) return(0);
834 return(s
->session_timeout
);
837 #ifndef OPENSSL_NO_TLSEXT
838 int SSL_set_session_secret_cb(SSL
*s
, int (*tls_session_secret_cb
)(SSL
*s
, void *secret
, int *secret_len
,
839 STACK_OF(SSL_CIPHER
) *peer_ciphers
, SSL_CIPHER
**cipher
, void *arg
), void *arg
)
841 if (s
== NULL
) return(0);
842 s
->tls_session_secret_cb
= tls_session_secret_cb
;
843 s
->tls_session_secret_cb_arg
= arg
;
847 int SSL_set_session_ticket_ext_cb(SSL
*s
, tls_session_ticket_ext_cb_fn cb
,
850 if (s
== NULL
) return(0);
851 s
->tls_session_ticket_ext_cb
= cb
;
852 s
->tls_session_ticket_ext_cb_arg
= arg
;
856 int SSL_set_session_ticket_ext(SSL
*s
, void *ext_data
, int ext_len
)
858 if (s
->version
>= TLS1_VERSION
)
860 if (s
->tlsext_session_ticket
)
862 OPENSSL_free(s
->tlsext_session_ticket
);
863 s
->tlsext_session_ticket
= NULL
;
866 s
->tlsext_session_ticket
= OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT
) + ext_len
);
867 if (!s
->tlsext_session_ticket
)
869 SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT
, ERR_R_MALLOC_FAILURE
);
875 s
->tlsext_session_ticket
->length
= ext_len
;
876 s
->tlsext_session_ticket
->data
= s
->tlsext_session_ticket
+ 1;
877 memcpy(s
->tlsext_session_ticket
->data
, ext_data
, ext_len
);
881 s
->tlsext_session_ticket
->length
= 0;
882 s
->tlsext_session_ticket
->data
= NULL
;
890 #endif /* OPENSSL_NO_TLSEXT */
892 typedef struct timeout_param_st
896 LHASH_OF(SSL_SESSION
) *cache
;
899 static void timeout_doall_arg(SSL_SESSION
*s
, TIMEOUT_PARAM
*p
)
901 if ((p
->time
== 0) || (p
->time
> (s
->time
+s
->timeout
))) /* timeout */
903 /* The reason we don't call SSL_CTX_remove_session() is to
904 * save on locking overhead */
905 (void)lh_SSL_SESSION_delete(p
->cache
,s
);
906 SSL_SESSION_list_remove(p
->ctx
,s
);
908 if (p
->ctx
->remove_session_cb
!= NULL
)
909 p
->ctx
->remove_session_cb(p
->ctx
,s
);
914 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout
, SSL_SESSION
, TIMEOUT_PARAM
)
916 void SSL_CTX_flush_sessions(SSL_CTX
*s
, long t
)
922 tp
.cache
=s
->sessions
;
923 if (tp
.cache
== NULL
) return;
925 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX
);
926 i
=CHECKED_LHASH_OF(SSL_SESSION
, tp
.cache
)->down_load
;
927 CHECKED_LHASH_OF(SSL_SESSION
, tp
.cache
)->down_load
=0;
928 lh_SSL_SESSION_doall_arg(tp
.cache
, LHASH_DOALL_ARG_FN(timeout
),
930 CHECKED_LHASH_OF(SSL_SESSION
, tp
.cache
)->down_load
=i
;
931 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX
);
934 int ssl_clear_bad_session(SSL
*s
)
936 if ( (s
->session
!= NULL
) &&
937 !(s
->shutdown
& SSL_SENT_SHUTDOWN
) &&
938 !(SSL_in_init(s
) || SSL_in_before(s
)))
940 SSL_CTX_remove_session(s
->ctx
,s
->session
);
947 /* locked by SSL_CTX in the calling function */
948 static void SSL_SESSION_list_remove(SSL_CTX
*ctx
, SSL_SESSION
*s
)
950 if ((s
->next
== NULL
) || (s
->prev
== NULL
)) return;
952 if (s
->next
== (SSL_SESSION
*)&(ctx
->session_cache_tail
))
953 { /* last element in list */
954 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
))
955 { /* only one element in list */
956 ctx
->session_cache_head
=NULL
;
957 ctx
->session_cache_tail
=NULL
;
961 ctx
->session_cache_tail
=s
->prev
;
962 s
->prev
->next
=(SSL_SESSION
*)&(ctx
->session_cache_tail
);
967 if (s
->prev
== (SSL_SESSION
*)&(ctx
->session_cache_head
))
968 { /* first element in list */
969 ctx
->session_cache_head
=s
->next
;
970 s
->next
->prev
=(SSL_SESSION
*)&(ctx
->session_cache_head
);
973 { /* middle of list */
974 s
->next
->prev
=s
->prev
;
975 s
->prev
->next
=s
->next
;
978 s
->prev
=s
->next
=NULL
;
981 static void SSL_SESSION_list_add(SSL_CTX
*ctx
, SSL_SESSION
*s
)
983 if ((s
->next
!= NULL
) && (s
->prev
!= NULL
))
984 SSL_SESSION_list_remove(ctx
,s
);
986 if (ctx
->session_cache_head
== NULL
)
988 ctx
->session_cache_head
=s
;
989 ctx
->session_cache_tail
=s
;
990 s
->prev
=(SSL_SESSION
*)&(ctx
->session_cache_head
);
991 s
->next
=(SSL_SESSION
*)&(ctx
->session_cache_tail
);
995 s
->next
=ctx
->session_cache_head
;
997 s
->prev
=(SSL_SESSION
*)&(ctx
->session_cache_head
);
998 ctx
->session_cache_head
=s
;
1002 void SSL_CTX_sess_set_new_cb(SSL_CTX
*ctx
,
1003 int (*cb
)(struct ssl_st
*ssl
,SSL_SESSION
*sess
))
1005 ctx
->new_session_cb
=cb
;
1008 int (*SSL_CTX_sess_get_new_cb(SSL_CTX
*ctx
))(SSL
*ssl
, SSL_SESSION
*sess
)
1010 return ctx
->new_session_cb
;
1013 void SSL_CTX_sess_set_remove_cb(SSL_CTX
*ctx
,
1014 void (*cb
)(SSL_CTX
*ctx
,SSL_SESSION
*sess
))
1016 ctx
->remove_session_cb
=cb
;
1019 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX
*ctx
))(SSL_CTX
* ctx
,SSL_SESSION
*sess
)
1021 return ctx
->remove_session_cb
;
1024 void SSL_CTX_sess_set_get_cb(SSL_CTX
*ctx
,
1025 SSL_SESSION
*(*cb
)(struct ssl_st
*ssl
,
1026 unsigned char *data
,int len
,int *copy
))
1028 ctx
->get_session_cb
=cb
;
1031 SSL_SESSION
* (*SSL_CTX_sess_get_get_cb(SSL_CTX
*ctx
))(SSL
*ssl
,
1032 unsigned char *data
,int len
,int *copy
)
1034 return ctx
->get_session_cb
;
1037 void SSL_CTX_set_info_callback(SSL_CTX
*ctx
,
1038 void (*cb
)(const SSL
*ssl
,int type
,int val
))
1040 ctx
->info_callback
=cb
;
1043 void (*SSL_CTX_get_info_callback(SSL_CTX
*ctx
))(const SSL
*ssl
,int type
,int val
)
1045 return ctx
->info_callback
;
1048 void SSL_CTX_set_client_cert_cb(SSL_CTX
*ctx
,
1049 int (*cb
)(SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
))
1051 ctx
->client_cert_cb
=cb
;
1054 int (*SSL_CTX_get_client_cert_cb(SSL_CTX
*ctx
))(SSL
* ssl
, X509
** x509
, EVP_PKEY
**pkey
)
1056 return ctx
->client_cert_cb
;
1059 #ifndef OPENSSL_NO_ENGINE
1060 int SSL_CTX_set_client_cert_engine(SSL_CTX
*ctx
, ENGINE
*e
)
1062 if (!ENGINE_init(e
))
1064 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE
, ERR_R_ENGINE_LIB
);
1067 if(!ENGINE_get_ssl_client_cert_function(e
))
1069 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE
, SSL_R_NO_CLIENT_CERT_METHOD
);
1073 ctx
->client_cert_engine
= e
;
1078 void SSL_CTX_set_cookie_generate_cb(SSL_CTX
*ctx
,
1079 int (*cb
)(SSL
*ssl
, unsigned char *cookie
, unsigned int *cookie_len
))
1081 ctx
->app_gen_cookie_cb
=cb
;
1084 void SSL_CTX_set_cookie_verify_cb(SSL_CTX
*ctx
,
1085 int (*cb
)(SSL
*ssl
, unsigned char *cookie
, unsigned int cookie_len
))
1087 ctx
->app_verify_cookie_cb
=cb
;
1090 IMPLEMENT_PEM_rw(SSL_SESSION
, SSL_SESSION
, PEM_STRING_SSL_SESSION
, SSL_SESSION
)