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