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