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