ssl/ssl_sess.c

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