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