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