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_VMS)
66 #include <sys/timeb.h>
69 static void get_current_time(struct timeval *t);
70 static void dtls1_set_handshake_header(SSL *s, int type, unsigned long len);
71 static int dtls1_handshake_write(SSL *s);
72 const char dtls1_version_str[]="DTLSv1" OPENSSL_VERSION_PTEXT;
73 int dtls1_listen(SSL *s, struct sockaddr *client);
75 SSL3_ENC_METHOD DTLSv1_enc_data={
79 tls1_generate_master_secret,
80 tls1_change_cipher_state,
81 tls1_final_finish_mac,
82 TLS1_FINISH_MAC_LENGTH,
84 TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
85 TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
87 tls1_export_keying_material,
88 SSL_ENC_FLAG_DTLS|SSL_ENC_FLAG_EXPLICIT_IV,
89 DTLS1_HM_HEADER_LENGTH,
90 dtls1_set_handshake_header,
94 SSL3_ENC_METHOD DTLSv1_2_enc_data={
98 tls1_generate_master_secret,
99 tls1_change_cipher_state,
100 tls1_final_finish_mac,
101 TLS1_FINISH_MAC_LENGTH,
102 tls1_cert_verify_mac,
103 TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
104 TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
106 tls1_export_keying_material,
107 SSL_ENC_FLAG_DTLS|SSL_ENC_FLAG_EXPLICIT_IV|SSL_ENC_FLAG_SIGALGS
108 |SSL_ENC_FLAG_SHA256_PRF|SSL_ENC_FLAG_TLS1_2_CIPHERS,
109 DTLS1_HM_HEADER_LENGTH,
110 dtls1_set_handshake_header,
111 dtls1_handshake_write
114 long dtls1_default_timeout(void)
116 /* 2 hours, the 24 hours mentioned in the DTLSv1 spec
117 * is way too long for http, the cache would over fill */
121 int dtls1_new(SSL *s)
125 if (!ssl3_new(s)) return(0);
126 if ((d1=OPENSSL_malloc(sizeof *d1)) == NULL) return (0);
127 memset(d1,0, sizeof *d1);
129 /* d1->handshake_epoch=0; */
131 d1->unprocessed_rcds.q=pqueue_new();
132 d1->processed_rcds.q=pqueue_new();
133 d1->buffered_messages = pqueue_new();
134 d1->sent_messages=pqueue_new();
135 d1->buffered_app_data.q=pqueue_new();
139 d1->cookie_len = sizeof(s->d1->cookie);
142 if( ! d1->unprocessed_rcds.q || ! d1->processed_rcds.q
143 || ! d1->buffered_messages || ! d1->sent_messages || ! d1->buffered_app_data.q)
145 if ( d1->unprocessed_rcds.q) pqueue_free(d1->unprocessed_rcds.q);
146 if ( d1->processed_rcds.q) pqueue_free(d1->processed_rcds.q);
147 if ( d1->buffered_messages) pqueue_free(d1->buffered_messages);
148 if ( d1->sent_messages) pqueue_free(d1->sent_messages);
149 if ( d1->buffered_app_data.q) pqueue_free(d1->buffered_app_data.q);
155 s->method->ssl_clear(s);
159 static void dtls1_clear_queues(SSL *s)
162 hm_fragment *frag = NULL;
163 DTLS1_RECORD_DATA *rdata;
165 while( (item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL)
167 rdata = (DTLS1_RECORD_DATA *) item->data;
170 OPENSSL_free(rdata->rbuf.buf);
172 OPENSSL_free(item->data);
176 while( (item = pqueue_pop(s->d1->processed_rcds.q)) != NULL)
178 rdata = (DTLS1_RECORD_DATA *) item->data;
181 OPENSSL_free(rdata->rbuf.buf);
183 OPENSSL_free(item->data);
187 while( (item = pqueue_pop(s->d1->buffered_messages)) != NULL)
189 frag = (hm_fragment *)item->data;
190 OPENSSL_free(frag->fragment);
195 while ( (item = pqueue_pop(s->d1->sent_messages)) != NULL)
197 frag = (hm_fragment *)item->data;
198 OPENSSL_free(frag->fragment);
203 while ( (item = pqueue_pop(s->d1->buffered_app_data.q)) != NULL)
205 frag = (hm_fragment *)item->data;
206 OPENSSL_free(frag->fragment);
212 void dtls1_free(SSL *s)
216 dtls1_clear_queues(s);
218 pqueue_free(s->d1->unprocessed_rcds.q);
219 pqueue_free(s->d1->processed_rcds.q);
220 pqueue_free(s->d1->buffered_messages);
221 pqueue_free(s->d1->sent_messages);
222 pqueue_free(s->d1->buffered_app_data.q);
228 void dtls1_clear(SSL *s)
230 pqueue unprocessed_rcds;
231 pqueue processed_rcds;
232 pqueue buffered_messages;
233 pqueue sent_messages;
234 pqueue buffered_app_data;
239 unprocessed_rcds = s->d1->unprocessed_rcds.q;
240 processed_rcds = s->d1->processed_rcds.q;
241 buffered_messages = s->d1->buffered_messages;
242 sent_messages = s->d1->sent_messages;
243 buffered_app_data = s->d1->buffered_app_data.q;
246 dtls1_clear_queues(s);
248 memset(s->d1, 0, sizeof(*(s->d1)));
252 s->d1->cookie_len = sizeof(s->d1->cookie);
255 if (SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)
260 s->d1->unprocessed_rcds.q = unprocessed_rcds;
261 s->d1->processed_rcds.q = processed_rcds;
262 s->d1->buffered_messages = buffered_messages;
263 s->d1->sent_messages = sent_messages;
264 s->d1->buffered_app_data.q = buffered_app_data;
268 if (s->options & SSL_OP_CISCO_ANYCONNECT)
269 s->version=DTLS1_BAD_VER;
270 else if (s->method->version == DTLS_ANY_VERSION)
271 s->version=DTLS1_2_VERSION;
273 s->version=s->method->version;
276 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg)
282 case DTLS_CTRL_GET_TIMEOUT:
283 if (dtls1_get_timeout(s, (struct timeval*) parg) != NULL)
288 case DTLS_CTRL_HANDLE_TIMEOUT:
289 ret = dtls1_handle_timeout(s);
291 case DTLS_CTRL_LISTEN:
292 ret = dtls1_listen(s, parg);
296 ret = ssl3_ctrl(s, cmd, larg, parg);
303 * As it's impossible to use stream ciphers in "datagram" mode, this
304 * simple filter is designed to disengage them in DTLS. Unfortunately
305 * there is no universal way to identify stream SSL_CIPHER, so we have
306 * to explicitly list their SSL_* codes. Currently RC4 is the only one
307 * available, but if new ones emerge, they will have to be added...
309 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
311 const SSL_CIPHER *ciph = ssl3_get_cipher(u);
315 if (ciph->algorithm_enc == SSL_RC4)
322 void dtls1_start_timer(SSL *s)
324 #ifndef OPENSSL_NO_SCTP
325 /* Disable timer for SCTP */
326 if (BIO_dgram_is_sctp(SSL_get_wbio(s)))
328 memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
333 /* If timer is not set, initialize duration with 1 second */
334 if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
336 s->d1->timeout_duration = 1;
339 /* Set timeout to current time */
340 get_current_time(&(s->d1->next_timeout));
342 /* Add duration to current time */
343 s->d1->next_timeout.tv_sec += s->d1->timeout_duration;
344 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
347 struct timeval* dtls1_get_timeout(SSL *s, struct timeval* timeleft)
349 struct timeval timenow;
351 /* If no timeout is set, just return NULL */
352 if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
357 /* Get current time */
358 get_current_time(&timenow);
360 /* If timer already expired, set remaining time to 0 */
361 if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
362 (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
363 s->d1->next_timeout.tv_usec <= timenow.tv_usec))
365 memset(timeleft, 0, sizeof(struct timeval));
369 /* Calculate time left until timer expires */
370 memcpy(timeleft, &(s->d1->next_timeout), sizeof(struct timeval));
371 timeleft->tv_sec -= timenow.tv_sec;
372 timeleft->tv_usec -= timenow.tv_usec;
373 if (timeleft->tv_usec < 0)
376 timeleft->tv_usec += 1000000;
379 /* If remaining time is less than 15 ms, set it to 0
380 * to prevent issues because of small devergences with
383 if (timeleft->tv_sec == 0 && timeleft->tv_usec < 15000)
385 memset(timeleft, 0, sizeof(struct timeval));
392 int dtls1_is_timer_expired(SSL *s)
394 struct timeval timeleft;
396 /* Get time left until timeout, return false if no timer running */
397 if (dtls1_get_timeout(s, &timeleft) == NULL)
402 /* Return false if timer is not expired yet */
403 if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0)
408 /* Timer expired, so return true */
412 void dtls1_double_timeout(SSL *s)
414 s->d1->timeout_duration *= 2;
415 if (s->d1->timeout_duration > 60)
416 s->d1->timeout_duration = 60;
417 dtls1_start_timer(s);
420 void dtls1_stop_timer(SSL *s)
422 /* Reset everything */
423 memset(&(s->d1->timeout), 0, sizeof(struct dtls1_timeout_st));
424 memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
425 s->d1->timeout_duration = 1;
426 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
427 /* Clear retransmission buffer */
428 dtls1_clear_record_buffer(s);
431 int dtls1_check_timeout_num(SSL *s)
433 s->d1->timeout.num_alerts++;
435 /* Reduce MTU after 2 unsuccessful retransmissions */
436 if (s->d1->timeout.num_alerts > 2)
438 s->d1->mtu = BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_FALLBACK_MTU, 0, NULL);
441 if (s->d1->timeout.num_alerts > DTLS1_TMO_ALERT_COUNT)
443 /* fail the connection, enough alerts have been sent */
444 SSLerr(SSL_F_DTLS1_CHECK_TIMEOUT_NUM,SSL_R_READ_TIMEOUT_EXPIRED);
451 int dtls1_handle_timeout(SSL *s)
453 /* if no timer is expired, don't do anything */
454 if (!dtls1_is_timer_expired(s))
459 dtls1_double_timeout(s);
461 if (dtls1_check_timeout_num(s) < 0)
464 s->d1->timeout.read_timeouts++;
465 if (s->d1->timeout.read_timeouts > DTLS1_TMO_READ_COUNT)
467 s->d1->timeout.read_timeouts = 1;
470 #ifndef OPENSSL_NO_HEARTBEATS
471 if (s->tlsext_hb_pending)
473 s->tlsext_hb_pending = 0;
474 return dtls1_heartbeat(s);
478 dtls1_start_timer(s);
479 return dtls1_retransmit_buffered_messages(s);
482 static void get_current_time(struct timeval *t)
486 union { unsigned __int64 ul; FILETIME ft; } now;
489 SystemTimeToFileTime(&st,&now.ft);
491 now.ul -= 116444736000000000ULL;
493 now.ul -= 116444736000000000UI64; /* re-bias to 1/1/1970 */
495 t->tv_sec = (long)(now.ul/10000000);
496 t->tv_usec = ((int)(now.ul%10000000))/10;
497 #elif defined(OPENSSL_SYS_VMS)
500 t->tv_sec = (long)tb.time;
501 t->tv_usec = (long)tb.millitm * 1000;
503 gettimeofday(t, NULL);
507 int dtls1_listen(SSL *s, struct sockaddr *client)
511 SSL_set_options(s, SSL_OP_COOKIE_EXCHANGE);
515 if (ret <= 0) return ret;
517 (void) BIO_dgram_get_peer(SSL_get_rbio(s), client);
521 static void dtls1_set_handshake_header(SSL *s, int htype, unsigned long len)
523 unsigned char *p = (unsigned char *)s->init_buf->data;
524 dtls1_set_message_header(s, p, htype, len, 0, len);
525 s->init_num = (int)len + DTLS1_HM_HEADER_LENGTH;
527 /* Buffer the message to handle re-xmits */
528 dtls1_buffer_message(s, 0);
531 static int dtls1_handshake_write(SSL *s)
533 return dtls1_do_write(s, SSL3_RT_HANDSHAKE);