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