Remove some SSLv2 references
[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 #define USE_SOCKETS
62 #include <openssl/objects.h>
63 #include <openssl/rand.h>
64 #include "ssl_locl.h"
65
66 #if defined(OPENSSL_SYS_VMS)
67 # include <sys/timeb.h>
68 #elif defined(OPENSSL_SYS_NETWARE) && !defined(_WINSOCK2API_)
69 # include <sys/timeval.h>
70 #elif defined(OPENSSL_SYS_VXWORKS)
71 # include <sys/times.h>
72 #elif !defined(OPENSSL_SYS_WIN32)
73 # include <sys/time.h>
74 #endif
75
76 static void get_current_time(struct timeval *t);
77 static int dtls1_set_handshake_header(SSL *s, int type, unsigned long len);
78 static int dtls1_handshake_write(SSL *s);
79 int dtls1_listen(SSL *s, struct sockaddr *client);
80 static unsigned int dtls1_link_min_mtu(void);
81
82 /* XDTLS:  figure out the right values */
83 static const unsigned int g_probable_mtu[] = { 1500, 512, 256 };
84
85 const SSL3_ENC_METHOD DTLSv1_enc_data = {
86     tls1_enc,
87     tls1_mac,
88     tls1_setup_key_block,
89     tls1_generate_master_secret,
90     tls1_change_cipher_state,
91     tls1_final_finish_mac,
92     TLS1_FINISH_MAC_LENGTH,
93     tls1_cert_verify_mac,
94     TLS_MD_CLIENT_FINISH_CONST, TLS_MD_CLIENT_FINISH_CONST_SIZE,
95     TLS_MD_SERVER_FINISH_CONST, TLS_MD_SERVER_FINISH_CONST_SIZE,
96     tls1_alert_code,
97     tls1_export_keying_material,
98     SSL_ENC_FLAG_DTLS | SSL_ENC_FLAG_EXPLICIT_IV,
99     DTLS1_HM_HEADER_LENGTH,
100     dtls1_set_handshake_header,
101     dtls1_handshake_write
102 };
103
104 const SSL3_ENC_METHOD DTLSv1_2_enc_data = {
105     tls1_enc,
106     tls1_mac,
107     tls1_setup_key_block,
108     tls1_generate_master_secret,
109     tls1_change_cipher_state,
110     tls1_final_finish_mac,
111     TLS1_FINISH_MAC_LENGTH,
112     tls1_cert_verify_mac,
113     TLS_MD_CLIENT_FINISH_CONST, TLS_MD_CLIENT_FINISH_CONST_SIZE,
114     TLS_MD_SERVER_FINISH_CONST, TLS_MD_SERVER_FINISH_CONST_SIZE,
115     tls1_alert_code,
116     tls1_export_keying_material,
117     SSL_ENC_FLAG_DTLS | SSL_ENC_FLAG_EXPLICIT_IV | SSL_ENC_FLAG_SIGALGS
118         | SSL_ENC_FLAG_SHA256_PRF | SSL_ENC_FLAG_TLS1_2_CIPHERS,
119     DTLS1_HM_HEADER_LENGTH,
120     dtls1_set_handshake_header,
121     dtls1_handshake_write
122 };
123
124 long dtls1_default_timeout(void)
125 {
126     /*
127      * 2 hours, the 24 hours mentioned in the DTLSv1 spec is way too long for
128      * http, the cache would over fill
129      */
130     return (60 * 60 * 2);
131 }
132
133 int dtls1_new(SSL *s)
134 {
135     DTLS1_STATE *d1;
136
137     if (!DTLS_RECORD_LAYER_new(&s->rlayer)) {
138         return 0;
139     }
140     
141     if (!ssl3_new(s))
142         return (0);
143     if ((d1 = OPENSSL_zalloc(sizeof(*d1))) == NULL) {
144         ssl3_free(s);
145         return (0);
146     }
147
148     d1->buffered_messages = pqueue_new();
149     d1->sent_messages = pqueue_new();
150
151     if (s->server) {
152         d1->cookie_len = sizeof(s->d1->cookie);
153     }
154
155     d1->link_mtu = 0;
156     d1->mtu = 0;
157
158     if (!d1->buffered_messages || !d1->sent_messages) {
159         pqueue_free(d1->buffered_messages);
160         pqueue_free(d1->sent_messages);
161         OPENSSL_free(d1);
162         ssl3_free(s);
163         return (0);
164     }
165
166     s->d1 = d1;
167     s->method->ssl_clear(s);
168     return (1);
169 }
170
171 static void dtls1_clear_queues(SSL *s)
172 {
173     pitem *item = NULL;
174     hm_fragment *frag = NULL;
175
176     while ((item = pqueue_pop(s->d1->buffered_messages)) != NULL) {
177         frag = (hm_fragment *)item->data;
178         dtls1_hm_fragment_free(frag);
179         pitem_free(item);
180     }
181
182     while ((item = pqueue_pop(s->d1->sent_messages)) != NULL) {
183         frag = (hm_fragment *)item->data;
184         dtls1_hm_fragment_free(frag);
185         pitem_free(item);
186     }
187 }
188
189 void dtls1_free(SSL *s)
190 {
191     DTLS_RECORD_LAYER_free(&s->rlayer);
192
193     ssl3_free(s);
194
195     dtls1_clear_queues(s);
196
197     pqueue_free(s->d1->buffered_messages);
198     pqueue_free(s->d1->sent_messages);
199
200     OPENSSL_free(s->d1);
201     s->d1 = NULL;
202 }
203
204 void dtls1_clear(SSL *s)
205 {
206     pqueue buffered_messages;
207     pqueue sent_messages;
208     unsigned int mtu;
209     unsigned int link_mtu;
210
211     DTLS_RECORD_LAYER_clear(&s->rlayer);
212
213     if (s->d1) {
214         buffered_messages = s->d1->buffered_messages;
215         sent_messages = s->d1->sent_messages;
216         mtu = s->d1->mtu;
217         link_mtu = s->d1->link_mtu;
218
219         dtls1_clear_queues(s);
220
221         memset(s->d1, 0, sizeof(*s->d1));
222
223         if (s->server) {
224             s->d1->cookie_len = sizeof(s->d1->cookie);
225         }
226
227         if (SSL_get_options(s) & SSL_OP_NO_QUERY_MTU) {
228             s->d1->mtu = mtu;
229             s->d1->link_mtu = link_mtu;
230         }
231
232         s->d1->buffered_messages = buffered_messages;
233         s->d1->sent_messages = sent_messages;
234     }
235
236     ssl3_clear(s);
237     if (s->options & SSL_OP_CISCO_ANYCONNECT)
238         s->client_version = s->version = DTLS1_BAD_VER;
239     else if (s->method->version == DTLS_ANY_VERSION)
240         s->version = DTLS1_2_VERSION;
241     else
242         s->version = s->method->version;
243 }
244
245 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg)
246 {
247     int ret = 0;
248
249     switch (cmd) {
250     case DTLS_CTRL_GET_TIMEOUT:
251         if (dtls1_get_timeout(s, (struct timeval *)parg) != NULL) {
252             ret = 1;
253         }
254         break;
255     case DTLS_CTRL_HANDLE_TIMEOUT:
256         ret = dtls1_handle_timeout(s);
257         break;
258     case DTLS_CTRL_LISTEN:
259         ret = dtls1_listen(s, parg);
260         break;
261     case SSL_CTRL_CHECK_PROTO_VERSION:
262         /*
263          * For library-internal use; checks that the current protocol is the
264          * highest enabled version (according to s->ctx->method, as version
265          * negotiation may have changed s->method).
266          */
267         if (s->version == s->ctx->method->version)
268             return 1;
269         /*
270          * Apparently we're using a version-flexible SSL_METHOD (not at its
271          * highest protocol version).
272          */
273         if (s->ctx->method->version == DTLS_method()->version) {
274 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
275 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
276 #endif
277             if (!(s->options & SSL_OP_NO_DTLSv1_2))
278                 return s->version == DTLS1_2_VERSION;
279             if (!(s->options & SSL_OP_NO_DTLSv1))
280                 return s->version == DTLS1_VERSION;
281         }
282         return 0;               /* Unexpected state; fail closed. */
283     case DTLS_CTRL_SET_LINK_MTU:
284         if (larg < (long)dtls1_link_min_mtu())
285             return 0;
286         s->d1->link_mtu = larg;
287         return 1;
288     case DTLS_CTRL_GET_LINK_MIN_MTU:
289         return (long)dtls1_link_min_mtu();
290     case SSL_CTRL_SET_MTU:
291         /*
292          *  We may not have a BIO set yet so can't call dtls1_min_mtu()
293          *  We'll have to make do with dtls1_link_min_mtu() and max overhead
294          */
295         if (larg < (long)dtls1_link_min_mtu() - DTLS1_MAX_MTU_OVERHEAD)
296             return 0;
297         s->d1->mtu = larg;
298         return larg;
299     default:
300         ret = ssl3_ctrl(s, cmd, larg, parg);
301         break;
302     }
303     return (ret);
304 }
305
306 /*
307  * As it's impossible to use stream ciphers in "datagram" mode, this
308  * simple filter is designed to disengage them in DTLS. Unfortunately
309  * there is no universal way to identify stream SSL_CIPHER, so we have
310  * to explicitly list their SSL_* codes. Currently RC4 is the only one
311  * available, but if new ones emerge, they will have to be added...
312  */
313 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
314 {
315     const SSL_CIPHER *ciph = ssl3_get_cipher(u);
316
317     if (ciph != NULL) {
318         if (ciph->algorithm_enc == SSL_RC4)
319             return NULL;
320     }
321
322     return ciph;
323 }
324
325 void dtls1_start_timer(SSL *s)
326 {
327 #ifndef OPENSSL_NO_SCTP
328     /* Disable timer for SCTP */
329     if (BIO_dgram_is_sctp(SSL_get_wbio(s))) {
330         memset(&s->d1->next_timeout, 0, sizeof(s->d1->next_timeout));
331         return;
332     }
333 #endif
334
335     /* If timer is not set, initialize duration with 1 second */
336     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
337         s->d1->timeout_duration = 1;
338     }
339
340     /* Set timeout to current time */
341     get_current_time(&(s->d1->next_timeout));
342
343     /* Add duration to current time */
344     s->d1->next_timeout.tv_sec += s->d1->timeout_duration;
345     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
346              &(s->d1->next_timeout));
347 }
348
349 struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft)
350 {
351     struct timeval timenow;
352
353     /* If no timeout is set, just return NULL */
354     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
355         return NULL;
356     }
357
358     /* Get current time */
359     get_current_time(&timenow);
360
361     /* If timer already expired, set remaining time to 0 */
362     if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
363         (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
364          s->d1->next_timeout.tv_usec <= timenow.tv_usec)) {
365         memset(timeleft, 0, sizeof(*timeleft));
366         return timeleft;
367     }
368
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) {
374         timeleft->tv_sec--;
375         timeleft->tv_usec += 1000000;
376     }
377
378     /*
379      * If remaining time is less than 15 ms, set it to 0 to prevent issues
380      * because of small devergences with socket timeouts.
381      */
382     if (timeleft->tv_sec == 0 && timeleft->tv_usec < 15000) {
383         memset(timeleft, 0, sizeof(*timeleft));
384     }
385
386     return timeleft;
387 }
388
389 int dtls1_is_timer_expired(SSL *s)
390 {
391     struct timeval timeleft;
392
393     /* Get time left until timeout, return false if no timer running */
394     if (dtls1_get_timeout(s, &timeleft) == NULL) {
395         return 0;
396     }
397
398     /* Return false if timer is not expired yet */
399     if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0) {
400         return 0;
401     }
402
403     /* Timer expired, so return true */
404     return 1;
405 }
406
407 void dtls1_double_timeout(SSL *s)
408 {
409     s->d1->timeout_duration *= 2;
410     if (s->d1->timeout_duration > 60)
411         s->d1->timeout_duration = 60;
412     dtls1_start_timer(s);
413 }
414
415 void dtls1_stop_timer(SSL *s)
416 {
417     /* Reset everything */
418     memset(&s->d1->timeout, 0, sizeof(s->d1->timeout));
419     memset(&s->d1->next_timeout, 0, sizeof(s->d1->next_timeout));
420     s->d1->timeout_duration = 1;
421     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
422              &(s->d1->next_timeout));
423     /* Clear retransmission buffer */
424     dtls1_clear_record_buffer(s);
425 }
426
427 int dtls1_check_timeout_num(SSL *s)
428 {
429     unsigned int mtu;
430
431     s->d1->timeout.num_alerts++;
432
433     /* Reduce MTU after 2 unsuccessful retransmissions */
434     if (s->d1->timeout.num_alerts > 2
435         && !(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
436         mtu =
437             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_FALLBACK_MTU, 0,
438                      NULL);
439         if (mtu < s->d1->mtu)
440             s->d1->mtu = mtu;
441     }
442
443     if (s->d1->timeout.num_alerts > DTLS1_TMO_ALERT_COUNT) {
444         /* fail the connection, enough alerts have been sent */
445         SSLerr(SSL_F_DTLS1_CHECK_TIMEOUT_NUM, SSL_R_READ_TIMEOUT_EXPIRED);
446         return -1;
447     }
448
449     return 0;
450 }
451
452 int dtls1_handle_timeout(SSL *s)
453 {
454     /* if no timer is expired, don't do anything */
455     if (!dtls1_is_timer_expired(s)) {
456         return 0;
457     }
458
459     dtls1_double_timeout(s);
460
461     if (dtls1_check_timeout_num(s) < 0)
462         return -1;
463
464     s->d1->timeout.read_timeouts++;
465     if (s->d1->timeout.read_timeouts > DTLS1_TMO_READ_COUNT) {
466         s->d1->timeout.read_timeouts = 1;
467     }
468 #ifndef OPENSSL_NO_HEARTBEATS
469     if (s->tlsext_hb_pending) {
470         s->tlsext_hb_pending = 0;
471         return dtls1_heartbeat(s);
472     }
473 #endif
474
475     dtls1_start_timer(s);
476     return dtls1_retransmit_buffered_messages(s);
477 }
478
479 static void get_current_time(struct timeval *t)
480 {
481 #if defined(_WIN32)
482     SYSTEMTIME st;
483     union {
484         unsigned __int64 ul;
485         FILETIME ft;
486     } now;
487
488     GetSystemTime(&st);
489     SystemTimeToFileTime(&st, &now.ft);
490 # ifdef  __MINGW32__
491     now.ul -= 116444736000000000ULL;
492 # else
493     now.ul -= 116444736000000000UI64; /* re-bias to 1/1/1970 */
494 # endif
495     t->tv_sec = (long)(now.ul / 10000000);
496     t->tv_usec = ((int)(now.ul % 10000000)) / 10;
497 #elif defined(OPENSSL_SYS_VMS)
498     struct timeb tb;
499     ftime(&tb);
500     t->tv_sec = (long)tb.time;
501     t->tv_usec = (long)tb.millitm * 1000;
502 #else
503     gettimeofday(t, NULL);
504 #endif
505 }
506
507
508 #define LISTEN_SUCCESS              2
509 #define LISTEN_SEND_VERIFY_REQUEST  1
510
511
512 int dtls1_listen(SSL *s, struct sockaddr *client)
513 {
514     int next, n, ret = 0, clearpkt = 0;
515     unsigned char cookie[DTLS1_COOKIE_LENGTH];
516     unsigned char seq[SEQ_NUM_SIZE];
517     unsigned char *data, *p, *buf;
518     unsigned long reclen, fragoff, fraglen, msglen;
519     unsigned int rectype, versmajor, msgseq, msgtype, clientvers, cookielen;
520     BIO *rbio, *wbio;
521     BUF_MEM *bufm;
522     struct sockaddr_storage tmpclient;
523     PACKET pkt, msgpkt, msgpayload, session, cookiepkt;
524
525     /* Ensure there is no state left over from a previous invocation */
526     if (!SSL_clear(s))
527         return -1;
528
529     ERR_clear_error();
530
531     rbio = SSL_get_rbio(s);
532     wbio = SSL_get_wbio(s);
533
534     if(!rbio || !wbio) {
535         SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_BIO_NOT_SET);
536         return -1;
537     }
538
539     /*
540      * We only peek at incoming ClientHello's until we're sure we are going to
541      * to respond with a HelloVerifyRequest. If its a ClientHello with a valid
542      * cookie then we leave it in the BIO for dtls1_accept to handle.
543      */
544     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_PEEK_MODE, 1, NULL);
545
546     /*
547      * Note: This check deliberately excludes DTLS1_BAD_VER because that version
548      * requires the MAC to be calculated *including* the first ClientHello
549      * (without the cookie). Since DTLSv1_listen is stateless that cannot be
550      * supported. DTLS1_BAD_VER must use cookies in a stateful manner (e.g. via
551      * SSL_accept)
552      */
553     if ((s->version & 0xff00) != (DTLS1_VERSION & 0xff00)) {
554         SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_UNSUPPORTED_SSL_VERSION);
555         return -1;
556     }
557
558     if (s->init_buf == NULL) {
559         if ((bufm = BUF_MEM_new()) == NULL) {
560             SSLerr(SSL_F_DTLS1_LISTEN, ERR_R_MALLOC_FAILURE);
561             return -1;
562         }
563
564         if (!BUF_MEM_grow(bufm, SSL3_RT_MAX_PLAIN_LENGTH)) {
565             BUF_MEM_free(bufm);
566             SSLerr(SSL_F_DTLS1_LISTEN, ERR_R_MALLOC_FAILURE);
567             return -1;
568         }
569         s->init_buf = bufm;
570     }
571     buf = (unsigned char *)s->init_buf->data;
572
573     do {
574         /* Get a packet */
575
576         clear_sys_error();
577         /*
578          * Technically a ClientHello could be SSL3_RT_MAX_PLAIN_LENGTH
579          * + DTLS1_RT_HEADER_LENGTH bytes long. Normally init_buf does not store
580          * the record header as well, but we do here. We've set up init_buf to
581          * be the standard size for simplicity. In practice we shouldn't ever
582          * receive a ClientHello as long as this. If we do it will get dropped
583          * in the record length check below.
584          */
585         n = BIO_read(rbio, buf, SSL3_RT_MAX_PLAIN_LENGTH);
586
587         if (n <= 0) {
588             if(BIO_should_retry(rbio)) {
589                 /* Non-blocking IO */
590                 goto end;
591             }
592             return -1;
593         }
594
595         /* If we hit any problems we need to clear this packet from the BIO */
596         clearpkt = 1;
597
598         if (!PACKET_buf_init(&pkt, buf, n)) {
599             SSLerr(SSL_F_DTLS1_LISTEN, ERR_R_INTERNAL_ERROR);
600             return -1;
601         }
602
603         /*
604          * Parse the received record. If there are any problems with it we just
605          * dump it - with no alert. RFC6347 says this "Unlike TLS, DTLS is
606          * resilient in the face of invalid records (e.g., invalid formatting,
607          * length, MAC, etc.).  In general, invalid records SHOULD be silently
608          * discarded, thus preserving the association; however, an error MAY be
609          * logged for diagnostic purposes."
610          */
611
612         /* this packet contained a partial record, dump it */
613         if (n < DTLS1_RT_HEADER_LENGTH) {
614             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_RECORD_TOO_SMALL);
615             goto end;
616         }
617
618         if (s->msg_callback)
619             s->msg_callback(0, 0, SSL3_RT_HEADER, buf,
620                             DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
621
622         /* Get the record header */
623         if (!PACKET_get_1(&pkt, &rectype)
624             || !PACKET_get_1(&pkt, &versmajor)) {
625             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_LENGTH_MISMATCH);
626             goto end;
627         }
628
629         if (rectype != SSL3_RT_HANDSHAKE)  {
630             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_UNEXPECTED_MESSAGE);
631             goto end;
632         }
633
634         /*
635          * Check record version number. We only check that the major version is
636          * the same.
637          */
638         if (versmajor != DTLS1_VERSION_MAJOR) {
639             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_BAD_PROTOCOL_VERSION_NUMBER);
640             goto end;
641         }
642
643         if (!PACKET_forward(&pkt, 1)
644             /* Save the sequence number: 64 bits, with top 2 bytes = epoch */
645             || !PACKET_copy_bytes(&pkt, seq, SEQ_NUM_SIZE)
646             || !PACKET_get_length_prefixed_2(&pkt, &msgpkt)
647             || PACKET_remaining(&pkt) != 0) {
648             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_LENGTH_MISMATCH);
649             goto end;
650         }
651
652         /* This is an initial ClientHello so the epoch has to be 0 */
653         if (seq[0] != 0 || seq[1] != 0) {
654             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_UNEXPECTED_MESSAGE);
655             goto end;
656         }
657
658         /* Get a pointer to the raw message for the later callback */
659         data = PACKET_data(&msgpkt);
660
661         /* Finished processing the record header, now process the message */
662         if (!PACKET_get_1(&msgpkt, &msgtype)
663             || !PACKET_get_net_3(&msgpkt, &msglen)
664             || !PACKET_get_net_2(&msgpkt, &msgseq)
665             || !PACKET_get_net_3(&msgpkt, &fragoff)
666             || !PACKET_get_net_3(&msgpkt, &fraglen)
667             || !PACKET_get_sub_packet(&msgpkt, &msgpayload, msglen)
668             || PACKET_remaining(&msgpkt) != 0) {
669             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_LENGTH_MISMATCH);
670             goto end;
671         }
672
673         if (msgtype != SSL3_MT_CLIENT_HELLO) {
674             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_UNEXPECTED_MESSAGE);
675             goto end;
676         }
677
678         /* Message sequence number can only be 0 or 1 */
679         if(msgseq > 2) {
680             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_INVALID_SEQUENCE_NUMBER);
681             goto end;
682         }
683
684         /* We don't support a fragmented ClientHello whilst listening */
685         if (fragoff != 0 || fraglen != msglen) {
686             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_FRAGMENTED_CLIENT_HELLO);
687             goto end;
688         }
689
690         if (s->msg_callback)
691             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE, data,
692                             msglen + DTLS1_HM_HEADER_LENGTH, s,
693                             s->msg_callback_arg);
694
695         if (!PACKET_get_net_2(&msgpayload, &clientvers)) {
696             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_LENGTH_MISMATCH);
697             goto end;
698         }
699
700         /*
701          * Verify client version is supported
702          */
703         if ((clientvers > (unsigned int)s->method->version &&
704                               s->method->version != DTLS_ANY_VERSION)) {
705             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_WRONG_VERSION_NUMBER);
706             goto end;
707         }
708
709         if (!PACKET_forward(&msgpayload, SSL3_RANDOM_SIZE)
710             || !PACKET_get_length_prefixed_1(&msgpayload, &session)
711             || !PACKET_get_length_prefixed_1(&msgpayload, &cookiepkt)) {
712             SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_LENGTH_MISMATCH);
713             goto end;
714         }
715
716         /*
717          * Check if we have a cookie or not. If not we need to send a
718          * HelloVerifyRequest.
719          */
720         if (PACKET_remaining(&cookiepkt) == 0) {
721             next = LISTEN_SEND_VERIFY_REQUEST;
722         } else {
723             /*
724              * We have a cookie, so lets check it.
725              */
726             if (s->ctx->app_verify_cookie_cb == NULL) {
727                 SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_NO_VERIFY_COOKIE_CALLBACK);
728                 /* This is fatal */
729                 return -1;
730             }
731             if (s->ctx->app_verify_cookie_cb(s, PACKET_data(&cookiepkt),
732                                              PACKET_remaining(&cookiepkt)) ==
733                 0) {
734                 /*
735                  * We treat invalid cookies in the same was as no cookie as
736                  * per RFC6347
737                  */
738                 next = LISTEN_SEND_VERIFY_REQUEST;
739             } else {
740                 /* Cookie verification succeeded */
741                 next = LISTEN_SUCCESS;
742             }
743         }
744
745         if (next == LISTEN_SEND_VERIFY_REQUEST) {
746             /*
747              * There was no cookie in the ClientHello so we need to send a
748              * HelloVerifyRequest. If this fails we do not worry about trying
749              * to resend, we just drop it.
750              */
751
752             /*
753              * Dump the read packet, we don't need it any more. Ignore return
754              * value
755              */
756             BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_PEEK_MODE, 0, NULL);
757             BIO_read(rbio, buf, SSL3_RT_MAX_PLAIN_LENGTH);
758             BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_PEEK_MODE, 1, NULL);
759
760             /* Generate the cookie */
761             if (s->ctx->app_gen_cookie_cb == NULL ||
762                 s->ctx->app_gen_cookie_cb(s, cookie, &cookielen) == 0 ||
763                 cookielen > 255) {
764                 SSLerr(SSL_F_DTLS1_LISTEN, SSL_R_COOKIE_GEN_CALLBACK_FAILURE);
765                 /* This is fatal */
766                 return -1;
767             }
768
769             p = &buf[DTLS1_RT_HEADER_LENGTH];
770             msglen = dtls_raw_hello_verify_request(p + DTLS1_HM_HEADER_LENGTH,
771                                                    cookie, cookielen);
772
773             *p++ = DTLS1_MT_HELLO_VERIFY_REQUEST;
774
775             /* Message length */
776             l2n3(msglen, p);
777
778             /* Message sequence number is always 0 for a HelloVerifyRequest */
779             s2n(0, p);
780
781             /*
782              * We never fragment a HelloVerifyRequest, so fragment offset is 0
783              * and fragment length is message length
784              */
785             l2n3(0, p);
786             l2n3(msglen, p);
787
788             /* Set reclen equal to length of whole handshake message */
789             reclen = msglen + DTLS1_HM_HEADER_LENGTH;
790
791             /* Add the record header */
792             p = buf;
793
794             *(p++) = SSL3_RT_HANDSHAKE;
795             /*
796              * Special case: for hello verify request, client version 1.0 and we
797              * haven't decided which version to use yet send back using version
798              * 1.0 header: otherwise some clients will ignore it.
799              */
800             if (s->method->version == DTLS_ANY_VERSION) {
801                 *(p++) = DTLS1_VERSION >> 8;
802                 *(p++) = DTLS1_VERSION & 0xff;
803             } else {
804                 *(p++) = s->version >> 8;
805                 *(p++) = s->version & 0xff;
806             }
807
808             /*
809              * Record sequence number is always the same as in the received
810              * ClientHello
811              */
812             memcpy(p, seq, SEQ_NUM_SIZE);
813             p += SEQ_NUM_SIZE;
814
815             /* Length */
816             s2n(reclen, p);
817
818             /*
819              * Set reclen equal to length of whole record including record
820              * header
821              */
822             reclen += DTLS1_RT_HEADER_LENGTH;
823
824             if (s->msg_callback)
825                 s->msg_callback(1, 0, SSL3_RT_HEADER, buf,
826                                 DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
827
828             /*
829              * This is unneccessary if rbio and wbio are one and the same - but
830              * maybe they're not.
831              */
832             if(BIO_dgram_get_peer(rbio, &tmpclient) <= 0
833                || BIO_dgram_set_peer(wbio, &tmpclient) <= 0) {
834                 SSLerr(SSL_F_DTLS1_LISTEN, ERR_R_INTERNAL_ERROR);
835                 goto end;
836             }
837
838             if (BIO_write(wbio, buf, reclen) < (int)reclen) {
839                 if(BIO_should_retry(wbio)) {
840                     /*
841                      * Non-blocking IO...but we're stateless, so we're just
842                      * going to drop this packet.
843                      */
844                     goto end;
845                 }
846                 return -1;
847             }
848
849             if (BIO_flush(wbio) <= 0) {
850                 if(BIO_should_retry(wbio)) {
851                     /*
852                      * Non-blocking IO...but we're stateless, so we're just
853                      * going to drop this packet.
854                      */
855                     goto end;
856                 }
857                 return -1;
858             }
859         }
860     } while (next != LISTEN_SUCCESS);
861
862     /*
863      * Set expected sequence numbers to continue the handshake.
864      */
865     s->d1->handshake_read_seq = 1;
866     s->d1->handshake_write_seq = 1;
867     s->d1->next_handshake_write_seq = 1;
868     DTLS_RECORD_LAYER_set_write_sequence(&s->rlayer, seq);
869
870     /*
871      * We are doing cookie exchange, so make sure we set that option in the
872      * SSL object
873      */
874     SSL_set_options(s, SSL_OP_COOKIE_EXCHANGE);
875
876     /*
877      * Tell the state machine that we've done the initial hello verify
878      * exchange
879      */
880     ossl_statem_set_hello_verify_done(s);
881
882     if(BIO_dgram_get_peer(rbio, client) <= 0) {
883         SSLerr(SSL_F_DTLS1_LISTEN, ERR_R_INTERNAL_ERROR);
884         return -1;
885     }
886
887     ret = 1;
888     clearpkt = 0;
889 end:
890     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_PEEK_MODE, 0, NULL);
891     if (clearpkt) {
892         /* Dump this packet. Ignore return value */
893         BIO_read(rbio, buf, SSL3_RT_MAX_PLAIN_LENGTH);
894     }
895     return ret;
896 }
897
898 static int dtls1_set_handshake_header(SSL *s, int htype, unsigned long len)
899 {
900     unsigned char *p = (unsigned char *)s->init_buf->data;
901     dtls1_set_message_header(s, p, htype, len, 0, len);
902     s->init_num = (int)len + DTLS1_HM_HEADER_LENGTH;
903     s->init_off = 0;
904     /* Buffer the message to handle re-xmits */
905
906     if (!dtls1_buffer_message(s, 0))
907         return 0;
908
909     return 1;
910 }
911
912 static int dtls1_handshake_write(SSL *s)
913 {
914     return dtls1_do_write(s, SSL3_RT_HANDSHAKE);
915 }
916
917 #ifndef OPENSSL_NO_HEARTBEATS
918 int dtls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length)
919 {
920     unsigned char *pl;
921     unsigned short hbtype;
922     unsigned int payload;
923     unsigned int padding = 16;  /* Use minimum padding */
924
925     if (s->msg_callback)
926         s->msg_callback(0, s->version, TLS1_RT_HEARTBEAT,
927                         p, length, s, s->msg_callback_arg);
928
929     /* Read type and payload length first */
930     if (1 + 2 + 16 > length)
931         return 0;               /* silently discard */
932     if (length > SSL3_RT_MAX_PLAIN_LENGTH)
933         return 0;               /* silently discard per RFC 6520 sec. 4 */
934
935     hbtype = *p++;
936     n2s(p, payload);
937     if (1 + 2 + payload + 16 > length)
938         return 0;               /* silently discard per RFC 6520 sec. 4 */
939     pl = p;
940
941     if (hbtype == TLS1_HB_REQUEST) {
942         unsigned char *buffer, *bp;
943         unsigned int write_length = 1 /* heartbeat type */  +
944             2 /* heartbeat length */  +
945             payload + padding;
946         int r;
947
948         if (write_length > SSL3_RT_MAX_PLAIN_LENGTH)
949             return 0;
950
951         /*
952          * Allocate memory for the response, size is 1 byte message type,
953          * plus 2 bytes payload length, plus payload, plus padding
954          */
955         buffer = OPENSSL_malloc(write_length);
956         if (buffer == NULL)
957             return -1;
958         bp = buffer;
959
960         /* Enter response type, length and copy payload */
961         *bp++ = TLS1_HB_RESPONSE;
962         s2n(payload, bp);
963         memcpy(bp, pl, payload);
964         bp += payload;
965         /* Random padding */
966         if (RAND_bytes(bp, padding) <= 0) {
967             OPENSSL_free(buffer);
968             return -1;
969         }
970
971         r = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buffer, write_length);
972
973         if (r >= 0 && s->msg_callback)
974             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
975                             buffer, write_length, s, s->msg_callback_arg);
976
977         OPENSSL_free(buffer);
978
979         if (r < 0)
980             return r;
981     } else if (hbtype == TLS1_HB_RESPONSE) {
982         unsigned int seq;
983
984         /*
985          * We only send sequence numbers (2 bytes unsigned int), and 16
986          * random bytes, so we just try to read the sequence number
987          */
988         n2s(pl, seq);
989
990         if (payload == 18 && seq == s->tlsext_hb_seq) {
991             dtls1_stop_timer(s);
992             s->tlsext_hb_seq++;
993             s->tlsext_hb_pending = 0;
994         }
995     }
996
997     return 0;
998 }
999
1000 int dtls1_heartbeat(SSL *s)
1001 {
1002     unsigned char *buf, *p;
1003     int ret = -1;
1004     unsigned int payload = 18;  /* Sequence number + random bytes */
1005     unsigned int padding = 16;  /* Use minimum padding */
1006
1007     /* Only send if peer supports and accepts HB requests... */
1008     if (!(s->tlsext_heartbeat & SSL_TLSEXT_HB_ENABLED) ||
1009         s->tlsext_heartbeat & SSL_TLSEXT_HB_DONT_SEND_REQUESTS) {
1010         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PEER_DOESNT_ACCEPT);
1011         return -1;
1012     }
1013
1014     /* ...and there is none in flight yet... */
1015     if (s->tlsext_hb_pending) {
1016         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PENDING);
1017         return -1;
1018     }
1019
1020     /* ...and no handshake in progress. */
1021     if (SSL_in_init(s) || ossl_statem_get_in_handshake(s)) {
1022         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_UNEXPECTED_MESSAGE);
1023         return -1;
1024     }
1025
1026     /*
1027      * Check if padding is too long, payload and padding must not exceed 2^14
1028      * - 3 = 16381 bytes in total.
1029      */
1030     OPENSSL_assert(payload + padding <= 16381);
1031
1032     /*-
1033      * Create HeartBeat message, we just use a sequence number
1034      * as payload to distuingish different messages and add
1035      * some random stuff.
1036      *  - Message Type, 1 byte
1037      *  - Payload Length, 2 bytes (unsigned int)
1038      *  - Payload, the sequence number (2 bytes uint)
1039      *  - Payload, random bytes (16 bytes uint)
1040      *  - Padding
1041      */
1042     buf = OPENSSL_malloc(1 + 2 + payload + padding);
1043     if (buf == NULL) {
1044         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_MALLOC_FAILURE);
1045         return -1;
1046     }
1047     p = buf;
1048     /* Message Type */
1049     *p++ = TLS1_HB_REQUEST;
1050     /* Payload length (18 bytes here) */
1051     s2n(payload, p);
1052     /* Sequence number */
1053     s2n(s->tlsext_hb_seq, p);
1054     /* 16 random bytes */
1055     if (RAND_bytes(p, 16) <= 0) {
1056         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1057         goto err;
1058     }
1059     p += 16;
1060     /* Random padding */
1061     if (RAND_bytes(p, padding) <= 0) {
1062         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1063         goto err;
1064     }
1065
1066     ret = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buf, 3 + payload + padding);
1067     if (ret >= 0) {
1068         if (s->msg_callback)
1069             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
1070                             buf, 3 + payload + padding,
1071                             s, s->msg_callback_arg);
1072
1073         dtls1_start_timer(s);
1074         s->tlsext_hb_pending = 1;
1075     }
1076
1077  err:
1078     OPENSSL_free(buf);
1079
1080     return ret;
1081 }
1082 #endif
1083
1084 int dtls1_shutdown(SSL *s)
1085 {
1086     int ret;
1087 #ifndef OPENSSL_NO_SCTP
1088     BIO *wbio;
1089
1090     wbio = SSL_get_wbio(s);
1091     if (wbio != NULL && BIO_dgram_is_sctp(wbio) &&
1092         !(s->shutdown & SSL_SENT_SHUTDOWN)) {
1093         ret = BIO_dgram_sctp_wait_for_dry(wbio);
1094         if (ret < 0)
1095             return -1;
1096
1097         if (ret == 0)
1098             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 1,
1099                      NULL);
1100     }
1101 #endif
1102     ret = ssl3_shutdown(s);
1103 #ifndef OPENSSL_NO_SCTP
1104     BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 0, NULL);
1105 #endif
1106     return ret;
1107 }
1108
1109 int dtls1_query_mtu(SSL *s)
1110 {
1111     if (s->d1->link_mtu) {
1112         s->d1->mtu =
1113             s->d1->link_mtu - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
1114         s->d1->link_mtu = 0;
1115     }
1116
1117     /* AHA!  Figure out the MTU, and stick to the right size */
1118     if (s->d1->mtu < dtls1_min_mtu(s)) {
1119         if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
1120             s->d1->mtu =
1121                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
1122
1123             /*
1124              * I've seen the kernel return bogus numbers when it doesn't know
1125              * (initial write), so just make sure we have a reasonable number
1126              */
1127             if (s->d1->mtu < dtls1_min_mtu(s)) {
1128                 /* Set to min mtu */
1129                 s->d1->mtu = dtls1_min_mtu(s);
1130                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SET_MTU,
1131                          s->d1->mtu, NULL);
1132             }
1133         } else
1134             return 0;
1135     }
1136     return 1;
1137 }
1138
1139 static unsigned int dtls1_link_min_mtu(void)
1140 {
1141     return (g_probable_mtu[(sizeof(g_probable_mtu) /
1142                             sizeof(g_probable_mtu[0])) - 1]);
1143 }
1144
1145 unsigned int dtls1_min_mtu(SSL *s)
1146 {
1147     return dtls1_link_min_mtu() - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
1148 }