ssl/record/rec_layer_d1.c

   1 /* ssl/record/rec_layer_d1.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 <stdio.h>
 117 #include <errno.h>
 118 #define USE_SOCKETS
 119 #include "../ssl_locl.h"
 120 #include <openssl/evp.h>
 121 #include <openssl/buffer.h>
 122 #include <openssl/pqueue.h>
 123 #include <openssl/rand.h>
 124 #include "record_locl.h"
 125
 126 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl)
 127 {
 128     DTLS_RECORD_LAYER *d;
 129
 130     if ((d = OPENSSL_malloc(sizeof *d)) == NULL) {
 131         return (0);
 132     }
 133
 134
 135     rl->d = d;
 136
 137     d->unprocessed_rcds.q = pqueue_new();
 138     d->processed_rcds.q = pqueue_new();
 139     d->buffered_app_data.q = pqueue_new();
 140
 141     if (!d->unprocessed_rcds.q || !d->processed_rcds.q
 142         || !d->buffered_app_data.q) {
 143         if (d->unprocessed_rcds.q)
 144             pqueue_free(d->unprocessed_rcds.q);
 145         if (d->processed_rcds.q)
 146             pqueue_free(d->processed_rcds.q);
 147         if (d->buffered_app_data.q)
 148             pqueue_free(d->buffered_app_data.q);
 149         OPENSSL_free(d);
 150         rl->d = NULL;
 151         return (0);
 152     }
 153
 154     return 1;
 155 }
 156
 157 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl)
 158 {
 159     DTLS_RECORD_LAYER_clear(rl);
 160     pqueue_free(rl->d->unprocessed_rcds.q);
 161     pqueue_free(rl->d->processed_rcds.q);
 162     pqueue_free(rl->d->buffered_app_data.q);
 163     OPENSSL_free(rl->d);
 164     rl->d = NULL;
 165 }
 166
 167 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl)
 168 {
 169     DTLS_RECORD_LAYER *d;
 170     pitem *item = NULL;
 171     DTLS1_RECORD_DATA *rdata;
 172     pqueue unprocessed_rcds;
 173     pqueue processed_rcds;
 174     pqueue buffered_app_data;
 175
 176     d = rl->d;
 177
 178     while ((item = pqueue_pop(d->unprocessed_rcds.q)) != NULL) {
 179         rdata = (DTLS1_RECORD_DATA *)item->data;
 180         if (rdata->rbuf.buf) {
 181             OPENSSL_free(rdata->rbuf.buf);
 182         }
 183         OPENSSL_free(item->data);
 184         pitem_free(item);
 185     }
 186
 187     while ((item = pqueue_pop(d->processed_rcds.q)) != NULL) {
 188         rdata = (DTLS1_RECORD_DATA *)item->data;
 189         if (rdata->rbuf.buf) {
 190             OPENSSL_free(rdata->rbuf.buf);
 191         }
 192         OPENSSL_free(item->data);
 193         pitem_free(item);
 194     }
 195
 196     while ((item = pqueue_pop(d->buffered_app_data.q)) != NULL) {
 197         rdata = (DTLS1_RECORD_DATA *)item->data;
 198         if (rdata->rbuf.buf) {
 199             OPENSSL_free(rdata->rbuf.buf);
 200         }
 201         OPENSSL_free(item->data);
 202         pitem_free(item);
 203     }
 204
 205     unprocessed_rcds = d->unprocessed_rcds.q;
 206     processed_rcds = d->processed_rcds.q;
 207     buffered_app_data = d->buffered_app_data.q;
 208     memset(d, 0, sizeof *d);
 209     d->unprocessed_rcds.q = unprocessed_rcds;
 210     d->processed_rcds.q = processed_rcds;
 211     d->buffered_app_data.q = buffered_app_data;
 212 }
 213
 214 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e)
 215 {
 216     if (e == rl->d->w_epoch - 1) {
 217         memcpy(rl->d->curr_write_sequence,
 218                rl->write_sequence,
 219                sizeof(rl->write_sequence));
 220         memcpy(rl->write_sequence,
 221                rl->d->last_write_sequence,
 222                sizeof(rl->write_sequence));
 223     } else if (e == rl->d->w_epoch + 1) {
 224         memcpy(rl->d->last_write_sequence,
 225                rl->write_sequence,
 226                sizeof(unsigned char[8]));
 227         memcpy(rl->write_sequence,
 228                rl->d->curr_write_sequence,
 229                sizeof(rl->write_sequence));
 230     }
 231     rl->d->w_epoch = e;
 232 }
 233
 234 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl)
 235 {
 236     memcpy(rl->write_sequence, rl->read_sequence, sizeof(rl->write_sequence));
 237 }
 238
 239 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
 240                                    int len, int peek);
 241
 242 /* copy buffered record into SSL structure */
 243 static int dtls1_copy_record(SSL *s, pitem *item)
 244 {
 245     DTLS1_RECORD_DATA *rdata;
 246
 247     rdata = (DTLS1_RECORD_DATA *)item->data;
 248
 249     SSL3_BUFFER_release(&s->rlayer.rbuf);
 250
 251     s->rlayer.packet = rdata->packet;
 252     s->rlayer.packet_length = rdata->packet_length;
 253     memcpy(&s->rlayer.rbuf, &(rdata->rbuf), sizeof(SSL3_BUFFER));
 254     memcpy(&s->rlayer.rrec, &(rdata->rrec), sizeof(SSL3_RECORD));
 255
 256     /* Set proper sequence number for mac calculation */
 257     memcpy(&(s->rlayer.read_sequence[2]), &(rdata->packet[5]), 6);
 258
 259     return (1);
 260 }
 261
 262 int dtls1_buffer_record(SSL *s, record_pqueue *queue, unsigned char *priority)
 263 {
 264     DTLS1_RECORD_DATA *rdata;
 265     pitem *item;
 266
 267     /* Limit the size of the queue to prevent DOS attacks */
 268     if (pqueue_size(queue->q) >= 100)
 269         return 0;
 270
 271     rdata = OPENSSL_malloc(sizeof(DTLS1_RECORD_DATA));
 272     item = pitem_new(priority, rdata);
 273     if (rdata == NULL || item == NULL) {
 274         if (rdata != NULL)
 275             OPENSSL_free(rdata);
 276         if (item != NULL)
 277             pitem_free(item);
 278
 279         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
 280         return -1;
 281     }
 282
 283     rdata->packet = s->rlayer.packet;
 284     rdata->packet_length = s->rlayer.packet_length;
 285     memcpy(&(rdata->rbuf), &s->rlayer.rbuf, sizeof(SSL3_BUFFER));
 286     memcpy(&(rdata->rrec), &s->rlayer.rrec, sizeof(SSL3_RECORD));
 287
 288     item->data = rdata;
 289
 290 #ifndef OPENSSL_NO_SCTP
 291     /* Store bio_dgram_sctp_rcvinfo struct */
 292     if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 293         (s->state == SSL3_ST_SR_FINISHED_A
 294          || s->state == SSL3_ST_CR_FINISHED_A)) {
 295         BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_GET_RCVINFO,
 296                  sizeof(rdata->recordinfo), &rdata->recordinfo);
 297     }
 298 #endif
 299
 300     s->rlayer.packet = NULL;
 301     s->rlayer.packet_length = 0;
 302     memset(&s->rlayer.rbuf, 0, sizeof(SSL3_BUFFER));
 303     memset(&s->rlayer.rrec, 0, sizeof(SSL3_RECORD));
 304
 305     if (!ssl3_setup_buffers(s)) {
 306         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
 307         if (rdata->rbuf.buf != NULL)
 308             OPENSSL_free(rdata->rbuf.buf);
 309         OPENSSL_free(rdata);
 310         pitem_free(item);
 311         return (-1);
 312     }
 313
 314     /* insert should not fail, since duplicates are dropped */
 315     if (pqueue_insert(queue->q, item) == NULL) {
 316         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
 317         if (rdata->rbuf.buf != NULL)
 318             OPENSSL_free(rdata->rbuf.buf);
 319         OPENSSL_free(rdata);
 320         pitem_free(item);
 321         return (-1);
 322     }
 323
 324     return (1);
 325 }
 326
 327 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
 328 {
 329     pitem *item;
 330
 331     item = pqueue_pop(queue->q);
 332     if (item) {
 333         dtls1_copy_record(s, item);
 334
 335         OPENSSL_free(item->data);
 336         pitem_free(item);
 337
 338         return (1);
 339     }
 340
 341     return (0);
 342 }
 343
 344 /*
 345  * retrieve a buffered record that belongs to the new epoch, i.e., not
 346  * processed yet
 347  */
 348 #define dtls1_get_unprocessed_record(s) \
 349                    dtls1_retrieve_buffered_record((s), \
 350                    &((s)->rlayer.d->unprocessed_rcds))
 351
 352
 353 int dtls1_process_buffered_records(SSL *s)
 354 {
 355     pitem *item;
 356
 357     item = pqueue_peek(s->rlayer.d->unprocessed_rcds.q);
 358     if (item) {
 359         /* Check if epoch is current. */
 360         if (s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch)
 361             return (1);         /* Nothing to do. */
 362
 363         /* Process all the records. */
 364         while (pqueue_peek(s->rlayer.d->unprocessed_rcds.q)) {
 365             dtls1_get_unprocessed_record(s);
 366             if (!dtls1_process_record(s))
 367                 return (0);
 368             if (dtls1_buffer_record(s, &(s->rlayer.d->processed_rcds),
 369                 SSL3_RECORD_get_seq_num(&s->rlayer.rrec)) < 0)
 370                 return -1;
 371         }
 372     }
 373
 374     /*
 375      * sync epoch numbers once all the unprocessed records have been
 376      * processed
 377      */
 378     s->rlayer.d->processed_rcds.epoch = s->rlayer.d->r_epoch;
 379     s->rlayer.d->unprocessed_rcds.epoch = s->rlayer.d->r_epoch + 1;
 380
 381     return (1);
 382 }
 383
 384
 385 /*-
 386  * Return up to 'len' payload bytes received in 'type' records.
 387  * 'type' is one of the following:
 388  *
 389  *   -  SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
 390  *   -  SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
 391  *   -  0 (during a shutdown, no data has to be returned)
 392  *
 393  * If we don't have stored data to work from, read a SSL/TLS record first
 394  * (possibly multiple records if we still don't have anything to return).
 395  *
 396  * This function must handle any surprises the peer may have for us, such as
 397  * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
 398  * a surprise, but handled as if it were), or renegotiation requests.
 399  * Also if record payloads contain fragments too small to process, we store
 400  * them until there is enough for the respective protocol (the record protocol
 401  * may use arbitrary fragmentation and even interleaving):
 402  *     Change cipher spec protocol
 403  *             just 1 byte needed, no need for keeping anything stored
 404  *     Alert protocol
 405  *             2 bytes needed (AlertLevel, AlertDescription)
 406  *     Handshake protocol
 407  *             4 bytes needed (HandshakeType, uint24 length) -- we just have
 408  *             to detect unexpected Client Hello and Hello Request messages
 409  *             here, anything else is handled by higher layers
 410  *     Application data protocol
 411  *             none of our business
 412  */
 413 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
 414 {
 415     int al, i, j, ret;
 416     unsigned int n;
 417     SSL3_RECORD *rr;
 418     void (*cb) (const SSL *ssl, int type2, int val) = NULL;
 419
 420     if (!SSL3_BUFFER_is_initialised(&s->rlayer.rbuf)) {
 421         /* Not initialized yet */
 422         if (!ssl3_setup_buffers(s))
 423             return (-1);
 424     }
 425
 426     if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
 427          (type != SSL3_RT_HANDSHAKE)) ||
 428         (peek && (type != SSL3_RT_APPLICATION_DATA))) {
 429         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
 430         return -1;
 431     }
 432
 433     /*
 434      * check whether there's a handshake message (client hello?) waiting
 435      */
 436     if ((ret = have_handshake_fragment(s, type, buf, len, peek)))
 437         return ret;
 438
 439     /*
 440      * Now s->rlayer.d->handshake_fragment_len == 0 if
 441      * type == SSL3_RT_HANDSHAKE.
 442      */
 443
 444 #ifndef OPENSSL_NO_SCTP
 445     /*
 446      * Continue handshake if it had to be interrupted to read app data with
 447      * SCTP.
 448      */
 449     if ((!s->in_handshake && SSL_in_init(s)) ||
 450         (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 451          (s->state == DTLS1_SCTP_ST_SR_READ_SOCK
 452           || s->state == DTLS1_SCTP_ST_CR_READ_SOCK)
 453          && s->s3->in_read_app_data != 2))
 454 #else
 455     if (!s->in_handshake && SSL_in_init(s))
 456 #endif
 457     {
 458         /* type == SSL3_RT_APPLICATION_DATA */
 459         i = s->handshake_func(s);
 460         if (i < 0)
 461             return (i);
 462         if (i == 0) {
 463             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
 464             return (-1);
 465         }
 466     }
 467
 468  start:
 469     s->rwstate = SSL_NOTHING;
 470
 471     /*-
 472      * s->s3->rrec.type         - is the type of record
 473      * s->s3->rrec.data,    - data
 474      * s->s3->rrec.off,     - offset into 'data' for next read
 475      * s->s3->rrec.length,  - number of bytes.
 476      */
 477     rr = &s->rlayer.rrec;
 478
 479     /*
 480      * We are not handshaking and have no data yet, so process data buffered
 481      * during the last handshake in advance, if any.
 482      */
 483     if (s->state == SSL_ST_OK && SSL3_RECORD_get_length(rr) == 0) {
 484         pitem *item;
 485         item = pqueue_pop(s->rlayer.d->buffered_app_data.q);
 486         if (item) {
 487 #ifndef OPENSSL_NO_SCTP
 488             /* Restore bio_dgram_sctp_rcvinfo struct */
 489             if (BIO_dgram_is_sctp(SSL_get_rbio(s))) {
 490                 DTLS1_RECORD_DATA *rdata = (DTLS1_RECORD_DATA *)item->data;
 491                 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_SET_RCVINFO,
 492                          sizeof(rdata->recordinfo), &rdata->recordinfo);
 493             }
 494 #endif
 495
 496             dtls1_copy_record(s, item);
 497
 498             OPENSSL_free(item->data);
 499             pitem_free(item);
 500         }
 501     }
 502
 503     /* Check for timeout */
 504     if (dtls1_handle_timeout(s) > 0)
 505         goto start;
 506
 507     /* get new packet if necessary */
 508     if ((SSL3_RECORD_get_length(rr) == 0)
 509             || (s->rlayer.rstate == SSL_ST_READ_BODY)) {
 510         ret = dtls1_get_record(s);
 511         if (ret <= 0) {
 512             ret = dtls1_read_failed(s, ret);
 513             /* anything other than a timeout is an error */
 514             if (ret <= 0)
 515                 return (ret);
 516             else
 517                 goto start;
 518         }
 519     }
 520
 521     if (s->d1->listen && rr->type != SSL3_RT_HANDSHAKE) {
 522         SSL3_RECORD_set_length(rr, 0);
 523         goto start;
 524     }
 525
 526     /* we now have a packet which can be read and processed */
 527
 528     if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
 529                                    * reset by ssl3_get_finished */
 530         && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
 531         /*
 532          * We now have application data between CCS and Finished. Most likely
 533          * the packets were reordered on their way, so buffer the application
 534          * data for later processing rather than dropping the connection.
 535          */
 536         if (dtls1_buffer_record(s, &(s->rlayer.d->buffered_app_data),
 537             SSL3_RECORD_get_seq_num(rr)) < 0) {
 538             SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
 539             return -1;
 540         }
 541         SSL3_RECORD_set_length(rr, 0);
 542         goto start;
 543     }
 544
 545     /*
 546      * If the other end has shut down, throw anything we read away (even in
 547      * 'peek' mode)
 548      */
 549     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
 550         SSL3_RECORD_set_length(rr, 0);
 551         s->rwstate = SSL_NOTHING;
 552         return (0);
 553     }
 554
 555     if (type == SSL3_RECORD_get_type(rr)) {
 556         /* SSL3_RT_APPLICATION_DATA or
 557          * SSL3_RT_HANDSHAKE */
 558         /*
 559          * make sure that we are not getting application data when we are
 560          * doing a handshake for the first time
 561          */
 562         if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
 563             (s->enc_read_ctx == NULL)) {
 564             al = SSL_AD_UNEXPECTED_MESSAGE;
 565             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
 566             goto f_err;
 567         }
 568
 569         if (len <= 0)
 570             return (len);
 571
 572         if ((unsigned int)len > SSL3_RECORD_get_length(rr))
 573             n = SSL3_RECORD_get_length(rr);
 574         else
 575             n = (unsigned int)len;
 576
 577         memcpy(buf, &(SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)]), n);
 578         if (!peek) {
 579             SSL3_RECORD_add_length(rr, -n);
 580             SSL3_RECORD_add_off(rr, n);
 581             if (SSL3_RECORD_get_length(rr) == 0) {
 582                 s->rlayer.rstate = SSL_ST_READ_HEADER;
 583                 SSL3_RECORD_set_off(rr, 0);
 584             }
 585         }
 586 #ifndef OPENSSL_NO_SCTP
 587         /*
 588          * We were about to renegotiate but had to read belated application
 589          * data first, so retry.
 590          */
 591         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 592             SSL3_RECORD_get_type(rr) == SSL3_RT_APPLICATION_DATA &&
 593             (s->state == DTLS1_SCTP_ST_SR_READ_SOCK
 594              || s->state == DTLS1_SCTP_ST_CR_READ_SOCK)) {
 595             s->rwstate = SSL_READING;
 596             BIO_clear_retry_flags(SSL_get_rbio(s));
 597             BIO_set_retry_read(SSL_get_rbio(s));
 598         }
 599
 600         /*
 601          * We might had to delay a close_notify alert because of reordered
 602          * app data. If there was an alert and there is no message to read
 603          * anymore, finally set shutdown.
 604          */
 605         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 606             s->d1->shutdown_received
 607             && !BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
 608             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
 609             return (0);
 610         }
 611 #endif
 612         return (n);
 613     }
 614
 615     /*
 616      * If we get here, then type != rr->type; if we have a handshake message,
 617      * then it was unexpected (Hello Request or Client Hello).
 618      */
 619
 620     /*
 621      * In case of record types for which we have 'fragment' storage, fill
 622      * that so that we can process the data at a fixed place.
 623      */
 624     {
 625         unsigned int k, dest_maxlen = 0;
 626         unsigned char *dest = NULL;
 627         unsigned int *dest_len = NULL;
 628
 629         if (SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) {
 630             dest_maxlen = sizeof s->rlayer.d->handshake_fragment;
 631             dest = s->rlayer.d->handshake_fragment;
 632             dest_len = &s->rlayer.d->handshake_fragment_len;
 633         } else if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
 634             dest_maxlen = sizeof(s->rlayer.d->alert_fragment);
 635             dest = s->rlayer.d->alert_fragment;
 636             dest_len = &s->rlayer.d->alert_fragment_len;
 637         }
 638 #ifndef OPENSSL_NO_HEARTBEATS
 639         else if (SSL3_RECORD_get_type(rr) == TLS1_RT_HEARTBEAT) {
 640             /* We allow a 0 return */
 641             if(dtls1_process_heartbeat(s, SSL3_RECORD_get_data(rr),
 642                     SSL3_RECORD_get_length(rr)) < 0) {
 643                 return -1;
 644             }
 645             /* Exit and notify application to read again */
 646             SSL3_RECORD_set_length(rr, 0);
 647             s->rwstate = SSL_READING;
 648             BIO_clear_retry_flags(SSL_get_rbio(s));
 649             BIO_set_retry_read(SSL_get_rbio(s));
 650             return (-1);
 651         }
 652 #endif
 653         /* else it's a CCS message, or application data or wrong */
 654         else if (SSL3_RECORD_get_type(rr) != SSL3_RT_CHANGE_CIPHER_SPEC) {
 655             /*
 656              * Application data while renegotiating is allowed. Try again
 657              * reading.
 658              */
 659             if (SSL3_RECORD_get_type(rr)  == SSL3_RT_APPLICATION_DATA) {
 660                 BIO *bio;
 661                 s->s3->in_read_app_data = 2;
 662                 bio = SSL_get_rbio(s);
 663                 s->rwstate = SSL_READING;
 664                 BIO_clear_retry_flags(bio);
 665                 BIO_set_retry_read(bio);
 666                 return (-1);
 667             }
 668
 669             /* Not certain if this is the right error handling */
 670             al = SSL_AD_UNEXPECTED_MESSAGE;
 671             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
 672             goto f_err;
 673         }
 674
 675         if (dest_maxlen > 0) {
 676             /*
 677              * XDTLS: In a pathalogical case, the Client Hello may be
 678              * fragmented--don't always expect dest_maxlen bytes
 679              */
 680             if (SSL3_RECORD_get_length(rr)  < dest_maxlen) {
 681 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
 682                 /*
 683                  * for normal alerts rr->length is 2, while
 684                  * dest_maxlen is 7 if we were to handle this
 685                  * non-existing alert...
 686                  */
 687                 FIX ME
 688 #endif
 689                 s->rlayer.rstate = SSL_ST_READ_HEADER;
 690                 SSL3_RECORD_set_length(rr, 0);
 691                 goto start;
 692             }
 693
 694             /* now move 'n' bytes: */
 695             for (k = 0; k < dest_maxlen; k++) {
 696                 dest[k] = SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)];
 697                 SSL3_RECORD_add_off(rr, 1);
 698                 SSL3_RECORD_add_length(rr, -1);
 699             }
 700             *dest_len = dest_maxlen;
 701         }
 702     }
 703
 704     /*-
 705      * s->rlayer.d->handshake_fragment_len == 12  iff  rr->type == SSL3_RT_HANDSHAKE;
 706      * s->rlayer.d->alert_fragment_len == 7      iff  rr->type == SSL3_RT_ALERT.
 707      * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
 708      */
 709
 710     /* If we are a client, check for an incoming 'Hello Request': */
 711     if ((!s->server) &&
 712         (s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
 713         (s->rlayer.d->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
 714         (s->session != NULL) && (s->session->cipher != NULL)) {
 715         s->rlayer.d->handshake_fragment_len = 0;
 716
 717         if ((s->rlayer.d->handshake_fragment[1] != 0) ||
 718             (s->rlayer.d->handshake_fragment[2] != 0) ||
 719             (s->rlayer.d->handshake_fragment[3] != 0)) {
 720             al = SSL_AD_DECODE_ERROR;
 721             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
 722             goto err;
 723         }
 724
 725         /*
 726          * no need to check sequence number on HELLO REQUEST messages
 727          */
 728
 729         if (s->msg_callback)
 730             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 731                             s->rlayer.d->handshake_fragment, 4, s,
 732                             s->msg_callback_arg);
 733
 734         if (SSL_is_init_finished(s) &&
 735             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
 736             !s->s3->renegotiate) {
 737             s->d1->handshake_read_seq++;
 738             s->new_session = 1;
 739             ssl3_renegotiate(s);
 740             if (ssl3_renegotiate_check(s)) {
 741                 i = s->handshake_func(s);
 742                 if (i < 0)
 743                     return (i);
 744                 if (i == 0) {
 745                     SSLerr(SSL_F_DTLS1_READ_BYTES,
 746                            SSL_R_SSL_HANDSHAKE_FAILURE);
 747                     return (-1);
 748                 }
 749
 750                 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
 751                     if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
 752                         /* no read-ahead left? */
 753                         BIO *bio;
 754                         /*
 755                          * In the case where we try to read application data,
 756                          * but we trigger an SSL handshake, we return -1 with
 757                          * the retry option set.  Otherwise renegotiation may
 758                          * cause nasty problems in the blocking world
 759                          */
 760                         s->rwstate = SSL_READING;
 761                         bio = SSL_get_rbio(s);
 762                         BIO_clear_retry_flags(bio);
 763                         BIO_set_retry_read(bio);
 764                         return (-1);
 765                     }
 766                 }
 767             }
 768         }
 769         /*
 770          * we either finished a handshake or ignored the request, now try
 771          * again to obtain the (application) data we were asked for
 772          */
 773         goto start;
 774     }
 775
 776     if (s->rlayer.d->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH) {
 777         int alert_level = s->rlayer.d->alert_fragment[0];
 778         int alert_descr = s->rlayer.d->alert_fragment[1];
 779
 780         s->rlayer.d->alert_fragment_len = 0;
 781
 782         if (s->msg_callback)
 783             s->msg_callback(0, s->version, SSL3_RT_ALERT,
 784                             s->rlayer.d->alert_fragment, 2, s,
 785                             s->msg_callback_arg);
 786
 787         if (s->info_callback != NULL)
 788             cb = s->info_callback;
 789         else if (s->ctx->info_callback != NULL)
 790             cb = s->ctx->info_callback;
 791
 792         if (cb != NULL) {
 793             j = (alert_level << 8) | alert_descr;
 794             cb(s, SSL_CB_READ_ALERT, j);
 795         }
 796
 797         if (alert_level == SSL3_AL_WARNING) {
 798             s->s3->warn_alert = alert_descr;
 799             if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
 800 #ifndef OPENSSL_NO_SCTP
 801                 /*
 802                  * With SCTP and streams the socket may deliver app data
 803                  * after a close_notify alert. We have to check this first so
 804                  * that nothing gets discarded.
 805                  */
 806                 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 807                     BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
 808                     s->d1->shutdown_received = 1;
 809                     s->rwstate = SSL_READING;
 810                     BIO_clear_retry_flags(SSL_get_rbio(s));
 811                     BIO_set_retry_read(SSL_get_rbio(s));
 812                     return -1;
 813                 }
 814 #endif
 815                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
 816                 return (0);
 817             }
 818 #if 0
 819             /* XXX: this is a possible improvement in the future */
 820             /* now check if it's a missing record */
 821             if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE) {
 822                 unsigned short seq;
 823                 unsigned int frag_off;
 824                 unsigned char *p = &(s->rlayer.d->alert_fragment[2]);
 825
 826                 n2s(p, seq);
 827                 n2l3(p, frag_off);
 828
 829                 dtls1_retransmit_message(s,
 830                                          dtls1_get_queue_priority
 831                                          (frag->msg_header.seq, 0), frag_off,
 832                                          &found);
 833                 if (!found && SSL_in_init(s)) {
 834                     /*
 835                      * fprintf( stderr,"in init = %d\n", SSL_in_init(s));
 836                      */
 837                     /*
 838                      * requested a message not yet sent, send an alert
 839                      * ourselves
 840                      */
 841                     ssl3_send_alert(s, SSL3_AL_WARNING,
 842                                     DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
 843                 }
 844             }
 845 #endif
 846         } else if (alert_level == SSL3_AL_FATAL) {
 847             char tmp[16];
 848
 849             s->rwstate = SSL_NOTHING;
 850             s->s3->fatal_alert = alert_descr;
 851             SSLerr(SSL_F_DTLS1_READ_BYTES,
 852                    SSL_AD_REASON_OFFSET + alert_descr);
 853             BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
 854             ERR_add_error_data(2, "SSL alert number ", tmp);
 855             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
 856             SSL_CTX_remove_session(s->ctx, s->session);
 857             return (0);
 858         } else {
 859             al = SSL_AD_ILLEGAL_PARAMETER;
 860             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
 861             goto f_err;
 862         }
 863
 864         goto start;
 865     }
 866
 867     if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
 868                                             * shutdown */
 869         s->rwstate = SSL_NOTHING;
 870         SSL3_RECORD_set_length(rr, 0);
 871         return (0);
 872     }
 873
 874     if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
 875         struct ccs_header_st ccs_hdr;
 876         unsigned int ccs_hdr_len = DTLS1_CCS_HEADER_LENGTH;
 877
 878         dtls1_get_ccs_header(SSL3_RECORD_get_data(rr), &ccs_hdr);
 879
 880         if (s->version == DTLS1_BAD_VER)
 881             ccs_hdr_len = 3;
 882
 883         /*
 884          * 'Change Cipher Spec' is just a single byte, so we know exactly
 885          * what the record payload has to look like
 886          */
 887         /* XDTLS: check that epoch is consistent */
 888         if ((SSL3_RECORD_get_length(rr) != ccs_hdr_len)
 889                 || (SSL3_RECORD_get_off(rr) != 0)
 890                 || (SSL3_RECORD_get_data(rr)[0] != SSL3_MT_CCS)) {
 891             i = SSL_AD_ILLEGAL_PARAMETER;
 892             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_CHANGE_CIPHER_SPEC);
 893             goto err;
 894         }
 895
 896         SSL3_RECORD_set_length(rr, 0);
 897
 898         if (s->msg_callback)
 899             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
 900                 SSL3_RECORD_get_data(rr), 1, s, s->msg_callback_arg);
 901
 902         /*
 903          * We can't process a CCS now, because previous handshake messages
 904          * are still missing, so just drop it.
 905          */
 906         if (!s->d1->change_cipher_spec_ok) {
 907             goto start;
 908         }
 909
 910         s->d1->change_cipher_spec_ok = 0;
 911
 912         s->s3->change_cipher_spec = 1;
 913         if (!ssl3_do_change_cipher_spec(s))
 914             goto err;
 915
 916         /* do this whenever CCS is processed */
 917         dtls1_reset_seq_numbers(s, SSL3_CC_READ);
 918
 919         if (s->version == DTLS1_BAD_VER)
 920             s->d1->handshake_read_seq++;
 921
 922 #ifndef OPENSSL_NO_SCTP
 923         /*
 924          * Remember that a CCS has been received, so that an old key of
 925          * SCTP-Auth can be deleted when a CCS is sent. Will be ignored if no
 926          * SCTP is used
 927          */
 928         BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD, 1, NULL);
 929 #endif
 930
 931         goto start;
 932     }
 933
 934     /*
 935      * Unexpected handshake message (Client Hello, or protocol violation)
 936      */
 937     if ((s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
 938         !s->in_handshake) {
 939         struct hm_header_st msg_hdr;
 940
 941         /* this may just be a stale retransmit */
 942         dtls1_get_message_header(rr->data, &msg_hdr);
 943         if (SSL3_RECORD_get_epoch(rr) != s->rlayer.d->r_epoch) {
 944             SSL3_RECORD_set_length(rr, 0);
 945             goto start;
 946         }
 947
 948         /*
 949          * If we are server, we may have a repeated FINISHED of the client
 950          * here, then retransmit our CCS and FINISHED.
 951          */
 952         if (msg_hdr.type == SSL3_MT_FINISHED) {
 953             if (dtls1_check_timeout_num(s) < 0)
 954                 return -1;
 955
 956             dtls1_retransmit_buffered_messages(s);
 957             SSL3_RECORD_set_length(rr, 0);
 958             goto start;
 959         }
 960
 961         if (((s->state & SSL_ST_MASK) == SSL_ST_OK) &&
 962             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
 963             s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
 964             s->renegotiate = 1;
 965             s->new_session = 1;
 966         }
 967         i = s->handshake_func(s);
 968         if (i < 0)
 969             return (i);
 970         if (i == 0) {
 971             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
 972             return (-1);
 973         }
 974
 975         if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
 976             if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
 977                 /* no read-ahead left? */
 978                 BIO *bio;
 979                 /*
 980                  * In the case where we try to read application data, but we
 981                  * trigger an SSL handshake, we return -1 with the retry
 982                  * option set.  Otherwise renegotiation may cause nasty
 983                  * problems in the blocking world
 984                  */
 985                 s->rwstate = SSL_READING;
 986                 bio = SSL_get_rbio(s);
 987                 BIO_clear_retry_flags(bio);
 988                 BIO_set_retry_read(bio);
 989                 return (-1);
 990             }
 991         }
 992         goto start;
 993     }
 994
 995     switch (SSL3_RECORD_get_type(rr)) {
 996     default:
 997         /* TLS just ignores unknown message types */
 998         if (s->version == TLS1_VERSION) {
 999             SSL3_RECORD_set_length(rr, 0);
1000             goto start;
1001         }
1002         al = SSL_AD_UNEXPECTED_MESSAGE;
1003         SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1004         goto f_err;
1005     case SSL3_RT_CHANGE_CIPHER_SPEC:
1006     case SSL3_RT_ALERT:
1007     case SSL3_RT_HANDSHAKE:
1008         /*
1009          * we already handled all of these, with the possible exception of
1010          * SSL3_RT_HANDSHAKE when s->in_handshake is set, but that should not
1011          * happen when type != rr->type
1012          */
1013         al = SSL_AD_UNEXPECTED_MESSAGE;
1014         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
1015         goto f_err;
1016     case SSL3_RT_APPLICATION_DATA:
1017         /*
1018          * At this point, we were expecting handshake data, but have
1019          * application data.  If the library was running inside ssl3_read()
1020          * (i.e. in_read_app_data is set) and it makes sense to read
1021          * application data at this point (session renegotiation not yet
1022          * started), we will indulge it.
1023          */
1024         if (s->s3->in_read_app_data &&
1025             (s->s3->total_renegotiations != 0) &&
1026             (((s->state & SSL_ST_CONNECT) &&
1027               (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1028               (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1029              ) || ((s->state & SSL_ST_ACCEPT) &&
1030                    (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1031                    (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1032              )
1033             )) {
1034             s->s3->in_read_app_data = 2;
1035             return (-1);
1036         } else {
1037             al = SSL_AD_UNEXPECTED_MESSAGE;
1038             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1039             goto f_err;
1040         }
1041     }
1042     /* not reached */
1043
1044  f_err:
1045     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1046  err:
1047     return (-1);
1048 }
1049
1050
1051         /*
1052          * this only happens when a client hello is received and a handshake
1053          * is started.
1054          */
1055 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
1056                                    int len, int peek)
1057 {
1058
1059     if ((type == SSL3_RT_HANDSHAKE)
1060             && (s->rlayer.d->handshake_fragment_len > 0))
1061         /* (partially) satisfy request from storage */
1062     {
1063         unsigned char *src = s->rlayer.d->handshake_fragment;
1064         unsigned char *dst = buf;
1065         unsigned int k, n;
1066
1067         /* peek == 0 */
1068         n = 0;
1069         while ((len > 0) && (s->rlayer.d->handshake_fragment_len > 0)) {
1070             *dst++ = *src++;
1071             len--;
1072             s->rlayer.d->handshake_fragment_len--;
1073             n++;
1074         }
1075         /* move any remaining fragment bytes: */
1076         for (k = 0; k < s->rlayer.d->handshake_fragment_len; k++)
1077             s->rlayer.d->handshake_fragment[k] = *src++;
1078         return n;
1079     }
1080
1081     return 0;
1082 }
1083
1084 /*
1085  * Call this to write data in records of type 'type' It will return <= 0 if
1086  * not all data has been sent or non-blocking IO.
1087  */
1088 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len)
1089 {
1090     int i;
1091
1092     OPENSSL_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH);
1093     s->rwstate = SSL_NOTHING;
1094     i = do_dtls1_write(s, type, buf, len, 0);
1095     return i;
1096 }
1097
1098 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
1099                    unsigned int len, int create_empty_fragment)
1100 {
1101     unsigned char *p, *pseq;
1102     int i, mac_size, clear = 0;
1103     int prefix_len = 0;
1104     int eivlen;
1105     SSL3_RECORD *wr;
1106     SSL3_BUFFER *wb;
1107     SSL_SESSION *sess;
1108
1109     wb = &s->rlayer.wbuf;
1110
1111     /*
1112      * first check if there is a SSL3_BUFFER still being written out.  This
1113      * will happen with non blocking IO
1114      */
1115     if (SSL3_BUFFER_get_left(wb) != 0) {
1116         OPENSSL_assert(0);      /* XDTLS: want to see if we ever get here */
1117         return (ssl3_write_pending(s, type, buf, len));
1118     }
1119
1120     /* If we have an alert to send, lets send it */
1121     if (s->s3->alert_dispatch) {
1122         i = s->method->ssl_dispatch_alert(s);
1123         if (i <= 0)
1124             return (i);
1125         /* if it went, fall through and send more stuff */
1126     }
1127
1128     if (len == 0 && !create_empty_fragment)
1129         return 0;
1130
1131     wr = &s->rlayer.wrec;
1132     sess = s->session;
1133
1134     if ((sess == NULL) ||
1135         (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL))
1136         clear = 1;
1137
1138     if (clear)
1139         mac_size = 0;
1140     else {
1141         mac_size = EVP_MD_CTX_size(s->write_hash);
1142         if (mac_size < 0)
1143             goto err;
1144     }
1145
1146     p = SSL3_BUFFER_get_buf(wb) + prefix_len;
1147
1148     /* write the header */
1149
1150     *(p++) = type & 0xff;
1151     SSL3_RECORD_set_type(wr, type);
1152     /*
1153      * Special case: for hello verify request, client version 1.0 and we
1154      * haven't decided which version to use yet send back using version 1.0
1155      * header: otherwise some clients will ignore it.
1156      */
1157     if (s->method->version == DTLS_ANY_VERSION) {
1158         *(p++) = DTLS1_VERSION >> 8;
1159         *(p++) = DTLS1_VERSION & 0xff;
1160     } else {
1161         *(p++) = s->version >> 8;
1162         *(p++) = s->version & 0xff;
1163     }
1164
1165     /* field where we are to write out packet epoch, seq num and len */
1166     pseq = p;
1167     p += 10;
1168
1169     /* Explicit IV length, block ciphers appropriate version flag */
1170     if (s->enc_write_ctx) {
1171         int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
1172         if (mode == EVP_CIPH_CBC_MODE) {
1173             eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
1174             if (eivlen <= 1)
1175                 eivlen = 0;
1176         }
1177         /* Need explicit part of IV for GCM mode */
1178         else if (mode == EVP_CIPH_GCM_MODE)
1179             eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
1180         else
1181             eivlen = 0;
1182     } else
1183         eivlen = 0;
1184
1185     /* lets setup the record stuff. */
1186     SSL3_RECORD_set_data(wr, p + eivlen); /* make room for IV in case of CBC */
1187     SSL3_RECORD_set_length(wr, (int)len);
1188     SSL3_RECORD_set_input(wr, (unsigned char *)buf);
1189
1190     /*
1191      * we now 'read' from wr->input, wr->length bytes into wr->data
1192      */
1193
1194     /* first we compress */
1195     if (s->compress != NULL) {
1196         if (!ssl3_do_compress(s)) {
1197             SSLerr(SSL_F_DO_DTLS1_WRITE, SSL_R_COMPRESSION_FAILURE);
1198             goto err;
1199         }
1200     } else {
1201         memcpy(SSL3_RECORD_get_data(wr), SSL3_RECORD_get_input(wr),
1202                SSL3_RECORD_get_length(wr));
1203         SSL3_RECORD_reset_input(wr);
1204     }
1205
1206     /*
1207      * we should still have the output to wr->data and the input from
1208      * wr->input.  Length should be wr->length. wr->data still points in the
1209      * wb->buf
1210      */
1211
1212     if (mac_size != 0) {
1213         if (s->method->ssl3_enc->mac(s,
1214                 &(p[SSL3_RECORD_get_length(wr) + eivlen]), 1) < 0)
1215             goto err;
1216         SSL3_RECORD_add_length(wr, mac_size);
1217     }
1218
1219     /* this is true regardless of mac size */
1220     SSL3_RECORD_set_data(wr, p);
1221     SSL3_RECORD_reset_input(wr);
1222
1223     if (eivlen)
1224         SSL3_RECORD_add_length(wr, eivlen);
1225
1226     if (s->method->ssl3_enc->enc(s, 1) < 1)
1227         goto err;
1228
1229     /* record length after mac and block padding */
1230     /*
1231      * if (type == SSL3_RT_APPLICATION_DATA || (type == SSL3_RT_ALERT && !
1232      * SSL_in_init(s)))
1233      */
1234
1235     /* there's only one epoch between handshake and app data */
1236
1237     s2n(s->rlayer.d->w_epoch, pseq);
1238
1239     /* XDTLS: ?? */
1240     /*
1241      * else s2n(s->d1->handshake_epoch, pseq);
1242      */
1243
1244     memcpy(pseq, &(s->rlayer.write_sequence[2]), 6);
1245     pseq += 6;
1246     s2n(SSL3_RECORD_get_length(wr), pseq);
1247
1248     if (s->msg_callback)
1249         s->msg_callback(1, 0, SSL3_RT_HEADER, pseq - DTLS1_RT_HEADER_LENGTH,
1250                         DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
1251
1252     /*
1253      * we should now have wr->data pointing to the encrypted data, which is
1254      * wr->length long
1255      */
1256     SSL3_RECORD_set_type(wr, type); /* not needed but helps for debugging */
1257     SSL3_RECORD_add_length(wr, DTLS1_RT_HEADER_LENGTH);
1258
1259     ssl3_record_sequence_update(&(s->rlayer.write_sequence[0]));
1260
1261     if (create_empty_fragment) {
1262         /*
1263          * we are in a recursive call; just return the length, don't write
1264          * out anything here
1265          */
1266         return wr->length;
1267     }
1268
1269     /* now let's set up wb */
1270     SSL3_BUFFER_set_left(wb, prefix_len + SSL3_RECORD_get_length(wr));
1271     SSL3_BUFFER_set_offset(wb, 0);
1272
1273     /*
1274      * memorize arguments so that ssl3_write_pending can detect bad write
1275      * retries later
1276      */
1277     s->rlayer.wpend_tot = len;
1278     s->rlayer.wpend_buf = buf;
1279     s->rlayer.wpend_type = type;
1280     s->rlayer.wpend_ret = len;
1281
1282     /* we now just need to write the buffer */
1283     return ssl3_write_pending(s, type, buf, len);
1284  err:
1285     return -1;
1286 }
1287
1288 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
1289                                       unsigned int *is_next_epoch)
1290 {
1291
1292     *is_next_epoch = 0;
1293
1294     /* In current epoch, accept HM, CCS, DATA, & ALERT */
1295     if (rr->epoch == s->rlayer.d->r_epoch)
1296         return &s->rlayer.d->bitmap;
1297
1298     /* Only HM and ALERT messages can be from the next epoch */
1299     else if (rr->epoch == (unsigned long)(s->rlayer.d->r_epoch + 1) &&
1300             (rr->type == SSL3_RT_HANDSHAKE || rr->type == SSL3_RT_ALERT)) {
1301         *is_next_epoch = 1;
1302         return &s->rlayer.d->next_bitmap;
1303     }
1304
1305     return NULL;
1306 }
1307
1308 void dtls1_reset_seq_numbers(SSL *s, int rw)
1309 {
1310     unsigned char *seq;
1311     unsigned int seq_bytes = sizeof(s->rlayer.read_sequence);
1312
1313     if (rw & SSL3_CC_READ) {
1314         seq = s->rlayer.read_sequence;
1315         s->rlayer.d->r_epoch++;
1316         memcpy(&(s->rlayer.d->bitmap), &(s->rlayer.d->next_bitmap),
1317             sizeof(DTLS1_BITMAP));
1318         memset(&(s->rlayer.d->next_bitmap), 0x00, sizeof(DTLS1_BITMAP));
1319     } else {
1320         seq = s->rlayer.write_sequence;
1321         memcpy(s->rlayer.d->last_write_sequence, seq,
1322                sizeof(s->rlayer.write_sequence));
1323         s->rlayer.d->w_epoch++;
1324     }
1325
1326     memset(seq, 0x00, seq_bytes);
1327 }