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