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