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)
75 int SSL_SESSION_get_ex_new_index(long argl, char *argp, int (*new_func)(),
76 int (*dup_func)(), void (*free_func)())
79 return(CRYPTO_get_ex_new_index(ssl_session_num-1,
81 argl,argp,new_func,dup_func,free_func));
84 int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, void *arg)
86 return(CRYPTO_set_ex_data(&s->ex_data,idx,arg));
89 void *SSL_SESSION_get_ex_data(SSL_SESSION *s, int idx)
91 return(CRYPTO_get_ex_data(&s->ex_data,idx));
94 SSL_SESSION *SSL_SESSION_new(void)
98 ss=(SSL_SESSION *)Malloc(sizeof(SSL_SESSION));
101 SSLerr(SSL_F_SSL_SESSION_NEW,ERR_R_MALLOC_FAILURE);
104 memset(ss,0,sizeof(SSL_SESSION));
107 ss->timeout=60*5+4; /* 5 minute timeout by default */
112 CRYPTO_new_ex_data(ssl_session_meth,(char *)ss,&ss->ex_data);
116 int ssl_get_new_session(SSL *s, int session)
118 /* This gets used by clients and servers. */
120 SSL_SESSION *ss=NULL;
122 if ((ss=SSL_SESSION_new()) == NULL) return(0);
124 /* If the context has a default timeout, use it */
125 if (s->ctx->session_timeout == 0)
126 ss->timeout=SSL_get_default_timeout(s);
128 ss->timeout=s->ctx->session_timeout;
130 if (s->session != NULL)
132 SSL_SESSION_free(s->session);
138 if (s->version == SSL2_VERSION)
140 ss->ssl_version=SSL2_VERSION;
141 ss->session_id_length=SSL2_SSL_SESSION_ID_LENGTH;
143 else if (s->version == SSL3_VERSION)
145 ss->ssl_version=SSL3_VERSION;
146 ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
148 else if (s->version == TLS1_VERSION)
150 ss->ssl_version=TLS1_VERSION;
151 ss->session_id_length=SSL3_SSL_SESSION_ID_LENGTH;
155 SSLerr(SSL_F_SSL_GET_NEW_SESSION,SSL_R_UNSUPPORTED_SSL_VERSION);
156 SSL_SESSION_free(ss);
164 RAND_bytes(ss->session_id,ss->session_id_length);
165 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
166 r=(SSL_SESSION *)lh_retrieve(s->ctx->sessions,
168 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
169 if (r == NULL) break;
170 /* else - woops a session_id match */
175 ss->session_id_length=0;
178 memcpy(ss->sid_ctx,s->sid_ctx,s->sid_ctx_length);
179 ss->sid_ctx_length=s->sid_ctx_length;
181 ss->ssl_version=s->version;
186 int ssl_get_prev_session(SSL *s, unsigned char *session_id, int len)
188 /* This is used only by servers. */
190 SSL_SESSION *ret=NULL,data;
194 data.ssl_version=s->version;
195 data.session_id_length=len;
196 if (len > SSL_MAX_SSL_SESSION_ID_LENGTH)
198 memcpy(data.session_id,session_id,len);
200 if (!(s->ctx->session_cache_mode & SSL_SESS_CACHE_NO_INTERNAL_LOOKUP))
202 CRYPTO_r_lock(CRYPTO_LOCK_SSL_CTX);
203 ret=(SSL_SESSION *)lh_retrieve(s->ctx->sessions,(char *)&data);
204 CRYPTO_r_unlock(CRYPTO_LOCK_SSL_CTX);
209 s->ctx->stats.sess_miss++;
211 if (s->ctx->get_session_cb != NULL
212 && (ret=s->ctx->get_session_cb(s,session_id,len,©))
215 s->ctx->stats.sess_cb_hit++;
217 /* The following should not return 1, otherwise,
218 * things are very strange */
219 SSL_CTX_add_session(s->ctx,ret);
221 if (ret == NULL) return(0);
224 if((s->verify_mode&SSL_VERIFY_PEER)
225 && (!s->sid_ctx_length || ret->sid_ctx_length != s->sid_ctx_length
226 || memcmp(ret->sid_ctx,s->sid_ctx,ret->sid_ctx_length)))
228 if (s->sid_ctx_length)
229 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT);
231 /* application should have used SSL[_CTX]_set_session_id_context */
232 SSLerr(SSL_F_SSL_GET_PREV_SESSION,SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED);
238 SSL_SESSION_free(ret);
240 if (ret->cipher == NULL)
242 unsigned char buf[5],*p;
248 if ((ret->ssl_version>>8) == SSL3_VERSION_MAJOR)
249 ret->cipher=ssl_get_cipher_by_char(s,&(buf[2]));
251 ret->cipher=ssl_get_cipher_by_char(s,&(buf[1]));
252 if (ret->cipher == NULL)
256 /* If a thread got the session, then 'swaped', and another got
257 * it and then due to a time-out decided to 'Free' it we could
258 * be in trouble. So I'll increment it now, then double decrement
259 * later - am I speaking rubbish?. */
260 CRYPTO_add(&ret->references,1,CRYPTO_LOCK_SSL_SESSION);
262 if ((long)(ret->time+ret->timeout) < (long)time(NULL)) /* timeout */
264 s->ctx->stats.sess_timeout++;
265 /* remove it from the cache */
266 SSL_CTX_remove_session(s->ctx,ret);
267 SSL_SESSION_free(ret); /* again to actually Free it */
271 s->ctx->stats.sess_hit++;
273 /* ret->time=time(NULL); */ /* rezero timeout? */
274 /* again, just leave the session
275 * if it is the same session, we have just incremented and
276 * then decremented the reference count :-) */
277 if (s->session != NULL)
278 SSL_SESSION_free(s->session);
283 int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c)
289 CRYPTO_add(&c->references,1,CRYPTO_LOCK_SSL_SESSION);
291 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
292 s=(SSL_SESSION *)lh_insert(ctx->sessions,(char *)c);
294 /* Put on the end of the queue unless it is already in the cache */
296 SSL_SESSION_list_add(ctx,c);
298 /* If the same session if is being 're-added', Free the old
299 * one when the last person stops using it.
300 * This will also work if it is alread in the cache.
301 * The references will go up and then down :-) */
311 if (SSL_CTX_sess_get_cache_size(ctx) > 0)
313 while (SSL_CTX_sess_number(ctx) >
314 SSL_CTX_sess_get_cache_size(ctx))
316 if (!remove_session_lock(ctx,
317 ctx->session_cache_tail, 0))
320 ctx->stats.sess_cache_full++;
324 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
328 int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c)
330 return remove_session_lock(ctx, c, 1);
333 static int remove_session_lock(SSL_CTX *ctx, SSL_SESSION *c, int lck)
338 if ((c != NULL) && (c->session_id_length != 0))
340 if(lck) CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
341 r=(SSL_SESSION *)lh_delete(ctx->sessions,(char *)c);
345 SSL_SESSION_list_remove(ctx,c);
348 if(lck) CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
353 if (ctx->remove_session_cb != NULL)
354 ctx->remove_session_cb(ctx,r);
363 void SSL_SESSION_free(SSL_SESSION *ss)
370 i=CRYPTO_add(&ss->references,-1,CRYPTO_LOCK_SSL_SESSION);
372 REF_PRINT("SSL_SESSION",ss);
378 fprintf(stderr,"SSL_SESSION_free, bad reference count\n");
383 CRYPTO_free_ex_data(ssl_session_meth,(char *)ss,&ss->ex_data);
385 memset(ss->key_arg,0,SSL_MAX_KEY_ARG_LENGTH);
386 memset(ss->master_key,0,SSL_MAX_MASTER_KEY_LENGTH);
387 memset(ss->session_id,0,SSL_MAX_SSL_SESSION_ID_LENGTH);
388 if (ss->sess_cert != NULL) ssl_sess_cert_free(ss->sess_cert);
389 if (ss->peer != NULL) X509_free(ss->peer);
390 if (ss->ciphers != NULL) sk_SSL_CIPHER_free(ss->ciphers);
391 memset(ss,0,sizeof(*ss));
395 int SSL_set_session(SSL *s, SSL_SESSION *session)
402 meth=s->ctx->method->get_ssl_method(session->ssl_version);
404 meth=s->method->get_ssl_method(session->ssl_version);
407 SSLerr(SSL_F_SSL_SET_SESSION,SSL_R_UNABLE_TO_FIND_SSL_METHOD);
411 if (meth != s->method)
413 if (!SSL_set_ssl_method(s,meth))
415 if (s->ctx->session_timeout == 0)
416 session->timeout=SSL_get_default_timeout(s);
418 session->timeout=s->ctx->session_timeout;
421 /* CRYPTO_w_lock(CRYPTO_LOCK_SSL);*/
422 CRYPTO_add(&session->references,1,CRYPTO_LOCK_SSL_SESSION);
423 if (s->session != NULL)
424 SSL_SESSION_free(s->session);
426 /* CRYPTO_w_unlock(CRYPTO_LOCK_SSL);*/
431 if (s->session != NULL)
433 SSL_SESSION_free(s->session);
438 if (meth != s->method)
440 if (!SSL_set_ssl_method(s,meth))
448 long SSL_SESSION_set_timeout(SSL_SESSION *s, long t)
450 if (s == NULL) return(0);
455 long SSL_SESSION_get_timeout(SSL_SESSION *s)
457 if (s == NULL) return(0);
461 long SSL_SESSION_get_time(SSL_SESSION *s)
463 if (s == NULL) return(0);
467 long SSL_SESSION_set_time(SSL_SESSION *s, long t)
469 if (s == NULL) return(0);
474 long SSL_CTX_set_timeout(SSL_CTX *s, long t)
477 if (s == NULL) return(0);
478 l=s->session_timeout;
479 s->session_timeout=t;
483 long SSL_CTX_get_timeout(SSL_CTX *s)
485 if (s == NULL) return(0);
486 return(s->session_timeout);
489 typedef struct timeout_param_st
496 static void timeout(SSL_SESSION *s, TIMEOUT_PARAM *p)
498 if ((p->time == 0) || (p->time > (s->time+s->timeout))) /* timeout */
500 /* The reason we don't call SSL_CTX_remove_session() is to
501 * save on locking overhead */
502 lh_delete(p->cache,(char *)s);
503 SSL_SESSION_list_remove(p->ctx,s);
505 if (p->ctx->remove_session_cb != NULL)
506 p->ctx->remove_session_cb(p->ctx,s);
511 void SSL_CTX_flush_sessions(SSL_CTX *s, long t)
517 tp.cache=s->sessions;
518 if (tp.cache == NULL) return;
520 CRYPTO_w_lock(CRYPTO_LOCK_SSL_CTX);
521 i=tp.cache->down_load;
522 tp.cache->down_load=0;
523 lh_doall_arg(tp.cache,(void (*)())timeout,(char *)&tp);
524 tp.cache->down_load=i;
525 CRYPTO_w_unlock(CRYPTO_LOCK_SSL_CTX);
528 int ssl_clear_bad_session(SSL *s)
530 if ( (s->session != NULL) &&
531 !(s->shutdown & SSL_SENT_SHUTDOWN) &&
532 !(SSL_in_init(s) || SSL_in_before(s)))
534 SSL_CTX_remove_session(s->ctx,s->session);
541 /* locked by SSL_CTX in the calling function */
542 static void SSL_SESSION_list_remove(SSL_CTX *ctx, SSL_SESSION *s)
544 if ((s->next == NULL) || (s->prev == NULL)) return;
546 if (s->next == (SSL_SESSION *)&(ctx->session_cache_tail))
547 { /* last element in list */
548 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
549 { /* only one element in list */
550 ctx->session_cache_head=NULL;
551 ctx->session_cache_tail=NULL;
555 ctx->session_cache_tail=s->prev;
556 s->prev->next=(SSL_SESSION *)&(ctx->session_cache_tail);
561 if (s->prev == (SSL_SESSION *)&(ctx->session_cache_head))
562 { /* first element in list */
563 ctx->session_cache_head=s->next;
564 s->next->prev=(SSL_SESSION *)&(ctx->session_cache_head);
567 { /* middle of list */
568 s->next->prev=s->prev;
569 s->prev->next=s->next;
572 s->prev=s->next=NULL;
575 static void SSL_SESSION_list_add(SSL_CTX *ctx, SSL_SESSION *s)
577 if ((s->next != NULL) && (s->prev != NULL))
578 SSL_SESSION_list_remove(ctx,s);
580 if (ctx->session_cache_head == NULL)
582 ctx->session_cache_head=s;
583 ctx->session_cache_tail=s;
584 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
585 s->next=(SSL_SESSION *)&(ctx->session_cache_tail);
589 s->next=ctx->session_cache_head;
591 s->prev=(SSL_SESSION *)&(ctx->session_cache_head);
592 ctx->session_cache_head=s;