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