ssl/ssl_sess.c

   1 /*
   2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /* ====================================================================
  11  * Copyright 2005 Nokia. All rights reserved.
  12  *
  13  * The portions of the attached software ("Contribution") is developed by
  14  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
  15  * license.
  16  *
  17  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
  18  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
  19  * support (see RFC 4279) to OpenSSL.
  20  *
  21  * No patent licenses or other rights except those expressly stated in
  22  * the OpenSSL open source license shall be deemed granted or received
  23  * expressly, by implication, estoppel, or otherwise.
  24  *
  25  * No assurances are provided by Nokia that the Contribution does not
  26  * infringe the patent or other intellectual property rights of any third
  27  * party or that the license provides you with all the necessary rights
  28  * to make use of the Contribution.
  29  *
  30  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
  31  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
  32  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
  33  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
  34  * OTHERWISE.
  35  */
  36
  37 #include <stdio.h>
  38 #include <openssl/lhash.h>
  39 #include <openssl/rand.h>
  40 #include <openssl/engine.h>
  41 #include "ssl_locl.h"
  42
  43 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
  44 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
  45 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
  46
  47 SSL_SESSION *SSL_get_session(const SSL *ssl)
  48 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
  49 {
  50     return (ssl->session);
  51 }
  52
  53 SSL_SESSION *SSL_get1_session(SSL *ssl)
  54 /* variant of SSL_get_session: caller really gets something */
  55 {
  56     SSL_SESSION *sess;
  57     /*
  58      * Need to lock this all up rather than just use CRYPTO_add so that
  59      * somebody doesn't free ssl->session between when we check it's non-null
  60      * and when we up the reference count.
  61      */
  62     CRYPTO_THREAD_read_lock(ssl->lock);
  63     sess = ssl->session;
  64     if (sess)
  65         SSL_SESSION_up_ref(sess);
  66     CRYPTO_THREAD_unlock(ssl->lock);
  67     return sess;
  68 }
  69
  70 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
  71 {
  72     return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
  73 }
  74
  75 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
  76 {
  77     return (CRYPTO_get_ex_data(&s->ex_data, idx));
  78 }
  79
  80 SSL_SESSION *SSL_SESSION_new(void)
  81 {
  82     SSL_SESSION *ss;
  83
  84     ss = OPENSSL_zalloc(sizeof(*ss));
  85     if (ss == NULL) {
  86         SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
  87         return NULL;
  88     }
  89
  90     ss->verify_result = 1;      /* avoid 0 (= X509_V_OK) just in case */
  91     ss->references = 1;
  92     ss->timeout = 60 * 5 + 4;   /* 5 minute timeout by default */
  93     ss->time = (unsigned long)time(NULL);
  94     ss->lock = CRYPTO_THREAD_lock_new();
  95     if (ss->lock == NULL) {
  96         SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
  97         OPENSSL_free(ss);
  98         return NULL;
  99     }
 100
 101     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data)) {
 102         CRYPTO_THREAD_lock_free(ss->lock);
 103         OPENSSL_free(ss);
 104         return NULL;
 105     }
 106     return ss;
 107 }
 108
 109 /*
 110  * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
 111  * ticket == 0 then no ticket information is duplicated, otherwise it is.
 112  */
 113 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
 114 {
 115     SSL_SESSION *dest;
 116
 117     dest = OPENSSL_malloc(sizeof(*src));
 118     if (dest == NULL) {
 119         goto err;
 120     }
 121     memcpy(dest, src, sizeof(*dest));
 122
 123     /*
 124      * Set the various pointers to NULL so that we can call SSL_SESSION_free in
 125      * the case of an error whilst halfway through constructing dest
 126      */
 127 #ifndef OPENSSL_NO_PSK
 128     dest->psk_identity_hint = NULL;
 129     dest->psk_identity = NULL;
 130 #endif
 131     dest->ciphers = NULL;
 132     dest->tlsext_hostname = NULL;
 133 #ifndef OPENSSL_NO_EC
 134     dest->tlsext_ecpointformatlist = NULL;
 135     dest->tlsext_ellipticcurvelist = NULL;
 136 #endif
 137     dest->tlsext_tick = NULL;
 138 #ifndef OPENSSL_NO_SRP
 139     dest->srp_username = NULL;
 140 #endif
 141     memset(&dest->ex_data, 0, sizeof(dest->ex_data));
 142
 143     /* We deliberately don't copy the prev and next pointers */
 144     dest->prev = NULL;
 145     dest->next = NULL;
 146
 147     dest->references = 1;
 148
 149     dest->lock = CRYPTO_THREAD_lock_new();
 150     if (dest->lock == NULL)
 151         goto err;
 152
 153     if (src->peer != NULL)
 154         X509_up_ref(src->peer);
 155
 156     if (src->peer_chain != NULL) {
 157         dest->peer_chain = X509_chain_up_ref(src->peer_chain);
 158         if (dest->peer_chain == NULL)
 159             goto err;
 160     }
 161 #ifndef OPENSSL_NO_PSK
 162     if (src->psk_identity_hint) {
 163         dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
 164         if (dest->psk_identity_hint == NULL) {
 165             goto err;
 166         }
 167     }
 168     if (src->psk_identity) {
 169         dest->psk_identity = OPENSSL_strdup(src->psk_identity);
 170         if (dest->psk_identity == NULL) {
 171             goto err;
 172         }
 173     }
 174 #endif
 175
 176     if (src->ciphers != NULL) {
 177         dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
 178         if (dest->ciphers == NULL)
 179             goto err;
 180     }
 181
 182     if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
 183                             &dest->ex_data, &src->ex_data)) {
 184         goto err;
 185     }
 186
 187     if (src->tlsext_hostname) {
 188         dest->tlsext_hostname = OPENSSL_strdup(src->tlsext_hostname);
 189         if (dest->tlsext_hostname == NULL) {
 190             goto err;
 191         }
 192     }
 193 #ifndef OPENSSL_NO_EC
 194     if (src->tlsext_ecpointformatlist) {
 195         dest->tlsext_ecpointformatlist =
 196             OPENSSL_memdup(src->tlsext_ecpointformatlist,
 197                            src->tlsext_ecpointformatlist_length);
 198         if (dest->tlsext_ecpointformatlist == NULL)
 199             goto err;
 200     }
 201     if (src->tlsext_ellipticcurvelist) {
 202         dest->tlsext_ellipticcurvelist =
 203             OPENSSL_memdup(src->tlsext_ellipticcurvelist,
 204                            src->tlsext_ellipticcurvelist_length);
 205         if (dest->tlsext_ellipticcurvelist == NULL)
 206             goto err;
 207     }
 208 #endif
 209
 210     if (ticket != 0) {
 211         dest->tlsext_tick =
 212             OPENSSL_memdup(src->tlsext_tick, src->tlsext_ticklen);
 213         if (dest->tlsext_tick == NULL)
 214             goto err;
 215     } else {
 216         dest->tlsext_tick_lifetime_hint = 0;
 217         dest->tlsext_ticklen = 0;
 218     }
 219
 220 #ifndef OPENSSL_NO_SRP
 221     if (src->srp_username) {
 222         dest->srp_username = OPENSSL_strdup(src->srp_username);
 223         if (dest->srp_username == NULL) {
 224             goto err;
 225         }
 226     }
 227 #endif
 228
 229     return dest;
 230  err:
 231     SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
 232     SSL_SESSION_free(dest);
 233     return NULL;
 234 }
 235
 236 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
 237 {
 238     if (len)
 239         *len = (unsigned int)s->session_id_length;
 240     return s->session_id;
 241 }
 242 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
 243                                                 unsigned int *len)
 244 {
 245     if (len != NULL)
 246         *len = (unsigned int)s->sid_ctx_length;
 247     return s->sid_ctx;
 248 }
 249
 250 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
 251 {
 252     return s->compress_meth;
 253 }
 254
 255 /*
 256  * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
 257  * the ID with random junk repeatedly until we have no conflict is going to
 258  * complete in one iteration pretty much "most" of the time (btw:
 259  * understatement). So, if it takes us 10 iterations and we still can't avoid
 260  * a conflict - well that's a reasonable point to call it quits. Either the
 261  * RAND code is broken or someone is trying to open roughly very close to
 262  * 2^256 SSL sessions to our server. How you might store that many sessions
 263  * is perhaps a more interesting question ...
 264  */
 265
 266 #define MAX_SESS_ID_ATTEMPTS 10
 267 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
 268                                    unsigned int *id_len)
 269 {
 270     unsigned int retry = 0;
 271     do
 272         if (RAND_bytes(id, *id_len) <= 0)
 273             return 0;
 274     while (SSL_has_matching_session_id(ssl, id, *id_len) &&
 275            (++retry < MAX_SESS_ID_ATTEMPTS)) ;
 276     if (retry < MAX_SESS_ID_ATTEMPTS)
 277         return 1;
 278     /* else - woops a session_id match */
 279     /*
 280      * XXX We should also check the external cache -- but the probability of
 281      * a collision is negligible, and we could not prevent the concurrent
 282      * creation of sessions with identical IDs since we currently don't have
 283      * means to atomically check whether a session ID already exists and make
 284      * a reservation for it if it does not (this problem applies to the
 285      * internal cache as well).
 286      */
 287     return 0;
 288 }
 289
 290 int ssl_get_new_session(SSL *s, int session)
 291 {
 292     /* This gets used by clients and servers. */
 293
 294     unsigned int tmp;
 295     SSL_SESSION *ss = NULL;
 296     GEN_SESSION_CB cb = def_generate_session_id;
 297
 298     if ((ss = SSL_SESSION_new()) == NULL)
 299         return (0);
 300
 301     /* If the context has a default timeout, use it */
 302     if (s->session_ctx->session_timeout == 0)
 303         ss->timeout = SSL_get_default_timeout(s);
 304     else
 305         ss->timeout = s->session_ctx->session_timeout;
 306
 307     SSL_SESSION_free(s->session);
 308     s->session = NULL;
 309
 310     if (session) {
 311         if (s->version == SSL3_VERSION) {
 312             ss->ssl_version = SSL3_VERSION;
 313             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 314         } else if (s->version == TLS1_VERSION) {
 315             ss->ssl_version = TLS1_VERSION;
 316             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 317         } else if (s->version == TLS1_1_VERSION) {
 318             ss->ssl_version = TLS1_1_VERSION;
 319             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 320         } else if (s->version == TLS1_2_VERSION) {
 321             ss->ssl_version = TLS1_2_VERSION;
 322             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 323         } else if (s->version == TLS1_3_VERSION) {
 324             ss->ssl_version = TLS1_3_VERSION;
 325             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 326         } else if (s->version == DTLS1_BAD_VER) {
 327             ss->ssl_version = DTLS1_BAD_VER;
 328             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 329         } else if (s->version == DTLS1_VERSION) {
 330             ss->ssl_version = DTLS1_VERSION;
 331             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 332         } else if (s->version == DTLS1_2_VERSION) {
 333             ss->ssl_version = DTLS1_2_VERSION;
 334             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 335         } else {
 336             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
 337             SSL_SESSION_free(ss);
 338             return (0);
 339         }
 340
 341         /*-
 342          * If RFC5077 ticket, use empty session ID (as server).
 343          * Note that:
 344          * (a) ssl_get_prev_session() does lookahead into the
 345          *     ClientHello extensions to find the session ticket.
 346          *     When ssl_get_prev_session() fails, statem_srvr.c calls
 347          *     ssl_get_new_session() in tls_process_client_hello().
 348          *     At that point, it has not yet parsed the extensions,
 349          *     however, because of the lookahead, it already knows
 350          *     whether a ticket is expected or not.
 351          *
 352          * (b) statem_clnt.c calls ssl_get_new_session() before parsing
 353          *     ServerHello extensions, and before recording the session
 354          *     ID received from the server, so this block is a noop.
 355          */
 356         if (s->tlsext_ticket_expected) {
 357             ss->session_id_length = 0;
 358             goto sess_id_done;
 359         }
 360
 361         /* Choose which callback will set the session ID */
 362         CRYPTO_THREAD_read_lock(s->lock);
 363         CRYPTO_THREAD_read_lock(s->session_ctx->lock);
 364         if (s->generate_session_id)
 365             cb = s->generate_session_id;
 366         else if (s->session_ctx->generate_session_id)
 367             cb = s->session_ctx->generate_session_id;
 368         CRYPTO_THREAD_unlock(s->session_ctx->lock);
 369         CRYPTO_THREAD_unlock(s->lock);
 370         /* Choose a session ID */
 371         memset(ss->session_id, 0, ss->session_id_length);
 372         tmp = (int)ss->session_id_length;
 373         if (!cb(s, ss->session_id, &tmp)) {
 374             /* The callback failed */
 375             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 376                    SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
 377             SSL_SESSION_free(ss);
 378             return (0);
 379         }
 380         /*
 381          * Don't allow the callback to set the session length to zero. nor
 382          * set it higher than it was.
 383          */
 384         if (tmp == 0 || tmp > ss->session_id_length) {
 385             /* The callback set an illegal length */
 386             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 387                    SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
 388             SSL_SESSION_free(ss);
 389             return (0);
 390         }
 391         ss->session_id_length = tmp;
 392         /* Finally, check for a conflict */
 393         if (SSL_has_matching_session_id(s, ss->session_id,
 394                                         (unsigned int)ss->session_id_length)) {
 395             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
 396             SSL_SESSION_free(ss);
 397             return (0);
 398         }
 399
 400  sess_id_done:
 401         if (s->tlsext_hostname) {
 402             ss->tlsext_hostname = OPENSSL_strdup(s->tlsext_hostname);
 403             if (ss->tlsext_hostname == NULL) {
 404                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 405                 SSL_SESSION_free(ss);
 406                 return 0;
 407             }
 408         }
 409     } else {
 410         ss->session_id_length = 0;
 411     }
 412
 413     if (s->sid_ctx_length > sizeof ss->sid_ctx) {
 414         SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 415         SSL_SESSION_free(ss);
 416         return 0;
 417     }
 418     memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
 419     ss->sid_ctx_length = s->sid_ctx_length;
 420     s->session = ss;
 421     ss->ssl_version = s->version;
 422     ss->verify_result = X509_V_OK;
 423
 424     /* If client supports extended master secret set it in session */
 425     if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)
 426         ss->flags |= SSL_SESS_FLAG_EXTMS;
 427
 428     return (1);
 429 }
 430
 431 /*-
 432  * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
 433  * connection. It is only called by servers.
 434  *
 435  *   ext: ClientHello extensions (including length prefix)
 436  *   session_id: ClientHello session ID.
 437  *
 438  * Returns:
 439  *   -1: error
 440  *    0: a session may have been found.
 441  *
 442  * Side effects:
 443  *   - If a session is found then s->session is pointed at it (after freeing an
 444  *     existing session if need be) and s->verify_result is set from the session.
 445  *   - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
 446  *     if the server should issue a new session ticket (to 0 otherwise).
 447  */
 448 int ssl_get_prev_session(SSL *s, const PACKET *ext, const PACKET *session_id)
 449 {
 450     /* This is used only by servers. */
 451
 452     SSL_SESSION *ret = NULL;
 453     int fatal = 0;
 454     int try_session_cache = 1;
 455     int r;
 456
 457     if (PACKET_remaining(session_id) == 0)
 458         try_session_cache = 0;
 459
 460     /* sets s->tlsext_ticket_expected and extended master secret flag */
 461     r = tls_check_serverhello_tlsext_early(s, ext, session_id, &ret);
 462     switch (r) {
 463     case -1:                   /* Error during processing */
 464         fatal = 1;
 465         goto err;
 466     case 0:                    /* No ticket found */
 467     case 1:                    /* Zero length ticket found */
 468         break;                  /* Ok to carry on processing session id. */
 469     case 2:                    /* Ticket found but not decrypted. */
 470     case 3:                    /* Ticket decrypted, *ret has been set. */
 471         try_session_cache = 0;
 472         break;
 473     default:
 474         abort();
 475     }
 476
 477     if (try_session_cache &&
 478         ret == NULL &&
 479         !(s->session_ctx->session_cache_mode &
 480           SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
 481         SSL_SESSION data;
 482         size_t local_len;
 483         data.ssl_version = s->version;
 484         memset(data.session_id, 0, sizeof(data.session_id));
 485         if (!PACKET_copy_all(session_id, data.session_id,
 486                              sizeof(data.session_id), &local_len)) {
 487             goto err;
 488         }
 489         data.session_id_length = local_len;
 490         CRYPTO_THREAD_read_lock(s->session_ctx->lock);
 491         ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
 492         if (ret != NULL) {
 493             /* don't allow other threads to steal it: */
 494             SSL_SESSION_up_ref(ret);
 495         }
 496         CRYPTO_THREAD_unlock(s->session_ctx->lock);
 497         if (ret == NULL)
 498             s->session_ctx->stats.sess_miss++;
 499     }
 500
 501     if (try_session_cache &&
 502         ret == NULL && s->session_ctx->get_session_cb != NULL) {
 503         int copy = 1;
 504         ret = s->session_ctx->get_session_cb(s, PACKET_data(session_id),
 505                                              (int)PACKET_remaining(session_id),
 506                                              &copy);
 507
 508         if (ret != NULL) {
 509             s->session_ctx->stats.sess_cb_hit++;
 510
 511             /*
 512              * Increment reference count now if the session callback asks us
 513              * to do so (note that if the session structures returned by the
 514              * callback are shared between threads, it must handle the
 515              * reference count itself [i.e. copy == 0], or things won't be
 516              * thread-safe).
 517              */
 518             if (copy)
 519                 SSL_SESSION_up_ref(ret);
 520
 521             /*
 522              * Add the externally cached session to the internal cache as
 523              * well if and only if we are supposed to.
 524              */
 525             if (!
 526                 (s->session_ctx->session_cache_mode &
 527                  SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
 528                 /*
 529                  * The following should not return 1, otherwise, things are
 530                  * very strange
 531                  */
 532                 if (SSL_CTX_add_session(s->session_ctx, ret))
 533                     goto err;
 534             }
 535         }
 536     }
 537
 538     if (ret == NULL)
 539         goto err;
 540
 541     /* Now ret is non-NULL and we own one of its reference counts. */
 542
 543     if (ret->sid_ctx_length != s->sid_ctx_length
 544         || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
 545         /*
 546          * We have the session requested by the client, but we don't want to
 547          * use it in this context.
 548          */
 549         goto err;               /* treat like cache miss */
 550     }
 551
 552     if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
 553         /*
 554          * We can't be sure if this session is being used out of context,
 555          * which is especially important for SSL_VERIFY_PEER. The application
 556          * should have used SSL[_CTX]_set_session_id_context. For this error
 557          * case, we generate an error instead of treating the event like a
 558          * cache miss (otherwise it would be easy for applications to
 559          * effectively disable the session cache by accident without anyone
 560          * noticing).
 561          */
 562
 563         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
 564                SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 565         fatal = 1;
 566         goto err;
 567     }
 568
 569     if (ret->cipher == NULL) {
 570         unsigned char buf[5], *p;
 571         unsigned long l;
 572
 573         p = buf;
 574         l = ret->cipher_id;
 575         l2n(l, p);
 576         if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
 577             ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
 578         else
 579             ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
 580         if (ret->cipher == NULL)
 581             goto err;
 582     }
 583
 584     if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
 585         s->session_ctx->stats.sess_timeout++;
 586         if (try_session_cache) {
 587             /* session was from the cache, so remove it */
 588             SSL_CTX_remove_session(s->session_ctx, ret);
 589         }
 590         goto err;
 591     }
 592
 593     /* Check extended master secret extension consistency */
 594     if (ret->flags & SSL_SESS_FLAG_EXTMS) {
 595         /* If old session includes extms, but new does not: abort handshake */
 596         if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
 597             SSLerr(SSL_F_SSL_GET_PREV_SESSION, SSL_R_INCONSISTENT_EXTMS);
 598             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
 599             fatal = 1;
 600             goto err;
 601         }
 602     } else if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) {
 603         /* If new session includes extms, but old does not: do not resume */
 604         goto err;
 605     }
 606
 607     s->session_ctx->stats.sess_hit++;
 608
 609     SSL_SESSION_free(s->session);
 610     s->session = ret;
 611     s->verify_result = s->session->verify_result;
 612     return 1;
 613
 614  err:
 615     if (ret != NULL) {
 616         SSL_SESSION_free(ret);
 617
 618         if (!try_session_cache) {
 619             /*
 620              * The session was from a ticket, so we should issue a ticket for
 621              * the new session
 622              */
 623             s->tlsext_ticket_expected = 1;
 624         }
 625     }
 626     if (fatal)
 627         return -1;
 628     else
 629         return 0;
 630 }
 631
 632 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 633 {
 634     int ret = 0;
 635     SSL_SESSION *s;
 636
 637     /*
 638      * add just 1 reference count for the SSL_CTX's session cache even though
 639      * it has two ways of access: each session is in a doubly linked list and
 640      * an lhash
 641      */
 642     SSL_SESSION_up_ref(c);
 643     /*
 644      * if session c is in already in cache, we take back the increment later
 645      */
 646
 647     CRYPTO_THREAD_write_lock(ctx->lock);
 648     s = lh_SSL_SESSION_insert(ctx->sessions, c);
 649
 650     /*
 651      * s != NULL iff we already had a session with the given PID. In this
 652      * case, s == c should hold (then we did not really modify
 653      * ctx->sessions), or we're in trouble.
 654      */
 655     if (s != NULL && s != c) {
 656         /* We *are* in trouble ... */
 657         SSL_SESSION_list_remove(ctx, s);
 658         SSL_SESSION_free(s);
 659         /*
 660          * ... so pretend the other session did not exist in cache (we cannot
 661          * handle two SSL_SESSION structures with identical session ID in the
 662          * same cache, which could happen e.g. when two threads concurrently
 663          * obtain the same session from an external cache)
 664          */
 665         s = NULL;
 666     }
 667
 668     /* Put at the head of the queue unless it is already in the cache */
 669     if (s == NULL)
 670         SSL_SESSION_list_add(ctx, c);
 671
 672     if (s != NULL) {
 673         /*
 674          * existing cache entry -- decrement previously incremented reference
 675          * count because it already takes into account the cache
 676          */
 677
 678         SSL_SESSION_free(s);    /* s == c */
 679         ret = 0;
 680     } else {
 681         /*
 682          * new cache entry -- remove old ones if cache has become too large
 683          */
 684
 685         ret = 1;
 686
 687         if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
 688             while (SSL_CTX_sess_number(ctx) > SSL_CTX_sess_get_cache_size(ctx)) {
 689                 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
 690                     break;
 691                 else
 692                     ctx->stats.sess_cache_full++;
 693             }
 694         }
 695     }
 696     CRYPTO_THREAD_unlock(ctx->lock);
 697     return ret;
 698 }
 699
 700 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 701 {
 702     return remove_session_lock(ctx, c, 1);
 703 }
 704
 705 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 706 {
 707     SSL_SESSION *r;
 708     int ret = 0;
 709
 710     if ((c != NULL) && (c->session_id_length != 0)) {
 711         if (lck)
 712             CRYPTO_THREAD_write_lock(ctx->lock);
 713         if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
 714             ret = 1;
 715             r = lh_SSL_SESSION_delete(ctx->sessions, c);
 716             SSL_SESSION_list_remove(ctx, c);
 717         }
 718         c->not_resumable = 1;
 719
 720         if (lck)
 721             CRYPTO_THREAD_unlock(ctx->lock);
 722
 723         if (ret)
 724             SSL_SESSION_free(r);
 725
 726         if (ctx->remove_session_cb != NULL)
 727             ctx->remove_session_cb(ctx, c);
 728     } else
 729         ret = 0;
 730     return (ret);
 731 }
 732
 733 void SSL_SESSION_free(SSL_SESSION *ss)
 734 {
 735     int i;
 736
 737     if (ss == NULL)
 738         return;
 739
 740     CRYPTO_atomic_add(&ss->references, -1, &i, ss->lock);
 741     REF_PRINT_COUNT("SSL_SESSION", ss);
 742     if (i > 0)
 743         return;
 744     REF_ASSERT_ISNT(i < 0);
 745
 746     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 747
 748     OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
 749     OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
 750     X509_free(ss->peer);
 751     sk_X509_pop_free(ss->peer_chain, X509_free);
 752     sk_SSL_CIPHER_free(ss->ciphers);
 753     OPENSSL_free(ss->tlsext_hostname);
 754     OPENSSL_free(ss->tlsext_tick);
 755 #ifndef OPENSSL_NO_EC
 756     ss->tlsext_ecpointformatlist_length = 0;
 757     OPENSSL_free(ss->tlsext_ecpointformatlist);
 758     ss->tlsext_ellipticcurvelist_length = 0;
 759     OPENSSL_free(ss->tlsext_ellipticcurvelist);
 760 #endif                          /* OPENSSL_NO_EC */
 761 #ifndef OPENSSL_NO_PSK
 762     OPENSSL_free(ss->psk_identity_hint);
 763     OPENSSL_free(ss->psk_identity);
 764 #endif
 765 #ifndef OPENSSL_NO_SRP
 766     OPENSSL_free(ss->srp_username);
 767 #endif
 768     CRYPTO_THREAD_lock_free(ss->lock);
 769     OPENSSL_clear_free(ss, sizeof(*ss));
 770 }
 771
 772 int SSL_SESSION_up_ref(SSL_SESSION *ss)
 773 {
 774     int i;
 775
 776     if (CRYPTO_atomic_add(&ss->references, 1, &i, ss->lock) <= 0)
 777         return 0;
 778
 779     REF_PRINT_COUNT("SSL_SESSION", ss);
 780     REF_ASSERT_ISNT(i < 2);
 781     return ((i > 1) ? 1 : 0);
 782 }
 783
 784 int SSL_set_session(SSL *s, SSL_SESSION *session)
 785 {
 786     ssl_clear_bad_session(s);
 787     if (s->ctx->method != s->method) {
 788         if (!SSL_set_ssl_method(s, s->ctx->method))
 789             return 0;
 790     }
 791
 792     if (session != NULL) {
 793         SSL_SESSION_up_ref(session);
 794         s->verify_result = session->verify_result;
 795     }
 796     SSL_SESSION_free(s->session);
 797     s->session = session;
 798
 799     return 1;
 800 }
 801
 802 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
 803                         unsigned int sid_len)
 804 {
 805     if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
 806       SSLerr(SSL_F_SSL_SESSION_SET1_ID,
 807              SSL_R_SSL_SESSION_ID_TOO_LONG);
 808       return 0;
 809     }
 810     s->session_id_length = sid_len;
 811     memcpy(s->session_id, sid, sid_len);
 812     return 1;
 813 }
 814
 815 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 816 {
 817     if (s == NULL)
 818         return (0);
 819     s->timeout = t;
 820     return (1);
 821 }
 822
 823 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 824 {
 825     if (s == NULL)
 826         return (0);
 827     return (s->timeout);
 828 }
 829
 830 long SSL_SESSION_get_time(const SSL_SESSION *s)
 831 {
 832     if (s == NULL)
 833         return (0);
 834     return (s->time);
 835 }
 836
 837 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 838 {
 839     if (s == NULL)
 840         return (0);
 841     s->time = t;
 842     return (t);
 843 }
 844
 845 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
 846 {
 847     return s->ssl_version;
 848 }
 849
 850 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
 851 {
 852     return s->cipher;
 853 }
 854
 855 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
 856 {
 857     return s->tlsext_hostname;
 858 }
 859
 860 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
 861 {
 862     return (s->tlsext_ticklen > 0) ? 1 : 0;
 863 }
 864
 865 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
 866 {
 867     return s->tlsext_tick_lifetime_hint;
 868 }
 869
 870 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
 871                              size_t *len)
 872 {
 873     *len = s->tlsext_ticklen;
 874     if (tick != NULL)
 875         *tick = s->tlsext_tick;
 876 }
 877
 878 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
 879 {
 880     return s->peer;
 881 }
 882
 883 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
 884                                 unsigned int sid_ctx_len)
 885 {
 886     if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
 887         SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
 888                SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
 889         return 0;
 890     }
 891     s->sid_ctx_length = sid_ctx_len;
 892     memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
 893
 894     return 1;
 895 }
 896
 897 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 898 {
 899     long l;
 900     if (s == NULL)
 901         return (0);
 902     l = s->session_timeout;
 903     s->session_timeout = t;
 904     return (l);
 905 }
 906
 907 long SSL_CTX_get_timeout(const SSL_CTX *s)
 908 {
 909     if (s == NULL)
 910         return (0);
 911     return (s->session_timeout);
 912 }
 913
 914 int SSL_set_session_secret_cb(SSL *s,
 915                               int (*tls_session_secret_cb) (SSL *s,
 916                                                             void *secret,
 917                                                             int *secret_len,
 918                                                             STACK_OF(SSL_CIPHER)
 919                                                             *peer_ciphers,
 920                                                             const SSL_CIPHER
 921                                                             **cipher,
 922                                                             void *arg),
 923                               void *arg)
 924 {
 925     if (s == NULL)
 926         return (0);
 927     s->tls_session_secret_cb = tls_session_secret_cb;
 928     s->tls_session_secret_cb_arg = arg;
 929     return (1);
 930 }
 931
 932 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
 933                                   void *arg)
 934 {
 935     if (s == NULL)
 936         return (0);
 937     s->tls_session_ticket_ext_cb = cb;
 938     s->tls_session_ticket_ext_cb_arg = arg;
 939     return (1);
 940 }
 941
 942 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
 943 {
 944     if (s->version >= TLS1_VERSION) {
 945         OPENSSL_free(s->tlsext_session_ticket);
 946         s->tlsext_session_ticket = NULL;
 947         s->tlsext_session_ticket =
 948             OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
 949         if (s->tlsext_session_ticket == NULL) {
 950             SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
 951             return 0;
 952         }
 953
 954         if (ext_data) {
 955             s->tlsext_session_ticket->length = ext_len;
 956             s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
 957             memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
 958         } else {
 959             s->tlsext_session_ticket->length = 0;
 960             s->tlsext_session_ticket->data = NULL;
 961         }
 962
 963         return 1;
 964     }
 965
 966     return 0;
 967 }
 968
 969 typedef struct timeout_param_st {
 970     SSL_CTX *ctx;
 971     long time;
 972     LHASH_OF(SSL_SESSION) *cache;
 973 } TIMEOUT_PARAM;
 974
 975 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
 976 {
 977     if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
 978         /*
 979          * The reason we don't call SSL_CTX_remove_session() is to save on
 980          * locking overhead
 981          */
 982         (void)lh_SSL_SESSION_delete(p->cache, s);
 983         SSL_SESSION_list_remove(p->ctx, s);
 984         s->not_resumable = 1;
 985         if (p->ctx->remove_session_cb != NULL)
 986             p->ctx->remove_session_cb(p->ctx, s);
 987         SSL_SESSION_free(s);
 988     }
 989 }
 990
 991 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
 992
 993 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 994 {
 995     unsigned long i;
 996     TIMEOUT_PARAM tp;
 997
 998     tp.ctx = s;
 999     tp.cache = s->sessions;
1000     if (tp.cache == NULL)
1001         return;
1002     tp.time = t;
1003     CRYPTO_THREAD_write_lock(s->lock);
1004     i = lh_SSL_SESSION_get_down_load(s->sessions);
1005     lh_SSL_SESSION_set_down_load(s->sessions, 0);
1006     lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1007     lh_SSL_SESSION_set_down_load(s->sessions, i);
1008     CRYPTO_THREAD_unlock(s->lock);
1009 }
1010
1011 int ssl_clear_bad_session(SSL *s)
1012 {
1013     if ((s->session != NULL) &&
1014         !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1015         !(SSL_in_init(s) || SSL_in_before(s))) {
1016         SSL_CTX_remove_session(s->session_ctx, s->session);
1017         return (1);
1018     } else
1019         return (0);
1020 }
1021
1022 /* locked by SSL_CTX in the calling function */
1023 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1024 {
1025     if ((s->next == NULL) || (s->prev == NULL))
1026         return;
1027
1028     if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1029         /* last element in list */
1030         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1031             /* only one element in list */
1032             ctx->session_cache_head = NULL;
1033             ctx->session_cache_tail = NULL;
1034         } else {
1035             ctx->session_cache_tail = s->prev;
1036             s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1037         }
1038     } else {
1039         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1040             /* first element in list */
1041             ctx->session_cache_head = s->next;
1042             s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1043         } else {
1044             /* middle of list */
1045             s->next->prev = s->prev;
1046             s->prev->next = s->next;
1047         }
1048     }
1049     s->prev = s->next = NULL;
1050 }
1051
1052 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1053 {
1054     if ((s->next != NULL) && (s->prev != NULL))
1055         SSL_SESSION_list_remove(ctx, s);
1056
1057     if (ctx->session_cache_head == NULL) {
1058         ctx->session_cache_head = s;
1059         ctx->session_cache_tail = s;
1060         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1061         s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1062     } else {
1063         s->next = ctx->session_cache_head;
1064         s->next->prev = s;
1065         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1066         ctx->session_cache_head = s;
1067     }
1068 }
1069
1070 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1071                              int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1072 {
1073     ctx->new_session_cb = cb;
1074 }
1075
1076 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1077     return ctx->new_session_cb;
1078 }
1079
1080 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1081                                 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1082 {
1083     ctx->remove_session_cb = cb;
1084 }
1085
1086 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1087                                                   SSL_SESSION *sess) {
1088     return ctx->remove_session_cb;
1089 }
1090
1091 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1092                              SSL_SESSION *(*cb) (struct ssl_st *ssl,
1093                                                  const unsigned char *data,
1094                                                  int len, int *copy))
1095 {
1096     ctx->get_session_cb = cb;
1097 }
1098
1099 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1100                                                        const unsigned char
1101                                                        *data, int len,
1102                                                        int *copy) {
1103     return ctx->get_session_cb;
1104 }
1105
1106 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1107                                void (*cb) (const SSL *ssl, int type, int val))
1108 {
1109     ctx->info_callback = cb;
1110 }
1111
1112 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1113                                                  int val) {
1114     return ctx->info_callback;
1115 }
1116
1117 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1118                                 int (*cb) (SSL *ssl, X509 **x509,
1119                                            EVP_PKEY **pkey))
1120 {
1121     ctx->client_cert_cb = cb;
1122 }
1123
1124 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1125                                                  EVP_PKEY **pkey) {
1126     return ctx->client_cert_cb;
1127 }
1128
1129 #ifndef OPENSSL_NO_ENGINE
1130 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1131 {
1132     if (!ENGINE_init(e)) {
1133         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1134         return 0;
1135     }
1136     if (!ENGINE_get_ssl_client_cert_function(e)) {
1137         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1138                SSL_R_NO_CLIENT_CERT_METHOD);
1139         ENGINE_finish(e);
1140         return 0;
1141     }
1142     ctx->client_cert_engine = e;
1143     return 1;
1144 }
1145 #endif
1146
1147 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1148                                     int (*cb) (SSL *ssl,
1149                                                unsigned char *cookie,
1150                                                unsigned int *cookie_len))
1151 {
1152     ctx->app_gen_cookie_cb = cb;
1153 }
1154
1155 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1156                                   int (*cb) (SSL *ssl,
1157                                              const unsigned char *cookie,
1158                                              unsigned int cookie_len))
1159 {
1160     ctx->app_verify_cookie_cb = cb;
1161 }
1162
1163 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)