ssl/d1_lib.c

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