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