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