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 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->session_ctx->session_cache_mode &
 322                   SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 323 #else
 324     if (len == 0)
 325         goto err;
 326     if (!(s->ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
 327 #endif
 328     {
 329         SSL_SESSION data;
 330         data.ssl_version = s->version;
 331         data.session_id_length = len;
 332         if (len == 0)
 333             return 0;
 334         memcpy(data.session_id, session_id, len);
 335         CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
 336         ret = (SSL_SESSION *)lh_retrieve(s->ctx->sessions, &data);
 337         if (ret != NULL)
 338             /* don't allow other threads to steal it: */
 339             CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 340         CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
 341     }
 342
 343     if (ret == NULL) {
 344         int copy = 1;
 345
 346         s->ctx->stats.sess_miss++;
 347         ret = NULL;
 348         if (s->ctx->get_session_cb != NULL
 349             && (ret = s->ctx->get_session_cb(s, session_id, len, &copy))
 350             != NULL) {
 351             s->ctx->stats.sess_cb_hit++;
 352
 353             /*
 354              * Increment reference count now if the session callback asks us
 355              * to do so (note that if the session structures returned by the
 356              * callback are shared between threads, it must handle the
 357              * reference count itself [i.e. copy == 0], or things won't be
 358              * thread-safe).
 359              */
 360             if (copy)
 361                 CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 362
 363             /*
 364              * Add the externally cached session to the internal cache as
 365              * well if and only if we are supposed to.
 366              */
 367             if (!
 368                 (s->
 369                  ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
 370                 /*
 371                  * The following should not return 1, otherwise, things are
 372                  * very strange
 373                  */
 374                 SSL_CTX_add_session(s->ctx, ret);
 375         }
 376         if (ret == NULL)
 377             goto err;
 378     }
 379
 380     /* Now ret is non-NULL, and we own one of its reference counts. */
 381
 382     if (ret->sid_ctx_length != s->sid_ctx_length
 383         || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
 384         /*
 385          * We've found the session named by the client, but we don't want to
 386          * use it in this context.
 387          */
 388
 389 #if 0                           /* The client cannot always know when a
 390                                  * session is not appropriate, so we
 391                                  * shouldn't generate an error message. */
 392
 393         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
 394                SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
 395 #endif
 396         goto err;               /* treat like cache miss */
 397     }
 398
 399     if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
 400         /*
 401          * We can't be sure if this session is being used out of context,
 402          * which is especially important for SSL_VERIFY_PEER. The application
 403          * should have used SSL[_CTX]_set_session_id_context. For this error
 404          * case, we generate an error instead of treating the event like a
 405          * cache miss (otherwise it would be easy for applications to
 406          * effectively disable the session cache by accident without anyone
 407          * noticing).
 408          */
 409
 410         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
 411                SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
 412         fatal = 1;
 413         goto err;
 414     }
 415
 416     if (ret->cipher == NULL) {
 417         unsigned char buf[5], *p;
 418         unsigned long l;
 419
 420         p = buf;
 421         l = ret->cipher_id;
 422         l2n(l, p);
 423         if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
 424             ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
 425         else
 426             ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
 427         if (ret->cipher == NULL)
 428             goto err;
 429     }
 430 #if 0                           /* This is way too late. */
 431
 432     /*
 433      * If a thread got the session, then 'swaped', and another got it and
 434      * then due to a time-out decided to 'OPENSSL_free' it we could be in
 435      * trouble.  So I'll increment it now, then double decrement later - am I
 436      * speaking rubbish?.
 437      */
 438     CRYPTO_add(&ret->references, 1, CRYPTO_LOCK_SSL_SESSION);
 439 #endif
 440
 441     if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
 442         s->ctx->stats.sess_timeout++;
 443         /* remove it from the cache */
 444         SSL_CTX_remove_session(s->ctx, ret);
 445         goto err;
 446     }
 447
 448     s->ctx->stats.sess_hit++;
 449
 450     /*- ret->time=time(NULL); *//*
 451      * rezero timeout?
 452      */
 453     /*
 454      * again, just leave the session if it is the same session, we have just
 455      * incremented and then decremented the reference count :-)
 456      */
 457     if (s->session != NULL)
 458         SSL_SESSION_free(s->session);
 459     s->session = ret;
 460     s->verify_result = s->session->verify_result;
 461     return (1);
 462
 463  err:
 464     if (ret != NULL)
 465         SSL_SESSION_free(ret);
 466     if (fatal)
 467         return -1;
 468     else
 469         return 0;
 470 }
 471
 472 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
 473 {
 474     int ret = 0;
 475     SSL_SESSION *s;
 476
 477     /*
 478      * add just 1 reference count for the SSL_CTX's session cache even though
 479      * it has two ways of access: each session is in a doubly linked list and
 480      * an lhash
 481      */
 482     CRYPTO_add(&c->references, 1, CRYPTO_LOCK_SSL_SESSION);
 483     /*
 484      * if session c is in already in cache, we take back the increment later
 485      */
 486
 487     CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 488     s = (SSL_SESSION *)lh_insert(ctx->sessions, c);
 489
 490     /*
 491      * s != NULL iff we already had a session with the given PID. In this
 492      * case, s == c should hold (then we did not really modify
 493      * ctx->sessions), or we're in trouble.
 494      */
 495     if (s != NULL && s != c) {
 496         /* We *are* in trouble ... */
 497         SSL_SESSION_list_remove(ctx, s);
 498         SSL_SESSION_free(s);
 499         /*
 500          * ... so pretend the other session did not exist in cache (we cannot
 501          * handle two SSL_SESSION structures with identical session ID in the
 502          * same cache, which could happen e.g. when two threads concurrently
 503          * obtain the same session from an external cache)
 504          */
 505         s = NULL;
 506     }
 507
 508     /* Put at the head of the queue unless it is already in the cache */
 509     if (s == NULL)
 510         SSL_SESSION_list_add(ctx, c);
 511
 512     if (s != NULL) {
 513         /*
 514          * existing cache entry -- decrement previously incremented reference
 515          * count because it already takes into account the cache
 516          */
 517
 518         SSL_SESSION_free(s);    /* s == c */
 519         ret = 0;
 520     } else {
 521         /*
 522          * new cache entry -- remove old ones if cache has become too large
 523          */
 524
 525         ret = 1;
 526
 527         if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
 528             while (SSL_CTX_sess_number(ctx) >
 529                    SSL_CTX_sess_get_cache_size(ctx)) {
 530                 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
 531                     break;
 532                 else
 533                     ctx->stats.sess_cache_full++;
 534             }
 535         }
 536     }
 537     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 538     return (ret);
 539 }
 540
 541 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
 542 {
 543     return remove_session_lock(ctx, c, 1);
 544 }
 545
 546 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
 547 {
 548     SSL_SESSION *r;
 549     int ret = 0;
 550
 551     if ((c != NULL) && (c->session_id_length != 0)) {
 552         if (lck)
 553             CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 554         if ((r = (SSL_SESSION *)lh_retrieve(ctx->sessions, c)) == c) {
 555             ret = 1;
 556             r = (SSL_SESSION *)lh_delete(ctx->sessions, c);
 557             SSL_SESSION_list_remove(ctx, c);
 558         }
 559
 560         if (lck)
 561             CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 562
 563         if (ret) {
 564             r->not_resumable = 1;
 565             if (ctx->remove_session_cb != NULL)
 566                 ctx->remove_session_cb(ctx, r);
 567             SSL_SESSION_free(r);
 568         }
 569     } else
 570         ret = 0;
 571     return (ret);
 572 }
 573
 574 void SSL_SESSION_free(SSL_SESSION *ss)
 575 {
 576     int i;
 577
 578     if (ss == NULL)
 579         return;
 580
 581     i = CRYPTO_add(&ss->references, -1, CRYPTO_LOCK_SSL_SESSION);
 582 #ifdef REF_PRINT
 583     REF_PRINT("SSL_SESSION", ss);
 584 #endif
 585     if (i > 0)
 586         return;
 587 #ifdef REF_CHECK
 588     if (i < 0) {
 589         fprintf(stderr, "SSL_SESSION_free, bad reference count\n");
 590         abort();                /* ok */
 591     }
 592 #endif
 593
 594     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
 595
 596     OPENSSL_cleanse(ss->key_arg, sizeof ss->key_arg);
 597     OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
 598     OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
 599     if (ss->sess_cert != NULL)
 600         ssl_sess_cert_free(ss->sess_cert);
 601     if (ss->peer != NULL)
 602         X509_free(ss->peer);
 603     if (ss->ciphers != NULL)
 604         sk_SSL_CIPHER_free(ss->ciphers);
 605 #ifndef OPENSSL_NO_TLSEXT
 606     if (ss->tlsext_hostname != NULL)
 607         OPENSSL_free(ss->tlsext_hostname);
 608     if (ss->tlsext_tick != NULL)
 609         OPENSSL_free(ss->tlsext_tick);
 610 #endif
 611     OPENSSL_cleanse(ss, sizeof(*ss));
 612     OPENSSL_free(ss);
 613 }
 614
 615 int SSL_set_session(SSL *s, SSL_SESSION *session)
 616 {
 617     int ret = 0;
 618     SSL_METHOD *meth;
 619
 620     if (session != NULL) {
 621         meth = s->ctx->method->get_ssl_method(session->ssl_version);
 622         if (meth == NULL)
 623             meth = s->method->get_ssl_method(session->ssl_version);
 624         if (meth == NULL) {
 625             SSLerr(SSL_F_SSL_SET_SESSION, SSL_R_UNABLE_TO_FIND_SSL_METHOD);
 626             return (0);
 627         }
 628
 629         if (meth != s->method) {
 630             if (!SSL_set_ssl_method(s, meth))
 631                 return (0);
 632             if (s->ctx->session_timeout == 0)
 633                 session->timeout = SSL_get_default_timeout(s);
 634             else
 635                 session->timeout = s->ctx->session_timeout;
 636         }
 637 #ifndef OPENSSL_NO_KRB5
 638         if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
 639             session->krb5_client_princ_len > 0) {
 640             s->kssl_ctx->client_princ =
 641                 (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
 642             memcpy(s->kssl_ctx->client_princ, session->krb5_client_princ,
 643                    session->krb5_client_princ_len);
 644             s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
 645         }
 646 #endif                          /* OPENSSL_NO_KRB5 */
 647
 648         /* CRYPTO_w_lock(CRYPTO_LOCK_SSL); */
 649         CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
 650         if (s->session != NULL)
 651             SSL_SESSION_free(s->session);
 652         s->session = session;
 653         s->verify_result = s->session->verify_result;
 654         /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL); */
 655         ret = 1;
 656     } else {
 657         if (s->session != NULL) {
 658             SSL_SESSION_free(s->session);
 659             s->session = NULL;
 660         }
 661
 662         meth = s->ctx->method;
 663         if (meth != s->method) {
 664             if (!SSL_set_ssl_method(s, meth))
 665                 return (0);
 666         }
 667         ret = 1;
 668     }
 669     return (ret);
 670 }
 671
 672 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
 673 {
 674     if (s == NULL)
 675         return (0);
 676     s->timeout = t;
 677     return (1);
 678 }
 679
 680 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
 681 {
 682     if (s == NULL)
 683         return (0);
 684     return (s->timeout);
 685 }
 686
 687 long SSL_SESSION_get_time(const SSL_SESSION *s)
 688 {
 689     if (s == NULL)
 690         return (0);
 691     return (s->time);
 692 }
 693
 694 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
 695 {
 696     if (s == NULL)
 697         return (0);
 698     s->time = t;
 699     return (t);
 700 }
 701
 702 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
 703 {
 704     long l;
 705     if (s == NULL)
 706         return (0);
 707     l = s->session_timeout;
 708     s->session_timeout = t;
 709     return (l);
 710 }
 711
 712 long SSL_CTX_get_timeout(const SSL_CTX *s)
 713 {
 714     if (s == NULL)
 715         return (0);
 716     return (s->session_timeout);
 717 }
 718
 719 typedef struct timeout_param_st {
 720     SSL_CTX *ctx;
 721     long time;
 722     LHASH *cache;
 723 } TIMEOUT_PARAM;
 724
 725 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
 726 {
 727     if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
 728         /*
 729          * The reason we don't call SSL_CTX_remove_session() is to save on
 730          * locking overhead
 731          */
 732         lh_delete(p->cache, s);
 733         SSL_SESSION_list_remove(p->ctx, s);
 734         s->not_resumable = 1;
 735         if (p->ctx->remove_session_cb != NULL)
 736             p->ctx->remove_session_cb(p->ctx, s);
 737         SSL_SESSION_free(s);
 738     }
 739 }
 740
 741 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION *, TIMEOUT_PARAM *)
 742
 743 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
 744 {
 745     unsigned long i;
 746     TIMEOUT_PARAM tp;
 747
 748     tp.ctx = s;
 749     tp.cache = s->sessions;
 750     if (tp.cache == NULL)
 751         return;
 752     tp.time = t;
 753     CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
 754     i = tp.cache->down_load;
 755     tp.cache->down_load = 0;
 756     lh_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout), &tp);
 757     tp.cache->down_load = i;
 758     CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
 759 }
 760
 761 int ssl_clear_bad_session(SSL *s)
 762 {
 763     if ((s->session != NULL) &&
 764         !(s->shutdown & SSL_SENT_SHUTDOWN) &&
 765         !(SSL_in_init(s) || SSL_in_before(s))) {
 766         SSL_CTX_remove_session(s->ctx, s->session);
 767         return (1);
 768     } else
 769         return (0);
 770 }
 771
 772 /* locked by SSL_CTX in the calling function */
 773 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
 774 {
 775     if ((s->next == NULL) || (s->prev == NULL))
 776         return;
 777
 778     if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
 779         /* last element in list */
 780         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
 781             /* only one element in list */
 782             ctx->session_cache_head = NULL;
 783             ctx->session_cache_tail = NULL;
 784         } else {
 785             ctx->session_cache_tail = s->prev;
 786             s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
 787         }
 788     } else {
 789         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
 790             /* first element in list */
 791             ctx->session_cache_head = s->next;
 792             s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
 793         } else {
 794             /* middle of list */
 795             s->next->prev = s->prev;
 796             s->prev->next = s->next;
 797         }
 798     }
 799     s->prev = s->next = NULL;
 800 }
 801
 802 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
 803 {
 804     if ((s->next != NULL) && (s->prev != NULL))
 805         SSL_SESSION_list_remove(ctx, s);
 806
 807     if (ctx->session_cache_head == NULL) {
 808         ctx->session_cache_head = s;
 809         ctx->session_cache_tail = s;
 810         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
 811         s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
 812     } else {
 813         s->next = ctx->session_cache_head;
 814         s->next->prev = s;
 815         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
 816         ctx->session_cache_head = s;
 817     }
 818 }
 819
 820 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
 821                              int (*cb) (struct ssl_st *ssl,
 822                                         SSL_SESSION *sess))
 823 {
 824     ctx->new_session_cb = cb;
 825 }
 826
 827 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
 828     return ctx->new_session_cb;
 829 }
 830
 831 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
 832                                 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
 833 {
 834     ctx->remove_session_cb = cb;
 835 }
 836
 837 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
 838                                                   SSL_SESSION *sess) {
 839     return ctx->remove_session_cb;
 840 }
 841
 842 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
 843                              SSL_SESSION *(*cb) (struct ssl_st *ssl,
 844                                                  unsigned char *data, int len,
 845                                                  int *copy))
 846 {
 847     ctx->get_session_cb = cb;
 848 }
 849
 850 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
 851                                                        unsigned char *data,
 852                                                        int len, int *copy) {
 853     return ctx->get_session_cb;
 854 }
 855
 856 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
 857                                void (*cb) (const SSL *ssl, int type, int val))
 858 {
 859     ctx->info_callback = cb;
 860 }
 861
 862 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
 863                                                  int val) {
 864     return ctx->info_callback;
 865 }
 866
 867 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
 868                                 int (*cb) (SSL *ssl, X509 **x509,
 869                                            EVP_PKEY **pkey))
 870 {
 871     ctx->client_cert_cb = cb;
 872 }
 873
 874 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
 875                                                  EVP_PKEY **pkey) {
 876     return ctx->client_cert_cb;
 877 }
 878
 879 #ifndef OPENSSL_NO_ENGINE
 880 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
 881 {
 882     if (!ENGINE_init(e)) {
 883         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
 884         return 0;
 885     }
 886     if (!ENGINE_get_ssl_client_cert_function(e)) {
 887         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
 888                SSL_R_NO_CLIENT_CERT_METHOD);
 889         ENGINE_finish(e);
 890         return 0;
 891     }
 892     ctx->client_cert_engine = e;
 893     return 1;
 894 }
 895 #endif
 896
 897 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
 898                                     int (*cb) (SSL *ssl,
 899                                                unsigned char *cookie,
 900                                                unsigned int *cookie_len))
 901 {
 902     ctx->app_gen_cookie_cb = cb;
 903 }
 904
 905 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
 906                                   int (*cb) (SSL *ssl, unsigned char *cookie,
 907                                              unsigned int cookie_len))
 908 {
 909     ctx->app_verify_cookie_cb = cb;
 910 }