ssl/d1_lib.c

   1 /*
   2  * Copyright 2005-2022 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 "internal/e_os.h"
  11 #include <stdio.h>
  12 #include <openssl/objects.h>
  13 #include <openssl/rand.h>
  14 #include "ssl_local.h"
  15 #include "internal/time.h"
  16
  17 static void get_current_time(struct timeval *t);
  18 static int dtls1_handshake_write(SSL_CONNECTION *s);
  19 static size_t dtls1_link_min_mtu(void);
  20
  21 /* XDTLS:  figure out the right values */
  22 static const size_t g_probable_mtu[] = { 1500, 512, 256 };
  23
  24 const SSL3_ENC_METHOD DTLSv1_enc_data = {
  25     tls1_enc,
  26     tls1_mac_old,
  27     tls1_setup_key_block,
  28     tls1_generate_master_secret,
  29     tls1_change_cipher_state,
  30     tls1_final_finish_mac,
  31     TLS_MD_CLIENT_FINISH_CONST, TLS_MD_CLIENT_FINISH_CONST_SIZE,
  32     TLS_MD_SERVER_FINISH_CONST, TLS_MD_SERVER_FINISH_CONST_SIZE,
  33     tls1_alert_code,
  34     tls1_export_keying_material,
  35     SSL_ENC_FLAG_DTLS | SSL_ENC_FLAG_EXPLICIT_IV,
  36     dtls1_set_handshake_header,
  37     dtls1_close_construct_packet,
  38     dtls1_handshake_write
  39 };
  40
  41 const SSL3_ENC_METHOD DTLSv1_2_enc_data = {
  42     tls1_enc,
  43     tls1_mac_old,
  44     tls1_setup_key_block,
  45     tls1_generate_master_secret,
  46     tls1_change_cipher_state,
  47     tls1_final_finish_mac,
  48     TLS_MD_CLIENT_FINISH_CONST, TLS_MD_CLIENT_FINISH_CONST_SIZE,
  49     TLS_MD_SERVER_FINISH_CONST, TLS_MD_SERVER_FINISH_CONST_SIZE,
  50     tls1_alert_code,
  51     tls1_export_keying_material,
  52     SSL_ENC_FLAG_DTLS | SSL_ENC_FLAG_EXPLICIT_IV | SSL_ENC_FLAG_SIGALGS
  53         | SSL_ENC_FLAG_SHA256_PRF | SSL_ENC_FLAG_TLS1_2_CIPHERS,
  54     dtls1_set_handshake_header,
  55     dtls1_close_construct_packet,
  56     dtls1_handshake_write
  57 };
  58
  59 long dtls1_default_timeout(void)
  60 {
  61     /*
  62      * 2 hours, the 24 hours mentioned in the DTLSv1 spec is way too long for
  63      * http, the cache would over fill
  64      */
  65     return (60 * 60 * 2);
  66 }
  67
  68 int dtls1_new(SSL *ssl)
  69 {
  70     DTLS1_STATE *d1;
  71     SSL_CONNECTION *s = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
  72
  73     if (s == NULL)
  74         return 0;
  75
  76     if (!DTLS_RECORD_LAYER_new(&s->rlayer)) {
  77         return 0;
  78     }
  79
  80     if (!ssl3_new(ssl))
  81         return 0;
  82     if ((d1 = OPENSSL_zalloc(sizeof(*d1))) == NULL) {
  83         ssl3_free(ssl);
  84         return 0;
  85     }
  86
  87     d1->buffered_messages = pqueue_new();
  88     d1->sent_messages = pqueue_new();
  89
  90     if (s->server) {
  91         d1->cookie_len = sizeof(s->d1->cookie);
  92     }
  93
  94     d1->link_mtu = 0;
  95     d1->mtu = 0;
  96
  97     if (d1->buffered_messages == NULL || d1->sent_messages == NULL) {
  98         pqueue_free(d1->buffered_messages);
  99         pqueue_free(d1->sent_messages);
 100         OPENSSL_free(d1);
 101         ssl3_free(ssl);
 102         return 0;
 103     }
 104
 105     s->d1 = d1;
 106
 107     if (!ssl->method->ssl_clear(ssl))
 108         return 0;
 109
 110     return 1;
 111 }
 112
 113 static void dtls1_clear_queues(SSL_CONNECTION *s)
 114 {
 115     dtls1_clear_received_buffer(s);
 116     dtls1_clear_sent_buffer(s);
 117 }
 118
 119 void dtls1_clear_received_buffer(SSL_CONNECTION *s)
 120 {
 121     pitem *item = NULL;
 122     hm_fragment *frag = NULL;
 123
 124     while ((item = pqueue_pop(s->d1->buffered_messages)) != NULL) {
 125         frag = (hm_fragment *)item->data;
 126         dtls1_hm_fragment_free(frag);
 127         pitem_free(item);
 128     }
 129 }
 130
 131 void dtls1_clear_sent_buffer(SSL_CONNECTION *s)
 132 {
 133     pitem *item = NULL;
 134     hm_fragment *frag = NULL;
 135
 136     while ((item = pqueue_pop(s->d1->sent_messages)) != NULL) {
 137         frag = (hm_fragment *)item->data;
 138         dtls1_hm_fragment_free(frag);
 139         pitem_free(item);
 140     }
 141 }
 142
 143
 144 void dtls1_free(SSL *ssl)
 145 {
 146     SSL_CONNECTION *s = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
 147
 148     if (s == NULL)
 149         return;
 150
 151     DTLS_RECORD_LAYER_free(&s->rlayer);
 152
 153     ssl3_free(ssl);
 154
 155     if (s->d1 != NULL) {
 156         dtls1_clear_queues(s);
 157         pqueue_free(s->d1->buffered_messages);
 158         pqueue_free(s->d1->sent_messages);
 159     }
 160
 161     OPENSSL_free(s->d1);
 162     s->d1 = NULL;
 163 }
 164
 165 int dtls1_clear(SSL *ssl)
 166 {
 167     pqueue *buffered_messages;
 168     pqueue *sent_messages;
 169     size_t mtu;
 170     size_t link_mtu;
 171
 172     SSL_CONNECTION *s = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
 173
 174     if (s == NULL)
 175         return 0;
 176
 177     DTLS_RECORD_LAYER_clear(&s->rlayer);
 178
 179     if (s->d1) {
 180         DTLS_timer_cb timer_cb = s->d1->timer_cb;
 181
 182         buffered_messages = s->d1->buffered_messages;
 183         sent_messages = s->d1->sent_messages;
 184         mtu = s->d1->mtu;
 185         link_mtu = s->d1->link_mtu;
 186
 187         dtls1_clear_queues(s);
 188
 189         memset(s->d1, 0, sizeof(*s->d1));
 190
 191         /* Restore the timer callback from previous state */
 192         s->d1->timer_cb = timer_cb;
 193
 194         if (s->server) {
 195             s->d1->cookie_len = sizeof(s->d1->cookie);
 196         }
 197
 198         if (SSL_get_options(ssl) & SSL_OP_NO_QUERY_MTU) {
 199             s->d1->mtu = mtu;
 200             s->d1->link_mtu = link_mtu;
 201         }
 202
 203         s->d1->buffered_messages = buffered_messages;
 204         s->d1->sent_messages = sent_messages;
 205     }
 206
 207     if (!ssl3_clear(ssl))
 208         return 0;
 209
 210     if (ssl->method->version == DTLS_ANY_VERSION)
 211         s->version = DTLS_MAX_VERSION_INTERNAL;
 212 #ifndef OPENSSL_NO_DTLS1_METHOD
 213     else if (s->options & SSL_OP_CISCO_ANYCONNECT)
 214         s->client_version = s->version = DTLS1_BAD_VER;
 215 #endif
 216     else
 217         s->version = ssl->method->version;
 218
 219     return 1;
 220 }
 221
 222 long dtls1_ctrl(SSL *ssl, int cmd, long larg, void *parg)
 223 {
 224     int ret = 0;
 225     SSL_CONNECTION *s = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
 226
 227     if (s == NULL)
 228         return 0;
 229
 230     switch (cmd) {
 231     case DTLS_CTRL_GET_TIMEOUT:
 232         if (dtls1_get_timeout(s, (struct timeval *)parg) != NULL) {
 233             ret = 1;
 234         }
 235         break;
 236     case DTLS_CTRL_HANDLE_TIMEOUT:
 237         ret = dtls1_handle_timeout(s);
 238         break;
 239     case DTLS_CTRL_SET_LINK_MTU:
 240         if (larg < (long)dtls1_link_min_mtu())
 241             return 0;
 242         s->d1->link_mtu = larg;
 243         return 1;
 244     case DTLS_CTRL_GET_LINK_MIN_MTU:
 245         return (long)dtls1_link_min_mtu();
 246     case SSL_CTRL_SET_MTU:
 247         /*
 248          *  We may not have a BIO set yet so can't call dtls1_min_mtu()
 249          *  We'll have to make do with dtls1_link_min_mtu() and max overhead
 250          */
 251         if (larg < (long)dtls1_link_min_mtu() - DTLS1_MAX_MTU_OVERHEAD)
 252             return 0;
 253         s->d1->mtu = larg;
 254         return larg;
 255     default:
 256         ret = ssl3_ctrl(ssl, cmd, larg, parg);
 257         break;
 258     }
 259     return ret;
 260 }
 261
 262 void dtls1_start_timer(SSL_CONNECTION *s)
 263 {
 264     unsigned int sec, usec;
 265     SSL *ssl = SSL_CONNECTION_GET_SSL(s);
 266
 267 #ifndef OPENSSL_NO_SCTP
 268     /* Disable timer for SCTP */
 269     if (BIO_dgram_is_sctp(SSL_get_wbio(ssl))) {
 270         memset(&s->d1->next_timeout, 0, sizeof(s->d1->next_timeout));
 271         return;
 272     }
 273 #endif
 274
 275     /*
 276      * If timer is not set, initialize duration with 1 second or
 277      * a user-specified value if the timer callback is installed.
 278      */
 279     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
 280
 281         if (s->d1->timer_cb != NULL)
 282             s->d1->timeout_duration_us = s->d1->timer_cb(ssl, 0);
 283         else
 284             s->d1->timeout_duration_us = 1000000;
 285     }
 286
 287     /* Set timeout to current time */
 288     get_current_time(&(s->d1->next_timeout));
 289
 290     /* Add duration to current time */
 291
 292     sec  = s->d1->timeout_duration_us / 1000000;
 293     usec = s->d1->timeout_duration_us - (sec * 1000000);
 294
 295     s->d1->next_timeout.tv_sec  += sec;
 296     s->d1->next_timeout.tv_usec += usec;
 297
 298     if (s->d1->next_timeout.tv_usec >= 1000000) {
 299         s->d1->next_timeout.tv_sec++;
 300         s->d1->next_timeout.tv_usec -= 1000000;
 301     }
 302
 303     BIO_ctrl(SSL_get_rbio(ssl), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
 304              &(s->d1->next_timeout));
 305 }
 306
 307 struct timeval *dtls1_get_timeout(SSL_CONNECTION *s, struct timeval *timeleft)
 308 {
 309     struct timeval timenow;
 310
 311     /* If no timeout is set, just return NULL */
 312     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
 313         return NULL;
 314     }
 315
 316     /* Get current time */
 317     get_current_time(&timenow);
 318
 319     /* If timer already expired, set remaining time to 0 */
 320     if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
 321         (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
 322          s->d1->next_timeout.tv_usec <= timenow.tv_usec)) {
 323         memset(timeleft, 0, sizeof(*timeleft));
 324         return timeleft;
 325     }
 326
 327     /* Calculate time left until timer expires */
 328     memcpy(timeleft, &(s->d1->next_timeout), sizeof(struct timeval));
 329     timeleft->tv_sec -= timenow.tv_sec;
 330     timeleft->tv_usec -= timenow.tv_usec;
 331     if (timeleft->tv_usec < 0) {
 332         timeleft->tv_sec--;
 333         timeleft->tv_usec += 1000000;
 334     }
 335
 336     /*
 337      * If remaining time is less than 15 ms, set it to 0 to prevent issues
 338      * because of small divergences with socket timeouts.
 339      */
 340     if (timeleft->tv_sec == 0 && timeleft->tv_usec < 15000) {
 341         memset(timeleft, 0, sizeof(*timeleft));
 342     }
 343
 344     return timeleft;
 345 }
 346
 347 int dtls1_is_timer_expired(SSL_CONNECTION *s)
 348 {
 349     struct timeval timeleft;
 350
 351     /* Get time left until timeout, return false if no timer running */
 352     if (dtls1_get_timeout(s, &timeleft) == NULL) {
 353         return 0;
 354     }
 355
 356     /* Return false if timer is not expired yet */
 357     if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0) {
 358         return 0;
 359     }
 360
 361     /* Timer expired, so return true */
 362     return 1;
 363 }
 364
 365 static void dtls1_double_timeout(SSL_CONNECTION *s)
 366 {
 367     s->d1->timeout_duration_us *= 2;
 368     if (s->d1->timeout_duration_us > 60000000)
 369         s->d1->timeout_duration_us = 60000000;
 370 }
 371
 372 void dtls1_stop_timer(SSL_CONNECTION *s)
 373 {
 374     /* Reset everything */
 375     s->d1->timeout_num_alerts = 0;
 376     memset(&s->d1->next_timeout, 0, sizeof(s->d1->next_timeout));
 377     s->d1->timeout_duration_us = 1000000;
 378     BIO_ctrl(s->rbio, BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
 379              &(s->d1->next_timeout));
 380     /* Clear retransmission buffer */
 381     dtls1_clear_sent_buffer(s);
 382 }
 383
 384 int dtls1_check_timeout_num(SSL_CONNECTION *s)
 385 {
 386     size_t mtu;
 387     SSL *ssl = SSL_CONNECTION_GET_SSL(s);
 388
 389     s->d1->timeout_num_alerts++;
 390
 391     /* Reduce MTU after 2 unsuccessful retransmissions */
 392     if (s->d1->timeout_num_alerts > 2
 393         && !(SSL_get_options(ssl) & SSL_OP_NO_QUERY_MTU)) {
 394         mtu =
 395             BIO_ctrl(SSL_get_wbio(ssl), BIO_CTRL_DGRAM_GET_FALLBACK_MTU, 0, NULL);
 396         if (mtu < s->d1->mtu)
 397             s->d1->mtu = mtu;
 398     }
 399
 400     if (s->d1->timeout_num_alerts > DTLS1_TMO_ALERT_COUNT) {
 401         /* fail the connection, enough alerts have been sent */
 402         SSLfatal(s, SSL_AD_NO_ALERT, SSL_R_READ_TIMEOUT_EXPIRED);
 403         return -1;
 404     }
 405
 406     return 0;
 407 }
 408
 409 int dtls1_handle_timeout(SSL_CONNECTION *s)
 410 {
 411     /* if no timer is expired, don't do anything */
 412     if (!dtls1_is_timer_expired(s)) {
 413         return 0;
 414     }
 415
 416     if (s->d1->timer_cb != NULL)
 417         s->d1->timeout_duration_us = s->d1->timer_cb(SSL_CONNECTION_GET_SSL(s),
 418                                                      s->d1->timeout_duration_us);
 419     else
 420         dtls1_double_timeout(s);
 421
 422     if (dtls1_check_timeout_num(s) < 0) {
 423         /* SSLfatal() already called */
 424         return -1;
 425     }
 426
 427     dtls1_start_timer(s);
 428     /* Calls SSLfatal() if required */
 429     return dtls1_retransmit_buffered_messages(s);
 430 }
 431
 432 static void get_current_time(struct timeval *t)
 433 {
 434     ossl_time_time_to_timeval(ossl_time_now(), t);
 435 }
 436
 437 #define LISTEN_SUCCESS              2
 438 #define LISTEN_SEND_VERIFY_REQUEST  1
 439
 440 #ifndef OPENSSL_NO_SOCK
 441 int DTLSv1_listen(SSL *ssl, BIO_ADDR *client)
 442 {
 443     int next, n, ret = 0;
 444     unsigned char cookie[DTLS1_COOKIE_LENGTH];
 445     unsigned char seq[SEQ_NUM_SIZE];
 446     const unsigned char *data;
 447     unsigned char *buf, *wbuf;
 448     size_t fragoff, fraglen, msglen, reclen, align = 0;
 449     unsigned int rectype, versmajor, msgseq, msgtype, clientvers, cookielen;
 450     BIO *rbio, *wbio;
 451     BIO_ADDR *tmpclient = NULL;
 452     PACKET pkt, msgpkt, msgpayload, session, cookiepkt;
 453     SSL_CONNECTION *s = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
 454
 455     if (s == NULL)
 456         return -1;
 457
 458     if (s->handshake_func == NULL) {
 459         /* Not properly initialized yet */
 460         SSL_set_accept_state(ssl);
 461     }
 462
 463     /* Ensure there is no state left over from a previous invocation */
 464     if (!SSL_clear(ssl))
 465         return -1;
 466
 467     ERR_clear_error();
 468
 469     rbio = SSL_get_rbio(ssl);
 470     wbio = SSL_get_wbio(ssl);
 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 = s->rrlmethod->get0_rbuf(s->rrl)->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 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, ssl, 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, ssl,
 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)ssl->method->version) &&
 640             ssl->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 (ssl->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 (ssl->ctx->app_verify_cookie_cb(ssl, 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 (ssl->ctx->app_gen_cookie_cb == NULL ||
 697                 ssl->ctx->app_gen_cookie_cb(ssl, 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 = (ssl->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, ssl,
 782                                 s->msg_callback_arg);
 783
 784             if ((tmpclient = BIO_ADDR_new()) == NULL) {
 785                 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
 786                 goto end;
 787             }
 788
 789             /*
 790              * This is unnecessary if rbio and wbio are one and the same - but
 791              * maybe they're not. We ignore errors here - some BIOs do not
 792              * support this.
 793              */
 794             if (BIO_dgram_get_peer(rbio, tmpclient) > 0) {
 795                 (void)BIO_dgram_set_peer(wbio, tmpclient);
 796             }
 797             BIO_ADDR_free(tmpclient);
 798             tmpclient = NULL;
 799
 800             if (BIO_write(wbio, wbuf, wreclen) < (int)wreclen) {
 801                 if (BIO_should_retry(wbio)) {
 802                     /*
 803                      * Non-blocking IO...but we're stateless, so we're just
 804                      * going to drop this packet.
 805                      */
 806                     goto end;
 807                 }
 808                 return -1;
 809             }
 810
 811             if (BIO_flush(wbio) <= 0) {
 812                 if (BIO_should_retry(wbio)) {
 813                     /*
 814                      * Non-blocking IO...but we're stateless, so we're just
 815                      * going to drop this packet.
 816                      */
 817                     goto end;
 818                 }
 819                 return -1;
 820             }
 821         }
 822     } while (next != LISTEN_SUCCESS);
 823
 824     /*
 825      * Set expected sequence numbers to continue the handshake.
 826      */
 827     s->d1->handshake_read_seq = 1;
 828     s->d1->handshake_write_seq = 1;
 829     s->d1->next_handshake_write_seq = 1;
 830     DTLS_RECORD_LAYER_set_write_sequence(&s->rlayer, seq);
 831
 832     /*
 833      * We are doing cookie exchange, so make sure we set that option in the
 834      * SSL object
 835      */
 836     SSL_set_options(ssl, SSL_OP_COOKIE_EXCHANGE);
 837
 838     /*
 839      * Tell the state machine that we've done the initial hello verify
 840      * exchange
 841      */
 842     ossl_statem_set_hello_verify_done(s);
 843
 844     /*
 845      * Some BIOs may not support this. If we fail we clear the client address
 846      */
 847     if (BIO_dgram_get_peer(rbio, client) <= 0)
 848         BIO_ADDR_clear(client);
 849
 850     /* Buffer the record in the processed_rcds queue */
 851     if (!dtls_buffer_listen_record(s, reclen, seq, align))
 852         return -1;
 853
 854     ret = 1;
 855  end:
 856     BIO_ADDR_free(tmpclient);
 857     return ret;
 858 }
 859 #endif
 860
 861 static int dtls1_handshake_write(SSL_CONNECTION *s)
 862 {
 863     return dtls1_do_write(s, SSL3_RT_HANDSHAKE);
 864 }
 865
 866 int dtls1_shutdown(SSL *s)
 867 {
 868     int ret;
 869 #ifndef OPENSSL_NO_SCTP
 870     BIO *wbio;
 871     SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL_ONLY(s);
 872
 873     if (s == NULL)
 874         return -1;
 875
 876     wbio = SSL_get_wbio(s);
 877     if (wbio != NULL && BIO_dgram_is_sctp(wbio) &&
 878         !(sc->shutdown & SSL_SENT_SHUTDOWN)) {
 879         ret = BIO_dgram_sctp_wait_for_dry(wbio);
 880         if (ret < 0)
 881             return -1;
 882
 883         if (ret == 0)
 884             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 1,
 885                      NULL);
 886     }
 887 #endif
 888     ret = ssl3_shutdown(s);
 889 #ifndef OPENSSL_NO_SCTP
 890     BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 0, NULL);
 891 #endif
 892     return ret;
 893 }
 894
 895 int dtls1_query_mtu(SSL_CONNECTION *s)
 896 {
 897     SSL *ssl = SSL_CONNECTION_GET_SSL(s);
 898
 899     if (s->d1->link_mtu) {
 900         s->d1->mtu =
 901             s->d1->link_mtu - BIO_dgram_get_mtu_overhead(SSL_get_wbio(ssl));
 902         s->d1->link_mtu = 0;
 903     }
 904
 905     /* AHA!  Figure out the MTU, and stick to the right size */
 906     if (s->d1->mtu < dtls1_min_mtu(s)) {
 907         if (!(SSL_get_options(ssl) & SSL_OP_NO_QUERY_MTU)) {
 908             s->d1->mtu =
 909                 BIO_ctrl(SSL_get_wbio(ssl), BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
 910
 911             /*
 912              * I've seen the kernel return bogus numbers when it doesn't know
 913              * (initial write), so just make sure we have a reasonable number
 914              */
 915             if (s->d1->mtu < dtls1_min_mtu(s)) {
 916                 /* Set to min mtu */
 917                 s->d1->mtu = dtls1_min_mtu(s);
 918                 BIO_ctrl(SSL_get_wbio(ssl), BIO_CTRL_DGRAM_SET_MTU,
 919                          (long)s->d1->mtu, NULL);
 920             }
 921         } else
 922             return 0;
 923     }
 924     return 1;
 925 }
 926
 927 static size_t dtls1_link_min_mtu(void)
 928 {
 929     return (g_probable_mtu[(sizeof(g_probable_mtu) /
 930                             sizeof(g_probable_mtu[0])) - 1]);
 931 }
 932
 933 size_t dtls1_min_mtu(SSL_CONNECTION *s)
 934 {
 935     SSL *ssl = SSL_CONNECTION_GET_SSL(s);
 936
 937     return dtls1_link_min_mtu() - BIO_dgram_get_mtu_overhead(SSL_get_wbio(ssl));
 938 }
 939
 940 size_t DTLS_get_data_mtu(const SSL *ssl)
 941 {
 942     size_t mac_overhead, int_overhead, blocksize, ext_overhead;
 943     const SSL_CIPHER *ciph = SSL_get_current_cipher(ssl);
 944     size_t mtu;
 945     const SSL_CONNECTION *s = SSL_CONNECTION_FROM_CONST_SSL_ONLY(ssl);
 946
 947     if (s == NULL)
 948         return 0;
 949
 950     mtu = s->d1->mtu;
 951
 952     if (ciph == NULL)
 953         return 0;
 954
 955     if (!ssl_cipher_get_overhead(ciph, &mac_overhead, &int_overhead,
 956                                  &blocksize, &ext_overhead))
 957         return 0;
 958
 959     if (SSL_READ_ETM(s))
 960         ext_overhead += mac_overhead;
 961     else
 962         int_overhead += mac_overhead;
 963
 964     /* Subtract external overhead (e.g. IV/nonce, separate MAC) */
 965     if (ext_overhead + DTLS1_RT_HEADER_LENGTH >= mtu)
 966         return 0;
 967     mtu -= ext_overhead + DTLS1_RT_HEADER_LENGTH;
 968
 969     /* Round encrypted payload down to cipher block size (for CBC etc.)
 970      * No check for overflow since 'mtu % blocksize' cannot exceed mtu. */
 971     if (blocksize)
 972         mtu -= (mtu % blocksize);
 973
 974     /* Subtract internal overhead (e.g. CBC padding len byte) */
 975     if (int_overhead >= mtu)
 976         return 0;
 977     mtu -= int_overhead;
 978
 979     return mtu;
 980 }
 981
 982 void DTLS_set_timer_cb(SSL *ssl, DTLS_timer_cb cb)
 983 {
 984     SSL_CONNECTION *s = SSL_CONNECTION_FROM_SSL_ONLY(ssl);
 985
 986     if (s == NULL)
 987         return;
 988
 989     s->d1->timer_cb = cb;
 990 }