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