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