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