3 * DTLS implementation written by Nagendra Modadugu
4 * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
6 /* ====================================================================
7 * Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
62 #include <openssl/objects.h>
65 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_VMS)
66 #include <sys/timeb.h>
69 static void get_current_time(struct timeval *t);
70 const char dtls1_version_str[]="DTLSv1" OPENSSL_VERSION_PTEXT;
71 int dtls1_listen(SSL *s, struct sockaddr *client);
73 SSL3_ENC_METHOD DTLSv1_enc_data={
77 tls1_generate_master_secret,
78 tls1_change_cipher_state,
79 tls1_final_finish_mac,
80 TLS1_FINISH_MAC_LENGTH,
82 TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
83 TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
85 tls1_export_keying_material,
88 long dtls1_default_timeout(void)
90 /* 2 hours, the 24 hours mentioned in the DTLSv1 spec
91 * is way too long for http, the cache would over fill */
99 if (!ssl3_new(s)) return(0);
100 if ((d1=OPENSSL_malloc(sizeof *d1)) == NULL) return (0);
101 memset(d1,0, sizeof *d1);
103 /* d1->handshake_epoch=0; */
105 d1->unprocessed_rcds.q=pqueue_new();
106 d1->processed_rcds.q=pqueue_new();
107 d1->buffered_messages = pqueue_new();
108 d1->sent_messages=pqueue_new();
109 d1->buffered_app_data.q=pqueue_new();
113 d1->cookie_len = sizeof(s->d1->cookie);
116 if( ! d1->unprocessed_rcds.q || ! d1->processed_rcds.q
117 || ! d1->buffered_messages || ! d1->sent_messages || ! d1->buffered_app_data.q)
119 if ( d1->unprocessed_rcds.q) pqueue_free(d1->unprocessed_rcds.q);
120 if ( d1->processed_rcds.q) pqueue_free(d1->processed_rcds.q);
121 if ( d1->buffered_messages) pqueue_free(d1->buffered_messages);
122 if ( d1->sent_messages) pqueue_free(d1->sent_messages);
123 if ( d1->buffered_app_data.q) pqueue_free(d1->buffered_app_data.q);
129 s->method->ssl_clear(s);
133 static void dtls1_clear_queues(SSL *s)
136 hm_fragment *frag = NULL;
137 DTLS1_RECORD_DATA *rdata;
139 while( (item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL)
141 rdata = (DTLS1_RECORD_DATA *) item->data;
144 OPENSSL_free(rdata->rbuf.buf);
146 OPENSSL_free(item->data);
150 while( (item = pqueue_pop(s->d1->processed_rcds.q)) != NULL)
152 rdata = (DTLS1_RECORD_DATA *) item->data;
155 OPENSSL_free(rdata->rbuf.buf);
157 OPENSSL_free(item->data);
161 while( (item = pqueue_pop(s->d1->buffered_messages)) != NULL)
163 frag = (hm_fragment *)item->data;
164 OPENSSL_free(frag->fragment);
169 while ( (item = pqueue_pop(s->d1->sent_messages)) != NULL)
171 frag = (hm_fragment *)item->data;
172 OPENSSL_free(frag->fragment);
177 while ( (item = pqueue_pop(s->d1->buffered_app_data.q)) != NULL)
179 frag = (hm_fragment *)item->data;
180 OPENSSL_free(frag->fragment);
186 void dtls1_free(SSL *s)
190 dtls1_clear_queues(s);
192 pqueue_free(s->d1->unprocessed_rcds.q);
193 pqueue_free(s->d1->processed_rcds.q);
194 pqueue_free(s->d1->buffered_messages);
195 pqueue_free(s->d1->sent_messages);
196 pqueue_free(s->d1->buffered_app_data.q);
201 void dtls1_clear(SSL *s)
203 pqueue unprocessed_rcds;
204 pqueue processed_rcds;
205 pqueue buffered_messages;
206 pqueue sent_messages;
207 pqueue buffered_app_data;
212 unprocessed_rcds = s->d1->unprocessed_rcds.q;
213 processed_rcds = s->d1->processed_rcds.q;
214 buffered_messages = s->d1->buffered_messages;
215 sent_messages = s->d1->sent_messages;
216 buffered_app_data = s->d1->buffered_app_data.q;
219 dtls1_clear_queues(s);
221 memset(s->d1, 0, sizeof(*(s->d1)));
225 s->d1->cookie_len = sizeof(s->d1->cookie);
228 if (SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)
233 s->d1->unprocessed_rcds.q = unprocessed_rcds;
234 s->d1->processed_rcds.q = processed_rcds;
235 s->d1->buffered_messages = buffered_messages;
236 s->d1->sent_messages = sent_messages;
237 s->d1->buffered_app_data.q = buffered_app_data;
241 if (s->options & SSL_OP_CISCO_ANYCONNECT)
242 s->version=DTLS1_BAD_VER;
244 s->version=DTLS1_VERSION;
247 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg)
253 case DTLS_CTRL_GET_TIMEOUT:
254 if (dtls1_get_timeout(s, (struct timeval*) parg) != NULL)
259 case DTLS_CTRL_HANDLE_TIMEOUT:
260 ret = dtls1_handle_timeout(s);
262 case DTLS_CTRL_LISTEN:
263 ret = dtls1_listen(s, parg);
265 case SSL_CTRL_CHECK_PROTO_VERSION:
266 /* For library-internal use; checks that the current protocol
267 * is the highest enabled version (according to s->ctx->method,
268 * as version negotiation may have changed s->method). */
269 #if DTLS_MAX_VERSION != DTLS1_VERSION
270 # error Code needs update for DTLS_method() support beyond DTLS1_VERSION.
272 /* Just one protocol version is supported so far;
273 * fail closed if the version is not as expected. */
274 return s->version == DTLS_MAX_VERSION;
277 ret = ssl3_ctrl(s, cmd, larg, parg);
284 * As it's impossible to use stream ciphers in "datagram" mode, this
285 * simple filter is designed to disengage them in DTLS. Unfortunately
286 * there is no universal way to identify stream SSL_CIPHER, so we have
287 * to explicitly list their SSL_* codes. Currently RC4 is the only one
288 * available, but if new ones emerge, they will have to be added...
290 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
292 const SSL_CIPHER *ciph = ssl3_get_cipher(u);
296 if (ciph->algorithm_enc == SSL_RC4)
303 void dtls1_start_timer(SSL *s)
305 #ifndef OPENSSL_NO_SCTP
306 /* Disable timer for SCTP */
307 if (BIO_dgram_is_sctp(SSL_get_wbio(s)))
309 memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
314 /* If timer is not set, initialize duration with 1 second */
315 if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
317 s->d1->timeout_duration = 1;
320 /* Set timeout to current time */
321 get_current_time(&(s->d1->next_timeout));
323 /* Add duration to current time */
324 s->d1->next_timeout.tv_sec += s->d1->timeout_duration;
325 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
328 struct timeval* dtls1_get_timeout(SSL *s, struct timeval* timeleft)
330 struct timeval timenow;
332 /* If no timeout is set, just return NULL */
333 if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
338 /* Get current time */
339 get_current_time(&timenow);
341 /* If timer already expired, set remaining time to 0 */
342 if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
343 (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
344 s->d1->next_timeout.tv_usec <= timenow.tv_usec))
346 memset(timeleft, 0, sizeof(struct timeval));
350 /* Calculate time left until timer expires */
351 memcpy(timeleft, &(s->d1->next_timeout), sizeof(struct timeval));
352 timeleft->tv_sec -= timenow.tv_sec;
353 timeleft->tv_usec -= timenow.tv_usec;
354 if (timeleft->tv_usec < 0)
357 timeleft->tv_usec += 1000000;
360 /* If remaining time is less than 15 ms, set it to 0
361 * to prevent issues because of small devergences with
364 if (timeleft->tv_sec == 0 && timeleft->tv_usec < 15000)
366 memset(timeleft, 0, sizeof(struct timeval));
373 int dtls1_is_timer_expired(SSL *s)
375 struct timeval timeleft;
377 /* Get time left until timeout, return false if no timer running */
378 if (dtls1_get_timeout(s, &timeleft) == NULL)
383 /* Return false if timer is not expired yet */
384 if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0)
389 /* Timer expired, so return true */
393 void dtls1_double_timeout(SSL *s)
395 s->d1->timeout_duration *= 2;
396 if (s->d1->timeout_duration > 60)
397 s->d1->timeout_duration = 60;
398 dtls1_start_timer(s);
401 void dtls1_stop_timer(SSL *s)
403 /* Reset everything */
404 memset(&(s->d1->timeout), 0, sizeof(struct dtls1_timeout_st));
405 memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
406 s->d1->timeout_duration = 1;
407 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
408 /* Clear retransmission buffer */
409 dtls1_clear_record_buffer(s);
412 int dtls1_check_timeout_num(SSL *s)
414 s->d1->timeout.num_alerts++;
416 /* Reduce MTU after 2 unsuccessful retransmissions */
417 if (s->d1->timeout.num_alerts > 2)
419 s->d1->mtu = BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_FALLBACK_MTU, 0, NULL);
422 if (s->d1->timeout.num_alerts > DTLS1_TMO_ALERT_COUNT)
424 /* fail the connection, enough alerts have been sent */
425 SSLerr(SSL_F_DTLS1_CHECK_TIMEOUT_NUM,SSL_R_READ_TIMEOUT_EXPIRED);
432 int dtls1_handle_timeout(SSL *s)
434 /* if no timer is expired, don't do anything */
435 if (!dtls1_is_timer_expired(s))
440 dtls1_double_timeout(s);
442 if (dtls1_check_timeout_num(s) < 0)
445 s->d1->timeout.read_timeouts++;
446 if (s->d1->timeout.read_timeouts > DTLS1_TMO_READ_COUNT)
448 s->d1->timeout.read_timeouts = 1;
451 #ifndef OPENSSL_NO_HEARTBEATS
452 if (s->tlsext_hb_pending)
454 s->tlsext_hb_pending = 0;
455 return dtls1_heartbeat(s);
459 dtls1_start_timer(s);
460 return dtls1_retransmit_buffered_messages(s);
463 static void get_current_time(struct timeval *t)
465 #ifdef OPENSSL_SYS_WIN32
468 t->tv_sec = (long)tb.time;
469 t->tv_usec = (long)tb.millitm * 1000;
470 #elif defined(OPENSSL_SYS_VMS)
473 t->tv_sec = (long)tb.time;
474 t->tv_usec = (long)tb.millitm * 1000;
476 gettimeofday(t, NULL);
480 int dtls1_listen(SSL *s, struct sockaddr *client)
484 SSL_set_options(s, SSL_OP_COOKIE_EXCHANGE);
488 if (ret <= 0) return ret;
490 (void) BIO_dgram_get_peer(SSL_get_rbio(s), client);