ssl/ssl_sess.c

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