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