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