ssl/record/rec_layer_d1.c

   1 /*
   2  * Copyright 2005-2017 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdio.h>
  11 #include <errno.h>
  12 #include "../ssl_locl.h"
  13 #include <openssl/evp.h>
  14 #include <openssl/buffer.h>
  15 #include "record_locl.h"
  16 #include "../packet_locl.h"
  17 #include "internal/cryptlib.h"
  18
  19 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl)
  20 {
  21     DTLS_RECORD_LAYER *d;
  22
  23     if ((d = OPENSSL_malloc(sizeof(*d))) == NULL)
  24         return 0;
  25
  26     rl->d = d;
  27
  28     d->unprocessed_rcds.q = pqueue_new();
  29     d->processed_rcds.q = pqueue_new();
  30     d->buffered_app_data.q = pqueue_new();
  31
  32     if (d->unprocessed_rcds.q == NULL || d->processed_rcds.q == NULL
  33         || d->buffered_app_data.q == NULL) {
  34         pqueue_free(d->unprocessed_rcds.q);
  35         pqueue_free(d->processed_rcds.q);
  36         pqueue_free(d->buffered_app_data.q);
  37         OPENSSL_free(d);
  38         rl->d = NULL;
  39         return 0;
  40     }
  41
  42     return 1;
  43 }
  44
  45 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl)
  46 {
  47     DTLS_RECORD_LAYER_clear(rl);
  48     pqueue_free(rl->d->unprocessed_rcds.q);
  49     pqueue_free(rl->d->processed_rcds.q);
  50     pqueue_free(rl->d->buffered_app_data.q);
  51     OPENSSL_free(rl->d);
  52     rl->d = NULL;
  53 }
  54
  55 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl)
  56 {
  57     DTLS_RECORD_LAYER *d;
  58     pitem *item = NULL;
  59     DTLS1_RECORD_DATA *rdata;
  60     pqueue *unprocessed_rcds;
  61     pqueue *processed_rcds;
  62     pqueue *buffered_app_data;
  63
  64     d = rl->d;
  65
  66     while ((item = pqueue_pop(d->unprocessed_rcds.q)) != NULL) {
  67         rdata = (DTLS1_RECORD_DATA *)item->data;
  68         OPENSSL_free(rdata->rbuf.buf);
  69         OPENSSL_free(item->data);
  70         pitem_free(item);
  71     }
  72
  73     while ((item = pqueue_pop(d->processed_rcds.q)) != NULL) {
  74         rdata = (DTLS1_RECORD_DATA *)item->data;
  75         OPENSSL_free(rdata->rbuf.buf);
  76         OPENSSL_free(item->data);
  77         pitem_free(item);
  78     }
  79
  80     while ((item = pqueue_pop(d->buffered_app_data.q)) != NULL) {
  81         rdata = (DTLS1_RECORD_DATA *)item->data;
  82         OPENSSL_free(rdata->rbuf.buf);
  83         OPENSSL_free(item->data);
  84         pitem_free(item);
  85     }
  86
  87     unprocessed_rcds = d->unprocessed_rcds.q;
  88     processed_rcds = d->processed_rcds.q;
  89     buffered_app_data = d->buffered_app_data.q;
  90     memset(d, 0, sizeof(*d));
  91     d->unprocessed_rcds.q = unprocessed_rcds;
  92     d->processed_rcds.q = processed_rcds;
  93     d->buffered_app_data.q = buffered_app_data;
  94 }
  95
  96 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e)
  97 {
  98     if (e == rl->d->w_epoch - 1) {
  99         memcpy(rl->d->curr_write_sequence,
 100                rl->write_sequence, sizeof(rl->write_sequence));
 101         memcpy(rl->write_sequence,
 102                rl->d->last_write_sequence, sizeof(rl->write_sequence));
 103     } else if (e == rl->d->w_epoch + 1) {
 104         memcpy(rl->d->last_write_sequence,
 105                rl->write_sequence, sizeof(unsigned char[8]));
 106         memcpy(rl->write_sequence,
 107                rl->d->curr_write_sequence, sizeof(rl->write_sequence));
 108     }
 109     rl->d->w_epoch = e;
 110 }
 111
 112 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq)
 113 {
 114     memcpy(rl->write_sequence, seq, SEQ_NUM_SIZE);
 115 }
 116
 117 /* copy buffered record into SSL structure */
 118 static int dtls1_copy_record(SSL *s, pitem *item)
 119 {
 120     DTLS1_RECORD_DATA *rdata;
 121
 122     rdata = (DTLS1_RECORD_DATA *)item->data;
 123
 124     SSL3_BUFFER_release(&s->rlayer.rbuf);
 125
 126     s->rlayer.packet = rdata->packet;
 127     s->rlayer.packet_length = rdata->packet_length;
 128     memcpy(&s->rlayer.rbuf, &(rdata->rbuf), sizeof(SSL3_BUFFER));
 129     memcpy(&s->rlayer.rrec, &(rdata->rrec), sizeof(SSL3_RECORD));
 130
 131     /* Set proper sequence number for mac calculation */
 132     memcpy(&(s->rlayer.read_sequence[2]), &(rdata->packet[5]), 6);
 133
 134     return 1;
 135 }
 136
 137 int dtls1_buffer_record(SSL *s, record_pqueue *queue, unsigned char *priority)
 138 {
 139     DTLS1_RECORD_DATA *rdata;
 140     pitem *item;
 141
 142     /* Limit the size of the queue to prevent DOS attacks */
 143     if (pqueue_size(queue->q) >= 100)
 144         return 0;
 145
 146     rdata = OPENSSL_malloc(sizeof(*rdata));
 147     item = pitem_new(priority, rdata);
 148     if (rdata == NULL || item == NULL) {
 149         OPENSSL_free(rdata);
 150         pitem_free(item);
 151         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
 152         return -1;
 153     }
 154
 155     rdata->packet = s->rlayer.packet;
 156     rdata->packet_length = s->rlayer.packet_length;
 157     memcpy(&(rdata->rbuf), &s->rlayer.rbuf, sizeof(SSL3_BUFFER));
 158     memcpy(&(rdata->rrec), &s->rlayer.rrec, sizeof(SSL3_RECORD));
 159
 160     item->data = rdata;
 161
 162 #ifndef OPENSSL_NO_SCTP
 163     /* Store bio_dgram_sctp_rcvinfo struct */
 164     if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 165         (SSL_get_state(s) == TLS_ST_SR_FINISHED
 166          || SSL_get_state(s) == TLS_ST_CR_FINISHED)) {
 167         BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_GET_RCVINFO,
 168                  sizeof(rdata->recordinfo), &rdata->recordinfo);
 169     }
 170 #endif
 171
 172     s->rlayer.packet = NULL;
 173     s->rlayer.packet_length = 0;
 174     memset(&s->rlayer.rbuf, 0, sizeof(s->rlayer.rbuf));
 175     memset(&s->rlayer.rrec, 0, sizeof(s->rlayer.rrec));
 176
 177     if (!ssl3_setup_buffers(s)) {
 178         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
 179         OPENSSL_free(rdata->rbuf.buf);
 180         OPENSSL_free(rdata);
 181         pitem_free(item);
 182         return -1;
 183     }
 184
 185     /* insert should not fail, since duplicates are dropped */
 186     if (pqueue_insert(queue->q, item) == NULL) {
 187         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
 188         OPENSSL_free(rdata->rbuf.buf);
 189         OPENSSL_free(rdata);
 190         pitem_free(item);
 191         return -1;
 192     }
 193
 194     return 1;
 195 }
 196
 197 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
 198 {
 199     pitem *item;
 200
 201     item = pqueue_pop(queue->q);
 202     if (item) {
 203         dtls1_copy_record(s, item);
 204
 205         OPENSSL_free(item->data);
 206         pitem_free(item);
 207
 208         return 1;
 209     }
 210
 211     return 0;
 212 }
 213
 214 /*
 215  * retrieve a buffered record that belongs to the new epoch, i.e., not
 216  * processed yet
 217  */
 218 #define dtls1_get_unprocessed_record(s) \
 219                    dtls1_retrieve_buffered_record((s), \
 220                    &((s)->rlayer.d->unprocessed_rcds))
 221
 222 int dtls1_process_buffered_records(SSL *s)
 223 {
 224     pitem *item;
 225     SSL3_BUFFER *rb;
 226     SSL3_RECORD *rr;
 227     DTLS1_BITMAP *bitmap;
 228     unsigned int is_next_epoch;
 229     int replayok = 1;
 230
 231     item = pqueue_peek(s->rlayer.d->unprocessed_rcds.q);
 232     if (item) {
 233         /* Check if epoch is current. */
 234         if (s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch)
 235             return 1;         /* Nothing to do. */
 236
 237         rr = RECORD_LAYER_get_rrec(&s->rlayer);
 238
 239         rb = RECORD_LAYER_get_rbuf(&s->rlayer);
 240
 241         if (SSL3_BUFFER_get_left(rb) > 0) {
 242             /*
 243              * We've still got data from the current packet to read. There could
 244              * be a record from the new epoch in it - so don't overwrite it
 245              * with the unprocessed records yet (we'll do it when we've
 246              * finished reading the current packet).
 247              */
 248             return 1;
 249         }
 250
 251         /* Process all the records. */
 252         while (pqueue_peek(s->rlayer.d->unprocessed_rcds.q)) {
 253             dtls1_get_unprocessed_record(s);
 254             bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
 255             if (bitmap == NULL) {
 256                 /*
 257                  * Should not happen. This will only ever be NULL when the
 258                  * current record is from a different epoch. But that cannot
 259                  * be the case because we already checked the epoch above
 260                  */
 261                  SSLerr(SSL_F_DTLS1_PROCESS_BUFFERED_RECORDS,
 262                         ERR_R_INTERNAL_ERROR);
 263                  return 0;
 264             }
 265 #ifndef OPENSSL_NO_SCTP
 266             /* Only do replay check if no SCTP bio */
 267             if (!BIO_dgram_is_sctp(SSL_get_rbio(s)))
 268 #endif
 269             {
 270                 /*
 271                  * Check whether this is a repeat, or aged record. We did this
 272                  * check once already when we first received the record - but
 273                  * we might have updated the window since then due to
 274                  * records we subsequently processed.
 275                  */
 276                 replayok = dtls1_record_replay_check(s, bitmap);
 277             }
 278
 279             if (!replayok || !dtls1_process_record(s, bitmap)) {
 280                 /* dump this record */
 281                 rr->length = 0;
 282                 RECORD_LAYER_reset_packet_length(&s->rlayer);
 283                 continue;
 284             }
 285
 286             if (dtls1_buffer_record(s, &(s->rlayer.d->processed_rcds),
 287                     SSL3_RECORD_get_seq_num(s->rlayer.rrec)) < 0)
 288                 return 0;
 289         }
 290     }
 291
 292     /*
 293      * sync epoch numbers once all the unprocessed records have been
 294      * processed
 295      */
 296     s->rlayer.d->processed_rcds.epoch = s->rlayer.d->r_epoch;
 297     s->rlayer.d->unprocessed_rcds.epoch = s->rlayer.d->r_epoch + 1;
 298
 299     return 1;
 300 }
 301
 302 /*-
 303  * Return up to 'len' payload bytes received in 'type' records.
 304  * 'type' is one of the following:
 305  *
 306  *   -  SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
 307  *   -  SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
 308  *   -  0 (during a shutdown, no data has to be returned)
 309  *
 310  * If we don't have stored data to work from, read a SSL/TLS record first
 311  * (possibly multiple records if we still don't have anything to return).
 312  *
 313  * This function must handle any surprises the peer may have for us, such as
 314  * Alert records (e.g. close_notify) or renegotiation requests. ChangeCipherSpec
 315  * messages are treated as if they were handshake messages *if* the |recd_type|
 316  * argument is non NULL.
 317  * Also if record payloads contain fragments too small to process, we store
 318  * them until there is enough for the respective protocol (the record protocol
 319  * may use arbitrary fragmentation and even interleaving):
 320  *     Change cipher spec protocol
 321  *             just 1 byte needed, no need for keeping anything stored
 322  *     Alert protocol
 323  *             2 bytes needed (AlertLevel, AlertDescription)
 324  *     Handshake protocol
 325  *             4 bytes needed (HandshakeType, uint24 length) -- we just have
 326  *             to detect unexpected Client Hello and Hello Request messages
 327  *             here, anything else is handled by higher layers
 328  *     Application data protocol
 329  *             none of our business
 330  */
 331 int dtls1_read_bytes(SSL *s, int type, int *recvd_type, unsigned char *buf,
 332                      size_t len, int peek, size_t *readbytes)
 333 {
 334     int al, i, j, iret;
 335     size_t n;
 336     SSL3_RECORD *rr;
 337     void (*cb) (const SSL *ssl, int type2, int val) = NULL;
 338
 339     if (!SSL3_BUFFER_is_initialised(&s->rlayer.rbuf)) {
 340         /* Not initialized yet */
 341         if (!ssl3_setup_buffers(s))
 342             return -1;
 343     }
 344
 345     if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
 346          (type != SSL3_RT_HANDSHAKE)) ||
 347         (peek && (type != SSL3_RT_APPLICATION_DATA))) {
 348         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
 349         return -1;
 350     }
 351
 352     if (!ossl_statem_get_in_handshake(s) && SSL_in_init(s))
 353     {
 354         /* type == SSL3_RT_APPLICATION_DATA */
 355         i = s->handshake_func(s);
 356         if (i < 0)
 357             return i;
 358         if (i == 0) {
 359             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
 360             return -1;
 361         }
 362     }
 363
 364  start:
 365     s->rwstate = SSL_NOTHING;
 366
 367     /*-
 368      * s->s3->rrec.type         - is the type of record
 369      * s->s3->rrec.data,    - data
 370      * s->s3->rrec.off,     - offset into 'data' for next read
 371      * s->s3->rrec.length,  - number of bytes.
 372      */
 373     rr = s->rlayer.rrec;
 374
 375     /*
 376      * We are not handshaking and have no data yet, so process data buffered
 377      * during the last handshake in advance, if any.
 378      */
 379     if (SSL_is_init_finished(s) && SSL3_RECORD_get_length(rr) == 0) {
 380         pitem *item;
 381         item = pqueue_pop(s->rlayer.d->buffered_app_data.q);
 382         if (item) {
 383 #ifndef OPENSSL_NO_SCTP
 384             /* Restore bio_dgram_sctp_rcvinfo struct */
 385             if (BIO_dgram_is_sctp(SSL_get_rbio(s))) {
 386                 DTLS1_RECORD_DATA *rdata = (DTLS1_RECORD_DATA *)item->data;
 387                 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_SET_RCVINFO,
 388                          sizeof(rdata->recordinfo), &rdata->recordinfo);
 389             }
 390 #endif
 391
 392             dtls1_copy_record(s, item);
 393
 394             OPENSSL_free(item->data);
 395             pitem_free(item);
 396         }
 397     }
 398
 399     /* Check for timeout */
 400     if (dtls1_handle_timeout(s) > 0) {
 401         goto start;
 402     } else if (ossl_statem_in_error(s)) {
 403         /* dtls1_handle_timeout() has failed with a fatal error */
 404         return -1;
 405     }
 406
 407     /* get new packet if necessary */
 408     if ((SSL3_RECORD_get_length(rr) == 0)
 409         || (s->rlayer.rstate == SSL_ST_READ_BODY)) {
 410         iret = dtls1_get_record(s);
 411         if (iret <= 0) {
 412             iret = dtls1_read_failed(s, iret);
 413             /* anything other than a timeout is an error */
 414             if (iret <= 0)
 415                 return iret;
 416             else
 417                 goto start;
 418         }
 419     }
 420
 421     /*
 422      * Reset the count of consecutive warning alerts if we've got a non-empty
 423      * record that isn't an alert.
 424      */
 425     if (SSL3_RECORD_get_type(rr) != SSL3_RT_ALERT
 426             && SSL3_RECORD_get_length(rr) != 0)
 427         s->rlayer.alert_count = 0;
 428
 429     /* we now have a packet which can be read and processed */
 430
 431     if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
 432                                    * reset by ssl3_get_finished */
 433         && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
 434         /*
 435          * We now have application data between CCS and Finished. Most likely
 436          * the packets were reordered on their way, so buffer the application
 437          * data for later processing rather than dropping the connection.
 438          */
 439         if (dtls1_buffer_record(s, &(s->rlayer.d->buffered_app_data),
 440                                 SSL3_RECORD_get_seq_num(rr)) < 0) {
 441             SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
 442             return -1;
 443         }
 444         SSL3_RECORD_set_length(rr, 0);
 445         goto start;
 446     }
 447
 448     /*
 449      * If the other end has shut down, throw anything we read away (even in
 450      * 'peek' mode)
 451      */
 452     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
 453         SSL3_RECORD_set_length(rr, 0);
 454         s->rwstate = SSL_NOTHING;
 455         return 0;
 456     }
 457
 458     if (type == SSL3_RECORD_get_type(rr)
 459         || (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
 460             && type == SSL3_RT_HANDSHAKE && recvd_type != NULL)) {
 461         /*
 462          * SSL3_RT_APPLICATION_DATA or
 463          * SSL3_RT_HANDSHAKE or
 464          * SSL3_RT_CHANGE_CIPHER_SPEC
 465          */
 466         /*
 467          * make sure that we are not getting application data when we are
 468          * doing a handshake for the first time
 469          */
 470         if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
 471             (s->enc_read_ctx == NULL)) {
 472             al = SSL_AD_UNEXPECTED_MESSAGE;
 473             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
 474             goto f_err;
 475         }
 476
 477         if (recvd_type != NULL)
 478             *recvd_type = SSL3_RECORD_get_type(rr);
 479
 480         if (len == 0)
 481             return 0;
 482
 483         if (len > SSL3_RECORD_get_length(rr))
 484             n = SSL3_RECORD_get_length(rr);
 485         else
 486             n = len;
 487
 488         memcpy(buf, &(SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)]), n);
 489         if (!peek) {
 490             SSL3_RECORD_sub_length(rr, n);
 491             SSL3_RECORD_add_off(rr, n);
 492             if (SSL3_RECORD_get_length(rr) == 0) {
 493                 s->rlayer.rstate = SSL_ST_READ_HEADER;
 494                 SSL3_RECORD_set_off(rr, 0);
 495             }
 496         }
 497 #ifndef OPENSSL_NO_SCTP
 498         /*
 499          * We might had to delay a close_notify alert because of reordered
 500          * app data. If there was an alert and there is no message to read
 501          * anymore, finally set shutdown.
 502          */
 503         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 504             s->d1->shutdown_received
 505             && !BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
 506             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
 507             return 0;
 508         }
 509 #endif
 510         *readbytes = n;
 511         return 1;
 512     }
 513
 514     /*
 515      * If we get here, then type != rr->type; if we have a handshake message,
 516      * then it was unexpected (Hello Request or Client Hello).
 517      */
 518
 519     if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
 520         unsigned int alert_level, alert_descr;
 521         unsigned char *alert_bytes = SSL3_RECORD_get_data(rr)
 522                                      + SSL3_RECORD_get_off(rr);
 523         PACKET alert;
 524
 525         if (!PACKET_buf_init(&alert, alert_bytes, SSL3_RECORD_get_length(rr))
 526                 || !PACKET_get_1(&alert, &alert_level)
 527                 || !PACKET_get_1(&alert, &alert_descr)
 528                 || PACKET_remaining(&alert) != 0) {
 529             al = SSL_AD_UNEXPECTED_MESSAGE;
 530             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_INVALID_ALERT);
 531             goto f_err;
 532         }
 533
 534         if (s->msg_callback)
 535             s->msg_callback(0, s->version, SSL3_RT_ALERT, alert_bytes, 2, s,
 536                             s->msg_callback_arg);
 537
 538         if (s->info_callback != NULL)
 539             cb = s->info_callback;
 540         else if (s->ctx->info_callback != NULL)
 541             cb = s->ctx->info_callback;
 542
 543         if (cb != NULL) {
 544             j = (alert_level << 8) | alert_descr;
 545             cb(s, SSL_CB_READ_ALERT, j);
 546         }
 547
 548         if (alert_level == SSL3_AL_WARNING) {
 549             s->s3->warn_alert = alert_descr;
 550
 551             s->rlayer.alert_count++;
 552             if (s->rlayer.alert_count == MAX_WARN_ALERT_COUNT) {
 553                 al = SSL_AD_UNEXPECTED_MESSAGE;
 554                 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_TOO_MANY_WARN_ALERTS);
 555                 goto f_err;
 556             }
 557
 558             if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
 559 #ifndef OPENSSL_NO_SCTP
 560                 /*
 561                  * With SCTP and streams the socket may deliver app data
 562                  * after a close_notify alert. We have to check this first so
 563                  * that nothing gets discarded.
 564                  */
 565                 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
 566                     BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
 567                     s->d1->shutdown_received = 1;
 568                     s->rwstate = SSL_READING;
 569                     BIO_clear_retry_flags(SSL_get_rbio(s));
 570                     BIO_set_retry_read(SSL_get_rbio(s));
 571                     return -1;
 572                 }
 573 #endif
 574                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
 575                 return 0;
 576             }
 577         } else if (alert_level == SSL3_AL_FATAL) {
 578             char tmp[16];
 579
 580             s->rwstate = SSL_NOTHING;
 581             s->s3->fatal_alert = alert_descr;
 582             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
 583             BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
 584             ERR_add_error_data(2, "SSL alert number ", tmp);
 585             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
 586             SSL_CTX_remove_session(s->session_ctx, s->session);
 587             return 0;
 588         } else {
 589             al = SSL_AD_ILLEGAL_PARAMETER;
 590             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
 591             goto f_err;
 592         }
 593
 594         goto start;
 595     }
 596
 597     if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
 598                                             * shutdown */
 599         s->rwstate = SSL_NOTHING;
 600         SSL3_RECORD_set_length(rr, 0);
 601         return 0;
 602     }
 603
 604     if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
 605         /*
 606          * We can't process a CCS now, because previous handshake messages
 607          * are still missing, so just drop it.
 608          */
 609         SSL3_RECORD_set_length(rr, 0);
 610         goto start;
 611     }
 612
 613     /*
 614      * Unexpected handshake message (Client Hello, or protocol violation)
 615      */
 616     if ((SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) &&
 617             !ossl_statem_get_in_handshake(s)) {
 618         struct hm_header_st msg_hdr;
 619
 620         /*
 621          * This may just be a stale retransmit. Also sanity check that we have
 622          * at least enough record bytes for a message header
 623          */
 624         if (SSL3_RECORD_get_epoch(rr) != s->rlayer.d->r_epoch
 625                 || SSL3_RECORD_get_length(rr) < DTLS1_HM_HEADER_LENGTH) {
 626             SSL3_RECORD_set_length(rr, 0);
 627             goto start;
 628         }
 629
 630         dtls1_get_message_header(rr->data, &msg_hdr);
 631
 632         /*
 633          * If we are server, we may have a repeated FINISHED of the client
 634          * here, then retransmit our CCS and FINISHED.
 635          */
 636         if (msg_hdr.type == SSL3_MT_FINISHED) {
 637             if (dtls1_check_timeout_num(s) < 0)
 638                 return -1;
 639
 640             if (dtls1_retransmit_buffered_messages(s) <= 0) {
 641                 /* Fail if we encountered a fatal error */
 642                 if (ossl_statem_in_error(s))
 643                     return -1;
 644
 645             }
 646             SSL3_RECORD_set_length(rr, 0);
 647             goto start;
 648         }
 649
 650         /*
 651          * To get here we must be trying to read app data but found handshake
 652          * data. But if we're trying to read app data, and we're not in init
 653          * (which is tested for at the top of this function) then init must be
 654          * finished
 655          */
 656         if (!ossl_assert(SSL_is_init_finished(s))) {
 657             al = SSL_AD_INTERNAL_ERROR;
 658             SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
 659             goto f_err;
 660         }
 661
 662         /* We found handshake data, so we're going back into init */
 663         ossl_statem_set_in_init(s, 1);
 664
 665         i = s->handshake_func(s);
 666         if (i < 0)
 667             return i;
 668         if (i == 0) {
 669             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
 670             return -1;
 671         }
 672
 673         if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
 674             if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
 675                 /* no read-ahead left? */
 676                 BIO *bio;
 677                 /*
 678                  * In the case where we try to read application data, but we
 679                  * trigger an SSL handshake, we return -1 with the retry
 680                  * option set.  Otherwise renegotiation may cause nasty
 681                  * problems in the blocking world
 682                  */
 683                 s->rwstate = SSL_READING;
 684                 bio = SSL_get_rbio(s);
 685                 BIO_clear_retry_flags(bio);
 686                 BIO_set_retry_read(bio);
 687                 return -1;
 688             }
 689         }
 690         goto start;
 691     }
 692
 693     switch (SSL3_RECORD_get_type(rr)) {
 694     default:
 695         al = SSL_AD_UNEXPECTED_MESSAGE;
 696         SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
 697         goto f_err;
 698     case SSL3_RT_CHANGE_CIPHER_SPEC:
 699     case SSL3_RT_ALERT:
 700     case SSL3_RT_HANDSHAKE:
 701         /*
 702          * we already handled all of these, with the possible exception of
 703          * SSL3_RT_HANDSHAKE when ossl_statem_get_in_handshake(s) is true, but
 704          * that should not happen when type != rr->type
 705          */
 706         al = SSL_AD_UNEXPECTED_MESSAGE;
 707         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
 708         goto f_err;
 709     case SSL3_RT_APPLICATION_DATA:
 710         /*
 711          * At this point, we were expecting handshake data, but have
 712          * application data.  If the library was running inside ssl3_read()
 713          * (i.e. in_read_app_data is set) and it makes sense to read
 714          * application data at this point (session renegotiation not yet
 715          * started), we will indulge it.
 716          */
 717         if (s->s3->in_read_app_data &&
 718             (s->s3->total_renegotiations != 0) &&
 719             ossl_statem_app_data_allowed(s)) {
 720             s->s3->in_read_app_data = 2;
 721             return -1;
 722         } else {
 723             al = SSL_AD_UNEXPECTED_MESSAGE;
 724             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
 725             goto f_err;
 726         }
 727     }
 728     /* not reached */
 729
 730  f_err:
 731     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 732     return -1;
 733 }
 734
 735 /*
 736  * Call this to write data in records of type 'type' It will return <= 0 if
 737  * not all data has been sent or non-blocking IO.
 738  */
 739 int dtls1_write_bytes(SSL *s, int type, const void *buf, size_t len,
 740                       size_t *written)
 741 {
 742     int i;
 743
 744     if (!ossl_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH)) {
 745         SSLerr(SSL_F_DTLS1_WRITE_BYTES, ERR_R_INTERNAL_ERROR);
 746         return -1;
 747     }
 748     s->rwstate = SSL_NOTHING;
 749     i = do_dtls1_write(s, type, buf, len, 0, written);
 750     return i;
 751 }
 752
 753 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
 754                    size_t len, int create_empty_fragment, size_t *written)
 755 {
 756     unsigned char *p, *pseq;
 757     int i, mac_size, clear = 0;
 758     size_t prefix_len = 0;
 759     int eivlen;
 760     SSL3_RECORD wr;
 761     SSL3_BUFFER *wb;
 762     SSL_SESSION *sess;
 763
 764     wb = &s->rlayer.wbuf[0];
 765
 766     /*
 767      * first check if there is a SSL3_BUFFER still being written out.  This
 768      * will happen with non blocking IO
 769      */
 770     if (!ossl_assert(SSL3_BUFFER_get_left(wb) == 0)) {
 771         SSLerr(SSL_F_DO_DTLS1_WRITE, ERR_R_INTERNAL_ERROR);
 772         return 0;
 773     }
 774
 775     /* If we have an alert to send, lets send it */
 776     if (s->s3->alert_dispatch) {
 777         i = s->method->ssl_dispatch_alert(s);
 778         if (i <= 0)
 779             return i;
 780         /* if it went, fall through and send more stuff */
 781     }
 782
 783     if (len == 0 && !create_empty_fragment)
 784         return 0;
 785
 786     if (len > ssl_get_max_send_fragment(s)) {
 787         SSLerr(SSL_F_DO_DTLS1_WRITE, SSL_R_EXCEEDS_MAX_FRAGMENT_SIZE);
 788         return 0;
 789     }
 790
 791     sess = s->session;
 792
 793     if ((sess == NULL) ||
 794         (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL))
 795         clear = 1;
 796
 797     if (clear)
 798         mac_size = 0;
 799     else {
 800         mac_size = EVP_MD_CTX_size(s->write_hash);
 801         if (mac_size < 0)
 802             goto err;
 803     }
 804
 805     p = SSL3_BUFFER_get_buf(wb) + prefix_len;
 806
 807     /* write the header */
 808
 809     *(p++) = type & 0xff;
 810     SSL3_RECORD_set_type(&wr, type);
 811     /*
 812      * Special case: for hello verify request, client version 1.0 and we
 813      * haven't decided which version to use yet send back using version 1.0
 814      * header: otherwise some clients will ignore it.
 815      */
 816     if (s->method->version == DTLS_ANY_VERSION &&
 817         s->max_proto_version != DTLS1_BAD_VER) {
 818         *(p++) = DTLS1_VERSION >> 8;
 819         *(p++) = DTLS1_VERSION & 0xff;
 820     } else {
 821         *(p++) = s->version >> 8;
 822         *(p++) = s->version & 0xff;
 823     }
 824
 825     /* field where we are to write out packet epoch, seq num and len */
 826     pseq = p;
 827     p += 10;
 828
 829     /* Explicit IV length, block ciphers appropriate version flag */
 830     if (s->enc_write_ctx) {
 831         int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
 832         if (mode == EVP_CIPH_CBC_MODE) {
 833             eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
 834             if (eivlen <= 1)
 835                 eivlen = 0;
 836         }
 837         /* Need explicit part of IV for GCM mode */
 838         else if (mode == EVP_CIPH_GCM_MODE)
 839             eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
 840         else if (mode == EVP_CIPH_CCM_MODE)
 841             eivlen = EVP_CCM_TLS_EXPLICIT_IV_LEN;
 842         else
 843             eivlen = 0;
 844     } else
 845         eivlen = 0;
 846
 847     /* lets setup the record stuff. */
 848     SSL3_RECORD_set_data(&wr, p + eivlen); /* make room for IV in case of CBC */
 849     SSL3_RECORD_set_length(&wr, len);
 850     SSL3_RECORD_set_input(&wr, (unsigned char *)buf);
 851
 852     /*
 853      * we now 'read' from wr.input, wr.length bytes into wr.data
 854      */
 855
 856     /* first we compress */
 857     if (s->compress != NULL) {
 858         if (!ssl3_do_compress(s, &wr)) {
 859             SSLerr(SSL_F_DO_DTLS1_WRITE, SSL_R_COMPRESSION_FAILURE);
 860             goto err;
 861         }
 862     } else {
 863         memcpy(SSL3_RECORD_get_data(&wr), SSL3_RECORD_get_input(&wr),
 864                SSL3_RECORD_get_length(&wr));
 865         SSL3_RECORD_reset_input(&wr);
 866     }
 867
 868     /*
 869      * we should still have the output to wr.data and the input from
 870      * wr.input.  Length should be wr.length. wr.data still points in the
 871      * wb->buf
 872      */
 873
 874     if (!SSL_WRITE_ETM(s) && mac_size != 0) {
 875         if (!s->method->ssl3_enc->mac(s, &wr,
 876                                       &(p[SSL3_RECORD_get_length(&wr) + eivlen]),
 877                                       1))
 878             goto err;
 879         SSL3_RECORD_add_length(&wr, mac_size);
 880     }
 881
 882     /* this is true regardless of mac size */
 883     SSL3_RECORD_set_data(&wr, p);
 884     SSL3_RECORD_reset_input(&wr);
 885
 886     if (eivlen)
 887         SSL3_RECORD_add_length(&wr, eivlen);
 888
 889     if (s->method->ssl3_enc->enc(s, &wr, 1, 1) < 1)
 890         goto err;
 891
 892     if (SSL_WRITE_ETM(s) && mac_size != 0) {
 893         if (!s->method->ssl3_enc->mac(s, &wr,
 894                                       &(p[SSL3_RECORD_get_length(&wr)]), 1))
 895             goto err;
 896         SSL3_RECORD_add_length(&wr, mac_size);
 897     }
 898
 899     /* record length after mac and block padding */
 900
 901     /* there's only one epoch between handshake and app data */
 902
 903     s2n(s->rlayer.d->w_epoch, pseq);
 904
 905     memcpy(pseq, &(s->rlayer.write_sequence[2]), 6);
 906     pseq += 6;
 907     s2n(SSL3_RECORD_get_length(&wr), pseq);
 908
 909     if (s->msg_callback)
 910         s->msg_callback(1, 0, SSL3_RT_HEADER, pseq - DTLS1_RT_HEADER_LENGTH,
 911                         DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
 912
 913     /*
 914      * we should now have wr.data pointing to the encrypted data, which is
 915      * wr->length long
 916      */
 917     SSL3_RECORD_set_type(&wr, type); /* not needed but helps for debugging */
 918     SSL3_RECORD_add_length(&wr, DTLS1_RT_HEADER_LENGTH);
 919
 920     ssl3_record_sequence_update(&(s->rlayer.write_sequence[0]));
 921
 922     if (create_empty_fragment) {
 923         /*
 924          * we are in a recursive call; just return the length, don't write
 925          * out anything here
 926          */
 927         *written = wr.length;
 928         return 1;
 929     }
 930
 931     /* now let's set up wb */
 932     SSL3_BUFFER_set_left(wb, prefix_len + SSL3_RECORD_get_length(&wr));
 933     SSL3_BUFFER_set_offset(wb, 0);
 934
 935     /*
 936      * memorize arguments so that ssl3_write_pending can detect bad write
 937      * retries later
 938      */
 939     s->rlayer.wpend_tot = len;
 940     s->rlayer.wpend_buf = buf;
 941     s->rlayer.wpend_type = type;
 942     s->rlayer.wpend_ret = len;
 943
 944     /* we now just need to write the buffer */
 945     return ssl3_write_pending(s, type, buf, len, written);
 946  err:
 947     return -1;
 948 }
 949
 950 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
 951                                unsigned int *is_next_epoch)
 952 {
 953
 954     *is_next_epoch = 0;
 955
 956     /* In current epoch, accept HM, CCS, DATA, & ALERT */
 957     if (rr->epoch == s->rlayer.d->r_epoch)
 958         return &s->rlayer.d->bitmap;
 959
 960     /*
 961      * Only HM and ALERT messages can be from the next epoch and only if we
 962      * have already processed all of the unprocessed records from the last
 963      * epoch
 964      */
 965     else if (rr->epoch == (unsigned long)(s->rlayer.d->r_epoch + 1) &&
 966              s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch &&
 967              (rr->type == SSL3_RT_HANDSHAKE || rr->type == SSL3_RT_ALERT)) {
 968         *is_next_epoch = 1;
 969         return &s->rlayer.d->next_bitmap;
 970     }
 971
 972     return NULL;
 973 }
 974
 975 void dtls1_reset_seq_numbers(SSL *s, int rw)
 976 {
 977     unsigned char *seq;
 978     unsigned int seq_bytes = sizeof(s->rlayer.read_sequence);
 979
 980     if (rw & SSL3_CC_READ) {
 981         seq = s->rlayer.read_sequence;
 982         s->rlayer.d->r_epoch++;
 983         memcpy(&s->rlayer.d->bitmap, &s->rlayer.d->next_bitmap,
 984                sizeof(s->rlayer.d->bitmap));
 985         memset(&s->rlayer.d->next_bitmap, 0, sizeof(s->rlayer.d->next_bitmap));
 986
 987         /*
 988          * We must not use any buffered messages received from the previous
 989          * epoch
 990          */
 991         dtls1_clear_received_buffer(s);
 992     } else {
 993         seq = s->rlayer.write_sequence;
 994         memcpy(s->rlayer.d->last_write_sequence, seq,
 995                sizeof(s->rlayer.write_sequence));
 996         s->rlayer.d->w_epoch++;
 997     }
 998
 999     memset(seq, 0, seq_bytes);
1000 }