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