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 #ifndef OPENSSL_NO_EC
 207         ss->tlsext_ecpointformatlist_length = 0;
 208         ss->tlsext_ecpointformatlist = NULL;
 209 #endif
 210 #endif
 211         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 212 #ifndef OPENSSL_NO_PSK
 213         ss->psk_identity_hint=NULL;
 214         ss->psk_identity=NULL;
 215 #endif
 216         return(ss);
 217         }
 218
 219 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
 220         {
 221         if(len)
 222                 *len = s->session_id_length;
 223         return s->session_id;
 224         }
 225
 226 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
 227  * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
 228  * until we have no conflict is going to complete in one iteration pretty much
 229  * "most" of the time (btw: understatement). So, if it takes us 10 iterations
 230  * and we still can't avoid a conflict - well that's a reasonable point to call
 231  * it quits. Either the RAND code is broken or someone is trying to open roughly
 232  * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
 233  * store that many sessions is perhaps a more interesting question ... */
 234
 235 #define MAX_SESS_ID_ATTEMPTS 10
 236 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
 237                                 unsigned int *id_len)
 238 {
 239         unsigned int retry = 0;
 240         do
 241                 if (RAND_pseudo_bytes(id, *id_len) <= 0)
 242                         return 0;
 243         while(SSL_has_matching_session_id(ssl, id, *id_len) &&
 244                 (++retry < MAX_SESS_ID_ATTEMPTS));
 245         if(retry < MAX_SESS_ID_ATTEMPTS)
 246                 return 1;
 247         /* else - woops a session_id match */
 248         /* XXX We should also check the external cache --
 249          * but the probability of a collision is negligible, and
 250          * we could not prevent the concurrent creation of sessions
 251          * with identical IDs since we currently don't have means
 252          * to atomically check whether a session ID already exists
 253          * and make a reservation for it if it does not
 254          * (this problem applies to the internal cache as well).
 255          */
 256         return 0;
 257 }
 258
 259 int ssl_get_new_session(SSL *s, int session)
 260         {
 261         /* This gets used by clients and servers. */
 262
 263         unsigned int tmp;
 264         SSL_SESSION *ss=NULL;
 265         GEN_SESSION_CB cb = def_generate_session_id;
 266
 267         if ((ss=SSL_SESSION_new()) == NULL) return(0);
 268
 269         /* If the context has a default timeout, use it */
 270         if (s->session_ctx->session_timeout == 0)
 271                 ss->timeout=SSL_get_default_timeout(s);
 272         else
 273                 ss->timeout=s->session_ctx->session_timeout;
 274
 275         if (s->session != NULL)
 276                 {
 277                 SSL_SESSION_free(s->session);
 278                 s->session=NULL;
 279                 }
 280
 281         if (session)
 282                 {
 283                 if (s->version == SSL2_VERSION)
 284                         {
 285                         ss->ssl_version=SSL2_VERSION;
 286                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
 287                         }
 288                 else if (s->version == SSL3_VERSION)
 289                         {
 290                         ss->ssl_version=SSL3_VERSION;
 291                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 292                         }
 293                 else if (s->version == TLS1_VERSION)
 294                         {
 295                         ss->ssl_version=TLS1_VERSION;
 296                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 297                         }
 298                 else if (s->version == DTLS1_VERSION)
 299                         {
 300                         ss->ssl_version=DTLS1_VERSION;
 301                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 302                         }
 303                 else
 304                         {
 305                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
 306                         SSL_SESSION_free(ss);
 307                         return(0);
 308                         }
 309                 /* Choose which callback will set the session ID */
 310                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 311                 if(s->generate_session_id)
 312                         cb = s->generate_session_id;
 313                 else if(s->session_ctx->generate_session_id)
 314                         cb = s->session_ctx->generate_session_id;
 315                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 316                 /* Choose a session ID */
 317                 tmp = ss->session_id_length;
 318                 if(!cb(s, ss->session_id, &tmp))
 319                         {
 320                         /* The callback failed */
 321                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 322                                 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
 323                         SSL_SESSION_free(ss);
 324                         return(0);
 325                         }
 326                 /* Don't allow the callback to set the session length to zero.
 327                  * nor set it higher than it was. */
 328                 if(!tmp || (tmp > ss->session_id_length))
 329                         {
 330                         /* The callback set an illegal length */
 331                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 332                                 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
 333                         SSL_SESSION_free(ss);
 334                         return(0);
 335                         }
 336                 /* If the session length was shrunk and we're SSLv2, pad it */
 337                 if((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
 338                         memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
 339                 else
 340                         ss->session_id_length = tmp;
 341                 /* Finally, check for a conflict */
 342                 if(SSL_has_matching_session_id(s, ss->session_id,
 343                                                 ss->session_id_length))
 344                         {
 345                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 346                                 SSL_R_SSL_SESSION_ID_CONFLICT);
 347                         SSL_SESSION_free(ss);
 348                         return(0);
 349                         }
 350 #ifndef OPENSSL_NO_TLSEXT
 351                 if (s->tlsext_hostname) {
 352                         ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
 353                         if (ss->tlsext_hostname == NULL) {
 354                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 355                                 SSL_SESSION_free(ss);
 356                                 return 0;
 357                                 }
 358                         }
 359 #ifndef OPENSSL_NO_EC
 360                 if (s->tlsext_ecpointformatlist)
 361                         {
 362                         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
 363                         if ((ss->tlsext_ecpointformatlist = OPENSSL_malloc(s->tlsext_ecpointformatlist_length)) == NULL)
 364                                 {
 365                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
 366                                 SSL_SESSION_free(ss);
 367                                 return 0;
 368                                 }
 369                         ss->tlsext_ecpointformatlist_length = s->tlsext_ecpointformatlist_length;
 370                         memcpy(ss->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist_length);
 371                         }
 372 #endif
 373 #endif
 374                 }
 375         else
 376                 {
 377                 ss->session_id_length=0;
 378                 }
 379
 380         if (s->sid_ctx_length > sizeof ss->sid_ctx)
 381                 {
 382                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 383                 SSL_SESSION_free(ss);
 384                 return 0;
 385                 }
 386         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
 387         ss->sid_ctx_length=s->sid_ctx_length;
 388         s->session=ss;
 389         ss->ssl_version=s->version;
 390         ss->verify_result = X509_V_OK;
 391
 392         return(1);
 393         }
 394
 395 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len)
 396         {
 397         /* This is used only by servers. */
 398
 399         SSL_SESSION *ret=NULL,data;
 400         int fatal = 0;
 401
 402         data.ssl_version=s->version;
 403         data.session_id_length=len;
 404         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
 405                 goto err;
 406         memcpy(data.session_id,session_id,len);
 407
 408         if (!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 409                 {
 410                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 411                 ret=(SSL_SESSION *)lh_retrieve(s->session_ctx->sessions,&data);
 412                 if (ret != NULL)
 413                     /* don't allow other threads to steal it: */
 414                     CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 415                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 416                 }
 417
 418         if (ret == NULL)
 419                 {
 420                 int copy=1;
 421
 422                 s->session_ctx->stats.sess_miss++;
 423                 ret=NULL;
 424                 if (s->session_ctx->get_session_cb != NULL
 425                     && (ret=s->session_ctx->get_session_cb(s,session_id,len,&copy))
 426                        != NULL)
 427                         {
 428                         s->session_ctx->stats.sess_cb_hit++;
 429
 430                         /* Increment reference count now if the session callback
 431                          * asks us to do so (note that if the session structures
 432                          * returned by the callback are shared between threads,
 433                          * it must handle the reference count itself [i.e. copy == 0],
 434                          * or things won't be thread-safe). */
 435                         if (copy)
 436                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 437
 438                         /* Add the externally cached session to the internal
 439                          * cache as well if and only if we are supposed to. */
 440                         if(!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
 441                                 /* The following should not return 1, otherwise,
 442                                  * things are very strange */
 443                                 SSL_CTX_add_session(s->session_ctx,ret);
 444                         }
 445                 if (ret == NULL)
 446                         goto err;
 447                 }
 448
 449         /* Now ret is non-NULL, and we own one of its reference counts. */
 450
 451         if((s->verify_mode&SSL_VERIFY_PEER)
 452            && (!s->sid_ctx_length || ret->sid_ctx_length != s->sid_ctx_length
 453                || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length)))
 454             {
 455                 /* We've found the session named by the client, but we don't
 456                  * want to use it in this context. */
 457
 458                 if (s->sid_ctx_length == 0)
 459                         {
 460                         /* application should have used SSL[_CTX]_set_session_id_context
 461                          * -- we could tolerate this and just pretend we never heard
 462                          * of this session, but then applications could effectively
 463                          * disable the session cache by accident without anyone noticing */
 464
 465                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 466                         fatal = 1;
 467                         goto err;
 468                         }
 469                 else
 470                         {
 471 #if 0 /* The client cannot always know when a session is not appropriate,
 472            * so we shouldn't generate an error message. */
 473
 474                         SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
 475 #endif
 476                         goto err; /* treat like cache miss */
 477                         }
 478                 }
 479
 480         if (ret->cipher == NULL)
 481                 {
 482                 unsigned char buf[5],*p;
 483                 unsigned long l;
 484
 485                 p=buf;
 486                 l=ret->cipher_id;
 487                 l2n(l,p);
 488                 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
 489                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
 490                 else
 491                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
 492                 if (ret->cipher == NULL)
 493                         goto err;
 494                 }
 495
 496
 497 #if 0 /* This is way too late. */
 498
 499         /* If a thread got the session, then 'swaped', and another got
 500          * it and then due to a time-out decided to 'OPENSSL_free' it we could
 501          * be in trouble.  So I'll increment it now, then double decrement
 502          * later - am I speaking rubbish?. */
 503         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 504 #endif
 505
 506         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
 507                 {
 508                 s->session_ctx->stats.sess_timeout++;
 509                 /* remove it from the cache */
 510                 SSL_CTX_remove_session(s->session_ctx,ret);
 511                 goto err;
 512                 }
 513
 514         s->session_ctx->stats.sess_hit++;
 515
 516         /* ret->time=time(NULL); */ /* rezero timeout? */
 517         /* again, just leave the session
 518          * if it is the same session, we have just incremented and
 519          * then decremented the reference count :-) */
 520         if (s->session != NULL)
 521                 SSL_SESSION_free(s->session);
 522         s->session=ret;
 523         s->verify_result = s->session->verify_result;
 524         return(1);
 525
 526  err:
 527         if (ret != NULL)
 528                 SSL_SESSION_free(ret);
 529         if (fatal)
 530                 return -1;
 531         else
 532                 return 0;
 533         }
 534
 535 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 536         {
 537         int ret=0;
 538         SSL_SESSION *s;
 539
 540         /* add just 1 reference count for the SSL_CTX's session cache
 541          * even though it has two ways of access: each session is in a
 542          * doubly linked list and an lhash */
 543         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
 544         /* if session c is in already in cache, we take back the increment later */
 545
 546         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 547         s=(SSL_SESSION *)lh_insert(ctx->sessions,c);
 548
 549         /* s != NULL iff we already had a session with the given PID.
 550          * In this case, s == c should hold (then we did not really modify
 551          * ctx->sessions), or we're in trouble. */
 552         if (s != NULL && s != c)
 553                 {
 554                 /* We *are* in trouble ... */
 555                 SSL_SESSION_list_remove(ctx,s);
 556                 SSL_SESSION_free(s);
 557                 /* ... so pretend the other session did not exist in cache
 558                  * (we cannot handle two SSL_SESSION structures with identical
 559                  * session ID in the same cache, which could happen e.g. when
 560                  * two threads concurrently obtain the same session from an external
 561                  * cache) */
 562                 s = NULL;
 563                 }
 564
 565         /* Put at the head of the queue unless it is already in the cache */
 566         if (s == NULL)
 567                 SSL_SESSION_list_add(ctx,c);
 568
 569         if (s != NULL)
 570                 {
 571                 /* existing cache entry -- decrement previously incremented reference
 572                  * count because it already takes into account the cache */
 573
 574                 SSL_SESSION_free(s); /* s == c */
 575                 ret=0;
 576                 }
 577         else
 578                 {
 579                 /* new cache entry -- remove old ones if cache has become too large */
 580
 581                 ret=1;
 582
 583                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
 584                         {
 585                         while (SSL_CTX_sess_number(ctx) >
 586                                 SSL_CTX_sess_get_cache_size(ctx))
 587                                 {
 588                                 if (!remove_session_lock(ctx,
 589                                         ctx->session_cache_tail, 0))
 590                                         break;
 591                                 else
 592                                         ctx->stats.sess_cache_full++;
 593                                 }
 594                         }
 595                 }
 596         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 597         return(ret);
 598         }
 599
 600 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 601 {
 602         return remove_session_lock(ctx, c, 1);
 603 }
 604
 605 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 606         {
 607         SSL_SESSION *r;
 608         int ret=0;
 609
 610         if ((c != NULL) && (c->session_id_length != 0))
 611                 {
 612                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 613                 if ((r = (SSL_SESSION *)lh_retrieve(ctx->sessions,c)) == c)
 614                         {
 615                         ret=1;
 616                         r=(SSL_SESSION *)lh_delete(ctx->sessions,c);
 617                         SSL_SESSION_list_remove(ctx,c);
 618                         }
 619
 620                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 621
 622                 if (ret)
 623                         {
 624                         r->not_resumable=1;
 625                         if (ctx->remove_session_cb != NULL)
 626                                 ctx->remove_session_cb(ctx,r);
 627                         SSL_SESSION_free(r);
 628                         }
 629                 }
 630         else
 631                 ret=0;
 632         return(ret);
 633         }
 634
 635 void SSL_SESSION_free(SSL_SESSION *ss)
 636         {
 637         int i;
 638
 639         if(ss == NULL)
 640             return;
 641
 642         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
 643 #ifdef REF_PRINT
 644         REF_PRINT("SSL_SESSION",ss);
 645 #endif
 646         if (i > 0) return;
 647 #ifdef REF_CHECK
 648         if (i < 0)
 649                 {
 650                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
 651                 abort(); /* ok */
 652                 }
 653 #endif
 654
 655         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 656
 657         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
 658         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
 659         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
 660         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
 661         if (ss->peer != NULL) X509_free(ss->peer);
 662         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
 663 #ifndef OPENSSL_NO_TLSEXT
 664         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
 665 #ifndef OPENSSL_NO_EC
 666         ss->tlsext_ecpointformatlist_length = 0;
 667         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
 668 #endif /* OPENSSL_NO_EC */
 669 #endif
 670 #ifndef OPENSSL_NO_PSK
 671         if (ss->psk_identity_hint != NULL)
 672                 OPENSSL_free(ss->psk_identity_hint);
 673         if (ss->psk_identity != NULL)
 674                 OPENSSL_free(ss->psk_identity);
 675 #endif
 676         OPENSSL_cleanse(ss,sizeof(*ss));
 677         OPENSSL_free(ss);
 678         }
 679
 680 int SSL_set_session(SSL *s, SSL_SESSION *session)
 681         {
 682         int ret=0;
 683         const SSL_METHOD *meth;
 684
 685         if (session != NULL)
 686                 {
 687                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
 688                 if (meth == NULL)
 689                         meth=s->method->get_ssl_method(session->ssl_version);
 690                 if (meth == NULL)
 691                         {
 692                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
 693                         return(0);
 694                         }
 695
 696                 if (meth != s->method)
 697                         {
 698                         if (!SSL_set_ssl_method(s,meth))
 699                                 return(0);
 700                         if (s->ctx->session_timeout == 0)
 701                                 session->timeout=SSL_get_default_timeout(s);
 702                         else
 703                                 session->timeout=s->ctx->session_timeout;
 704                         }
 705
 706 #ifndef OPENSSL_NO_KRB5
 707                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
 708                     session->krb5_client_princ_len > 0)
 709                 {
 710                     s->kssl_ctx->client_princ = (char *)malloc(session->krb5_client_princ_len + 1);
 711                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
 712                             session->krb5_client_princ_len);
 713                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
 714                 }
 715 #endif /* OPENSSL_NO_KRB5 */
 716
 717                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
 718                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
 719                 if (s->session != NULL)
 720                         SSL_SESSION_free(s->session);
 721                 s->session=session;
 722                 s->verify_result = s->session->verify_result;
 723                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
 724                 ret=1;
 725                 }
 726         else
 727                 {
 728                 if (s->session != NULL)
 729                         {
 730                         SSL_SESSION_free(s->session);
 731                         s->session=NULL;
 732                         }
 733
 734                 meth=s->ctx->method;
 735                 if (meth != s->method)
 736                         {
 737                         if (!SSL_set_ssl_method(s,meth))
 738                                 return(0);
 739                         }
 740                 ret=1;
 741                 }
 742         return(ret);
 743         }
 744
 745 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 746         {
 747         if (s == NULL) return(0);
 748         s->timeout=t;
 749         return(1);
 750         }
 751
 752 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 753         {
 754         if (s == NULL) return(0);
 755         return(s->timeout);
 756         }
 757
 758 long SSL_SESSION_get_time(const SSL_SESSION *s)
 759         {
 760         if (s == NULL) return(0);
 761         return(s->time);
 762         }
 763
 764 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 765         {
 766         if (s == NULL) return(0);
 767         s->time=t;
 768         return(t);
 769         }
 770
 771 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 772         {
 773         long l;
 774         if (s == NULL) return(0);
 775         l=s->session_timeout;
 776         s->session_timeout=t;
 777         return(l);
 778         }
 779
 780 long SSL_CTX_get_timeout(const SSL_CTX *s)
 781         {
 782         if (s == NULL) return(0);
 783         return(s->session_timeout);
 784         }
 785
 786 typedef struct timeout_param_st
 787         {
 788         SSL_CTX *ctx;
 789         long time;
 790         LHASH *cache;
 791         } TIMEOUT_PARAM;
 792
 793 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
 794         {
 795         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
 796                 {
 797                 /* The reason we don't call SSL_CTX_remove_session() is to
 798                  * save on locking overhead */
 799                 lh_delete(p->cache,s);
 800                 SSL_SESSION_list_remove(p->ctx,s);
 801                 s->not_resumable=1;
 802                 if (p->ctx->remove_session_cb != NULL)
 803                         p->ctx->remove_session_cb(p->ctx,s);
 804                 SSL_SESSION_free(s);
 805                 }
 806         }
 807
 808 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION *, TIMEOUT_PARAM *)
 809
 810 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 811         {
 812         unsigned long i;
 813         TIMEOUT_PARAM tp;
 814
 815         tp.ctx=s;
 816         tp.cache=s->sessions;
 817         if (tp.cache == NULL) return;
 818         tp.time=t;
 819         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 820         i=tp.cache->down_load;
 821         tp.cache->down_load=0;
 822         lh_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout), &tp);
 823         tp.cache->down_load=i;
 824         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 825         }
 826
 827 int ssl_clear_bad_session(SSL *s)
 828         {
 829         if (    (s->session != NULL) &&
 830                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
 831                 !(SSL_in_init(s) || SSL_in_before(s)))
 832                 {
 833                 SSL_CTX_remove_session(s->ctx,s->session);
 834                 return(1);
 835                 }
 836         else
 837                 return(0);
 838         }
 839
 840 /* locked by SSL_CTX in the calling function */
 841 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
 842         {
 843         if ((s->next == NULL) || (s->prev == NULL)) return;
 844
 845         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
 846                 { /* last element in list */
 847                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
 848                         { /* only one element in list */
 849                         ctx->session_cache_head=NULL;
 850                         ctx->session_cache_tail=NULL;
 851                         }
 852                 else
 853                         {
 854                         ctx->session_cache_tail=s->prev;
 855                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
 856                         }
 857                 }
 858         else
 859                 {
 860                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
 861                         { /* first element in list */
 862                         ctx->session_cache_head=s->next;
 863                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 864                         }
 865                 else
 866                         { /* middle of list */
 867                         s->next->prev=s->prev;
 868                         s->prev->next=s->next;
 869                         }
 870                 }
 871         s->prev=s->next=NULL;
 872         }
 873
 874 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
 875         {
 876         if ((s->next != NULL) && (s->prev != NULL))
 877                 SSL_SESSION_list_remove(ctx,s);
 878
 879         if (ctx->session_cache_head == NULL)
 880                 {
 881                 ctx->session_cache_head=s;
 882                 ctx->session_cache_tail=s;
 883                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 884                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
 885                 }
 886         else
 887                 {
 888                 s->next=ctx->session_cache_head;
 889                 s->next->prev=s;
 890                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 891                 ctx->session_cache_head=s;
 892                 }
 893         }
 894