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