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