ssl/record/rec_layer_d1.c

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