ssl/ssl_sess.c

   1 /* ssl/ssl_sess.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58 /* ====================================================================
  59  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111 /* ====================================================================
 112  * Copyright 2005 Nokia. All rights reserved.
 113  *
 114  * The portions of the attached software ("Contribution") is developed by
 115  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
 116  * license.
 117  *
 118  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
 119  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
 120  * support (see RFC 4279) to OpenSSL.
 121  *
 122  * No patent licenses or other rights except those expressly stated in
 123  * the OpenSSL open source license shall be deemed granted or received
 124  * expressly, by implication, estoppel, or otherwise.
 125  *
 126  * No assurances are provided by Nokia that the Contribution does not
 127  * infringe the patent or other intellectual property rights of any third
 128  * party or that the license provides you with all the necessary rights
 129  * to make use of the Contribution.
 130  *
 131  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
 132  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
 133  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
 134  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
 135  * OTHERWISE.
 136  */
 137
 138 #include <stdio.h>
 139 #include <openssl/lhash.h>
 140 #include <openssl/rand.h>
 141 #ifndef OPENSSL_NO_ENGINE
 142 # include <openssl/engine.h>
 143 #endif
 144 #include "ssl_locl.h"
 145
 146 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
 147 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
 148 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
 149
 150 SSL_SESSION *SSL_get_session(const SSL *ssl)
 151 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
 152 {
 153     return (ssl->session);
 154 }
 155
 156 SSL_SESSION *SSL_get1_session(SSL *ssl)
 157 /* variant of SSL_get_session: caller really gets something */
 158 {
 159     SSL_SESSION *sess;
 160     /*
 161      * Need to lock this all up rather than just use CRYPTO_add so that
 162      * somebody doesn't free ssl->session between when we check it's non-null
 163      * and when we up the reference count.
 164      */
 165     CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION);
 166     sess = ssl->session;
 167     if (sess)
 168         sess->references++;
 169     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
 170     return (sess);
 171 }
 172
 173 int SSL_SESSION_get_ex_new_index(long argl, void *argp,
 174                                  CRYPTO_EX_new *new_func,
 175                                  CRYPTO_EX_dup *dup_func,
 176                                  CRYPTO_EX_free *free_func)
 177 {
 178     return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, argl, argp,
 179                                    new_func, dup_func, free_func);
 180 }
 181
 182 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
 183 {
 184     return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
 185 }
 186
 187 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
 188 {
 189     return (CRYPTO_get_ex_data(&s->ex_data, idx));
 190 }
 191
 192 SSL_SESSION *SSL_SESSION_new(void)
 193 {
 194     SSL_SESSION *ss;
 195
 196     ss = (SSL_SESSION *)OPENSSL_malloc(sizeof(SSL_SESSION));
 197     if (ss == NULL) {
 198         SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
 199         return (0);
 200     }
 201     memset(ss, 0, sizeof(SSL_SESSION));
 202
 203     ss->verify_result = 1;      /* avoid 0 (= X509_V_OK) just in case */
 204     ss->references = 1;
 205     ss->timeout = 60 * 5 + 4;   /* 5 minute timeout by default */
 206     ss->time = (unsigned long)time(NULL);
 207     ss->prev = NULL;
 208     ss->next = NULL;
 209     ss->compress_meth = 0;
 210 #ifndef OPENSSL_NO_TLSEXT
 211     ss->tlsext_hostname = NULL;
 212 # ifndef OPENSSL_NO_EC
 213     ss->tlsext_ecpointformatlist_length = 0;
 214     ss->tlsext_ecpointformatlist = NULL;
 215     ss->tlsext_ellipticcurvelist_length = 0;
 216     ss->tlsext_ellipticcurvelist = NULL;
 217 # endif
 218 #endif
 219     CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 220 #ifndef OPENSSL_NO_PSK
 221     ss->psk_identity_hint = NULL;
 222     ss->psk_identity = NULL;
 223 #endif
 224     return (ss);
 225 }
 226
 227 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
 228                                         unsigned int *len)
 229 {
 230     if (len)
 231         *len = s->session_id_length;
 232     return s->session_id;
 233 }
 234
 235 /*
 236  * Even with SSLv2, we have 16 bytes (128 bits) of session ID space.
 237  * SSLv3/TLSv1 has 32 bytes (256 bits). As such, filling the ID with random
 238  * gunk repeatedly until we have no conflict is going to complete in one
 239  * iteration pretty much "most" of the time (btw: understatement). So, if it
 240  * takes us 10 iterations and we still can't avoid a conflict - well that's a
 241  * reasonable point to call it quits. Either the RAND code is broken or
 242  * someone is trying to open roughly very close to 2^128 (or 2^256) SSL
 243  * sessions to our server. How you might store that many sessions is perhaps
 244  * a more interesting question ...
 245  */
 246
 247 #define MAX_SESS_ID_ATTEMPTS 10
 248 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
 249                                    unsigned int *id_len)
 250 {
 251     unsigned int retry = 0;
 252     do
 253         if (RAND_pseudo_bytes(id, *id_len) <= 0)
 254             return 0;
 255     while (SSL_has_matching_session_id(ssl, id, *id_len) &&
 256            (++retry < MAX_SESS_ID_ATTEMPTS)) ;
 257     if (retry < MAX_SESS_ID_ATTEMPTS)
 258         return 1;
 259     /* else - woops a session_id match */
 260     /*
 261      * XXX We should also check the external cache -- but the probability of
 262      * a collision is negligible, and we could not prevent the concurrent
 263      * creation of sessions with identical IDs since we currently don't have
 264      * means to atomically check whether a session ID already exists and make
 265      * a reservation for it if it does not (this problem applies to the
 266      * internal cache as well).
 267      */
 268     return 0;
 269 }
 270
 271 int ssl_get_new_session(SSL *s, int session)
 272 {
 273     /* This gets used by clients and servers. */
 274
 275     unsigned int tmp;
 276     SSL_SESSION *ss = NULL;
 277     GEN_SESSION_CB cb = def_generate_session_id;
 278
 279     if ((ss = SSL_SESSION_new()) == NULL)
 280         return (0);
 281
 282     /* If the context has a default timeout, use it */
 283     if (s->session_ctx->session_timeout == 0)
 284         ss->timeout = SSL_get_default_timeout(s);
 285     else
 286         ss->timeout = s->session_ctx->session_timeout;
 287
 288     if (s->session != NULL) {
 289         SSL_SESSION_free(s->session);
 290         s->session = NULL;
 291     }
 292
 293     if (session) {
 294         if (s->version == SSL2_VERSION) {
 295             ss->ssl_version = SSL2_VERSION;
 296             ss->session_id_length = SSL2_SSL_SESSION_ID_LENGTH;
 297         } else if (s->version == SSL3_VERSION) {
 298             ss->ssl_version = SSL3_VERSION;
 299             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 300         } else if (s->version == TLS1_VERSION) {
 301             ss->ssl_version = TLS1_VERSION;
 302             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 303         } else if (s->version == DTLS1_BAD_VER) {
 304             ss->ssl_version = DTLS1_BAD_VER;
 305             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 306         } else if (s->version == DTLS1_VERSION) {
 307             ss->ssl_version = DTLS1_VERSION;
 308             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 309         } else {
 310             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
 311             SSL_SESSION_free(ss);
 312             return (0);
 313         }
 314 #ifndef OPENSSL_NO_TLSEXT
 315         /* If RFC4507 ticket use empty session ID */
 316         if (s->tlsext_ticket_expected) {
 317             ss->session_id_length = 0;
 318             goto sess_id_done;
 319         }
 320 #endif
 321         /* Choose which callback will set the session ID */
 322         CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 323         if (s->generate_session_id)
 324             cb = s->generate_session_id;
 325         else if (s->session_ctx->generate_session_id)
 326             cb = s->session_ctx->generate_session_id;
 327         CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 328         /* Choose a session ID */
 329         tmp = ss->session_id_length;
 330         if (!cb(s, ss->session_id, &tmp)) {
 331             /* The callback failed */
 332             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 333                    SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
 334             SSL_SESSION_free(ss);
 335             return (0);
 336         }
 337         /*
 338          * Don't allow the callback to set the session length to zero. nor
 339          * set it higher than it was.
 340          */
 341         if (!tmp || (tmp > ss->session_id_length)) {
 342             /* The callback set an illegal length */
 343             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 344                    SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
 345             SSL_SESSION_free(ss);
 346             return (0);
 347         }
 348         /* If the session length was shrunk and we're SSLv2, pad it */
 349         if ((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
 350             memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
 351         else
 352             ss->session_id_length = tmp;
 353         /* Finally, check for a conflict */
 354         if (SSL_has_matching_session_id(s, ss->session_id,
 355                                         ss->session_id_length)) {
 356             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
 357             SSL_SESSION_free(ss);
 358             return (0);
 359         }
 360 #ifndef OPENSSL_NO_TLSEXT
 361  sess_id_done:
 362         if (s->tlsext_hostname) {
 363             ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
 364             if (ss->tlsext_hostname == NULL) {
 365                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 366                 SSL_SESSION_free(ss);
 367                 return 0;
 368             }
 369         }
 370 # ifndef OPENSSL_NO_EC
 371         if (s->tlsext_ecpointformatlist) {
 372             if (ss->tlsext_ecpointformatlist != NULL)
 373                 OPENSSL_free(ss->tlsext_ecpointformatlist);
 374             if ((ss->tlsext_ecpointformatlist =
 375                  OPENSSL_malloc(s->tlsext_ecpointformatlist_length)) ==
 376                 NULL) {
 377                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
 378                 SSL_SESSION_free(ss);
 379                 return 0;
 380             }
 381             ss->tlsext_ecpointformatlist_length =
 382                 s->tlsext_ecpointformatlist_length;
 383             memcpy(ss->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist,
 384                    s->tlsext_ecpointformatlist_length);
 385         }
 386         if (s->tlsext_ellipticcurvelist) {
 387             if (ss->tlsext_ellipticcurvelist != NULL)
 388                 OPENSSL_free(ss->tlsext_ellipticcurvelist);
 389             if ((ss->tlsext_ellipticcurvelist =
 390                  OPENSSL_malloc(s->tlsext_ellipticcurvelist_length)) ==
 391                 NULL) {
 392                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
 393                 SSL_SESSION_free(ss);
 394                 return 0;
 395             }
 396             ss->tlsext_ellipticcurvelist_length =
 397                 s->tlsext_ellipticcurvelist_length;
 398             memcpy(ss->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist,
 399                    s->tlsext_ellipticcurvelist_length);
 400         }
 401 # endif
 402 #endif
 403     } else {
 404         ss->session_id_length = 0;
 405     }
 406
 407     if (s->sid_ctx_length > sizeof ss->sid_ctx) {
 408         SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 409         SSL_SESSION_free(ss);
 410         return 0;
 411     }
 412     memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
 413     ss->sid_ctx_length = s->sid_ctx_length;
 414     s->session = ss;
 415     ss->ssl_version = s->version;
 416     ss->verify_result = X509_V_OK;
 417
 418     return (1);
 419 }
 420
 421 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
 422                          const unsigned char *limit)
 423 {
 424     /* This is used only by servers. */
 425
 426     SSL_SESSION *ret = NULL;
 427     int fatal = 0;
 428 #ifndef OPENSSL_NO_TLSEXT
 429     int r;
 430 #endif
 431
 432     if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
 433         goto err;
 434
 435     if (session_id + len > limit) {
 436         fatal = 1;
 437         goto err;
 438     }
 439
 440 #ifndef OPENSSL_NO_TLSEXT
 441     r = tls1_process_ticket(s, session_id, len, limit, &ret);
 442     if (r == -1) {
 443         fatal = 1;
 444         goto err;
 445     } else if (r == 0 || (!ret && !len))
 446         goto err;
 447     else if (!ret
 448              && !(s->session_ctx->session_cache_mode &
 449                   SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 450 #else
 451     if (len == 0)
 452         goto err;
 453     if (!
 454         (s->
 455          session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 456 #endif
 457     {
 458         SSL_SESSION data;
 459         data.ssl_version = s->version;
 460         data.session_id_length = len;
 461         if (len == 0)
 462             return 0;
 463         memcpy(data.session_id, session_id, len);
 464         CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 465         ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
 466         if (ret != NULL)
 467             /* don't allow other threads to steal it: */
 468             CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 469         CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 470     }
 471
 472     if (ret == NULL) {
 473         int copy = 1;
 474
 475         s->session_ctx->stats.sess_miss++;
 476         ret = NULL;
 477         if (s->session_ctx->get_session_cb != NULL
 478             && (ret =
 479                 s->session_ctx->get_session_cb(s, session_id, len, &copy))
 480             != NULL) {
 481             s->session_ctx->stats.sess_cb_hit++;
 482
 483             /*
 484              * Increment reference count now if the session callback asks us
 485              * to do so (note that if the session structures returned by the
 486              * callback are shared between threads, it must handle the
 487              * reference count itself [i.e. copy == 0], or things won't be
 488              * thread-safe).
 489              */
 490             if (copy)
 491                 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 492
 493             /*
 494              * Add the externally cached session to the internal cache as
 495              * well if and only if we are supposed to.
 496              */
 497             if (!
 498                 (s->session_ctx->session_cache_mode &
 499                  SSL_SESS_CACHE_NO_INTERNAL_STORE))
 500                 /*
 501                  * The following should not return 1, otherwise, things are
 502                  * very strange
 503                  */
 504                 SSL_CTX_add_session(s->session_ctx, ret);
 505         }
 506         if (ret == NULL)
 507             goto err;
 508     }
 509
 510     /* Now ret is non-NULL, and we own one of its reference counts. */
 511
 512     if (ret->sid_ctx_length != s->sid_ctx_length
 513         || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
 514         /*
 515          * We've found the session named by the client, but we don't want to
 516          * use it in this context.
 517          */
 518
 519 #if 0                           /* The client cannot always know when a
 520                                  * session is not appropriate, so we
 521                                  * shouldn't generate an error message. */
 522
 523         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
 524                SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
 525 #endif
 526         goto err;               /* treat like cache miss */
 527     }
 528
 529     if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
 530         /*
 531          * We can't be sure if this session is being used out of context,
 532          * which is especially important for SSL_VERIFY_PEER. The application
 533          * should have used SSL[_CTX]_set_session_id_context. For this error
 534          * case, we generate an error instead of treating the event like a
 535          * cache miss (otherwise it would be easy for applications to
 536          * effectively disable the session cache by accident without anyone
 537          * noticing).
 538          */
 539
 540         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
 541                SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 542         fatal = 1;
 543         goto err;
 544     }
 545
 546     if (ret->cipher == NULL) {
 547         unsigned char buf[5], *p;
 548         unsigned long l;
 549
 550         p = buf;
 551         l = ret->cipher_id;
 552         l2n(l, p);
 553         if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
 554             ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
 555         else
 556             ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
 557         if (ret->cipher == NULL)
 558             goto err;
 559     }
 560 #if 0                           /* This is way too late. */
 561
 562     /*
 563      * If a thread got the session, then 'swaped', and another got it and
 564      * then due to a time-out decided to 'OPENSSL_free' it we could be in
 565      * trouble.  So I'll increment it now, then double decrement later - am I
 566      * speaking rubbish?.
 567      */
 568     CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 569 #endif
 570
 571     if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
 572         s->session_ctx->stats.sess_timeout++;
 573         /* remove it from the cache */
 574         SSL_CTX_remove_session(s->session_ctx, ret);
 575         goto err;
 576     }
 577
 578     s->session_ctx->stats.sess_hit++;
 579
 580     /*- ret->time=time(NULL); *//*
 581      * rezero timeout?
 582      */
 583     /*
 584      * again, just leave the session if it is the same session, we have just
 585      * incremented and then decremented the reference count :-)
 586      */
 587     if (s->session != NULL)
 588         SSL_SESSION_free(s->session);
 589     s->session = ret;
 590     s->verify_result = s->session->verify_result;
 591     return (1);
 592
 593  err:
 594     if (ret != NULL)
 595         SSL_SESSION_free(ret);
 596     if (fatal)
 597         return -1;
 598     else
 599         return 0;
 600 }
 601
 602 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 603 {
 604     int ret = 0;
 605     SSL_SESSION *s;
 606
 607     /*
 608      * add just 1 reference count for the SSL_CTX's session cache even though
 609      * it has two ways of access: each session is in a doubly linked list and
 610      * an lhash
 611      */
 612     CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
 613     /*
 614      * if session c is in already in cache, we take back the increment later
 615      */
 616
 617     CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 618     s = lh_SSL_SESSION_insert(ctx->sessions, c);
 619
 620     /*
 621      * s != NULL iff we already had a session with the given PID. In this
 622      * case, s == c should hold (then we did not really modify
 623      * ctx->sessions), or we're in trouble.
 624      */
 625     if (s != NULL && s != c) {
 626         /* We *are* in trouble ... */
 627         SSL_SESSION_list_remove(ctx, s);
 628         SSL_SESSION_free(s);
 629         /*
 630          * ... so pretend the other session did not exist in cache (we cannot
 631          * handle two SSL_SESSION structures with identical session ID in the
 632          * same cache, which could happen e.g. when two threads concurrently
 633          * obtain the same session from an external cache)
 634          */
 635         s = NULL;
 636     }
 637
 638     /* Put at the head of the queue unless it is already in the cache */
 639     if (s == NULL)
 640         SSL_SESSION_list_add(ctx, c);
 641
 642     if (s != NULL) {
 643         /*
 644          * existing cache entry -- decrement previously incremented reference
 645          * count because it already takes into account the cache
 646          */
 647
 648         SSL_SESSION_free(s);    /* s == c */
 649         ret = 0;
 650     } else {
 651         /*
 652          * new cache entry -- remove old ones if cache has become too large
 653          */
 654
 655         ret = 1;
 656
 657         if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
 658             while (SSL_CTX_sess_number(ctx) >
 659                    SSL_CTX_sess_get_cache_size(ctx)) {
 660                 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
 661                     break;
 662                 else
 663                     ctx->stats.sess_cache_full++;
 664             }
 665         }
 666     }
 667     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 668     return (ret);
 669 }
 670
 671 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 672 {
 673     return remove_session_lock(ctx, c, 1);
 674 }
 675
 676 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 677 {
 678     SSL_SESSION *r;
 679     int ret = 0;
 680
 681     if ((c != NULL) && (c->session_id_length != 0)) {
 682         if (lck)
 683             CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 684         if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
 685             ret = 1;
 686             r = lh_SSL_SESSION_delete(ctx->sessions, c);
 687             SSL_SESSION_list_remove(ctx, c);
 688         }
 689
 690         if (lck)
 691             CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 692
 693         if (ret) {
 694             r->not_resumable = 1;
 695             if (ctx->remove_session_cb != NULL)
 696                 ctx->remove_session_cb(ctx, r);
 697             SSL_SESSION_free(r);
 698         }
 699     } else
 700         ret = 0;
 701     return (ret);
 702 }
 703
 704 void SSL_SESSION_free(SSL_SESSION *ss)
 705 {
 706     int i;
 707
 708     if (ss == NULL)
 709         return;
 710
 711     i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
 712 #ifdef REF_PRINT
 713     REF_PRINT("SSL_SESSION", ss);
 714 #endif
 715     if (i > 0)
 716         return;
 717 #ifdef REF_CHECK
 718     if (i < 0) {
 719         fprintf(stderr, "SSL_SESSION_free, bad reference count\n");
 720         abort();                /* ok */
 721     }
 722 #endif
 723
 724     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 725
 726     OPENSSL_cleanse(ss->key_arg, sizeof ss->key_arg);
 727     OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
 728     OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
 729     if (ss->sess_cert != NULL)
 730         ssl_sess_cert_free(ss->sess_cert);
 731     if (ss->peer != NULL)
 732         X509_free(ss->peer);
 733     if (ss->ciphers != NULL)
 734         sk_SSL_CIPHER_free(ss->ciphers);
 735 #ifndef OPENSSL_NO_TLSEXT
 736     if (ss->tlsext_hostname != NULL)
 737         OPENSSL_free(ss->tlsext_hostname);
 738     if (ss->tlsext_tick != NULL)
 739         OPENSSL_free(ss->tlsext_tick);
 740 # ifndef OPENSSL_NO_EC
 741     ss->tlsext_ecpointformatlist_length = 0;
 742     if (ss->tlsext_ecpointformatlist != NULL)
 743         OPENSSL_free(ss->tlsext_ecpointformatlist);
 744     ss->tlsext_ellipticcurvelist_length = 0;
 745     if (ss->tlsext_ellipticcurvelist != NULL)
 746         OPENSSL_free(ss->tlsext_ellipticcurvelist);
 747 # endif                         /* OPENSSL_NO_EC */
 748 #endif
 749 #ifndef OPENSSL_NO_PSK
 750     if (ss->psk_identity_hint != NULL)
 751         OPENSSL_free(ss->psk_identity_hint);
 752     if (ss->psk_identity != NULL)
 753         OPENSSL_free(ss->psk_identity);
 754 #endif
 755     OPENSSL_cleanse(ss, sizeof(*ss));
 756     OPENSSL_free(ss);
 757 }
 758
 759 int SSL_set_session(SSL *s, SSL_SESSION *session)
 760 {
 761     int ret = 0;
 762     const SSL_METHOD *meth;
 763
 764     if (session != NULL) {
 765         meth = s->ctx->method->get_ssl_method(session->ssl_version);
 766         if (meth == NULL)
 767             meth = s->method->get_ssl_method(session->ssl_version);
 768         if (meth == NULL) {
 769             SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
 770             return (0);
 771         }
 772
 773         if (meth != s->method) {
 774             if (!SSL_set_ssl_method(s, meth))
 775                 return (0);
 776             if (s->ctx->session_timeout == 0)
 777                 session->timeout = SSL_get_default_timeout(s);
 778             else
 779                 session->timeout = s->ctx->session_timeout;
 780         }
 781 #ifndef OPENSSL_NO_KRB5
 782         if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
 783             session->krb5_client_princ_len > 0) {
 784             s->kssl_ctx->client_princ =
 785                 (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
 786             memcpy(s->kssl_ctx->client_princ, session->krb5_client_princ,
 787                    session->krb5_client_princ_len);
 788             s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
 789         }
 790 #endif                          /* OPENSSL_NO_KRB5 */
 791
 792         /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
 793         CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
 794         if (s->session != NULL)
 795             SSL_SESSION_free(s->session);
 796         s->session = session;
 797         s->verify_result = s->session->verify_result;
 798         /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
 799         ret = 1;
 800     } else {
 801         if (s->session != NULL) {
 802             SSL_SESSION_free(s->session);
 803             s->session = NULL;
 804         }
 805
 806         meth = s->ctx->method;
 807         if (meth != s->method) {
 808             if (!SSL_set_ssl_method(s, meth))
 809                 return (0);
 810         }
 811         ret = 1;
 812     }
 813     return (ret);
 814 }
 815
 816 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 817 {
 818     if (s == NULL)
 819         return (0);
 820     s->timeout = t;
 821     return (1);
 822 }
 823
 824 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 825 {
 826     if (s == NULL)
 827         return (0);
 828     return (s->timeout);
 829 }
 830
 831 long SSL_SESSION_get_time(const SSL_SESSION *s)
 832 {
 833     if (s == NULL)
 834         return (0);
 835     return (s->time);
 836 }
 837
 838 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 839 {
 840     if (s == NULL)
 841         return (0);
 842     s->time = t;
 843     return (t);
 844 }
 845
 846 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 847 {
 848     long l;
 849     if (s == NULL)
 850         return (0);
 851     l = s->session_timeout;
 852     s->session_timeout = t;
 853     return (l);
 854 }
 855
 856 long SSL_CTX_get_timeout(const SSL_CTX *s)
 857 {
 858     if (s == NULL)
 859         return (0);
 860     return (s->session_timeout);
 861 }
 862
 863 #ifndef OPENSSL_NO_TLSEXT
 864 int SSL_set_session_secret_cb(SSL *s,
 865                               int (*tls_session_secret_cb) (SSL *s,
 866                                                             void *secret,
 867                                                             int *secret_len,
 868                                                             STACK_OF(SSL_CIPHER)
 869                                                             *peer_ciphers,
 870                                                             SSL_CIPHER
 871                                                             **cipher,
 872                                                             void *arg),
 873                               void *arg)
 874 {
 875     if (s == NULL)
 876         return (0);
 877     s->tls_session_secret_cb = tls_session_secret_cb;
 878     s->tls_session_secret_cb_arg = arg;
 879     return (1);
 880 }
 881
 882 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
 883                                   void *arg)
 884 {
 885     if (s == NULL)
 886         return (0);
 887     s->tls_session_ticket_ext_cb = cb;
 888     s->tls_session_ticket_ext_cb_arg = arg;
 889     return (1);
 890 }
 891
 892 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
 893 {
 894     if (s->version >= TLS1_VERSION) {
 895         if (s->tlsext_session_ticket) {
 896             OPENSSL_free(s->tlsext_session_ticket);
 897             s->tlsext_session_ticket = NULL;
 898         }
 899
 900         s->tlsext_session_ticket =
 901             OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
 902         if (!s->tlsext_session_ticket) {
 903             SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
 904             return 0;
 905         }
 906
 907         if (ext_data) {
 908             s->tlsext_session_ticket->length = ext_len;
 909             s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
 910             memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
 911         } else {
 912             s->tlsext_session_ticket->length = 0;
 913             s->tlsext_session_ticket->data = NULL;
 914         }
 915
 916         return 1;
 917     }
 918
 919     return 0;
 920 }
 921 #endif                          /* OPENSSL_NO_TLSEXT */
 922
 923 typedef struct timeout_param_st {
 924     SSL_CTX *ctx;
 925     long time;
 926     LHASH_OF(SSL_SESSION) *cache;
 927 } TIMEOUT_PARAM;
 928
 929 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
 930 {
 931     if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
 932         /*
 933          * The reason we don't call SSL_CTX_remove_session() is to save on
 934          * locking overhead
 935          */
 936         (void)lh_SSL_SESSION_delete(p->cache, s);
 937         SSL_SESSION_list_remove(p->ctx, s);
 938         s->not_resumable = 1;
 939         if (p->ctx->remove_session_cb != NULL)
 940             p->ctx->remove_session_cb(p->ctx, s);
 941         SSL_SESSION_free(s);
 942     }
 943 }
 944
 945 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
 946
 947 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 948 {
 949     unsigned long i;
 950     TIMEOUT_PARAM tp;
 951
 952     tp.ctx = s;
 953     tp.cache = s->sessions;
 954     if (tp.cache == NULL)
 955         return;
 956     tp.time = t;
 957     CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 958     i = CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
 959     CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = 0;
 960     lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
 961                              TIMEOUT_PARAM, &tp);
 962     CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load = i;
 963     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 964 }
 965
 966 int ssl_clear_bad_session(SSL *s)
 967 {
 968     if ((s->session != NULL) &&
 969         !(s->shutdown & SSL_SENT_SHUTDOWN) &&
 970         !(SSL_in_init(s) || SSL_in_before(s))) {
 971         SSL_CTX_remove_session(s->ctx, s->session);
 972         return (1);
 973     } else
 974         return (0);
 975 }
 976
 977 /* locked by SSL_CTX in the calling function */
 978 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
 979 {
 980     if ((s->next == NULL) || (s->prev == NULL))
 981         return;
 982
 983     if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
 984         /* last element in list */
 985         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
 986             /* only one element in list */
 987             ctx->session_cache_head = NULL;
 988             ctx->session_cache_tail = NULL;
 989         } else {
 990             ctx->session_cache_tail = s->prev;
 991             s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
 992         }
 993     } else {
 994         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
 995             /* first element in list */
 996             ctx->session_cache_head = s->next;
 997             s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
 998         } else {
 999             /* middle of list */
1000             s->next->prev = s->prev;
1001             s->prev->next = s->next;
1002         }
1003     }
1004     s->prev = s->next = NULL;
1005 }
1006
1007 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1008 {
1009     if ((s->next != NULL) && (s->prev != NULL))
1010         SSL_SESSION_list_remove(ctx, s);
1011
1012     if (ctx->session_cache_head == NULL) {
1013         ctx->session_cache_head = s;
1014         ctx->session_cache_tail = s;
1015         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1016         s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1017     } else {
1018         s->next = ctx->session_cache_head;
1019         s->next->prev = s;
1020         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1021         ctx->session_cache_head = s;
1022     }
1023 }
1024
1025 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1026                              int (*cb) (struct ssl_st *ssl,
1027                                         SSL_SESSION *sess))
1028 {
1029     ctx->new_session_cb = cb;
1030 }
1031
1032 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1033     return ctx->new_session_cb;
1034 }
1035
1036 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1037                                 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1038 {
1039     ctx->remove_session_cb = cb;
1040 }
1041
1042 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1043                                                   SSL_SESSION *sess) {
1044     return ctx->remove_session_cb;
1045 }
1046
1047 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1048                              SSL_SESSION *(*cb) (struct ssl_st *ssl,
1049                                                  unsigned char *data, int len,
1050                                                  int *copy))
1051 {
1052     ctx->get_session_cb = cb;
1053 }
1054
1055 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1056                                                        unsigned char *data,
1057                                                        int len, int *copy) {
1058     return ctx->get_session_cb;
1059 }
1060
1061 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1062                                void (*cb) (const SSL *ssl, int type, int val))
1063 {
1064     ctx->info_callback = cb;
1065 }
1066
1067 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1068                                                  int val) {
1069     return ctx->info_callback;
1070 }
1071
1072 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1073                                 int (*cb) (SSL *ssl, X509 **x509,
1074                                            EVP_PKEY **pkey))
1075 {
1076     ctx->client_cert_cb = cb;
1077 }
1078
1079 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1080                                                  EVP_PKEY **pkey) {
1081     return ctx->client_cert_cb;
1082 }
1083
1084 #ifndef OPENSSL_NO_ENGINE
1085 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1086 {
1087     if (!ENGINE_init(e)) {
1088         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1089         return 0;
1090     }
1091     if (!ENGINE_get_ssl_client_cert_function(e)) {
1092         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1093                SSL_R_NO_CLIENT_CERT_METHOD);
1094         ENGINE_finish(e);
1095         return 0;
1096     }
1097     ctx->client_cert_engine = e;
1098     return 1;
1099 }
1100 #endif
1101
1102 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1103                                     int (*cb) (SSL *ssl,
1104                                                unsigned char *cookie,
1105                                                unsigned int *cookie_len))
1106 {
1107     ctx->app_gen_cookie_cb = cb;
1108 }
1109
1110 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1111                                   int (*cb) (SSL *ssl, unsigned char *cookie,
1112                                              unsigned int cookie_len))
1113 {
1114     ctx->app_verify_cookie_cb = cb;
1115 }
1116
1117 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION,
1118                  SSL_SESSION)