5dfc4c81bc686de18bf3dffafa251f737215f835
[openssl.git] / ssl / ssl_sess.c
1 /* ssl/ssl_sess.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
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.
8  * 
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).
15  * 
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.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
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)"
40  * 
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
51  * SUCH DAMAGE.
52  * 
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.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
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
71  *    distribution.
72  *
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/)"
77  *
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.
82  *
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.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
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  * ====================================================================
105  *
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).
109  *
110  */
111
112 #include <stdio.h>
113 #include <openssl/lhash.h>
114 #include <openssl/rand.h>
115 #include "ssl_locl.h"
116
117 #ifndef OPENSSL_NO_TLSEXT
118 #define session_ctx initial_ctx
119 #else
120 #define session_ctx ctx
121 #endif
122
123 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
124 static void SSL_SESSION_list_add(SSL_CTX *ctx,SSL_SESSION *s);
125 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
126
127 SSL_SESSION *SSL_get_session(const SSL *ssl)
128 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
129         {
130         return(ssl->session);
131         }
132
133 SSL_SESSION *SSL_get1_session(SSL *ssl)
134 /* variant of SSL_get_session: caller really gets something */
135         {
136         SSL_SESSION *sess;
137         /* Need to lock this all up rather than just use CRYPTO_add so that
138          * somebody doesn't free ssl->session between when we check it's
139          * non-null and when we up the reference count. */
140         CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION);
141         sess = ssl->session;
142         if(sess)
143                 sess->references++;
144         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
145         return(sess);
146         }
147
148 int SSL_SESSION_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
149              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
150         {
151         return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, argl, argp,
152                         new_func, dup_func, free_func);
153         }
154
155 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
156         {
157         return(CRYPTO_set_ex_data(&s->ex_data,idx,arg));
158         }
159
160 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
161         {
162         return(CRYPTO_get_ex_data(&s->ex_data,idx));
163         }
164
165 SSL_SESSION *SSL_SESSION_new(void)
166         {
167         SSL_SESSION *ss;
168
169         ss=(SSL_SESSION *)OPENSSL_malloc(sizeof(SSL_SESSION));
170         if (ss == NULL)
171                 {
172                 SSLerr(SSL_F_SSL_SESSION_NEW,ERR_R_MALLOC_FAILURE);
173                 return(0);
174                 }
175         memset(ss,0,sizeof(SSL_SESSION));
176
177         ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
178         ss->references=1;
179         ss->timeout=60*5+4; /* 5 minute timeout by default */
180         ss->time=(unsigned long)time(NULL);
181         ss->prev=NULL;
182         ss->next=NULL;
183         ss->compress_meth=0;
184 #ifndef OPENSSL_NO_TLSEXT
185         ss->tlsext_hostname = NULL; 
186 #endif
187         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
188         return(ss);
189         }
190
191 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
192         {
193         if(len)
194                 *len = s->session_id_length;
195         return s->session_id;
196         }
197
198 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
199  * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
200  * until we have no conflict is going to complete in one iteration pretty much
201  * "most" of the time (btw: understatement). So, if it takes us 10 iterations
202  * and we still can't avoid a conflict - well that's a reasonable point to call
203  * it quits. Either the RAND code is broken or someone is trying to open roughly
204  * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
205  * store that many sessions is perhaps a more interesting question ... */
206
207 #define MAX_SESS_ID_ATTEMPTS 10
208 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
209                                 unsigned int *id_len)
210 {
211         unsigned int retry = 0;
212         do
213                 if (RAND_pseudo_bytes(id, *id_len) <= 0)
214                         return 0;
215         while(SSL_has_matching_session_id(ssl, id, *id_len) &&
216                 (++retry < MAX_SESS_ID_ATTEMPTS));
217         if(retry < MAX_SESS_ID_ATTEMPTS)
218                 return 1;
219         /* else - woops a session_id match */
220         /* XXX We should also check the external cache --
221          * but the probability of a collision is negligible, and
222          * we could not prevent the concurrent creation of sessions
223          * with identical IDs since we currently don't have means
224          * to atomically check whether a session ID already exists
225          * and make a reservation for it if it does not
226          * (this problem applies to the internal cache as well).
227          */
228         return 0;
229 }
230
231 int ssl_get_new_session(SSL *s, int session)
232         {
233         /* This gets used by clients and servers. */
234
235         unsigned int tmp;
236         SSL_SESSION *ss=NULL;
237         GEN_SESSION_CB cb = def_generate_session_id;
238
239         if ((ss=SSL_SESSION_new()) == NULL) return(0);
240
241         /* If the context has a default timeout, use it */
242         if (s->session_ctx->session_timeout == 0)
243                 ss->timeout=SSL_get_default_timeout(s);
244         else
245                 ss->timeout=s->ctx->session_timeout;
246
247         if (s->session != NULL)
248                 {
249                 SSL_SESSION_free(s->session);
250                 s->session=NULL;
251                 }
252
253         if (session)
254                 {
255                 if (s->version == SSL2_VERSION)
256                         {
257                         ss->ssl_version=SSL2_VERSION;
258                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
259                         }
260                 else if (s->version == SSL3_VERSION)
261                         {
262                         ss->ssl_version=SSL3_VERSION;
263                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
264                         }
265                 else if (s->version == TLS1_VERSION)
266                         {
267                         ss->ssl_version=TLS1_VERSION;
268                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
269                         }
270                 else if (s->version == DTLS1_VERSION)
271                         {
272                         ss->ssl_version=DTLS1_VERSION;
273                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
274                         }
275                 else
276                         {
277                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
278                         SSL_SESSION_free(ss);
279                         return(0);
280                         }
281                 /* Choose which callback will set the session ID */
282                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
283                 if(s->generate_session_id)
284                         cb = s->generate_session_id;
285                 else if(s->session_ctx->generate_session_id)
286                         cb = s->session_ctx->generate_session_id;
287                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
288                 /* Choose a session ID */
289                 tmp = ss->session_id_length;
290                 if(!cb(s, ss->session_id, &tmp))
291                         {
292                         /* The callback failed */
293                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
294                                 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
295                         SSL_SESSION_free(ss);
296                         return(0);
297                         }
298                 /* Don't allow the callback to set the session length to zero.
299                  * nor set it higher than it was. */
300                 if(!tmp || (tmp > ss->session_id_length))
301                         {
302                         /* The callback set an illegal length */
303                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
304                                 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
305                         SSL_SESSION_free(ss);
306                         return(0);
307                         }
308                 /* If the session length was shrunk and we're SSLv2, pad it */
309                 if((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
310                         memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
311                 else
312                         ss->session_id_length = tmp;
313                 /* Finally, check for a conflict */
314                 if(SSL_has_matching_session_id(s, ss->session_id,
315                                                 ss->session_id_length))
316                         {
317                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
318                                 SSL_R_SSL_SESSION_ID_CONFLICT);
319                         SSL_SESSION_free(ss);
320                         return(0);
321                         }
322                 }
323         else
324                 {
325                 ss->session_id_length=0;
326                 }
327
328         if (s->sid_ctx_length > sizeof ss->sid_ctx)
329                 {
330                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
331                 SSL_SESSION_free(ss);
332                 return 0;
333                 }
334         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
335         ss->sid_ctx_length=s->sid_ctx_length;
336         s->session=ss;
337         ss->ssl_version=s->version;
338         ss->verify_result = X509_V_OK;
339
340         return(1);
341         }
342
343 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len)
344         {
345         /* This is used only by servers. */
346
347         SSL_SESSION *ret=NULL,data;
348         int fatal = 0;
349
350         data.ssl_version=s->version;
351         data.session_id_length=len;
352         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
353                 goto err;
354         memcpy(data.session_id,session_id,len);
355
356         if (!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
357                 {
358                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
359                 ret=(SSL_SESSION *)lh_retrieve(s->session_ctx->sessions,&data);
360                 if (ret != NULL)
361                     /* don't allow other threads to steal it: */
362                     CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
363                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
364                 }
365
366         if (ret == NULL)
367                 {
368                 int copy=1;
369         
370                 s->session_ctx->stats.sess_miss++;
371                 ret=NULL;
372                 if (s->session_ctx->get_session_cb != NULL
373                     && (ret=s->session_ctx->get_session_cb(s,session_id,len,&copy))
374                        != NULL)
375                         {
376                         s->session_ctx->stats.sess_cb_hit++;
377
378                         /* Increment reference count now if the session callback
379                          * asks us to do so (note that if the session structures
380                          * returned by the callback are shared between threads,
381                          * it must handle the reference count itself [i.e. copy == 0],
382                          * or things won't be thread-safe). */
383                         if (copy)
384                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
385
386                         /* Add the externally cached session to the internal
387                          * cache as well if and only if we are supposed to. */
388                         if(!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
389                                 /* The following should not return 1, otherwise,
390                                  * things are very strange */
391                                 SSL_CTX_add_session(s->session_ctx,ret);
392                         }
393                 if (ret == NULL)
394                         goto err;
395                 }
396
397         /* Now ret is non-NULL, and we own one of its reference counts. */
398
399         if((s->verify_mode&SSL_VERIFY_PEER)
400            && (!s->sid_ctx_length || ret->sid_ctx_length != s->sid_ctx_length
401                || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length)))
402             {
403                 /* We've found the session named by the client, but we don't
404                  * want to use it in this context. */
405                 
406                 if (s->sid_ctx_length == 0)
407                         {
408                         /* application should have used SSL[_CTX]_set_session_id_context
409                          * -- we could tolerate this and just pretend we never heard
410                          * of this session, but then applications could effectively
411                          * disable the session cache by accident without anyone noticing */
412
413                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
414                         fatal = 1;
415                         goto err;
416                         }
417                 else
418                         {
419 #if 0 /* The client cannot always know when a session is not appropriate,
420            * so we shouldn't generate an error message. */
421
422                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
423 #endif
424                         goto err; /* treat like cache miss */
425                         }
426                 }
427
428         if (ret->cipher == NULL)
429                 {
430                 unsigned char buf[5],*p;
431                 unsigned long l;
432
433                 p=buf;
434                 l=ret->cipher_id;
435                 l2n(l,p);
436                 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
437                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
438                 else 
439                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
440                 if (ret->cipher == NULL)
441                         goto err;
442                 }
443
444
445 #if 0 /* This is way too late. */
446
447         /* If a thread got the session, then 'swaped', and another got
448          * it and then due to a time-out decided to 'OPENSSL_free' it we could
449          * be in trouble.  So I'll increment it now, then double decrement
450          * later - am I speaking rubbish?. */
451         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
452 #endif
453
454         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
455                 {
456                 s->session_ctx->stats.sess_timeout++;
457                 /* remove it from the cache */
458                 SSL_CTX_remove_session(s->session_ctx,ret);
459                 goto err;
460                 }
461
462         s->session_ctx->stats.sess_hit++;
463
464         /* ret->time=time(NULL); */ /* rezero timeout? */
465         /* again, just leave the session 
466          * if it is the same session, we have just incremented and
467          * then decremented the reference count :-) */
468         if (s->session != NULL)
469                 SSL_SESSION_free(s->session);
470         s->session=ret;
471         s->verify_result = s->session->verify_result;
472         return(1);
473
474  err:
475         if (ret != NULL)
476                 SSL_SESSION_free(ret);
477         if (fatal)
478                 return -1;
479         else
480                 return 0;
481         }
482
483 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
484         {
485         int ret=0;
486         SSL_SESSION *s;
487
488         /* add just 1 reference count for the SSL_CTX's session cache
489          * even though it has two ways of access: each session is in a
490          * doubly linked list and an lhash */
491         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
492         /* if session c is in already in cache, we take back the increment later */
493
494         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
495         s=(SSL_SESSION *)lh_insert(ctx->sessions,c);
496         
497         /* s != NULL iff we already had a session with the given PID.
498          * In this case, s == c should hold (then we did not really modify
499          * ctx->sessions), or we're in trouble. */
500         if (s != NULL && s != c)
501                 {
502                 /* We *are* in trouble ... */
503                 SSL_SESSION_list_remove(ctx,s);
504                 SSL_SESSION_free(s);
505                 /* ... so pretend the other session did not exist in cache
506                  * (we cannot handle two SSL_SESSION structures with identical
507                  * session ID in the same cache, which could happen e.g. when
508                  * two threads concurrently obtain the same session from an external
509                  * cache) */
510                 s = NULL;
511                 }
512
513         /* Put at the head of the queue unless it is already in the cache */
514         if (s == NULL)
515                 SSL_SESSION_list_add(ctx,c);
516
517         if (s != NULL)
518                 {
519                 /* existing cache entry -- decrement previously incremented reference
520                  * count because it already takes into account the cache */
521
522                 SSL_SESSION_free(s); /* s == c */
523                 ret=0;
524                 }
525         else
526                 {
527                 /* new cache entry -- remove old ones if cache has become too large */
528                 
529                 ret=1;
530
531                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
532                         {
533                         while (SSL_CTX_sess_number(ctx) >
534                                 SSL_CTX_sess_get_cache_size(ctx))
535                                 {
536                                 if (!remove_session_lock(ctx,
537                                         ctx->session_cache_tail, 0))
538                                         break;
539                                 else
540                                         ctx->stats.sess_cache_full++;
541                                 }
542                         }
543                 }
544         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
545         return(ret);
546         }
547
548 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
549 {
550         return remove_session_lock(ctx, c, 1);
551 }
552
553 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
554         {
555         SSL_SESSION *r;
556         int ret=0;
557
558         if ((c != NULL) && (c->session_id_length != 0))
559                 {
560                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
561                 if ((r = (SSL_SESSION *)lh_retrieve(ctx->sessions,c)) == c)
562                         {
563                         ret=1;
564                         r=(SSL_SESSION *)lh_delete(ctx->sessions,c);
565                         SSL_SESSION_list_remove(ctx,c);
566                         }
567
568                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
569
570                 if (ret)
571                         {
572                         r->not_resumable=1;
573                         if (ctx->remove_session_cb != NULL)
574                                 ctx->remove_session_cb(ctx,r);
575                         SSL_SESSION_free(r);
576                         }
577                 }
578         else
579                 ret=0;
580         return(ret);
581         }
582
583 void SSL_SESSION_free(SSL_SESSION *ss)
584         {
585         int i;
586
587         if(ss == NULL)
588             return;
589
590         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
591 #ifdef REF_PRINT
592         REF_PRINT("SSL_SESSION",ss);
593 #endif
594         if (i > 0) return;
595 #ifdef REF_CHECK
596         if (i < 0)
597                 {
598                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
599                 abort(); /* ok */
600                 }
601 #endif
602
603         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
604
605         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
606         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
607         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
608         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
609         if (ss->peer != NULL) X509_free(ss->peer);
610         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
611 #ifndef OPENSSL_NO_TLSEXT
612         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
613 #endif
614         OPENSSL_cleanse(ss,sizeof(*ss));
615         OPENSSL_free(ss);
616         }
617
618 int SSL_set_session(SSL *s, SSL_SESSION *session)
619         {
620         int ret=0;
621         const SSL_METHOD *meth;
622
623         if (session != NULL)
624                 {
625                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
626                 if (meth == NULL)
627                         meth=s->method->get_ssl_method(session->ssl_version);
628                 if (meth == NULL)
629                         {
630                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
631                         return(0);
632                         }
633
634                 if (meth != s->method)
635                         {
636                         if (!SSL_set_ssl_method(s,meth))
637                                 return(0);
638                         if (s->ctx->session_timeout == 0)
639                                 session->timeout=SSL_get_default_timeout(s);
640                         else
641                                 session->timeout=s->ctx->session_timeout;
642                         }
643
644 #ifndef OPENSSL_NO_KRB5
645                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
646                     session->krb5_client_princ_len > 0)
647                 {
648                     s->kssl_ctx->client_princ = (char *)malloc(session->krb5_client_princ_len + 1);
649                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
650                             session->krb5_client_princ_len);
651                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
652                 }
653 #endif /* OPENSSL_NO_KRB5 */
654
655                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
656                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
657                 if (s->session != NULL)
658                         SSL_SESSION_free(s->session);
659                 s->session=session;
660                 s->verify_result = s->session->verify_result;
661                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
662                 ret=1;
663                 }
664         else
665                 {
666                 if (s->session != NULL)
667                         {
668                         SSL_SESSION_free(s->session);
669                         s->session=NULL;
670                         }
671
672                 meth=s->ctx->method;
673                 if (meth != s->method)
674                         {
675                         if (!SSL_set_ssl_method(s,meth))
676                                 return(0);
677                         }
678                 ret=1;
679                 }
680         return(ret);
681         }
682
683 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
684         {
685         if (s == NULL) return(0);
686         s->timeout=t;
687         return(1);
688         }
689
690 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
691         {
692         if (s == NULL) return(0);
693         return(s->timeout);
694         }
695
696 long SSL_SESSION_get_time(const SSL_SESSION *s)
697         {
698         if (s == NULL) return(0);
699         return(s->time);
700         }
701
702 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
703         {
704         if (s == NULL) return(0);
705         s->time=t;
706         return(t);
707         }
708
709 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
710         {
711         long l;
712         if (s == NULL) return(0);
713         l=s->session_timeout;
714         s->session_timeout=t;
715         return(l);
716         }
717
718 long SSL_CTX_get_timeout(const SSL_CTX *s)
719         {
720         if (s == NULL) return(0);
721         return(s->session_timeout);
722         }
723
724 typedef struct timeout_param_st
725         {
726         SSL_CTX *ctx;
727         long time;
728         LHASH *cache;
729         } TIMEOUT_PARAM;
730
731 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
732         {
733         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
734                 {
735                 /* The reason we don't call SSL_CTX_remove_session() is to
736                  * save on locking overhead */
737                 lh_delete(p->cache,s);
738                 SSL_SESSION_list_remove(p->ctx,s);
739                 s->not_resumable=1;
740                 if (p->ctx->remove_session_cb != NULL)
741                         p->ctx->remove_session_cb(p->ctx,s);
742                 SSL_SESSION_free(s);
743                 }
744         }
745
746 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION *, TIMEOUT_PARAM *)
747
748 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
749         {
750         unsigned long i;
751         TIMEOUT_PARAM tp;
752
753         tp.ctx=s;
754         tp.cache=s->sessions;
755         if (tp.cache == NULL) return;
756         tp.time=t;
757         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
758         i=tp.cache->down_load;
759         tp.cache->down_load=0;
760         lh_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout), &tp);
761         tp.cache->down_load=i;
762         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
763         }
764
765 int ssl_clear_bad_session(SSL *s)
766         {
767         if (    (s->session != NULL) &&
768                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
769                 !(SSL_in_init(s) || SSL_in_before(s)))
770                 {
771                 SSL_CTX_remove_session(s->ctx,s->session);
772                 return(1);
773                 }
774         else
775                 return(0);
776         }
777
778 /* locked by SSL_CTX in the calling function */
779 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
780         {
781         if ((s->next == NULL) || (s->prev == NULL)) return;
782
783         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
784                 { /* last element in list */
785                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
786                         { /* only one element in list */
787                         ctx->session_cache_head=NULL;
788                         ctx->session_cache_tail=NULL;
789                         }
790                 else
791                         {
792                         ctx->session_cache_tail=s->prev;
793                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
794                         }
795                 }
796         else
797                 {
798                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
799                         { /* first element in list */
800                         ctx->session_cache_head=s->next;
801                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
802                         }
803                 else
804                         { /* middle of list */
805                         s->next->prev=s->prev;
806                         s->prev->next=s->next;
807                         }
808                 }
809         s->prev=s->next=NULL;
810         }
811
812 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
813         {
814         if ((s->next != NULL) && (s->prev != NULL))
815                 SSL_SESSION_list_remove(ctx,s);
816
817         if (ctx->session_cache_head == NULL)
818                 {
819                 ctx->session_cache_head=s;
820                 ctx->session_cache_tail=s;
821                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
822                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
823                 }
824         else
825                 {
826                 s->next=ctx->session_cache_head;
827                 s->next->prev=s;
828                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
829                 ctx->session_cache_head=s;
830                 }
831         }
832