PR: 1751
[openssl.git] / ssl / d1_lib.c
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
64 const char dtls1_version_str[]="DTLSv1" OPENSSL_VERSION_PTEXT;
65
66 SSL3_ENC_METHOD DTLSv1_enc_data={
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
80 long dtls1_default_timeout(void)
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(60*60*2);
85         }
86
87 int dtls1_new(SSL *s)
88         {
89         DTLS1_STATE *d1;
90
91         if (!ssl3_new(s)) return(0);
92         if ((d1=OPENSSL_malloc(sizeof *d1)) == NULL) return (0);
93         memset(d1,0, sizeof *d1);
94
95         /* d1->handshake_epoch=0; */
96
97         d1->unprocessed_rcds.q=pqueue_new();
98         d1->processed_rcds.q=pqueue_new();
99         d1->buffered_messages = pqueue_new();
100         d1->sent_messages=pqueue_new();
101         d1->buffered_app_data.q=pqueue_new();
102
103         if ( s->server)
104                 {
105                 d1->cookie_len = sizeof(s->d1->cookie);
106                 }
107
108         if( ! d1->unprocessed_rcds.q || ! d1->processed_rcds.q 
109         || ! d1->buffered_messages || ! d1->sent_messages || ! d1->buffered_app_data.q)
110                 {
111         if ( d1->unprocessed_rcds.q) pqueue_free(d1->unprocessed_rcds.q);
112         if ( d1->processed_rcds.q) pqueue_free(d1->processed_rcds.q);
113         if ( d1->buffered_messages) pqueue_free(d1->buffered_messages);
114                 if ( d1->sent_messages) pqueue_free(d1->sent_messages);
115                 if ( d1->buffered_app_data.q) pqueue_free(d1->buffered_app_data.q);
116                 OPENSSL_free(d1);
117                 return (0);
118                 }
119
120         s->d1=d1;
121         s->method->ssl_clear(s);
122         return(1);
123         }
124
125 void dtls1_free(SSL *s)
126         {
127     pitem *item = NULL;
128     hm_fragment *frag = NULL;
129
130         ssl3_free(s);
131
132     while( (item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL)
133         {
134         OPENSSL_free(item->data);
135         pitem_free(item);
136         }
137     pqueue_free(s->d1->unprocessed_rcds.q);
138
139     while( (item = pqueue_pop(s->d1->processed_rcds.q)) != NULL)
140         {
141         OPENSSL_free(item->data);
142         pitem_free(item);
143         }
144     pqueue_free(s->d1->processed_rcds.q);
145
146     while( (item = pqueue_pop(s->d1->buffered_messages)) != NULL)
147         {
148         frag = (hm_fragment *)item->data;
149         OPENSSL_free(frag->fragment);
150         OPENSSL_free(frag);
151         pitem_free(item);
152         }
153     pqueue_free(s->d1->buffered_messages);
154
155     while ( (item = pqueue_pop(s->d1->sent_messages)) != NULL)
156         {
157         frag = (hm_fragment *)item->data;
158         OPENSSL_free(frag->fragment);
159         OPENSSL_free(frag);
160         pitem_free(item);
161         }
162         pqueue_free(s->d1->sent_messages);
163
164         while ( (item = pqueue_pop(s->d1->buffered_app_data.q)) != NULL)
165                 {
166                 frag = (hm_fragment *)item->data;
167                 OPENSSL_free(frag->fragment);
168                 OPENSSL_free(frag);
169                 pitem_free(item);
170                 }
171         pqueue_free(s->d1->buffered_app_data.q);
172
173         OPENSSL_free(s->d1);
174         }
175
176 void dtls1_clear(SSL *s)
177         {
178         ssl3_clear(s);
179         if (s->options & SSL_OP_CISCO_ANYCONNECT)
180                 s->version=DTLS1_BAD_VER;
181         else
182                 s->version=DTLS1_VERSION;
183         }
184
185 /*
186  * As it's impossible to use stream ciphers in "datagram" mode, this
187  * simple filter is designed to disengage them in DTLS. Unfortunately
188  * there is no universal way to identify stream SSL_CIPHER, so we have
189  * to explicitly list their SSL_* codes. Currently RC4 is the only one
190  * available, but if new ones emerge, they will have to be added...
191  */
192 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
193         {
194         const SSL_CIPHER *ciph = ssl3_get_cipher(u);
195
196         if (ciph != NULL)
197                 {
198                 if (ciph->algorithm_enc == SSL_RC4)
199                         return NULL;
200                 }
201
202         return ciph;
203         }