ssl/statem/statem_dtls.c

   1 /*
   2  * Copyright 2005-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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 <limits.h>
  11 #include <string.h>
  12 #include <stdio.h>
  13 #include "../ssl_locl.h"
  14 #include "statem_locl.h"
  15 #include <openssl/buffer.h>
  16 #include <openssl/objects.h>
  17 #include <openssl/evp.h>
  18 #include <openssl/x509.h>
  19
  20 #define RSMBLY_BITMASK_SIZE(msg_len) (((msg_len) + 7) / 8)
  21
  22 #define RSMBLY_BITMASK_MARK(bitmask, start, end) { \
  23                         if ((end) - (start) <= 8) { \
  24                                 long ii; \
  25                                 for (ii = (start); ii < (end); ii++) bitmask[((ii) >> 3)] |= (1 << ((ii) & 7)); \
  26                         } else { \
  27                                 long ii; \
  28                                 bitmask[((start) >> 3)] |= bitmask_start_values[((start) & 7)]; \
  29                                 for (ii = (((start) >> 3) + 1); ii < ((((end) - 1)) >> 3); ii++) bitmask[ii] = 0xff; \
  30                                 bitmask[(((end) - 1) >> 3)] |= bitmask_end_values[((end) & 7)]; \
  31                         } }
  32
  33 #define RSMBLY_BITMASK_IS_COMPLETE(bitmask, msg_len, is_complete) { \
  34                         long ii; \
  35                         OPENSSL_assert((msg_len) > 0); \
  36                         is_complete = 1; \
  37                         if (bitmask[(((msg_len) - 1) >> 3)] != bitmask_end_values[((msg_len) & 7)]) is_complete = 0; \
  38                         if (is_complete) for (ii = (((msg_len) - 1) >> 3) - 1; ii >= 0 ; ii--) \
  39                                 if (bitmask[ii] != 0xff) { is_complete = 0; break; } }
  40
  41 static unsigned char bitmask_start_values[] =
  42     { 0xff, 0xfe, 0xfc, 0xf8, 0xf0, 0xe0, 0xc0, 0x80 };
  43 static unsigned char bitmask_end_values[] =
  44     { 0xff, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f };
  45
  46 static void dtls1_fix_message_header(SSL *s, size_t frag_off,
  47                                      size_t frag_len);
  48 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p);
  49 static void dtls1_set_message_header_int(SSL *s, unsigned char mt,
  50                                          size_t len,
  51                                          unsigned short seq_num,
  52                                          size_t frag_off,
  53                                          size_t frag_len);
  54 static int dtls_get_reassembled_message(SSL *s, int *errtype, size_t *len);
  55
  56 static hm_fragment *dtls1_hm_fragment_new(size_t frag_len, int reassembly)
  57 {
  58     hm_fragment *frag = NULL;
  59     unsigned char *buf = NULL;
  60     unsigned char *bitmask = NULL;
  61
  62     frag = OPENSSL_malloc(sizeof(*frag));
  63     if (frag == NULL)
  64         return NULL;
  65
  66     if (frag_len) {
  67         buf = OPENSSL_malloc(frag_len);
  68         if (buf == NULL) {
  69             OPENSSL_free(frag);
  70             return NULL;
  71         }
  72     }
  73
  74     /* zero length fragment gets zero frag->fragment */
  75     frag->fragment = buf;
  76
  77     /* Initialize reassembly bitmask if necessary */
  78     if (reassembly) {
  79         bitmask = OPENSSL_zalloc(RSMBLY_BITMASK_SIZE(frag_len));
  80         if (bitmask == NULL) {
  81             OPENSSL_free(buf);
  82             OPENSSL_free(frag);
  83             return NULL;
  84         }
  85     }
  86
  87     frag->reassembly = bitmask;
  88
  89     return frag;
  90 }
  91
  92 void dtls1_hm_fragment_free(hm_fragment *frag)
  93 {
  94     if (!frag)
  95         return;
  96     if (frag->msg_header.is_ccs) {
  97         EVP_CIPHER_CTX_free(frag->msg_header.
  98                             saved_retransmit_state.enc_write_ctx);
  99         EVP_MD_CTX_free(frag->msg_header.saved_retransmit_state.write_hash);
 100     }
 101     OPENSSL_free(frag->fragment);
 102     OPENSSL_free(frag->reassembly);
 103     OPENSSL_free(frag);
 104 }
 105
 106 /*
 107  * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
 108  * SSL3_RT_CHANGE_CIPHER_SPEC)
 109  */
 110 int dtls1_do_write(SSL *s, int type)
 111 {
 112     int ret;
 113     size_t written;
 114     size_t curr_mtu;
 115     int retry = 1;
 116     size_t len, frag_off, mac_size, blocksize, used_len;
 117
 118     if (!dtls1_query_mtu(s))
 119         return -1;
 120
 121     if (s->d1->mtu < dtls1_min_mtu(s))
 122         /* should have something reasonable now */
 123         return -1;
 124
 125     if (s->init_off == 0 && type == SSL3_RT_HANDSHAKE)
 126         OPENSSL_assert(s->init_num ==
 127                        s->d1->w_msg_hdr.msg_len + DTLS1_HM_HEADER_LENGTH);
 128
 129     if (s->write_hash) {
 130         if (s->enc_write_ctx
 131             && (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_write_ctx)) &
 132                 EVP_CIPH_FLAG_AEAD_CIPHER) != 0)
 133             mac_size = 0;
 134         else
 135             mac_size = EVP_MD_CTX_size(s->write_hash);
 136     } else
 137         mac_size = 0;
 138
 139     if (s->enc_write_ctx &&
 140         (EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_CBC_MODE))
 141         blocksize = 2 * EVP_CIPHER_CTX_block_size(s->enc_write_ctx);
 142     else
 143         blocksize = 0;
 144
 145     frag_off = 0;
 146     s->rwstate = SSL_NOTHING;
 147
 148     /* s->init_num shouldn't ever be < 0...but just in case */
 149     while (s->init_num > 0) {
 150         if (type == SSL3_RT_HANDSHAKE && s->init_off != 0) {
 151             /* We must be writing a fragment other than the first one */
 152
 153             if (frag_off > 0) {
 154                 /* This is the first attempt at writing out this fragment */
 155
 156                 if (s->init_off <= DTLS1_HM_HEADER_LENGTH) {
 157                     /*
 158                      * Each fragment that was already sent must at least have
 159                      * contained the message header plus one other byte.
 160                      * Therefore |init_off| must have progressed by at least
 161                      * |DTLS1_HM_HEADER_LENGTH + 1| bytes. If not something went
 162                      * wrong.
 163                      */
 164                     return -1;
 165                 }
 166
 167                 /*
 168                  * Adjust |init_off| and |init_num| to allow room for a new
 169                  * message header for this fragment.
 170                  */
 171                 s->init_off -= DTLS1_HM_HEADER_LENGTH;
 172                 s->init_num += DTLS1_HM_HEADER_LENGTH;
 173             } else {
 174                 /*
 175                  * We must have been called again after a retry so use the
 176                  * fragment offset from our last attempt. We do not need
 177                  * to adjust |init_off| and |init_num| as above, because
 178                  * that should already have been done before the retry.
 179                  */
 180                 frag_off = s->d1->w_msg_hdr.frag_off;
 181             }
 182         }
 183
 184         used_len = BIO_wpending(s->wbio) + DTLS1_RT_HEADER_LENGTH
 185             + mac_size + blocksize;
 186         if (s->d1->mtu > used_len)
 187             curr_mtu = s->d1->mtu - used_len;
 188         else
 189             curr_mtu = 0;
 190
 191         if (curr_mtu <= DTLS1_HM_HEADER_LENGTH) {
 192             /*
 193              * grr.. we could get an error if MTU picked was wrong
 194              */
 195             ret = BIO_flush(s->wbio);
 196             if (ret <= 0) {
 197                 s->rwstate = SSL_WRITING;
 198                 return ret;
 199             }
 200             used_len = DTLS1_RT_HEADER_LENGTH + mac_size + blocksize;
 201             if (s->d1->mtu > used_len + DTLS1_HM_HEADER_LENGTH) {
 202                 curr_mtu = s->d1->mtu - used_len;
 203             } else {
 204                 /* Shouldn't happen */
 205                 return -1;
 206             }
 207         }
 208
 209         /*
 210          * We just checked that s->init_num > 0 so this cast should be safe
 211          */
 212         if (((unsigned int)s->init_num) > curr_mtu)
 213             len = curr_mtu;
 214         else
 215             len = s->init_num;
 216
 217         /* Shouldn't ever happen */
 218         /* TODO(size_t): can this go now? */
 219         if (len > INT_MAX)
 220             len = INT_MAX;
 221
 222         /*
 223          * XDTLS: this function is too long.  split out the CCS part
 224          */
 225         if (type == SSL3_RT_HANDSHAKE) {
 226             if (len < DTLS1_HM_HEADER_LENGTH) {
 227                 /*
 228                  * len is so small that we really can't do anything sensible
 229                  * so fail
 230                  */
 231                 return -1;
 232             }
 233             dtls1_fix_message_header(s, frag_off, len - DTLS1_HM_HEADER_LENGTH);
 234
 235             dtls1_write_message_header(s,
 236                                        (unsigned char *)&s->init_buf->
 237                                        data[s->init_off]);
 238         }
 239
 240         ret = dtls1_write_bytes(s, type, &s->init_buf->data[s->init_off], len,
 241                                 &written);
 242         if (ret < 0) {
 243             /*
 244              * might need to update MTU here, but we don't know which
 245              * previous packet caused the failure -- so can't really
 246              * retransmit anything.  continue as if everything is fine and
 247              * wait for an alert to handle the retransmit
 248              */
 249             if (retry && BIO_ctrl(SSL_get_wbio(s),
 250                                   BIO_CTRL_DGRAM_MTU_EXCEEDED, 0, NULL) > 0) {
 251                 if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
 252                     if (!dtls1_query_mtu(s))
 253                         return -1;
 254                     /* Have one more go */
 255                     retry = 0;
 256                 } else
 257                     return -1;
 258             } else {
 259                 return (-1);
 260             }
 261         } else {
 262
 263             /*
 264              * bad if this assert fails, only part of the handshake message
 265              * got sent.  but why would this happen?
 266              */
 267             OPENSSL_assert(len == written);
 268
 269             if (type == SSL3_RT_HANDSHAKE && !s->d1->retransmitting) {
 270                 /*
 271                  * should not be done for 'Hello Request's, but in that case
 272                  * we'll ignore the result anyway
 273                  */
 274                 unsigned char *p =
 275                     (unsigned char *)&s->init_buf->data[s->init_off];
 276                 const struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
 277                 size_t xlen;
 278
 279                 if (frag_off == 0 && s->version != DTLS1_BAD_VER) {
 280                     /*
 281                      * reconstruct message header is if it is being sent in
 282                      * single fragment
 283                      */
 284                     *p++ = msg_hdr->type;
 285                     l2n3(msg_hdr->msg_len, p);
 286                     s2n(msg_hdr->seq, p);
 287                     l2n3(0, p);
 288                     l2n3(msg_hdr->msg_len, p);
 289                     p -= DTLS1_HM_HEADER_LENGTH;
 290                     xlen = written;
 291                 } else {
 292                     p += DTLS1_HM_HEADER_LENGTH;
 293                     xlen = written - DTLS1_HM_HEADER_LENGTH;
 294                 }
 295
 296                 if (!ssl3_finish_mac(s, p, xlen))
 297                     return -1;
 298             }
 299
 300             if (written == s->init_num) {
 301                 if (s->msg_callback)
 302                     s->msg_callback(1, s->version, type, s->init_buf->data,
 303                                     (size_t)(s->init_off + s->init_num), s,
 304                                     s->msg_callback_arg);
 305
 306                 s->init_off = 0; /* done writing this message */
 307                 s->init_num = 0;
 308
 309                 return 1;
 310             }
 311             s->init_off += written;
 312             s->init_num -= written;
 313             written -= DTLS1_HM_HEADER_LENGTH;
 314             frag_off += written;
 315
 316             /*
 317              * We save the fragment offset for the next fragment so we have it
 318              * available in case of an IO retry. We don't know the length of the
 319              * next fragment yet so just set that to 0 for now. It will be
 320              * updated again later.
 321              */
 322             dtls1_fix_message_header(s, frag_off, 0);
 323         }
 324     }
 325     return 0;
 326 }
 327
 328 int dtls_get_message(SSL *s, int *mt, size_t *len)
 329 {
 330     struct hm_header_st *msg_hdr;
 331     unsigned char *p;
 332     size_t msg_len;
 333     size_t tmplen;
 334     int errtype;
 335
 336     msg_hdr = &s->d1->r_msg_hdr;
 337     memset(msg_hdr, 0, sizeof(*msg_hdr));
 338
 339  again:
 340     if (!dtls_get_reassembled_message(s, &errtype, &tmplen)) {
 341         if (errtype == DTLS1_HM_BAD_FRAGMENT
 342                 || errtype == DTLS1_HM_FRAGMENT_RETRY) {
 343             /* bad fragment received */
 344             goto again;
 345         }
 346         return 0;
 347     }
 348
 349     *mt = s->s3->tmp.message_type;
 350
 351     p = (unsigned char *)s->init_buf->data;
 352     *len = s->init_num;
 353
 354     if (*mt == SSL3_MT_CHANGE_CIPHER_SPEC) {
 355         if (s->msg_callback) {
 356             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
 357                             p, 1, s, s->msg_callback_arg);
 358         }
 359         /*
 360          * This isn't a real handshake message so skip the processing below.
 361          */
 362         return 1;
 363     }
 364
 365     msg_len = msg_hdr->msg_len;
 366
 367     /* reconstruct message header */
 368     *(p++) = msg_hdr->type;
 369     l2n3(msg_len, p);
 370     s2n(msg_hdr->seq, p);
 371     l2n3(0, p);
 372     l2n3(msg_len, p);
 373     if (s->version != DTLS1_BAD_VER) {
 374         p -= DTLS1_HM_HEADER_LENGTH;
 375         msg_len += DTLS1_HM_HEADER_LENGTH;
 376     }
 377
 378     if (!ssl3_finish_mac(s, p, msg_len))
 379         return 0;
 380     if (s->msg_callback)
 381         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 382                         p, msg_len, s, s->msg_callback_arg);
 383
 384     memset(msg_hdr, 0, sizeof(*msg_hdr));
 385
 386     s->d1->handshake_read_seq++;
 387
 388     s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 389
 390     return 1;
 391 }
 392
 393 /*
 394  * dtls1_max_handshake_message_len returns the maximum number of bytes
 395  * permitted in a DTLS handshake message for |s|. The minimum is 16KB, but
 396  * may be greater if the maximum certificate list size requires it.
 397  */
 398 static unsigned long dtls1_max_handshake_message_len(const SSL *s)
 399 {
 400     unsigned long max_len =
 401         DTLS1_HM_HEADER_LENGTH + SSL3_RT_MAX_ENCRYPTED_LENGTH;
 402     if (max_len < (unsigned long)s->max_cert_list)
 403         return s->max_cert_list;
 404     return max_len;
 405 }
 406
 407 static int dtls1_preprocess_fragment(SSL *s, struct hm_header_st *msg_hdr)
 408 {
 409     size_t frag_off, frag_len, msg_len;
 410
 411     msg_len = msg_hdr->msg_len;
 412     frag_off = msg_hdr->frag_off;
 413     frag_len = msg_hdr->frag_len;
 414
 415     /* sanity checking */
 416     if ((frag_off + frag_len) > msg_len
 417             || msg_len > dtls1_max_handshake_message_len(s)) {
 418         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 419         return SSL_AD_ILLEGAL_PARAMETER;
 420     }
 421
 422     if (s->d1->r_msg_hdr.frag_off == 0) { /* first fragment */
 423         /*
 424          * msg_len is limited to 2^24, but is effectively checked against
 425          * dtls_max_handshake_message_len(s) above
 426          */
 427         if (!BUF_MEM_grow_clean(s->init_buf, msg_len + DTLS1_HM_HEADER_LENGTH)) {
 428             SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, ERR_R_BUF_LIB);
 429             return SSL_AD_INTERNAL_ERROR;
 430         }
 431
 432         s->s3->tmp.message_size = msg_len;
 433         s->d1->r_msg_hdr.msg_len = msg_len;
 434         s->s3->tmp.message_type = msg_hdr->type;
 435         s->d1->r_msg_hdr.type = msg_hdr->type;
 436         s->d1->r_msg_hdr.seq = msg_hdr->seq;
 437     } else if (msg_len != s->d1->r_msg_hdr.msg_len) {
 438         /*
 439          * They must be playing with us! BTW, failure to enforce upper limit
 440          * would open possibility for buffer overrun.
 441          */
 442         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 443         return SSL_AD_ILLEGAL_PARAMETER;
 444     }
 445
 446     return 0;                   /* no error */
 447 }
 448
 449 static int dtls1_retrieve_buffered_fragment(SSL *s, size_t *len)
 450 {
 451     /*-
 452      * (0) check whether the desired fragment is available
 453      * if so:
 454      * (1) copy over the fragment to s->init_buf->data[]
 455      * (2) update s->init_num
 456      */
 457     pitem *item;
 458     hm_fragment *frag;
 459     int al;
 460
 461     do {
 462         item = pqueue_peek(s->d1->buffered_messages);
 463         if (item == NULL)
 464             return 0;
 465
 466         frag = (hm_fragment *)item->data;
 467
 468         if (frag->msg_header.seq < s->d1->handshake_read_seq) {
 469             /* This is a stale message that has been buffered so clear it */
 470             pqueue_pop(s->d1->buffered_messages);
 471             dtls1_hm_fragment_free(frag);
 472             pitem_free(item);
 473             item = NULL;
 474             frag = NULL;
 475         }
 476     } while (item == NULL);
 477
 478     /* Don't return if reassembly still in progress */
 479     if (frag->reassembly != NULL)
 480         return 0;
 481
 482     if (s->d1->handshake_read_seq == frag->msg_header.seq) {
 483         size_t frag_len = frag->msg_header.frag_len;
 484         pqueue_pop(s->d1->buffered_messages);
 485
 486         al = dtls1_preprocess_fragment(s, &frag->msg_header);
 487
 488         if (al == 0) {          /* no alert */
 489             unsigned char *p =
 490                 (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 491             memcpy(&p[frag->msg_header.frag_off], frag->fragment,
 492                    frag->msg_header.frag_len);
 493         }
 494
 495         dtls1_hm_fragment_free(frag);
 496         pitem_free(item);
 497
 498         if (al == 0) {
 499             *len = frag_len;
 500             return 1;
 501         }
 502
 503         ssl3_send_alert(s, SSL3_AL_FATAL, al);
 504         s->init_num = 0;
 505         return 0;
 506     } else {
 507         return 0;
 508     }
 509 }
 510
 511 static int
 512 dtls1_reassemble_fragment(SSL *s, const struct hm_header_st *msg_hdr)
 513 {
 514     hm_fragment *frag = NULL;
 515     pitem *item = NULL;
 516     int i = -1, is_complete;
 517     unsigned char seq64be[8];
 518     size_t frag_len = msg_hdr->frag_len;
 519     size_t read;
 520
 521     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len ||
 522         msg_hdr->msg_len > dtls1_max_handshake_message_len(s))
 523         goto err;
 524
 525     if (frag_len == 0) {
 526         return DTLS1_HM_FRAGMENT_RETRY;
 527     }
 528
 529     /* Try to find item in queue */
 530     memset(seq64be, 0, sizeof(seq64be));
 531     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 532     seq64be[7] = (unsigned char)msg_hdr->seq;
 533     item = pqueue_find(s->d1->buffered_messages, seq64be);
 534
 535     if (item == NULL) {
 536         frag = dtls1_hm_fragment_new(msg_hdr->msg_len, 1);
 537         if (frag == NULL)
 538             goto err;
 539         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 540         frag->msg_header.frag_len = frag->msg_header.msg_len;
 541         frag->msg_header.frag_off = 0;
 542     } else {
 543         frag = (hm_fragment *)item->data;
 544         if (frag->msg_header.msg_len != msg_hdr->msg_len) {
 545             item = NULL;
 546             frag = NULL;
 547             goto err;
 548         }
 549     }
 550
 551     /*
 552      * If message is already reassembled, this must be a retransmit and can
 553      * be dropped. In this case item != NULL and so frag does not need to be
 554      * freed.
 555      */
 556     if (frag->reassembly == NULL) {
 557         unsigned char devnull[256];
 558
 559         while (frag_len) {
 560             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 561                                           devnull,
 562                                           frag_len >
 563                                           sizeof(devnull) ? sizeof(devnull) :
 564                                           frag_len, 0, &read);
 565             if (i <= 0)
 566                 goto err;
 567             frag_len -= read;
 568         }
 569         return DTLS1_HM_FRAGMENT_RETRY;
 570     }
 571
 572     /* read the body of the fragment (header has already been read */
 573     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 574                                   frag->fragment + msg_hdr->frag_off,
 575                                   frag_len, 0, &read);
 576     if (i <= 0 || read != frag_len)
 577         i = -1;
 578     if (i <= 0)
 579         goto err;
 580
 581     RSMBLY_BITMASK_MARK(frag->reassembly, (long)msg_hdr->frag_off,
 582                         (long)(msg_hdr->frag_off + frag_len));
 583
 584     RSMBLY_BITMASK_IS_COMPLETE(frag->reassembly, (long)msg_hdr->msg_len,
 585                                is_complete);
 586
 587     if (is_complete) {
 588         OPENSSL_free(frag->reassembly);
 589         frag->reassembly = NULL;
 590     }
 591
 592     if (item == NULL) {
 593         item = pitem_new(seq64be, frag);
 594         if (item == NULL) {
 595             i = -1;
 596             goto err;
 597         }
 598
 599         item = pqueue_insert(s->d1->buffered_messages, item);
 600         /*
 601          * pqueue_insert fails iff a duplicate item is inserted. However,
 602          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 603          * would have returned it and control would never have reached this
 604          * branch.
 605          */
 606         OPENSSL_assert(item != NULL);
 607     }
 608
 609     return DTLS1_HM_FRAGMENT_RETRY;
 610
 611  err:
 612     if (item == NULL)
 613         dtls1_hm_fragment_free(frag);
 614     return -1;
 615 }
 616
 617 static int
 618 dtls1_process_out_of_seq_message(SSL *s, const struct hm_header_st *msg_hdr)
 619 {
 620     int i = -1;
 621     hm_fragment *frag = NULL;
 622     pitem *item = NULL;
 623     unsigned char seq64be[8];
 624     size_t frag_len = msg_hdr->frag_len;
 625     size_t read;
 626
 627     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len)
 628         goto err;
 629
 630     /* Try to find item in queue, to prevent duplicate entries */
 631     memset(seq64be, 0, sizeof(seq64be));
 632     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 633     seq64be[7] = (unsigned char)msg_hdr->seq;
 634     item = pqueue_find(s->d1->buffered_messages, seq64be);
 635
 636     /*
 637      * If we already have an entry and this one is a fragment, don't discard
 638      * it and rather try to reassemble it.
 639      */
 640     if (item != NULL && frag_len != msg_hdr->msg_len)
 641         item = NULL;
 642
 643     /*
 644      * Discard the message if sequence number was already there, is too far
 645      * in the future, already in the queue or if we received a FINISHED
 646      * before the SERVER_HELLO, which then must be a stale retransmit.
 647      */
 648     if (msg_hdr->seq <= s->d1->handshake_read_seq ||
 649         msg_hdr->seq > s->d1->handshake_read_seq + 10 || item != NULL ||
 650         (s->d1->handshake_read_seq == 0 && msg_hdr->type == SSL3_MT_FINISHED)) {
 651         unsigned char devnull[256];
 652
 653         while (frag_len) {
 654             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 655                                           devnull,
 656                                           frag_len >
 657                                           sizeof(devnull) ? sizeof(devnull) :
 658                                           frag_len, 0, &read);
 659             if (i <= 0)
 660                 goto err;
 661             frag_len -= read;
 662         }
 663     } else {
 664         if (frag_len != msg_hdr->msg_len) {
 665             return dtls1_reassemble_fragment(s, msg_hdr);;
 666         }
 667
 668         if (frag_len > dtls1_max_handshake_message_len(s))
 669             goto err;
 670
 671         frag = dtls1_hm_fragment_new(frag_len, 0);
 672         if (frag == NULL)
 673             goto err;
 674
 675         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 676
 677         if (frag_len) {
 678             /*
 679              * read the body of the fragment (header has already been read
 680              */
 681             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 682                                           frag->fragment, frag_len, 0, &read);
 683             if (i<=0 || read != frag_len)
 684                 i = -1;
 685             if (i <= 0)
 686                 goto err;
 687         }
 688
 689         item = pitem_new(seq64be, frag);
 690         if (item == NULL)
 691             goto err;
 692
 693         item = pqueue_insert(s->d1->buffered_messages, item);
 694         /*
 695          * pqueue_insert fails iff a duplicate item is inserted. However,
 696          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 697          * would have returned it. Then, either |frag_len| !=
 698          * |msg_hdr->msg_len| in which case |item| is set to NULL and it will
 699          * have been processed with |dtls1_reassemble_fragment|, above, or
 700          * the record will have been discarded.
 701          */
 702         OPENSSL_assert(item != NULL);
 703     }
 704
 705     return DTLS1_HM_FRAGMENT_RETRY;
 706
 707  err:
 708     if (item == NULL)
 709         dtls1_hm_fragment_free(frag);
 710     return 0;
 711 }
 712
 713 static int dtls_get_reassembled_message(SSL *s, int *errtype, size_t *len)
 714 {
 715     unsigned char wire[DTLS1_HM_HEADER_LENGTH];
 716     size_t mlen, frag_off, frag_len;
 717     int i, al, recvd_type;
 718     struct hm_header_st msg_hdr;
 719     size_t read;
 720
 721     *errtype = 0;
 722
 723  redo:
 724     /* see if we have the required fragment already */
 725     if (dtls1_retrieve_buffered_fragment(s, &frag_len)) {
 726         s->init_num = frag_len;
 727         *len = frag_len;
 728         return 1;
 729     }
 730
 731     /* read handshake message header */
 732     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type, wire,
 733                                   DTLS1_HM_HEADER_LENGTH, 0, &read);
 734     if (i <= 0) {               /* nbio, or an error */
 735         s->rwstate = SSL_READING;
 736         *len = 0;
 737         return 0;
 738     }
 739     if (recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
 740         if (wire[0] != SSL3_MT_CCS) {
 741             al = SSL_AD_UNEXPECTED_MESSAGE;
 742             SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE,
 743                    SSL_R_BAD_CHANGE_CIPHER_SPEC);
 744             goto f_err;
 745         }
 746
 747         memcpy(s->init_buf->data, wire, read);
 748         s->init_num = read - 1;
 749         s->init_msg = s->init_buf->data + 1;
 750         s->s3->tmp.message_type = SSL3_MT_CHANGE_CIPHER_SPEC;
 751         s->s3->tmp.message_size = read - 1;
 752         *len = read - 1;
 753         return 1;
 754     }
 755
 756     /* Handshake fails if message header is incomplete */
 757     if (read != DTLS1_HM_HEADER_LENGTH) {
 758         al = SSL_AD_UNEXPECTED_MESSAGE;
 759         SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
 760         goto f_err;
 761     }
 762
 763     /* parse the message fragment header */
 764     dtls1_get_message_header(wire, &msg_hdr);
 765
 766     mlen = msg_hdr.msg_len;
 767     frag_off = msg_hdr.frag_off;
 768     frag_len = msg_hdr.frag_len;
 769
 770     /*
 771      * We must have at least frag_len bytes left in the record to be read.
 772      * Fragments must not span records.
 773      */
 774     if (frag_len > RECORD_LAYER_get_rrec_length(&s->rlayer)) {
 775         al = SSL3_AD_ILLEGAL_PARAMETER;
 776         SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_BAD_LENGTH);
 777         goto f_err;
 778     }
 779
 780     /*
 781      * if this is a future (or stale) message it gets buffered
 782      * (or dropped)--no further processing at this time
 783      * While listening, we accept seq 1 (ClientHello with cookie)
 784      * although we're still expecting seq 0 (ClientHello)
 785      */
 786     if (msg_hdr.seq != s->d1->handshake_read_seq) {
 787         *errtype = dtls1_process_out_of_seq_message(s, &msg_hdr);
 788         return 0;
 789     }
 790
 791     if (frag_len && frag_len < mlen) {
 792         *errtype = dtls1_reassemble_fragment(s, &msg_hdr);
 793         return 0;
 794     }
 795
 796     if (!s->server && s->d1->r_msg_hdr.frag_off == 0 &&
 797         wire[0] == SSL3_MT_HELLO_REQUEST) {
 798         /*
 799          * The server may always send 'Hello Request' messages -- we are
 800          * doing a handshake anyway now, so ignore them if their format is
 801          * correct. Does not count for 'Finished' MAC.
 802          */
 803         if (wire[1] == 0 && wire[2] == 0 && wire[3] == 0) {
 804             if (s->msg_callback)
 805                 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 806                                 wire, DTLS1_HM_HEADER_LENGTH, s,
 807                                 s->msg_callback_arg);
 808
 809             s->init_num = 0;
 810             goto redo;
 811         } else {                /* Incorrectly formatted Hello request */
 812
 813             al = SSL_AD_UNEXPECTED_MESSAGE;
 814             SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE,
 815                    SSL_R_UNEXPECTED_MESSAGE);
 816             goto f_err;
 817         }
 818     }
 819
 820     if ((al = dtls1_preprocess_fragment(s, &msg_hdr)))
 821         goto f_err;
 822
 823     if (frag_len > 0) {
 824         unsigned char *p =
 825             (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 826
 827         i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 828                                       &p[frag_off], frag_len, 0, &read);
 829
 830         /*
 831          * This shouldn't ever fail due to NBIO because we already checked
 832          * that we have enough data in the record
 833          */
 834         if (i <= 0) {
 835             s->rwstate = SSL_READING;
 836             *len = 0;
 837             return 0;
 838         }
 839     } else {
 840         read = 0;
 841     }
 842
 843     /*
 844      * XDTLS: an incorrectly formatted fragment should cause the handshake
 845      * to fail
 846      */
 847     if (read != frag_len) {
 848         al = SSL3_AD_ILLEGAL_PARAMETER;
 849         SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL3_AD_ILLEGAL_PARAMETER);
 850         goto f_err;
 851     }
 852
 853     /*
 854      * Note that s->init_num is *not* used as current offset in
 855      * s->init_buf->data, but as a counter summing up fragments' lengths: as
 856      * soon as they sum up to handshake packet length, we assume we have got
 857      * all the fragments.
 858      */
 859     *len = s->init_num = frag_len;
 860     return 1;
 861
 862  f_err:
 863     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 864     s->init_num = 0;
 865     *len = 0;
 866     return 0;
 867 }
 868
 869 /*-
 870  * for these 2 messages, we need to
 871  * ssl->enc_read_ctx                    re-init
 872  * ssl->rlayer.read_sequence            zero
 873  * ssl->s3->read_mac_secret             re-init
 874  * ssl->session->read_sym_enc           assign
 875  * ssl->session->read_compression       assign
 876  * ssl->session->read_hash              assign
 877  */
 878 int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt)
 879 {
 880     if (s->version == DTLS1_BAD_VER) {
 881         s->d1->next_handshake_write_seq++;
 882
 883         if (!WPACKET_put_bytes_u16(pkt, s->d1->handshake_write_seq)) {
 884             SSLerr(SSL_F_DTLS_CONSTRUCT_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
 885             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 886         }
 887     }
 888
 889     return 1;
 890 }
 891
 892 #ifndef OPENSSL_NO_SCTP
 893 WORK_STATE dtls_wait_for_dry(SSL *s)
 894 {
 895     int ret;
 896
 897     /* read app data until dry event */
 898     ret = BIO_dgram_sctp_wait_for_dry(SSL_get_wbio(s));
 899     if (ret < 0)
 900         return WORK_ERROR;
 901
 902     if (ret == 0) {
 903         s->s3->in_read_app_data = 2;
 904         s->rwstate = SSL_READING;
 905         BIO_clear_retry_flags(SSL_get_rbio(s));
 906         BIO_set_retry_read(SSL_get_rbio(s));
 907         return WORK_MORE_A;
 908     }
 909     return WORK_FINISHED_CONTINUE;
 910 }
 911 #endif
 912
 913 int dtls1_read_failed(SSL *s, int code)
 914 {
 915     if (code > 0) {
 916         SSLerr(SSL_F_DTLS1_READ_FAILED, ERR_R_INTERNAL_ERROR);
 917         return 1;
 918     }
 919
 920     if (!dtls1_is_timer_expired(s)) {
 921         /*
 922          * not a timeout, none of our business, let higher layers handle
 923          * this.  in fact it's probably an error
 924          */
 925         return code;
 926     }
 927 #ifndef OPENSSL_NO_HEARTBEATS
 928     /* done, no need to send a retransmit */
 929     if (!SSL_in_init(s) && !s->tlsext_hb_pending)
 930 #else
 931     /* done, no need to send a retransmit */
 932     if (!SSL_in_init(s))
 933 #endif
 934     {
 935         BIO_set_flags(SSL_get_rbio(s), BIO_FLAGS_READ);
 936         return code;
 937     }
 938
 939     return dtls1_handle_timeout(s);
 940 }
 941
 942 int dtls1_get_queue_priority(unsigned short seq, int is_ccs)
 943 {
 944     /*
 945      * The index of the retransmission queue actually is the message sequence
 946      * number, since the queue only contains messages of a single handshake.
 947      * However, the ChangeCipherSpec has no message sequence number and so
 948      * using only the sequence will result in the CCS and Finished having the
 949      * same index. To prevent this, the sequence number is multiplied by 2.
 950      * In case of a CCS 1 is subtracted. This does not only differ CSS and
 951      * Finished, it also maintains the order of the index (important for
 952      * priority queues) and fits in the unsigned short variable.
 953      */
 954     return seq * 2 - is_ccs;
 955 }
 956
 957 int dtls1_retransmit_buffered_messages(SSL *s)
 958 {
 959     pqueue *sent = s->d1->sent_messages;
 960     piterator iter;
 961     pitem *item;
 962     hm_fragment *frag;
 963     int found = 0;
 964
 965     iter = pqueue_iterator(sent);
 966
 967     for (item = pqueue_next(&iter); item != NULL; item = pqueue_next(&iter)) {
 968         frag = (hm_fragment *)item->data;
 969         if (dtls1_retransmit_message(s, (unsigned short)
 970                                      dtls1_get_queue_priority
 971                                      (frag->msg_header.seq,
 972                                       frag->msg_header.is_ccs), &found) <= 0)
 973             return -1;
 974     }
 975
 976     return 1;
 977 }
 978
 979 int dtls1_buffer_message(SSL *s, int is_ccs)
 980 {
 981     pitem *item;
 982     hm_fragment *frag;
 983     unsigned char seq64be[8];
 984
 985     /*
 986      * this function is called immediately after a message has been
 987      * serialized
 988      */
 989     OPENSSL_assert(s->init_off == 0);
 990
 991     frag = dtls1_hm_fragment_new(s->init_num, 0);
 992     if (frag == NULL)
 993         return 0;
 994
 995     memcpy(frag->fragment, s->init_buf->data, s->init_num);
 996
 997     if (is_ccs) {
 998         /* For DTLS1_BAD_VER the header length is non-standard */
 999         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1000                        ((s->version ==
1001                          DTLS1_BAD_VER) ? 3 : DTLS1_CCS_HEADER_LENGTH)
1002                        == (unsigned int)s->init_num);
1003     } else {
1004         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1005                        DTLS1_HM_HEADER_LENGTH == (unsigned int)s->init_num);
1006     }
1007
1008     frag->msg_header.msg_len = s->d1->w_msg_hdr.msg_len;
1009     frag->msg_header.seq = s->d1->w_msg_hdr.seq;
1010     frag->msg_header.type = s->d1->w_msg_hdr.type;
1011     frag->msg_header.frag_off = 0;
1012     frag->msg_header.frag_len = s->d1->w_msg_hdr.msg_len;
1013     frag->msg_header.is_ccs = is_ccs;
1014
1015     /* save current state */
1016     frag->msg_header.saved_retransmit_state.enc_write_ctx = s->enc_write_ctx;
1017     frag->msg_header.saved_retransmit_state.write_hash = s->write_hash;
1018     frag->msg_header.saved_retransmit_state.compress = s->compress;
1019     frag->msg_header.saved_retransmit_state.session = s->session;
1020     frag->msg_header.saved_retransmit_state.epoch =
1021         DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1022
1023     memset(seq64be, 0, sizeof(seq64be));
1024     seq64be[6] =
1025         (unsigned
1026          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1027                                         frag->msg_header.is_ccs) >> 8);
1028     seq64be[7] =
1029         (unsigned
1030          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1031                                         frag->msg_header.is_ccs));
1032
1033     item = pitem_new(seq64be, frag);
1034     if (item == NULL) {
1035         dtls1_hm_fragment_free(frag);
1036         return 0;
1037     }
1038
1039     pqueue_insert(s->d1->sent_messages, item);
1040     return 1;
1041 }
1042
1043 int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found)
1044 {
1045     int ret;
1046     /* XDTLS: for now assuming that read/writes are blocking */
1047     pitem *item;
1048     hm_fragment *frag;
1049     unsigned long header_length;
1050     unsigned char seq64be[8];
1051     struct dtls1_retransmit_state saved_state;
1052
1053     /*-
1054       OPENSSL_assert(s->init_num == 0);
1055       OPENSSL_assert(s->init_off == 0);
1056      */
1057
1058     /* XDTLS:  the requested message ought to be found, otherwise error */
1059     memset(seq64be, 0, sizeof(seq64be));
1060     seq64be[6] = (unsigned char)(seq >> 8);
1061     seq64be[7] = (unsigned char)seq;
1062
1063     item = pqueue_find(s->d1->sent_messages, seq64be);
1064     if (item == NULL) {
1065         SSLerr(SSL_F_DTLS1_RETRANSMIT_MESSAGE, ERR_R_INTERNAL_ERROR);
1066         *found = 0;
1067         return 0;
1068     }
1069
1070     *found = 1;
1071     frag = (hm_fragment *)item->data;
1072
1073     if (frag->msg_header.is_ccs)
1074         header_length = DTLS1_CCS_HEADER_LENGTH;
1075     else
1076         header_length = DTLS1_HM_HEADER_LENGTH;
1077
1078     memcpy(s->init_buf->data, frag->fragment,
1079            frag->msg_header.msg_len + header_length);
1080     s->init_num = frag->msg_header.msg_len + header_length;
1081
1082     dtls1_set_message_header_int(s, frag->msg_header.type,
1083                                  frag->msg_header.msg_len,
1084                                  frag->msg_header.seq, 0,
1085                                  frag->msg_header.frag_len);
1086
1087     /* save current state */
1088     saved_state.enc_write_ctx = s->enc_write_ctx;
1089     saved_state.write_hash = s->write_hash;
1090     saved_state.compress = s->compress;
1091     saved_state.session = s->session;
1092     saved_state.epoch = DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1093
1094     s->d1->retransmitting = 1;
1095
1096     /* restore state in which the message was originally sent */
1097     s->enc_write_ctx = frag->msg_header.saved_retransmit_state.enc_write_ctx;
1098     s->write_hash = frag->msg_header.saved_retransmit_state.write_hash;
1099     s->compress = frag->msg_header.saved_retransmit_state.compress;
1100     s->session = frag->msg_header.saved_retransmit_state.session;
1101     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer,
1102                                         frag->msg_header.
1103                                         saved_retransmit_state.epoch);
1104
1105     ret = dtls1_do_write(s, frag->msg_header.is_ccs ?
1106                          SSL3_RT_CHANGE_CIPHER_SPEC : SSL3_RT_HANDSHAKE);
1107
1108     /* restore current state */
1109     s->enc_write_ctx = saved_state.enc_write_ctx;
1110     s->write_hash = saved_state.write_hash;
1111     s->compress = saved_state.compress;
1112     s->session = saved_state.session;
1113     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer, saved_state.epoch);
1114
1115     s->d1->retransmitting = 0;
1116
1117     (void)BIO_flush(s->wbio);
1118     return ret;
1119 }
1120
1121 void dtls1_set_message_header(SSL *s,
1122                               unsigned char mt, unsigned long len,
1123                               unsigned long frag_off, unsigned long frag_len)
1124 {
1125     if (frag_off == 0) {
1126         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1127         s->d1->next_handshake_write_seq++;
1128     }
1129
1130     dtls1_set_message_header_int(s, mt, len, s->d1->handshake_write_seq,
1131                                  frag_off, frag_len);
1132 }
1133
1134 /* don't actually do the writing, wait till the MTU has been retrieved */
1135 static void
1136 dtls1_set_message_header_int(SSL *s, unsigned char mt,
1137                              size_t len, unsigned short seq_num,
1138                              size_t frag_off, size_t frag_len)
1139 {
1140     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1141
1142     msg_hdr->type = mt;
1143     msg_hdr->msg_len = len;
1144     msg_hdr->seq = seq_num;
1145     msg_hdr->frag_off = frag_off;
1146     msg_hdr->frag_len = frag_len;
1147 }
1148
1149 static void
1150 dtls1_fix_message_header(SSL *s, size_t frag_off, size_t frag_len)
1151 {
1152     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1153
1154     msg_hdr->frag_off = frag_off;
1155     msg_hdr->frag_len = frag_len;
1156 }
1157
1158 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p)
1159 {
1160     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1161
1162     *p++ = msg_hdr->type;
1163     l2n3(msg_hdr->msg_len, p);
1164
1165     s2n(msg_hdr->seq, p);
1166     l2n3(msg_hdr->frag_off, p);
1167     l2n3(msg_hdr->frag_len, p);
1168
1169     return p;
1170 }
1171
1172 void dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr)
1173 {
1174     memset(msg_hdr, 0, sizeof(*msg_hdr));
1175     msg_hdr->type = *(data++);
1176     n2l3(data, msg_hdr->msg_len);
1177
1178     n2s(data, msg_hdr->seq);
1179     n2l3(data, msg_hdr->frag_off);
1180     n2l3(data, msg_hdr->frag_len);
1181 }
1182
1183 int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype)
1184 {
1185     unsigned char *header;
1186
1187     if (htype == SSL3_MT_CHANGE_CIPHER_SPEC) {
1188         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1189         dtls1_set_message_header_int(s, SSL3_MT_CCS, 0,
1190                                      s->d1->handshake_write_seq, 0, 0);
1191         if (!WPACKET_put_bytes_u8(pkt, SSL3_MT_CCS))
1192             return 0;
1193     } else {
1194         dtls1_set_message_header(s, htype, 0, 0, 0);
1195         /*
1196          * We allocate space at the start for the message header. This gets
1197          * filled in later
1198          */
1199         if (!WPACKET_allocate_bytes(pkt, DTLS1_HM_HEADER_LENGTH, &header)
1200                 || !WPACKET_start_sub_packet(pkt))
1201             return 0;
1202     }
1203
1204     return 1;
1205 }
1206
1207 int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype)
1208 {
1209     size_t msglen;
1210
1211     if ((htype != SSL3_MT_CHANGE_CIPHER_SPEC && !WPACKET_close(pkt))
1212             || !WPACKET_get_length(pkt, &msglen)
1213             || msglen > INT_MAX)
1214         return 0;
1215
1216     if (htype != SSL3_MT_CHANGE_CIPHER_SPEC) {
1217         s->d1->w_msg_hdr.msg_len = msglen - DTLS1_HM_HEADER_LENGTH;
1218         s->d1->w_msg_hdr.frag_len = msglen - DTLS1_HM_HEADER_LENGTH;
1219     }
1220     s->init_num = (int)msglen;
1221     s->init_off = 0;
1222
1223     if (htype != DTLS1_MT_HELLO_VERIFY_REQUEST) {
1224         /* Buffer the message to handle re-xmits */
1225         if (!dtls1_buffer_message(s, htype == SSL3_MT_CHANGE_CIPHER_SPEC
1226                                      ? 1 : 0))
1227             return 0;
1228     }
1229
1230     return 1;
1231 }