ssl/d1_lib.c

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