Fix a ssl session leak due to OOM in lh_SSL_SESSION_insert
[openssl.git] / ssl / ssl_sess.c
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /* ====================================================================
11  * Copyright 2005 Nokia. All rights reserved.
12  *
13  * The portions of the attached software ("Contribution") is developed by
14  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
15  * license.
16  *
17  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
18  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
19  * support (see RFC 4279) to OpenSSL.
20  *
21  * No patent licenses or other rights except those expressly stated in
22  * the OpenSSL open source license shall be deemed granted or received
23  * expressly, by implication, estoppel, or otherwise.
24  *
25  * No assurances are provided by Nokia that the Contribution does not
26  * infringe the patent or other intellectual property rights of any third
27  * party or that the license provides you with all the necessary rights
28  * to make use of the Contribution.
29  *
30  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
31  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
32  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
33  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
34  * OTHERWISE.
35  */
36
37 #include <stdio.h>
38 #include <openssl/lhash.h>
39 #include <openssl/rand.h>
40 #include <openssl/engine.h>
41 #include "ssl_locl.h"
42
43 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
44 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s);
45 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
46
47 SSL_SESSION *SSL_get_session(const SSL *ssl)
48 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
49 {
50     return (ssl->session);
51 }
52
53 SSL_SESSION *SSL_get1_session(SSL *ssl)
54 /* variant of SSL_get_session: caller really gets something */
55 {
56     SSL_SESSION *sess;
57     /*
58      * Need to lock this all up rather than just use CRYPTO_add so that
59      * somebody doesn't free ssl->session between when we check it's non-null
60      * and when we up the reference count.
61      */
62     CRYPTO_THREAD_read_lock(ssl->lock);
63     sess = ssl->session;
64     if (sess)
65         SSL_SESSION_up_ref(sess);
66     CRYPTO_THREAD_unlock(ssl->lock);
67     return sess;
68 }
69
70 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
71 {
72     return (CRYPTO_set_ex_data(&s->ex_data, idx, arg));
73 }
74
75 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
76 {
77     return (CRYPTO_get_ex_data(&s->ex_data, idx));
78 }
79
80 SSL_SESSION *SSL_SESSION_new(void)
81 {
82     SSL_SESSION *ss;
83
84     ss = OPENSSL_zalloc(sizeof(*ss));
85     if (ss == NULL) {
86         SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
87         return NULL;
88     }
89
90     ss->verify_result = 1;      /* avoid 0 (= X509_V_OK) just in case */
91     ss->references = 1;
92     ss->timeout = 60 * 5 + 4;   /* 5 minute timeout by default */
93     ss->time = (unsigned long)time(NULL);
94     ss->lock = CRYPTO_THREAD_lock_new();
95     if (ss->lock == NULL) {
96         SSLerr(SSL_F_SSL_SESSION_NEW, ERR_R_MALLOC_FAILURE);
97         OPENSSL_free(ss);
98         return NULL;
99     }
100
101     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data)) {
102         CRYPTO_THREAD_lock_free(ss->lock);
103         OPENSSL_free(ss);
104         return NULL;
105     }
106     return ss;
107 }
108
109 /*
110  * Create a new SSL_SESSION and duplicate the contents of |src| into it. If
111  * ticket == 0 then no ticket information is duplicated, otherwise it is.
112  */
113 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket)
114 {
115     SSL_SESSION *dest;
116
117     dest = OPENSSL_malloc(sizeof(*src));
118     if (dest == NULL) {
119         goto err;
120     }
121     memcpy(dest, src, sizeof(*dest));
122
123     /*
124      * Set the various pointers to NULL so that we can call SSL_SESSION_free in
125      * the case of an error whilst halfway through constructing dest
126      */
127 #ifndef OPENSSL_NO_PSK
128     dest->psk_identity_hint = NULL;
129     dest->psk_identity = NULL;
130 #endif
131     dest->ciphers = NULL;
132     dest->ext.hostname = NULL;
133 #ifndef OPENSSL_NO_EC
134     dest->ext.ecpointformats = NULL;
135     dest->ext.supportedgroups = NULL;
136 #endif
137     dest->ext.tick = NULL;
138 #ifndef OPENSSL_NO_SRP
139     dest->srp_username = NULL;
140 #endif
141     memset(&dest->ex_data, 0, sizeof(dest->ex_data));
142
143     /* We deliberately don't copy the prev and next pointers */
144     dest->prev = NULL;
145     dest->next = NULL;
146
147     dest->references = 1;
148
149     dest->lock = CRYPTO_THREAD_lock_new();
150     if (dest->lock == NULL)
151         goto err;
152
153     if (src->peer != NULL)
154         X509_up_ref(src->peer);
155
156     if (src->peer_chain != NULL) {
157         dest->peer_chain = X509_chain_up_ref(src->peer_chain);
158         if (dest->peer_chain == NULL)
159             goto err;
160     }
161 #ifndef OPENSSL_NO_PSK
162     if (src->psk_identity_hint) {
163         dest->psk_identity_hint = OPENSSL_strdup(src->psk_identity_hint);
164         if (dest->psk_identity_hint == NULL) {
165             goto err;
166         }
167     }
168     if (src->psk_identity) {
169         dest->psk_identity = OPENSSL_strdup(src->psk_identity);
170         if (dest->psk_identity == NULL) {
171             goto err;
172         }
173     }
174 #endif
175
176     if (src->ciphers != NULL) {
177         dest->ciphers = sk_SSL_CIPHER_dup(src->ciphers);
178         if (dest->ciphers == NULL)
179             goto err;
180     }
181
182     if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_SSL_SESSION,
183                             &dest->ex_data, &src->ex_data)) {
184         goto err;
185     }
186
187     if (src->ext.hostname) {
188         dest->ext.hostname = OPENSSL_strdup(src->ext.hostname);
189         if (dest->ext.hostname == NULL) {
190             goto err;
191         }
192     }
193 #ifndef OPENSSL_NO_EC
194     if (src->ext.ecpointformats) {
195         dest->ext.ecpointformats =
196             OPENSSL_memdup(src->ext.ecpointformats,
197                            src->ext.ecpointformats_len);
198         if (dest->ext.ecpointformats == NULL)
199             goto err;
200     }
201     if (src->ext.supportedgroups) {
202         dest->ext.supportedgroups =
203             OPENSSL_memdup(src->ext.supportedgroups,
204                            src->ext.supportedgroups_len);
205         if (dest->ext.supportedgroups == NULL)
206             goto err;
207     }
208 #endif
209
210     if (ticket != 0) {
211         dest->ext.tick =
212             OPENSSL_memdup(src->ext.tick, src->ext.ticklen);
213         if (dest->ext.tick == NULL)
214             goto err;
215     } else {
216         dest->ext.tick_lifetime_hint = 0;
217         dest->ext.ticklen = 0;
218     }
219
220 #ifndef OPENSSL_NO_SRP
221     if (src->srp_username) {
222         dest->srp_username = OPENSSL_strdup(src->srp_username);
223         if (dest->srp_username == NULL) {
224             goto err;
225         }
226     }
227 #endif
228
229     return dest;
230  err:
231     SSLerr(SSL_F_SSL_SESSION_DUP, ERR_R_MALLOC_FAILURE);
232     SSL_SESSION_free(dest);
233     return NULL;
234 }
235
236 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
237 {
238     if (len)
239         *len = (unsigned int)s->session_id_length;
240     return s->session_id;
241 }
242 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
243                                                 unsigned int *len)
244 {
245     if (len != NULL)
246         *len = (unsigned int)s->sid_ctx_length;
247     return s->sid_ctx;
248 }
249
250 unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s)
251 {
252     return s->compress_meth;
253 }
254
255 /*
256  * SSLv3/TLSv1 has 32 bytes (256 bits) of session ID space. As such, filling
257  * the ID with random junk repeatedly until we have no conflict is going to
258  * complete in one iteration pretty much "most" of the time (btw:
259  * understatement). So, if it takes us 10 iterations and we still can't avoid
260  * a conflict - well that's a reasonable point to call it quits. Either the
261  * RAND code is broken or someone is trying to open roughly very close to
262  * 2^256 SSL sessions to our server. How you might store that many sessions
263  * is perhaps a more interesting question ...
264  */
265
266 #define MAX_SESS_ID_ATTEMPTS 10
267 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
268                                    unsigned int *id_len)
269 {
270     unsigned int retry = 0;
271     do
272         if (RAND_bytes(id, *id_len) <= 0)
273             return 0;
274     while (SSL_has_matching_session_id(ssl, id, *id_len) &&
275            (++retry < MAX_SESS_ID_ATTEMPTS)) ;
276     if (retry < MAX_SESS_ID_ATTEMPTS)
277         return 1;
278     /* else - woops a session_id match */
279     /*
280      * XXX We should also check the external cache -- but the probability of
281      * a collision is negligible, and we could not prevent the concurrent
282      * creation of sessions with identical IDs since we currently don't have
283      * means to atomically check whether a session ID already exists and make
284      * a reservation for it if it does not (this problem applies to the
285      * internal cache as well).
286      */
287     return 0;
288 }
289
290 int ssl_get_new_session(SSL *s, int session)
291 {
292     /* This gets used by clients and servers. */
293
294     unsigned int tmp;
295     SSL_SESSION *ss = NULL;
296     GEN_SESSION_CB cb = def_generate_session_id;
297
298     if ((ss = SSL_SESSION_new()) == NULL)
299         return (0);
300
301     /* If the context has a default timeout, use it */
302     if (s->session_ctx->session_timeout == 0)
303         ss->timeout = SSL_get_default_timeout(s);
304     else
305         ss->timeout = s->session_ctx->session_timeout;
306
307     SSL_SESSION_free(s->session);
308     s->session = NULL;
309
310     if (session) {
311         if (s->version == SSL3_VERSION) {
312             ss->ssl_version = SSL3_VERSION;
313             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
314         } else if (s->version == TLS1_VERSION) {
315             ss->ssl_version = TLS1_VERSION;
316             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
317         } else if (s->version == TLS1_1_VERSION) {
318             ss->ssl_version = TLS1_1_VERSION;
319             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
320         } else if (s->version == TLS1_2_VERSION) {
321             ss->ssl_version = TLS1_2_VERSION;
322             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
323         } else if (s->version == TLS1_3_VERSION) {
324             ss->ssl_version = TLS1_3_VERSION;
325             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
326         } else if (s->version == DTLS1_BAD_VER) {
327             ss->ssl_version = DTLS1_BAD_VER;
328             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
329         } else if (s->version == DTLS1_VERSION) {
330             ss->ssl_version = DTLS1_VERSION;
331             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
332         } else if (s->version == DTLS1_2_VERSION) {
333             ss->ssl_version = DTLS1_2_VERSION;
334             ss->session_id_length = SSL3_SSL_SESSION_ID_LENGTH;
335         } else {
336             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
337             SSL_SESSION_free(ss);
338             return (0);
339         }
340
341         /*-
342          * If RFC5077 ticket, use empty session ID (as server).
343          * Note that:
344          * (a) ssl_get_prev_session() does lookahead into the
345          *     ClientHello extensions to find the session ticket.
346          *     When ssl_get_prev_session() fails, statem_srvr.c calls
347          *     ssl_get_new_session() in tls_process_client_hello().
348          *     At that point, it has not yet parsed the extensions,
349          *     however, because of the lookahead, it already knows
350          *     whether a ticket is expected or not.
351          *
352          * (b) statem_clnt.c calls ssl_get_new_session() before parsing
353          *     ServerHello extensions, and before recording the session
354          *     ID received from the server, so this block is a noop.
355          */
356         if (s->ext.ticket_expected) {
357             ss->session_id_length = 0;
358             goto sess_id_done;
359         }
360
361         /* Choose which callback will set the session ID */
362         CRYPTO_THREAD_read_lock(s->lock);
363         CRYPTO_THREAD_read_lock(s->session_ctx->lock);
364         if (s->generate_session_id)
365             cb = s->generate_session_id;
366         else if (s->session_ctx->generate_session_id)
367             cb = s->session_ctx->generate_session_id;
368         CRYPTO_THREAD_unlock(s->session_ctx->lock);
369         CRYPTO_THREAD_unlock(s->lock);
370         /* Choose a session ID */
371         memset(ss->session_id, 0, ss->session_id_length);
372         tmp = (int)ss->session_id_length;
373         if (!cb(s, ss->session_id, &tmp)) {
374             /* The callback failed */
375             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
376                    SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
377             SSL_SESSION_free(ss);
378             return (0);
379         }
380         /*
381          * Don't allow the callback to set the session length to zero. nor
382          * set it higher than it was.
383          */
384         if (tmp == 0 || tmp > ss->session_id_length) {
385             /* The callback set an illegal length */
386             SSLerr(SSL_F_SSL_GET_NEW_SESSION,
387                    SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
388             SSL_SESSION_free(ss);
389             return (0);
390         }
391         ss->session_id_length = tmp;
392         /* Finally, check for a conflict */
393         if (SSL_has_matching_session_id(s, ss->session_id,
394                                         (unsigned int)ss->session_id_length)) {
395             SSLerr(SSL_F_SSL_GET_NEW_SESSION, SSL_R_SSL_SESSION_ID_CONFLICT);
396             SSL_SESSION_free(ss);
397             return (0);
398         }
399
400  sess_id_done:
401         if (s->ext.hostname) {
402             ss->ext.hostname = OPENSSL_strdup(s->ext.hostname);
403             if (ss->ext.hostname == NULL) {
404                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
405                 SSL_SESSION_free(ss);
406                 return 0;
407             }
408         }
409     } else {
410         ss->session_id_length = 0;
411     }
412
413     if (s->sid_ctx_length > sizeof ss->sid_ctx) {
414         SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
415         SSL_SESSION_free(ss);
416         return 0;
417     }
418     memcpy(ss->sid_ctx, s->sid_ctx, s->sid_ctx_length);
419     ss->sid_ctx_length = s->sid_ctx_length;
420     s->session = ss;
421     ss->ssl_version = s->version;
422     ss->verify_result = X509_V_OK;
423
424     /* If client supports extended master secret set it in session */
425     if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)
426         ss->flags |= SSL_SESS_FLAG_EXTMS;
427
428     return (1);
429 }
430
431 /*-
432  * ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
433  * connection. It is only called by servers.
434  *
435  *   hello: The parsed ClientHello data
436  *
437  * Returns:
438  *   -1: error
439  *    0: a session may have been found.
440  *
441  * Side effects:
442  *   - If a session is found then s->session is pointed at it (after freeing an
443  *     existing session if need be) and s->verify_result is set from the session.
444  *   - Both for new and resumed sessions, s->ext.ticket_expected is set to 1
445  *     if the server should issue a new session ticket (to 0 otherwise).
446  */
447 int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello)
448 {
449     /* This is used only by servers. */
450
451     SSL_SESSION *ret = NULL;
452     int fatal = 0;
453     int try_session_cache = 1;
454     int r;
455
456     if (hello->session_id_len == 0)
457         try_session_cache = 0;
458
459     /* sets s->ext.ticket_expected */
460     r = tls_get_ticket_from_client(s, hello, &ret);
461     switch (r) {
462     case -1:                   /* Error during processing */
463         fatal = 1;
464         goto err;
465     case 0:                    /* No ticket found */
466     case 1:                    /* Zero length ticket found */
467         break;                  /* Ok to carry on processing session id. */
468     case 2:                    /* Ticket found but not decrypted. */
469     case 3:                    /* Ticket decrypted, *ret has been set. */
470         try_session_cache = 0;
471         break;
472     default:
473         abort();
474     }
475
476     if (try_session_cache &&
477         ret == NULL &&
478         !(s->session_ctx->session_cache_mode &
479           SSL_SESS_CACHE_NO_INTERNAL_LOOKUP)) {
480         SSL_SESSION data;
481
482         data.ssl_version = s->version;
483         memset(data.session_id, 0, sizeof(data.session_id));
484         memcpy(data.session_id, hello->session_id, hello->session_id_len);
485         data.session_id_length = hello->session_id_len;
486
487         CRYPTO_THREAD_read_lock(s->session_ctx->lock);
488         ret = lh_SSL_SESSION_retrieve(s->session_ctx->sessions, &data);
489         if (ret != NULL) {
490             /* don't allow other threads to steal it: */
491             SSL_SESSION_up_ref(ret);
492         }
493         CRYPTO_THREAD_unlock(s->session_ctx->lock);
494         if (ret == NULL)
495             s->session_ctx->stats.sess_miss++;
496     }
497
498     if (try_session_cache &&
499         ret == NULL && s->session_ctx->get_session_cb != NULL) {
500         int copy = 1;
501
502         ret = s->session_ctx->get_session_cb(s, hello->session_id,
503                                              hello->session_id_len,
504                                              &copy);
505
506         if (ret != NULL) {
507             s->session_ctx->stats.sess_cb_hit++;
508
509             /*
510              * Increment reference count now if the session callback asks us
511              * to do so (note that if the session structures returned by the
512              * callback are shared between threads, it must handle the
513              * reference count itself [i.e. copy == 0], or things won't be
514              * thread-safe).
515              */
516             if (copy)
517                 SSL_SESSION_up_ref(ret);
518
519             /*
520              * Add the externally cached session to the internal cache as
521              * well if and only if we are supposed to.
522              */
523             if (!
524                 (s->session_ctx->session_cache_mode &
525                  SSL_SESS_CACHE_NO_INTERNAL_STORE)) {
526                 /*
527                  * The following should not return 1, otherwise, things are
528                  * very strange
529                  */
530                 if (SSL_CTX_add_session(s->session_ctx, ret))
531                     goto err;
532             }
533         }
534     }
535
536     if (ret == NULL)
537         goto err;
538
539     /* Now ret is non-NULL and we own one of its reference counts. */
540
541     if (ret->sid_ctx_length != s->sid_ctx_length
542         || memcmp(ret->sid_ctx, s->sid_ctx, ret->sid_ctx_length)) {
543         /*
544          * We have the session requested by the client, but we don't want to
545          * use it in this context.
546          */
547         goto err;               /* treat like cache miss */
548     }
549
550     if ((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0) {
551         /*
552          * We can't be sure if this session is being used out of context,
553          * which is especially important for SSL_VERIFY_PEER. The application
554          * should have used SSL[_CTX]_set_session_id_context. For this error
555          * case, we generate an error instead of treating the event like a
556          * cache miss (otherwise it would be easy for applications to
557          * effectively disable the session cache by accident without anyone
558          * noticing).
559          */
560
561         SSLerr(SSL_F_SSL_GET_PREV_SESSION,
562                SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
563         fatal = 1;
564         goto err;
565     }
566
567     if (ret->cipher == NULL) {
568         unsigned char buf[5], *p;
569         unsigned long l;
570
571         p = buf;
572         l = ret->cipher_id;
573         l2n(l, p);
574         if ((ret->ssl_version >> 8) >= SSL3_VERSION_MAJOR)
575             ret->cipher = ssl_get_cipher_by_char(s, &(buf[2]));
576         else
577             ret->cipher = ssl_get_cipher_by_char(s, &(buf[1]));
578         if (ret->cipher == NULL)
579             goto err;
580     }
581
582     if (ret->timeout < (long)(time(NULL) - ret->time)) { /* timeout */
583         s->session_ctx->stats.sess_timeout++;
584         if (try_session_cache) {
585             /* session was from the cache, so remove it */
586             SSL_CTX_remove_session(s->session_ctx, ret);
587         }
588         goto err;
589     }
590
591     /*
592      * TODO(TLS1.3): This is temporary, because TLSv1.3 resumption is completely
593      * different. For now though we're still using the old resumption logic, so
594      * to avoid test failures we need this. Remove this code!
595      * 
596      * Check TLS version consistency. We can't resume <=TLSv1.2 session if we
597      * have negotiated TLSv1.3, and vice versa.
598      */
599     if (!SSL_IS_DTLS(s)
600             && ((ret->ssl_version <= TLS1_2_VERSION
601                  && s->version >=TLS1_3_VERSION)
602                 || (ret->ssl_version >= TLS1_3_VERSION
603                     && s->version <= TLS1_2_VERSION))) {
604         /* Continue but do not resume */
605         goto err;
606     }
607
608     /* Check extended master secret extension consistency */
609     if (ret->flags & SSL_SESS_FLAG_EXTMS) {
610         /* If old session includes extms, but new does not: abort handshake */
611         if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS)) {
612             SSLerr(SSL_F_SSL_GET_PREV_SESSION, SSL_R_INCONSISTENT_EXTMS);
613             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
614             fatal = 1;
615             goto err;
616         }
617     } else if (s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) {
618         /* If new session includes extms, but old does not: do not resume */
619         goto err;
620     }
621
622     s->session_ctx->stats.sess_hit++;
623
624     SSL_SESSION_free(s->session);
625     s->session = ret;
626     s->verify_result = s->session->verify_result;
627     return 1;
628
629  err:
630     if (ret != NULL) {
631         SSL_SESSION_free(ret);
632
633         if (!try_session_cache) {
634             /*
635              * The session was from a ticket, so we should issue a ticket for
636              * the new session
637              */
638             s->ext.ticket_expected = 1;
639         }
640     }
641     if (fatal)
642         return -1;
643     else
644         return 0;
645 }
646
647 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
648 {
649     int ret = 0;
650     SSL_SESSION *s;
651
652     /*
653      * add just 1 reference count for the SSL_CTX's session cache even though
654      * it has two ways of access: each session is in a doubly linked list and
655      * an lhash
656      */
657     SSL_SESSION_up_ref(c);
658     /*
659      * if session c is in already in cache, we take back the increment later
660      */
661
662     CRYPTO_THREAD_write_lock(ctx->lock);
663     s = lh_SSL_SESSION_insert(ctx->sessions, c);
664
665     /*
666      * s != NULL iff we already had a session with the given PID. In this
667      * case, s == c should hold (then we did not really modify
668      * ctx->sessions), or we're in trouble.
669      */
670     if (s != NULL && s != c) {
671         /* We *are* in trouble ... */
672         SSL_SESSION_list_remove(ctx, s);
673         SSL_SESSION_free(s);
674         /*
675          * ... so pretend the other session did not exist in cache (we cannot
676          * handle two SSL_SESSION structures with identical session ID in the
677          * same cache, which could happen e.g. when two threads concurrently
678          * obtain the same session from an external cache)
679          */
680         s = NULL;
681     } else if (s == NULL &&
682                lh_SSL_SESSION_retrieve(ctx->sessions, c) == NULL) {
683         /* s == NULL can also mean OOM error in lh_SSL_SESSION_insert ... */
684
685         /*
686          * ... so take back the extra reference and also don't add
687          * the session to the SSL_SESSION_list at this time
688          */
689         s = c;
690     }
691
692     /* Put at the head of the queue unless it is already in the cache */
693     if (s == NULL)
694         SSL_SESSION_list_add(ctx, c);
695
696     if (s != NULL) {
697         /*
698          * existing cache entry -- decrement previously incremented reference
699          * count because it already takes into account the cache
700          */
701
702         SSL_SESSION_free(s);    /* s == c */
703         ret = 0;
704     } else {
705         /*
706          * new cache entry -- remove old ones if cache has become too large
707          */
708
709         ret = 1;
710
711         if (SSL_CTX_sess_get_cache_size(ctx) > 0) {
712             while (SSL_CTX_sess_number(ctx) > SSL_CTX_sess_get_cache_size(ctx)) {
713                 if (!remove_session_lock(ctx, ctx->session_cache_tail, 0))
714                     break;
715                 else
716                     ctx->stats.sess_cache_full++;
717             }
718         }
719     }
720     CRYPTO_THREAD_unlock(ctx->lock);
721     return ret;
722 }
723
724 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
725 {
726     return remove_session_lock(ctx, c, 1);
727 }
728
729 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
730 {
731     SSL_SESSION *r;
732     int ret = 0;
733
734     if ((c != NULL) && (c->session_id_length != 0)) {
735         if (lck)
736             CRYPTO_THREAD_write_lock(ctx->lock);
737         if ((r = lh_SSL_SESSION_retrieve(ctx->sessions, c)) == c) {
738             ret = 1;
739             r = lh_SSL_SESSION_delete(ctx->sessions, c);
740             SSL_SESSION_list_remove(ctx, c);
741         }
742         c->not_resumable = 1;
743
744         if (lck)
745             CRYPTO_THREAD_unlock(ctx->lock);
746
747         if (ret)
748             SSL_SESSION_free(r);
749
750         if (ctx->remove_session_cb != NULL)
751             ctx->remove_session_cb(ctx, c);
752     } else
753         ret = 0;
754     return (ret);
755 }
756
757 void SSL_SESSION_free(SSL_SESSION *ss)
758 {
759     int i;
760
761     if (ss == NULL)
762         return;
763
764     CRYPTO_DOWN_REF(&ss->references, &i, ss->lock);
765     REF_PRINT_COUNT("SSL_SESSION", ss);
766     if (i > 0)
767         return;
768     REF_ASSERT_ISNT(i < 0);
769
770     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
771
772     OPENSSL_cleanse(ss->master_key, sizeof ss->master_key);
773     OPENSSL_cleanse(ss->session_id, sizeof ss->session_id);
774     X509_free(ss->peer);
775     sk_X509_pop_free(ss->peer_chain, X509_free);
776     sk_SSL_CIPHER_free(ss->ciphers);
777     OPENSSL_free(ss->ext.hostname);
778     OPENSSL_free(ss->ext.tick);
779 #ifndef OPENSSL_NO_EC
780     OPENSSL_free(ss->ext.ecpointformats);
781     ss->ext.ecpointformats = NULL;
782     ss->ext.ecpointformats_len = 0;
783     OPENSSL_free(ss->ext.supportedgroups);
784     ss->ext.supportedgroups = NULL;
785     ss->ext.supportedgroups_len = 0;
786 #endif                          /* OPENSSL_NO_EC */
787 #ifndef OPENSSL_NO_PSK
788     OPENSSL_free(ss->psk_identity_hint);
789     OPENSSL_free(ss->psk_identity);
790 #endif
791 #ifndef OPENSSL_NO_SRP
792     OPENSSL_free(ss->srp_username);
793 #endif
794     CRYPTO_THREAD_lock_free(ss->lock);
795     OPENSSL_clear_free(ss, sizeof(*ss));
796 }
797
798 int SSL_SESSION_up_ref(SSL_SESSION *ss)
799 {
800     int i;
801
802     if (CRYPTO_UP_REF(&ss->references, &i, ss->lock) <= 0)
803         return 0;
804
805     REF_PRINT_COUNT("SSL_SESSION", ss);
806     REF_ASSERT_ISNT(i < 2);
807     return ((i > 1) ? 1 : 0);
808 }
809
810 int SSL_set_session(SSL *s, SSL_SESSION *session)
811 {
812     ssl_clear_bad_session(s);
813     if (s->ctx->method != s->method) {
814         if (!SSL_set_ssl_method(s, s->ctx->method))
815             return 0;
816     }
817
818     if (session != NULL) {
819         SSL_SESSION_up_ref(session);
820         s->verify_result = session->verify_result;
821     }
822     SSL_SESSION_free(s->session);
823     s->session = session;
824
825     return 1;
826 }
827
828 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
829                         unsigned int sid_len)
830 {
831     if (sid_len > SSL_MAX_SSL_SESSION_ID_LENGTH) {
832       SSLerr(SSL_F_SSL_SESSION_SET1_ID,
833              SSL_R_SSL_SESSION_ID_TOO_LONG);
834       return 0;
835     }
836     s->session_id_length = sid_len;
837     memcpy(s->session_id, sid, sid_len);
838     return 1;
839 }
840
841 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
842 {
843     if (s == NULL)
844         return (0);
845     s->timeout = t;
846     return (1);
847 }
848
849 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
850 {
851     if (s == NULL)
852         return (0);
853     return (s->timeout);
854 }
855
856 long SSL_SESSION_get_time(const SSL_SESSION *s)
857 {
858     if (s == NULL)
859         return (0);
860     return (s->time);
861 }
862
863 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
864 {
865     if (s == NULL)
866         return (0);
867     s->time = t;
868     return (t);
869 }
870
871 int SSL_SESSION_get_protocol_version(const SSL_SESSION *s)
872 {
873     return s->ssl_version;
874 }
875
876 const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s)
877 {
878     return s->cipher;
879 }
880
881 const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s)
882 {
883     return s->ext.hostname;
884 }
885
886 int SSL_SESSION_has_ticket(const SSL_SESSION *s)
887 {
888     return (s->ext.ticklen > 0) ? 1 : 0;
889 }
890
891 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
892 {
893     return s->ext.tick_lifetime_hint;
894 }
895
896 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
897                              size_t *len)
898 {
899     *len = s->ext.ticklen;
900     if (tick != NULL)
901         *tick = s->ext.tick;
902 }
903
904 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
905 {
906     return s->peer;
907 }
908
909 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
910                                 unsigned int sid_ctx_len)
911 {
912     if (sid_ctx_len > SSL_MAX_SID_CTX_LENGTH) {
913         SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,
914                SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
915         return 0;
916     }
917     s->sid_ctx_length = sid_ctx_len;
918     memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
919
920     return 1;
921 }
922
923 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
924 {
925     long l;
926     if (s == NULL)
927         return (0);
928     l = s->session_timeout;
929     s->session_timeout = t;
930     return (l);
931 }
932
933 long SSL_CTX_get_timeout(const SSL_CTX *s)
934 {
935     if (s == NULL)
936         return (0);
937     return (s->session_timeout);
938 }
939
940 int SSL_set_session_secret_cb(SSL *s,
941                               tls_session_secret_cb_fn tls_session_secret_cb,
942                               void *arg)
943 {
944     if (s == NULL)
945         return (0);
946     s->ext.session_secret_cb = tls_session_secret_cb;
947     s->ext.session_secret_cb_arg = arg;
948     return (1);
949 }
950
951 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
952                                   void *arg)
953 {
954     if (s == NULL)
955         return (0);
956     s->ext.session_ticket_cb = cb;
957     s->ext.session_ticket_cb_arg = arg;
958     return (1);
959 }
960
961 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
962 {
963     if (s->version >= TLS1_VERSION) {
964         OPENSSL_free(s->ext.session_ticket);
965         s->ext.session_ticket = NULL;
966         s->ext.session_ticket =
967             OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
968         if (s->ext.session_ticket == NULL) {
969             SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
970             return 0;
971         }
972
973         if (ext_data != NULL) {
974             s->ext.session_ticket->length = ext_len;
975             s->ext.session_ticket->data = s->ext.session_ticket + 1;
976             memcpy(s->ext.session_ticket->data, ext_data, ext_len);
977         } else {
978             s->ext.session_ticket->length = 0;
979             s->ext.session_ticket->data = NULL;
980         }
981
982         return 1;
983     }
984
985     return 0;
986 }
987
988 typedef struct timeout_param_st {
989     SSL_CTX *ctx;
990     long time;
991     LHASH_OF(SSL_SESSION) *cache;
992 } TIMEOUT_PARAM;
993
994 static void timeout_cb(SSL_SESSION *s, TIMEOUT_PARAM *p)
995 {
996     if ((p->time == 0) || (p->time > (s->time + s->timeout))) { /* timeout */
997         /*
998          * The reason we don't call SSL_CTX_remove_session() is to save on
999          * locking overhead
1000          */
1001         (void)lh_SSL_SESSION_delete(p->cache, s);
1002         SSL_SESSION_list_remove(p->ctx, s);
1003         s->not_resumable = 1;
1004         if (p->ctx->remove_session_cb != NULL)
1005             p->ctx->remove_session_cb(p->ctx, s);
1006         SSL_SESSION_free(s);
1007     }
1008 }
1009
1010 IMPLEMENT_LHASH_DOALL_ARG(SSL_SESSION, TIMEOUT_PARAM);
1011
1012 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
1013 {
1014     unsigned long i;
1015     TIMEOUT_PARAM tp;
1016
1017     tp.ctx = s;
1018     tp.cache = s->sessions;
1019     if (tp.cache == NULL)
1020         return;
1021     tp.time = t;
1022     CRYPTO_THREAD_write_lock(s->lock);
1023     i = lh_SSL_SESSION_get_down_load(s->sessions);
1024     lh_SSL_SESSION_set_down_load(s->sessions, 0);
1025     lh_SSL_SESSION_doall_TIMEOUT_PARAM(tp.cache, timeout_cb, &tp);
1026     lh_SSL_SESSION_set_down_load(s->sessions, i);
1027     CRYPTO_THREAD_unlock(s->lock);
1028 }
1029
1030 int ssl_clear_bad_session(SSL *s)
1031 {
1032     if ((s->session != NULL) &&
1033         !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1034         !(SSL_in_init(s) || SSL_in_before(s))) {
1035         SSL_CTX_remove_session(s->session_ctx, s->session);
1036         return (1);
1037     } else
1038         return (0);
1039 }
1040
1041 /* locked by SSL_CTX in the calling function */
1042 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1043 {
1044     if ((s->next == NULL) || (s->prev == NULL))
1045         return;
1046
1047     if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail)) {
1048         /* last element in list */
1049         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1050             /* only one element in list */
1051             ctx->session_cache_head = NULL;
1052             ctx->session_cache_tail = NULL;
1053         } else {
1054             ctx->session_cache_tail = s->prev;
1055             s->prev->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1056         }
1057     } else {
1058         if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head)) {
1059             /* first element in list */
1060             ctx->session_cache_head = s->next;
1061             s->next->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1062         } else {
1063             /* middle of list */
1064             s->next->prev = s->prev;
1065             s->prev->next = s->next;
1066         }
1067     }
1068     s->prev = s->next = NULL;
1069 }
1070
1071 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1072 {
1073     if ((s->next != NULL) && (s->prev != NULL))
1074         SSL_SESSION_list_remove(ctx, s);
1075
1076     if (ctx->session_cache_head == NULL) {
1077         ctx->session_cache_head = s;
1078         ctx->session_cache_tail = s;
1079         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1080         s->next = (SSL_SESSION *)&(ctx->session_cache_tail);
1081     } else {
1082         s->next = ctx->session_cache_head;
1083         s->next->prev = s;
1084         s->prev = (SSL_SESSION *)&(ctx->session_cache_head);
1085         ctx->session_cache_head = s;
1086     }
1087 }
1088
1089 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1090                              int (*cb) (struct ssl_st *ssl, SSL_SESSION *sess))
1091 {
1092     ctx->new_session_cb = cb;
1093 }
1094
1095 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (SSL *ssl, SSL_SESSION *sess) {
1096     return ctx->new_session_cb;
1097 }
1098
1099 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1100                                 void (*cb) (SSL_CTX *ctx, SSL_SESSION *sess))
1101 {
1102     ctx->remove_session_cb = cb;
1103 }
1104
1105 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (SSL_CTX *ctx,
1106                                                   SSL_SESSION *sess) {
1107     return ctx->remove_session_cb;
1108 }
1109
1110 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1111                              SSL_SESSION *(*cb) (struct ssl_st *ssl,
1112                                                  const unsigned char *data,
1113                                                  int len, int *copy))
1114 {
1115     ctx->get_session_cb = cb;
1116 }
1117
1118 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (SSL *ssl,
1119                                                        const unsigned char
1120                                                        *data, int len,
1121                                                        int *copy) {
1122     return ctx->get_session_cb;
1123 }
1124
1125 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1126                                void (*cb) (const SSL *ssl, int type, int val))
1127 {
1128     ctx->info_callback = cb;
1129 }
1130
1131 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
1132                                                  int val) {
1133     return ctx->info_callback;
1134 }
1135
1136 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1137                                 int (*cb) (SSL *ssl, X509 **x509,
1138                                            EVP_PKEY **pkey))
1139 {
1140     ctx->client_cert_cb = cb;
1141 }
1142
1143 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
1144                                                  EVP_PKEY **pkey) {
1145     return ctx->client_cert_cb;
1146 }
1147
1148 #ifndef OPENSSL_NO_ENGINE
1149 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1150 {
1151     if (!ENGINE_init(e)) {
1152         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1153         return 0;
1154     }
1155     if (!ENGINE_get_ssl_client_cert_function(e)) {
1156         SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE,
1157                SSL_R_NO_CLIENT_CERT_METHOD);
1158         ENGINE_finish(e);
1159         return 0;
1160     }
1161     ctx->client_cert_engine = e;
1162     return 1;
1163 }
1164 #endif
1165
1166 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1167                                     int (*cb) (SSL *ssl,
1168                                                unsigned char *cookie,
1169                                                unsigned int *cookie_len))
1170 {
1171     ctx->app_gen_cookie_cb = cb;
1172 }
1173
1174 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1175                                   int (*cb) (SSL *ssl,
1176                                              const unsigned char *cookie,
1177                                              unsigned int cookie_len))
1178 {
1179     ctx->app_verify_cookie_cb = cb;
1180 }
1181
1182 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)