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