Let ssl_get_prev_session reliably work in multi-threaded settings.
[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 #include <stdio.h>
60 #include <openssl/lhash.h>
61 #include <openssl/rand.h>
62 #include "ssl_locl.h"
63
64 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
65 static void SSL_SESSION_list_add(SSL_CTX *ctx,SSL_SESSION *s);
66 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
67 static int ssl_session_num=0;
68 static STACK *ssl_session_meth=NULL;
69
70 SSL_SESSION *SSL_get_session(SSL *ssl)
71         {
72         return(ssl->session);
73         }
74
75 int SSL_SESSION_get_ex_new_index(long argl, char *argp, int (*new_func)(),
76              int (*dup_func)(), void (*free_func)())
77         {
78         ssl_session_num++;
79         return(CRYPTO_get_ex_new_index(ssl_session_num-1,
80                 &ssl_session_meth,
81                 argl,argp,new_func,dup_func,free_func));
82         }
83
84 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
85         {
86         return(CRYPTO_set_ex_data(&s->ex_data,idx,arg));
87         }
88
89 void *SSL_SESSION_get_ex_data(SSL_SESSION *s, int idx)
90         {
91         return(CRYPTO_get_ex_data(&s->ex_data,idx));
92         }
93
94 SSL_SESSION *SSL_SESSION_new(void)
95         {
96         SSL_SESSION *ss;
97
98         ss=(SSL_SESSION *)Malloc(sizeof(SSL_SESSION));
99         if (ss == NULL)
100                 {
101                 SSLerr(SSL_F_SSL_SESSION_NEW,ERR_R_MALLOC_FAILURE);
102                 return(0);
103                 }
104         memset(ss,0,sizeof(SSL_SESSION));
105
106         ss->references=1;
107         ss->timeout=60*5+4; /* 5 minute timeout by default */
108         ss->time=time(NULL);
109         ss->prev=NULL;
110         ss->next=NULL;
111         ss->compress_meth=0;
112         CRYPTO_new_ex_data(ssl_session_meth,(char *)ss,&ss->ex_data);
113         return(ss);
114         }
115
116 int ssl_get_new_session(SSL *s, int session)
117         {
118         /* This gets used by clients and servers. */
119
120         SSL_SESSION *ss=NULL;
121
122         if ((ss=SSL_SESSION_new()) == NULL) return(0);
123
124         /* If the context has a default timeout, use it */
125         if (s->ctx->session_timeout == 0)
126                 ss->timeout=SSL_get_default_timeout(s);
127         else
128                 ss->timeout=s->ctx->session_timeout;
129
130         if (s->session != NULL)
131                 {
132                 SSL_SESSION_free(s->session);
133                 s->session=NULL;
134                 }
135
136         if (session)
137                 {
138                 if (s->version == SSL2_VERSION)
139                         {
140                         ss->ssl_version=SSL2_VERSION;
141                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
142                         }
143                 else if (s->version == SSL3_VERSION)
144                         {
145                         ss->ssl_version=SSL3_VERSION;
146                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
147                         }
148                 else if (s->version == TLS1_VERSION)
149                         {
150                         ss->ssl_version=TLS1_VERSION;
151                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
152                         }
153                 else
154                         {
155                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
156                         SSL_SESSION_free(ss);
157                         return(0);
158                         }
159
160                 for (;;)
161                         {
162                         SSL_SESSION *r;
163
164                         RAND_bytes(ss->session_id,ss->session_id_length);
165                         CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
166                         r=(SSL_SESSION *)lh_retrieve(s->ctx->sessions,
167                                 (char *)ss);
168                         CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
169                         if (r == NULL) break;
170                         /* else - woops a session_id match */
171                         }
172                 }
173         else
174                 {
175                 ss->session_id_length=0;
176                 }
177
178         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
179         ss->sid_ctx_length=s->sid_ctx_length;
180         s->session=ss;
181         ss->ssl_version=s->version;
182
183         return(1);
184         }
185
186 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len)
187         {
188         /* This is used only by servers. */
189
190         SSL_SESSION *ret=NULL,data;
191         int fatal = 0;
192
193         /* conn_init();*/
194         data.ssl_version=s->version;
195         data.session_id_length=len;
196         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
197                 goto err;
198         memcpy(data.session_id,session_id,len);
199
200         if (!(s->ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
201                 {
202                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
203                 ret=(SSL_SESSION *)lh_retrieve(s->ctx->sessions,(char *)&data);
204                 /* don't allow other threads to steal it: */
205                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
206                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
207                 }
208
209         if (ret == NULL)
210                 {
211                 int copy=1;
212         
213                 s->ctx->stats.sess_miss++;
214                 ret=NULL;
215                 if (s->ctx->get_session_cb != NULL
216                     && (ret=s->ctx->get_session_cb(s,session_id,len,&copy))
217                        != NULL)
218                         {
219                         s->ctx->stats.sess_cb_hit++;
220
221                         /* Increment reference count now if the session callback
222                          * asks us to do so (note that if the session structures
223                          * returned by the callback are shared between threads,
224                          * it must handle the reference count itself [i.e. copy == 0],
225                          * or things won't be thread-safe). */
226                         if (copy)
227                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
228
229                         /* The following should not return 1, otherwise,
230                          * things are very strange */
231                         SSL_CTX_add_session(s->ctx,ret);
232                         }
233                 if (ret == NULL)
234                         goto err;
235                 }
236
237         /* Now ret is non-NULL, and we own one of its reference counts. */
238
239         if((s->verify_mode&SSL_VERIFY_PEER)
240            && (!s->sid_ctx_length || ret->sid_ctx_length != s->sid_ctx_length
241                || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length)))
242             {
243                 /* We've found the session named by the client, but we don't
244                  * want to use it in this context. */
245                 
246                 if (s->sid_ctx_length == 0)
247                         {
248                         /* application should have used SSL[_CTX]_set_session_id_context
249                          * -- we could tolerate this and just pretend we never heard
250                          * of this session, but then applications could effectively
251                          * disable the session cache by accident without anyone noticing */
252
253                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
254                         fatal = 1;
255                         goto err;
256                         }
257                 else
258                         {
259 #if 0 /* The client cannot always know when a session is not appropriate,
260            * so we shouldn't generate an error message. */
261
262                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
263 #endif
264                         goto err; /* treat like cache miss */
265                         }
266                 }
267
268         if (ret->cipher == NULL)
269                 {
270                 unsigned char buf[5],*p;
271                 unsigned long l;
272
273                 p=buf;
274                 l=ret->cipher_id;
275                 l2n(l,p);
276                 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
277                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
278                 else 
279                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
280                 if (ret->cipher == NULL)
281                         goto err;
282                 }
283
284
285 #if 0 /* This is way too late. */
286
287         /* If a thread got the session, then 'swaped', and another got
288          * it and then due to a time-out decided to 'Free' it we could
289          * be in trouble.  So I'll increment it now, then double decrement
290          * later - am I speaking rubbish?. */
291         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
292 #endif
293
294         if ((long)(ret->time+ret->timeout) < (long)time(NULL)) /* timeout */
295                 {
296                 s->ctx->stats.sess_timeout++;
297                 /* remove it from the cache */
298                 SSL_CTX_remove_session(s->ctx,ret);
299                 goto err;
300                 }
301
302         s->ctx->stats.sess_hit++;
303
304         /* ret->time=time(NULL); */ /* rezero timeout? */
305         /* again, just leave the session 
306          * if it is the same session, we have just incremented and
307          * then decremented the reference count :-) */
308         if (s->session != NULL)
309                 SSL_SESSION_free(s->session);
310         s->session=ret;
311         return(1);
312
313  err:
314         if (ret != NULL)
315                 SSL_SESSION_free(ret);
316         if (fatal)
317                 return -1;
318         else
319                 return 0;
320         }
321
322 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
323         {
324         int ret=0;
325         SSL_SESSION *s;
326
327         /* conn_init(); */
328         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
329
330         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
331         s=(SSL_SESSION *)lh_insert(ctx->sessions,(char *)c);
332         
333         /* Put on the end of the queue unless it is already in the cache */
334         if (s == NULL)
335                 SSL_SESSION_list_add(ctx,c);
336
337         /* If the same session if is being 're-added', Free the old
338          * one when the last person stops using it.
339          * This will also work if it is alread in the cache.
340          * The references will go up and then down :-) */
341         if (s != NULL)
342                 {
343                 SSL_SESSION_free(s);
344                 ret=0;
345                 }
346         else
347                 {
348                 ret=1;
349
350                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
351                         {
352                         while (SSL_CTX_sess_number(ctx) >
353                                 SSL_CTX_sess_get_cache_size(ctx))
354                                 {
355                                 if (!remove_session_lock(ctx,
356                                         ctx->session_cache_tail, 0))
357                                         break;
358                                 else
359                                         ctx->stats.sess_cache_full++;
360                                 }
361                         }
362                 }
363         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
364         return(ret);
365         }
366
367 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
368 {
369         return remove_session_lock(ctx, c, 1);
370 }
371
372 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
373         {
374         SSL_SESSION *r;
375         int ret=0;
376
377         if ((c != NULL) && (c->session_id_length != 0))
378                 {
379                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
380                 r=(SSL_SESSION *)lh_delete(ctx->sessions,(char *)c);
381                 if (r != NULL)
382                         {
383                         ret=1;
384                         SSL_SESSION_list_remove(ctx,c);
385                         }
386
387                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
388
389                 if (ret)
390                         {
391                         r->not_resumable=1;
392                         if (ctx->remove_session_cb != NULL)
393                                 ctx->remove_session_cb(ctx,r);
394                         SSL_SESSION_free(r);
395                         }
396                 }
397         else
398                 ret=0;
399         return(ret);
400         }
401
402 void SSL_SESSION_free(SSL_SESSION *ss)
403         {
404         int i;
405
406         if(ss == NULL)
407             return;
408
409         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
410 #ifdef REF_PRINT
411         REF_PRINT("SSL_SESSION",ss);
412 #endif
413         if (i > 0) return;
414 #ifdef REF_CHECK
415         if (i < 0)
416                 {
417                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
418                 abort(); /* ok */
419                 }
420 #endif
421
422         CRYPTO_free_ex_data(ssl_session_meth,(char *)ss,&ss->ex_data);
423
424         memset(ss->key_arg,0,SSL_MAX_KEY_ARG_LENGTH);
425         memset(ss->master_key,0,SSL_MAX_MASTER_KEY_LENGTH);
426         memset(ss->session_id,0,SSL_MAX_SSL_SESSION_ID_LENGTH);
427         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
428         if (ss->peer != NULL) X509_free(ss->peer);
429         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
430         memset(ss,0,sizeof(*ss));
431         Free(ss);
432         }
433
434 int SSL_set_session(SSL *s, SSL_SESSION *session)
435         {
436         int ret=0;
437         SSL_METHOD *meth;
438
439         if (session != NULL)
440                 {
441                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
442                 if (meth == NULL)
443                         meth=s->method->get_ssl_method(session->ssl_version);
444                 if (meth == NULL)
445                         {
446                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
447                         return(0);
448                         }
449
450                 if (meth != s->method)
451                         {
452                         if (!SSL_set_ssl_method(s,meth))
453                                 return(0);
454                         if (s->ctx->session_timeout == 0)
455                                 session->timeout=SSL_get_default_timeout(s);
456                         else
457                                 session->timeout=s->ctx->session_timeout;
458                         }
459
460                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
461                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
462                 if (s->session != NULL)
463                         SSL_SESSION_free(s->session);
464                 s->session=session;
465                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
466                 ret=1;
467                 }
468         else
469                 {
470                 if (s->session != NULL)
471                         {
472                         SSL_SESSION_free(s->session);
473                         s->session=NULL;
474                         }
475
476                 meth=s->ctx->method;
477                 if (meth != s->method)
478                         {
479                         if (!SSL_set_ssl_method(s,meth))
480                                 return(0);
481                         }
482                 ret=1;
483                 }
484         return(ret);
485         }
486
487 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
488         {
489         if (s == NULL) return(0);
490         s->timeout=t;
491         return(1);
492         }
493
494 long SSL_SESSION_get_timeout(SSL_SESSION *s)
495         {
496         if (s == NULL) return(0);
497         return(s->timeout);
498         }
499
500 long SSL_SESSION_get_time(SSL_SESSION *s)
501         {
502         if (s == NULL) return(0);
503         return(s->time);
504         }
505
506 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
507         {
508         if (s == NULL) return(0);
509         s->time=t;
510         return(t);
511         }
512
513 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
514         {
515         long l;
516         if (s == NULL) return(0);
517         l=s->session_timeout;
518         s->session_timeout=t;
519         return(l);
520         }
521
522 long SSL_CTX_get_timeout(SSL_CTX *s)
523         {
524         if (s == NULL) return(0);
525         return(s->session_timeout);
526         }
527
528 typedef struct timeout_param_st
529         {
530         SSL_CTX *ctx;
531         long time;
532         LHASH *cache;
533         } TIMEOUT_PARAM;
534
535 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
536         {
537         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
538                 {
539                 /* The reason we don't call SSL_CTX_remove_session() is to
540                  * save on locking overhead */
541                 lh_delete(p->cache,(char *)s);
542                 SSL_SESSION_list_remove(p->ctx,s);
543                 s->not_resumable=1;
544                 if (p->ctx->remove_session_cb != NULL)
545                         p->ctx->remove_session_cb(p->ctx,s);
546                 SSL_SESSION_free(s);
547                 }
548         }
549
550 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
551         {
552         unsigned long i;
553         TIMEOUT_PARAM tp;
554
555         tp.ctx=s;
556         tp.cache=s->sessions;
557         if (tp.cache == NULL) return;
558         tp.time=t;
559         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
560         i=tp.cache->down_load;
561         tp.cache->down_load=0;
562         lh_doall_arg(tp.cache,(void (*)())timeout,(char *)&tp);
563         tp.cache->down_load=i;
564         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
565         }
566
567 int ssl_clear_bad_session(SSL *s)
568         {
569         if (    (s->session != NULL) &&
570                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
571                 !(SSL_in_init(s) || SSL_in_before(s)))
572                 {
573                 SSL_CTX_remove_session(s->ctx,s->session);
574                 return(1);
575                 }
576         else
577                 return(0);
578         }
579
580 /* locked by SSL_CTX in the calling function */
581 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
582         {
583         if ((s->next == NULL) || (s->prev == NULL)) return;
584
585         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
586                 { /* last element in list */
587                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
588                         { /* only one element in list */
589                         ctx->session_cache_head=NULL;
590                         ctx->session_cache_tail=NULL;
591                         }
592                 else
593                         {
594                         ctx->session_cache_tail=s->prev;
595                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
596                         }
597                 }
598         else
599                 {
600                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
601                         { /* first element in list */
602                         ctx->session_cache_head=s->next;
603                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
604                         }
605                 else
606                         { /* middle of list */
607                         s->next->prev=s->prev;
608                         s->prev->next=s->next;
609                         }
610                 }
611         s->prev=s->next=NULL;
612         }
613
614 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
615         {
616         if ((s->next != NULL) && (s->prev != NULL))
617                 SSL_SESSION_list_remove(ctx,s);
618
619         if (ctx->session_cache_head == NULL)
620                 {
621                 ctx->session_cache_head=s;
622                 ctx->session_cache_tail=s;
623                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
624                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
625                 }
626         else
627                 {
628                 s->next=ctx->session_cache_head;
629                 s->next->prev=s;
630                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
631                 ctx->session_cache_head=s;
632                 }
633         }
634