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