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, long max,
 164                                        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_malloc(RSMBLY_BITMASK_SIZE(frag_len));
 191         if (bitmask == NULL) {
 192             OPENSSL_free(buf);
 193             OPENSSL_free(frag);
 194             return NULL;
 195         }
 196         memset(bitmask, 0, RSMBLY_BITMASK_SIZE(frag_len));
 197     }
 198
 199     frag->reassembly = bitmask;
 200
 201     return frag;
 202 }
 203
 204 void dtls1_hm_fragment_free(hm_fragment *frag)
 205 {
 206     if (!frag)
 207         return;
 208     if (frag->msg_header.is_ccs) {
 209         EVP_CIPHER_CTX_free(frag->msg_header.
 210                             saved_retransmit_state.enc_write_ctx);
 211         EVP_MD_CTX_destroy(frag->msg_header.
 212                            saved_retransmit_state.write_hash);
 213     }
 214     OPENSSL_free(frag->fragment);
 215     OPENSSL_free(frag->reassembly);
 216     OPENSSL_free(frag);
 217 }
 218
 219 static int dtls1_query_mtu(SSL *s)
 220 {
 221     if (s->d1->link_mtu) {
 222         s->d1->mtu =
 223             s->d1->link_mtu - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
 224         s->d1->link_mtu = 0;
 225     }
 226
 227     /* AHA!  Figure out the MTU, and stick to the right size */
 228     if (s->d1->mtu < dtls1_min_mtu(s)) {
 229         if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
 230             s->d1->mtu =
 231                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
 232
 233             /*
 234              * I've seen the kernel return bogus numbers when it doesn't know
 235              * (initial write), so just make sure we have a reasonable number
 236              */
 237             if (s->d1->mtu < dtls1_min_mtu(s)) {
 238                 /* Set to min mtu */
 239                 s->d1->mtu = dtls1_min_mtu(s);
 240                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SET_MTU,
 241                          s->d1->mtu, NULL);
 242             }
 243         } else
 244             return 0;
 245     }
 246     return 1;
 247 }
 248
 249 /*
 250  * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
 251  * SSL3_RT_CHANGE_CIPHER_SPEC)
 252  */
 253 int dtls1_do_write(SSL *s, int type)
 254 {
 255     int ret;
 256     unsigned int curr_mtu;
 257     int retry = 1;
 258     unsigned int len, frag_off, mac_size, blocksize, used_len;
 259
 260     if (!dtls1_query_mtu(s))
 261         return -1;
 262
 263     OPENSSL_assert(s->d1->mtu >= dtls1_min_mtu(s)); /* should have something
 264                                                      * reasonable now */
 265
 266     if (s->init_off == 0 && type == SSL3_RT_HANDSHAKE)
 267         OPENSSL_assert(s->init_num ==
 268                        (int)s->d1->w_msg_hdr.msg_len +
 269                        DTLS1_HM_HEADER_LENGTH);
 270
 271     if (s->write_hash) {
 272         if (s->enc_write_ctx
 273             && EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_GCM_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         s->s3->tmp.reuse_message = 0;
 458         if ((mt >= 0) && (s->s3->tmp.message_type != mt)) {
 459             al = SSL_AD_UNEXPECTED_MESSAGE;
 460             SSLerr(SSL_F_DTLS1_GET_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
 461             goto f_err;
 462         }
 463         *ok = 1;
 464         s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 465         s->init_num = (int)s->s3->tmp.message_size;
 466         return s->init_num;
 467     }
 468
 469     msg_hdr = &s->d1->r_msg_hdr;
 470     memset(msg_hdr, 0x00, sizeof(struct hm_header_st));
 471
 472  again:
 473     i = dtls1_get_message_fragment(s, st1, stn, max, ok);
 474     if (i == DTLS1_HM_BAD_FRAGMENT || i == DTLS1_HM_FRAGMENT_RETRY) {
 475         /* bad fragment received */
 476         goto again;
 477     } else if (i <= 0 && !*ok) {
 478         return i;
 479     }
 480
 481     p = (unsigned char *)s->init_buf->data;
 482     msg_len = msg_hdr->msg_len;
 483
 484     /* reconstruct message header */
 485     *(p++) = msg_hdr->type;
 486     l2n3(msg_len, p);
 487     s2n(msg_hdr->seq, p);
 488     l2n3(0, p);
 489     l2n3(msg_len, p);
 490     if (s->version != DTLS1_BAD_VER) {
 491         p -= DTLS1_HM_HEADER_LENGTH;
 492         msg_len += DTLS1_HM_HEADER_LENGTH;
 493     }
 494
 495     ssl3_finish_mac(s, p, msg_len);
 496     if (s->msg_callback)
 497         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 498                         p, msg_len, s, s->msg_callback_arg);
 499
 500     memset(msg_hdr, 0x00, sizeof(struct hm_header_st));
 501
 502     /* Don't change sequence numbers while listening */
 503     if (!s->d1->listen)
 504         s->d1->handshake_read_seq++;
 505
 506     s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 507     return s->init_num;
 508
 509  f_err:
 510     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 511     *ok = 0;
 512     return -1;
 513 }
 514
 515 static int dtls1_preprocess_fragment(SSL *s, struct hm_header_st *msg_hdr,
 516                                      int max)
 517 {
 518     size_t frag_off, frag_len, msg_len;
 519
 520     msg_len = msg_hdr->msg_len;
 521     frag_off = msg_hdr->frag_off;
 522     frag_len = msg_hdr->frag_len;
 523
 524     /* sanity checking */
 525     if ((frag_off + frag_len) > msg_len) {
 526         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 527         return SSL_AD_ILLEGAL_PARAMETER;
 528     }
 529
 530     if ((frag_off + frag_len) > (unsigned long)max) {
 531         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 532         return SSL_AD_ILLEGAL_PARAMETER;
 533     }
 534
 535     if (s->d1->r_msg_hdr.frag_off == 0) { /* first fragment */
 536         /*
 537          * msg_len is limited to 2^24, but is effectively checked against max
 538          * above
 539          */
 540         if (!BUF_MEM_grow_clean
 541             (s->init_buf, msg_len + DTLS1_HM_HEADER_LENGTH)) {
 542             SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, ERR_R_BUF_LIB);
 543             return SSL_AD_INTERNAL_ERROR;
 544         }
 545
 546         s->s3->tmp.message_size = msg_len;
 547         s->d1->r_msg_hdr.msg_len = msg_len;
 548         s->s3->tmp.message_type = msg_hdr->type;
 549         s->d1->r_msg_hdr.type = msg_hdr->type;
 550         s->d1->r_msg_hdr.seq = msg_hdr->seq;
 551     } else if (msg_len != s->d1->r_msg_hdr.msg_len) {
 552         /*
 553          * They must be playing with us! BTW, failure to enforce upper limit
 554          * would open possibility for buffer overrun.
 555          */
 556         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 557         return SSL_AD_ILLEGAL_PARAMETER;
 558     }
 559
 560     return 0;                   /* no error */
 561 }
 562
 563 static int dtls1_retrieve_buffered_fragment(SSL *s, long max, int *ok)
 564 {
 565     /*-
 566      * (0) check whether the desired fragment is available
 567      * if so:
 568      * (1) copy over the fragment to s->init_buf->data[]
 569      * (2) update s->init_num
 570      */
 571     pitem *item;
 572     hm_fragment *frag;
 573     int al;
 574
 575     *ok = 0;
 576     item = pqueue_peek(s->d1->buffered_messages);
 577     if (item == NULL)
 578         return 0;
 579
 580     frag = (hm_fragment *)item->data;
 581
 582     /* Don't return if reassembly still in progress */
 583     if (frag->reassembly != NULL)
 584         return 0;
 585
 586     if (s->d1->handshake_read_seq == frag->msg_header.seq) {
 587         unsigned long frag_len = frag->msg_header.frag_len;
 588         pqueue_pop(s->d1->buffered_messages);
 589
 590         al = dtls1_preprocess_fragment(s, &frag->msg_header, max);
 591
 592         if (al == 0) {          /* no alert */
 593             unsigned char *p =
 594                 (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 595             memcpy(&p[frag->msg_header.frag_off], frag->fragment,
 596                    frag->msg_header.frag_len);
 597         }
 598
 599         dtls1_hm_fragment_free(frag);
 600         pitem_free(item);
 601
 602         if (al == 0) {
 603             *ok = 1;
 604             return frag_len;
 605         }
 606
 607         ssl3_send_alert(s, SSL3_AL_FATAL, al);
 608         s->init_num = 0;
 609         *ok = 0;
 610         return -1;
 611     } else
 612         return 0;
 613 }
 614
 615 /*
 616  * dtls1_max_handshake_message_len returns the maximum number of bytes
 617  * permitted in a DTLS handshake message for |s|. The minimum is 16KB, but
 618  * may be greater if the maximum certificate list size requires it.
 619  */
 620 static unsigned long dtls1_max_handshake_message_len(const SSL *s)
 621 {
 622     unsigned long max_len =
 623         DTLS1_HM_HEADER_LENGTH + SSL3_RT_MAX_ENCRYPTED_LENGTH;
 624     if (max_len < (unsigned long)s->max_cert_list)
 625         return s->max_cert_list;
 626     return max_len;
 627 }
 628
 629 static int
 630 dtls1_reassemble_fragment(SSL *s, const struct hm_header_st *msg_hdr, int *ok)
 631 {
 632     hm_fragment *frag = NULL;
 633     pitem *item = NULL;
 634     int i = -1, is_complete;
 635     unsigned char seq64be[8];
 636     unsigned long frag_len = msg_hdr->frag_len;
 637
 638     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len ||
 639         msg_hdr->msg_len > dtls1_max_handshake_message_len(s))
 640         goto err;
 641
 642     if (frag_len == 0)
 643         return DTLS1_HM_FRAGMENT_RETRY;
 644
 645     /* Try to find item in queue */
 646     memset(seq64be, 0, sizeof(seq64be));
 647     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 648     seq64be[7] = (unsigned char)msg_hdr->seq;
 649     item = pqueue_find(s->d1->buffered_messages, seq64be);
 650
 651     if (item == NULL) {
 652         frag = dtls1_hm_fragment_new(msg_hdr->msg_len, 1);
 653         if (frag == NULL)
 654             goto err;
 655         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 656         frag->msg_header.frag_len = frag->msg_header.msg_len;
 657         frag->msg_header.frag_off = 0;
 658     } else {
 659         frag = (hm_fragment *)item->data;
 660         if (frag->msg_header.msg_len != msg_hdr->msg_len) {
 661             item = NULL;
 662             frag = NULL;
 663             goto err;
 664         }
 665     }
 666
 667     /*
 668      * If message is already reassembled, this must be a retransmit and can
 669      * be dropped. In this case item != NULL and so frag does not need to be
 670      * freed.
 671      */
 672     if (frag->reassembly == NULL) {
 673         unsigned char devnull[256];
 674
 675         while (frag_len) {
 676             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE,
 677                                           devnull,
 678                                           frag_len >
 679                                           sizeof(devnull) ? sizeof(devnull) :
 680                                           frag_len, 0);
 681             if (i <= 0)
 682                 goto err;
 683             frag_len -= i;
 684         }
 685         return DTLS1_HM_FRAGMENT_RETRY;
 686     }
 687
 688     /* read the body of the fragment (header has already been read */
 689     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE,
 690                                   frag->fragment + msg_hdr->frag_off,
 691                                   frag_len, 0);
 692     if ((unsigned long)i != frag_len)
 693         i = -1;
 694     if (i <= 0)
 695         goto err;
 696
 697     RSMBLY_BITMASK_MARK(frag->reassembly, (long)msg_hdr->frag_off,
 698                         (long)(msg_hdr->frag_off + frag_len));
 699
 700     RSMBLY_BITMASK_IS_COMPLETE(frag->reassembly, (long)msg_hdr->msg_len,
 701                                is_complete);
 702
 703     if (is_complete) {
 704         OPENSSL_free(frag->reassembly);
 705         frag->reassembly = NULL;
 706     }
 707
 708     if (item == NULL) {
 709         item = pitem_new(seq64be, frag);
 710         if (item == NULL) {
 711             i = -1;
 712             goto err;
 713         }
 714
 715         item = pqueue_insert(s->d1->buffered_messages, item);
 716         /*
 717          * pqueue_insert fails iff a duplicate item is inserted. However,
 718          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 719          * would have returned it and control would never have reached this
 720          * branch.
 721          */
 722         OPENSSL_assert(item != NULL);
 723     }
 724
 725     return DTLS1_HM_FRAGMENT_RETRY;
 726
 727  err:
 728     if (item == NULL)
 729         dtls1_hm_fragment_free(frag);
 730     *ok = 0;
 731     return i;
 732 }
 733
 734 static int
 735 dtls1_process_out_of_seq_message(SSL *s, const struct hm_header_st *msg_hdr,
 736                                  int *ok)
 737 {
 738     int i = -1;
 739     hm_fragment *frag = NULL;
 740     pitem *item = NULL;
 741     unsigned char seq64be[8];
 742     unsigned long frag_len = msg_hdr->frag_len;
 743
 744     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len)
 745         goto err;
 746
 747     /* Try to find item in queue, to prevent duplicate entries */
 748     memset(seq64be, 0, sizeof(seq64be));
 749     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
 750     seq64be[7] = (unsigned char)msg_hdr->seq;
 751     item = pqueue_find(s->d1->buffered_messages, seq64be);
 752
 753     /*
 754      * If we already have an entry and this one is a fragment, don't discard
 755      * it and rather try to reassemble it.
 756      */
 757     if (item != NULL && frag_len != msg_hdr->msg_len)
 758         item = NULL;
 759
 760     /*
 761      * Discard the message if sequence number was already there, is too far
 762      * in the future, already in the queue or if we received a FINISHED
 763      * before the SERVER_HELLO, which then must be a stale retransmit.
 764      */
 765     if (msg_hdr->seq <= s->d1->handshake_read_seq ||
 766         msg_hdr->seq > s->d1->handshake_read_seq + 10 || item != NULL ||
 767         (s->d1->handshake_read_seq == 0 && msg_hdr->type == SSL3_MT_FINISHED))
 768     {
 769         unsigned char devnull[256];
 770
 771         while (frag_len) {
 772             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE,
 773                                           devnull,
 774                                           frag_len >
 775                                           sizeof(devnull) ? sizeof(devnull) :
 776                                           frag_len, 0);
 777             if (i <= 0)
 778                 goto err;
 779             frag_len -= i;
 780         }
 781     } else {
 782         if (frag_len != msg_hdr->msg_len)
 783             return dtls1_reassemble_fragment(s, msg_hdr, ok);
 784
 785         if (frag_len > dtls1_max_handshake_message_len(s))
 786             goto err;
 787
 788         frag = dtls1_hm_fragment_new(frag_len, 0);
 789         if (frag == NULL)
 790             goto err;
 791
 792         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
 793
 794         if (frag_len) {
 795             /*
 796              * read the body of the fragment (header has already been read
 797              */
 798             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE,
 799                                           frag->fragment, frag_len, 0);
 800             if ((unsigned long)i != frag_len)
 801                 i = -1;
 802             if (i <= 0)
 803                 goto err;
 804         }
 805
 806         item = pitem_new(seq64be, frag);
 807         if (item == NULL)
 808             goto err;
 809
 810         item = pqueue_insert(s->d1->buffered_messages, item);
 811         /*
 812          * pqueue_insert fails iff a duplicate item is inserted. However,
 813          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
 814          * would have returned it. Then, either |frag_len| !=
 815          * |msg_hdr->msg_len| in which case |item| is set to NULL and it will
 816          * have been processed with |dtls1_reassemble_fragment|, above, or
 817          * the record will have been discarded.
 818          */
 819         OPENSSL_assert(item != NULL);
 820     }
 821
 822     return DTLS1_HM_FRAGMENT_RETRY;
 823
 824  err:
 825     if (item == NULL)
 826         dtls1_hm_fragment_free(frag);
 827     *ok = 0;
 828     return i;
 829 }
 830
 831 static long
 832 dtls1_get_message_fragment(SSL *s, int st1, int stn, long max, int *ok)
 833 {
 834     unsigned char wire[DTLS1_HM_HEADER_LENGTH];
 835     unsigned long len, frag_off, frag_len;
 836     int i, al;
 837     struct hm_header_st msg_hdr;
 838
 839  redo:
 840     /* see if we have the required fragment already */
 841     if ((frag_len = dtls1_retrieve_buffered_fragment(s, max, ok)) || *ok) {
 842         if (*ok)
 843             s->init_num = frag_len;
 844         return frag_len;
 845     }
 846
 847     /* read handshake message header */
 848     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, wire,
 849                                   DTLS1_HM_HEADER_LENGTH, 0);
 850     if (i <= 0) {               /* nbio, or an error */
 851         s->rwstate = SSL_READING;
 852         *ok = 0;
 853         return i;
 854     }
 855     /* Handshake fails if message header is incomplete */
 856     if (i != DTLS1_HM_HEADER_LENGTH) {
 857         al = SSL_AD_UNEXPECTED_MESSAGE;
 858         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL_R_UNEXPECTED_MESSAGE);
 859         goto f_err;
 860     }
 861
 862     /* parse the message fragment header */
 863     dtls1_get_message_header(wire, &msg_hdr);
 864
 865     /*
 866      * if this is a future (or stale) message it gets buffered
 867      * (or dropped)--no further processing at this time
 868      * While listening, we accept seq 1 (ClientHello with cookie)
 869      * although we're still expecting seq 0 (ClientHello)
 870      */
 871     if (msg_hdr.seq != s->d1->handshake_read_seq
 872         && !(s->d1->listen && msg_hdr.seq == 1))
 873         return dtls1_process_out_of_seq_message(s, &msg_hdr, ok);
 874
 875     len = msg_hdr.msg_len;
 876     frag_off = msg_hdr.frag_off;
 877     frag_len = msg_hdr.frag_len;
 878
 879     if (frag_len && frag_len < len)
 880         return dtls1_reassemble_fragment(s, &msg_hdr, ok);
 881
 882     if (!s->server && s->d1->r_msg_hdr.frag_off == 0 &&
 883         wire[0] == SSL3_MT_HELLO_REQUEST) {
 884         /*
 885          * The server may always send 'Hello Request' messages -- we are
 886          * doing a handshake anyway now, so ignore them if their format is
 887          * correct. Does not count for 'Finished' MAC.
 888          */
 889         if (wire[1] == 0 && wire[2] == 0 && wire[3] == 0) {
 890             if (s->msg_callback)
 891                 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 892                                 wire, DTLS1_HM_HEADER_LENGTH, s,
 893                                 s->msg_callback_arg);
 894
 895             s->init_num = 0;
 896             goto redo;
 897         } else {                /* Incorrectly formated Hello request */
 898
 899             al = SSL_AD_UNEXPECTED_MESSAGE;
 900             SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT,
 901                    SSL_R_UNEXPECTED_MESSAGE);
 902             goto f_err;
 903         }
 904     }
 905
 906     if ((al = dtls1_preprocess_fragment(s, &msg_hdr, max)))
 907         goto f_err;
 908
 909     /* XDTLS:  ressurect this when restart is in place */
 910     s->state = stn;
 911
 912     if (frag_len > 0) {
 913         unsigned char *p =
 914             (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
 915
 916         i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE,
 917                                       &p[frag_off], frag_len, 0);
 918         /*
 919          * XDTLS: fix this--message fragments cannot span multiple packets
 920          */
 921         if (i <= 0) {
 922             s->rwstate = SSL_READING;
 923             *ok = 0;
 924             return i;
 925         }
 926     } else
 927         i = 0;
 928
 929     /*
 930      * XDTLS: an incorrectly formatted fragment should cause the handshake
 931      * to fail
 932      */
 933     if (i != (int)frag_len) {
 934         al = SSL3_AD_ILLEGAL_PARAMETER;
 935         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL3_AD_ILLEGAL_PARAMETER);
 936         goto f_err;
 937     }
 938
 939     *ok = 1;
 940
 941     /*
 942      * Note that s->init_num is *not* used as current offset in
 943      * s->init_buf->data, but as a counter summing up fragments' lengths: as
 944      * soon as they sum up to handshake packet length, we assume we have got
 945      * all the fragments.
 946      */
 947     s->init_num = frag_len;
 948     return frag_len;
 949
 950  f_err:
 951     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 952     s->init_num = 0;
 953
 954     *ok = 0;
 955     return (-1);
 956 }
 957
 958 /*-
 959  * for these 2 messages, we need to
 960  * ssl->enc_read_ctx                    re-init
 961  * ssl->rlayer.read_sequence            zero
 962  * ssl->s3->read_mac_secret             re-init
 963  * ssl->session->read_sym_enc           assign
 964  * ssl->session->read_compression       assign
 965  * ssl->session->read_hash              assign
 966  */
 967 int dtls1_send_change_cipher_spec(SSL *s, int a, int b)
 968 {
 969     unsigned char *p;
 970
 971     if (s->state == a) {
 972         p = (unsigned char *)s->init_buf->data;
 973         *p++ = SSL3_MT_CCS;
 974         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
 975         s->init_num = DTLS1_CCS_HEADER_LENGTH;
 976
 977         if (s->version == DTLS1_BAD_VER) {
 978             s->d1->next_handshake_write_seq++;
 979             s2n(s->d1->handshake_write_seq, p);
 980             s->init_num += 2;
 981         }
 982
 983         s->init_off = 0;
 984
 985         dtls1_set_message_header_int(s, SSL3_MT_CCS, 0,
 986                                      s->d1->handshake_write_seq, 0, 0);
 987
 988         /* buffer the message to handle re-xmits */
 989         if (!dtls1_buffer_message(s, 1)) {
 990             SSLerr(SSL_F_DTLS1_SEND_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
 991             return -1;
 992         }
 993
 994         s->state = b;
 995     }
 996
 997     /* SSL3_ST_CW_CHANGE_B */
 998     return (dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC));
 999 }
1000
1001 int dtls1_read_failed(SSL *s, int code)
1002 {
1003     if (code > 0) {
1004         fprintf(stderr, "invalid state reached %s:%d", __FILE__, __LINE__);
1005         return 1;
1006     }
1007
1008     if (!dtls1_is_timer_expired(s)) {
1009         /*
1010          * not a timeout, none of our business, let higher layers handle
1011          * this.  in fact it's probably an error
1012          */
1013         return code;
1014     }
1015 #ifndef OPENSSL_NO_HEARTBEATS
1016     /* done, no need to send a retransmit */
1017     if (!SSL_in_init(s) && !s->tlsext_hb_pending)
1018 #else
1019     /* done, no need to send a retransmit */
1020     if (!SSL_in_init(s))
1021 #endif
1022     {
1023         BIO_set_flags(SSL_get_rbio(s), BIO_FLAGS_READ);
1024         return code;
1025     }
1026
1027     return dtls1_handle_timeout(s);
1028 }
1029
1030 int dtls1_get_queue_priority(unsigned short seq, int is_ccs)
1031 {
1032     /*
1033      * The index of the retransmission queue actually is the message sequence
1034      * number, since the queue only contains messages of a single handshake.
1035      * However, the ChangeCipherSpec has no message sequence number and so
1036      * using only the sequence will result in the CCS and Finished having the
1037      * same index. To prevent this, the sequence number is multiplied by 2.
1038      * In case of a CCS 1 is subtracted. This does not only differ CSS and
1039      * Finished, it also maintains the order of the index (important for
1040      * priority queues) and fits in the unsigned short variable.
1041      */
1042     return seq * 2 - is_ccs;
1043 }
1044
1045 int dtls1_retransmit_buffered_messages(SSL *s)
1046 {
1047     pqueue sent = s->d1->sent_messages;
1048     piterator iter;
1049     pitem *item;
1050     hm_fragment *frag;
1051     int found = 0;
1052
1053     iter = pqueue_iterator(sent);
1054
1055     for (item = pqueue_next(&iter); item != NULL; item = pqueue_next(&iter)) {
1056         frag = (hm_fragment *)item->data;
1057         if (dtls1_retransmit_message(s, (unsigned short)
1058                                      dtls1_get_queue_priority
1059                                      (frag->msg_header.seq,
1060                                       frag->msg_header.is_ccs), 0,
1061                                      &found) <= 0 && found) {
1062             fprintf(stderr, "dtls1_retransmit_message() failed\n");
1063             return -1;
1064         }
1065     }
1066
1067     return 1;
1068 }
1069
1070 int dtls1_buffer_message(SSL *s, int is_ccs)
1071 {
1072     pitem *item;
1073     hm_fragment *frag;
1074     unsigned char seq64be[8];
1075
1076     /*
1077      * this function is called immediately after a message has been
1078      * serialized
1079      */
1080     OPENSSL_assert(s->init_off == 0);
1081
1082     frag = dtls1_hm_fragment_new(s->init_num, 0);
1083     if (!frag)
1084         return 0;
1085
1086     memcpy(frag->fragment, s->init_buf->data, s->init_num);
1087
1088     if (is_ccs) {
1089         /* For DTLS1_BAD_VER the header length is non-standard */
1090         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1091                        ((s->version==DTLS1_BAD_VER)?3:DTLS1_CCS_HEADER_LENGTH)
1092                        == (unsigned int)s->init_num);
1093     } else {
1094         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1095                        DTLS1_HM_HEADER_LENGTH == (unsigned int)s->init_num);
1096     }
1097
1098     frag->msg_header.msg_len = s->d1->w_msg_hdr.msg_len;
1099     frag->msg_header.seq = s->d1->w_msg_hdr.seq;
1100     frag->msg_header.type = s->d1->w_msg_hdr.type;
1101     frag->msg_header.frag_off = 0;
1102     frag->msg_header.frag_len = s->d1->w_msg_hdr.msg_len;
1103     frag->msg_header.is_ccs = is_ccs;
1104
1105     /* save current state */
1106     frag->msg_header.saved_retransmit_state.enc_write_ctx = s->enc_write_ctx;
1107     frag->msg_header.saved_retransmit_state.write_hash = s->write_hash;
1108     frag->msg_header.saved_retransmit_state.compress = s->compress;
1109     frag->msg_header.saved_retransmit_state.session = s->session;
1110     frag->msg_header.saved_retransmit_state.epoch =
1111         DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1112
1113     memset(seq64be, 0, sizeof(seq64be));
1114     seq64be[6] =
1115         (unsigned
1116          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1117                                         frag->msg_header.is_ccs) >> 8);
1118     seq64be[7] =
1119         (unsigned
1120          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1121                                         frag->msg_header.is_ccs));
1122
1123     item = pitem_new(seq64be, frag);
1124     if (item == NULL) {
1125         dtls1_hm_fragment_free(frag);
1126         return 0;
1127     }
1128
1129     pqueue_insert(s->d1->sent_messages, item);
1130     return 1;
1131 }
1132
1133 int
1134 dtls1_retransmit_message(SSL *s, unsigned short seq, unsigned long frag_off,
1135                          int *found)
1136 {
1137     int ret;
1138     /* XDTLS: for now assuming that read/writes are blocking */
1139     pitem *item;
1140     hm_fragment *frag;
1141     unsigned long header_length;
1142     unsigned char seq64be[8];
1143     struct dtls1_retransmit_state saved_state;
1144
1145     /*-
1146       OPENSSL_assert(s->init_num == 0);
1147       OPENSSL_assert(s->init_off == 0);
1148      */
1149
1150     /* XDTLS:  the requested message ought to be found, otherwise error */
1151     memset(seq64be, 0, sizeof(seq64be));
1152     seq64be[6] = (unsigned char)(seq >> 8);
1153     seq64be[7] = (unsigned char)seq;
1154
1155     item = pqueue_find(s->d1->sent_messages, seq64be);
1156     if (item == NULL) {
1157         fprintf(stderr, "retransmit:  message %d non-existant\n", seq);
1158         *found = 0;
1159         return 0;
1160     }
1161
1162     *found = 1;
1163     frag = (hm_fragment *)item->data;
1164
1165     if (frag->msg_header.is_ccs)
1166         header_length = DTLS1_CCS_HEADER_LENGTH;
1167     else
1168         header_length = DTLS1_HM_HEADER_LENGTH;
1169
1170     memcpy(s->init_buf->data, frag->fragment,
1171            frag->msg_header.msg_len + header_length);
1172     s->init_num = frag->msg_header.msg_len + header_length;
1173
1174     dtls1_set_message_header_int(s, frag->msg_header.type,
1175                                  frag->msg_header.msg_len,
1176                                  frag->msg_header.seq, 0,
1177                                  frag->msg_header.frag_len);
1178
1179     /* save current state */
1180     saved_state.enc_write_ctx = s->enc_write_ctx;
1181     saved_state.write_hash = s->write_hash;
1182     saved_state.compress = s->compress;
1183     saved_state.session = s->session;
1184     saved_state.epoch = DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1185
1186     s->d1->retransmitting = 1;
1187
1188     /* restore state in which the message was originally sent */
1189     s->enc_write_ctx = frag->msg_header.saved_retransmit_state.enc_write_ctx;
1190     s->write_hash = frag->msg_header.saved_retransmit_state.write_hash;
1191     s->compress = frag->msg_header.saved_retransmit_state.compress;
1192     s->session = frag->msg_header.saved_retransmit_state.session;
1193     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer,
1194         frag->msg_header.saved_retransmit_state.epoch);
1195
1196     ret = dtls1_do_write(s, frag->msg_header.is_ccs ?
1197                          SSL3_RT_CHANGE_CIPHER_SPEC : SSL3_RT_HANDSHAKE);
1198
1199     /* restore current state */
1200     s->enc_write_ctx = saved_state.enc_write_ctx;
1201     s->write_hash = saved_state.write_hash;
1202     s->compress = saved_state.compress;
1203     s->session = saved_state.session;
1204     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer, saved_state.epoch);
1205
1206     s->d1->retransmitting = 0;
1207
1208     (void)BIO_flush(SSL_get_wbio(s));
1209     return ret;
1210 }
1211
1212 /* call this function when the buffered messages are no longer needed */
1213 void dtls1_clear_record_buffer(SSL *s)
1214 {
1215     pitem *item;
1216
1217     for (item = pqueue_pop(s->d1->sent_messages);
1218          item != NULL; item = pqueue_pop(s->d1->sent_messages)) {
1219         dtls1_hm_fragment_free((hm_fragment *)item->data);
1220         pitem_free(item);
1221     }
1222 }
1223
1224 void dtls1_set_message_header(SSL *s, unsigned char *p,
1225                                         unsigned char mt, unsigned long len,
1226                                         unsigned long frag_off,
1227                                         unsigned long frag_len)
1228 {
1229     /* Don't change sequence numbers while listening */
1230     if (frag_off == 0 && !s->d1->listen) {
1231         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1232         s->d1->next_handshake_write_seq++;
1233     }
1234
1235     dtls1_set_message_header_int(s, mt, len, s->d1->handshake_write_seq,
1236                                  frag_off, frag_len);
1237 }
1238
1239 /* don't actually do the writing, wait till the MTU has been retrieved */
1240 static void
1241 dtls1_set_message_header_int(SSL *s, unsigned char mt,
1242                              unsigned long len, unsigned short seq_num,
1243                              unsigned long frag_off, unsigned long frag_len)
1244 {
1245     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1246
1247     msg_hdr->type = mt;
1248     msg_hdr->msg_len = len;
1249     msg_hdr->seq = seq_num;
1250     msg_hdr->frag_off = frag_off;
1251     msg_hdr->frag_len = frag_len;
1252 }
1253
1254 static void
1255 dtls1_fix_message_header(SSL *s, unsigned long frag_off,
1256                          unsigned long frag_len)
1257 {
1258     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1259
1260     msg_hdr->frag_off = frag_off;
1261     msg_hdr->frag_len = frag_len;
1262 }
1263
1264 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p)
1265 {
1266     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1267
1268     *p++ = msg_hdr->type;
1269     l2n3(msg_hdr->msg_len, p);
1270
1271     s2n(msg_hdr->seq, p);
1272     l2n3(msg_hdr->frag_off, p);
1273     l2n3(msg_hdr->frag_len, p);
1274
1275     return p;
1276 }
1277
1278 unsigned int dtls1_link_min_mtu(void)
1279 {
1280     return (g_probable_mtu[(sizeof(g_probable_mtu) /
1281                             sizeof(g_probable_mtu[0])) - 1]);
1282 }
1283
1284 unsigned int dtls1_min_mtu(SSL *s)
1285 {
1286     return dtls1_link_min_mtu() - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
1287 }
1288
1289 void
1290 dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr)
1291 {
1292     memset(msg_hdr, 0x00, sizeof(struct hm_header_st));
1293     msg_hdr->type = *(data++);
1294     n2l3(data, msg_hdr->msg_len);
1295
1296     n2s(data, msg_hdr->seq);
1297     n2l3(data, msg_hdr->frag_off);
1298     n2l3(data, msg_hdr->frag_len);
1299 }
1300
1301 void dtls1_get_ccs_header(unsigned char *data, struct ccs_header_st *ccs_hdr)
1302 {
1303     memset(ccs_hdr, 0x00, sizeof(struct ccs_header_st));
1304
1305     ccs_hdr->type = *(data++);
1306 }
1307
1308 int dtls1_shutdown(SSL *s)
1309 {
1310     int ret;
1311 #ifndef OPENSSL_NO_SCTP
1312     if (BIO_dgram_is_sctp(SSL_get_wbio(s)) &&
1313         !(s->shutdown & SSL_SENT_SHUTDOWN)) {
1314         ret = BIO_dgram_sctp_wait_for_dry(SSL_get_wbio(s));
1315         if (ret < 0)
1316             return -1;
1317
1318         if (ret == 0)
1319             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 1,
1320                      NULL);
1321     }
1322 #endif
1323     ret = ssl3_shutdown(s);
1324 #ifndef OPENSSL_NO_SCTP
1325     BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 0, NULL);
1326 #endif
1327     return ret;
1328 }
1329
1330 #ifndef OPENSSL_NO_HEARTBEATS
1331 int dtls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length)
1332 {
1333     unsigned char *pl;
1334     unsigned short hbtype;
1335     unsigned int payload;
1336     unsigned int padding = 16;  /* Use minimum padding */
1337
1338     if (s->msg_callback)
1339         s->msg_callback(0, s->version, TLS1_RT_HEARTBEAT,
1340                         p, length, s, s->msg_callback_arg);
1341
1342     /* Read type and payload length first */
1343     if (1 + 2 + 16 > length)
1344         return 0;               /* silently discard */
1345     if (length > SSL3_RT_MAX_PLAIN_LENGTH)
1346         return 0;               /* silently discard per RFC 6520 sec. 4 */
1347
1348     hbtype = *p++;
1349     n2s(p, payload);
1350     if (1 + 2 + payload + 16 > length)
1351         return 0;               /* silently discard per RFC 6520 sec. 4 */
1352     pl = p;
1353
1354     if (hbtype == TLS1_HB_REQUEST) {
1355         unsigned char *buffer, *bp;
1356         unsigned int write_length = 1 /* heartbeat type */  +
1357             2 /* heartbeat length */  +
1358             payload + padding;
1359         int r;
1360
1361         if (write_length > SSL3_RT_MAX_PLAIN_LENGTH)
1362             return 0;
1363
1364         /*
1365          * Allocate memory for the response, size is 1 byte message type,
1366          * plus 2 bytes payload length, plus payload, plus padding
1367          */
1368         buffer = OPENSSL_malloc(write_length);
1369         if (buffer == NULL)
1370             return -1;
1371         bp = buffer;
1372
1373         /* Enter response type, length and copy payload */
1374         *bp++ = TLS1_HB_RESPONSE;
1375         s2n(payload, bp);
1376         memcpy(bp, pl, payload);
1377         bp += payload;
1378         /* Random padding */
1379         if (RAND_bytes(bp, padding) <= 0) {
1380             OPENSSL_free(buffer);
1381             return -1;
1382         }
1383
1384         r = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buffer, write_length);
1385
1386         if (r >= 0 && s->msg_callback)
1387             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
1388                             buffer, write_length, s, s->msg_callback_arg);
1389
1390         OPENSSL_free(buffer);
1391
1392         if (r < 0)
1393             return r;
1394     } else if (hbtype == TLS1_HB_RESPONSE) {
1395         unsigned int seq;
1396
1397         /*
1398          * We only send sequence numbers (2 bytes unsigned int), and 16
1399          * random bytes, so we just try to read the sequence number
1400          */
1401         n2s(pl, seq);
1402
1403         if (payload == 18 && seq == s->tlsext_hb_seq) {
1404             dtls1_stop_timer(s);
1405             s->tlsext_hb_seq++;
1406             s->tlsext_hb_pending = 0;
1407         }
1408     }
1409
1410     return 0;
1411 }
1412
1413 int dtls1_heartbeat(SSL *s)
1414 {
1415     unsigned char *buf, *p;
1416     int ret = -1;
1417     unsigned int payload = 18;  /* Sequence number + random bytes */
1418     unsigned int padding = 16;  /* Use minimum padding */
1419
1420     /* Only send if peer supports and accepts HB requests... */
1421     if (!(s->tlsext_heartbeat & SSL_TLSEXT_HB_ENABLED) ||
1422         s->tlsext_heartbeat & SSL_TLSEXT_HB_DONT_SEND_REQUESTS) {
1423         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PEER_DOESNT_ACCEPT);
1424         return -1;
1425     }
1426
1427     /* ...and there is none in flight yet... */
1428     if (s->tlsext_hb_pending) {
1429         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PENDING);
1430         return -1;
1431     }
1432
1433     /* ...and no handshake in progress. */
1434     if (SSL_in_init(s) || s->in_handshake) {
1435         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_UNEXPECTED_MESSAGE);
1436         return -1;
1437     }
1438
1439     /*
1440      * Check if padding is too long, payload and padding must not exceed 2^14
1441      * - 3 = 16381 bytes in total.
1442      */
1443     OPENSSL_assert(payload + padding <= 16381);
1444
1445     /*-
1446      * Create HeartBeat message, we just use a sequence number
1447      * as payload to distuingish different messages and add
1448      * some random stuff.
1449      *  - Message Type, 1 byte
1450      *  - Payload Length, 2 bytes (unsigned int)
1451      *  - Payload, the sequence number (2 bytes uint)
1452      *  - Payload, random bytes (16 bytes uint)
1453      *  - Padding
1454      */
1455     buf = OPENSSL_malloc(1 + 2 + payload + padding);
1456     if (buf == NULL) {
1457         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_MALLOC_FAILURE);
1458         return -1;
1459     }
1460     p = buf;
1461     /* Message Type */
1462     *p++ = TLS1_HB_REQUEST;
1463     /* Payload length (18 bytes here) */
1464     s2n(payload, p);
1465     /* Sequence number */
1466     s2n(s->tlsext_hb_seq, p);
1467     /* 16 random bytes */
1468     if (RAND_bytes(p, 16) <= 0) {
1469         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1470         goto err;
1471     }
1472     p += 16;
1473     /* Random padding */
1474     if (RAND_bytes(p, padding) <= 0) {
1475         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1476         goto err;
1477     }
1478
1479     ret = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buf, 3 + payload + padding);
1480     if (ret >= 0) {
1481         if (s->msg_callback)
1482             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
1483                             buf, 3 + payload + padding,
1484                             s, s->msg_callback_arg);
1485
1486         dtls1_start_timer(s);
1487         s->tlsext_hb_pending = 1;
1488     }
1489
1490  err:
1491     OPENSSL_free(buf);
1492
1493     return ret;
1494 }
1495 #endif