Don't send zero length session ID if stateless session resupmtion is
[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         ss->tlsext_ellipticcurvelist_length = 0;
210         ss->tlsext_ellipticcurvelist = NULL;
211 #endif
212 #endif
213         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
214 #ifndef OPENSSL_NO_PSK
215         ss->psk_identity_hint=NULL;
216         ss->psk_identity=NULL;
217 #endif
218         return(ss);
219         }
220
221 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
222         {
223         if(len)
224                 *len = s->session_id_length;
225         return s->session_id;
226         }
227
228 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
229  * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
230  * until we have no conflict is going to complete in one iteration pretty much
231  * "most" of the time (btw: understatement). So, if it takes us 10 iterations
232  * and we still can't avoid a conflict - well that's a reasonable point to call
233  * it quits. Either the RAND code is broken or someone is trying to open roughly
234  * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
235  * store that many sessions is perhaps a more interesting question ... */
236
237 #define MAX_SESS_ID_ATTEMPTS 10
238 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
239                                 unsigned int *id_len)
240 {
241         unsigned int retry = 0;
242         do
243                 if (RAND_pseudo_bytes(id, *id_len) <= 0)
244                         return 0;
245         while(SSL_has_matching_session_id(ssl, id, *id_len) &&
246                 (++retry < MAX_SESS_ID_ATTEMPTS));
247         if(retry < MAX_SESS_ID_ATTEMPTS)
248                 return 1;
249         /* else - woops a session_id match */
250         /* XXX We should also check the external cache --
251          * but the probability of a collision is negligible, and
252          * we could not prevent the concurrent creation of sessions
253          * with identical IDs since we currently don't have means
254          * to atomically check whether a session ID already exists
255          * and make a reservation for it if it does not
256          * (this problem applies to the internal cache as well).
257          */
258         return 0;
259 }
260
261 int ssl_get_new_session(SSL *s, int session)
262         {
263         /* This gets used by clients and servers. */
264
265         unsigned int tmp;
266         SSL_SESSION *ss=NULL;
267         GEN_SESSION_CB cb = def_generate_session_id;
268
269         if ((ss=SSL_SESSION_new()) == NULL) return(0);
270
271         /* If the context has a default timeout, use it */
272         if (s->session_ctx->session_timeout == 0)
273                 ss->timeout=SSL_get_default_timeout(s);
274         else
275                 ss->timeout=s->session_ctx->session_timeout;
276
277         if (s->session != NULL)
278                 {
279                 SSL_SESSION_free(s->session);
280                 s->session=NULL;
281                 }
282
283         if (session)
284                 {
285                 if (s->version == SSL2_VERSION)
286                         {
287                         ss->ssl_version=SSL2_VERSION;
288                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
289                         }
290                 else if (s->version == SSL3_VERSION)
291                         {
292                         ss->ssl_version=SSL3_VERSION;
293                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
294                         }
295                 else if (s->version == TLS1_VERSION)
296                         {
297                         ss->ssl_version=TLS1_VERSION;
298                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
299                         }
300                 else if (s->version == DTLS1_VERSION)
301                         {
302                         ss->ssl_version=DTLS1_VERSION;
303                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
304                         }
305                 else
306                         {
307                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
308                         SSL_SESSION_free(ss);
309                         return(0);
310                         }
311 #ifndef OPENSSL_NO_TLSEXT
312                 /* If RFC4507 ticket use empty session ID */
313                 if (s->tlsext_ticket_expected)
314                         {
315                         ss->session_id_length = 0;
316                         goto sess_id_done;
317                         }
318 #endif
319                 /* Choose which callback will set the session ID */
320                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
321                 if(s->generate_session_id)
322                         cb = s->generate_session_id;
323                 else if(s->session_ctx->generate_session_id)
324                         cb = s->session_ctx->generate_session_id;
325                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
326                 /* Choose a session ID */
327                 tmp = ss->session_id_length;
328                 if(!cb(s, ss->session_id, &tmp))
329                         {
330                         /* The callback failed */
331                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
332                                 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
333                         SSL_SESSION_free(ss);
334                         return(0);
335                         }
336                 /* Don't allow the callback to set the session length to zero.
337                  * nor set it higher than it was. */
338                 if(!tmp || (tmp > ss->session_id_length))
339                         {
340                         /* The callback set an illegal length */
341                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
342                                 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
343                         SSL_SESSION_free(ss);
344                         return(0);
345                         }
346                 /* If the session length was shrunk and we're SSLv2, pad it */
347                 if((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
348                         memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
349                 else
350                         ss->session_id_length = tmp;
351                 /* Finally, check for a conflict */
352                 if(SSL_has_matching_session_id(s, ss->session_id,
353                                                 ss->session_id_length))
354                         {
355                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
356                                 SSL_R_SSL_SESSION_ID_CONFLICT);
357                         SSL_SESSION_free(ss);
358                         return(0);
359                         }
360 #ifndef OPENSSL_NO_TLSEXT
361                 sess_id_done:
362                 if (s->tlsext_hostname) {
363                         ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
364                         if (ss->tlsext_hostname == NULL) {
365                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
366                                 SSL_SESSION_free(ss);
367                                 return 0;
368                                 }
369                         }
370 #ifndef OPENSSL_NO_EC
371                 if (s->tlsext_ecpointformatlist)
372                         {
373                         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
374                         if ((ss->tlsext_ecpointformatlist = OPENSSL_malloc(s->tlsext_ecpointformatlist_length)) == NULL)
375                                 {
376                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
377                                 SSL_SESSION_free(ss);
378                                 return 0;
379                                 }
380                         ss->tlsext_ecpointformatlist_length = s->tlsext_ecpointformatlist_length;
381                         memcpy(ss->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist_length);
382                         }
383                 if (s->tlsext_ellipticcurvelist)
384                         {
385                         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
386                         if ((ss->tlsext_ellipticcurvelist = OPENSSL_malloc(s->tlsext_ellipticcurvelist_length)) == NULL)
387                                 {
388                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
389                                 SSL_SESSION_free(ss);
390                                 return 0;
391                                 }
392                         ss->tlsext_ellipticcurvelist_length = s->tlsext_ellipticcurvelist_length;
393                         memcpy(ss->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist_length);
394                         }
395 #endif
396 #endif
397                 }
398         else
399                 {
400                 ss->session_id_length=0;
401                 }
402
403         if (s->sid_ctx_length > sizeof ss->sid_ctx)
404                 {
405                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
406                 SSL_SESSION_free(ss);
407                 return 0;
408                 }
409         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
410         ss->sid_ctx_length=s->sid_ctx_length;
411         s->session=ss;
412         ss->ssl_version=s->version;
413         ss->verify_result = X509_V_OK;
414
415         return(1);
416         }
417
418 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
419                         const unsigned char *limit)
420         {
421         /* This is used only by servers. */
422
423         SSL_SESSION *ret=NULL;
424         int fatal = 0;
425 #ifndef OPENSSL_NO_TLSEXT
426         int r;
427 #endif
428
429         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
430                 goto err;
431 #ifndef OPENSSL_NO_TLSEXT
432         r = tls1_process_ticket(s, session_id, len, limit, &ret);
433         if (r == -1)
434                 {
435                 fatal = 1;
436                 goto err;
437                 }
438         else if (r == 0 || (!ret || !len))
439                 goto err;
440         else if (!ret && !(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
441 #else
442         if (len == 0)
443                 goto err;
444         if (!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
445 #endif
446                 {
447                 SSL_SESSION data;
448                 data.ssl_version=s->version;
449                 data.session_id_length=len;
450                 if (len == 0)
451                         return 0;
452                 memcpy(data.session_id,session_id,len);
453                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
454                 ret=(SSL_SESSION *)lh_retrieve(s->session_ctx->sessions,&data);
455                 if (ret != NULL)
456                     /* don't allow other threads to steal it: */
457                     CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
458                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
459                 }
460
461         if (ret == NULL)
462                 {
463                 int copy=1;
464         
465                 s->session_ctx->stats.sess_miss++;
466                 ret=NULL;
467                 if (s->session_ctx->get_session_cb != NULL
468                     && (ret=s->session_ctx->get_session_cb(s,session_id,len,&copy))
469                        != NULL)
470                         {
471                         s->session_ctx->stats.sess_cb_hit++;
472
473                         /* Increment reference count now if the session callback
474                          * asks us to do so (note that if the session structures
475                          * returned by the callback are shared between threads,
476                          * it must handle the reference count itself [i.e. copy == 0],
477                          * or things won't be thread-safe). */
478                         if (copy)
479                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
480
481                         /* Add the externally cached session to the internal
482                          * cache as well if and only if we are supposed to. */
483                         if(!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
484                                 /* The following should not return 1, otherwise,
485                                  * things are very strange */
486                                 SSL_CTX_add_session(s->session_ctx,ret);
487                         }
488                 if (ret == NULL)
489                         goto err;
490                 }
491
492         /* Now ret is non-NULL, and we own one of its reference counts. */
493
494         if (ret->sid_ctx_length != s->sid_ctx_length
495             || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length))
496                 {
497                 /* We've found the session named by the client, but we don't
498                  * want to use it in this context. */
499
500 #if 0 /* The client cannot always know when a session is not appropriate,
501        * so we shouldn't generate an error message. */
502
503                 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
504 #endif
505                 goto err; /* treat like cache miss */
506                 }
507         
508         if((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0)
509                 {
510                 /* We can't be sure if this session is being used out of
511                  * context, which is especially important for SSL_VERIFY_PEER.
512                  * The application should have used SSL[_CTX]_set_session_id_context.
513                  *
514                  * For this error case, we generate an error instead of treating
515                  * the event like a cache miss (otherwise it would be easy for
516                  * applications to effectively disable the session cache by
517                  * accident without anyone noticing).
518                  */
519                 
520                 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
521                 fatal = 1;
522                 goto err;
523                 }
524
525         if (ret->cipher == NULL)
526                 {
527                 unsigned char buf[5],*p;
528                 unsigned long l;
529
530                 p=buf;
531                 l=ret->cipher_id;
532                 l2n(l,p);
533                 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
534                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
535                 else 
536                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
537                 if (ret->cipher == NULL)
538                         goto err;
539                 }
540
541
542 #if 0 /* This is way too late. */
543
544         /* If a thread got the session, then 'swaped', and another got
545          * it and then due to a time-out decided to 'OPENSSL_free' it we could
546          * be in trouble.  So I'll increment it now, then double decrement
547          * later - am I speaking rubbish?. */
548         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
549 #endif
550
551         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
552                 {
553                 s->session_ctx->stats.sess_timeout++;
554                 /* remove it from the cache */
555                 SSL_CTX_remove_session(s->session_ctx,ret);
556                 goto err;
557                 }
558
559         s->session_ctx->stats.sess_hit++;
560
561         /* ret->time=time(NULL); */ /* rezero timeout? */
562         /* again, just leave the session 
563          * if it is the same session, we have just incremented and
564          * then decremented the reference count :-) */
565         if (s->session != NULL)
566                 SSL_SESSION_free(s->session);
567         s->session=ret;
568         s->verify_result = s->session->verify_result;
569         return(1);
570
571  err:
572         if (ret != NULL)
573                 SSL_SESSION_free(ret);
574         if (fatal)
575                 return -1;
576         else
577                 return 0;
578         }
579
580 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
581         {
582         int ret=0;
583         SSL_SESSION *s;
584
585         /* add just 1 reference count for the SSL_CTX's session cache
586          * even though it has two ways of access: each session is in a
587          * doubly linked list and an lhash */
588         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
589         /* if session c is in already in cache, we take back the increment later */
590
591         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
592         s=(SSL_SESSION *)lh_insert(ctx->sessions,c);
593         
594         /* s != NULL iff we already had a session with the given PID.
595          * In this case, s == c should hold (then we did not really modify
596          * ctx->sessions), or we're in trouble. */
597         if (s != NULL && s != c)
598                 {
599                 /* We *are* in trouble ... */
600                 SSL_SESSION_list_remove(ctx,s);
601                 SSL_SESSION_free(s);
602                 /* ... so pretend the other session did not exist in cache
603                  * (we cannot handle two SSL_SESSION structures with identical
604                  * session ID in the same cache, which could happen e.g. when
605                  * two threads concurrently obtain the same session from an external
606                  * cache) */
607                 s = NULL;
608                 }
609
610         /* Put at the head of the queue unless it is already in the cache */
611         if (s == NULL)
612                 SSL_SESSION_list_add(ctx,c);
613
614         if (s != NULL)
615                 {
616                 /* existing cache entry -- decrement previously incremented reference
617                  * count because it already takes into account the cache */
618
619                 SSL_SESSION_free(s); /* s == c */
620                 ret=0;
621                 }
622         else
623                 {
624                 /* new cache entry -- remove old ones if cache has become too large */
625                 
626                 ret=1;
627
628                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
629                         {
630                         while (SSL_CTX_sess_number(ctx) >
631                                 SSL_CTX_sess_get_cache_size(ctx))
632                                 {
633                                 if (!remove_session_lock(ctx,
634                                         ctx->session_cache_tail, 0))
635                                         break;
636                                 else
637                                         ctx->stats.sess_cache_full++;
638                                 }
639                         }
640                 }
641         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
642         return(ret);
643         }
644
645 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
646 {
647         return remove_session_lock(ctx, c, 1);
648 }
649
650 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
651         {
652         SSL_SESSION *r;
653         int ret=0;
654
655         if ((c != NULL) && (c->session_id_length != 0))
656                 {
657                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
658                 if ((r = (SSL_SESSION *)lh_retrieve(ctx->sessions,c)) == c)
659                         {
660                         ret=1;
661                         r=(SSL_SESSION *)lh_delete(ctx->sessions,c);
662                         SSL_SESSION_list_remove(ctx,c);
663                         }
664
665                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
666
667                 if (ret)
668                         {
669                         r->not_resumable=1;
670                         if (ctx->remove_session_cb != NULL)
671                                 ctx->remove_session_cb(ctx,r);
672                         SSL_SESSION_free(r);
673                         }
674                 }
675         else
676                 ret=0;
677         return(ret);
678         }
679
680 void SSL_SESSION_free(SSL_SESSION *ss)
681         {
682         int i;
683
684         if(ss == NULL)
685             return;
686
687         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
688 #ifdef REF_PRINT
689         REF_PRINT("SSL_SESSION",ss);
690 #endif
691         if (i > 0) return;
692 #ifdef REF_CHECK
693         if (i < 0)
694                 {
695                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
696                 abort(); /* ok */
697                 }
698 #endif
699
700         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
701
702         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
703         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
704         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
705         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
706         if (ss->peer != NULL) X509_free(ss->peer);
707         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
708 #ifndef OPENSSL_NO_TLSEXT
709         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
710         if (ss->tlsext_tick != NULL) OPENSSL_free(ss->tlsext_tick);
711 #ifndef OPENSSL_NO_EC
712         ss->tlsext_ecpointformatlist_length = 0;
713         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
714         ss->tlsext_ellipticcurvelist_length = 0;
715         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
716 #endif /* OPENSSL_NO_EC */
717 #endif
718 #ifndef OPENSSL_NO_PSK
719         if (ss->psk_identity_hint != NULL)
720                 OPENSSL_free(ss->psk_identity_hint);
721         if (ss->psk_identity != NULL)
722                 OPENSSL_free(ss->psk_identity);
723 #endif
724         OPENSSL_cleanse(ss,sizeof(*ss));
725         OPENSSL_free(ss);
726         }
727
728 int SSL_set_session(SSL *s, SSL_SESSION *session)
729         {
730         int ret=0;
731         const SSL_METHOD *meth;
732
733         if (session != NULL)
734                 {
735                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
736                 if (meth == NULL)
737                         meth=s->method->get_ssl_method(session->ssl_version);
738                 if (meth == NULL)
739                         {
740                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
741                         return(0);
742                         }
743
744                 if (meth != s->method)
745                         {
746                         if (!SSL_set_ssl_method(s,meth))
747                                 return(0);
748                         if (s->ctx->session_timeout == 0)
749                                 session->timeout=SSL_get_default_timeout(s);
750                         else
751                                 session->timeout=s->ctx->session_timeout;
752                         }
753
754 #ifndef OPENSSL_NO_KRB5
755                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
756                     session->krb5_client_princ_len > 0)
757                 {
758                     s->kssl_ctx->client_princ = (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
759                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
760                             session->krb5_client_princ_len);
761                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
762                 }
763 #endif /* OPENSSL_NO_KRB5 */
764
765                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
766                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
767                 if (s->session != NULL)
768                         SSL_SESSION_free(s->session);
769                 s->session=session;
770                 s->verify_result = s->session->verify_result;
771                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
772                 ret=1;
773                 }
774         else
775                 {
776                 if (s->session != NULL)
777                         {
778                         SSL_SESSION_free(s->session);
779                         s->session=NULL;
780                         }
781
782                 meth=s->ctx->method;
783                 if (meth != s->method)
784                         {
785                         if (!SSL_set_ssl_method(s,meth))
786                                 return(0);
787                         }
788                 ret=1;
789                 }
790         return(ret);
791         }
792
793 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
794         {
795         if (s == NULL) return(0);
796         s->timeout=t;
797         return(1);
798         }
799
800 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
801         {
802         if (s == NULL) return(0);
803         return(s->timeout);
804         }
805
806 long SSL_SESSION_get_time(const SSL_SESSION *s)
807         {
808         if (s == NULL) return(0);
809         return(s->time);
810         }
811
812 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
813         {
814         if (s == NULL) return(0);
815         s->time=t;
816         return(t);
817         }
818
819 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
820         {
821         long l;
822         if (s == NULL) return(0);
823         l=s->session_timeout;
824         s->session_timeout=t;
825         return(l);
826         }
827
828 long SSL_CTX_get_timeout(const SSL_CTX *s)
829         {
830         if (s == NULL) return(0);
831         return(s->session_timeout);
832         }
833
834 typedef struct timeout_param_st
835         {
836         SSL_CTX *ctx;
837         long time;
838         LHASH *cache;
839         } TIMEOUT_PARAM;
840
841 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
842         {
843         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
844                 {
845                 /* The reason we don't call SSL_CTX_remove_session() is to
846                  * save on locking overhead */
847                 lh_delete(p->cache,s);
848                 SSL_SESSION_list_remove(p->ctx,s);
849                 s->not_resumable=1;
850                 if (p->ctx->remove_session_cb != NULL)
851                         p->ctx->remove_session_cb(p->ctx,s);
852                 SSL_SESSION_free(s);
853                 }
854         }
855
856 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION *, TIMEOUT_PARAM *)
857
858 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
859         {
860         unsigned long i;
861         TIMEOUT_PARAM tp;
862
863         tp.ctx=s;
864         tp.cache=s->sessions;
865         if (tp.cache == NULL) return;
866         tp.time=t;
867         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
868         i=tp.cache->down_load;
869         tp.cache->down_load=0;
870         lh_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout), &tp);
871         tp.cache->down_load=i;
872         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
873         }
874
875 int ssl_clear_bad_session(SSL *s)
876         {
877         if (    (s->session != NULL) &&
878                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
879                 !(SSL_in_init(s) || SSL_in_before(s)))
880                 {
881                 SSL_CTX_remove_session(s->ctx,s->session);
882                 return(1);
883                 }
884         else
885                 return(0);
886         }
887
888 /* locked by SSL_CTX in the calling function */
889 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
890         {
891         if ((s->next == NULL) || (s->prev == NULL)) return;
892
893         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
894                 { /* last element in list */
895                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
896                         { /* only one element in list */
897                         ctx->session_cache_head=NULL;
898                         ctx->session_cache_tail=NULL;
899                         }
900                 else
901                         {
902                         ctx->session_cache_tail=s->prev;
903                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
904                         }
905                 }
906         else
907                 {
908                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
909                         { /* first element in list */
910                         ctx->session_cache_head=s->next;
911                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
912                         }
913                 else
914                         { /* middle of list */
915                         s->next->prev=s->prev;
916                         s->prev->next=s->next;
917                         }
918                 }
919         s->prev=s->next=NULL;
920         }
921
922 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
923         {
924         if ((s->next != NULL) && (s->prev != NULL))
925                 SSL_SESSION_list_remove(ctx,s);
926
927         if (ctx->session_cache_head == NULL)
928                 {
929                 ctx->session_cache_head=s;
930                 ctx->session_cache_tail=s;
931                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
932                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
933                 }
934         else
935                 {
936                 s->next=ctx->session_cache_head;
937                 s->next->prev=s;
938                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
939                 ctx->session_cache_head=s;
940                 }
941         }
942
943 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
944         int (*cb)(struct ssl_st *ssl,SSL_SESSION *sess))
945         {
946         ctx->new_session_cb=cb;
947         }
948
949 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl, SSL_SESSION *sess)
950         {
951         return ctx->new_session_cb;
952         }
953
954 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
955         void (*cb)(SSL_CTX *ctx,SSL_SESSION *sess))
956         {
957         ctx->remove_session_cb=cb;
958         }
959
960 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(SSL_CTX * ctx,SSL_SESSION *sess)
961         {
962         return ctx->remove_session_cb;
963         }
964
965 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
966         SSL_SESSION *(*cb)(struct ssl_st *ssl,
967                  unsigned char *data,int len,int *copy))
968         {
969         ctx->get_session_cb=cb;
970         }
971
972 SSL_SESSION * (*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl,
973                  unsigned char *data,int len,int *copy)
974         {
975         return ctx->get_session_cb;
976         }
977
978 void SSL_CTX_set_info_callback(SSL_CTX *ctx, 
979         void (*cb)(const SSL *ssl,int type,int val))
980         {
981         ctx->info_callback=cb;
982         }
983
984 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,int type,int val)
985         {
986         return ctx->info_callback;
987         }
988
989 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
990         int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey))
991         {
992         ctx->client_cert_cb=cb;
993         }
994
995 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL * ssl, X509 ** x509 , EVP_PKEY **pkey)
996         {
997         return ctx->client_cert_cb;
998         }
999
1000 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1001         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int *cookie_len))
1002         {
1003         ctx->app_gen_cookie_cb=cb;
1004         }
1005
1006 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1007         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int cookie_len))
1008         {
1009         ctx->app_verify_cookie_cb=cb;
1010         }
1011
1012 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)