ssl/d1_both.c

   1 /* ssl/d1_both.c */
   2 /*
   3  * DTLS implementation written by Nagendra Modadugu
   4  * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    openssl-core@openssl.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  60  * All rights reserved.
  61  *
  62  * This package is an SSL implementation written
  63  * by Eric Young (eay@cryptsoft.com).
  64  * The implementation was written so as to conform with Netscapes SSL.
  65  *
  66  * This library is free for commercial and non-commercial use as long as
  67  * the following conditions are aheared to.  The following conditions
  68  * apply to all code found in this distribution, be it the RC4, RSA,
  69  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  70  * included with this distribution is covered by the same copyright terms
  71  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  72  *
  73  * Copyright remains Eric Young's, and as such any Copyright notices in
  74  * the code are not to be removed.
  75  * If this package is used in a product, Eric Young should be given attribution
  76  * as the author of the parts of the library used.
  77  * This can be in the form of a textual message at program startup or
  78  * in documentation (online or textual) provided with the package.
  79  *
  80  * Redistribution and use in source and binary forms, with or without
  81  * modification, are permitted provided that the following conditions
  82  * are met:
  83  * 1. Redistributions of source code must retain the copyright
  84  *    notice, this list of conditions and the following disclaimer.
  85  * 2. Redistributions in binary form must reproduce the above copyright
  86  *    notice, this list of conditions and the following disclaimer in the
  87  *    documentation and/or other materials provided with the distribution.
  88  * 3. All advertising materials mentioning features or use of this software
  89  *    must display the following acknowledgement:
  90  *    "This product includes cryptographic software written by
  91  *     Eric Young (eay@cryptsoft.com)"
  92  *    The word 'cryptographic' can be left out if the rouines from the library
  93  *    being used are not cryptographic related :-).
  94  * 4. If you include any Windows specific code (or a derivative thereof) from
  95  *    the apps directory (application code) you must include an acknowledgement:
  96  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  97  *
  98  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  99  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 100  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 101  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 102  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 103  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 104  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 105  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 106  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 107  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 108  * SUCH DAMAGE.
 109  *
 110  * The licence and distribution terms for any publically available version or
 111  * derivative of this code cannot be changed.  i.e. this code cannot simply be
 112  * copied and put under another distribution licence
 113  * [including the GNU Public Licence.]
 114  */
 115
 116 #include <limits.h>
 117 #include <string.h>
 118 #include <stdio.h>
 119 #include "ssl_locl.h"
 120 #include <openssl/buffer.h>
 121 #include <openssl/rand.h>
 122 #include <openssl/objects.h>
 123 #include <openssl/evp.h>
 124 #include <openssl/x509.h>
 125
 126 #define RSMBLY_BITMASK_SIZE(msg_len) (((msg_len) + 7) / 8)
 127
 128 #define RSMBLY_BITMASK_MARK(bitmask, start, end) { \
 129                         if ((end) - (start) <= 8) { \
 130                                 long ii; \
 131                                 for (ii = (start); ii < (end); ii++) bitmask[((ii) >> 3)] |= (1 << ((ii) & 7)); \
 132                         } else { \
 133                                 long ii; \
 134                                 bitmask[((start) >> 3)] |= bitmask_start_values[((start) & 7)]; \
 135                                 for (ii = (((start) >> 3) + 1); ii < ((((end) - 1)) >> 3); ii++) bitmask[ii] = 0xff; \
 136                                 bitmask[(((end) - 1) >> 3)] |= bitmask_end_values[((end) & 7)]; \
 137                         } }
 138
 139 #define RSMBLY_BITMASK_IS_COMPLETE(bitmask, msg_len, is_complete) { \
 140                         long ii; \
 141                         OPENSSL_assert((msg_len) > 0); \
 142                         is_complete = 1; \
 143                         if (bitmask[(((msg_len) - 1) >> 3)] != bitmask_end_values[((msg_len) & 7)]) is_complete = 0; \
 144                         if (is_complete) for (ii = (((msg_len) - 1) >> 3) - 1; ii >= 0 ; ii--) \
 145                                 if (bitmask[ii] != 0xff) { is_complete = 0; break; } }
 146
 147 static unsigned char bitmask_start_values[] =
 148     { 0xff, 0xfe, 0xfc, 0xf8, 0xf0, 0xe0, 0xc0, 0x80 };
 149 static unsigned char bitmask_end_values[] =
 150     { 0xff, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f };
 151
 152 /* XDTLS:  figure out the right values */
 153 static const unsigned int g_probable_mtu[] = { 1500, 512, 256 };
 154
 155 static void dtls1_fix_message_header(SSL *s, unsigned long frag_off,
 156                                      unsigned long frag_len);
 157 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p);
 158 static void dtls1_set_message_header_int(SSL *s, unsigned char mt,
 159                                          unsigned long len,
 160                                          unsigned short seq_num,
 161                                          unsigned long frag_off,
 162                                          unsigned long frag_len);
 163 static long dtls1_get_message_fragment(SSL *s, int st1, int stn, int mt,
 164                                        long max, int *ok);
 165
 166 static hm_fragment *dtls1_hm_fragment_new(unsigned long frag_len,
 167                                           int reassembly)
 168 {
 169     hm_fragment *frag = NULL;
 170     unsigned char *buf = NULL;
 171     unsigned char *bitmask = NULL;
 172
 173     frag = OPENSSL_malloc(sizeof(*frag));
 174     if (frag == NULL)
 175         return NULL;
 176
 177     if (frag_len) {
 178         buf = OPENSSL_malloc(frag_len);
 179         if (buf == NULL) {
 180             OPENSSL_free(frag);
 181             return NULL;
 182         }
 183     }
 184
 185     /* zero length fragment gets zero frag->fragment */
 186     frag->fragment = buf;
 187
 188     /* Initialize reassembly bitmask if necessary */
 189     if (reassembly) {
 190         bitmask = OPENSSL_zalloc(RSMBLY_BITMASK_SIZE(frag_len));
 191         if (bitmask == NULL) {
 192             OPENSSL_free(buf);
 193             OPENSSL_free(frag);
 194             return NULL;
 195         }
 196     }
 197
 198     frag->reassembly = bitmask;
 199
 200     return frag;
 201 }
 202
 203 void dtls1_hm_fragment_free(hm_fragment *frag)
 204 {
 205     if (!frag)
 206         return;
 207     if (frag->msg_header.is_ccs) {
 208         EVP_CIPHER_CTX_free(frag->msg_header.
 209                             saved_retransmit_state.enc_write_ctx);
 210         EVP_MD_CTX_destroy(frag->msg_header.
 211                            saved_retransmit_state.write_hash);
 212     }
 213     OPENSSL_free(frag->fragment);
 214     OPENSSL_free(frag->reassembly);
 215     OPENSSL_free(frag);
 216 }
 217
 218 static int dtls1_query_mtu(SSL *s)
 219 {
 220     if (s->d1->link_mtu) {
 221         s->d1->mtu =
 222             s->d1->link_mtu - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
 223         s->d1->link_mtu = 0;
 224     }
 225
 226     /* AHA!  Figure out the MTU, and stick to the right size */
 227     if (s->d1->mtu < dtls1_min_mtu(s)) {
 228         if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
 229             s->d1->mtu =
 230                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
 231
 232             /*
 233              * I've seen the kernel return bogus numbers when it doesn't know
 234              * (initial write), so just make sure we have a reasonable number
 235              */
 236             if (s->d1->mtu < dtls1_min_mtu(s)) {
 237                 /* Set to min mtu */
 238                 s->d1->mtu = dtls1_min_mtu(s);
 239                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SET_MTU,
 240                          s->d1->mtu, NULL);
 241             }
 242         } else
 243             return 0;
 244     }
 245     return 1;
 246 }
 247
 248 /*
 249  * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
 250  * SSL3_RT_CHANGE_CIPHER_SPEC)
 251  */
 252 int dtls1_do_write(SSL *s, int type)
 253 {
 254     int ret;
 255     unsigned int curr_mtu;
 256     int retry = 1;
 257     unsigned int len, frag_off, mac_size, blocksize, used_len;
 258
 259     if (!dtls1_query_mtu(s))
 260         return -1;
 261
 262     OPENSSL_assert(s->d1->mtu >= dtls1_min_mtu(s)); /* should have something
 263                                                      * reasonable now */
 264
 265     if (s->init_off == 0 && type == SSL3_RT_HANDSHAKE)
 266         OPENSSL_assert(s->init_num ==
 267                        (int)s->d1->w_msg_hdr.msg_len +
 268                        DTLS1_HM_HEADER_LENGTH);
 269
 270     if (s->write_hash) {
 271         if (s->enc_write_ctx
 272             && ((EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_GCM_MODE) ||
 273                 (EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_CCM_MODE)))
 274             mac_size = 0;
 275         else
 276             mac_size = EVP_MD_CTX_size(s->write_hash);
 277     } else
 278         mac_size = 0;
 279
 280     if (s->enc_write_ctx &&
 281         (EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_CBC_MODE))
 282         blocksize = 2 * EVP_CIPHER_block_size(s->enc_write_ctx->cipher);
 283     else
 284         blocksize = 0;
 285
 286     frag_off = 0;
 287     /* s->init_num shouldn't ever be < 0...but just in case */
 288     while (s->init_num > 0) {
 289         used_len = BIO_wpending(SSL_get_wbio(s)) + DTLS1_RT_HEADER_LENGTH
 290             + mac_size + blocksize;
 291         if (s->d1->mtu > used_len)
 292             curr_mtu = s->d1->mtu - used_len;
 293         else
 294             curr_mtu = 0;
 295
 296         if (curr_mtu <= DTLS1_HM_HEADER_LENGTH) {
 297             /*
 298              * grr.. we could get an error if MTU picked was wrong
 299              */
 300             ret = BIO_flush(SSL_get_wbio(s));
 301             if (ret <= 0)
 302                 return ret;
 303             used_len = DTLS1_RT_HEADER_LENGTH + mac_size + blocksize;
 304             if (s->d1->mtu > used_len + DTLS1_HM_HEADER_LENGTH) {
 305                 curr_mtu = s->d1->mtu - used_len;
 306             } else {
 307                 /* Shouldn't happen */
 308                 return -1;
 309             }
 310         }
 311
 312         /*
 313          * We just checked that s->init_num > 0 so this cast should be safe
 314          */
 315         if (((unsigned int)s->init_num) > curr_mtu)
 316             len = curr_mtu;
 317         else
 318             len = s->init_num;
 319
 320         /* Shouldn't ever happen */
 321         if (len > INT_MAX)
 322             len = INT_MAX;
 323
 324         /*
 325          * XDTLS: this function is too long.  split out the CCS part
 326          */
 327         if (type == SSL3_RT_HANDSHAKE) {
 328             if (s->init_off != 0) {
 329                 OPENSSL_assert(s->init_off > DTLS1_HM_HEADER_LENGTH);
 330                 s->init_off -= DTLS1_HM_HEADER_LENGTH;
 331                 s->init_num += DTLS1_HM_HEADER_LENGTH;
 332
 333                 /*
 334                  * We just checked that s->init_num > 0 so this cast should
 335                  * be safe
 336                  */
 337                 if (((unsigned int)s->init_num) > curr_mtu)
 338                     len = curr_mtu;
 339                 else
 340                     len = s->init_num;
 341             }
 342
 343             /* Shouldn't ever happen */
 344             if (len > INT_MAX)
 345                 len = INT_MAX;
 346
 347             if (len < DTLS1_HM_HEADER_LENGTH) {
 348                 /*
 349                  * len is so small that we really can't do anything sensible
 350                  * so fail
 351                  */
 352                 return -1;
 353             }
 354             dtls1_fix_message_header(s, frag_off,
 355                                      len - DTLS1_HM_HEADER_LENGTH);
 356
 357             dtls1_write_message_header(s,
 358                                        (unsigned char *)&s->init_buf->
 359                                        data[s->init_off]);
 360         }
 361
 362         ret = dtls1_write_bytes(s, type, &s->init_buf->data[s->init_off],
 363                                 len);
 364         if (ret < 0) {
 365             /*
 366              * might need to update MTU here, but we don't know which
 367              * previous packet caused the failure -- so can't really
 368              * retransmit anything.  continue as if everything is fine and
 369              * wait for an alert to handle the retransmit
 370              */
 371             if (retry && BIO_ctrl(SSL_get_wbio(s),
 372                                   BIO_CTRL_DGRAM_MTU_EXCEEDED, 0, NULL) > 0) {
 373                 if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
 374                     if (!dtls1_query_mtu(s))
 375                         return -1;
 376                     /* Have one more go */
 377                     retry = 0;
 378                 } else
 379                     return -1;
 380             } else {
 381                 return (-1);
 382             }
 383         } else {
 384
 385             /*
 386              * bad if this assert fails, only part of the handshake message
 387              * got sent.  but why would this happen?
 388              */
 389             OPENSSL_assert(len == (unsigned int)ret);
 390
 391             if (type == SSL3_RT_HANDSHAKE && !s->d1->retransmitting) {
 392                 /*
 393                  * should not be done for 'Hello Request's, but in that case
 394                  * we'll ignore the result anyway
 395                  */
 396                 unsigned char *p =
 397                     (unsigned char *)&s->init_buf->data[s->init_off];
 398                 const struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
 399                 int xlen;
 400
 401                 if (frag_off == 0 && s->version != DTLS1_BAD_VER) {
 402                     /*
 403                      * reconstruct message header is if it is being sent in
 404                      * single fragment
 405                      */
 406                     *p++ = msg_hdr->type;
 407                     l2n3(msg_hdr->msg_len, p);
 408                     s2n(msg_hdr->seq, p);
 409                     l2n3(0, p);
 410                     l2n3(msg_hdr->msg_len, p);
 411                     p -= DTLS1_HM_HEADER_LENGTH;
 412                     xlen = ret;
 413                 } else {
 414                     p += DTLS1_HM_HEADER_LENGTH;
 415                     xlen = ret - DTLS1_HM_HEADER_LENGTH;
 416                 }
 417
 418                 ssl3_finish_mac(s, p, xlen);
 419             }
 420
 421             if (ret == s->init_num) {
 422                 if (s->msg_callback)
 423                     s->msg_callback(1, s->version, type, s->init_buf->data,
 424                                     (size_t)(s->init_off + s->init_num), s,
 425                                     s->msg_callback_arg);
 426
 427                 s->init_off = 0; /* done writing this message */
 428                 s->init_num = 0;
 429
 430                 return (1);
 431             }
 432             s->init_off += ret;
 433             s->init_num -= ret;
 434             frag_off += (ret -= DTLS1_HM_HEADER_LENGTH);
 435         }
 436     }
 437     return (0);
 438 }
 439
 440 /*
 441  * Obtain handshake message of message type 'mt' (any if mt == -1), maximum
 442  * acceptable body length 'max'. Read an entire handshake message.  Handshake
 443  * messages arrive in fragments.
 444  */
 445 long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok)
 446 {
 447     int i, al;
 448     struct hm_header_st *msg_hdr;
 449     unsigned char *p;
 450     unsigned long msg_len;
 451
 452     /*
 453      * s3->tmp is used to store messages that are unexpected, caused by the
 454      * absence of an optional handshake message
 455      */
 456     if (s->s3->tmp.reuse_message) {
 457         if ((mt >= 0) && (s->s3->tmp.message_type != mt)) {
 458             al = SSL_AD_UNEXPECTED_MESSAGE;
 459             SSLerr(SSL_F_DTLS1_GET_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
 460             goto f_err;
 461         }
 462         *ok = 1;
 463
 464
 465         /*
 466          * Messages reused from dtls1_listen also have the record header in
 467          * the buffer which we need to skip over.
 468          */
 469         if (s->s3->tmp.reuse_message == DTLS1_SKIP_RECORD_HEADER) {
 470             s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH
 471                           + DTLS1_RT_HEADER_LENGTH;
 472         } else {
 473             s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 474         }
 475         s->init_num = (int)s->s3->tmp.message_size;
 476         s->s3->tmp.reuse_message = 0;
 477         return s->init_num;
 478     }
 479
 480     msg_hdr = &s->d1->r_msg_hdr;
 481     memset(msg_hdr, 0, sizeof(*msg_hdr));
 482
 483  again:
 484     i = dtls1_get_message_fragment(s, st1, stn, mt, max, ok);
 485     if (i == DTLS1_HM_BAD_FRAGMENT || i == DTLS1_HM_FRAGMENT_RETRY) {
 486         /* bad fragment received */
 487         goto again;
 488     } else if (i <= 0 && !*ok) {
 489         return i;
 490     }
 491
 492     if (mt >= 0 && s->s3->tmp.message_type != mt) {
 493         al = SSL_AD_UNEXPECTED_MESSAGE;
 494         SSLerr(SSL_F_DTLS1_GET_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
 495         goto f_err;
 496     }
 497
 498     p = (unsigned char *)s->init_buf->data;
 499
 500     if (mt == SSL3_MT_CHANGE_CIPHER_SPEC) {
 501         if (s->msg_callback) {
 502             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
 503                             p, 1, s, s->msg_callback_arg);
 504         }
 505         /*
 506          * This isn't a real handshake message so skip the processing below.
 507          * dtls1_get_message_fragment() will never return a CCS if mt == -1,
 508          * so we are ok to continue in that case.
 509          */
 510         return i;
 511     }
 512
 513     msg_len = msg_hdr->msg_len;
 514
 515     /* reconstruct message header */
 516     *(p++) = msg_hdr->type;
 517     l2n3(msg_len, p);
 518     s2n(msg_hdr->seq, p);
 519     l2n3(0, p);
 520     l2n3(msg_len, p);
 521     if (s->version != DTLS1_BAD_VER) {
 522         p -= DTLS1_HM_HEADER_LENGTH;
 523         msg_len += DTLS1_HM_HEADER_LENGTH;
 524     }
 525
 526     ssl3_finish_mac(s, p, msg_len);
 527     if (s->msg_callback)
 528         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 529                         p, msg_len, s, s->msg_callback_arg);
 530
 531     memset(msg_hdr, 0, sizeof(*msg_hdr));
 532
 533     /* Don't change sequence numbers while listening */
 534     if (!s->d1->listen)
 535         s->d1->handshake_read_seq++;
 536
 537     s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 538     return s->init_num;
 539
 540  f_err:
 541     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 542     *ok = 0;
 543     return -1;
 544 }
 545
 546 static int dtls1_preprocess_fragment(SSL *s, struct hm_header_st *msg_hdr,
 547                                      int max)
 548 {
 549     size_t frag_off, frag_len, msg_len;
 550
 551     msg_len = msg_hdr->msg_len;
 552     frag_off = msg_hdr->frag_off;
 553     frag_len = msg_hdr->frag_len;
 554
 555     /* sanity checking */
 556     if ((frag_off + frag_len) > msg_len) {
 557         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 558         return SSL_AD_ILLEGAL_PARAMETER;
 559     }
 560
 561     if ((frag_off + frag_len) > (unsigned long)max) {
 562         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 563         return SSL_AD_ILLEGAL_PARAMETER;
 564     }
 565
 566     if (s->d1->r_msg_hdr.frag_off == 0) { /* first fragment */
 567         /*
 568          * msg_len is limited to 2^24, but is effectively checked against max
 569          * above
 570          */
 571         if (!BUF_MEM_grow_clean
 572             (s->init_buf, msg_len + DTLS1_HM_HEADER_LENGTH)) {
 573             SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, ERR_R_BUF_LIB);
 574             return SSL_AD_INTERNAL_ERROR;
 575         }
 576
 577         s->s3->tmp.message_size = msg_len;
 578         s->d1->r_msg_hdr.msg_len = msg_len;
 579         s->s3->tmp.message_type = msg_hdr->type;
 580         s->d1->r_msg_hdr.type = msg_hdr->type;
 581         s->d1->r_msg_hdr.seq = msg_hdr->seq;
 582     } else if (msg_len != s->d1->r_msg_hdr.msg_len) {
 583         /*
 584          * They must be playing with us! BTW, failure to enforce upper limit
 585          * would open possibility for buffer overrun.
 586          */
 587         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 588         return SSL_AD_ILLEGAL_PARAMETER;
 589     }
 590
 591     return 0;                   /* no error */
 592 }
 593
 594 static int dtls1_retrieve_buffered_fragment(SSL *s, long max, int *ok)
 595 {
 596     /*-
 597      * (0) check whether the desired fragment is available
 598      * if so:
 599      * (1) copy over the fragment to s->init_buf->data[]
 600      * (2) update s->init_num
 601      */
 602     pitem *item;
 603     hm_fragment *frag;
 604     int al;
 605
 606     *ok = 0;
 607     item = pqueue_peek(s->d1->buffered_messages);
 608     if (item == NULL)
 609         return 0;
 610
 611     frag = (hm_fragment *)item->data;
 612
 613     /* Don't return if reassembly still in progress */
 614     if (frag->reassembly != NULL)
 615         return 0;
 616
 617     if (s->d1->handshake_read_seq == frag->msg_header.seq) {
 618         unsigned long frag_len = frag->msg_header.frag_len;
 619         pqueue_pop(s->d1->buffered_messages);
 620
 621         al = dtls1_preprocess_fragment(s, &frag->msg_header, max);
 622
 623         if (al == 0) {          /* no alert */
 624             unsigned char *p =
 625                 (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 626             memcpy(&p[frag->msg_header.frag_off], frag->fragment,
 627                    frag->msg_header.frag_len);
 628         }
 629
 630         dtls1_hm_fragment_free(frag);
 631         pitem_free(item);
 632
 633         if (al == 0) {
 634             *ok = 1;
 635             return frag_len;
 636         }
 637
 638         ssl3_send_alert(s, SSL3_AL_FATAL, al);
 639         s->init_num = 0;
 640         *ok = 0;
 641         return -1;
 642     } else
 643         return 0;
 644 }
 645
 646 /*
 647  * dtls1_max_handshake_message_len returns the maximum number of bytes
 648  * permitted in a DTLS handshake message for |s|. The minimum is 16KB, but
 649  * may be greater if the maximum certificate list size requires it.
 650  */
 651 static unsigned long dtls1_max_handshake_message_len(const SSL *s)
 652 {
 653     unsigned long max_len =
 654         DTLS1_HM_HEADER_LENGTH + SSL3_RT_MAX_ENCRYPTED_LENGTH;
 655     if (max_len < (unsigned long)s->max_cert_list)
 656         return s->max_cert_list;
 657     return max_len;
 658 }
 659
 660 static int
 661 dtls1_reassemble_fragment(SSL *s, const struct hm_header_st *msg_hdr, int *ok)
 662 {
 663     hm_fragment *frag = NULL;
 664     pitem *item = NULL;
 665     int i = -1, is_complete;
 666     unsigned char seq64be[8];
 667     unsigned long frag_len = msg_hdr->frag_len;
 668
 669     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len ||
 670         msg_hdr->msg_len > dtls1_max_handshake_message_len(s))
 671         goto err;
 672
 673     if (frag_len == 0)
 674         return DTLS1_HM_FRAGMENT_RETRY;
 675
 676     /* Try to find item in queue */
 677     memset(seq64be, 0, sizeof(seq64be));
 678     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 679     seq64be[7] = (unsigned char)msg_hdr->seq;
 680     item = pqueue_find(s->d1->buffered_messages, seq64be);
 681
 682     if (item == NULL) {
 683         frag = dtls1_hm_fragment_new(msg_hdr->msg_len, 1);
 684         if (frag == NULL)
 685             goto err;
 686         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 687         frag->msg_header.frag_len = frag->msg_header.msg_len;
 688         frag->msg_header.frag_off = 0;
 689     } else {
 690         frag = (hm_fragment *)item->data;
 691         if (frag->msg_header.msg_len != msg_hdr->msg_len) {
 692             item = NULL;
 693             frag = NULL;
 694             goto err;
 695         }
 696     }
 697
 698     /*
 699      * If message is already reassembled, this must be a retransmit and can
 700      * be dropped. In this case item != NULL and so frag does not need to be
 701      * freed.
 702      */
 703     if (frag->reassembly == NULL) {
 704         unsigned char devnull[256];
 705
 706         while (frag_len) {
 707             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 708                                           devnull,
 709                                           frag_len >
 710                                           sizeof(devnull) ? sizeof(devnull) :
 711                                           frag_len, 0);
 712             if (i <= 0)
 713                 goto err;
 714             frag_len -= i;
 715         }
 716         return DTLS1_HM_FRAGMENT_RETRY;
 717     }
 718
 719     /* read the body of the fragment (header has already been read */
 720     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 721                                   frag->fragment + msg_hdr->frag_off,
 722                                   frag_len, 0);
 723     if ((unsigned long)i != frag_len)
 724         i = -1;
 725     if (i <= 0)
 726         goto err;
 727
 728     RSMBLY_BITMASK_MARK(frag->reassembly, (long)msg_hdr->frag_off,
 729                         (long)(msg_hdr->frag_off + frag_len));
 730
 731     RSMBLY_BITMASK_IS_COMPLETE(frag->reassembly, (long)msg_hdr->msg_len,
 732                                is_complete);
 733
 734     if (is_complete) {
 735         OPENSSL_free(frag->reassembly);
 736         frag->reassembly = NULL;
 737     }
 738
 739     if (item == NULL) {
 740         item = pitem_new(seq64be, frag);
 741         if (item == NULL) {
 742             i = -1;
 743             goto err;
 744         }
 745
 746         item = pqueue_insert(s->d1->buffered_messages, item);
 747         /*
 748          * pqueue_insert fails iff a duplicate item is inserted. However,
 749          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 750          * would have returned it and control would never have reached this
 751          * branch.
 752          */
 753         OPENSSL_assert(item != NULL);
 754     }
 755
 756     return DTLS1_HM_FRAGMENT_RETRY;
 757
 758  err:
 759     if (item == NULL)
 760         dtls1_hm_fragment_free(frag);
 761     *ok = 0;
 762     return i;
 763 }
 764
 765 static int
 766 dtls1_process_out_of_seq_message(SSL *s, const struct hm_header_st *msg_hdr,
 767                                  int *ok)
 768 {
 769     int i = -1;
 770     hm_fragment *frag = NULL;
 771     pitem *item = NULL;
 772     unsigned char seq64be[8];
 773     unsigned long frag_len = msg_hdr->frag_len;
 774
 775     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len)
 776         goto err;
 777
 778     /* Try to find item in queue, to prevent duplicate entries */
 779     memset(seq64be, 0, sizeof(seq64be));
 780     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 781     seq64be[7] = (unsigned char)msg_hdr->seq;
 782     item = pqueue_find(s->d1->buffered_messages, seq64be);
 783
 784     /*
 785      * If we already have an entry and this one is a fragment, don't discard
 786      * it and rather try to reassemble it.
 787      */
 788     if (item != NULL && frag_len != msg_hdr->msg_len)
 789         item = NULL;
 790
 791     /*
 792      * Discard the message if sequence number was already there, is too far
 793      * in the future, already in the queue or if we received a FINISHED
 794      * before the SERVER_HELLO, which then must be a stale retransmit.
 795      */
 796     if (msg_hdr->seq <= s->d1->handshake_read_seq ||
 797         msg_hdr->seq > s->d1->handshake_read_seq + 10 || item != NULL ||
 798         (s->d1->handshake_read_seq == 0 && msg_hdr->type == SSL3_MT_FINISHED))
 799     {
 800         unsigned char devnull[256];
 801
 802         while (frag_len) {
 803             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 804                                           devnull,
 805                                           frag_len >
 806                                           sizeof(devnull) ? sizeof(devnull) :
 807                                           frag_len, 0);
 808             if (i <= 0)
 809                 goto err;
 810             frag_len -= i;
 811         }
 812     } else {
 813         if (frag_len != msg_hdr->msg_len)
 814             return dtls1_reassemble_fragment(s, msg_hdr, ok);
 815
 816         if (frag_len > dtls1_max_handshake_message_len(s))
 817             goto err;
 818
 819         frag = dtls1_hm_fragment_new(frag_len, 0);
 820         if (frag == NULL)
 821             goto err;
 822
 823         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 824
 825         if (frag_len) {
 826             /*
 827              * read the body of the fragment (header has already been read
 828              */
 829             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 830                                           frag->fragment, frag_len, 0);
 831             if ((unsigned long)i != frag_len)
 832                 i = -1;
 833             if (i <= 0)
 834                 goto err;
 835         }
 836
 837         item = pitem_new(seq64be, frag);
 838         if (item == NULL)
 839             goto err;
 840
 841         item = pqueue_insert(s->d1->buffered_messages, item);
 842         /*
 843          * pqueue_insert fails iff a duplicate item is inserted. However,
 844          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 845          * would have returned it. Then, either |frag_len| !=
 846          * |msg_hdr->msg_len| in which case |item| is set to NULL and it will
 847          * have been processed with |dtls1_reassemble_fragment|, above, or
 848          * the record will have been discarded.
 849          */
 850         OPENSSL_assert(item != NULL);
 851     }
 852
 853     return DTLS1_HM_FRAGMENT_RETRY;
 854
 855  err:
 856     if (item == NULL)
 857         dtls1_hm_fragment_free(frag);
 858     *ok = 0;
 859     return i;
 860 }
 861
 862 static long
 863 dtls1_get_message_fragment(SSL *s, int st1, int stn, int mt, long max, int *ok)
 864 {
 865     unsigned char wire[DTLS1_HM_HEADER_LENGTH];
 866     unsigned long len, frag_off, frag_len;
 867     int i, al, recvd_type;
 868     struct hm_header_st msg_hdr;
 869
 870  redo:
 871     /* see if we have the required fragment already */
 872     if ((frag_len = dtls1_retrieve_buffered_fragment(s, max, ok)) || *ok) {
 873         if (*ok)
 874             s->init_num = frag_len;
 875         return frag_len;
 876     }
 877
 878     /* read handshake message header */
 879     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type, wire,
 880                                   DTLS1_HM_HEADER_LENGTH, 0);
 881     if (i <= 0) {               /* nbio, or an error */
 882         s->rwstate = SSL_READING;
 883         *ok = 0;
 884         return i;
 885     }
 886     if(recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
 887         /* This isn't a real handshake message - its a CCS.
 888          * There is no message sequence number in a CCS to give us confidence
 889          * that this was really intended to be at this point in the handshake
 890          * sequence. Therefore we only allow this if we were explicitly looking
 891          * for it (i.e. if |mt| is -1 we still don't allow it).
 892          */
 893         if(mt == SSL3_MT_CHANGE_CIPHER_SPEC) {
 894             if (wire[0] != SSL3_MT_CCS) {
 895                 al = SSL_AD_UNEXPECTED_MESSAGE;
 896                 SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL_R_BAD_CHANGE_CIPHER_SPEC);
 897                 goto f_err;
 898             }
 899
 900             memcpy(s->init_buf->data, wire, i);
 901             s->init_num = i - 1;
 902             s->init_msg = s->init_buf->data + 1;
 903             s->s3->tmp.message_type = SSL3_MT_CHANGE_CIPHER_SPEC;
 904             s->s3->tmp.message_size = i - 1;
 905             s->state = stn;
 906             *ok = 1;
 907             return i-1;
 908         } else {
 909             /*
 910              * We weren't expecting a CCS yet. Probably something got
 911              * re-ordered or this is a retransmit. We should drop this and try
 912              * again.
 913              */
 914             s->init_num = 0;
 915             goto redo;
 916         }
 917     }
 918
 919     /* Handshake fails if message header is incomplete */
 920     if (i != DTLS1_HM_HEADER_LENGTH) {
 921         al = SSL_AD_UNEXPECTED_MESSAGE;
 922         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL_R_UNEXPECTED_MESSAGE);
 923         goto f_err;
 924     }
 925
 926     /* parse the message fragment header */
 927     dtls1_get_message_header(wire, &msg_hdr);
 928
 929     len = msg_hdr.msg_len;
 930     frag_off = msg_hdr.frag_off;
 931     frag_len = msg_hdr.frag_len;
 932
 933     /*
 934      * We must have at least frag_len bytes left in the record to be read.
 935      * Fragments must not span records.
 936      */
 937     if (frag_len > RECORD_LAYER_get_rrec_length(&s->rlayer)) {
 938         al = SSL3_AD_ILLEGAL_PARAMETER;
 939         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL_R_BAD_LENGTH);
 940         goto f_err;
 941     }
 942
 943     /*
 944      * if this is a future (or stale) message it gets buffered
 945      * (or dropped)--no further processing at this time
 946      * While listening, we accept seq 1 (ClientHello with cookie)
 947      * although we're still expecting seq 0 (ClientHello)
 948      */
 949     if (msg_hdr.seq != s->d1->handshake_read_seq
 950         && !(s->d1->listen && msg_hdr.seq == 1))
 951         return dtls1_process_out_of_seq_message(s, &msg_hdr, ok);
 952
 953     if (frag_len && frag_len < len)
 954         return dtls1_reassemble_fragment(s, &msg_hdr, ok);
 955
 956     if (!s->server && s->d1->r_msg_hdr.frag_off == 0 &&
 957         wire[0] == SSL3_MT_HELLO_REQUEST) {
 958         /*
 959          * The server may always send 'Hello Request' messages -- we are
 960          * doing a handshake anyway now, so ignore them if their format is
 961          * correct. Does not count for 'Finished' MAC.
 962          */
 963         if (wire[1] == 0 && wire[2] == 0 && wire[3] == 0) {
 964             if (s->msg_callback)
 965                 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 966                                 wire, DTLS1_HM_HEADER_LENGTH, s,
 967                                 s->msg_callback_arg);
 968
 969             s->init_num = 0;
 970             goto redo;
 971         } else {                /* Incorrectly formated Hello request */
 972
 973             al = SSL_AD_UNEXPECTED_MESSAGE;
 974             SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT,
 975                    SSL_R_UNEXPECTED_MESSAGE);
 976             goto f_err;
 977         }
 978     }
 979
 980     if ((al = dtls1_preprocess_fragment(s, &msg_hdr, max)))
 981         goto f_err;
 982
 983     if (frag_len > 0) {
 984         unsigned char *p =
 985             (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 986
 987         i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 988                                       &p[frag_off], frag_len, 0);
 989
 990         /*
 991          * This shouldn't ever fail due to NBIO because we already checked
 992          * that we have enough data in the record
 993          */
 994         if (i <= 0) {
 995             s->rwstate = SSL_READING;
 996             *ok = 0;
 997             return i;
 998         }
 999     } else
1000         i = 0;
1001
1002     /*
1003      * XDTLS: an incorrectly formatted fragment should cause the handshake
1004      * to fail
1005      */
1006     if (i != (int)frag_len) {
1007         al = SSL3_AD_ILLEGAL_PARAMETER;
1008         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL3_AD_ILLEGAL_PARAMETER);
1009         goto f_err;
1010     }
1011
1012     *ok = 1;
1013     s->state = stn;
1014
1015     /*
1016      * Note that s->init_num is *not* used as current offset in
1017      * s->init_buf->data, but as a counter summing up fragments' lengths: as
1018      * soon as they sum up to handshake packet length, we assume we have got
1019      * all the fragments.
1020      */
1021     s->init_num = frag_len;
1022     return frag_len;
1023
1024  f_err:
1025     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1026     s->init_num = 0;
1027
1028     *ok = 0;
1029     return (-1);
1030 }
1031
1032 /*-
1033  * for these 2 messages, we need to
1034  * ssl->enc_read_ctx                    re-init
1035  * ssl->rlayer.read_sequence            zero
1036  * ssl->s3->read_mac_secret             re-init
1037  * ssl->session->read_sym_enc           assign
1038  * ssl->session->read_compression       assign
1039  * ssl->session->read_hash              assign
1040  */
1041 int dtls1_send_change_cipher_spec(SSL *s, int a, int b)
1042 {
1043     unsigned char *p;
1044
1045     if (s->state == a) {
1046         p = (unsigned char *)s->init_buf->data;
1047         *p++ = SSL3_MT_CCS;
1048         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1049         s->init_num = DTLS1_CCS_HEADER_LENGTH;
1050
1051         if (s->version == DTLS1_BAD_VER) {
1052             s->d1->next_handshake_write_seq++;
1053             s2n(s->d1->handshake_write_seq, p);
1054             s->init_num += 2;
1055         }
1056
1057         s->init_off = 0;
1058
1059         dtls1_set_message_header_int(s, SSL3_MT_CCS, 0,
1060                                      s->d1->handshake_write_seq, 0, 0);
1061
1062         /* buffer the message to handle re-xmits */
1063         if (!dtls1_buffer_message(s, 1)) {
1064             SSLerr(SSL_F_DTLS1_SEND_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
1065             return -1;
1066         }
1067
1068         s->state = b;
1069     }
1070
1071     /* SSL3_ST_CW_CHANGE_B */
1072     return (dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC));
1073 }
1074
1075 int dtls1_read_failed(SSL *s, int code)
1076 {
1077     if (code > 0) {
1078         fprintf(stderr, "invalid state reached %s:%d", __FILE__, __LINE__);
1079         return 1;
1080     }
1081
1082     if (!dtls1_is_timer_expired(s)) {
1083         /*
1084          * not a timeout, none of our business, let higher layers handle
1085          * this.  in fact it's probably an error
1086          */
1087         return code;
1088     }
1089 #ifndef OPENSSL_NO_HEARTBEATS
1090     /* done, no need to send a retransmit */
1091     if (!SSL_in_init(s) && !s->tlsext_hb_pending)
1092 #else
1093     /* done, no need to send a retransmit */
1094     if (!SSL_in_init(s))
1095 #endif
1096     {
1097         BIO_set_flags(SSL_get_rbio(s), BIO_FLAGS_READ);
1098         return code;
1099     }
1100
1101     return dtls1_handle_timeout(s);
1102 }
1103
1104 int dtls1_get_queue_priority(unsigned short seq, int is_ccs)
1105 {
1106     /*
1107      * The index of the retransmission queue actually is the message sequence
1108      * number, since the queue only contains messages of a single handshake.
1109      * However, the ChangeCipherSpec has no message sequence number and so
1110      * using only the sequence will result in the CCS and Finished having the
1111      * same index. To prevent this, the sequence number is multiplied by 2.
1112      * In case of a CCS 1 is subtracted. This does not only differ CSS and
1113      * Finished, it also maintains the order of the index (important for
1114      * priority queues) and fits in the unsigned short variable.
1115      */
1116     return seq * 2 - is_ccs;
1117 }
1118
1119 int dtls1_retransmit_buffered_messages(SSL *s)
1120 {
1121     pqueue sent = s->d1->sent_messages;
1122     piterator iter;
1123     pitem *item;
1124     hm_fragment *frag;
1125     int found = 0;
1126
1127     iter = pqueue_iterator(sent);
1128
1129     for (item = pqueue_next(&iter); item != NULL; item = pqueue_next(&iter)) {
1130         frag = (hm_fragment *)item->data;
1131         if (dtls1_retransmit_message(s, (unsigned short)
1132                                      dtls1_get_queue_priority
1133                                      (frag->msg_header.seq,
1134                                       frag->msg_header.is_ccs), 0,
1135                                      &found) <= 0 && found) {
1136             fprintf(stderr, "dtls1_retransmit_message() failed\n");
1137             return -1;
1138         }
1139     }
1140
1141     return 1;
1142 }
1143
1144 int dtls1_buffer_message(SSL *s, int is_ccs)
1145 {
1146     pitem *item;
1147     hm_fragment *frag;
1148     unsigned char seq64be[8];
1149
1150     /*
1151      * this function is called immediately after a message has been
1152      * serialized
1153      */
1154     OPENSSL_assert(s->init_off == 0);
1155
1156     frag = dtls1_hm_fragment_new(s->init_num, 0);
1157     if (!frag)
1158         return 0;
1159
1160     memcpy(frag->fragment, s->init_buf->data, s->init_num);
1161
1162     if (is_ccs) {
1163         /* For DTLS1_BAD_VER the header length is non-standard */
1164         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1165                        ((s->version==DTLS1_BAD_VER)?3:DTLS1_CCS_HEADER_LENGTH)
1166                        == (unsigned int)s->init_num);
1167     } else {
1168         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1169                        DTLS1_HM_HEADER_LENGTH == (unsigned int)s->init_num);
1170     }
1171
1172     frag->msg_header.msg_len = s->d1->w_msg_hdr.msg_len;
1173     frag->msg_header.seq = s->d1->w_msg_hdr.seq;
1174     frag->msg_header.type = s->d1->w_msg_hdr.type;
1175     frag->msg_header.frag_off = 0;
1176     frag->msg_header.frag_len = s->d1->w_msg_hdr.msg_len;
1177     frag->msg_header.is_ccs = is_ccs;
1178
1179     /* save current state */
1180     frag->msg_header.saved_retransmit_state.enc_write_ctx = s->enc_write_ctx;
1181     frag->msg_header.saved_retransmit_state.write_hash = s->write_hash;
1182     frag->msg_header.saved_retransmit_state.compress = s->compress;
1183     frag->msg_header.saved_retransmit_state.session = s->session;
1184     frag->msg_header.saved_retransmit_state.epoch =
1185         DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1186
1187     memset(seq64be, 0, sizeof(seq64be));
1188     seq64be[6] =
1189         (unsigned
1190          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1191                                         frag->msg_header.is_ccs) >> 8);
1192     seq64be[7] =
1193         (unsigned
1194          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1195                                         frag->msg_header.is_ccs));
1196
1197     item = pitem_new(seq64be, frag);
1198     if (item == NULL) {
1199         dtls1_hm_fragment_free(frag);
1200         return 0;
1201     }
1202
1203     pqueue_insert(s->d1->sent_messages, item);
1204     return 1;
1205 }
1206
1207 int
1208 dtls1_retransmit_message(SSL *s, unsigned short seq, unsigned long frag_off,
1209                          int *found)
1210 {
1211     int ret;
1212     /* XDTLS: for now assuming that read/writes are blocking */
1213     pitem *item;
1214     hm_fragment *frag;
1215     unsigned long header_length;
1216     unsigned char seq64be[8];
1217     struct dtls1_retransmit_state saved_state;
1218
1219     /*-
1220       OPENSSL_assert(s->init_num == 0);
1221       OPENSSL_assert(s->init_off == 0);
1222      */
1223
1224     /* XDTLS:  the requested message ought to be found, otherwise error */
1225     memset(seq64be, 0, sizeof(seq64be));
1226     seq64be[6] = (unsigned char)(seq >> 8);
1227     seq64be[7] = (unsigned char)seq;
1228
1229     item = pqueue_find(s->d1->sent_messages, seq64be);
1230     if (item == NULL) {
1231         fprintf(stderr, "retransmit:  message %d non-existant\n", seq);
1232         *found = 0;
1233         return 0;
1234     }
1235
1236     *found = 1;
1237     frag = (hm_fragment *)item->data;
1238
1239     if (frag->msg_header.is_ccs)
1240         header_length = DTLS1_CCS_HEADER_LENGTH;
1241     else
1242         header_length = DTLS1_HM_HEADER_LENGTH;
1243
1244     memcpy(s->init_buf->data, frag->fragment,
1245            frag->msg_header.msg_len + header_length);
1246     s->init_num = frag->msg_header.msg_len + header_length;
1247
1248     dtls1_set_message_header_int(s, frag->msg_header.type,
1249                                  frag->msg_header.msg_len,
1250                                  frag->msg_header.seq, 0,
1251                                  frag->msg_header.frag_len);
1252
1253     /* save current state */
1254     saved_state.enc_write_ctx = s->enc_write_ctx;
1255     saved_state.write_hash = s->write_hash;
1256     saved_state.compress = s->compress;
1257     saved_state.session = s->session;
1258     saved_state.epoch = DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1259
1260     s->d1->retransmitting = 1;
1261
1262     /* restore state in which the message was originally sent */
1263     s->enc_write_ctx = frag->msg_header.saved_retransmit_state.enc_write_ctx;
1264     s->write_hash = frag->msg_header.saved_retransmit_state.write_hash;
1265     s->compress = frag->msg_header.saved_retransmit_state.compress;
1266     s->session = frag->msg_header.saved_retransmit_state.session;
1267     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer,
1268         frag->msg_header.saved_retransmit_state.epoch);
1269
1270     ret = dtls1_do_write(s, frag->msg_header.is_ccs ?
1271                          SSL3_RT_CHANGE_CIPHER_SPEC : SSL3_RT_HANDSHAKE);
1272
1273     /* restore current state */
1274     s->enc_write_ctx = saved_state.enc_write_ctx;
1275     s->write_hash = saved_state.write_hash;
1276     s->compress = saved_state.compress;
1277     s->session = saved_state.session;
1278     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer, saved_state.epoch);
1279
1280     s->d1->retransmitting = 0;
1281
1282     (void)BIO_flush(SSL_get_wbio(s));
1283     return ret;
1284 }
1285
1286 /* call this function when the buffered messages are no longer needed */
1287 void dtls1_clear_record_buffer(SSL *s)
1288 {
1289     pitem *item;
1290
1291     for (item = pqueue_pop(s->d1->sent_messages);
1292          item != NULL; item = pqueue_pop(s->d1->sent_messages)) {
1293         dtls1_hm_fragment_free((hm_fragment *)item->data);
1294         pitem_free(item);
1295     }
1296 }
1297
1298 void dtls1_set_message_header(SSL *s, unsigned char *p,
1299                                         unsigned char mt, unsigned long len,
1300                                         unsigned long frag_off,
1301                                         unsigned long frag_len)
1302 {
1303     /* Don't change sequence numbers while listening */
1304     if (frag_off == 0 && !s->d1->listen) {
1305         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1306         s->d1->next_handshake_write_seq++;
1307     }
1308
1309     dtls1_set_message_header_int(s, mt, len, s->d1->handshake_write_seq,
1310                                  frag_off, frag_len);
1311 }
1312
1313 /* don't actually do the writing, wait till the MTU has been retrieved */
1314 static void
1315 dtls1_set_message_header_int(SSL *s, unsigned char mt,
1316                              unsigned long len, unsigned short seq_num,
1317                              unsigned long frag_off, unsigned long frag_len)
1318 {
1319     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1320
1321     msg_hdr->type = mt;
1322     msg_hdr->msg_len = len;
1323     msg_hdr->seq = seq_num;
1324     msg_hdr->frag_off = frag_off;
1325     msg_hdr->frag_len = frag_len;
1326 }
1327
1328 static void
1329 dtls1_fix_message_header(SSL *s, unsigned long frag_off,
1330                          unsigned long frag_len)
1331 {
1332     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1333
1334     msg_hdr->frag_off = frag_off;
1335     msg_hdr->frag_len = frag_len;
1336 }
1337
1338 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p)
1339 {
1340     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1341
1342     *p++ = msg_hdr->type;
1343     l2n3(msg_hdr->msg_len, p);
1344
1345     s2n(msg_hdr->seq, p);
1346     l2n3(msg_hdr->frag_off, p);
1347     l2n3(msg_hdr->frag_len, p);
1348
1349     return p;
1350 }
1351
1352 unsigned int dtls1_link_min_mtu(void)
1353 {
1354     return (g_probable_mtu[(sizeof(g_probable_mtu) /
1355                             sizeof(g_probable_mtu[0])) - 1]);
1356 }
1357
1358 unsigned int dtls1_min_mtu(SSL *s)
1359 {
1360     return dtls1_link_min_mtu() - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
1361 }
1362
1363 void
1364 dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr)
1365 {
1366     memset(msg_hdr, 0, sizeof(*msg_hdr));
1367     msg_hdr->type = *(data++);
1368     n2l3(data, msg_hdr->msg_len);
1369
1370     n2s(data, msg_hdr->seq);
1371     n2l3(data, msg_hdr->frag_off);
1372     n2l3(data, msg_hdr->frag_len);
1373 }
1374
1375 int dtls1_shutdown(SSL *s)
1376 {
1377     int ret;
1378 #ifndef OPENSSL_NO_SCTP
1379     BIO *wbio;
1380
1381     wbio = SSL_get_wbio(s);
1382     if (wbio != NULL && BIO_dgram_is_sctp(wbio) &&
1383         !(s->shutdown & SSL_SENT_SHUTDOWN)) {
1384         ret = BIO_dgram_sctp_wait_for_dry(wbio);
1385         if (ret < 0)
1386             return -1;
1387
1388         if (ret == 0)
1389             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 1,
1390                      NULL);
1391     }
1392 #endif
1393     ret = ssl3_shutdown(s);
1394 #ifndef OPENSSL_NO_SCTP
1395     BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 0, NULL);
1396 #endif
1397     return ret;
1398 }
1399
1400 #ifndef OPENSSL_NO_HEARTBEATS
1401 int dtls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length)
1402 {
1403     unsigned char *pl;
1404     unsigned short hbtype;
1405     unsigned int payload;
1406     unsigned int padding = 16;  /* Use minimum padding */
1407
1408     if (s->msg_callback)
1409         s->msg_callback(0, s->version, TLS1_RT_HEARTBEAT,
1410                         p, length, s, s->msg_callback_arg);
1411
1412     /* Read type and payload length first */
1413     if (1 + 2 + 16 > length)
1414         return 0;               /* silently discard */
1415     if (length > SSL3_RT_MAX_PLAIN_LENGTH)
1416         return 0;               /* silently discard per RFC 6520 sec. 4 */
1417
1418     hbtype = *p++;
1419     n2s(p, payload);
1420     if (1 + 2 + payload + 16 > length)
1421         return 0;               /* silently discard per RFC 6520 sec. 4 */
1422     pl = p;
1423
1424     if (hbtype == TLS1_HB_REQUEST) {
1425         unsigned char *buffer, *bp;
1426         unsigned int write_length = 1 /* heartbeat type */  +
1427             2 /* heartbeat length */  +
1428             payload + padding;
1429         int r;
1430
1431         if (write_length > SSL3_RT_MAX_PLAIN_LENGTH)
1432             return 0;
1433
1434         /*
1435          * Allocate memory for the response, size is 1 byte message type,
1436          * plus 2 bytes payload length, plus payload, plus padding
1437          */
1438         buffer = OPENSSL_malloc(write_length);
1439         if (buffer == NULL)
1440             return -1;
1441         bp = buffer;
1442
1443         /* Enter response type, length and copy payload */
1444         *bp++ = TLS1_HB_RESPONSE;
1445         s2n(payload, bp);
1446         memcpy(bp, pl, payload);
1447         bp += payload;
1448         /* Random padding */
1449         if (RAND_bytes(bp, padding) <= 0) {
1450             OPENSSL_free(buffer);
1451             return -1;
1452         }
1453
1454         r = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buffer, write_length);
1455
1456         if (r >= 0 && s->msg_callback)
1457             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
1458                             buffer, write_length, s, s->msg_callback_arg);
1459
1460         OPENSSL_free(buffer);
1461
1462         if (r < 0)
1463             return r;
1464     } else if (hbtype == TLS1_HB_RESPONSE) {
1465         unsigned int seq;
1466
1467         /*
1468          * We only send sequence numbers (2 bytes unsigned int), and 16
1469          * random bytes, so we just try to read the sequence number
1470          */
1471         n2s(pl, seq);
1472
1473         if (payload == 18 && seq == s->tlsext_hb_seq) {
1474             dtls1_stop_timer(s);
1475             s->tlsext_hb_seq++;
1476             s->tlsext_hb_pending = 0;
1477         }
1478     }
1479
1480     return 0;
1481 }
1482
1483 int dtls1_heartbeat(SSL *s)
1484 {
1485     unsigned char *buf, *p;
1486     int ret = -1;
1487     unsigned int payload = 18;  /* Sequence number + random bytes */
1488     unsigned int padding = 16;  /* Use minimum padding */
1489
1490     /* Only send if peer supports and accepts HB requests... */
1491     if (!(s->tlsext_heartbeat & SSL_TLSEXT_HB_ENABLED) ||
1492         s->tlsext_heartbeat & SSL_TLSEXT_HB_DONT_SEND_REQUESTS) {
1493         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PEER_DOESNT_ACCEPT);
1494         return -1;
1495     }
1496
1497     /* ...and there is none in flight yet... */
1498     if (s->tlsext_hb_pending) {
1499         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PENDING);
1500         return -1;
1501     }
1502
1503     /* ...and no handshake in progress. */
1504     if (SSL_in_init(s) || s->in_handshake) {
1505         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_UNEXPECTED_MESSAGE);
1506         return -1;
1507     }
1508
1509     /*
1510      * Check if padding is too long, payload and padding must not exceed 2^14
1511      * - 3 = 16381 bytes in total.
1512      */
1513     OPENSSL_assert(payload + padding <= 16381);
1514
1515     /*-
1516      * Create HeartBeat message, we just use a sequence number
1517      * as payload to distuingish different messages and add
1518      * some random stuff.
1519      *  - Message Type, 1 byte
1520      *  - Payload Length, 2 bytes (unsigned int)
1521      *  - Payload, the sequence number (2 bytes uint)
1522      *  - Payload, random bytes (16 bytes uint)
1523      *  - Padding
1524      */
1525     buf = OPENSSL_malloc(1 + 2 + payload + padding);
1526     if (buf == NULL) {
1527         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_MALLOC_FAILURE);
1528         return -1;
1529     }
1530     p = buf;
1531     /* Message Type */
1532     *p++ = TLS1_HB_REQUEST;
1533     /* Payload length (18 bytes here) */
1534     s2n(payload, p);
1535     /* Sequence number */
1536     s2n(s->tlsext_hb_seq, p);
1537     /* 16 random bytes */
1538     if (RAND_bytes(p, 16) <= 0) {
1539         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1540         goto err;
1541     }
1542     p += 16;
1543     /* Random padding */
1544     if (RAND_bytes(p, padding) <= 0) {
1545         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1546         goto err;
1547     }
1548
1549     ret = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buf, 3 + payload + padding);
1550     if (ret >= 0) {
1551         if (s->msg_callback)
1552             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
1553                             buf, 3 + payload + padding,
1554                             s, s->msg_callback_arg);
1555
1556         dtls1_start_timer(s);
1557         s->tlsext_hb_pending = 1;
1558     }
1559
1560  err:
1561     OPENSSL_free(buf);
1562
1563     return ret;
1564 }
1565 #endif