[PR3597] Advance to the next state variant when reusing messages.
[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 /* ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
438  * connection. It is only called by servers.
439  *
440  *   session_id: points at the session ID in the ClientHello. This code will
441  *       read past the end of this in order to parse out the session ticket
442  *       extension, if any.
443  *   len: the length of the session ID.
444  *   limit: a pointer to the first byte after the ClientHello.
445  *
446  * Returns:
447  *   -1: error
448  *    0: a session may have been found.
449  *
450  * Side effects:
451  *   - If a session is found then s->session is pointed at it (after freeing an
452  *     existing session if need be) and s->verify_result is set from the session.
453  *   - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
454  *     if the server should issue a new session ticket (to 0 otherwise).
455  */
456 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
457                         const unsigned char *limit)
458         {
459         /* This is used only by servers. */
460
461         SSL_SESSION *ret=NULL;
462         int fatal = 0;
463         int try_session_cache = 1;
464 #ifndef OPENSSL_NO_TLSEXT
465         int r;
466 #endif
467
468         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
469                 goto err;
470
471         if (len == 0)
472                 try_session_cache = 0;
473
474 #ifndef OPENSSL_NO_TLSEXT
475         r = tls1_process_ticket(s, session_id, len, limit, &ret); /* sets s->tlsext_ticket_expected */
476         switch (r)
477                 {
478         case -1: /* Error during processing */
479                 fatal = 1;
480                 goto err;
481         case 0: /* No ticket found */
482         case 1: /* Zero length ticket found */
483                 break; /* Ok to carry on processing session id. */
484         case 2: /* Ticket found but not decrypted. */
485         case 3: /* Ticket decrypted, *ret has been set. */
486                 try_session_cache = 0;
487                 break;
488         default:
489                 abort();
490                 }
491 #endif
492
493         if (try_session_cache &&
494             ret == NULL &&
495             !(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
496                 {
497                 SSL_SESSION data;
498                 data.ssl_version=s->version;
499                 data.session_id_length=len;
500                 if (len == 0)
501                         return 0;
502                 memcpy(data.session_id,session_id,len);
503                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
504                 ret=lh_SSL_SESSION_retrieve(s->session_ctx->sessions,&data);
505                 if (ret != NULL)
506                         {
507                         /* don't allow other threads to steal it: */
508                         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
509                         }
510                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
511                 if (ret == NULL)
512                         s->session_ctx->stats.sess_miss++;
513                 }
514
515         if (try_session_cache &&
516             ret == NULL &&
517             s->session_ctx->get_session_cb != NULL)
518                 {
519                 int copy=1;
520         
521                 if ((ret=s->session_ctx->get_session_cb(s,session_id,len,&copy)))
522                         {
523                         s->session_ctx->stats.sess_cb_hit++;
524
525                         /* Increment reference count now if the session callback
526                          * asks us to do so (note that if the session structures
527                          * returned by the callback are shared between threads,
528                          * it must handle the reference count itself [i.e. copy == 0],
529                          * or things won't be thread-safe). */
530                         if (copy)
531                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
532
533                         /* Add the externally cached session to the internal
534                          * cache as well if and only if we are supposed to. */
535                         if(!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
536                                 /* The following should not return 1, otherwise,
537                                  * things are very strange */
538                                 SSL_CTX_add_session(s->session_ctx,ret);
539                         }
540                 }
541
542         if (ret == NULL)
543                 goto err;
544
545         /* Now ret is non-NULL and we own one of its reference counts. */
546
547         if (ret->sid_ctx_length != s->sid_ctx_length
548             || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length))
549                 {
550                 /* We have the session requested by the client, but we don't
551                  * want to use it in this context. */
552                 goto err; /* treat like cache miss */
553                 }
554         
555         if((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0)
556                 {
557                 /* We can't be sure if this session is being used out of
558                  * context, which is especially important for SSL_VERIFY_PEER.
559                  * The application should have used SSL[_CTX]_set_session_id_context.
560                  *
561                  * For this error case, we generate an error instead of treating
562                  * the event like a cache miss (otherwise it would be easy for
563                  * applications to effectively disable the session cache by
564                  * accident without anyone noticing).
565                  */
566                 
567                 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
568                 fatal = 1;
569                 goto err;
570                 }
571
572         if (ret->cipher == NULL)
573                 {
574                 unsigned char buf[5],*p;
575                 unsigned long l;
576
577                 p=buf;
578                 l=ret->cipher_id;
579                 l2n(l,p);
580                 if ((ret->ssl_version>>8) >= SSL3_VERSION_MAJOR)
581                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
582                 else 
583                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
584                 if (ret->cipher == NULL)
585                         goto err;
586                 }
587
588         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
589                 {
590                 s->session_ctx->stats.sess_timeout++;
591                 if (try_session_cache)
592                         {
593                         /* session was from the cache, so remove it */
594                         SSL_CTX_remove_session(s->session_ctx,ret);
595                         }
596                 goto err;
597                 }
598
599         s->session_ctx->stats.sess_hit++;
600
601         if (s->session != NULL)
602                 SSL_SESSION_free(s->session);
603         s->session=ret;
604         s->verify_result = s->session->verify_result;
605         return 1;
606
607  err:
608         if (ret != NULL)
609                 {
610                 SSL_SESSION_free(ret);
611 #ifndef OPENSSL_NO_TLSEXT
612                 if (!try_session_cache)
613                         {
614                         /* The session was from a ticket, so we should
615                          * issue a ticket for the new session */
616                         s->tlsext_ticket_expected = 1;
617                         }
618 #endif
619                 }
620         if (fatal)
621                 return -1;
622         else
623                 return 0;
624         }
625
626 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
627         {
628         int ret=0;
629         SSL_SESSION *s;
630
631         /* add just 1 reference count for the SSL_CTX's session cache
632          * even though it has two ways of access: each session is in a
633          * doubly linked list and an lhash */
634         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
635         /* if session c is in already in cache, we take back the increment later */
636
637         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
638         s=lh_SSL_SESSION_insert(ctx->sessions,c);
639         
640         /* s != NULL iff we already had a session with the given PID.
641          * In this case, s == c should hold (then we did not really modify
642          * ctx->sessions), or we're in trouble. */
643         if (s != NULL && s != c)
644                 {
645                 /* We *are* in trouble ... */
646                 SSL_SESSION_list_remove(ctx,s);
647                 SSL_SESSION_free(s);
648                 /* ... so pretend the other session did not exist in cache
649                  * (we cannot handle two SSL_SESSION structures with identical
650                  * session ID in the same cache, which could happen e.g. when
651                  * two threads concurrently obtain the same session from an external
652                  * cache) */
653                 s = NULL;
654                 }
655
656         /* Put at the head of the queue unless it is already in the cache */
657         if (s == NULL)
658                 SSL_SESSION_list_add(ctx,c);
659
660         if (s != NULL)
661                 {
662                 /* existing cache entry -- decrement previously incremented reference
663                  * count because it already takes into account the cache */
664
665                 SSL_SESSION_free(s); /* s == c */
666                 ret=0;
667                 }
668         else
669                 {
670                 /* new cache entry -- remove old ones if cache has become too large */
671                 
672                 ret=1;
673
674                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
675                         {
676                         while (SSL_CTX_sess_number(ctx) >
677                                 SSL_CTX_sess_get_cache_size(ctx))
678                                 {
679                                 if (!remove_session_lock(ctx,
680                                         ctx->session_cache_tail, 0))
681                                         break;
682                                 else
683                                         ctx->stats.sess_cache_full++;
684                                 }
685                         }
686                 }
687         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
688         return(ret);
689         }
690
691 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
692 {
693         return remove_session_lock(ctx, c, 1);
694 }
695
696 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
697         {
698         SSL_SESSION *r;
699         int ret=0;
700
701         if ((c != NULL) && (c->session_id_length != 0))
702                 {
703                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
704                 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions,c)) == c)
705                         {
706                         ret=1;
707                         r=lh_SSL_SESSION_delete(ctx->sessions,c);
708                         SSL_SESSION_list_remove(ctx,c);
709                         }
710
711                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
712
713                 if (ret)
714                         {
715                         r->not_resumable=1;
716                         if (ctx->remove_session_cb != NULL)
717                                 ctx->remove_session_cb(ctx,r);
718                         SSL_SESSION_free(r);
719                         }
720                 }
721         else
722                 ret=0;
723         return(ret);
724         }
725
726 void SSL_SESSION_free(SSL_SESSION *ss)
727         {
728         int i;
729
730         if(ss == NULL)
731             return;
732
733         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
734 #ifdef REF_PRINT
735         REF_PRINT("SSL_SESSION",ss);
736 #endif
737         if (i > 0) return;
738 #ifdef REF_CHECK
739         if (i < 0)
740                 {
741                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
742                 abort(); /* ok */
743                 }
744 #endif
745
746         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
747
748         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
749         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
750         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
751         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
752         if (ss->peer != NULL) X509_free(ss->peer);
753         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
754 #ifndef OPENSSL_NO_TLSEXT
755         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
756         if (ss->tlsext_tick != NULL) OPENSSL_free(ss->tlsext_tick);
757 #ifndef OPENSSL_NO_EC
758         ss->tlsext_ecpointformatlist_length = 0;
759         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
760         ss->tlsext_ellipticcurvelist_length = 0;
761         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
762 #endif /* OPENSSL_NO_EC */
763 #endif
764 #ifndef OPENSSL_NO_PSK
765         if (ss->psk_identity_hint != NULL)
766                 OPENSSL_free(ss->psk_identity_hint);
767         if (ss->psk_identity != NULL)
768                 OPENSSL_free(ss->psk_identity);
769 #endif
770 #ifndef OPENSSL_NO_SRP
771         if (ss->srp_username != NULL)
772                 OPENSSL_free(ss->srp_username);
773 #endif
774         OPENSSL_cleanse(ss,sizeof(*ss));
775         OPENSSL_free(ss);
776         }
777
778 int SSL_set_session(SSL *s, SSL_SESSION *session)
779         {
780         int ret=0;
781         const SSL_METHOD *meth;
782
783         if (session != NULL)
784                 {
785                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
786                 if (meth == NULL)
787                         meth=s->method->get_ssl_method(session->ssl_version);
788                 if (meth == NULL)
789                         {
790                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
791                         return(0);
792                         }
793
794                 if (meth != s->method)
795                         {
796                         if (!SSL_set_ssl_method(s,meth))
797                                 return(0);
798                         }
799
800 #ifndef OPENSSL_NO_KRB5
801                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
802                     session->krb5_client_princ_len > 0)
803                 {
804                     s->kssl_ctx->client_princ = (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
805                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
806                             session->krb5_client_princ_len);
807                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
808                 }
809 #endif /* OPENSSL_NO_KRB5 */
810
811                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
812                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
813                 if (s->session != NULL)
814                         SSL_SESSION_free(s->session);
815                 s->session=session;
816                 s->verify_result = s->session->verify_result;
817                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
818                 ret=1;
819                 }
820         else
821                 {
822                 if (s->session != NULL)
823                         {
824                         SSL_SESSION_free(s->session);
825                         s->session=NULL;
826                         }
827
828                 meth=s->ctx->method;
829                 if (meth != s->method)
830                         {
831                         if (!SSL_set_ssl_method(s,meth))
832                                 return(0);
833                         }
834                 ret=1;
835                 }
836         return(ret);
837         }
838
839 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
840         {
841         if (s == NULL) return(0);
842         s->timeout=t;
843         return(1);
844         }
845
846 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
847         {
848         if (s == NULL) return(0);
849         return(s->timeout);
850         }
851
852 long SSL_SESSION_get_time(const SSL_SESSION *s)
853         {
854         if (s == NULL) return(0);
855         return(s->time);
856         }
857
858 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
859         {
860         if (s == NULL) return(0);
861         s->time=t;
862         return(t);
863         }
864
865 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
866         {
867         return s->peer;
868         }
869
870 int SSL_SESSION_set1_id_context(SSL_SESSION *s,const unsigned char *sid_ctx,
871                                unsigned int sid_ctx_len)
872         {
873         if(sid_ctx_len > SSL_MAX_SID_CTX_LENGTH)
874                 {
875                 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
876                 return 0;
877                 }
878         s->sid_ctx_length=sid_ctx_len;
879         memcpy(s->sid_ctx,sid_ctx,sid_ctx_len);
880
881         return 1;
882         }
883
884 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
885         {
886         long l;
887         if (s == NULL) return(0);
888         l=s->session_timeout;
889         s->session_timeout=t;
890         return(l);
891         }
892
893 long SSL_CTX_get_timeout(const SSL_CTX *s)
894         {
895         if (s == NULL) return(0);
896         return(s->session_timeout);
897         }
898
899 #ifndef OPENSSL_NO_TLSEXT
900 int SSL_set_session_secret_cb(SSL *s, int (*tls_session_secret_cb)(SSL *s, void *secret, int *secret_len,
901         STACK_OF(SSL_CIPHER) *peer_ciphers, SSL_CIPHER **cipher, void *arg), void *arg)
902         {
903         if (s == NULL) return(0);
904         s->tls_session_secret_cb = tls_session_secret_cb;
905         s->tls_session_secret_cb_arg = arg;
906         return(1);
907         }
908
909 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
910                                   void *arg)
911         {
912         if (s == NULL) return(0);
913         s->tls_session_ticket_ext_cb = cb;
914         s->tls_session_ticket_ext_cb_arg = arg;
915         return(1);
916         }
917
918 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
919         {
920         if (s->version >= TLS1_VERSION)
921                 {
922                 if (s->tlsext_session_ticket)
923                         {
924                         OPENSSL_free(s->tlsext_session_ticket);
925                         s->tlsext_session_ticket = NULL;
926                         }
927
928                 s->tlsext_session_ticket = OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
929                 if (!s->tlsext_session_ticket)
930                         {
931                         SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
932                         return 0;
933                         }
934
935                 if (ext_data)
936                         {
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                         }
941                 else
942                         {
943                         s->tlsext_session_ticket->length = 0;
944                         s->tlsext_session_ticket->data = NULL;
945                         }
946
947                 return 1;
948                 }
949
950         return 0;
951         }
952 #endif /* OPENSSL_NO_TLSEXT */
953
954 typedef struct timeout_param_st
955         {
956         SSL_CTX *ctx;
957         long time;
958         LHASH_OF(SSL_SESSION) *cache;
959         } TIMEOUT_PARAM;
960
961 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
962         {
963         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
964                 {
965                 /* The reason we don't call SSL_CTX_remove_session() is to
966                  * save on locking overhead */
967                 (void)lh_SSL_SESSION_delete(p->cache,s);
968                 SSL_SESSION_list_remove(p->ctx,s);
969                 s->not_resumable=1;
970                 if (p->ctx->remove_session_cb != NULL)
971                         p->ctx->remove_session_cb(p->ctx,s);
972                 SSL_SESSION_free(s);
973                 }
974         }
975
976 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
977
978 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
979         {
980         unsigned long i;
981         TIMEOUT_PARAM tp;
982
983         tp.ctx=s;
984         tp.cache=s->sessions;
985         if (tp.cache == NULL) return;
986         tp.time=t;
987         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
988         i=CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
989         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=0;
990         lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
991                                  TIMEOUT_PARAM, &tp);
992         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=i;
993         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
994         }
995
996 int ssl_clear_bad_session(SSL *s)
997         {
998         if (    (s->session != NULL) &&
999                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1000                 !(SSL_in_init(s) || SSL_in_before(s)))
1001                 {
1002                 SSL_CTX_remove_session(s->ctx,s->session);
1003                 return(1);
1004                 }
1005         else
1006                 return(0);
1007         }
1008
1009 /* locked by SSL_CTX in the calling function */
1010 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1011         {
1012         if ((s->next == NULL) || (s->prev == NULL)) return;
1013
1014         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
1015                 { /* last element in list */
1016                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
1017                         { /* only one element in list */
1018                         ctx->session_cache_head=NULL;
1019                         ctx->session_cache_tail=NULL;
1020                         }
1021                 else
1022                         {
1023                         ctx->session_cache_tail=s->prev;
1024                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
1025                         }
1026                 }
1027         else
1028                 {
1029                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
1030                         { /* first element in list */
1031                         ctx->session_cache_head=s->next;
1032                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1033                         }
1034                 else
1035                         { /* middle of list */
1036                         s->next->prev=s->prev;
1037                         s->prev->next=s->next;
1038                         }
1039                 }
1040         s->prev=s->next=NULL;
1041         }
1042
1043 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1044         {
1045         if ((s->next != NULL) && (s->prev != NULL))
1046                 SSL_SESSION_list_remove(ctx,s);
1047
1048         if (ctx->session_cache_head == NULL)
1049                 {
1050                 ctx->session_cache_head=s;
1051                 ctx->session_cache_tail=s;
1052                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1053                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
1054                 }
1055         else
1056                 {
1057                 s->next=ctx->session_cache_head;
1058                 s->next->prev=s;
1059                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1060                 ctx->session_cache_head=s;
1061                 }
1062         }
1063
1064 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1065         int (*cb)(struct ssl_st *ssl,SSL_SESSION *sess))
1066         {
1067         ctx->new_session_cb=cb;
1068         }
1069
1070 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl, SSL_SESSION *sess)
1071         {
1072         return ctx->new_session_cb;
1073         }
1074
1075 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1076         void (*cb)(SSL_CTX *ctx,SSL_SESSION *sess))
1077         {
1078         ctx->remove_session_cb=cb;
1079         }
1080
1081 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(SSL_CTX * ctx,SSL_SESSION *sess)
1082         {
1083         return ctx->remove_session_cb;
1084         }
1085
1086 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1087         SSL_SESSION *(*cb)(struct ssl_st *ssl,
1088                  unsigned char *data,int len,int *copy))
1089         {
1090         ctx->get_session_cb=cb;
1091         }
1092
1093 SSL_SESSION * (*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl,
1094                  unsigned char *data,int len,int *copy)
1095         {
1096         return ctx->get_session_cb;
1097         }
1098
1099 void SSL_CTX_set_info_callback(SSL_CTX *ctx, 
1100         void (*cb)(const SSL *ssl,int type,int val))
1101         {
1102         ctx->info_callback=cb;
1103         }
1104
1105 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,int type,int val)
1106         {
1107         return ctx->info_callback;
1108         }
1109
1110 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1111         int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey))
1112         {
1113         ctx->client_cert_cb=cb;
1114         }
1115
1116 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL * ssl, X509 ** x509 , EVP_PKEY **pkey)
1117         {
1118         return ctx->client_cert_cb;
1119         }
1120
1121 #ifndef OPENSSL_NO_ENGINE
1122 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1123         {
1124         if (!ENGINE_init(e))
1125                 {
1126                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1127                 return 0;
1128                 }
1129         if(!ENGINE_get_ssl_client_cert_function(e))
1130                 {
1131                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, SSL_R_NO_CLIENT_CERT_METHOD);
1132                 ENGINE_finish(e);
1133                 return 0;
1134                 }
1135         ctx->client_cert_engine = e;
1136         return 1;
1137         }
1138 #endif
1139
1140 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1141         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int *cookie_len))
1142         {
1143         ctx->app_gen_cookie_cb=cb;
1144         }
1145
1146 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1147         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int cookie_len))
1148         {
1149         ctx->app_verify_cookie_cb=cb;
1150         }
1151
1152 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)