2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
60 #include <openssl/lhash.h>
61 #include <openssl/rand.h>
64 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s);
65 static void SSL_SESSION_list_add(SSL_CTX *ctx,SSL_SESSION *s);
66 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck);
67 static int ssl_session_num=0;
68 static STACK *ssl_session_meth=NULL;
70 SSL_SESSION *SSL_get_session(SSL *ssl)
73 /* Need to lock this all up rather than just use CRYPTO_add so that
74 * somebody doesn't free ssl->session between when we check it's
75 * non-null and when we up the reference count. */
76 CRYPTO_r_lock(CRYPTO_LOCK_SSL_SESSION);
80 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_SESSION);
84 int SSL_SESSION_get_ex_new_index(long argl, char *argp, int (*new_func)(),
85 int (*dup_func)(), void (*free_func)())
88 return(CRYPTO_get_ex_new_index(ssl_session_num-1,
90 argl,argp,new_func,dup_func,free_func));
93 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
95 return(CRYPTO_set_ex_data(&s->ex_data,idx,arg));
98 void *SSL_SESSION_get_ex_data(SSL_SESSION *s, int idx)
100 return(CRYPTO_get_ex_data(&s->ex_data,idx));
103 SSL_SESSION *SSL_SESSION_new(void)
107 ss=(SSL_SESSION *)Malloc(sizeof(SSL_SESSION));
110 SSLerr(SSL_F_SSL_SESSION_NEW,ERR_R_MALLOC_FAILURE);
113 memset(ss,0,sizeof(SSL_SESSION));
115 ss->verify_result = 1; /* avoid 0 (= X509_V_OK) just in case */
117 ss->timeout=60*5+4; /* 5 minute timeout by default */
122 CRYPTO_new_ex_data(ssl_session_meth,(char *)ss,&ss->ex_data);
126 int ssl_get_new_session(SSL *s, int session)
128 /* This gets used by clients and servers. */
130 SSL_SESSION *ss=NULL;
132 if ((ss=SSL_SESSION_new()) == NULL) return(0);
134 /* If the context has a default timeout, use it */
135 if (s->ctx->session_timeout == 0)
136 ss->timeout=SSL_get_default_timeout(s);
138 ss->timeout=s->ctx->session_timeout;
140 if (s->session != NULL)
142 SSL_SESSION_free(s->session);
148 if (s->version == SSL2_VERSION)
150 ss->ssl_version=SSL2_VERSION;
151 ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
153 else if (s->version == SSL3_VERSION)
155 ss->ssl_version=SSL3_VERSION;
156 ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
158 else if (s->version == TLS1_VERSION)
160 ss->ssl_version=TLS1_VERSION;
161 ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
165 SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
166 SSL_SESSION_free(ss);
174 RAND_bytes(ss->session_id,ss->session_id_length);
175 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
176 r=(SSL_SESSION *)lh_retrieve(s->ctx->sessions,
178 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
179 if (r == NULL) break;
180 /* else - woops a session_id match */
181 /* XXX should also check external cache!
182 * (But the probability of a collision is negligible, anyway...) */
187 ss->session_id_length=0;
190 memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
191 ss->sid_ctx_length=s->sid_ctx_length;
193 ss->ssl_version=s->version;
194 ss->verify_result = X509_V_OK;
199 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len)
201 /* This is used only by servers. */
203 SSL_SESSION *ret=NULL,data;
207 data.ssl_version=s->version;
208 data.session_id_length=len;
209 if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
211 memcpy(data.session_id,session_id,len);
213 if (!(s->ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
215 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
216 ret=(SSL_SESSION *)lh_retrieve(s->ctx->sessions,(char *)&data);
218 /* don't allow other threads to steal it: */
219 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
220 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
227 s->ctx->stats.sess_miss++;
229 if (s->ctx->get_session_cb != NULL
230 && (ret=s->ctx->get_session_cb(s,session_id,len,©))
233 s->ctx->stats.sess_cb_hit++;
235 /* Increment reference count now if the session callback
236 * asks us to do so (note that if the session structures
237 * returned by the callback are shared between threads,
238 * it must handle the reference count itself [i.e. copy == 0],
239 * or things won't be thread-safe). */
241 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
243 /* The following should not return 1, otherwise,
244 * things are very strange */
245 SSL_CTX_add_session(s->ctx,ret);
251 /* Now ret is non-NULL, and we own one of its reference counts. */
253 if((s->verify_mode&SSL_VERIFY_PEER)
254 && (!s->sid_ctx_length || ret->sid_ctx_length != s->sid_ctx_length
255 || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length)))
257 /* We've found the session named by the client, but we don't
258 * want to use it in this context. */
260 if (s->sid_ctx_length == 0)
262 /* application should have used SSL[_CTX]_set_session_id_context
263 * -- we could tolerate this and just pretend we never heard
264 * of this session, but then applications could effectively
265 * disable the session cache by accident without anyone noticing */
267 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
273 #if 0 /* The client cannot always know when a session is not appropriate,
274 * so we shouldn't generate an error message. */
276 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
278 goto err; /* treat like cache miss */
282 if (ret->cipher == NULL)
284 unsigned char buf[5],*p;
290 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
291 ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
293 ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
294 if (ret->cipher == NULL)
299 #if 0 /* This is way too late. */
301 /* If a thread got the session, then 'swaped', and another got
302 * it and then due to a time-out decided to 'Free' it we could
303 * be in trouble. So I'll increment it now, then double decrement
304 * later - am I speaking rubbish?. */
305 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
308 if ((long)(ret->time+ret->timeout) < (long)time(NULL)) /* timeout */
310 s->ctx->stats.sess_timeout++;
311 /* remove it from the cache */
312 SSL_CTX_remove_session(s->ctx,ret);
316 s->ctx->stats.sess_hit++;
318 /* ret->time=time(NULL); */ /* rezero timeout? */
319 /* again, just leave the session
320 * if it is the same session, we have just incremented and
321 * then decremented the reference count :-) */
322 if (s->session != NULL)
323 SSL_SESSION_free(s->session);
325 s->verify_result = s->session->verify_result;
330 SSL_SESSION_free(ret);
337 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
343 CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
345 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
346 s=(SSL_SESSION *)lh_insert(ctx->sessions,(char *)c);
348 /* Put on the end of the queue unless it is already in the cache */
350 SSL_SESSION_list_add(ctx,c);
352 /* If the same session if is being 're-added', Free the old
353 * one when the last person stops using it.
354 * This will also work if it is alread in the cache.
355 * The references will go up and then down :-) */
365 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
367 while (SSL_CTX_sess_number(ctx) >
368 SSL_CTX_sess_get_cache_size(ctx))
370 if (!remove_session_lock(ctx,
371 ctx->session_cache_tail, 0))
374 ctx->stats.sess_cache_full++;
378 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
382 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
384 return remove_session_lock(ctx, c, 1);
387 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
392 if ((c != NULL) && (c->session_id_length != 0))
394 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
395 r=(SSL_SESSION *)lh_delete(ctx->sessions,(char *)c);
399 SSL_SESSION_list_remove(ctx,c);
402 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
407 if (ctx->remove_session_cb != NULL)
408 ctx->remove_session_cb(ctx,r);
417 void SSL_SESSION_free(SSL_SESSION *ss)
424 i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
426 REF_PRINT("SSL_SESSION",ss);
432 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
437 CRYPTO_free_ex_data(ssl_session_meth,(char *)ss,&ss->ex_data);
439 memset(ss->key_arg,0,SSL_MAX_KEY_ARG_LENGTH);
440 memset(ss->master_key,0,SSL_MAX_MASTER_KEY_LENGTH);
441 memset(ss->session_id,0,SSL_MAX_SSL_SESSION_ID_LENGTH);
442 if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
443 if (ss->peer != NULL) X509_free(ss->peer);
444 if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
445 memset(ss,0,sizeof(*ss));
449 int SSL_set_session(SSL *s, SSL_SESSION *session)
456 meth=s->ctx->method->get_ssl_method(session->ssl_version);
458 meth=s->method->get_ssl_method(session->ssl_version);
461 SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
465 if (meth != s->method)
467 if (!SSL_set_ssl_method(s,meth))
469 if (s->ctx->session_timeout == 0)
470 session->timeout=SSL_get_default_timeout(s);
472 session->timeout=s->ctx->session_timeout;
475 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
476 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
477 if (s->session != NULL)
478 SSL_SESSION_free(s->session);
480 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
485 if (s->session != NULL)
487 SSL_SESSION_free(s->session);
492 if (meth != s->method)
494 if (!SSL_set_ssl_method(s,meth))
502 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
504 if (s == NULL) return(0);
509 long SSL_SESSION_get_timeout(SSL_SESSION *s)
511 if (s == NULL) return(0);
515 long SSL_SESSION_get_time(SSL_SESSION *s)
517 if (s == NULL) return(0);
521 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
523 if (s == NULL) return(0);
528 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
531 if (s == NULL) return(0);
532 l=s->session_timeout;
533 s->session_timeout=t;
537 long SSL_CTX_get_timeout(SSL_CTX *s)
539 if (s == NULL) return(0);
540 return(s->session_timeout);
543 typedef struct timeout_param_st
550 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
552 if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
554 /* The reason we don't call SSL_CTX_remove_session() is to
555 * save on locking overhead */
556 lh_delete(p->cache,(char *)s);
557 SSL_SESSION_list_remove(p->ctx,s);
559 if (p->ctx->remove_session_cb != NULL)
560 p->ctx->remove_session_cb(p->ctx,s);
565 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
571 tp.cache=s->sessions;
572 if (tp.cache == NULL) return;
574 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
575 i=tp.cache->down_load;
576 tp.cache->down_load=0;
577 lh_doall_arg(tp.cache,(void (*)())timeout,(char *)&tp);
578 tp.cache->down_load=i;
579 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
582 int ssl_clear_bad_session(SSL *s)
584 if ( (s->session != NULL) &&
585 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
586 !(SSL_in_init(s) || SSL_in_before(s)))
588 SSL_CTX_remove_session(s->ctx,s->session);
595 /* locked by SSL_CTX in the calling function */
596 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
598 if ((s->next == NULL) || (s->prev == NULL)) return;
600 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
601 { /* last element in list */
602 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
603 { /* only one element in list */
604 ctx->session_cache_head=NULL;
605 ctx->session_cache_tail=NULL;
609 ctx->session_cache_tail=s->prev;
610 s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
615 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
616 { /* first element in list */
617 ctx->session_cache_head=s->next;
618 s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
621 { /* middle of list */
622 s->next->prev=s->prev;
623 s->prev->next=s->next;
626 s->prev=s->next=NULL;
629 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
631 if ((s->next != NULL) && (s->prev != NULL))
632 SSL_SESSION_list_remove(ctx,s);
634 if (ctx->session_cache_head == NULL)
636 ctx->session_cache_head=s;
637 ctx->session_cache_tail=s;
638 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
639 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
643 s->next=ctx->session_cache_head;
645 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
646 ctx->session_cache_head=s;