[thirdparty/openssl.git] / ssl / d1_lib.c

/* ssl/d1_lib.c */
/* 
 * DTLS implementation written by Nagendra Modadugu
 * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.  
 */
/* ====================================================================
 * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    openssl-core@OpenSSL.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This product includes cryptographic software written by Eric Young
 * (eay@cryptsoft.com).  This product includes software written by Tim
 * Hudson (tjh@cryptsoft.com).
 *
 */

#include <stdio.h>
#include <openssl/objects.h>
#include "ssl_locl.h"

const char dtls1_version_str[]="DTLSv1" OPENSSL_VERSION_PTEXT;

SSL3_ENC_METHOD DTLSv1_enc_data={
    dtls1_enc,
	tls1_mac,
	tls1_setup_key_block,
	tls1_generate_master_secret,
	tls1_change_cipher_state,
	tls1_final_finish_mac,
	TLS1_FINISH_MAC_LENGTH,
	tls1_cert_verify_mac,
	TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
	TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
	tls1_alert_code,
	};

long dtls1_default_timeout(void)
	{
	/* 2 hours, the 24 hours mentioned in the DTLSv1 spec
	 * is way too long for http, the cache would over fill */
	return(60*60*2);
	}

IMPLEMENT_dtls1_meth_func(dtlsv1_base_method,
			ssl_undefined_function,
			ssl_undefined_function,
			ssl_bad_method)

int dtls1_new(SSL *s)
	{
	DTLS1_STATE *d1;

	if (!ssl3_new(s)) return(0);
	if ((d1=OPENSSL_malloc(sizeof *d1)) == NULL) return (0);
	memset(d1,0, sizeof *d1);

	/* d1->handshake_epoch=0; */
#if defined(OPENSSL_SYS_VMS) || defined(VMS_TEST)
	d1->bitmap.length=64;
#else
	d1->bitmap.length=sizeof(d1->bitmap.map) * 8;
#endif
	pq_64bit_init(&(d1->bitmap.map));
	pq_64bit_init(&(d1->bitmap.max_seq_num));
	
	pq_64bit_init(&(d1->next_bitmap.map));
	pq_64bit_init(&(d1->next_bitmap.max_seq_num));

	d1->unprocessed_rcds.q=pqueue_new();
	d1->processed_rcds.q=pqueue_new();
	d1->buffered_messages = pqueue_new();
	d1->sent_messages=pqueue_new();

	if ( s->server)
		{
		d1->cookie_len = sizeof(s->d1->cookie);
		}

	if( ! d1->unprocessed_rcds.q || ! d1->processed_rcds.q 
        || ! d1->buffered_messages || ! d1->sent_messages)
		{
        if ( d1->unprocessed_rcds.q) pqueue_free(d1->unprocessed_rcds.q);
        if ( d1->processed_rcds.q) pqueue_free(d1->processed_rcds.q);
        if ( d1->buffered_messages) pqueue_free(d1->buffered_messages);
		if ( d1->sent_messages) pqueue_free(d1->sent_messages);
		OPENSSL_free(d1);
		return (0);
		}

	s->d1=d1;
	s->method->ssl_clear(s);
	return(1);
	}

void dtls1_free(SSL *s)
	{
    pitem *item = NULL;
    hm_fragment *frag = NULL;

	ssl3_free(s);

    while( (item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL)
        {
        OPENSSL_free(item->data);
        pitem_free(item);
        }
    pqueue_free(s->d1->unprocessed_rcds.q);

    while( (item = pqueue_pop(s->d1->processed_rcds.q)) != NULL)
        {
        OPENSSL_free(item->data);
        pitem_free(item);
        }
    pqueue_free(s->d1->processed_rcds.q);

    while( (item = pqueue_pop(s->d1->buffered_messages)) != NULL)
        {
        frag = (hm_fragment *)item->data;
        OPENSSL_free(frag->fragment);
        OPENSSL_free(frag);
        pitem_free(item);
        }
    pqueue_free(s->d1->buffered_messages);

    while ( (item = pqueue_pop(s->d1->sent_messages)) != NULL)
        {
        frag = (hm_fragment *)item->data;
        OPENSSL_free(frag->fragment);
        OPENSSL_free(frag);
        pitem_free(item);
        }
	pqueue_free(s->d1->sent_messages);

	pq_64bit_free(&(s->d1->bitmap.map));
	pq_64bit_free(&(s->d1->bitmap.max_seq_num));

	pq_64bit_free(&(s->d1->next_bitmap.map));
	pq_64bit_free(&(s->d1->next_bitmap.max_seq_num));

	OPENSSL_free(s->d1);
	}

void dtls1_clear(SSL *s)
	{
	ssl3_clear(s);
	s->version=DTLS1_VERSION;
	}

/*
 * As it's impossible to use stream ciphers in "datagram" mode, this
 * simple filter is designed to disengage them in DTLS. Unfortunately
 * there is no universal way to identify stream SSL_CIPHER, so we have
 * to explicitly list their SSL_* codes. Currently RC4 is the only one
 * available, but if new ones emerge, they will have to be added...
 */
SSL_CIPHER *dtls1_get_cipher(unsigned int u)
	{
	SSL_CIPHER *ciph = ssl3_get_cipher(u);

	if (ciph != NULL)
		{
		if ((ciph->algorithms&SSL_ENC_MASK) == SSL_RC4)
			return NULL;
		}

	return ciph;
	}
Commit	Line	Data
36d16f8e BL	1	/* ssl/d1_lib.c */
	2	/*
	3	* DTLS implementation written by Nagendra Modadugu
	4	* (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
	5	*/
	6	/* ====================================================================
	7	* Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved.
	8	*
	9	* Redistribution and use in source and binary forms, with or without
	10	* modification, are permitted provided that the following conditions
	11	* are met:
	12	*
	13	* 1. Redistributions of source code must retain the above copyright
	14	* notice, this list of conditions and the following disclaimer.
	15	*
	16	* 2. Redistributions in binary form must reproduce the above copyright
	17	* notice, this list of conditions and the following disclaimer in
	18	* the documentation and/or other materials provided with the
	19	* distribution.
	20	*
	21	* 3. All advertising materials mentioning features or use of this
	22	* software must display the following acknowledgment:
	23	* "This product includes software developed by the OpenSSL Project
	24	* for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
	25	*
	26	* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
	27	* endorse or promote products derived from this software without
	28	* prior written permission. For written permission, please contact
	29	* openssl-core@OpenSSL.org.
	30	*
	31	* 5. Products derived from this software may not be called "OpenSSL"
	32	* nor may "OpenSSL" appear in their names without prior written
	33	* permission of the OpenSSL Project.
	34	*
	35	* 6. Redistributions of any form whatsoever must retain the following
	36	* acknowledgment:
	37	* "This product includes software developed by the OpenSSL Project
	38	* for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
	39	*
	40	* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
	41	* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	42	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	43	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
	44	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	45	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	46	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	47	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	48	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	49	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	50	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
	51	* OF THE POSSIBILITY OF SUCH DAMAGE.
	52	* ====================================================================
	53	*
	54	* This product includes cryptographic software written by Eric Young
	55	* (eay@cryptsoft.com). This product includes software written by Tim
	56	* Hudson (tjh@cryptsoft.com).
	57	*
	58	*/
	59
	60	#include <stdio.h>
	61	#include <openssl/objects.h>
	62	#include "ssl_locl.h"
	63
4479ce9c	64	const char dtls1_version_str[]="DTLSv1" OPENSSL_VERSION_PTEXT;
36d16f8e	65
222f2246	66	SSL3_ENC_METHOD DTLSv1_enc_data={
36d16f8e BL	67	dtls1_enc,
	68	tls1_mac,
	69	tls1_setup_key_block,
	70	tls1_generate_master_secret,
	71	tls1_change_cipher_state,
	72	tls1_final_finish_mac,
	73	TLS1_FINISH_MAC_LENGTH,
	74	tls1_cert_verify_mac,
	75	TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
	76	TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
	77	tls1_alert_code,
	78	};
	79
222f2246	80	long dtls1_default_timeout(void)
36d16f8e BL	81	{
	82	/* 2 hours, the 24 hours mentioned in the DTLSv1 spec
	83	* is way too long for http, the cache would over fill */
	84	return(60602);
	85	}
	86
e7eec05a	87	IMPLEMENT_dtls1_meth_func(dtlsv1_base_method,
222f2246 DSH	88	ssl_undefined_function,
	89	ssl_undefined_function,
	90	ssl_bad_method)
36d16f8e BL	91
	92	int dtls1_new(SSL *s)
	93	{
	94	DTLS1_STATE *d1;
	95
	96	if (!ssl3_new(s)) return(0);
	97	if ((d1=OPENSSL_malloc(sizeof *d1)) == NULL) return (0);
	98	memset(d1,0, sizeof *d1);
	99
	100	/* d1->handshake_epoch=0; */
e2ac4732 RL	101	#if defined(OPENSSL_SYS_VMS) \|\| defined(VMS_TEST)
	102	d1->bitmap.length=64;
	103	#else
36d16f8e	104	d1->bitmap.length=sizeof(d1->bitmap.map) * 8;
e2ac4732 RL	105	#endif
	106	pq_64bit_init(&(d1->bitmap.map));
	107	pq_64bit_init(&(d1->bitmap.max_seq_num));
	108
	109	pq_64bit_init(&(d1->next_bitmap.map));
	110	pq_64bit_init(&(d1->next_bitmap.max_seq_num));
	111
36d16f8e	112	d1->unprocessed_rcds.q=pqueue_new();
e2ac4732 RL	113	d1->processed_rcds.q=pqueue_new();
e2ac4732 RL	114	d1->buffered_messages = pqueue_new();
36d16f8e BL	115	d1->sent_messages=pqueue_new();
	116
	117	if ( s->server)
	118	{
	119	d1->cookie_len = sizeof(s->d1->cookie);
	120	}
	121
	122	if( ! d1->unprocessed_rcds.q \|\| ! d1->processed_rcds.q
	123	\|\| ! d1->buffered_messages \|\| ! d1->sent_messages)
	124	{
	125	if ( d1->unprocessed_rcds.q) pqueue_free(d1->unprocessed_rcds.q);
	126	if ( d1->processed_rcds.q) pqueue_free(d1->processed_rcds.q);
	127	if ( d1->buffered_messages) pqueue_free(d1->buffered_messages);
	128	if ( d1->sent_messages) pqueue_free(d1->sent_messages);
	129	OPENSSL_free(d1);
	130	return (0);
	131	}
	132
	133	s->d1=d1;
	134	s->method->ssl_clear(s);
	135	return(1);
	136	}
	137
	138	void dtls1_free(SSL *s)
	139	{
	140	pitem *item = NULL;
	141	hm_fragment *frag = NULL;
	142
	143	ssl3_free(s);
	144
	145	while( (item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL)
	146	{
	147	OPENSSL_free(item->data);
	148	pitem_free(item);
	149	}
	150	pqueue_free(s->d1->unprocessed_rcds.q);
	151
	152	while( (item = pqueue_pop(s->d1->processed_rcds.q)) != NULL)
	153	{
	154	OPENSSL_free(item->data);
	155	pitem_free(item);
	156	}
	157	pqueue_free(s->d1->processed_rcds.q);
	158
	159	while( (item = pqueue_pop(s->d1->buffered_messages)) != NULL)
	160	{
	161	frag = (hm_fragment *)item->data;
	162	OPENSSL_free(frag->fragment);
	163	OPENSSL_free(frag);
	164	pitem_free(item);
	165	}
	166	pqueue_free(s->d1->buffered_messages);
	167
	168	while ( (item = pqueue_pop(s->d1->sent_messages)) != NULL)
	169	{
	170	frag = (hm_fragment *)item->data;
	171	OPENSSL_free(frag->fragment);
	172	OPENSSL_free(frag);
	173	pitem_free(item);
	174	}
	175	pqueue_free(s->d1->sent_messages);
	176
e2ac4732 RL	177	pq_64bit_free(&(s->d1->bitmap.map));
	178	pq_64bit_free(&(s->d1->bitmap.max_seq_num));
	179
	180	pq_64bit_free(&(s->d1->next_bitmap.map));
	181	pq_64bit_free(&(s->d1->next_bitmap.max_seq_num));
	182
36d16f8e BL	183	OPENSSL_free(s->d1);
	184	}
	185
	186	void dtls1_clear(SSL *s)
	187	{
	188	ssl3_clear(s);
	189	s->version=DTLS1_VERSION;
	190	}
d5e858c5 AP	191
	192	/*
	193	* As it's impossible to use stream ciphers in "datagram" mode, this
	194	* simple filter is designed to disengage them in DTLS. Unfortunately
	195	* there is no universal way to identify stream SSL_CIPHER, so we have
	196	* to explicitly list their SSL_* codes. Currently RC4 is the only one
	197	* available, but if new ones emerge, they will have to be added...
	198	*/
	199	SSL_CIPHER *dtls1_get_cipher(unsigned int u)
	200	{
	201	SSL_CIPHER *ciph = ssl3_get_cipher(u);
	202
	203	if (ciph != NULL)
	204	{
	205	if ((ciph->algorithms&SSL_ENC_MASK) == SSL_RC4)
	206	return NULL;
	207	}
	208
	209	return ciph;
	210	}