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         if (len > s->max_send_fragment)
 218             len = s->max_send_fragment;
 219
 220         /*
 221          * XDTLS: this function is too long.  split out the CCS part
 222          */
 223         if (type == SSL3_RT_HANDSHAKE) {
 224             if (len < DTLS1_HM_HEADER_LENGTH) {
 225                 /*
 226                  * len is so small that we really can't do anything sensible
 227                  * so fail
 228                  */
 229                 return -1;
 230             }
 231             dtls1_fix_message_header(s, frag_off, len - DTLS1_HM_HEADER_LENGTH);
 232
 233             dtls1_write_message_header(s,
 234                                        (unsigned char *)&s->init_buf->
 235                                        data[s->init_off]);
 236         }
 237
 238         ret = dtls1_write_bytes(s, type, &s->init_buf->data[s->init_off], len,
 239                                 &written);
 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 == written);
 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                 size_t 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 = written;
 289                 } else {
 290                     p += DTLS1_HM_HEADER_LENGTH;
 291                     xlen = written - DTLS1_HM_HEADER_LENGTH;
 292                 }
 293
 294                 if (!ssl3_finish_mac(s, p, xlen))
 295                     return -1;
 296             }
 297
 298             if (written == 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 += written;
 310             s->init_num -= written;
 311             written -= DTLS1_HM_HEADER_LENGTH;
 312             frag_off += written;
 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, size_t *len)
 327 {
 328     struct hm_header_st *msg_hdr;
 329     unsigned char *p;
 330     size_t msg_len;
 331     size_t tmplen;
 332     int errtype;
 333
 334     msg_hdr = &s->d1->r_msg_hdr;
 335     memset(msg_hdr, 0, sizeof(*msg_hdr));
 336
 337  again:
 338     if (!dtls_get_reassembled_message(s, &errtype, &tmplen)) {
 339         if (errtype == DTLS1_HM_BAD_FRAGMENT
 340                 || errtype == DTLS1_HM_FRAGMENT_RETRY) {
 341             /* bad fragment received */
 342             goto again;
 343         }
 344         return 0;
 345     }
 346
 347     *mt = s->s3->tmp.message_type;
 348
 349     p = (unsigned char *)s->init_buf->data;
 350     *len = s->init_num;
 351
 352     if (*mt == SSL3_MT_CHANGE_CIPHER_SPEC) {
 353         if (s->msg_callback) {
 354             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
 355                             p, 1, s, s->msg_callback_arg);
 356         }
 357         /*
 358          * This isn't a real handshake message so skip the processing below.
 359          */
 360         return 1;
 361     }
 362
 363     msg_len = msg_hdr->msg_len;
 364
 365     /* reconstruct message header */
 366     *(p++) = msg_hdr->type;
 367     l2n3(msg_len, p);
 368     s2n(msg_hdr->seq, p);
 369     l2n3(0, p);
 370     l2n3(msg_len, p);
 371     if (s->version != DTLS1_BAD_VER) {
 372         p -= DTLS1_HM_HEADER_LENGTH;
 373         msg_len += DTLS1_HM_HEADER_LENGTH;
 374     }
 375
 376     if (!ssl3_finish_mac(s, p, msg_len))
 377         return 0;
 378     if (s->msg_callback)
 379         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 380                         p, msg_len, s, s->msg_callback_arg);
 381
 382     memset(msg_hdr, 0, sizeof(*msg_hdr));
 383
 384     s->d1->handshake_read_seq++;
 385
 386     s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 387
 388     return 1;
 389 }
 390
 391 /*
 392  * dtls1_max_handshake_message_len returns the maximum number of bytes
 393  * permitted in a DTLS handshake message for |s|. The minimum is 16KB, but
 394  * may be greater if the maximum certificate list size requires it.
 395  */
 396 static size_t dtls1_max_handshake_message_len(const SSL *s)
 397 {
 398     size_t max_len = DTLS1_HM_HEADER_LENGTH + SSL3_RT_MAX_ENCRYPTED_LENGTH;
 399     if (max_len < s->max_cert_list)
 400         return s->max_cert_list;
 401     return max_len;
 402 }
 403
 404 static int dtls1_preprocess_fragment(SSL *s, struct hm_header_st *msg_hdr)
 405 {
 406     size_t frag_off, frag_len, msg_len;
 407
 408     msg_len = msg_hdr->msg_len;
 409     frag_off = msg_hdr->frag_off;
 410     frag_len = msg_hdr->frag_len;
 411
 412     /* sanity checking */
 413     if ((frag_off + frag_len) > msg_len
 414             || msg_len > dtls1_max_handshake_message_len(s)) {
 415         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 416         return SSL_AD_ILLEGAL_PARAMETER;
 417     }
 418
 419     if (s->d1->r_msg_hdr.frag_off == 0) { /* first fragment */
 420         /*
 421          * msg_len is limited to 2^24, but is effectively checked against
 422          * dtls_max_handshake_message_len(s) above
 423          */
 424         if (!BUF_MEM_grow_clean(s->init_buf, msg_len + DTLS1_HM_HEADER_LENGTH)) {
 425             SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, ERR_R_BUF_LIB);
 426             return SSL_AD_INTERNAL_ERROR;
 427         }
 428
 429         s->s3->tmp.message_size = msg_len;
 430         s->d1->r_msg_hdr.msg_len = msg_len;
 431         s->s3->tmp.message_type = msg_hdr->type;
 432         s->d1->r_msg_hdr.type = msg_hdr->type;
 433         s->d1->r_msg_hdr.seq = msg_hdr->seq;
 434     } else if (msg_len != s->d1->r_msg_hdr.msg_len) {
 435         /*
 436          * They must be playing with us! BTW, failure to enforce upper limit
 437          * would open possibility for buffer overrun.
 438          */
 439         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 440         return SSL_AD_ILLEGAL_PARAMETER;
 441     }
 442
 443     return 0;                   /* no error */
 444 }
 445
 446 static int dtls1_retrieve_buffered_fragment(SSL *s, size_t *len)
 447 {
 448     /*-
 449      * (0) check whether the desired fragment is available
 450      * if so:
 451      * (1) copy over the fragment to s->init_buf->data[]
 452      * (2) update s->init_num
 453      */
 454     pitem *item;
 455     hm_fragment *frag;
 456     int al;
 457
 458     do {
 459         item = pqueue_peek(s->d1->buffered_messages);
 460         if (item == NULL)
 461             return 0;
 462
 463         frag = (hm_fragment *)item->data;
 464
 465         if (frag->msg_header.seq < s->d1->handshake_read_seq) {
 466             /* This is a stale message that has been buffered so clear it */
 467             pqueue_pop(s->d1->buffered_messages);
 468             dtls1_hm_fragment_free(frag);
 469             pitem_free(item);
 470             item = NULL;
 471             frag = NULL;
 472         }
 473     } while (item == NULL);
 474
 475     /* Don't return if reassembly still in progress */
 476     if (frag->reassembly != NULL)
 477         return 0;
 478
 479     if (s->d1->handshake_read_seq == frag->msg_header.seq) {
 480         size_t frag_len = frag->msg_header.frag_len;
 481         pqueue_pop(s->d1->buffered_messages);
 482
 483         al = dtls1_preprocess_fragment(s, &frag->msg_header);
 484
 485         if (al == 0) {          /* no alert */
 486             unsigned char *p =
 487                 (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 488             memcpy(&p[frag->msg_header.frag_off], frag->fragment,
 489                    frag->msg_header.frag_len);
 490         }
 491
 492         dtls1_hm_fragment_free(frag);
 493         pitem_free(item);
 494
 495         if (al == 0) {
 496             *len = frag_len;
 497             return 1;
 498         }
 499
 500         ssl3_send_alert(s, SSL3_AL_FATAL, al);
 501         s->init_num = 0;
 502         return 0;
 503     } else {
 504         return 0;
 505     }
 506 }
 507
 508 static int
 509 dtls1_reassemble_fragment(SSL *s, const struct hm_header_st *msg_hdr)
 510 {
 511     hm_fragment *frag = NULL;
 512     pitem *item = NULL;
 513     int i = -1, is_complete;
 514     unsigned char seq64be[8];
 515     size_t frag_len = msg_hdr->frag_len;
 516     size_t readbytes;
 517
 518     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len ||
 519         msg_hdr->msg_len > dtls1_max_handshake_message_len(s))
 520         goto err;
 521
 522     if (frag_len == 0) {
 523         return DTLS1_HM_FRAGMENT_RETRY;
 524     }
 525
 526     /* Try to find item in queue */
 527     memset(seq64be, 0, sizeof(seq64be));
 528     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 529     seq64be[7] = (unsigned char)msg_hdr->seq;
 530     item = pqueue_find(s->d1->buffered_messages, seq64be);
 531
 532     if (item == NULL) {
 533         frag = dtls1_hm_fragment_new(msg_hdr->msg_len, 1);
 534         if (frag == NULL)
 535             goto err;
 536         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 537         frag->msg_header.frag_len = frag->msg_header.msg_len;
 538         frag->msg_header.frag_off = 0;
 539     } else {
 540         frag = (hm_fragment *)item->data;
 541         if (frag->msg_header.msg_len != msg_hdr->msg_len) {
 542             item = NULL;
 543             frag = NULL;
 544             goto err;
 545         }
 546     }
 547
 548     /*
 549      * If message is already reassembled, this must be a retransmit and can
 550      * be dropped. In this case item != NULL and so frag does not need to be
 551      * freed.
 552      */
 553     if (frag->reassembly == NULL) {
 554         unsigned char devnull[256];
 555
 556         while (frag_len) {
 557             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 558                                           devnull,
 559                                           frag_len >
 560                                           sizeof(devnull) ? sizeof(devnull) :
 561                                           frag_len, 0, &readbytes);
 562             if (i <= 0)
 563                 goto err;
 564             frag_len -= readbytes;
 565         }
 566         return DTLS1_HM_FRAGMENT_RETRY;
 567     }
 568
 569     /* read the body of the fragment (header has already been read */
 570     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 571                                   frag->fragment + msg_hdr->frag_off,
 572                                   frag_len, 0, &readbytes);
 573     if (i <= 0 || readbytes != frag_len)
 574         i = -1;
 575     if (i <= 0)
 576         goto err;
 577
 578     RSMBLY_BITMASK_MARK(frag->reassembly, (long)msg_hdr->frag_off,
 579                         (long)(msg_hdr->frag_off + frag_len));
 580
 581     RSMBLY_BITMASK_IS_COMPLETE(frag->reassembly, (long)msg_hdr->msg_len,
 582                                is_complete);
 583
 584     if (is_complete) {
 585         OPENSSL_free(frag->reassembly);
 586         frag->reassembly = NULL;
 587     }
 588
 589     if (item == NULL) {
 590         item = pitem_new(seq64be, frag);
 591         if (item == NULL) {
 592             i = -1;
 593             goto err;
 594         }
 595
 596         item = pqueue_insert(s->d1->buffered_messages, item);
 597         /*
 598          * pqueue_insert fails iff a duplicate item is inserted. However,
 599          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 600          * would have returned it and control would never have reached this
 601          * branch.
 602          */
 603         OPENSSL_assert(item != NULL);
 604     }
 605
 606     return DTLS1_HM_FRAGMENT_RETRY;
 607
 608  err:
 609     if (item == NULL)
 610         dtls1_hm_fragment_free(frag);
 611     return -1;
 612 }
 613
 614 static int
 615 dtls1_process_out_of_seq_message(SSL *s, const struct hm_header_st *msg_hdr)
 616 {
 617     int i = -1;
 618     hm_fragment *frag = NULL;
 619     pitem *item = NULL;
 620     unsigned char seq64be[8];
 621     size_t frag_len = msg_hdr->frag_len;
 622     size_t readbytes;
 623
 624     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len)
 625         goto err;
 626
 627     /* Try to find item in queue, to prevent duplicate entries */
 628     memset(seq64be, 0, sizeof(seq64be));
 629     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 630     seq64be[7] = (unsigned char)msg_hdr->seq;
 631     item = pqueue_find(s->d1->buffered_messages, seq64be);
 632
 633     /*
 634      * If we already have an entry and this one is a fragment, don't discard
 635      * it and rather try to reassemble it.
 636      */
 637     if (item != NULL && frag_len != msg_hdr->msg_len)
 638         item = NULL;
 639
 640     /*
 641      * Discard the message if sequence number was already there, is too far
 642      * in the future, already in the queue or if we received a FINISHED
 643      * before the SERVER_HELLO, which then must be a stale retransmit.
 644      */
 645     if (msg_hdr->seq <= s->d1->handshake_read_seq ||
 646         msg_hdr->seq > s->d1->handshake_read_seq + 10 || item != NULL ||
 647         (s->d1->handshake_read_seq == 0 && msg_hdr->type == SSL3_MT_FINISHED)) {
 648         unsigned char devnull[256];
 649
 650         while (frag_len) {
 651             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 652                                           devnull,
 653                                           frag_len >
 654                                           sizeof(devnull) ? sizeof(devnull) :
 655                                           frag_len, 0, &readbytes);
 656             if (i <= 0)
 657                 goto err;
 658             frag_len -= readbytes;
 659         }
 660     } else {
 661         if (frag_len != msg_hdr->msg_len) {
 662             return dtls1_reassemble_fragment(s, msg_hdr);
 663         }
 664
 665         if (frag_len > dtls1_max_handshake_message_len(s))
 666             goto err;
 667
 668         frag = dtls1_hm_fragment_new(frag_len, 0);
 669         if (frag == NULL)
 670             goto err;
 671
 672         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 673
 674         if (frag_len) {
 675             /*
 676              * read the body of the fragment (header has already been read
 677              */
 678             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 679                                           frag->fragment, frag_len, 0,
 680                                           &readbytes);
 681             if (i<=0 || readbytes != frag_len)
 682                 i = -1;
 683             if (i <= 0)
 684                 goto err;
 685         }
 686
 687         item = pitem_new(seq64be, frag);
 688         if (item == NULL)
 689             goto err;
 690
 691         item = pqueue_insert(s->d1->buffered_messages, item);
 692         /*
 693          * pqueue_insert fails iff a duplicate item is inserted. However,
 694          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 695          * would have returned it. Then, either |frag_len| !=
 696          * |msg_hdr->msg_len| in which case |item| is set to NULL and it will
 697          * have been processed with |dtls1_reassemble_fragment|, above, or
 698          * the record will have been discarded.
 699          */
 700         OPENSSL_assert(item != NULL);
 701     }
 702
 703     return DTLS1_HM_FRAGMENT_RETRY;
 704
 705  err:
 706     if (item == NULL)
 707         dtls1_hm_fragment_free(frag);
 708     return 0;
 709 }
 710
 711 static int dtls_get_reassembled_message(SSL *s, int *errtype, size_t *len)
 712 {
 713     unsigned char wire[DTLS1_HM_HEADER_LENGTH];
 714     size_t mlen, frag_off, frag_len;
 715     int i, al, recvd_type;
 716     struct hm_header_st msg_hdr;
 717     size_t readbytes;
 718
 719     *errtype = 0;
 720
 721  redo:
 722     /* see if we have the required fragment already */
 723     if (dtls1_retrieve_buffered_fragment(s, &frag_len)) {
 724         s->init_num = frag_len;
 725         *len = frag_len;
 726         return 1;
 727     }
 728
 729     /* read handshake message header */
 730     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type, wire,
 731                                   DTLS1_HM_HEADER_LENGTH, 0, &readbytes);
 732     if (i <= 0) {               /* nbio, or an error */
 733         s->rwstate = SSL_READING;
 734         *len = 0;
 735         return 0;
 736     }
 737     if (recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
 738         if (wire[0] != SSL3_MT_CCS) {
 739             al = SSL_AD_UNEXPECTED_MESSAGE;
 740             SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE,
 741                    SSL_R_BAD_CHANGE_CIPHER_SPEC);
 742             goto f_err;
 743         }
 744
 745         memcpy(s->init_buf->data, wire, readbytes);
 746         s->init_num = readbytes - 1;
 747         s->init_msg = s->init_buf->data + 1;
 748         s->s3->tmp.message_type = SSL3_MT_CHANGE_CIPHER_SPEC;
 749         s->s3->tmp.message_size = readbytes - 1;
 750         *len = readbytes - 1;
 751         return 1;
 752     }
 753
 754     /* Handshake fails if message header is incomplete */
 755     if (readbytes != DTLS1_HM_HEADER_LENGTH) {
 756         al = SSL_AD_UNEXPECTED_MESSAGE;
 757         SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
 758         goto f_err;
 759     }
 760
 761     /* parse the message fragment header */
 762     dtls1_get_message_header(wire, &msg_hdr);
 763
 764     mlen = msg_hdr.msg_len;
 765     frag_off = msg_hdr.frag_off;
 766     frag_len = msg_hdr.frag_len;
 767
 768     /*
 769      * We must have at least frag_len bytes left in the record to be read.
 770      * Fragments must not span records.
 771      */
 772     if (frag_len > RECORD_LAYER_get_rrec_length(&s->rlayer)) {
 773         al = SSL_AD_ILLEGAL_PARAMETER;
 774         SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_BAD_LENGTH);
 775         goto f_err;
 776     }
 777
 778     /*
 779      * if this is a future (or stale) message it gets buffered
 780      * (or dropped)--no further processing at this time
 781      * While listening, we accept seq 1 (ClientHello with cookie)
 782      * although we're still expecting seq 0 (ClientHello)
 783      */
 784     if (msg_hdr.seq != s->d1->handshake_read_seq) {
 785         *errtype = dtls1_process_out_of_seq_message(s, &msg_hdr);
 786         return 0;
 787     }
 788
 789     if (frag_len && frag_len < mlen) {
 790         *errtype = dtls1_reassemble_fragment(s, &msg_hdr);
 791         return 0;
 792     }
 793
 794     if (!s->server
 795             && s->d1->r_msg_hdr.frag_off == 0
 796             && s->statem.hand_state != TLS_ST_OK
 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, &readbytes);
 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         readbytes = 0;
 841     }
 842
 843     /*
 844      * XDTLS: an incorrectly formatted fragment should cause the handshake
 845      * to fail
 846      */
 847     if (readbytes != frag_len) {
 848         al = SSL_AD_ILLEGAL_PARAMETER;
 849         SSLerr(SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_BAD_LENGTH);
 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     /* done, no need to send a retransmit */
 928     if (!SSL_in_init(s))
 929     {
 930         BIO_set_flags(SSL_get_rbio(s), BIO_FLAGS_READ);
 931         return code;
 932     }
 933
 934     return dtls1_handle_timeout(s);
 935 }
 936
 937 int dtls1_get_queue_priority(unsigned short seq, int is_ccs)
 938 {
 939     /*
 940      * The index of the retransmission queue actually is the message sequence
 941      * number, since the queue only contains messages of a single handshake.
 942      * However, the ChangeCipherSpec has no message sequence number and so
 943      * using only the sequence will result in the CCS and Finished having the
 944      * same index. To prevent this, the sequence number is multiplied by 2.
 945      * In case of a CCS 1 is subtracted. This does not only differ CSS and
 946      * Finished, it also maintains the order of the index (important for
 947      * priority queues) and fits in the unsigned short variable.
 948      */
 949     return seq * 2 - is_ccs;
 950 }
 951
 952 int dtls1_retransmit_buffered_messages(SSL *s)
 953 {
 954     pqueue *sent = s->d1->sent_messages;
 955     piterator iter;
 956     pitem *item;
 957     hm_fragment *frag;
 958     int found = 0;
 959
 960     iter = pqueue_iterator(sent);
 961
 962     for (item = pqueue_next(&iter); item != NULL; item = pqueue_next(&iter)) {
 963         frag = (hm_fragment *)item->data;
 964         if (dtls1_retransmit_message(s, (unsigned short)
 965                                      dtls1_get_queue_priority
 966                                      (frag->msg_header.seq,
 967                                       frag->msg_header.is_ccs), &found) <= 0)
 968             return -1;
 969     }
 970
 971     return 1;
 972 }
 973
 974 int dtls1_buffer_message(SSL *s, int is_ccs)
 975 {
 976     pitem *item;
 977     hm_fragment *frag;
 978     unsigned char seq64be[8];
 979
 980     /*
 981      * this function is called immediately after a message has been
 982      * serialized
 983      */
 984     OPENSSL_assert(s->init_off == 0);
 985
 986     frag = dtls1_hm_fragment_new(s->init_num, 0);
 987     if (frag == NULL)
 988         return 0;
 989
 990     memcpy(frag->fragment, s->init_buf->data, s->init_num);
 991
 992     if (is_ccs) {
 993         /* For DTLS1_BAD_VER the header length is non-standard */
 994         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
 995                        ((s->version ==
 996                          DTLS1_BAD_VER) ? 3 : DTLS1_CCS_HEADER_LENGTH)
 997                        == (unsigned int)s->init_num);
 998     } else {
 999         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1000                        DTLS1_HM_HEADER_LENGTH == (unsigned int)s->init_num);
1001     }
1002
1003     frag->msg_header.msg_len = s->d1->w_msg_hdr.msg_len;
1004     frag->msg_header.seq = s->d1->w_msg_hdr.seq;
1005     frag->msg_header.type = s->d1->w_msg_hdr.type;
1006     frag->msg_header.frag_off = 0;
1007     frag->msg_header.frag_len = s->d1->w_msg_hdr.msg_len;
1008     frag->msg_header.is_ccs = is_ccs;
1009
1010     /* save current state */
1011     frag->msg_header.saved_retransmit_state.enc_write_ctx = s->enc_write_ctx;
1012     frag->msg_header.saved_retransmit_state.write_hash = s->write_hash;
1013     frag->msg_header.saved_retransmit_state.compress = s->compress;
1014     frag->msg_header.saved_retransmit_state.session = s->session;
1015     frag->msg_header.saved_retransmit_state.epoch =
1016         DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1017
1018     memset(seq64be, 0, sizeof(seq64be));
1019     seq64be[6] =
1020         (unsigned
1021          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1022                                         frag->msg_header.is_ccs) >> 8);
1023     seq64be[7] =
1024         (unsigned
1025          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1026                                         frag->msg_header.is_ccs));
1027
1028     item = pitem_new(seq64be, frag);
1029     if (item == NULL) {
1030         dtls1_hm_fragment_free(frag);
1031         return 0;
1032     }
1033
1034     pqueue_insert(s->d1->sent_messages, item);
1035     return 1;
1036 }
1037
1038 int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found)
1039 {
1040     int ret;
1041     /* XDTLS: for now assuming that read/writes are blocking */
1042     pitem *item;
1043     hm_fragment *frag;
1044     unsigned long header_length;
1045     unsigned char seq64be[8];
1046     struct dtls1_retransmit_state saved_state;
1047
1048     /*-
1049       OPENSSL_assert(s->init_num == 0);
1050       OPENSSL_assert(s->init_off == 0);
1051      */
1052
1053     /* XDTLS:  the requested message ought to be found, otherwise error */
1054     memset(seq64be, 0, sizeof(seq64be));
1055     seq64be[6] = (unsigned char)(seq >> 8);
1056     seq64be[7] = (unsigned char)seq;
1057
1058     item = pqueue_find(s->d1->sent_messages, seq64be);
1059     if (item == NULL) {
1060         SSLerr(SSL_F_DTLS1_RETRANSMIT_MESSAGE, ERR_R_INTERNAL_ERROR);
1061         *found = 0;
1062         return 0;
1063     }
1064
1065     *found = 1;
1066     frag = (hm_fragment *)item->data;
1067
1068     if (frag->msg_header.is_ccs)
1069         header_length = DTLS1_CCS_HEADER_LENGTH;
1070     else
1071         header_length = DTLS1_HM_HEADER_LENGTH;
1072
1073     memcpy(s->init_buf->data, frag->fragment,
1074            frag->msg_header.msg_len + header_length);
1075     s->init_num = frag->msg_header.msg_len + header_length;
1076
1077     dtls1_set_message_header_int(s, frag->msg_header.type,
1078                                  frag->msg_header.msg_len,
1079                                  frag->msg_header.seq, 0,
1080                                  frag->msg_header.frag_len);
1081
1082     /* save current state */
1083     saved_state.enc_write_ctx = s->enc_write_ctx;
1084     saved_state.write_hash = s->write_hash;
1085     saved_state.compress = s->compress;
1086     saved_state.session = s->session;
1087     saved_state.epoch = DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1088
1089     s->d1->retransmitting = 1;
1090
1091     /* restore state in which the message was originally sent */
1092     s->enc_write_ctx = frag->msg_header.saved_retransmit_state.enc_write_ctx;
1093     s->write_hash = frag->msg_header.saved_retransmit_state.write_hash;
1094     s->compress = frag->msg_header.saved_retransmit_state.compress;
1095     s->session = frag->msg_header.saved_retransmit_state.session;
1096     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer,
1097                                         frag->msg_header.
1098                                         saved_retransmit_state.epoch);
1099
1100     ret = dtls1_do_write(s, frag->msg_header.is_ccs ?
1101                          SSL3_RT_CHANGE_CIPHER_SPEC : SSL3_RT_HANDSHAKE);
1102
1103     /* restore current state */
1104     s->enc_write_ctx = saved_state.enc_write_ctx;
1105     s->write_hash = saved_state.write_hash;
1106     s->compress = saved_state.compress;
1107     s->session = saved_state.session;
1108     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer, saved_state.epoch);
1109
1110     s->d1->retransmitting = 0;
1111
1112     (void)BIO_flush(s->wbio);
1113     return ret;
1114 }
1115
1116 void dtls1_set_message_header(SSL *s,
1117                               unsigned char mt, size_t len,
1118                               size_t frag_off, size_t frag_len)
1119 {
1120     if (frag_off == 0) {
1121         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1122         s->d1->next_handshake_write_seq++;
1123     }
1124
1125     dtls1_set_message_header_int(s, mt, len, s->d1->handshake_write_seq,
1126                                  frag_off, frag_len);
1127 }
1128
1129 /* don't actually do the writing, wait till the MTU has been retrieved */
1130 static void
1131 dtls1_set_message_header_int(SSL *s, unsigned char mt,
1132                              size_t len, unsigned short seq_num,
1133                              size_t frag_off, size_t frag_len)
1134 {
1135     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1136
1137     msg_hdr->type = mt;
1138     msg_hdr->msg_len = len;
1139     msg_hdr->seq = seq_num;
1140     msg_hdr->frag_off = frag_off;
1141     msg_hdr->frag_len = frag_len;
1142 }
1143
1144 static void
1145 dtls1_fix_message_header(SSL *s, size_t frag_off, size_t frag_len)
1146 {
1147     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1148
1149     msg_hdr->frag_off = frag_off;
1150     msg_hdr->frag_len = frag_len;
1151 }
1152
1153 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p)
1154 {
1155     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1156
1157     *p++ = msg_hdr->type;
1158     l2n3(msg_hdr->msg_len, p);
1159
1160     s2n(msg_hdr->seq, p);
1161     l2n3(msg_hdr->frag_off, p);
1162     l2n3(msg_hdr->frag_len, p);
1163
1164     return p;
1165 }
1166
1167 void dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr)
1168 {
1169     memset(msg_hdr, 0, sizeof(*msg_hdr));
1170     msg_hdr->type = *(data++);
1171     n2l3(data, msg_hdr->msg_len);
1172
1173     n2s(data, msg_hdr->seq);
1174     n2l3(data, msg_hdr->frag_off);
1175     n2l3(data, msg_hdr->frag_len);
1176 }
1177
1178 int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype)
1179 {
1180     unsigned char *header;
1181
1182     if (htype == SSL3_MT_CHANGE_CIPHER_SPEC) {
1183         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1184         dtls1_set_message_header_int(s, SSL3_MT_CCS, 0,
1185                                      s->d1->handshake_write_seq, 0, 0);
1186         if (!WPACKET_put_bytes_u8(pkt, SSL3_MT_CCS))
1187             return 0;
1188     } else {
1189         dtls1_set_message_header(s, htype, 0, 0, 0);
1190         /*
1191          * We allocate space at the start for the message header. This gets
1192          * filled in later
1193          */
1194         if (!WPACKET_allocate_bytes(pkt, DTLS1_HM_HEADER_LENGTH, &header)
1195                 || !WPACKET_start_sub_packet(pkt))
1196             return 0;
1197     }
1198
1199     return 1;
1200 }
1201
1202 int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype)
1203 {
1204     size_t msglen;
1205
1206     if ((htype != SSL3_MT_CHANGE_CIPHER_SPEC && !WPACKET_close(pkt))
1207             || !WPACKET_get_length(pkt, &msglen)
1208             || msglen > INT_MAX)
1209         return 0;
1210
1211     if (htype != SSL3_MT_CHANGE_CIPHER_SPEC) {
1212         s->d1->w_msg_hdr.msg_len = msglen - DTLS1_HM_HEADER_LENGTH;
1213         s->d1->w_msg_hdr.frag_len = msglen - DTLS1_HM_HEADER_LENGTH;
1214     }
1215     s->init_num = (int)msglen;
1216     s->init_off = 0;
1217
1218     if (htype != DTLS1_MT_HELLO_VERIFY_REQUEST) {
1219         /* Buffer the message to handle re-xmits */
1220         if (!dtls1_buffer_message(s, htype == SSL3_MT_CHANGE_CIPHER_SPEC
1221                                      ? 1 : 0))
1222             return 0;
1223     }
1224
1225     return 1;
1226 }