Note SRP support.
[openssl.git] / ssl / ssl_sess.c
1 /* ssl/ssl_sess.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111 /* ====================================================================
112  * Copyright 2005 Nokia. All rights reserved.
113  *
114  * The portions of the attached software ("Contribution") is developed by
115  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
116  * license.
117  *
118  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
119  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
120  * support (see RFC 4279) to OpenSSL.
121  *
122  * No patent licenses or other rights except those expressly stated in
123  * the OpenSSL open source license shall be deemed granted or received
124  * expressly, by implication, estoppel, or otherwise.
125  *
126  * No assurances are provided by Nokia that the Contribution does not
127  * infringe the patent or other intellectual property rights of any third
128  * party or that the license provides you with all the necessary rights
129  * to make use of the Contribution.
130  *
131  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
132  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
133  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
134  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
135  * OTHERWISE.
136  */
137
138 #include <stdio.h>
139 #include <openssl/lhash.h>
140 #include <openssl/rand.h>
141 #ifndef OPENSSL_NO_ENGINE
142 #include <openssl/engine.h>
143 #endif
144 #include "ssl_locl.h"
145
146 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
147 static void SSL_SESSION_list_add(SSL_CTX *ctx,SSL_SESSION *s);
148 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
149
150 SSL_SESSION *SSL_get_session(const SSL *ssl)
151 /* aka SSL_get0_session; gets 0 objects, just returns a copy of the pointer */
152         {
153         return(ssl->session);
154         }
155
156 SSL_SESSION *SSL_get1_session(SSL *ssl)
157 /* variant of SSL_get_session: caller really gets something */
158         {
159         SSL_SESSION *sess;
160         /* Need to lock this all up rather than just use CRYPTO_add so that
161          * somebody doesn't free ssl->session between when we check it's
162          * non-null and when we up the reference count. */
163         CRYPTO_w_lock(CRYPTO_LOCK_SSL_SESSION);
164         sess = ssl->session;
165         if(sess)
166                 sess->references++;
167         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_SESSION);
168         return(sess);
169         }
170
171 int SSL_SESSION_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
172              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
173         {
174         return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, argl, argp,
175                         new_func, dup_func, free_func);
176         }
177
178 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
179         {
180         return(CRYPTO_set_ex_data(&s->ex_data,idx,arg));
181         }
182
183 void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx)
184         {
185         return(CRYPTO_get_ex_data(&s->ex_data,idx));
186         }
187
188 SSL_SESSION *SSL_SESSION_new(void)
189         {
190         SSL_SESSION *ss;
191
192         ss=(SSL_SESSION *)OPENSSL_malloc(sizeof(SSL_SESSION));
193         if (ss == NULL)
194                 {
195                 SSLerr(SSL_F_SSL_SESSION_NEW,ERR_R_MALLOC_FAILURE);
196                 return(0);
197                 }
198         memset(ss,0,sizeof(SSL_SESSION));
199
200         ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
201         ss->references=1;
202         ss->timeout=60*5+4; /* 5 minute timeout by default */
203         ss->time=(unsigned long)time(NULL);
204         ss->prev=NULL;
205         ss->next=NULL;
206         ss->compress_meth=0;
207 #ifndef OPENSSL_NO_TLSEXT
208         ss->tlsext_hostname = NULL; 
209 #ifndef OPENSSL_NO_EC
210         ss->tlsext_ecpointformatlist_length = 0;
211         ss->tlsext_ecpointformatlist = NULL;
212         ss->tlsext_ellipticcurvelist_length = 0;
213         ss->tlsext_ellipticcurvelist = NULL;
214 #endif
215 #endif
216         CRYPTO_new_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
217 #ifndef OPENSSL_NO_PSK
218         ss->psk_identity_hint=NULL;
219         ss->psk_identity=NULL;
220 #endif
221 #ifndef OPENSSL_NO_SRP
222         ss->srp_username=NULL;
223 #endif
224         return(ss);
225         }
226
227 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, unsigned int *len)
228         {
229         if(len)
230                 *len = s->session_id_length;
231         return s->session_id;
232         }
233
234 /* Even with SSLv2, we have 16 bytes (128 bits) of session ID space. SSLv3/TLSv1
235  * has 32 bytes (256 bits). As such, filling the ID with random gunk repeatedly
236  * until we have no conflict is going to complete in one iteration pretty much
237  * "most" of the time (btw: understatement). So, if it takes us 10 iterations
238  * and we still can't avoid a conflict - well that's a reasonable point to call
239  * it quits. Either the RAND code is broken or someone is trying to open roughly
240  * very close to 2^128 (or 2^256) SSL sessions to our server. How you might
241  * store that many sessions is perhaps a more interesting question ... */
242
243 #define MAX_SESS_ID_ATTEMPTS 10
244 static int def_generate_session_id(const SSL *ssl, unsigned char *id,
245                                 unsigned int *id_len)
246 {
247         unsigned int retry = 0;
248         do
249                 if (RAND_pseudo_bytes(id, *id_len) <= 0)
250                         return 0;
251         while(SSL_has_matching_session_id(ssl, id, *id_len) &&
252                 (++retry < MAX_SESS_ID_ATTEMPTS));
253         if(retry < MAX_SESS_ID_ATTEMPTS)
254                 return 1;
255         /* else - woops a session_id match */
256         /* XXX We should also check the external cache --
257          * but the probability of a collision is negligible, and
258          * we could not prevent the concurrent creation of sessions
259          * with identical IDs since we currently don't have means
260          * to atomically check whether a session ID already exists
261          * and make a reservation for it if it does not
262          * (this problem applies to the internal cache as well).
263          */
264         return 0;
265 }
266
267 int ssl_get_new_session(SSL *s, int session)
268         {
269         /* This gets used by clients and servers. */
270
271         unsigned int tmp;
272         SSL_SESSION *ss=NULL;
273         GEN_SESSION_CB cb = def_generate_session_id;
274
275         if ((ss=SSL_SESSION_new()) == NULL) return(0);
276
277         /* If the context has a default timeout, use it */
278         if (s->session_ctx->session_timeout == 0)
279                 ss->timeout=SSL_get_default_timeout(s);
280         else
281                 ss->timeout=s->session_ctx->session_timeout;
282
283         if (s->session != NULL)
284                 {
285                 SSL_SESSION_free(s->session);
286                 s->session=NULL;
287                 }
288
289         if (session)
290                 {
291                 if (s->version == SSL2_VERSION)
292                         {
293                         ss->ssl_version=SSL2_VERSION;
294                         ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
295                         }
296                 else if (s->version == SSL3_VERSION)
297                         {
298                         ss->ssl_version=SSL3_VERSION;
299                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
300                         }
301                 else if (s->version == TLS1_VERSION)
302                         {
303                         ss->ssl_version=TLS1_VERSION;
304                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
305                         }
306                 else if (s->version == TLS1_1_VERSION)
307                         {
308                         ss->ssl_version=TLS1_1_VERSION;
309                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
310                         }
311                 else if (s->version == DTLS1_BAD_VER)
312                         {
313                         ss->ssl_version=DTLS1_BAD_VER;
314                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
315                         }
316                 else if (s->version == DTLS1_VERSION)
317                         {
318                         ss->ssl_version=DTLS1_VERSION;
319                         ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
320                         }
321                 else
322                         {
323                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
324                         SSL_SESSION_free(ss);
325                         return(0);
326                         }
327 #ifndef OPENSSL_NO_TLSEXT
328                 /* If RFC4507 ticket use empty session ID */
329                 if (s->tlsext_ticket_expected)
330                         {
331                         ss->session_id_length = 0;
332                         goto sess_id_done;
333                         }
334 #endif
335                 /* Choose which callback will set the session ID */
336                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
337                 if(s->generate_session_id)
338                         cb = s->generate_session_id;
339                 else if(s->session_ctx->generate_session_id)
340                         cb = s->session_ctx->generate_session_id;
341                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
342                 /* Choose a session ID */
343                 tmp = ss->session_id_length;
344                 if(!cb(s, ss->session_id, &tmp))
345                         {
346                         /* The callback failed */
347                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
348                                 SSL_R_SSL_SESSION_ID_CALLBACK_FAILED);
349                         SSL_SESSION_free(ss);
350                         return(0);
351                         }
352                 /* Don't allow the callback to set the session length to zero.
353                  * nor set it higher than it was. */
354                 if(!tmp || (tmp > ss->session_id_length))
355                         {
356                         /* The callback set an illegal length */
357                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
358                                 SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH);
359                         SSL_SESSION_free(ss);
360                         return(0);
361                         }
362                 /* If the session length was shrunk and we're SSLv2, pad it */
363                 if((tmp < ss->session_id_length) && (s->version == SSL2_VERSION))
364                         memset(ss->session_id + tmp, 0, ss->session_id_length - tmp);
365                 else
366                         ss->session_id_length = tmp;
367                 /* Finally, check for a conflict */
368                 if(SSL_has_matching_session_id(s, ss->session_id,
369                                                 ss->session_id_length))
370                         {
371                         SSLerr(SSL_F_SSL_GET_NEW_SESSION,
372                                 SSL_R_SSL_SESSION_ID_CONFLICT);
373                         SSL_SESSION_free(ss);
374                         return(0);
375                         }
376 #ifndef OPENSSL_NO_TLSEXT
377                 sess_id_done:
378                 if (s->tlsext_hostname) {
379                         ss->tlsext_hostname = BUF_strdup(s->tlsext_hostname);
380                         if (ss->tlsext_hostname == NULL) {
381                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
382                                 SSL_SESSION_free(ss);
383                                 return 0;
384                                 }
385                         }
386 #ifndef OPENSSL_NO_EC
387                 if (s->tlsext_ecpointformatlist)
388                         {
389                         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
390                         if ((ss->tlsext_ecpointformatlist = OPENSSL_malloc(s->tlsext_ecpointformatlist_length)) == NULL)
391                                 {
392                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
393                                 SSL_SESSION_free(ss);
394                                 return 0;
395                                 }
396                         ss->tlsext_ecpointformatlist_length = s->tlsext_ecpointformatlist_length;
397                         memcpy(ss->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist, s->tlsext_ecpointformatlist_length);
398                         }
399                 if (s->tlsext_ellipticcurvelist)
400                         {
401                         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
402                         if ((ss->tlsext_ellipticcurvelist = OPENSSL_malloc(s->tlsext_ellipticcurvelist_length)) == NULL)
403                                 {
404                                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_MALLOC_FAILURE);
405                                 SSL_SESSION_free(ss);
406                                 return 0;
407                                 }
408                         ss->tlsext_ellipticcurvelist_length = s->tlsext_ellipticcurvelist_length;
409                         memcpy(ss->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist, s->tlsext_ellipticcurvelist_length);
410                         }
411 #endif
412 #endif
413                 }
414         else
415                 {
416                 ss->session_id_length=0;
417                 }
418
419         if (s->sid_ctx_length > sizeof ss->sid_ctx)
420                 {
421                 SSLerr(SSL_F_SSL_GET_NEW_SESSION, ERR_R_INTERNAL_ERROR);
422                 SSL_SESSION_free(ss);
423                 return 0;
424                 }
425         memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
426         ss->sid_ctx_length=s->sid_ctx_length;
427         s->session=ss;
428         ss->ssl_version=s->version;
429         ss->verify_result = X509_V_OK;
430
431         return(1);
432         }
433
434 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len,
435                         const unsigned char *limit)
436         {
437         /* This is used only by servers. */
438
439         SSL_SESSION *ret=NULL;
440         int fatal = 0;
441 #ifndef OPENSSL_NO_TLSEXT
442         int r;
443 #endif
444
445         if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
446                 goto err;
447 #ifndef OPENSSL_NO_TLSEXT
448         r = tls1_process_ticket(s, session_id, len, limit, &ret);
449         if (r == -1)
450                 {
451                 fatal = 1;
452                 goto err;
453                 }
454         else if (r == 0 || (!ret && !len))
455                 goto err;
456         else if (!ret && !(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
457 #else
458         if (len == 0)
459                 goto err;
460         if (!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
461 #endif
462                 {
463                 SSL_SESSION data;
464                 data.ssl_version=s->version;
465                 data.session_id_length=len;
466                 if (len == 0)
467                         return 0;
468                 memcpy(data.session_id,session_id,len);
469                 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
470                 ret=lh_SSL_SESSION_retrieve(s->session_ctx->sessions,&data);
471                 if (ret != NULL)
472                     /* don't allow other threads to steal it: */
473                     CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
474                 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
475                 }
476
477         if (ret == NULL)
478                 {
479                 int copy=1;
480         
481                 s->session_ctx->stats.sess_miss++;
482                 ret=NULL;
483                 if (s->session_ctx->get_session_cb != NULL
484                     && (ret=s->session_ctx->get_session_cb(s,session_id,len,&copy))
485                        != NULL)
486                         {
487                         s->session_ctx->stats.sess_cb_hit++;
488
489                         /* Increment reference count now if the session callback
490                          * asks us to do so (note that if the session structures
491                          * returned by the callback are shared between threads,
492                          * it must handle the reference count itself [i.e. copy == 0],
493                          * or things won't be thread-safe). */
494                         if (copy)
495                                 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
496
497                         /* Add the externally cached session to the internal
498                          * cache as well if and only if we are supposed to. */
499                         if(!(s->session_ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_STORE))
500                                 /* The following should not return 1, otherwise,
501                                  * things are very strange */
502                                 SSL_CTX_add_session(s->session_ctx,ret);
503                         }
504                 if (ret == NULL)
505                         goto err;
506                 }
507
508         /* Now ret is non-NULL, and we own one of its reference counts. */
509
510         if (ret->sid_ctx_length != s->sid_ctx_length
511             || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length))
512                 {
513                 /* We've found the session named by the client, but we don't
514                  * want to use it in this context. */
515
516 #if 0 /* The client cannot always know when a session is not appropriate,
517        * so we shouldn't generate an error message. */
518
519                 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
520 #endif
521                 goto err; /* treat like cache miss */
522                 }
523         
524         if((s->verify_mode & SSL_VERIFY_PEER) && s->sid_ctx_length == 0)
525                 {
526                 /* We can't be sure if this session is being used out of
527                  * context, which is especially important for SSL_VERIFY_PEER.
528                  * The application should have used SSL[_CTX]_set_session_id_context.
529                  *
530                  * For this error case, we generate an error instead of treating
531                  * the event like a cache miss (otherwise it would be easy for
532                  * applications to effectively disable the session cache by
533                  * accident without anyone noticing).
534                  */
535                 
536                 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
537                 fatal = 1;
538                 goto err;
539                 }
540
541         if (ret->cipher == NULL)
542                 {
543                 unsigned char buf[5],*p;
544                 unsigned long l;
545
546                 p=buf;
547                 l=ret->cipher_id;
548                 l2n(l,p);
549                 if ((ret->ssl_version>>8) >= SSL3_VERSION_MAJOR)
550                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
551                 else 
552                         ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
553                 if (ret->cipher == NULL)
554                         goto err;
555                 }
556
557
558 #if 0 /* This is way too late. */
559
560         /* If a thread got the session, then 'swaped', and another got
561          * it and then due to a time-out decided to 'OPENSSL_free' it we could
562          * be in trouble.  So I'll increment it now, then double decrement
563          * later - am I speaking rubbish?. */
564         CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
565 #endif
566
567         if (ret->timeout < (long)(time(NULL) - ret->time)) /* timeout */
568                 {
569                 s->session_ctx->stats.sess_timeout++;
570                 /* remove it from the cache */
571                 SSL_CTX_remove_session(s->session_ctx,ret);
572                 goto err;
573                 }
574
575         s->session_ctx->stats.sess_hit++;
576
577         /* ret->time=time(NULL); */ /* rezero timeout? */
578         /* again, just leave the session 
579          * if it is the same session, we have just incremented and
580          * then decremented the reference count :-) */
581         if (s->session != NULL)
582                 SSL_SESSION_free(s->session);
583         s->session=ret;
584         s->verify_result = s->session->verify_result;
585         return(1);
586
587  err:
588         if (ret != NULL)
589                 SSL_SESSION_free(ret);
590         if (fatal)
591                 return -1;
592         else
593                 return 0;
594         }
595
596 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
597         {
598         int ret=0;
599         SSL_SESSION *s;
600
601         /* add just 1 reference count for the SSL_CTX's session cache
602          * even though it has two ways of access: each session is in a
603          * doubly linked list and an lhash */
604         CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
605         /* if session c is in already in cache, we take back the increment later */
606
607         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
608         s=lh_SSL_SESSION_insert(ctx->sessions,c);
609         
610         /* s != NULL iff we already had a session with the given PID.
611          * In this case, s == c should hold (then we did not really modify
612          * ctx->sessions), or we're in trouble. */
613         if (s != NULL && s != c)
614                 {
615                 /* We *are* in trouble ... */
616                 SSL_SESSION_list_remove(ctx,s);
617                 SSL_SESSION_free(s);
618                 /* ... so pretend the other session did not exist in cache
619                  * (we cannot handle two SSL_SESSION structures with identical
620                  * session ID in the same cache, which could happen e.g. when
621                  * two threads concurrently obtain the same session from an external
622                  * cache) */
623                 s = NULL;
624                 }
625
626         /* Put at the head of the queue unless it is already in the cache */
627         if (s == NULL)
628                 SSL_SESSION_list_add(ctx,c);
629
630         if (s != NULL)
631                 {
632                 /* existing cache entry -- decrement previously incremented reference
633                  * count because it already takes into account the cache */
634
635                 SSL_SESSION_free(s); /* s == c */
636                 ret=0;
637                 }
638         else
639                 {
640                 /* new cache entry -- remove old ones if cache has become too large */
641                 
642                 ret=1;
643
644                 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
645                         {
646                         while (SSL_CTX_sess_number(ctx) >
647                                 SSL_CTX_sess_get_cache_size(ctx))
648                                 {
649                                 if (!remove_session_lock(ctx,
650                                         ctx->session_cache_tail, 0))
651                                         break;
652                                 else
653                                         ctx->stats.sess_cache_full++;
654                                 }
655                         }
656                 }
657         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
658         return(ret);
659         }
660
661 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
662 {
663         return remove_session_lock(ctx, c, 1);
664 }
665
666 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
667         {
668         SSL_SESSION *r;
669         int ret=0;
670
671         if ((c != NULL) && (c->session_id_length != 0))
672                 {
673                 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
674                 if ((r = lh_SSL_SESSION_retrieve(ctx->sessions,c)) == c)
675                         {
676                         ret=1;
677                         r=lh_SSL_SESSION_delete(ctx->sessions,c);
678                         SSL_SESSION_list_remove(ctx,c);
679                         }
680
681                 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
682
683                 if (ret)
684                         {
685                         r->not_resumable=1;
686                         if (ctx->remove_session_cb != NULL)
687                                 ctx->remove_session_cb(ctx,r);
688                         SSL_SESSION_free(r);
689                         }
690                 }
691         else
692                 ret=0;
693         return(ret);
694         }
695
696 void SSL_SESSION_free(SSL_SESSION *ss)
697         {
698         int i;
699
700         if(ss == NULL)
701             return;
702
703         i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
704 #ifdef REF_PRINT
705         REF_PRINT("SSL_SESSION",ss);
706 #endif
707         if (i > 0) return;
708 #ifdef REF_CHECK
709         if (i < 0)
710                 {
711                 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
712                 abort(); /* ok */
713                 }
714 #endif
715
716         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_SSL_SESSION, ss, &ss->ex_data);
717
718         OPENSSL_cleanse(ss->key_arg,sizeof ss->key_arg);
719         OPENSSL_cleanse(ss->master_key,sizeof ss->master_key);
720         OPENSSL_cleanse(ss->session_id,sizeof ss->session_id);
721         if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
722         if (ss->peer != NULL) X509_free(ss->peer);
723         if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
724 #ifndef OPENSSL_NO_TLSEXT
725         if (ss->tlsext_hostname != NULL) OPENSSL_free(ss->tlsext_hostname);
726         if (ss->tlsext_tick != NULL) OPENSSL_free(ss->tlsext_tick);
727 #ifndef OPENSSL_NO_EC
728         ss->tlsext_ecpointformatlist_length = 0;
729         if (ss->tlsext_ecpointformatlist != NULL) OPENSSL_free(ss->tlsext_ecpointformatlist);
730         ss->tlsext_ellipticcurvelist_length = 0;
731         if (ss->tlsext_ellipticcurvelist != NULL) OPENSSL_free(ss->tlsext_ellipticcurvelist);
732 #endif /* OPENSSL_NO_EC */
733 #endif
734 #ifndef OPENSSL_NO_PSK
735         if (ss->psk_identity_hint != NULL)
736                 OPENSSL_free(ss->psk_identity_hint);
737         if (ss->psk_identity != NULL)
738                 OPENSSL_free(ss->psk_identity);
739 #endif
740 #ifndef OPENSSL_NO_SRP
741         if (ss->srp_username != NULL)
742                 OPENSSL_free(ss->srp_username);
743 #endif
744         OPENSSL_cleanse(ss,sizeof(*ss));
745         OPENSSL_free(ss);
746         }
747
748 int SSL_set_session(SSL *s, SSL_SESSION *session)
749         {
750         int ret=0;
751         const SSL_METHOD *meth;
752
753         if (session != NULL)
754                 {
755                 meth=s->ctx->method->get_ssl_method(session->ssl_version);
756                 if (meth == NULL)
757                         meth=s->method->get_ssl_method(session->ssl_version);
758                 if (meth == NULL)
759                         {
760                         SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
761                         return(0);
762                         }
763
764                 if (meth != s->method)
765                         {
766                         if (!SSL_set_ssl_method(s,meth))
767                                 return(0);
768                         if (s->ctx->session_timeout == 0)
769                                 session->timeout=SSL_get_default_timeout(s);
770                         else
771                                 session->timeout=s->ctx->session_timeout;
772                         }
773
774 #ifndef OPENSSL_NO_KRB5
775                 if (s->kssl_ctx && !s->kssl_ctx->client_princ &&
776                     session->krb5_client_princ_len > 0)
777                 {
778                     s->kssl_ctx->client_princ = (char *)OPENSSL_malloc(session->krb5_client_princ_len + 1);
779                     memcpy(s->kssl_ctx->client_princ,session->krb5_client_princ,
780                             session->krb5_client_princ_len);
781                     s->kssl_ctx->client_princ[session->krb5_client_princ_len] = '\0';
782                 }
783 #endif /* OPENSSL_NO_KRB5 */
784
785                 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
786                 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
787                 if (s->session != NULL)
788                         SSL_SESSION_free(s->session);
789                 s->session=session;
790                 s->verify_result = s->session->verify_result;
791                 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
792                 ret=1;
793                 }
794         else
795                 {
796                 if (s->session != NULL)
797                         {
798                         SSL_SESSION_free(s->session);
799                         s->session=NULL;
800                         }
801
802                 meth=s->ctx->method;
803                 if (meth != s->method)
804                         {
805                         if (!SSL_set_ssl_method(s,meth))
806                                 return(0);
807                         }
808                 ret=1;
809                 }
810         return(ret);
811         }
812
813 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
814         {
815         if (s == NULL) return(0);
816         s->timeout=t;
817         return(1);
818         }
819
820 long SSL_SESSION_get_timeout(const SSL_SESSION *s)
821         {
822         if (s == NULL) return(0);
823         return(s->timeout);
824         }
825
826 long SSL_SESSION_get_time(const SSL_SESSION *s)
827         {
828         if (s == NULL) return(0);
829         return(s->time);
830         }
831
832 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
833         {
834         if (s == NULL) return(0);
835         s->time=t;
836         return(t);
837         }
838
839 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
840         {
841         long l;
842         if (s == NULL) return(0);
843         l=s->session_timeout;
844         s->session_timeout=t;
845         return(l);
846         }
847
848 long SSL_CTX_get_timeout(const SSL_CTX *s)
849         {
850         if (s == NULL) return(0);
851         return(s->session_timeout);
852         }
853
854 #ifndef OPENSSL_NO_TLSEXT
855 int SSL_set_session_secret_cb(SSL *s, int (*tls_session_secret_cb)(SSL *s, void *secret, int *secret_len,
856         STACK_OF(SSL_CIPHER) *peer_ciphers, SSL_CIPHER **cipher, void *arg), void *arg)
857         {
858         if (s == NULL) return(0);
859         s->tls_session_secret_cb = tls_session_secret_cb;
860         s->tls_session_secret_cb_arg = arg;
861         return(1);
862         }
863
864 int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
865                                   void *arg)
866         {
867         if (s == NULL) return(0);
868         s->tls_session_ticket_ext_cb = cb;
869         s->tls_session_ticket_ext_cb_arg = arg;
870         return(1);
871         }
872
873 int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len)
874         {
875         if (s->version >= TLS1_VERSION)
876                 {
877                 if (s->tlsext_session_ticket)
878                         {
879                         OPENSSL_free(s->tlsext_session_ticket);
880                         s->tlsext_session_ticket = NULL;
881                         }
882
883                 s->tlsext_session_ticket = OPENSSL_malloc(sizeof(TLS_SESSION_TICKET_EXT) + ext_len);
884                 if (!s->tlsext_session_ticket)
885                         {
886                         SSLerr(SSL_F_SSL_SET_SESSION_TICKET_EXT, ERR_R_MALLOC_FAILURE);
887                         return 0;
888                         }
889
890                 if (ext_data)
891                         {
892                         s->tlsext_session_ticket->length = ext_len;
893                         s->tlsext_session_ticket->data = s->tlsext_session_ticket + 1;
894                         memcpy(s->tlsext_session_ticket->data, ext_data, ext_len);
895                         }
896                 else
897                         {
898                         s->tlsext_session_ticket->length = 0;
899                         s->tlsext_session_ticket->data = NULL;
900                         }
901
902                 return 1;
903                 }
904
905         return 0;
906         }
907 #endif /* OPENSSL_NO_TLSEXT */
908
909 typedef struct timeout_param_st
910         {
911         SSL_CTX *ctx;
912         long time;
913         LHASH_OF(SSL_SESSION) *cache;
914         } TIMEOUT_PARAM;
915
916 static void timeout_doall_arg(SSL_SESSION *s, TIMEOUT_PARAM *p)
917         {
918         if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
919                 {
920                 /* The reason we don't call SSL_CTX_remove_session() is to
921                  * save on locking overhead */
922                 (void)lh_SSL_SESSION_delete(p->cache,s);
923                 SSL_SESSION_list_remove(p->ctx,s);
924                 s->not_resumable=1;
925                 if (p->ctx->remove_session_cb != NULL)
926                         p->ctx->remove_session_cb(p->ctx,s);
927                 SSL_SESSION_free(s);
928                 }
929         }
930
931 static IMPLEMENT_LHASH_DOALL_ARG_FN(timeout, SSL_SESSION, TIMEOUT_PARAM)
932
933 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
934         {
935         unsigned long i;
936         TIMEOUT_PARAM tp;
937
938         tp.ctx=s;
939         tp.cache=s->sessions;
940         if (tp.cache == NULL) return;
941         tp.time=t;
942         CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
943         i=CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load;
944         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=0;
945         lh_SSL_SESSION_doall_arg(tp.cache, LHASH_DOALL_ARG_FN(timeout),
946                                  TIMEOUT_PARAM, &tp);
947         CHECKED_LHASH_OF(SSL_SESSION, tp.cache)->down_load=i;
948         CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
949         }
950
951 int ssl_clear_bad_session(SSL *s)
952         {
953         if (    (s->session != NULL) &&
954                 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
955                 !(SSL_in_init(s) || SSL_in_before(s)))
956                 {
957                 SSL_CTX_remove_session(s->ctx,s->session);
958                 return(1);
959                 }
960         else
961                 return(0);
962         }
963
964 /* locked by SSL_CTX in the calling function */
965 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
966         {
967         if ((s->next == NULL) || (s->prev == NULL)) return;
968
969         if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
970                 { /* last element in list */
971                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
972                         { /* only one element in list */
973                         ctx->session_cache_head=NULL;
974                         ctx->session_cache_tail=NULL;
975                         }
976                 else
977                         {
978                         ctx->session_cache_tail=s->prev;
979                         s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
980                         }
981                 }
982         else
983                 {
984                 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
985                         { /* first element in list */
986                         ctx->session_cache_head=s->next;
987                         s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
988                         }
989                 else
990                         { /* middle of list */
991                         s->next->prev=s->prev;
992                         s->prev->next=s->next;
993                         }
994                 }
995         s->prev=s->next=NULL;
996         }
997
998 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
999         {
1000         if ((s->next != NULL) && (s->prev != NULL))
1001                 SSL_SESSION_list_remove(ctx,s);
1002
1003         if (ctx->session_cache_head == NULL)
1004                 {
1005                 ctx->session_cache_head=s;
1006                 ctx->session_cache_tail=s;
1007                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1008                 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
1009                 }
1010         else
1011                 {
1012                 s->next=ctx->session_cache_head;
1013                 s->next->prev=s;
1014                 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
1015                 ctx->session_cache_head=s;
1016                 }
1017         }
1018
1019 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
1020         int (*cb)(struct ssl_st *ssl,SSL_SESSION *sess))
1021         {
1022         ctx->new_session_cb=cb;
1023         }
1024
1025 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl, SSL_SESSION *sess)
1026         {
1027         return ctx->new_session_cb;
1028         }
1029
1030 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
1031         void (*cb)(SSL_CTX *ctx,SSL_SESSION *sess))
1032         {
1033         ctx->remove_session_cb=cb;
1034         }
1035
1036 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(SSL_CTX * ctx,SSL_SESSION *sess)
1037         {
1038         return ctx->remove_session_cb;
1039         }
1040
1041 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
1042         SSL_SESSION *(*cb)(struct ssl_st *ssl,
1043                  unsigned char *data,int len,int *copy))
1044         {
1045         ctx->get_session_cb=cb;
1046         }
1047
1048 SSL_SESSION * (*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl,
1049                  unsigned char *data,int len,int *copy)
1050         {
1051         return ctx->get_session_cb;
1052         }
1053
1054 void SSL_CTX_set_info_callback(SSL_CTX *ctx, 
1055         void (*cb)(const SSL *ssl,int type,int val))
1056         {
1057         ctx->info_callback=cb;
1058         }
1059
1060 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,int type,int val)
1061         {
1062         return ctx->info_callback;
1063         }
1064
1065 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
1066         int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey))
1067         {
1068         ctx->client_cert_cb=cb;
1069         }
1070
1071 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL * ssl, X509 ** x509 , EVP_PKEY **pkey)
1072         {
1073         return ctx->client_cert_cb;
1074         }
1075
1076 #ifndef OPENSSL_NO_ENGINE
1077 int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e)
1078         {
1079         if (!ENGINE_init(e))
1080                 {
1081                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, ERR_R_ENGINE_LIB);
1082                 return 0;
1083                 }
1084         if(!ENGINE_get_ssl_client_cert_function(e))
1085                 {
1086                 SSLerr(SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE, SSL_R_NO_CLIENT_CERT_METHOD);
1087                 ENGINE_finish(e);
1088                 return 0;
1089                 }
1090         ctx->client_cert_engine = e;
1091         return 1;
1092         }
1093 #endif
1094
1095 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
1096         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int *cookie_len))
1097         {
1098         ctx->app_gen_cookie_cb=cb;
1099         }
1100
1101 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
1102         int (*cb)(SSL *ssl, unsigned char *cookie, unsigned int cookie_len))
1103         {
1104         ctx->app_verify_cookie_cb=cb;
1105         }
1106
1107 IMPLEMENT_PEM_rw(SSL_SESSION, SSL_SESSION, PEM_STRING_SSL_SESSION, SSL_SESSION)