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 #ifndef OPENSSL_NO_ENGINE
 142 #include <openssl/engine.h>
 143 #endif
 144 #include "ssl_locl.h"
 145
 146 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
 147 static void SSL_SESSION_list_add(SSL_CTX *ctx,SSL_SESSION *s);
 148 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
 149
 150 SSL_SESSION *SSL_get_session(const SSL *ssl)
 151 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
 152         {
 153         return(ssl->session);
 154         }
 155
 156 SSL_SESSION *SSL_get1_session(SSL *ssl)
 157 /* variant of SSL_get_session: caller really gets something */
 158         {
 159         SSL_SESSION *sess;
 160         /* Need to lock this all up rather than just use CRYPTO_add so that
 161          * somebody doesn't free ssl->session between when we check it's
 162          * non-null and when we up the reference count. */
 163         CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION);
 164         sess = ssl->session;
 165         if(sess)
 166                 sess->references++;
 167         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
 168         return(sess);
 169         }
 170
 171 int SSL_SESSION_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 172              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
 173         {
 174         return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, argl, argp,
 175                         new_func, dup_func, free_func);
 176         }
 177
 178 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
 179         {
 180         return(CRYPTO_set_ex_data(&s->ex_data,idx,arg));
 181         }
 182
 183 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
 184         {
 185         return(CRYPTO_get_ex_data(&s->ex_data,idx));
 186         }
 187
 188 SSL_SESSION *SSL_SESSION_new(void)
 189         {
 190         SSL_SESSION *ss;
 191
 192         ss=(SSL_SESSION *)OPENSSL_malloc(sizeof(SSL_SESSION));
 193         if (ss == NULL)
 194                 {
 195                 SSLerr(SSL_F_SSL_SESSION_NEW,ERR_R_MALLOC_FAILURE);
 196                 return(0);
 197                 }
 198         memset(ss,0,sizeof(SSL_SESSION));
 199
 200         ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
 201         ss->references=1;
 202         ss->timeout=60*5+4; /* 5 minute timeout by default */
 203         ss->time=(unsigned long)time(NULL);
 204         ss->prev=NULL;
 205         ss->next=NULL;
 206         ss->compress_meth=0;
 207 #ifndef OPENSSL_NO_TLSEXT
 208         ss->tlsext_hostname = NULL;
 209 #ifndef OPENSSL_NO_EC
 210         ss->tlsext_ecpointformatlist_length = 0;
 211         ss->tlsext_ecpointformatlist = NULL;
 212         ss->tlsext_ellipticcurvelist_length = 0;
 213         ss->tlsext_ellipticcurvelist = NULL;
 214 #endif
 215 #endif
 216         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 217 #ifndef OPENSSL_NO_PSK
 218         ss->psk_identity_hint=NULL;
 219         ss->psk_identity=NULL;
 220 #endif
 221 #ifndef OPENSSL_NO_SRP
 222         ss->srp_username=NULL;
 223 #endif
 224         return(ss);
 225         }
 226
 227 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
 228         {
 229         if(len)
 230                 *len = s->session_id_length;
 231         return s->session_id;
 232         }
 233
 234 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
 235         {
 236         return s->compress_meth;
 237         }
 238
 239 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
 240  * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
 241  * until we have no conflict is going to complete in one iteration pretty much
 242  * "most" of the time (btw: understatement). So, if it takes us 10 iterations
 243  * and we still can't avoid a conflict - well that's a reasonable point to call
 244  * it quits. Either the RAND code is broken or someone is trying to open roughly
 245  * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
 246  * store that many sessions is perhaps a more interesting question ... */
 247
 248 #define MAX_SESS_ID_ATTEMPTS 10
 249 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
 250                                 unsigned int *id_len)
 251 {
 252         unsigned int retry = 0;
 253         do
 254                 if (RAND_pseudo_bytes(id, *id_len) <= 0)
 255                         return 0;
 256         while(SSL_has_matching_session_id(ssl, id, *id_len) &&
 257                 (++retry < MAX_SESS_ID_ATTEMPTS));
 258         if(retry < MAX_SESS_ID_ATTEMPTS)
 259                 return 1;
 260         /* else - woops a session_id match */
 261         /* XXX We should also check the external cache --
 262          * but the probability of a collision is negligible, and
 263          * we could not prevent the concurrent creation of sessions
 264          * with identical IDs since we currently don't have means
 265          * to atomically check whether a session ID already exists
 266          * and make a reservation for it if it does not
 267          * (this problem applies to the internal cache as well).
 268          */
 269         return 0;
 270 }
 271
 272 int ssl_get_new_session(SSL *s, int session)
 273         {
 274         /* This gets used by clients and servers. */
 275
 276         unsigned int tmp;
 277         SSL_SESSION *ss=NULL;
 278         GEN_SESSION_CB cb = def_generate_session_id;
 279
 280         if ((ss=SSL_SESSION_new()) == NULL) return(0);
 281
 282         /* If the context has a default timeout, use it */
 283         if (s->session_ctx->session_timeout == 0)
 284                 ss->timeout=SSL_get_default_timeout(s);
 285         else
 286                 ss->timeout=s->session_ctx->session_timeout;
 287
 288         if (s->session != NULL)
 289                 {
 290                 SSL_SESSION_free(s->session);
 291                 s->session=NULL;
 292                 }
 293
 294         if (session)
 295                 {
 296                 if (s->version == SSL2_VERSION)
 297                         {
 298                         ss->ssl_version=SSL2_VERSION;
 299                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
 300                         }
 301                 else if (s->version == SSL3_VERSION)
 302                         {
 303                         ss->ssl_version=SSL3_VERSION;
 304                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 305                         }
 306                 else if (s->version == TLS1_VERSION)
 307                         {
 308                         ss->ssl_version=TLS1_VERSION;
 309                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 310                         }
 311                 else if (s->version == TLS1_1_VERSION)
 312                         {
 313                         ss->ssl_version=TLS1_1_VERSION;
 314                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 315                         }
 316                 else if (s->version == TLS1_2_VERSION)
 317                         {
 318                         ss->ssl_version=TLS1_2_VERSION;
 319                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 320                         }
 321                 else if (s->version == DTLS1_BAD_VER)
 322                         {
 323                         ss->ssl_version=DTLS1_BAD_VER;
 324                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 325                         }
 326                 else if (s->version == DTLS1_VERSION)
 327                         {
 328                         ss->ssl_version=DTLS1_VERSION;
 329                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
 330                         }
 331                 else
 332                         {
 333                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
 334                         SSL_SESSION_free(ss);
 335                         return(0);
 336                         }
 337 #ifndef OPENSSL_NO_TLSEXT
 338                 /* If RFC4507 ticket use empty session ID */
 339                 if (s->tlsext_ticket_expected)
 340                         {
 341                         ss->session_id_length = 0;
 342                         goto sess_id_done;
 343                         }
 344 #endif
 345                 /* Choose which callback will set the session ID */
 346                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 347                 if(s->generate_session_id)
 348                         cb = s->generate_session_id;
 349                 else if(s->session_ctx->generate_session_id)
 350                         cb = s->session_ctx->generate_session_id;
 351                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 352                 /* Choose a session ID */
 353                 tmp = ss->session_id_length;
 354                 if(!cb(s, ss->session_id, &tmp))
 355                         {
 356                         /* The callback failed */
 357                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 358                                 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
 359                         SSL_SESSION_free(ss);
 360                         return(0);
 361                         }
 362                 /* Don't allow the callback to set the session length to zero.
 363                  * nor set it higher than it was. */
 364                 if(!tmp || (tmp > ss->session_id_length))
 365                         {
 366                         /* The callback set an illegal length */
 367                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 368                                 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
 369                         SSL_SESSION_free(ss);
 370                         return(0);
 371                         }
 372                 /* If the session length was shrunk and we're SSLv2, pad it */
 373                 if((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
 374                         memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
 375                 else
 376                         ss->session_id_length = tmp;
 377                 /* Finally, check for a conflict */
 378                 if(SSL_has_matching_session_id(s, ss->session_id,
 379                                                 ss->session_id_length))
 380                         {
 381                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 382                                 SSL_R_SSL_SESSION_ID_CONFLICT);
 383                         SSL_SESSION_free(ss);
 384                         return(0);
 385                         }
 386 #ifndef OPENSSL_NO_TLSEXT
 387                 sess_id_done:
 388                 if (s->tlsext_hostname) {
 389                         ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
 390                         if (ss->tlsext_hostname == NULL) {
 391                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 392                                 SSL_SESSION_free(ss);
 393                                 return 0;
 394                                 }
 395                         }
 396 #endif
 397                 }
 398         else
 399                 {
 400                 ss->session_id_length=0;
 401                 }
 402
 403         if (s->sid_ctx_length > sizeof ss->sid_ctx)
 404                 {
 405                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 406                 SSL_SESSION_free(ss);
 407                 return 0;
 408                 }
 409         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
 410         ss->sid_ctx_length=s->sid_ctx_length;
 411         s->session=ss;
 412         ss->ssl_version=s->version;
 413         ss->verify_result = X509_V_OK;
 414
 415         return(1);
 416         }
 417
 418 /* ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
 419  * connection. It is only called by servers.
 420  *
 421  *   session_id: points at the session ID in the ClientHello. This code will
 422  *       read past the end of this in order to parse out the session ticket
 423  *       extension, if any.
 424  *   len: the length of the session ID.
 425  *   limit: a pointer to the first byte after the ClientHello.
 426  *
 427  * Returns:
 428  *   -1: error
 429  *    0: a session may have been found.
 430  *
 431  * Side effects:
 432  *   - If a session is found then s->session is pointed at it (after freeing an
 433  *     existing session if need be) and s->verify_result is set from the session.
 434  *   - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
 435  *     if the server should issue a new session ticket (to 0 otherwise).
 436  */
 437 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
 438                         const unsigned char *limit)
 439         {
 440         /* This is used only by servers. */
 441
 442         SSL_SESSION *ret=NULL;
 443         int fatal = 0;
 444         int try_session_cache = 1;
 445 #ifndef OPENSSL_NO_TLSEXT
 446         int r;
 447 #endif
 448
 449         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
 450                 goto err;
 451
 452         if (len == 0)
 453                 try_session_cache = 0;
 454
 455 #ifndef OPENSSL_NO_TLSEXT
 456         r = tls1_process_ticket(s, session_id, len, limit, &ret); /* sets s->tlsext_ticket_expected */
 457         switch (r)
 458                 {
 459         case -1: /* Error during processing */
 460                 fatal = 1;
 461                 goto err;
 462         case 0: /* No ticket found */
 463         case 1: /* Zero length ticket found */
 464                 break; /* Ok to carry on processing session id. */
 465         case 2: /* Ticket found but not decrypted. */
 466         case 3: /* Ticket decrypted, *ret has been set. */
 467                 try_session_cache = 0;
 468                 break;
 469         default:
 470                 abort();
 471                 }
 472 #endif
 473
 474         if (try_session_cache &&
 475             ret == NULL &&
 476             !(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 477                 {
 478                 SSL_SESSION data;
 479                 data.ssl_version=s->version;
 480                 data.session_id_length=len;
 481                 if (len == 0)
 482                         return 0;
 483                 memcpy(data.session_id,session_id,len);
 484                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 485                 ret=lh_SSL_SESSION_retrieve(s->session_ctx->sessions,&data);
 486                 if (ret != NULL)
 487                         {
 488                         /* don't allow other threads to steal it: */
 489                         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 490                         }
 491                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 492                 if (ret == NULL)
 493                         s->session_ctx->stats.sess_miss++;
 494                 }
 495
 496         if (try_session_cache &&
 497             ret == NULL &&
 498             s->session_ctx->get_session_cb != NULL)
 499                 {
 500                 int copy=1;
 501
 502                 if ((ret=s->session_ctx->get_session_cb(s,session_id,len,&copy)))
 503                         {
 504                         s->session_ctx->stats.sess_cb_hit++;
 505
 506                         /* Increment reference count now if the session callback
 507                          * asks us to do so (note that if the session structures
 508                          * returned by the callback are shared between threads,
 509                          * it must handle the reference count itself [i.e. copy == 0],
 510                          * or things won't be thread-safe). */
 511                         if (copy)
 512                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 513
 514                         /* Add the externally cached session to the internal
 515                          * cache as well if and only if we are supposed to. */
 516                         if(!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
 517                                 /* The following should not return 1, otherwise,
 518                                  * things are very strange */
 519                                 SSL_CTX_add_session(s->session_ctx,ret);
 520                         }
 521                 }
 522
 523         if (ret == NULL)
 524                 goto err;
 525
 526         /* Now ret is non-NULL and we own one of its reference counts. */
 527
 528         if (ret->sid_ctx_length != s->sid_ctx_length
 529             || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length))
 530                 {
 531                 /* We have the session requested by the client, but we don't
 532                  * want to use it in this context. */
 533                 goto err; /* treat like cache miss */
 534                 }
 535
 536         if((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0)
 537                 {
 538                 /* We can't be sure if this session is being used out of
 539                  * context, which is especially important for SSL_VERIFY_PEER.
 540                  * The application should have used SSL[_CTX]_set_session_id_context.
 541                  *
 542                  * For this error case, we generate an error instead of treating
 543                  * the event like a cache miss (otherwise it would be easy for
 544                  * applications to effectively disable the session cache by
 545                  * accident without anyone noticing).
 546                  */
 547
 548                 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 549                 fatal = 1;
 550                 goto err;
 551                 }
 552
 553         if (ret->cipher == NULL)
 554                 {
 555                 unsigned char buf[5],*p;
 556                 unsigned long l;
 557
 558                 p=buf;
 559                 l=ret->cipher_id;
 560                 l2n(l,p);
 561                 if ((ret->ssl_version>>8) >= SSL3_VERSION_MAJOR)
 562                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
 563                 else
 564                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
 565                 if (ret->cipher == NULL)
 566                         goto err;
 567                 }
 568
 569         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
 570                 {
 571                 s->session_ctx->stats.sess_timeout++;
 572                 if (try_session_cache)
 573                         {
 574                         /* session was from the cache, so remove it */
 575                         SSL_CTX_remove_session(s->session_ctx,ret);
 576                         }
 577                 goto err;
 578                 }
 579
 580         s->session_ctx->stats.sess_hit++;
 581
 582         if (s->session != NULL)
 583                 SSL_SESSION_free(s->session);
 584         s->session=ret;
 585         s->verify_result = s->session->verify_result;
 586         return 1;
 587
 588  err:
 589         if (ret != NULL)
 590                 {
 591                 SSL_SESSION_free(ret);
 592                 if (!try_session_cache)
 593                         {
 594                         /* The session was from a ticket, so we should
 595                          * issue a ticket for the new session */
 596                         s->tlsext_ticket_expected = 1;
 597                         }
 598                 }
 599         if (fatal)
 600                 return -1;
 601         else
 602                 return 0;
 603         }
 604
 605 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 606         {
 607         int ret=0;
 608         SSL_SESSION *s;
 609
 610         /* add just 1 reference count for the SSL_CTX's session cache
 611          * even though it has two ways of access: each session is in a
 612          * doubly linked list and an lhash */
 613         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
 614         /* if session c is in already in cache, we take back the increment later */
 615
 616         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 617         s=lh_SSL_SESSION_insert(ctx->sessions,c);
 618
 619         /* s != NULL iff we already had a session with the given PID.
 620          * In this case, s == c should hold (then we did not really modify
 621          * ctx->sessions), or we're in trouble. */
 622         if (s != NULL && s != c)
 623                 {
 624                 /* We *are* in trouble ... */
 625                 SSL_SESSION_list_remove(ctx,s);
 626                 SSL_SESSION_free(s);
 627                 /* ... so pretend the other session did not exist in cache
 628                  * (we cannot handle two SSL_SESSION structures with identical
 629                  * session ID in the same cache, which could happen e.g. when
 630                  * two threads concurrently obtain the same session from an external
 631                  * cache) */
 632                 s = NULL;
 633                 }
 634
 635         /* Put at the head of the queue unless it is already in the cache */
 636         if (s == NULL)
 637                 SSL_SESSION_list_add(ctx,c);
 638
 639         if (s != NULL)
 640                 {
 641                 /* existing cache entry -- decrement previously incremented reference
 642                  * count because it already takes into account the cache */
 643
 644                 SSL_SESSION_free(s); /* s == c */
 645                 ret=0;
 646                 }
 647         else
 648                 {
 649                 /* new cache entry -- remove old ones if cache has become too large */
 650
 651                 ret=1;
 652
 653                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
 654                         {
 655                         while (SSL_CTX_sess_number(ctx) >
 656                                 SSL_CTX_sess_get_cache_size(ctx))
 657                                 {
 658                                 if (!remove_session_lock(ctx,
 659                                         ctx->session_cache_tail, 0))
 660                                         break;
 661                                 else
 662                                         ctx->stats.sess_cache_full++;
 663                                 }
 664                         }
 665                 }
 666         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 667         return(ret);
 668         }
 669
 670 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 671 {
 672         return remove_session_lock(ctx, c, 1);
 673 }
 674
 675 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 676         {
 677         SSL_SESSION *r;
 678         int ret=0;
 679
 680         if ((c != NULL) && (c->session_id_length != 0))
 681                 {
 682                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 683                 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions,c)) == c)
 684                         {
 685                         ret=1;
 686                         r=lh_SSL_SESSION_delete(ctx->sessions,c);
 687                         SSL_SESSION_list_remove(ctx,c);
 688                         }
 689
 690                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 691
 692                 if (ret)
 693                         {
 694                         r->not_resumable=1;
 695                         if (ctx->remove_session_cb != NULL)
 696                                 ctx->remove_session_cb(ctx,r);
 697                         SSL_SESSION_free(r);
 698                         }
 699                 }
 700         else
 701                 ret=0;
 702         return(ret);
 703         }
 704
 705 void SSL_SESSION_free(SSL_SESSION *ss)
 706         {
 707         int i;
 708
 709         if(ss == NULL)
 710             return;
 711
 712         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
 713 #ifdef REF_PRINT
 714         REF_PRINT("SSL_SESSION",ss);
 715 #endif
 716         if (i > 0) return;
 717 #ifdef REF_CHECK
 718         if (i < 0)
 719                 {
 720                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
 721                 abort(); /* ok */
 722                 }
 723 #endif
 724
 725         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 726
 727         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
 728         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
 729         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
 730         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
 731         if (ss->peer != NULL) X509_free(ss->peer);
 732         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
 733 #ifndef OPENSSL_NO_TLSEXT
 734         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
 735         if (ss->tlsext_tick != NULL) OPENSSL_free(ss->tlsext_tick);
 736 #ifndef OPENSSL_NO_EC
 737         ss->tlsext_ecpointformatlist_length = 0;
 738         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
 739         ss->tlsext_ellipticcurvelist_length = 0;
 740         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
 741 #endif /* OPENSSL_NO_EC */
 742 #endif
 743 #ifndef OPENSSL_NO_PSK
 744         if (ss->psk_identity_hint != NULL)
 745                 OPENSSL_free(ss->psk_identity_hint);
 746         if (ss->psk_identity != NULL)
 747                 OPENSSL_free(ss->psk_identity);
 748 #endif
 749 #ifndef OPENSSL_NO_SRP
 750         if (ss->srp_username != NULL)
 751                 OPENSSL_free(ss->srp_username);
 752 #endif
 753         OPENSSL_cleanse(ss,sizeof(*ss));
 754         OPENSSL_free(ss);
 755         }
 756
 757 int SSL_set_session(SSL *s, SSL_SESSION *session)
 758         {
 759         int ret=0;
 760         const SSL_METHOD *meth;
 761
 762         if (session != NULL)
 763                 {
 764                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
 765                 if (meth == NULL)
 766                         meth=s->method->get_ssl_method(session->ssl_version);
 767                 if (meth == NULL)
 768                         {
 769                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
 770                         return(0);
 771                         }
 772
 773                 if (meth != s->method)
 774                         {
 775                         if (!SSL_set_ssl_method(s,meth))
 776                                 return(0);
 777                         }
 778
 779 #ifndef OPENSSL_NO_KRB5
 780                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
 781                     session->krb5_client_princ_len > 0)
 782                 {
 783                     s->kssl_ctx->client_princ = (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
 784                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
 785                             session->krb5_client_princ_len);
 786                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
 787                 }
 788 #endif /* OPENSSL_NO_KRB5 */
 789
 790                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
 791                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
 792                 if (s->session != NULL)
 793                         SSL_SESSION_free(s->session);
 794                 s->session=session;
 795                 s->verify_result = s->session->verify_result;
 796                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
 797                 ret=1;
 798                 }
 799         else
 800                 {
 801                 if (s->session != NULL)
 802                         {
 803                         SSL_SESSION_free(s->session);
 804                         s->session=NULL;
 805                         }
 806
 807                 meth=s->ctx->method;
 808                 if (meth != s->method)
 809                         {
 810                         if (!SSL_set_ssl_method(s,meth))
 811                                 return(0);
 812                         }
 813                 ret=1;
 814                 }
 815         return(ret);
 816         }
 817
 818 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 819         {
 820         if (s == NULL) return(0);
 821         s->timeout=t;
 822         return(1);
 823         }
 824
 825 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 826         {
 827         if (s == NULL) return(0);
 828         return(s->timeout);
 829         }
 830
 831 long SSL_SESSION_get_time(const SSL_SESSION *s)
 832         {
 833         if (s == NULL) return(0);
 834         return(s->time);
 835         }
 836
 837 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 838         {
 839         if (s == NULL) return(0);
 840         s->time=t;
 841         return(t);
 842         }
 843
 844 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
 845         {
 846         return s->peer;
 847         }
 848
 849 int SSL_SESSION_set1_id_context(SSL_SESSION *s,const unsigned char *sid_ctx,
 850                                unsigned int sid_ctx_len)
 851         {
 852         if(sid_ctx_len > SSL_MAX_SID_CTX_LENGTH)
 853                 {
 854                 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
 855                 return 0;
 856                 }
 857         s->sid_ctx_length=sid_ctx_len;
 858         memcpy(s->sid_ctx,sid_ctx,sid_ctx_len);
 859
 860         return 1;
 861         }
 862
 863 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 864         {
 865         long l;
 866         if (s == NULL) return(0);
 867         l=s->session_timeout;
 868         s->session_timeout=t;
 869         return(l);
 870         }
 871
 872 long SSL_CTX_get_timeout(const SSL_CTX *s)
 873         {
 874         if (s == NULL) return(0);
 875         return(s->session_timeout);
 876         }
 877
 878 #ifndef OPENSSL_NO_TLSEXT
 879 int SSL_set_session_secret_cb(SSL *s, int (*tls_session_secret_cb)(SSL *s, void *secret, int *secret_len,
 880         STACK_OF(SSL_CIPHER) *peer_ciphers, SSL_CIPHER **cipher, void *arg), void *arg)
 881         {
 882         if (s == NULL) return(0);
 883         s->tls_session_secret_cb = tls_session_secret_cb;
 884         s->tls_session_secret_cb_arg = arg;
 885         return(1);
 886         }
 887
 888 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
 889                                   void *arg)
 890         {
 891         if (s == NULL) return(0);
 892         s->tls_session_ticket_ext_cb = cb;
 893         s->tls_session_ticket_ext_cb_arg = arg;
 894         return(1);
 895         }
 896
 897 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
 898         {
 899         if (s->version >= TLS1_VERSION)
 900                 {
 901                 if (s->tlsext_session_ticket)
 902                         {
 903                         OPENSSL_free(s->tlsext_session_ticket);
 904                         s->tlsext_session_ticket = NULL;
 905                         }
 906
 907                 s->tlsext_session_ticket = OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
 908                 if (!s->tlsext_session_ticket)
 909                         {
 910                         SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
 911                         return 0;
 912                         }
 913
 914                 if (ext_data)
 915                         {
 916                         s->tlsext_session_ticket->length = ext_len;
 917                         s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
 918                         memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
 919                         }
 920                 else
 921                         {
 922                         s->tlsext_session_ticket->length = 0;
 923                         s->tlsext_session_ticket->data = NULL;
 924                         }
 925
 926                 return 1;
 927                 }
 928
 929         return 0;
 930         }
 931 #endif /* OPENSSL_NO_TLSEXT */
 932
 933 typedef struct timeout_param_st
 934         {
 935         SSL_CTX *ctx;
 936         long time;
 937         LHASH_OF(SSL_SESSION) *cache;
 938         } TIMEOUT_PARAM;
 939
 940 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
 941         {
 942         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
 943                 {
 944                 /* The reason we don't call SSL_CTX_remove_session() is to
 945                  * save on locking overhead */
 946                 (void)lh_SSL_SESSION_delete(p->cache,s);
 947                 SSL_SESSION_list_remove(p->ctx,s);
 948                 s->not_resumable=1;
 949                 if (p->ctx->remove_session_cb != NULL)
 950                         p->ctx->remove_session_cb(p->ctx,s);
 951                 SSL_SESSION_free(s);
 952                 }
 953         }
 954
 955 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
 956
 957 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 958         {
 959         unsigned long i;
 960         TIMEOUT_PARAM tp;
 961
 962         tp.ctx=s;
 963         tp.cache=s->sessions;
 964         if (tp.cache == NULL) return;
 965         tp.time=t;
 966         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 967         i=CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
 968         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=0;
 969         lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
 970                                  TIMEOUT_PARAM, &tp);
 971         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=i;
 972         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 973         }
 974
 975 int ssl_clear_bad_session(SSL *s)
 976         {
 977         if (    (s->session != NULL) &&
 978                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
 979                 !(SSL_in_init(s) || SSL_in_before(s)))
 980                 {
 981                 SSL_CTX_remove_session(s->ctx,s->session);
 982                 return(1);
 983                 }
 984         else
 985                 return(0);
 986         }
 987
 988 /* locked by SSL_CTX in the calling function */
 989 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
 990         {
 991         if ((s->next == NULL) || (s->prev == NULL)) return;
 992
 993         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
 994                 { /* last element in list */
 995                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
 996                         { /* only one element in list */
 997                         ctx->session_cache_head=NULL;
 998                         ctx->session_cache_tail=NULL;
 999                         }
1000                 else
1001                         {
1002                         ctx->session_cache_tail=s->prev;
1003                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
1004                         }
1005                 }
1006         else
1007                 {
1008                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
1009                         { /* first element in list */
1010                         ctx->session_cache_head=s->next;
1011                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1012                         }
1013                 else
1014                         { /* middle of list */
1015                         s->next->prev=s->prev;
1016                         s->prev->next=s->next;
1017                         }
1018                 }
1019         s->prev=s->next=NULL;
1020         }
1021
1022 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1023         {
1024         if ((s->next != NULL) && (s->prev != NULL))
1025                 SSL_SESSION_list_remove(ctx,s);
1026
1027         if (ctx->session_cache_head == NULL)
1028                 {
1029                 ctx->session_cache_head=s;
1030                 ctx->session_cache_tail=s;
1031                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1032                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
1033                 }
1034         else
1035                 {
1036                 s->next=ctx->session_cache_head;
1037                 s->next->prev=s;
1038                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1039                 ctx->session_cache_head=s;
1040                 }
1041         }
1042
1043 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1044         int (*cb)(struct ssl_st *ssl,SSL_SESSION *sess))
1045         {
1046         ctx->new_session_cb=cb;
1047         }
1048
1049 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl, SSL_SESSION *sess)
1050         {
1051         return ctx->new_session_cb;
1052         }
1053
1054 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1055         void (*cb)(SSL_CTX *ctx,SSL_SESSION *sess))
1056         {
1057         ctx->remove_session_cb=cb;
1058         }
1059
1060 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(SSL_CTX * ctx,SSL_SESSION *sess)
1061         {
1062         return ctx->remove_session_cb;
1063         }
1064
1065 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1066         SSL_SESSION *(*cb)(struct ssl_st *ssl,
1067                  unsigned char *data,int len,int *copy))
1068         {
1069         ctx->get_session_cb=cb;
1070         }
1071
1072 SSL_SESSION * (*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl,
1073                  unsigned char *data,int len,int *copy)
1074         {
1075         return ctx->get_session_cb;
1076         }
1077
1078 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1079         void (*cb)(const SSL *ssl,int type,int val))
1080         {
1081         ctx->info_callback=cb;
1082         }
1083
1084 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,int type,int val)
1085         {
1086         return ctx->info_callback;
1087         }
1088
1089 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1090         int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey))
1091         {
1092         ctx->client_cert_cb=cb;
1093         }
1094
1095 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL * ssl, X509 ** x509 , EVP_PKEY **pkey)
1096         {
1097         return ctx->client_cert_cb;
1098         }
1099
1100 #ifndef OPENSSL_NO_ENGINE
1101 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1102         {
1103         if (!ENGINE_init(e))
1104                 {
1105                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1106                 return 0;
1107                 }
1108         if(!ENGINE_get_ssl_client_cert_function(e))
1109                 {
1110                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, SSL_R_NO_CLIENT_CERT_METHOD);
1111                 ENGINE_finish(e);
1112                 return 0;
1113                 }
1114         ctx->client_cert_engine = e;
1115         return 1;
1116         }
1117 #endif
1118
1119 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1120         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int *cookie_len))
1121         {
1122         ctx->app_gen_cookie_cb=cb;
1123         }
1124
1125 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1126         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int cookie_len))
1127         {
1128         ctx->app_verify_cookie_cb=cb;
1129         }
1130
1131 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)