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