ssl/ssl_sess.c

   1 /* ssl/ssl_sess.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58 /* ====================================================================
  59  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111 /* ====================================================================
 112  * Copyright 2005 Nokia. All rights reserved.
 113  *
 114  * The portions of the attached software ("Contribution") is developed by
 115  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
 116  * license.
 117  *
 118  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
 119  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
 120  * support (see RFC 4279) to OpenSSL.
 121  *
 122  * No patent licenses or other rights except those expressly stated in
 123  * the OpenSSL open source license shall be deemed granted or received
 124  * expressly, by implication, estoppel, or otherwise.
 125  *
 126  * No assurances are provided by Nokia that the Contribution does not
 127  * infringe the patent or other intellectual property rights of any third
 128  * party or that the license provides you with all the necessary rights
 129  * to make use of the Contribution.
 130  *
 131  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
 132  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
 133  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
 134  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
 135  * OTHERWISE.
 136  */
 137
 138 #include <stdio.h>
 139 #include <openssl/lhash.h>
 140 #include <openssl/rand.h>
 141 #include "ssl_locl.h"
 142
 143 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
 144 static void SSL_SESSION_list_add(SSL_CTX *ctx,SSL_SESSION *s);
 145 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
 146
 147 SSL_SESSION *SSL_get_session(const SSL *ssl)
 148 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
 149         {
 150         return(ssl->session);
 151         }
 152
 153 SSL_SESSION *SSL_get1_session(SSL *ssl)
 154 /* variant of SSL_get_session: caller really gets something */
 155         {
 156         SSL_SESSION *sess;
 157         /* Need to lock this all up rather than just use CRYPTO_add so that
 158          * somebody doesn't free ssl->session between when we check it's
 159          * non-null and when we up the reference count. */
 160         CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION);
 161         sess = ssl->session;
 162         if(sess)
 163                 sess->references++;
 164         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
 165         return(sess);
 166         }
 167
 168 int SSL_SESSION_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 169              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
 170         {
 171         return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, argl, argp,
 172                         new_func, dup_func, free_func);
 173         }
 174
 175 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
 176         {
 177         return(CRYPTO_set_ex_data(&s->ex_data,idx,arg));
 178         }
 179
 180 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
 181         {
 182         return(CRYPTO_get_ex_data(&s->ex_data,idx));
 183         }
 184
 185 SSL_SESSION *SSL_SESSION_new(void)
 186         {
 187         SSL_SESSION *ss;
 188
 189         ss=(SSL_SESSION *)OPENSSL_malloc(sizeof(SSL_SESSION));
 190         if (ss == NULL)
 191                 {
 192                 SSLerr(SSL_F_SSL_SESSION_NEW,ERR_R_MALLOC_FAILURE);
 193                 return(0);
 194                 }
 195         memset(ss,0,sizeof(SSL_SESSION));
 196
 197         ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
 198         ss->references=1;
 199         ss->timeout=60*5+4; /* 5 minute timeout by default */
 200         ss->time=(unsigned long)time(NULL);
 201         ss->prev=NULL;
 202         ss->next=NULL;
 203         ss->compress_meth=0;
 204 #ifndef OPENSSL_NO_TLSEXT
 205         ss->tlsext_hostname = NULL;
 206 #endif
 207         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 208 #ifndef OPENSSL_NO_PSK
 209         ss->psk_identity_hint=NULL;
 210         ss->psk_identity=NULL;
 211 #endif
 212         return(ss);
 213         }
 214
 215 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
 216         {
 217         if(len)
 218                 *len = s->session_id_length;
 219         return s->session_id;
 220         }
 221
 222 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
 223  * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
 224  * until we have no conflict is going to complete in one iteration pretty much
 225  * "most" of the time (btw: understatement). So, if it takes us 10 iterations
 226  * and we still can't avoid a conflict - well that's a reasonable point to call
 227  * it quits. Either the RAND code is broken or someone is trying to open roughly
 228  * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
 229  * store that many sessions is perhaps a more interesting question ... */
 230
 231 #define MAX_SESS_ID_ATTEMPTS 10
 232 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
 233                                 unsigned int *id_len)
 234 {
 235         unsigned int retry = 0;
 236         do
 237                 if (RAND_pseudo_bytes(id, *id_len) <= 0)
 238                         return 0;
 239         while(SSL_has_matching_session_id(ssl, id, *id_len) &&
 240                 (++retry < MAX_SESS_ID_ATTEMPTS));
 241         if(retry < MAX_SESS_ID_ATTEMPTS)
 242                 return 1;
 243         /* else - woops a session_id match */
 244         /* XXX We should also check the external cache --
 245          * but the probability of a collision is negligible, and
 246          * we could not prevent the concurrent creation of sessions
 247          * with identical IDs since we currently don't have means
 248          * to atomically check whether a session ID already exists
 249          * and make a reservation for it if it does not
 250          * (this problem applies to the internal cache as well).
 251          */
 252         return 0;
 253 }
 254
 255 int ssl_get_new_session(SSL *s, int session)
 256         {
 257         /* This gets used by clients and servers. */
 258
 259         unsigned int tmp;
 260         SSL_SESSION *ss=NULL;
 261         GEN_SESSION_CB cb = def_generate_session_id;
 262
 263         if ((ss=SSL_SESSION_new()) == NULL) return(0);
 264
 265         /* If the context has a default timeout, use it */
 266         if (s->session_ctx->session_timeout == 0)
 267                 ss->timeout=SSL_get_default_timeout(s);
 268         else
 269                 ss->timeout=s->session_ctx->session_timeout;
 270
 271         if (s->session != NULL)
 272                 {
 273                 SSL_SESSION_free(s->session);
 274                 s->session=NULL;
 275                 }
 276
 277         if (session)
 278                 {
 279                 if (s->version == SSL2_VERSION)
 280                         {
 281                         ss->ssl_version=SSL2_VERSION;
 282                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
 283                         }
 284                 else if (s->version == SSL3_VERSION)
 285                         {
 286                         ss->ssl_version=SSL3_VERSION;
 287                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 288                         }
 289                 else if (s->version == TLS1_VERSION)
 290                         {
 291                         ss->ssl_version=TLS1_VERSION;
 292                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 293                         }
 294                 else if (s->version == DTLS1_VERSION)
 295                         {
 296                         ss->ssl_version=DTLS1_VERSION;
 297                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 298                         }
 299                 else
 300                         {
 301                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
 302                         SSL_SESSION_free(ss);
 303                         return(0);
 304                         }
 305                 /* Choose which callback will set the session ID */
 306                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 307                 if(s->generate_session_id)
 308                         cb = s->generate_session_id;
 309                 else if(s->session_ctx->generate_session_id)
 310                         cb = s->session_ctx->generate_session_id;
 311                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 312                 /* Choose a session ID */
 313                 tmp = ss->session_id_length;
 314                 if(!cb(s, ss->session_id, &tmp))
 315                         {
 316                         /* The callback failed */
 317                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 318                                 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
 319                         SSL_SESSION_free(ss);
 320                         return(0);
 321                         }
 322                 /* Don't allow the callback to set the session length to zero.
 323                  * nor set it higher than it was. */
 324                 if(!tmp || (tmp > ss->session_id_length))
 325                         {
 326                         /* The callback set an illegal length */
 327                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 328                                 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
 329                         SSL_SESSION_free(ss);
 330                         return(0);
 331                         }
 332                 /* If the session length was shrunk and we're SSLv2, pad it */
 333                 if((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
 334                         memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
 335                 else
 336                         ss->session_id_length = tmp;
 337                 /* Finally, check for a conflict */
 338                 if(SSL_has_matching_session_id(s, ss->session_id,
 339                                                 ss->session_id_length))
 340                         {
 341                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 342                                 SSL_R_SSL_SESSION_ID_CONFLICT);
 343                         SSL_SESSION_free(ss);
 344                         return(0);
 345                         }
 346 #ifndef OPENSSL_NO_TLSEXT
 347                 if (s->tlsext_hostname) {
 348                         ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
 349                         if (ss->tlsext_hostname == NULL) {
 350                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 351                                 SSL_SESSION_free(ss);
 352                                 return 0;
 353                                 }
 354                         }
 355 #endif
 356                 }
 357         else
 358                 {
 359                 ss->session_id_length=0;
 360                 }
 361
 362         if (s->sid_ctx_length > sizeof ss->sid_ctx)
 363                 {
 364                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 365                 SSL_SESSION_free(ss);
 366                 return 0;
 367                 }
 368         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
 369         ss->sid_ctx_length=s->sid_ctx_length;
 370         s->session=ss;
 371         ss->ssl_version=s->version;
 372         ss->verify_result = X509_V_OK;
 373
 374         return(1);
 375         }
 376
 377 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len)
 378         {
 379         /* This is used only by servers. */
 380
 381         SSL_SESSION *ret=NULL,data;
 382         int fatal = 0;
 383
 384         data.ssl_version=s->version;
 385         data.session_id_length=len;
 386         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
 387                 goto err;
 388         memcpy(data.session_id,session_id,len);
 389
 390         if (!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 391                 {
 392                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 393                 ret=(SSL_SESSION *)lh_retrieve(s->session_ctx->sessions,&data);
 394                 if (ret != NULL)
 395                     /* don't allow other threads to steal it: */
 396                     CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 397                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 398                 }
 399
 400         if (ret == NULL)
 401                 {
 402                 int copy=1;
 403
 404                 s->session_ctx->stats.sess_miss++;
 405                 ret=NULL;
 406                 if (s->session_ctx->get_session_cb != NULL
 407                     && (ret=s->session_ctx->get_session_cb(s,session_id,len,&copy))
 408                        != NULL)
 409                         {
 410                         s->session_ctx->stats.sess_cb_hit++;
 411
 412                         /* Increment reference count now if the session callback
 413                          * asks us to do so (note that if the session structures
 414                          * returned by the callback are shared between threads,
 415                          * it must handle the reference count itself [i.e. copy == 0],
 416                          * or things won't be thread-safe). */
 417                         if (copy)
 418                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 419
 420                         /* Add the externally cached session to the internal
 421                          * cache as well if and only if we are supposed to. */
 422                         if(!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
 423                                 /* The following should not return 1, otherwise,
 424                                  * things are very strange */
 425                                 SSL_CTX_add_session(s->session_ctx,ret);
 426                         }
 427                 if (ret == NULL)
 428                         goto err;
 429                 }
 430
 431         /* Now ret is non-NULL, and we own one of its reference counts. */
 432
 433         if((s->verify_mode&SSL_VERIFY_PEER)
 434            && (!s->sid_ctx_length || ret->sid_ctx_length != s->sid_ctx_length
 435                || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length)))
 436             {
 437                 /* We've found the session named by the client, but we don't
 438                  * want to use it in this context. */
 439
 440                 if (s->sid_ctx_length == 0)
 441                         {
 442                         /* application should have used SSL[_CTX]_set_session_id_context
 443                          * -- we could tolerate this and just pretend we never heard
 444                          * of this session, but then applications could effectively
 445                          * disable the session cache by accident without anyone noticing */
 446
 447                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 448                         fatal = 1;
 449                         goto err;
 450                         }
 451                 else
 452                         {
 453 #if 0 /* The client cannot always know when a session is not appropriate,
 454            * so we shouldn't generate an error message. */
 455
 456                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
 457 #endif
 458                         goto err; /* treat like cache miss */
 459                         }
 460                 }
 461
 462         if (ret->cipher == NULL)
 463                 {
 464                 unsigned char buf[5],*p;
 465                 unsigned long l;
 466
 467                 p=buf;
 468                 l=ret->cipher_id;
 469                 l2n(l,p);
 470                 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
 471                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
 472                 else
 473                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
 474                 if (ret->cipher == NULL)
 475                         goto err;
 476                 }
 477
 478
 479 #if 0 /* This is way too late. */
 480
 481         /* If a thread got the session, then 'swaped', and another got
 482          * it and then due to a time-out decided to 'OPENSSL_free' it we could
 483          * be in trouble.  So I'll increment it now, then double decrement
 484          * later - am I speaking rubbish?. */
 485         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 486 #endif
 487
 488         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
 489                 {
 490                 s->session_ctx->stats.sess_timeout++;
 491                 /* remove it from the cache */
 492                 SSL_CTX_remove_session(s->session_ctx,ret);
 493                 goto err;
 494                 }
 495
 496         s->session_ctx->stats.sess_hit++;
 497
 498         /* ret->time=time(NULL); */ /* rezero timeout? */
 499         /* again, just leave the session
 500          * if it is the same session, we have just incremented and
 501          * then decremented the reference count :-) */
 502         if (s->session != NULL)
 503                 SSL_SESSION_free(s->session);
 504         s->session=ret;
 505         s->verify_result = s->session->verify_result;
 506         return(1);
 507
 508  err:
 509         if (ret != NULL)
 510                 SSL_SESSION_free(ret);
 511         if (fatal)
 512                 return -1;
 513         else
 514                 return 0;
 515         }
 516
 517 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 518         {
 519         int ret=0;
 520         SSL_SESSION *s;
 521
 522         /* add just 1 reference count for the SSL_CTX's session cache
 523          * even though it has two ways of access: each session is in a
 524          * doubly linked list and an lhash */
 525         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
 526         /* if session c is in already in cache, we take back the increment later */
 527
 528         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 529         s=(SSL_SESSION *)lh_insert(ctx->sessions,c);
 530
 531         /* s != NULL iff we already had a session with the given PID.
 532          * In this case, s == c should hold (then we did not really modify
 533          * ctx->sessions), or we're in trouble. */
 534         if (s != NULL && s != c)
 535                 {
 536                 /* We *are* in trouble ... */
 537                 SSL_SESSION_list_remove(ctx,s);
 538                 SSL_SESSION_free(s);
 539                 /* ... so pretend the other session did not exist in cache
 540                  * (we cannot handle two SSL_SESSION structures with identical
 541                  * session ID in the same cache, which could happen e.g. when
 542                  * two threads concurrently obtain the same session from an external
 543                  * cache) */
 544                 s = NULL;
 545                 }
 546
 547         /* Put at the head of the queue unless it is already in the cache */
 548         if (s == NULL)
 549                 SSL_SESSION_list_add(ctx,c);
 550
 551         if (s != NULL)
 552                 {
 553                 /* existing cache entry -- decrement previously incremented reference
 554                  * count because it already takes into account the cache */
 555
 556                 SSL_SESSION_free(s); /* s == c */
 557                 ret=0;
 558                 }
 559         else
 560                 {
 561                 /* new cache entry -- remove old ones if cache has become too large */
 562
 563                 ret=1;
 564
 565                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
 566                         {
 567                         while (SSL_CTX_sess_number(ctx) >
 568                                 SSL_CTX_sess_get_cache_size(ctx))
 569                                 {
 570                                 if (!remove_session_lock(ctx,
 571                                         ctx->session_cache_tail, 0))
 572                                         break;
 573                                 else
 574                                         ctx->stats.sess_cache_full++;
 575                                 }
 576                         }
 577                 }
 578         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 579         return(ret);
 580         }
 581
 582 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 583 {
 584         return remove_session_lock(ctx, c, 1);
 585 }
 586
 587 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 588         {
 589         SSL_SESSION *r;
 590         int ret=0;
 591
 592         if ((c != NULL) && (c->session_id_length != 0))
 593                 {
 594                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 595                 if ((r = (SSL_SESSION *)lh_retrieve(ctx->sessions,c)) == c)
 596                         {
 597                         ret=1;
 598                         r=(SSL_SESSION *)lh_delete(ctx->sessions,c);
 599                         SSL_SESSION_list_remove(ctx,c);
 600                         }
 601
 602                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 603
 604                 if (ret)
 605                         {
 606                         r->not_resumable=1;
 607                         if (ctx->remove_session_cb != NULL)
 608                                 ctx->remove_session_cb(ctx,r);
 609                         SSL_SESSION_free(r);
 610                         }
 611                 }
 612         else
 613                 ret=0;
 614         return(ret);
 615         }
 616
 617 void SSL_SESSION_free(SSL_SESSION *ss)
 618         {
 619         int i;
 620
 621         if(ss == NULL)
 622             return;
 623
 624         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
 625 #ifdef REF_PRINT
 626         REF_PRINT("SSL_SESSION",ss);
 627 #endif
 628         if (i > 0) return;
 629 #ifdef REF_CHECK
 630         if (i < 0)
 631                 {
 632                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
 633                 abort(); /* ok */
 634                 }
 635 #endif
 636
 637         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 638
 639         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
 640         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
 641         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
 642         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
 643         if (ss->peer != NULL) X509_free(ss->peer);
 644         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
 645 #ifndef OPENSSL_NO_TLSEXT
 646         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
 647 #endif
 648 #ifndef OPENSSL_NO_PSK
 649         if (ss->psk_identity_hint != NULL)
 650                 OPENSSL_free(ss->psk_identity_hint);
 651         if (ss->psk_identity != NULL)
 652                 OPENSSL_free(ss->psk_identity);
 653 #endif
 654         OPENSSL_cleanse(ss,sizeof(*ss));
 655         OPENSSL_free(ss);
 656         }
 657
 658 int SSL_set_session(SSL *s, SSL_SESSION *session)
 659         {
 660         int ret=0;
 661         const SSL_METHOD *meth;
 662
 663         if (session != NULL)
 664                 {
 665                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
 666                 if (meth == NULL)
 667                         meth=s->method->get_ssl_method(session->ssl_version);
 668                 if (meth == NULL)
 669                         {
 670                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
 671                         return(0);
 672                         }
 673
 674                 if (meth != s->method)
 675                         {
 676                         if (!SSL_set_ssl_method(s,meth))
 677                                 return(0);
 678                         if (s->ctx->session_timeout == 0)
 679                                 session->timeout=SSL_get_default_timeout(s);
 680                         else
 681                                 session->timeout=s->ctx->session_timeout;
 682                         }
 683
 684 #ifndef OPENSSL_NO_KRB5
 685                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
 686                     session->krb5_client_princ_len > 0)
 687                 {
 688                     s->kssl_ctx->client_princ = (char *)malloc(session->krb5_client_princ_len + 1);
 689                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
 690                             session->krb5_client_princ_len);
 691                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
 692                 }
 693 #endif /* OPENSSL_NO_KRB5 */
 694
 695                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
 696                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
 697                 if (s->session != NULL)
 698                         SSL_SESSION_free(s->session);
 699                 s->session=session;
 700                 s->verify_result = s->session->verify_result;
 701                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
 702                 ret=1;
 703                 }
 704         else
 705                 {
 706                 if (s->session != NULL)
 707                         {
 708                         SSL_SESSION_free(s->session);
 709                         s->session=NULL;
 710                         }
 711
 712                 meth=s->ctx->method;
 713                 if (meth != s->method)
 714                         {
 715                         if (!SSL_set_ssl_method(s,meth))
 716                                 return(0);
 717                         }
 718                 ret=1;
 719                 }
 720         return(ret);
 721         }
 722
 723 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 724         {
 725         if (s == NULL) return(0);
 726         s->timeout=t;
 727         return(1);
 728         }
 729
 730 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 731         {
 732         if (s == NULL) return(0);
 733         return(s->timeout);
 734         }
 735
 736 long SSL_SESSION_get_time(const SSL_SESSION *s)
 737         {
 738         if (s == NULL) return(0);
 739         return(s->time);
 740         }
 741
 742 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 743         {
 744         if (s == NULL) return(0);
 745         s->time=t;
 746         return(t);
 747         }
 748
 749 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 750         {
 751         long l;
 752         if (s == NULL) return(0);
 753         l=s->session_timeout;
 754         s->session_timeout=t;
 755         return(l);
 756         }
 757
 758 long SSL_CTX_get_timeout(const SSL_CTX *s)
 759         {
 760         if (s == NULL) return(0);
 761         return(s->session_timeout);
 762         }
 763
 764 typedef struct timeout_param_st
 765         {
 766         SSL_CTX *ctx;
 767         long time;
 768         LHASH *cache;
 769         } TIMEOUT_PARAM;
 770
 771 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
 772         {
 773         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
 774                 {
 775                 /* The reason we don't call SSL_CTX_remove_session() is to
 776                  * save on locking overhead */
 777                 lh_delete(p->cache,s);
 778                 SSL_SESSION_list_remove(p->ctx,s);
 779                 s->not_resumable=1;
 780                 if (p->ctx->remove_session_cb != NULL)
 781                         p->ctx->remove_session_cb(p->ctx,s);
 782                 SSL_SESSION_free(s);
 783                 }
 784         }
 785
 786 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION *, TIMEOUT_PARAM *)
 787
 788 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 789         {
 790         unsigned long i;
 791         TIMEOUT_PARAM tp;
 792
 793         tp.ctx=s;
 794         tp.cache=s->sessions;
 795         if (tp.cache == NULL) return;
 796         tp.time=t;
 797         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 798         i=tp.cache->down_load;
 799         tp.cache->down_load=0;
 800         lh_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout), &tp);
 801         tp.cache->down_load=i;
 802         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 803         }
 804
 805 int ssl_clear_bad_session(SSL *s)
 806         {
 807         if (    (s->session != NULL) &&
 808                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
 809                 !(SSL_in_init(s) || SSL_in_before(s)))
 810                 {
 811                 SSL_CTX_remove_session(s->ctx,s->session);
 812                 return(1);
 813                 }
 814         else
 815                 return(0);
 816         }
 817
 818 /* locked by SSL_CTX in the calling function */
 819 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
 820         {
 821         if ((s->next == NULL) || (s->prev == NULL)) return;
 822
 823         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
 824                 { /* last element in list */
 825                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
 826                         { /* only one element in list */
 827                         ctx->session_cache_head=NULL;
 828                         ctx->session_cache_tail=NULL;
 829                         }
 830                 else
 831                         {
 832                         ctx->session_cache_tail=s->prev;
 833                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
 834                         }
 835                 }
 836         else
 837                 {
 838                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
 839                         { /* first element in list */
 840                         ctx->session_cache_head=s->next;
 841                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 842                         }
 843                 else
 844                         { /* middle of list */
 845                         s->next->prev=s->prev;
 846                         s->prev->next=s->next;
 847                         }
 848                 }
 849         s->prev=s->next=NULL;
 850         }
 851
 852 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
 853         {
 854         if ((s->next != NULL) && (s->prev != NULL))
 855                 SSL_SESSION_list_remove(ctx,s);
 856
 857         if (ctx->session_cache_head == NULL)
 858                 {
 859                 ctx->session_cache_head=s;
 860                 ctx->session_cache_tail=s;
 861                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 862                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
 863                 }
 864         else
 865                 {
 866                 s->next=ctx->session_cache_head;
 867                 s->next->prev=s;
 868                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 869                 ctx->session_cache_head=s;
 870                 }
 871         }
 872