ssl/d1_lib.c

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