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 (ret->sid_ctx_length != s->sid_ctx_length
 466             || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length))
 467                 {
 468                 /* We've found the session named by the client, but we don't
 469                  * want to use it in this context. */
 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         if((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0)
 480                 {
 481                 /* We can't be sure if this session is being used out of
 482                  * context, which is especially important for SSL_VERIFY_PEER.
 483                  * The application should have used SSL[_CTX]_set_session_id_context.
 484                  *
 485                  * For this error case, we generate an error instead of treating
 486                  * the event like a cache miss (otherwise it would be easy for
 487                  * applications to effectively disable the session cache by
 488                  * accident without anyone noticing).
 489                  */
 490
 491                 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 492                 fatal = 1;
 493                 goto err;
 494                 }
 495
 496         if (ret->cipher == NULL)
 497                 {
 498                 unsigned char buf[5],*p;
 499                 unsigned long l;
 500
 501                 p=buf;
 502                 l=ret->cipher_id;
 503                 l2n(l,p);
 504                 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
 505                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
 506                 else
 507                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
 508                 if (ret->cipher == NULL)
 509                         goto err;
 510                 }
 511
 512
 513 #if 0 /* This is way too late. */
 514
 515         /* If a thread got the session, then 'swaped', and another got
 516          * it and then due to a time-out decided to 'OPENSSL_free' it we could
 517          * be in trouble.  So I'll increment it now, then double decrement
 518          * later - am I speaking rubbish?. */
 519         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
 520 #endif
 521
 522         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
 523                 {
 524                 s->session_ctx->stats.sess_timeout++;
 525                 /* remove it from the cache */
 526                 SSL_CTX_remove_session(s->session_ctx,ret);
 527                 goto err;
 528                 }
 529
 530         s->session_ctx->stats.sess_hit++;
 531
 532         /* ret->time=time(NULL); */ /* rezero timeout? */
 533         /* again, just leave the session
 534          * if it is the same session, we have just incremented and
 535          * then decremented the reference count :-) */
 536         if (s->session != NULL)
 537                 SSL_SESSION_free(s->session);
 538         s->session=ret;
 539         s->verify_result = s->session->verify_result;
 540         return(1);
 541
 542  err:
 543         if (ret != NULL)
 544                 SSL_SESSION_free(ret);
 545         if (fatal)
 546                 return -1;
 547         else
 548                 return 0;
 549         }
 550
 551 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 552         {
 553         int ret=0;
 554         SSL_SESSION *s;
 555
 556         /* add just 1 reference count for the SSL_CTX's session cache
 557          * even though it has two ways of access: each session is in a
 558          * doubly linked list and an lhash */
 559         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
 560         /* if session c is in already in cache, we take back the increment later */
 561
 562         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 563         s=(SSL_SESSION *)lh_insert(ctx->sessions,c);
 564
 565         /* s != NULL iff we already had a session with the given PID.
 566          * In this case, s == c should hold (then we did not really modify
 567          * ctx->sessions), or we're in trouble. */
 568         if (s != NULL && s != c)
 569                 {
 570                 /* We *are* in trouble ... */
 571                 SSL_SESSION_list_remove(ctx,s);
 572                 SSL_SESSION_free(s);
 573                 /* ... so pretend the other session did not exist in cache
 574                  * (we cannot handle two SSL_SESSION structures with identical
 575                  * session ID in the same cache, which could happen e.g. when
 576                  * two threads concurrently obtain the same session from an external
 577                  * cache) */
 578                 s = NULL;
 579                 }
 580
 581         /* Put at the head of the queue unless it is already in the cache */
 582         if (s == NULL)
 583                 SSL_SESSION_list_add(ctx,c);
 584
 585         if (s != NULL)
 586                 {
 587                 /* existing cache entry -- decrement previously incremented reference
 588                  * count because it already takes into account the cache */
 589
 590                 SSL_SESSION_free(s); /* s == c */
 591                 ret=0;
 592                 }
 593         else
 594                 {
 595                 /* new cache entry -- remove old ones if cache has become too large */
 596
 597                 ret=1;
 598
 599                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
 600                         {
 601                         while (SSL_CTX_sess_number(ctx) >
 602                                 SSL_CTX_sess_get_cache_size(ctx))
 603                                 {
 604                                 if (!remove_session_lock(ctx,
 605                                         ctx->session_cache_tail, 0))
 606                                         break;
 607                                 else
 608                                         ctx->stats.sess_cache_full++;
 609                                 }
 610                         }
 611                 }
 612         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 613         return(ret);
 614         }
 615
 616 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 617 {
 618         return remove_session_lock(ctx, c, 1);
 619 }
 620
 621 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 622         {
 623         SSL_SESSION *r;
 624         int ret=0;
 625
 626         if ((c != NULL) && (c->session_id_length != 0))
 627                 {
 628                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 629                 if ((r = (SSL_SESSION *)lh_retrieve(ctx->sessions,c)) == c)
 630                         {
 631                         ret=1;
 632                         r=(SSL_SESSION *)lh_delete(ctx->sessions,c);
 633                         SSL_SESSION_list_remove(ctx,c);
 634                         }
 635
 636                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 637
 638                 if (ret)
 639                         {
 640                         r->not_resumable=1;
 641                         if (ctx->remove_session_cb != NULL)
 642                                 ctx->remove_session_cb(ctx,r);
 643                         SSL_SESSION_free(r);
 644                         }
 645                 }
 646         else
 647                 ret=0;
 648         return(ret);
 649         }
 650
 651 void SSL_SESSION_free(SSL_SESSION *ss)
 652         {
 653         int i;
 654
 655         if(ss == NULL)
 656             return;
 657
 658         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
 659 #ifdef REF_PRINT
 660         REF_PRINT("SSL_SESSION",ss);
 661 #endif
 662         if (i > 0) return;
 663 #ifdef REF_CHECK
 664         if (i < 0)
 665                 {
 666                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
 667                 abort(); /* ok */
 668                 }
 669 #endif
 670
 671         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 672
 673         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
 674         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
 675         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
 676         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
 677         if (ss->peer != NULL) X509_free(ss->peer);
 678         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
 679 #ifndef OPENSSL_NO_TLSEXT
 680         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
 681 #ifndef OPENSSL_NO_EC
 682         ss->tlsext_ecpointformatlist_length = 0;
 683         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
 684         ss->tlsext_ellipticcurvelist_length = 0;
 685         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
 686 #endif /* OPENSSL_NO_EC */
 687 #endif
 688 #ifndef OPENSSL_NO_PSK
 689         if (ss->psk_identity_hint != NULL)
 690                 OPENSSL_free(ss->psk_identity_hint);
 691         if (ss->psk_identity != NULL)
 692                 OPENSSL_free(ss->psk_identity);
 693 #endif
 694         OPENSSL_cleanse(ss,sizeof(*ss));
 695         OPENSSL_free(ss);
 696         }
 697
 698 int SSL_set_session(SSL *s, SSL_SESSION *session)
 699         {
 700         int ret=0;
 701         const SSL_METHOD *meth;
 702
 703         if (session != NULL)
 704                 {
 705                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
 706                 if (meth == NULL)
 707                         meth=s->method->get_ssl_method(session->ssl_version);
 708                 if (meth == NULL)
 709                         {
 710                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
 711                         return(0);
 712                         }
 713
 714                 if (meth != s->method)
 715                         {
 716                         if (!SSL_set_ssl_method(s,meth))
 717                                 return(0);
 718                         if (s->ctx->session_timeout == 0)
 719                                 session->timeout=SSL_get_default_timeout(s);
 720                         else
 721                                 session->timeout=s->ctx->session_timeout;
 722                         }
 723
 724 #ifndef OPENSSL_NO_KRB5
 725                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
 726                     session->krb5_client_princ_len > 0)
 727                 {
 728                     s->kssl_ctx->client_princ = (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
 729                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
 730                             session->krb5_client_princ_len);
 731                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
 732                 }
 733 #endif /* OPENSSL_NO_KRB5 */
 734
 735                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
 736                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
 737                 if (s->session != NULL)
 738                         SSL_SESSION_free(s->session);
 739                 s->session=session;
 740                 s->verify_result = s->session->verify_result;
 741                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
 742                 ret=1;
 743                 }
 744         else
 745                 {
 746                 if (s->session != NULL)
 747                         {
 748                         SSL_SESSION_free(s->session);
 749                         s->session=NULL;
 750                         }
 751
 752                 meth=s->ctx->method;
 753                 if (meth != s->method)
 754                         {
 755                         if (!SSL_set_ssl_method(s,meth))
 756                                 return(0);
 757                         }
 758                 ret=1;
 759                 }
 760         return(ret);
 761         }
 762
 763 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 764         {
 765         if (s == NULL) return(0);
 766         s->timeout=t;
 767         return(1);
 768         }
 769
 770 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 771         {
 772         if (s == NULL) return(0);
 773         return(s->timeout);
 774         }
 775
 776 long SSL_SESSION_get_time(const SSL_SESSION *s)
 777         {
 778         if (s == NULL) return(0);
 779         return(s->time);
 780         }
 781
 782 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 783         {
 784         if (s == NULL) return(0);
 785         s->time=t;
 786         return(t);
 787         }
 788
 789 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 790         {
 791         long l;
 792         if (s == NULL) return(0);
 793         l=s->session_timeout;
 794         s->session_timeout=t;
 795         return(l);
 796         }
 797
 798 long SSL_CTX_get_timeout(const SSL_CTX *s)
 799         {
 800         if (s == NULL) return(0);
 801         return(s->session_timeout);
 802         }
 803
 804 typedef struct timeout_param_st
 805         {
 806         SSL_CTX *ctx;
 807         long time;
 808         LHASH *cache;
 809         } TIMEOUT_PARAM;
 810
 811 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
 812         {
 813         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
 814                 {
 815                 /* The reason we don't call SSL_CTX_remove_session() is to
 816                  * save on locking overhead */
 817                 lh_delete(p->cache,s);
 818                 SSL_SESSION_list_remove(p->ctx,s);
 819                 s->not_resumable=1;
 820                 if (p->ctx->remove_session_cb != NULL)
 821                         p->ctx->remove_session_cb(p->ctx,s);
 822                 SSL_SESSION_free(s);
 823                 }
 824         }
 825
 826 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION *, TIMEOUT_PARAM *)
 827
 828 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 829         {
 830         unsigned long i;
 831         TIMEOUT_PARAM tp;
 832
 833         tp.ctx=s;
 834         tp.cache=s->sessions;
 835         if (tp.cache == NULL) return;
 836         tp.time=t;
 837         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 838         i=tp.cache->down_load;
 839         tp.cache->down_load=0;
 840         lh_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout), &tp);
 841         tp.cache->down_load=i;
 842         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 843         }
 844
 845 int ssl_clear_bad_session(SSL *s)
 846         {
 847         if (    (s->session != NULL) &&
 848                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
 849                 !(SSL_in_init(s) || SSL_in_before(s)))
 850                 {
 851                 SSL_CTX_remove_session(s->ctx,s->session);
 852                 return(1);
 853                 }
 854         else
 855                 return(0);
 856         }
 857
 858 /* locked by SSL_CTX in the calling function */
 859 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
 860         {
 861         if ((s->next == NULL) || (s->prev == NULL)) return;
 862
 863         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
 864                 { /* last element in list */
 865                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
 866                         { /* only one element in list */
 867                         ctx->session_cache_head=NULL;
 868                         ctx->session_cache_tail=NULL;
 869                         }
 870                 else
 871                         {
 872                         ctx->session_cache_tail=s->prev;
 873                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
 874                         }
 875                 }
 876         else
 877                 {
 878                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
 879                         { /* first element in list */
 880                         ctx->session_cache_head=s->next;
 881                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 882                         }
 883                 else
 884                         { /* middle of list */
 885                         s->next->prev=s->prev;
 886                         s->prev->next=s->next;
 887                         }
 888                 }
 889         s->prev=s->next=NULL;
 890         }
 891
 892 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
 893         {
 894         if ((s->next != NULL) && (s->prev != NULL))
 895                 SSL_SESSION_list_remove(ctx,s);
 896
 897         if (ctx->session_cache_head == NULL)
 898                 {
 899                 ctx->session_cache_head=s;
 900                 ctx->session_cache_tail=s;
 901                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 902                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
 903                 }
 904         else
 905                 {
 906                 s->next=ctx->session_cache_head;
 907                 s->next->prev=s;
 908                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
 909                 ctx->session_cache_head=s;
 910                 }
 911         }
 912
 913 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
 914         int (*cb)(struct ssl_st *ssl,SSL_SESSION *sess))
 915         {
 916         ctx->new_session_cb=cb;
 917         }
 918
 919 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl, SSL_SESSION *sess)
 920         {
 921         return ctx->new_session_cb;
 922         }
 923
 924 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
 925         void (*cb)(SSL_CTX *ctx,SSL_SESSION *sess))
 926         {
 927         ctx->remove_session_cb=cb;
 928         }
 929
 930 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(SSL_CTX * ctx,SSL_SESSION *sess)
 931         {
 932         return ctx->remove_session_cb;
 933         }
 934
 935 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
 936         SSL_SESSION *(*cb)(struct ssl_st *ssl,
 937                  unsigned char *data,int len,int *copy))
 938         {
 939         ctx->get_session_cb=cb;
 940         }
 941
 942 SSL_SESSION * (*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl,
 943                  unsigned char *data,int len,int *copy)
 944         {
 945         return ctx->get_session_cb;
 946         }
 947
 948 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
 949         void (*cb)(const SSL *ssl,int type,int val))
 950         {
 951         ctx->info_callback=cb;
 952         }
 953
 954 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,int type,int val)
 955         {
 956         return ctx->info_callback;
 957         }
 958
 959 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
 960         int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey))
 961         {
 962         ctx->client_cert_cb=cb;
 963         }
 964
 965 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL * ssl, X509 ** x509 , EVP_PKEY **pkey)
 966         {
 967         return ctx->client_cert_cb;
 968         }
 969
 970 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
 971         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int *cookie_len))
 972         {
 973         ctx->app_gen_cookie_cb=cb;
 974         }
 975
 976 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
 977         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int cookie_len))
 978         {
 979         ctx->app_verify_cookie_cb=cb;
 980         }
 981
 982 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)