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