74e8f7b99df50e66a803022d9c3e90ce8145f3a3
[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 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
235  * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
236  * until we have no conflict is going to complete in one iteration pretty much
237  * "most" of the time (btw: understatement). So, if it takes us 10 iterations
238  * and we still can't avoid a conflict - well that's a reasonable point to call
239  * it quits. Either the RAND code is broken or someone is trying to open roughly
240  * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
241  * store that many sessions is perhaps a more interesting question ... */
242
243 #define MAX_SESS_ID_ATTEMPTS 10
244 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
245                                 unsigned int *id_len)
246 {
247         unsigned int retry = 0;
248         do
249                 if (RAND_pseudo_bytes(id, *id_len) <= 0)
250                         return 0;
251         while(SSL_has_matching_session_id(ssl, id, *id_len) &&
252                 (++retry < MAX_SESS_ID_ATTEMPTS));
253         if(retry < MAX_SESS_ID_ATTEMPTS)
254                 return 1;
255         /* else - woops a session_id match */
256         /* XXX We should also check the external cache --
257          * but the probability of a collision is negligible, and
258          * we could not prevent the concurrent creation of sessions
259          * with identical IDs since we currently don't have means
260          * to atomically check whether a session ID already exists
261          * and make a reservation for it if it does not
262          * (this problem applies to the internal cache as well).
263          */
264         return 0;
265 }
266
267 int ssl_get_new_session(SSL *s, int session)
268         {
269         /* This gets used by clients and servers. */
270
271         unsigned int tmp;
272         SSL_SESSION *ss=NULL;
273         GEN_SESSION_CB cb = def_generate_session_id;
274
275         if ((ss=SSL_SESSION_new()) == NULL) return(0);
276
277         /* If the context has a default timeout, use it */
278         if (s->session_ctx->session_timeout == 0)
279                 ss->timeout=SSL_get_default_timeout(s);
280         else
281                 ss->timeout=s->session_ctx->session_timeout;
282
283         if (s->session != NULL)
284                 {
285                 SSL_SESSION_free(s->session);
286                 s->session=NULL;
287                 }
288
289         if (session)
290                 {
291                 if (s->version == SSL2_VERSION)
292                         {
293                         ss->ssl_version=SSL2_VERSION;
294                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
295                         }
296                 else if (s->version == SSL3_VERSION)
297                         {
298                         ss->ssl_version=SSL3_VERSION;
299                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
300                         }
301                 else if (s->version == TLS1_VERSION)
302                         {
303                         ss->ssl_version=TLS1_VERSION;
304                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
305                         }
306                 else if (s->version == TLS1_1_VERSION)
307                         {
308                         ss->ssl_version=TLS1_1_VERSION;
309                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
310                         }
311                 else if (s->version == TLS1_2_VERSION)
312                         {
313                         ss->ssl_version=TLS1_2_VERSION;
314                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
315                         }
316                 else if (s->version == DTLS1_BAD_VER)
317                         {
318                         ss->ssl_version=DTLS1_BAD_VER;
319                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
320                         }
321                 else if (s->version == DTLS1_VERSION)
322                         {
323                         ss->ssl_version=DTLS1_VERSION;
324                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
325                         }
326                 else
327                         {
328                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
329                         SSL_SESSION_free(ss);
330                         return(0);
331                         }
332 #ifndef OPENSSL_NO_TLSEXT
333                 /* If RFC4507 ticket use empty session ID */
334                 if (s->tlsext_ticket_expected)
335                         {
336                         ss->session_id_length = 0;
337                         goto sess_id_done;
338                         }
339 #endif
340                 /* Choose which callback will set the session ID */
341                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
342                 if(s->generate_session_id)
343                         cb = s->generate_session_id;
344                 else if(s->session_ctx->generate_session_id)
345                         cb = s->session_ctx->generate_session_id;
346                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
347                 /* Choose a session ID */
348                 tmp = ss->session_id_length;
349                 if(!cb(s, ss->session_id, &tmp))
350                         {
351                         /* The callback failed */
352                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
353                                 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
354                         SSL_SESSION_free(ss);
355                         return(0);
356                         }
357                 /* Don't allow the callback to set the session length to zero.
358                  * nor set it higher than it was. */
359                 if(!tmp || (tmp > ss->session_id_length))
360                         {
361                         /* The callback set an illegal length */
362                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
363                                 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
364                         SSL_SESSION_free(ss);
365                         return(0);
366                         }
367                 /* If the session length was shrunk and we're SSLv2, pad it */
368                 if((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
369                         memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
370                 else
371                         ss->session_id_length = tmp;
372                 /* Finally, check for a conflict */
373                 if(SSL_has_matching_session_id(s, ss->session_id,
374                                                 ss->session_id_length))
375                         {
376                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
377                                 SSL_R_SSL_SESSION_ID_CONFLICT);
378                         SSL_SESSION_free(ss);
379                         return(0);
380                         }
381 #ifndef OPENSSL_NO_TLSEXT
382                 sess_id_done:
383                 if (s->tlsext_hostname) {
384                         ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
385                         if (ss->tlsext_hostname == NULL) {
386                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
387                                 SSL_SESSION_free(ss);
388                                 return 0;
389                                 }
390                         }
391 #ifndef OPENSSL_NO_EC
392                 if (s->tlsext_ecpointformatlist)
393                         {
394                         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
395                         if ((ss->tlsext_ecpointformatlist = OPENSSL_malloc(s->tlsext_ecpointformatlist_length)) == NULL)
396                                 {
397                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
398                                 SSL_SESSION_free(ss);
399                                 return 0;
400                                 }
401                         ss->tlsext_ecpointformatlist_length = s->tlsext_ecpointformatlist_length;
402                         memcpy(ss->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist_length);
403                         }
404                 if (s->tlsext_ellipticcurvelist)
405                         {
406                         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
407                         if ((ss->tlsext_ellipticcurvelist = OPENSSL_malloc(s->tlsext_ellipticcurvelist_length)) == NULL)
408                                 {
409                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
410                                 SSL_SESSION_free(ss);
411                                 return 0;
412                                 }
413                         ss->tlsext_ellipticcurvelist_length = s->tlsext_ellipticcurvelist_length;
414                         memcpy(ss->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist_length);
415                         }
416 #endif
417 #endif
418                 }
419         else
420                 {
421                 ss->session_id_length=0;
422                 }
423
424         if (s->sid_ctx_length > sizeof ss->sid_ctx)
425                 {
426                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
427                 SSL_SESSION_free(ss);
428                 return 0;
429                 }
430         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
431         ss->sid_ctx_length=s->sid_ctx_length;
432         s->session=ss;
433         ss->ssl_version=s->version;
434         ss->verify_result = X509_V_OK;
435
436         return(1);
437         }
438
439 /* ssl_get_prev attempts to find an SSL_SESSION to be used to resume this
440  * connection. It is only called by servers.
441  *
442  *   session_id: points at the session ID in the ClientHello. This code will
443  *       read past the end of this in order to parse out the session ticket
444  *       extension, if any.
445  *   len: the length of the session ID.
446  *   limit: a pointer to the first byte after the ClientHello.
447  *
448  * Returns:
449  *   -1: error
450  *    0: a session may have been found.
451  *
452  * Side effects:
453  *   - If a session is found then s->session is pointed at it (after freeing an
454  *     existing session if need be) and s->verify_result is set from the session.
455  *   - Both for new and resumed sessions, s->tlsext_ticket_expected is set to 1
456  *     if the server should issue a new session ticket (to 0 otherwise).
457  */
458 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
459                         const unsigned char *limit)
460         {
461         /* This is used only by servers. */
462
463         SSL_SESSION *ret=NULL;
464         int fatal = 0;
465         int try_session_cache = 1;
466 #ifndef OPENSSL_NO_TLSEXT
467         int r;
468 #endif
469
470         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
471                 goto err;
472
473         if (len == 0)
474                 try_session_cache = 0;
475
476 #ifndef OPENSSL_NO_TLSEXT
477         r = tls1_process_ticket(s, session_id, len, limit, &ret); /* sets s->tlsext_ticket_expected */
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                 if (!try_session_cache)
614                         {
615                         /* The session was from a ticket, so we should
616                          * issue a ticket for the new session */
617                         s->tlsext_ticket_expected = 1;
618                         }
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 unsigned int SSL_SESSION_get_id_len(SSL_SESSION *s)
866         {
867         return s->session_id_length;
868         }
869
870 const unsigned char *SSL_SESSION_get0_id(SSL_SESSION *s)
871         {
872         return s->session_id;
873         }
874
875 X509 *SSL_SESSION_get0_peer(SSL_SESSION *s)
876         {
877         return s->peer;
878         }
879
880 int SSL_SESSION_set1_id_context(SSL_SESSION *s,const unsigned char *sid_ctx,
881                                unsigned int sid_ctx_len)
882         {
883         if(sid_ctx_len > SSL_MAX_SID_CTX_LENGTH)
884                 {
885                 SSLerr(SSL_F_SSL_SESSION_SET1_ID_CONTEXT,SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG);
886                 return 0;
887                 }
888         s->sid_ctx_length=sid_ctx_len;
889         memcpy(s->sid_ctx,sid_ctx,sid_ctx_len);
890
891         return 1;
892         }
893
894 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
895         {
896         long l;
897         if (s == NULL) return(0);
898         l=s->session_timeout;
899         s->session_timeout=t;
900         return(l);
901         }
902
903 long SSL_CTX_get_timeout(const SSL_CTX *s)
904         {
905         if (s == NULL) return(0);
906         return(s->session_timeout);
907         }
908
909 #ifndef OPENSSL_NO_TLSEXT
910 int SSL_set_session_secret_cb(SSL *s, int (*tls_session_secret_cb)(SSL *s, void *secret, int *secret_len,
911         STACK_OF(SSL_CIPHER) *peer_ciphers, SSL_CIPHER **cipher, void *arg), void *arg)
912         {
913         if (s == NULL) return(0);
914         s->tls_session_secret_cb = tls_session_secret_cb;
915         s->tls_session_secret_cb_arg = arg;
916         return(1);
917         }
918
919 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
920                                   void *arg)
921         {
922         if (s == NULL) return(0);
923         s->tls_session_ticket_ext_cb = cb;
924         s->tls_session_ticket_ext_cb_arg = arg;
925         return(1);
926         }
927
928 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
929         {
930         if (s->version >= TLS1_VERSION)
931                 {
932                 if (s->tlsext_session_ticket)
933                         {
934                         OPENSSL_free(s->tlsext_session_ticket);
935                         s->tlsext_session_ticket = NULL;
936                         }
937
938                 s->tlsext_session_ticket = OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
939                 if (!s->tlsext_session_ticket)
940                         {
941                         SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
942                         return 0;
943                         }
944
945                 if (ext_data)
946                         {
947                         s->tlsext_session_ticket->length = ext_len;
948                         s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
949                         memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
950                         }
951                 else
952                         {
953                         s->tlsext_session_ticket->length = 0;
954                         s->tlsext_session_ticket->data = NULL;
955                         }
956
957                 return 1;
958                 }
959
960         return 0;
961         }
962 #endif /* OPENSSL_NO_TLSEXT */
963
964 typedef struct timeout_param_st
965         {
966         SSL_CTX *ctx;
967         long time;
968         LHASH_OF(SSL_SESSION) *cache;
969         } TIMEOUT_PARAM;
970
971 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
972         {
973         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
974                 {
975                 /* The reason we don't call SSL_CTX_remove_session() is to
976                  * save on locking overhead */
977                 (void)lh_SSL_SESSION_delete(p->cache,s);
978                 SSL_SESSION_list_remove(p->ctx,s);
979                 s->not_resumable=1;
980                 if (p->ctx->remove_session_cb != NULL)
981                         p->ctx->remove_session_cb(p->ctx,s);
982                 SSL_SESSION_free(s);
983                 }
984         }
985
986 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
987
988 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
989         {
990         unsigned long i;
991         TIMEOUT_PARAM tp;
992
993         tp.ctx=s;
994         tp.cache=s->sessions;
995         if (tp.cache == NULL) return;
996         tp.time=t;
997         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
998         i=CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
999         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=0;
1000         lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
1001                                  TIMEOUT_PARAM, &tp);
1002         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=i;
1003         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
1004         }
1005
1006 int ssl_clear_bad_session(SSL *s)
1007         {
1008         if (    (s->session != NULL) &&
1009                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
1010                 !(SSL_in_init(s) || SSL_in_before(s)))
1011                 {
1012                 SSL_CTX_remove_session(s->ctx,s->session);
1013                 return(1);
1014                 }
1015         else
1016                 return(0);
1017         }
1018
1019 /* locked by SSL_CTX in the calling function */
1020 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
1021         {
1022         if ((s->next == NULL) || (s->prev == NULL)) return;
1023
1024         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
1025                 { /* last element in list */
1026                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
1027                         { /* only one element in list */
1028                         ctx->session_cache_head=NULL;
1029                         ctx->session_cache_tail=NULL;
1030                         }
1031                 else
1032                         {
1033                         ctx->session_cache_tail=s->prev;
1034                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
1035                         }
1036                 }
1037         else
1038                 {
1039                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
1040                         { /* first element in list */
1041                         ctx->session_cache_head=s->next;
1042                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1043                         }
1044                 else
1045                         { /* middle of list */
1046                         s->next->prev=s->prev;
1047                         s->prev->next=s->next;
1048                         }
1049                 }
1050         s->prev=s->next=NULL;
1051         }
1052
1053 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
1054         {
1055         if ((s->next != NULL) && (s->prev != NULL))
1056                 SSL_SESSION_list_remove(ctx,s);
1057
1058         if (ctx->session_cache_head == NULL)
1059                 {
1060                 ctx->session_cache_head=s;
1061                 ctx->session_cache_tail=s;
1062                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1063                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
1064                 }
1065         else
1066                 {
1067                 s->next=ctx->session_cache_head;
1068                 s->next->prev=s;
1069                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1070                 ctx->session_cache_head=s;
1071                 }
1072         }
1073
1074 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1075         int (*cb)(struct ssl_st *ssl,SSL_SESSION *sess))
1076         {
1077         ctx->new_session_cb=cb;
1078         }
1079
1080 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl, SSL_SESSION *sess)
1081         {
1082         return ctx->new_session_cb;
1083         }
1084
1085 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1086         void (*cb)(SSL_CTX *ctx,SSL_SESSION *sess))
1087         {
1088         ctx->remove_session_cb=cb;
1089         }
1090
1091 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(SSL_CTX * ctx,SSL_SESSION *sess)
1092         {
1093         return ctx->remove_session_cb;
1094         }
1095
1096 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1097         SSL_SESSION *(*cb)(struct ssl_st *ssl,
1098                  unsigned char *data,int len,int *copy))
1099         {
1100         ctx->get_session_cb=cb;
1101         }
1102
1103 SSL_SESSION * (*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl,
1104                  unsigned char *data,int len,int *copy)
1105         {
1106         return ctx->get_session_cb;
1107         }
1108
1109 void SSL_CTX_set_info_callback(SSL_CTX *ctx, 
1110         void (*cb)(const SSL *ssl,int type,int val))
1111         {
1112         ctx->info_callback=cb;
1113         }
1114
1115 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,int type,int val)
1116         {
1117         return ctx->info_callback;
1118         }
1119
1120 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1121         int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey))
1122         {
1123         ctx->client_cert_cb=cb;
1124         }
1125
1126 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL * ssl, X509 ** x509 , EVP_PKEY **pkey)
1127         {
1128         return ctx->client_cert_cb;
1129         }
1130
1131 #ifndef OPENSSL_NO_ENGINE
1132 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1133         {
1134         if (!ENGINE_init(e))
1135                 {
1136                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1137                 return 0;
1138                 }
1139         if(!ENGINE_get_ssl_client_cert_function(e))
1140                 {
1141                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, SSL_R_NO_CLIENT_CERT_METHOD);
1142                 ENGINE_finish(e);
1143                 return 0;
1144                 }
1145         ctx->client_cert_engine = e;
1146         return 1;
1147         }
1148 #endif
1149
1150 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1151         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int *cookie_len))
1152         {
1153         ctx->app_gen_cookie_cb=cb;
1154         }
1155
1156 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1157         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int cookie_len))
1158         {
1159         ctx->app_verify_cookie_cb=cb;
1160         }
1161
1162 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)