crypto/openssl/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 #include <stdio.h>
  60 #include <openssl/lhash.h>
  61 #include <openssl/rand.h>
  62 #ifndef OPENSSL_NO_ENGINE
  63 # include <openssl/engine.h>
  64 #endif
  65 #include "ssl_locl.h"
  66
  67 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
  68 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
  69 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
  70
  71 SSL_SESSION *SSL_get_session(const SSL *ssl)
  72 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
  73 {
  74     return (ssl->session);
  75 }
  76
  77 SSL_SESSION *SSL_get1_session(SSL *ssl)
  78 /* variant of SSL_get_session: caller really gets something */
  79 {
  80     SSL_SESSION *sess;
  81     /*
  82      * Need to lock this all up rather than just use CRYPTO_add so that
  83      * somebody doesn't free ssl->session between when we check it's non-null
  84      * and when we up the reference count.
  85      */
  86     CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION);
  87     sess = ssl->session;
  88     if (sess)
  89         sess->references++;
  90     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
  91     return (sess);
  92 }
  93
  94 int SSL_SESSION_get_ex_new_index(long argl, void *argp,
  95                                  CRYPTO_EX_new *new_func,
  96                                  CRYPTO_EX_dup *dup_func,
  97                                  CRYPTO_EX_free *free_func)
  98 {
  99     return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, argl, argp,
 100                                    new_func, dup_func, free_func);
 101 }
 102
 103 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
 104 {
 105     return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
 106 }
 107
 108 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
 109 {
 110     return (CRYPTO_get_ex_data(&s->ex_data, idx));
 111 }
 112
 113 SSL_SESSION *SSL_SESSION_new(void)
 114 {
 115     SSL_SESSION *ss;
 116
 117     ss = (SSL_SESSION *)OPENSSL_malloc(sizeof(SSL_SESSION));
 118     if (ss == NULL) {
 119         SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
 120         return (0);
 121     }
 122     memset(ss, 0, sizeof(SSL_SESSION));
 123
 124     ss->verify_result = 1;      /* avoid 0 (= X509_V_OK) just in case */
 125     ss->references = 1;
 126     ss->timeout = 60 * 5 + 4;   /* 5 minute timeout by default */
 127     ss->time = (unsigned long)time(NULL);
 128     ss->prev = NULL;
 129     ss->next = NULL;
 130     ss->compress_meth = 0;
 131 #ifndef OPENSSL_NO_TLSEXT
 132     ss->tlsext_hostname = NULL;
 133 #endif
 134     CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 135     return (ss);
 136 }
 137
 138 /*
 139  * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
 140  * ticket == 0 then no ticket information is duplicated, otherwise it is.
 141  */
 142 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
 143 {
 144     SSL_SESSION *dest;
 145
 146     dest = OPENSSL_malloc(sizeof(*src));
 147     if (dest == NULL) {
 148         goto err;
 149     }
 150     memcpy(dest, src, sizeof(*dest));
 151
 152     /*
 153      * Set the various pointers to NULL so that we can call SSL_SESSION_free in
 154      * the case of an error whilst halfway through constructing dest
 155      */
 156     dest->ciphers = NULL;
 157 #ifndef OPENSSL_NO_TLSEXT
 158     dest->tlsext_hostname = NULL;
 159     dest->tlsext_tick = NULL;
 160 #endif
 161     memset(&dest->ex_data, 0, sizeof(dest->ex_data));
 162
 163     /* We deliberately don't copy the prev and next pointers */
 164     dest->prev = NULL;
 165     dest->next = NULL;
 166
 167     dest->references = 1;
 168
 169     if (src->sess_cert != NULL)
 170         CRYPTO_add(&src->sess_cert->references, 1, CRYPTO_LOCK_SSL_SESS_CERT);
 171
 172     if (src->peer != NULL)
 173         CRYPTO_add(&src->peer->references, 1, CRYPTO_LOCK_X509);
 174
 175     if(src->ciphers != NULL) {
 176         dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
 177         if (dest->ciphers == NULL)
 178             goto err;
 179     }
 180
 181     if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
 182                                             &dest->ex_data, &src->ex_data)) {
 183         goto err;
 184     }
 185
 186 #ifndef OPENSSL_NO_TLSEXT
 187     if (src->tlsext_hostname) {
 188         dest->tlsext_hostname = BUF_strdup(src->tlsext_hostname);
 189         if (dest->tlsext_hostname == NULL) {
 190             goto err;
 191         }
 192     }
 193
 194     if (ticket != 0) {
 195         dest->tlsext_tick = BUF_memdup(src->tlsext_tick, src->tlsext_ticklen);
 196         if(dest->tlsext_tick == NULL)
 197             goto err;
 198     } else {
 199         dest->tlsext_tick_lifetime_hint = 0;
 200         dest->tlsext_ticklen = 0;
 201     }
 202 #endif
 203
 204     return dest;
 205 err:
 206     SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
 207     SSL_SESSION_free(dest);
 208     return NULL;
 209 }
 210
 211 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
 212                                         unsigned int *len)
 213 {
 214     if (len)
 215         *len = s->session_id_length;
 216     return s->session_id;
 217 }
 218
 219 /*
 220  * Even with SSLv2, we have 16 bytes (128 bits) of session ID space.
 221  * SSLv3/TLSv1 has 32 bytes (256 bits). As such, filling the ID with random
 222  * gunk repeatedly until we have no conflict is going to complete in one
 223  * iteration pretty much "most" of the time (btw: understatement). So, if it
 224  * takes us 10 iterations and we still can't avoid a conflict - well that's a
 225  * reasonable point to call it quits. Either the RAND code is broken or
 226  * someone is trying to open roughly very close to 2^128 (or 2^256) SSL
 227  * sessions to our server. How you might store that many sessions is perhaps
 228  * a more interesting question ...
 229  */
 230
 231 #define MAX_SESS_ID_ATTEMPTS 10
 232 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
 233                                    unsigned int *id_len)
 234 {
 235     unsigned int retry = 0;
 236     do
 237         if (RAND_pseudo_bytes(id, *id_len) <= 0)
 238             return 0;
 239     while (SSL_has_matching_session_id(ssl, id, *id_len) &&
 240            (++retry < MAX_SESS_ID_ATTEMPTS)) ;
 241     if (retry < MAX_SESS_ID_ATTEMPTS)
 242         return 1;
 243     /* else - woops a session_id match */
 244     /*
 245      * XXX We should also check the external cache -- but the probability of
 246      * a collision is negligible, and we could not prevent the concurrent
 247      * creation of sessions with identical IDs since we currently don't have
 248      * means to atomically check whether a session ID already exists and make
 249      * a reservation for it if it does not (this problem applies to the
 250      * internal cache as well).
 251      */
 252     return 0;
 253 }
 254
 255 int ssl_get_new_session(SSL *s, int session)
 256 {
 257     /* This gets used by clients and servers. */
 258
 259     unsigned int tmp;
 260     SSL_SESSION *ss = NULL;
 261     GEN_SESSION_CB cb = def_generate_session_id;
 262
 263     if ((ss = SSL_SESSION_new()) == NULL)
 264         return (0);
 265
 266     /* If the context has a default timeout, use it */
 267     if (s->ctx->session_timeout == 0)
 268         ss->timeout = SSL_get_default_timeout(s);
 269     else
 270         ss->timeout = s->ctx->session_timeout;
 271
 272     if (s->session != NULL) {
 273         SSL_SESSION_free(s->session);
 274         s->session = NULL;
 275     }
 276
 277     if (session) {
 278         if (s->version == SSL2_VERSION) {
 279             ss->ssl_version = SSL2_VERSION;
 280             ss->session_id_length = SSL2_SSL_SESSION_ID_LENGTH;
 281         } else if (s->version == SSL3_VERSION) {
 282             ss->ssl_version = SSL3_VERSION;
 283             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 284         } else if (s->version == TLS1_VERSION) {
 285             ss->ssl_version = TLS1_VERSION;
 286             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 287         } else if (s->version == DTLS1_BAD_VER) {
 288             ss->ssl_version = DTLS1_BAD_VER;
 289             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 290         } else if (s->version == DTLS1_VERSION) {
 291             ss->ssl_version = DTLS1_VERSION;
 292             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
 293         } else {
 294             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
 295             SSL_SESSION_free(ss);
 296             return (0);
 297         }
 298 #ifndef OPENSSL_NO_TLSEXT
 299         /* If RFC4507 ticket use empty session ID */
 300         if (s->tlsext_ticket_expected) {
 301             ss->session_id_length = 0;
 302             goto sess_id_done;
 303         }
 304 #endif
 305         /* Choose which callback will set the session ID */
 306         CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 307         if (s->generate_session_id)
 308             cb = s->generate_session_id;
 309         else if (s->ctx->generate_session_id)
 310             cb = s->ctx->generate_session_id;
 311         CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 312         /* Choose a session ID */
 313         tmp = ss->session_id_length;
 314         if (!cb(s, ss->session_id, &tmp)) {
 315             /* The callback failed */
 316             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 317                    SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
 318             SSL_SESSION_free(ss);
 319             return (0);
 320         }
 321         /*
 322          * Don't allow the callback to set the session length to zero. nor
 323          * set it higher than it was.
 324          */
 325         if (!tmp || (tmp > ss->session_id_length)) {
 326             /* The callback set an illegal length */
 327             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
 328                    SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
 329             SSL_SESSION_free(ss);
 330             return (0);
 331         }
 332         /* If the session length was shrunk and we're SSLv2, pad it */
 333         if ((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
 334             memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
 335         else
 336             ss->session_id_length = tmp;
 337         /* Finally, check for a conflict */
 338         if (SSL_has_matching_session_id(s, ss->session_id,
 339                                         ss->session_id_length)) {
 340             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
 341             SSL_SESSION_free(ss);
 342             return (0);
 343         }
 344 #ifndef OPENSSL_NO_TLSEXT
 345  sess_id_done:
 346         if (s->tlsext_hostname) {
 347             ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
 348             if (ss->tlsext_hostname == NULL) {
 349                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 350                 SSL_SESSION_free(ss);
 351                 return 0;
 352             }
 353         }
 354 #endif
 355     } else {
 356         ss->session_id_length = 0;
 357     }
 358
 359     if (s->sid_ctx_length > sizeof ss->sid_ctx) {
 360         SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
 361         SSL_SESSION_free(ss);
 362         return 0;
 363     }
 364     memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
 365     ss->sid_ctx_length = s->sid_ctx_length;
 366     s->session = ss;
 367     ss->ssl_version = s->version;
 368     ss->verify_result = X509_V_OK;
 369
 370     return (1);
 371 }
 372
 373 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
 374                          const unsigned char *limit)
 375 {
 376     /* This is used only by servers. */
 377
 378     SSL_SESSION *ret = NULL;
 379     int fatal = 0;
 380 #ifndef OPENSSL_NO_TLSEXT
 381     int r;
 382 #endif
 383
 384     if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
 385         goto err;
 386
 387     if (session_id + len > limit) {
 388         fatal = 1;
 389         goto err;
 390     }
 391
 392 #ifndef OPENSSL_NO_TLSEXT
 393     r = tls1_process_ticket(s, session_id, len, limit, &ret);
 394     if (r == -1) {
 395         fatal = 1;
 396         goto err;
 397     } else if (r == 0 || (!ret && !len))
 398         goto err;
 399     else if (!ret
 400              && !(s->session_ctx->session_cache_mode &
 401                   SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 402 #else
 403     if (len == 0)
 404         goto err;
 405     if (!(s->ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 406 #endif
 407     {
 408         SSL_SESSION data;
 409         data.ssl_version = s->version;
 410         data.session_id_length = len;
 411         if (len == 0)
 412             return 0;
 413         memcpy(data.session_id, session_id, len);
 414         CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 415         ret = (SSL_SESSION *)lh_retrieve(s->ctx->sessions, &data);
 416         if (ret != NULL)
 417             /* don't allow other threads to steal it: */
 418             CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 419         CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 420     }
 421
 422     if (ret == NULL) {
 423         int copy = 1;
 424
 425         s->ctx->stats.sess_miss++;
 426         ret = NULL;
 427         if (s->ctx->get_session_cb != NULL
 428             && (ret = s->ctx->get_session_cb(s, session_id, len, &copy))
 429             != NULL) {
 430             s->ctx->stats.sess_cb_hit++;
 431
 432             /*
 433              * Increment reference count now if the session callback asks us
 434              * to do so (note that if the session structures returned by the
 435              * callback are shared between threads, it must handle the
 436              * reference count itself [i.e. copy == 0], or things won't be
 437              * thread-safe).
 438              */
 439             if (copy)
 440                 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 441
 442             /*
 443              * Add the externally cached session to the internal cache as
 444              * well if and only if we are supposed to.
 445              */
 446             if (!
 447                 (s->
 448                  ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
 449                 /*
 450                  * The following should not return 1, otherwise, things are
 451                  * very strange
 452                  */
 453                 SSL_CTX_add_session(s->ctx, ret);
 454         }
 455         if (ret == NULL)
 456             goto err;
 457     }
 458
 459     /* Now ret is non-NULL, and we own one of its reference counts. */
 460
 461     if (ret->sid_ctx_length != s->sid_ctx_length
 462         || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
 463         /*
 464          * We've found the session named by the client, but we don't want to
 465          * use it in this context.
 466          */
 467
 468 #if 0                           /* The client cannot always know when a
 469                                  * session is not appropriate, so we
 470                                  * shouldn't generate an error message. */
 471
 472         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
 473                SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
 474 #endif
 475         goto err;               /* treat like cache miss */
 476     }
 477
 478     if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
 479         /*
 480          * We can't be sure if this session is being used out of context,
 481          * which is especially important for SSL_VERIFY_PEER. The application
 482          * should have used SSL[_CTX]_set_session_id_context. For this error
 483          * case, we generate an error instead of treating the event like a
 484          * cache miss (otherwise it would be easy for applications to
 485          * effectively disable the session cache by accident without anyone
 486          * noticing).
 487          */
 488
 489         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
 490                SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 491         fatal = 1;
 492         goto err;
 493     }
 494
 495     if (ret->cipher == NULL) {
 496         unsigned char buf[5], *p;
 497         unsigned long l;
 498
 499         p = buf;
 500         l = ret->cipher_id;
 501         l2n(l, p);
 502         if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
 503             ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
 504         else
 505             ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
 506         if (ret->cipher == NULL)
 507             goto err;
 508     }
 509 #if 0                           /* This is way too late. */
 510
 511     /*
 512      * If a thread got the session, then 'swaped', and another got it and
 513      * then due to a time-out decided to 'OPENSSL_free' it we could be in
 514      * trouble.  So I'll increment it now, then double decrement later - am I
 515      * speaking rubbish?.
 516      */
 517     CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 518 #endif
 519
 520     if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
 521         s->ctx->stats.sess_timeout++;
 522         /* remove it from the cache */
 523         SSL_CTX_remove_session(s->ctx, ret);
 524         goto err;
 525     }
 526
 527     s->ctx->stats.sess_hit++;
 528
 529     /*- ret->time=time(NULL); *//*
 530      * rezero timeout?
 531      */
 532     /*
 533      * again, just leave the session if it is the same session, we have just
 534      * incremented and then decremented the reference count :-)
 535      */
 536     if (s->session != NULL)
 537         SSL_SESSION_free(s->session);
 538     s->session = ret;
 539     s->verify_result = s->session->verify_result;
 540     return (1);
 541
 542  err:
 543     if (ret != NULL)
 544         SSL_SESSION_free(ret);
 545     if (fatal)
 546         return -1;
 547     else
 548         return 0;
 549 }
 550
 551 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 552 {
 553     int ret = 0;
 554     SSL_SESSION *s;
 555
 556     /*
 557      * add just 1 reference count for the SSL_CTX's session cache even though
 558      * it has two ways of access: each session is in a doubly linked list and
 559      * an lhash
 560      */
 561     CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
 562     /*
 563      * if session c is in already in cache, we take back the increment later
 564      */
 565
 566     CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 567     s = (SSL_SESSION *)lh_insert(ctx->sessions, c);
 568
 569     /*
 570      * s != NULL iff we already had a session with the given PID. In this
 571      * case, s == c should hold (then we did not really modify
 572      * ctx->sessions), or we're in trouble.
 573      */
 574     if (s != NULL && s != c) {
 575         /* We *are* in trouble ... */
 576         SSL_SESSION_list_remove(ctx, s);
 577         SSL_SESSION_free(s);
 578         /*
 579          * ... so pretend the other session did not exist in cache (we cannot
 580          * handle two SSL_SESSION structures with identical session ID in the
 581          * same cache, which could happen e.g. when two threads concurrently
 582          * obtain the same session from an external cache)
 583          */
 584         s = NULL;
 585     }
 586
 587     /* Put at the head of the queue unless it is already in the cache */
 588     if (s == NULL)
 589         SSL_SESSION_list_add(ctx, c);
 590
 591     if (s != NULL) {
 592         /*
 593          * existing cache entry -- decrement previously incremented reference
 594          * count because it already takes into account the cache
 595          */
 596
 597         SSL_SESSION_free(s);    /* s == c */
 598         ret = 0;
 599     } else {
 600         /*
 601          * new cache entry -- remove old ones if cache has become too large
 602          */
 603
 604         ret = 1;
 605
 606         if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
 607             while (SSL_CTX_sess_number(ctx) >
 608                    SSL_CTX_sess_get_cache_size(ctx)) {
 609                 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
 610                     break;
 611                 else
 612                     ctx->stats.sess_cache_full++;
 613             }
 614         }
 615     }
 616     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 617     return (ret);
 618 }
 619
 620 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 621 {
 622     return remove_session_lock(ctx, c, 1);
 623 }
 624
 625 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 626 {
 627     SSL_SESSION *r;
 628     int ret = 0;
 629
 630     if ((c != NULL) && (c->session_id_length != 0)) {
 631         if (lck)
 632             CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 633         if ((r = (SSL_SESSION *)lh_retrieve(ctx->sessions, c)) == c) {
 634             ret = 1;
 635             r = (SSL_SESSION *)lh_delete(ctx->sessions, c);
 636             SSL_SESSION_list_remove(ctx, c);
 637         }
 638
 639         if (lck)
 640             CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 641
 642         if (ret) {
 643             r->not_resumable = 1;
 644             if (ctx->remove_session_cb != NULL)
 645                 ctx->remove_session_cb(ctx, r);
 646             SSL_SESSION_free(r);
 647         }
 648     } else
 649         ret = 0;
 650     return (ret);
 651 }
 652
 653 void SSL_SESSION_free(SSL_SESSION *ss)
 654 {
 655     int i;
 656
 657     if (ss == NULL)
 658         return;
 659
 660     i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
 661 #ifdef REF_PRINT
 662     REF_PRINT("SSL_SESSION", ss);
 663 #endif
 664     if (i > 0)
 665         return;
 666 #ifdef REF_CHECK
 667     if (i < 0) {
 668         fprintf(stderr, "SSL_SESSION_free, bad reference count\n");
 669         abort();                /* ok */
 670     }
 671 #endif
 672
 673     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 674
 675     OPENSSL_cleanse(ss->key_arg, sizeof ss->key_arg);
 676     OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
 677     OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
 678     if (ss->sess_cert != NULL)
 679         ssl_sess_cert_free(ss->sess_cert);
 680     if (ss->peer != NULL)
 681         X509_free(ss->peer);
 682     if (ss->ciphers != NULL)
 683         sk_SSL_CIPHER_free(ss->ciphers);
 684 #ifndef OPENSSL_NO_TLSEXT
 685     if (ss->tlsext_hostname != NULL)
 686         OPENSSL_free(ss->tlsext_hostname);
 687     if (ss->tlsext_tick != NULL)
 688         OPENSSL_free(ss->tlsext_tick);
 689 #endif
 690     OPENSSL_cleanse(ss, sizeof(*ss));
 691     OPENSSL_free(ss);
 692 }
 693
 694 int SSL_set_session(SSL *s, SSL_SESSION *session)
 695 {
 696     int ret = 0;
 697     SSL_METHOD *meth;
 698
 699     if (session != NULL) {
 700         meth = s->ctx->method->get_ssl_method(session->ssl_version);
 701         if (meth == NULL)
 702             meth = s->method->get_ssl_method(session->ssl_version);
 703         if (meth == NULL) {
 704             SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
 705             return (0);
 706         }
 707
 708         if (meth != s->method) {
 709             if (!SSL_set_ssl_method(s, meth))
 710                 return (0);
 711             if (s->ctx->session_timeout == 0)
 712                 session->timeout = SSL_get_default_timeout(s);
 713             else
 714                 session->timeout = s->ctx->session_timeout;
 715         }
 716 #ifndef OPENSSL_NO_KRB5
 717         if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
 718             session->krb5_client_princ_len > 0) {
 719             s->kssl_ctx->client_princ =
 720                 (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
 721             memcpy(s->kssl_ctx->client_princ, session->krb5_client_princ,
 722                    session->krb5_client_princ_len);
 723             s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
 724         }
 725 #endif                          /* OPENSSL_NO_KRB5 */
 726
 727         /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
 728         CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
 729         if (s->session != NULL)
 730             SSL_SESSION_free(s->session);
 731         s->session = session;
 732         s->verify_result = s->session->verify_result;
 733         /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
 734         ret = 1;
 735     } else {
 736         if (s->session != NULL) {
 737             SSL_SESSION_free(s->session);
 738             s->session = NULL;
 739         }
 740
 741         meth = s->ctx->method;
 742         if (meth != s->method) {
 743             if (!SSL_set_ssl_method(s, meth))
 744                 return (0);
 745         }
 746         ret = 1;
 747     }
 748     return (ret);
 749 }
 750
 751 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 752 {
 753     if (s == NULL)
 754         return (0);
 755     s->timeout = t;
 756     return (1);
 757 }
 758
 759 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 760 {
 761     if (s == NULL)
 762         return (0);
 763     return (s->timeout);
 764 }
 765
 766 long SSL_SESSION_get_time(const SSL_SESSION *s)
 767 {
 768     if (s == NULL)
 769         return (0);
 770     return (s->time);
 771 }
 772
 773 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 774 {
 775     if (s == NULL)
 776         return (0);
 777     s->time = t;
 778     return (t);
 779 }
 780
 781 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 782 {
 783     long l;
 784     if (s == NULL)
 785         return (0);
 786     l = s->session_timeout;
 787     s->session_timeout = t;
 788     return (l);
 789 }
 790
 791 long SSL_CTX_get_timeout(const SSL_CTX *s)
 792 {
 793     if (s == NULL)
 794         return (0);
 795     return (s->session_timeout);
 796 }
 797
 798 typedef struct timeout_param_st {
 799     SSL_CTX *ctx;
 800     long time;
 801     LHASH *cache;
 802 } TIMEOUT_PARAM;
 803
 804 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
 805 {
 806     if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
 807         /*
 808          * The reason we don't call SSL_CTX_remove_session() is to save on
 809          * locking overhead
 810          */
 811         lh_delete(p->cache, s);
 812         SSL_SESSION_list_remove(p->ctx, s);
 813         s->not_resumable = 1;
 814         if (p->ctx->remove_session_cb != NULL)
 815             p->ctx->remove_session_cb(p->ctx, s);
 816         SSL_SESSION_free(s);
 817     }
 818 }
 819
 820 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION *, TIMEOUT_PARAM *)
 821
 822 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 823 {
 824     unsigned long i;
 825     TIMEOUT_PARAM tp;
 826
 827     tp.ctx = s;
 828     tp.cache = s->sessions;
 829     if (tp.cache == NULL)
 830         return;
 831     tp.time = t;
 832     CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 833     i = tp.cache->down_load;
 834     tp.cache->down_load = 0;
 835     lh_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout), &tp);
 836     tp.cache->down_load = i;
 837     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 838 }
 839
 840 int ssl_clear_bad_session(SSL *s)
 841 {
 842     if ((s->session != NULL) &&
 843         !(s->shutdown & SSL_SENT_SHUTDOWN) &&
 844         !(SSL_in_init(s) || SSL_in_before(s))) {
 845         SSL_CTX_remove_session(s->ctx, s->session);
 846         return (1);
 847     } else
 848         return (0);
 849 }
 850
 851 /* locked by SSL_CTX in the calling function */
 852 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
 853 {
 854     if ((s->next == NULL) || (s->prev == NULL))
 855         return;
 856
 857     if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
 858         /* last element in list */
 859         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
 860             /* only one element in list */
 861             ctx->session_cache_head = NULL;
 862             ctx->session_cache_tail = NULL;
 863         } else {
 864             ctx->session_cache_tail = s->prev;
 865             s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
 866         }
 867     } else {
 868         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
 869             /* first element in list */
 870             ctx->session_cache_head = s->next;
 871             s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
 872         } else {
 873             /* middle of list */
 874             s->next->prev = s->prev;
 875             s->prev->next = s->next;
 876         }
 877     }
 878     s->prev = s->next = NULL;
 879 }
 880
 881 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
 882 {
 883     if ((s->next != NULL) && (s->prev != NULL))
 884         SSL_SESSION_list_remove(ctx, s);
 885
 886     if (ctx->session_cache_head == NULL) {
 887         ctx->session_cache_head = s;
 888         ctx->session_cache_tail = s;
 889         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
 890         s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
 891     } else {
 892         s->next = ctx->session_cache_head;
 893         s->next->prev = s;
 894         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
 895         ctx->session_cache_head = s;
 896     }
 897 }
 898
 899 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
 900                              int (*cb) (struct ssl_st *ssl,
 901                                         SSL_SESSION *sess))
 902 {
 903     ctx->new_session_cb = cb;
 904 }
 905
 906 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
 907     return ctx->new_session_cb;
 908 }
 909
 910 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
 911                                 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
 912 {
 913     ctx->remove_session_cb = cb;
 914 }
 915
 916 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
 917                                                   SSL_SESSION *sess) {
 918     return ctx->remove_session_cb;
 919 }
 920
 921 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
 922                              SSL_SESSION *(*cb) (struct ssl_st *ssl,
 923                                                  unsigned char *data, int len,
 924                                                  int *copy))
 925 {
 926     ctx->get_session_cb = cb;
 927 }
 928
 929 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
 930                                                        unsigned char *data,
 931                                                        int len, int *copy) {
 932     return ctx->get_session_cb;
 933 }
 934
 935 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
 936                                void (*cb) (const SSL *ssl, int type, int val))
 937 {
 938     ctx->info_callback = cb;
 939 }
 940
 941 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
 942                                                  int val) {
 943     return ctx->info_callback;
 944 }
 945
 946 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
 947                                 int (*cb) (SSL *ssl, X509 **x509,
 948                                            EVP_PKEY **pkey))
 949 {
 950     ctx->client_cert_cb = cb;
 951 }
 952
 953 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
 954                                                  EVP_PKEY **pkey) {
 955     return ctx->client_cert_cb;
 956 }
 957
 958 #ifndef OPENSSL_NO_ENGINE
 959 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
 960 {
 961     if (!ENGINE_init(e)) {
 962         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
 963         return 0;
 964     }
 965     if (!ENGINE_get_ssl_client_cert_function(e)) {
 966         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
 967                SSL_R_NO_CLIENT_CERT_METHOD);
 968         ENGINE_finish(e);
 969         return 0;
 970     }
 971     ctx->client_cert_engine = e;
 972     return 1;
 973 }
 974 #endif
 975
 976 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
 977                                     int (*cb) (SSL *ssl,
 978                                                unsigned char *cookie,
 979                                                unsigned int *cookie_len))
 980 {
 981     ctx->app_gen_cookie_cb = cb;
 982 }
 983
 984 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
 985                                   int (*cb) (SSL *ssl, unsigned char *cookie,
 986                                              unsigned int cookie_len))
 987 {
 988     ctx->app_verify_cookie_cb = cb;
 989 }