2 * Copyright 2005-2018 The OpenSSL Project Authors. All Rights Reserved.
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
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"
19 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl)
23 if ((d = OPENSSL_malloc(sizeof(*d))) == NULL) {
24 SSLerr(SSL_F_DTLS_RECORD_LAYER_NEW, ERR_R_MALLOC_FAILURE);
30 d->unprocessed_rcds.q = pqueue_new();
31 d->processed_rcds.q = pqueue_new();
32 d->buffered_app_data.q = pqueue_new();
34 if (d->unprocessed_rcds.q == NULL || d->processed_rcds.q == NULL
35 || d->buffered_app_data.q == NULL) {
36 pqueue_free(d->unprocessed_rcds.q);
37 pqueue_free(d->processed_rcds.q);
38 pqueue_free(d->buffered_app_data.q);
47 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl)
49 DTLS_RECORD_LAYER_clear(rl);
50 pqueue_free(rl->d->unprocessed_rcds.q);
51 pqueue_free(rl->d->processed_rcds.q);
52 pqueue_free(rl->d->buffered_app_data.q);
57 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl)
61 DTLS1_RECORD_DATA *rdata;
62 pqueue *unprocessed_rcds;
63 pqueue *processed_rcds;
64 pqueue *buffered_app_data;
68 while ((item = pqueue_pop(d->unprocessed_rcds.q)) != NULL) {
69 rdata = (DTLS1_RECORD_DATA *)item->data;
70 OPENSSL_free(rdata->rbuf.buf);
71 OPENSSL_free(item->data);
75 while ((item = pqueue_pop(d->processed_rcds.q)) != NULL) {
76 rdata = (DTLS1_RECORD_DATA *)item->data;
77 OPENSSL_free(rdata->rbuf.buf);
78 OPENSSL_free(item->data);
82 while ((item = pqueue_pop(d->buffered_app_data.q)) != NULL) {
83 rdata = (DTLS1_RECORD_DATA *)item->data;
84 OPENSSL_free(rdata->rbuf.buf);
85 OPENSSL_free(item->data);
89 unprocessed_rcds = d->unprocessed_rcds.q;
90 processed_rcds = d->processed_rcds.q;
91 buffered_app_data = d->buffered_app_data.q;
92 memset(d, 0, sizeof(*d));
93 d->unprocessed_rcds.q = unprocessed_rcds;
94 d->processed_rcds.q = processed_rcds;
95 d->buffered_app_data.q = buffered_app_data;
98 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e)
100 if (e == rl->d->w_epoch - 1) {
101 memcpy(rl->d->curr_write_sequence,
102 rl->write_sequence, sizeof(rl->write_sequence));
103 memcpy(rl->write_sequence,
104 rl->d->last_write_sequence, sizeof(rl->write_sequence));
105 } else if (e == rl->d->w_epoch + 1) {
106 memcpy(rl->d->last_write_sequence,
107 rl->write_sequence, sizeof(unsigned char[8]));
108 memcpy(rl->write_sequence,
109 rl->d->curr_write_sequence, sizeof(rl->write_sequence));
114 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq)
116 memcpy(rl->write_sequence, seq, SEQ_NUM_SIZE);
119 /* copy buffered record into SSL structure */
120 static int dtls1_copy_record(SSL *s, pitem *item)
122 DTLS1_RECORD_DATA *rdata;
124 rdata = (DTLS1_RECORD_DATA *)item->data;
126 SSL3_BUFFER_release(&s->rlayer.rbuf);
128 s->rlayer.packet = rdata->packet;
129 s->rlayer.packet_length = rdata->packet_length;
130 memcpy(&s->rlayer.rbuf, &(rdata->rbuf), sizeof(SSL3_BUFFER));
131 memcpy(&s->rlayer.rrec, &(rdata->rrec), sizeof(SSL3_RECORD));
133 /* Set proper sequence number for mac calculation */
134 memcpy(&(s->rlayer.read_sequence[2]), &(rdata->packet[5]), 6);
139 int dtls1_buffer_record(SSL *s, record_pqueue *queue, unsigned char *priority)
141 DTLS1_RECORD_DATA *rdata;
144 /* Limit the size of the queue to prevent DOS attacks */
145 if (pqueue_size(queue->q) >= 100)
148 rdata = OPENSSL_malloc(sizeof(*rdata));
149 item = pitem_new(priority, rdata);
150 if (rdata == NULL || item == NULL) {
153 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS1_BUFFER_RECORD,
154 ERR_R_INTERNAL_ERROR);
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));
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);
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));
180 if (!ssl3_setup_buffers(s)) {
181 /* SSLfatal() already called */
182 OPENSSL_free(rdata->rbuf.buf);
188 /* insert should not fail, since duplicates are dropped */
189 if (pqueue_insert(queue->q, item) == NULL) {
190 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS1_BUFFER_RECORD,
191 ERR_R_INTERNAL_ERROR);
192 OPENSSL_free(rdata->rbuf.buf);
201 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
205 item = pqueue_pop(queue->q);
207 dtls1_copy_record(s, item);
209 OPENSSL_free(item->data);
219 * retrieve a buffered record that belongs to the new epoch, i.e., not
222 #define dtls1_get_unprocessed_record(s) \
223 dtls1_retrieve_buffered_record((s), \
224 &((s)->rlayer.d->unprocessed_rcds))
226 int dtls1_process_buffered_records(SSL *s)
231 DTLS1_BITMAP *bitmap;
232 unsigned int is_next_epoch;
235 item = pqueue_peek(s->rlayer.d->unprocessed_rcds.q);
237 /* Check if epoch is current. */
238 if (s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch)
239 return 1; /* Nothing to do. */
241 rr = RECORD_LAYER_get_rrec(&s->rlayer);
243 rb = RECORD_LAYER_get_rbuf(&s->rlayer);
245 if (SSL3_BUFFER_get_left(rb) > 0) {
247 * We've still got data from the current packet to read. There could
248 * be a record from the new epoch in it - so don't overwrite it
249 * with the unprocessed records yet (we'll do it when we've
250 * finished reading the current packet).
255 /* Process all the records. */
256 while (pqueue_peek(s->rlayer.d->unprocessed_rcds.q)) {
257 dtls1_get_unprocessed_record(s);
258 bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
259 if (bitmap == NULL) {
261 * Should not happen. This will only ever be NULL when the
262 * current record is from a different epoch. But that cannot
263 * be the case because we already checked the epoch above
265 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
266 SSL_F_DTLS1_PROCESS_BUFFERED_RECORDS,
267 ERR_R_INTERNAL_ERROR);
270 #ifndef OPENSSL_NO_SCTP
271 /* Only do replay check if no SCTP bio */
272 if (!BIO_dgram_is_sctp(SSL_get_rbio(s)))
276 * Check whether this is a repeat, or aged record. We did this
277 * check once already when we first received the record - but
278 * we might have updated the window since then due to
279 * records we subsequently processed.
281 replayok = dtls1_record_replay_check(s, bitmap);
284 if (!replayok || !dtls1_process_record(s, bitmap)) {
285 if (ossl_statem_in_error(s)) {
286 /* dtls1_process_record called SSLfatal() */
289 /* dump this record */
291 RECORD_LAYER_reset_packet_length(&s->rlayer);
295 if (dtls1_buffer_record(s, &(s->rlayer.d->processed_rcds),
296 SSL3_RECORD_get_seq_num(s->rlayer.rrec)) < 0) {
297 /* SSLfatal() already called */
304 * sync epoch numbers once all the unprocessed records have been
307 s->rlayer.d->processed_rcds.epoch = s->rlayer.d->r_epoch;
308 s->rlayer.d->unprocessed_rcds.epoch = s->rlayer.d->r_epoch + 1;
314 * Return up to 'len' payload bytes received in 'type' records.
315 * 'type' is one of the following:
317 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
318 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
319 * - 0 (during a shutdown, no data has to be returned)
321 * If we don't have stored data to work from, read a SSL/TLS record first
322 * (possibly multiple records if we still don't have anything to return).
324 * This function must handle any surprises the peer may have for us, such as
325 * Alert records (e.g. close_notify) or renegotiation requests. ChangeCipherSpec
326 * messages are treated as if they were handshake messages *if* the |recd_type|
327 * argument is non NULL.
328 * Also if record payloads contain fragments too small to process, we store
329 * them until there is enough for the respective protocol (the record protocol
330 * may use arbitrary fragmentation and even interleaving):
331 * Change cipher spec protocol
332 * just 1 byte needed, no need for keeping anything stored
334 * 2 bytes needed (AlertLevel, AlertDescription)
336 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
337 * to detect unexpected Client Hello and Hello Request messages
338 * here, anything else is handled by higher layers
339 * Application data protocol
340 * none of our business
342 int dtls1_read_bytes(SSL *s, int type, int *recvd_type, unsigned char *buf,
343 size_t len, int peek, size_t *readbytes)
348 void (*cb) (const SSL *ssl, int type2, int val) = NULL;
350 if (!SSL3_BUFFER_is_initialised(&s->rlayer.rbuf)) {
351 /* Not initialized yet */
352 if (!ssl3_setup_buffers(s)) {
353 /* SSLfatal() already called */
358 if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
359 (type != SSL3_RT_HANDSHAKE)) ||
360 (peek && (type != SSL3_RT_APPLICATION_DATA))) {
361 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS1_READ_BYTES,
362 ERR_R_INTERNAL_ERROR);
366 if (!ossl_statem_get_in_handshake(s) && SSL_in_init(s)) {
367 /* type == SSL3_RT_APPLICATION_DATA */
368 i = s->handshake_func(s);
369 /* SSLfatal() already called if appropriate */
377 s->rwstate = SSL_NOTHING;
380 * s->s3->rrec.type - is the type of record
381 * s->s3->rrec.data, - data
382 * s->s3->rrec.off, - offset into 'data' for next read
383 * s->s3->rrec.length, - number of bytes.
388 * We are not handshaking and have no data yet, so process data buffered
389 * during the last handshake in advance, if any.
391 if (SSL_is_init_finished(s) && SSL3_RECORD_get_length(rr) == 0) {
393 item = pqueue_pop(s->rlayer.d->buffered_app_data.q);
395 #ifndef OPENSSL_NO_SCTP
396 /* Restore bio_dgram_sctp_rcvinfo struct */
397 if (BIO_dgram_is_sctp(SSL_get_rbio(s))) {
398 DTLS1_RECORD_DATA *rdata = (DTLS1_RECORD_DATA *)item->data;
399 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_SET_RCVINFO,
400 sizeof(rdata->recordinfo), &rdata->recordinfo);
404 dtls1_copy_record(s, item);
406 OPENSSL_free(item->data);
411 /* Check for timeout */
412 if (dtls1_handle_timeout(s) > 0) {
414 } else if (ossl_statem_in_error(s)) {
415 /* dtls1_handle_timeout() has failed with a fatal error */
419 /* get new packet if necessary */
420 if ((SSL3_RECORD_get_length(rr) == 0)
421 || (s->rlayer.rstate == SSL_ST_READ_BODY)) {
422 RECORD_LAYER_set_numrpipes(&s->rlayer, 0);
423 iret = dtls1_get_record(s);
425 iret = dtls1_read_failed(s, iret);
427 * Anything other than a timeout is an error. SSLfatal() already
428 * called if appropriate.
435 RECORD_LAYER_set_numrpipes(&s->rlayer, 1);
439 * Reset the count of consecutive warning alerts if we've got a non-empty
440 * record that isn't an alert.
442 if (SSL3_RECORD_get_type(rr) != SSL3_RT_ALERT
443 && SSL3_RECORD_get_length(rr) != 0)
444 s->rlayer.alert_count = 0;
446 if (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE
447 && SSL3_RECORD_get_type(rr) != SSL3_RT_CHANGE_CIPHER_SPEC
449 && (s->d1->next_timeout.tv_sec != 0
450 || s->d1->next_timeout.tv_usec != 0)) {
452 * The timer is still running but we've received something that isn't
453 * handshake data - so the peer must have finished processing our
454 * last handshake flight. Stop the timer.
459 /* we now have a packet which can be read and processed */
461 if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
462 * reset by ssl3_get_finished */
463 && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
465 * We now have application data between CCS and Finished. Most likely
466 * the packets were reordered on their way, so buffer the application
467 * data for later processing rather than dropping the connection.
469 if (dtls1_buffer_record(s, &(s->rlayer.d->buffered_app_data),
470 SSL3_RECORD_get_seq_num(rr)) < 0) {
471 /* SSLfatal() already called */
474 SSL3_RECORD_set_length(rr, 0);
475 SSL3_RECORD_set_read(rr);
480 * If the other end has shut down, throw anything we read away (even in
483 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
484 SSL3_RECORD_set_length(rr, 0);
485 SSL3_RECORD_set_read(rr);
486 s->rwstate = SSL_NOTHING;
490 if (type == SSL3_RECORD_get_type(rr)
491 || (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
492 && type == SSL3_RT_HANDSHAKE && recvd_type != NULL)) {
494 * SSL3_RT_APPLICATION_DATA or
495 * SSL3_RT_HANDSHAKE or
496 * SSL3_RT_CHANGE_CIPHER_SPEC
499 * make sure that we are not getting application data when we are
500 * doing a handshake for the first time
502 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
503 (s->enc_read_ctx == NULL)) {
504 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_DTLS1_READ_BYTES,
505 SSL_R_APP_DATA_IN_HANDSHAKE);
509 if (recvd_type != NULL)
510 *recvd_type = SSL3_RECORD_get_type(rr);
514 * Mark a zero length record as read. This ensures multiple calls to
515 * SSL_read() with a zero length buffer will eventually cause
516 * SSL_pending() to report data as being available.
518 if (SSL3_RECORD_get_length(rr) == 0)
519 SSL3_RECORD_set_read(rr);
523 if (len > SSL3_RECORD_get_length(rr))
524 n = SSL3_RECORD_get_length(rr);
528 memcpy(buf, &(SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)]), n);
530 if (SSL3_RECORD_get_length(rr) == 0)
531 SSL3_RECORD_set_read(rr);
533 SSL3_RECORD_sub_length(rr, n);
534 SSL3_RECORD_add_off(rr, n);
535 if (SSL3_RECORD_get_length(rr) == 0) {
536 s->rlayer.rstate = SSL_ST_READ_HEADER;
537 SSL3_RECORD_set_off(rr, 0);
538 SSL3_RECORD_set_read(rr);
541 #ifndef OPENSSL_NO_SCTP
543 * We might had to delay a close_notify alert because of reordered
544 * app data. If there was an alert and there is no message to read
545 * anymore, finally set shutdown.
547 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
548 s->d1->shutdown_received
549 && !BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
550 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
559 * If we get here, then type != rr->type; if we have a handshake message,
560 * then it was unexpected (Hello Request or Client Hello).
563 if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
564 unsigned int alert_level, alert_descr;
565 unsigned char *alert_bytes = SSL3_RECORD_get_data(rr)
566 + SSL3_RECORD_get_off(rr);
569 if (!PACKET_buf_init(&alert, alert_bytes, SSL3_RECORD_get_length(rr))
570 || !PACKET_get_1(&alert, &alert_level)
571 || !PACKET_get_1(&alert, &alert_descr)
572 || PACKET_remaining(&alert) != 0) {
573 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_DTLS1_READ_BYTES,
574 SSL_R_INVALID_ALERT);
579 s->msg_callback(0, s->version, SSL3_RT_ALERT, alert_bytes, 2, s,
580 s->msg_callback_arg);
582 if (s->info_callback != NULL)
583 cb = s->info_callback;
584 else if (s->ctx->info_callback != NULL)
585 cb = s->ctx->info_callback;
588 j = (alert_level << 8) | alert_descr;
589 cb(s, SSL_CB_READ_ALERT, j);
592 if (alert_level == SSL3_AL_WARNING) {
593 s->s3->warn_alert = alert_descr;
594 SSL3_RECORD_set_read(rr);
596 s->rlayer.alert_count++;
597 if (s->rlayer.alert_count == MAX_WARN_ALERT_COUNT) {
598 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_DTLS1_READ_BYTES,
599 SSL_R_TOO_MANY_WARN_ALERTS);
603 if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
604 #ifndef OPENSSL_NO_SCTP
606 * With SCTP and streams the socket may deliver app data
607 * after a close_notify alert. We have to check this first so
608 * that nothing gets discarded.
610 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
611 BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
612 s->d1->shutdown_received = 1;
613 s->rwstate = SSL_READING;
614 BIO_clear_retry_flags(SSL_get_rbio(s));
615 BIO_set_retry_read(SSL_get_rbio(s));
619 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
622 } else if (alert_level == SSL3_AL_FATAL) {
625 s->rwstate = SSL_NOTHING;
626 s->s3->fatal_alert = alert_descr;
627 SSLfatal(s, SSL_AD_NO_ALERT, SSL_F_DTLS1_READ_BYTES,
628 SSL_AD_REASON_OFFSET + alert_descr);
629 BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
630 ERR_add_error_data(2, "SSL alert number ", tmp);
631 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
632 SSL3_RECORD_set_read(rr);
633 SSL_CTX_remove_session(s->session_ctx, s->session);
636 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_DTLS1_READ_BYTES,
637 SSL_R_UNKNOWN_ALERT_TYPE);
644 if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
646 s->rwstate = SSL_NOTHING;
647 SSL3_RECORD_set_length(rr, 0);
648 SSL3_RECORD_set_read(rr);
652 if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
654 * We can't process a CCS now, because previous handshake messages
655 * are still missing, so just drop it.
657 SSL3_RECORD_set_length(rr, 0);
658 SSL3_RECORD_set_read(rr);
663 * Unexpected handshake message (Client Hello, or protocol violation)
665 if ((SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) &&
666 !ossl_statem_get_in_handshake(s)) {
667 struct hm_header_st msg_hdr;
670 * This may just be a stale retransmit. Also sanity check that we have
671 * at least enough record bytes for a message header
673 if (SSL3_RECORD_get_epoch(rr) != s->rlayer.d->r_epoch
674 || SSL3_RECORD_get_length(rr) < DTLS1_HM_HEADER_LENGTH) {
675 SSL3_RECORD_set_length(rr, 0);
676 SSL3_RECORD_set_read(rr);
680 dtls1_get_message_header(rr->data, &msg_hdr);
683 * If we are server, we may have a repeated FINISHED of the client
684 * here, then retransmit our CCS and FINISHED.
686 if (msg_hdr.type == SSL3_MT_FINISHED) {
687 if (dtls1_check_timeout_num(s) < 0) {
688 /* SSLfatal) already called */
692 if (dtls1_retransmit_buffered_messages(s) <= 0) {
693 /* Fail if we encountered a fatal error */
694 if (ossl_statem_in_error(s))
697 SSL3_RECORD_set_length(rr, 0);
698 SSL3_RECORD_set_read(rr);
699 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
700 if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
701 /* no read-ahead left? */
704 s->rwstate = SSL_READING;
705 bio = SSL_get_rbio(s);
706 BIO_clear_retry_flags(bio);
707 BIO_set_retry_read(bio);
715 * To get here we must be trying to read app data but found handshake
716 * data. But if we're trying to read app data, and we're not in init
717 * (which is tested for at the top of this function) then init must be
720 if (!ossl_assert(SSL_is_init_finished(s))) {
721 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS1_READ_BYTES,
722 ERR_R_INTERNAL_ERROR);
726 /* We found handshake data, so we're going back into init */
727 ossl_statem_set_in_init(s, 1);
729 i = s->handshake_func(s);
730 /* SSLfatal() called if appropriate */
736 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
737 if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
738 /* no read-ahead left? */
741 * In the case where we try to read application data, but we
742 * trigger an SSL handshake, we return -1 with the retry
743 * option set. Otherwise renegotiation may cause nasty
744 * problems in the blocking world
746 s->rwstate = SSL_READING;
747 bio = SSL_get_rbio(s);
748 BIO_clear_retry_flags(bio);
749 BIO_set_retry_read(bio);
756 switch (SSL3_RECORD_get_type(rr)) {
758 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_DTLS1_READ_BYTES,
759 SSL_R_UNEXPECTED_RECORD);
761 case SSL3_RT_CHANGE_CIPHER_SPEC:
763 case SSL3_RT_HANDSHAKE:
765 * we already handled all of these, with the possible exception of
766 * SSL3_RT_HANDSHAKE when ossl_statem_get_in_handshake(s) is true, but
767 * that should not happen when type != rr->type
769 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_DTLS1_READ_BYTES,
770 ERR_R_INTERNAL_ERROR);
772 case SSL3_RT_APPLICATION_DATA:
774 * At this point, we were expecting handshake data, but have
775 * application data. If the library was running inside ssl3_read()
776 * (i.e. in_read_app_data is set) and it makes sense to read
777 * application data at this point (session renegotiation not yet
778 * started), we will indulge it.
780 if (s->s3->in_read_app_data &&
781 (s->s3->total_renegotiations != 0) &&
782 ossl_statem_app_data_allowed(s)) {
783 s->s3->in_read_app_data = 2;
786 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_DTLS1_READ_BYTES,
787 SSL_R_UNEXPECTED_RECORD);
795 * Call this to write data in records of type 'type' It will return <= 0 if
796 * not all data has been sent or non-blocking IO.
798 int dtls1_write_bytes(SSL *s, int type, const void *buf, size_t len,
803 if (!ossl_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH)) {
804 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS1_WRITE_BYTES,
805 ERR_R_INTERNAL_ERROR);
808 s->rwstate = SSL_NOTHING;
809 i = do_dtls1_write(s, type, buf, len, 0, written);
813 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
814 size_t len, int create_empty_fragment, size_t *written)
816 unsigned char *p, *pseq;
817 int i, mac_size, clear = 0;
818 size_t prefix_len = 0;
824 wb = &s->rlayer.wbuf[0];
827 * first check if there is a SSL3_BUFFER still being written out. This
828 * will happen with non blocking IO
830 if (!ossl_assert(SSL3_BUFFER_get_left(wb) == 0)) {
831 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_DTLS1_WRITE,
832 ERR_R_INTERNAL_ERROR);
836 /* If we have an alert to send, lets send it */
837 if (s->s3->alert_dispatch) {
838 i = s->method->ssl_dispatch_alert(s);
841 /* if it went, fall through and send more stuff */
844 if (len == 0 && !create_empty_fragment)
847 if (len > ssl_get_max_send_fragment(s)) {
848 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_DTLS1_WRITE,
849 SSL_R_EXCEEDS_MAX_FRAGMENT_SIZE);
855 if ((sess == NULL) ||
856 (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL))
862 mac_size = EVP_MD_CTX_size(s->write_hash);
864 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_DTLS1_WRITE,
865 SSL_R_EXCEEDS_MAX_FRAGMENT_SIZE);
870 p = SSL3_BUFFER_get_buf(wb) + prefix_len;
872 /* write the header */
874 *(p++) = type & 0xff;
875 SSL3_RECORD_set_type(&wr, type);
877 * Special case: for hello verify request, client version 1.0 and we
878 * haven't decided which version to use yet send back using version 1.0
879 * header: otherwise some clients will ignore it.
881 if (s->method->version == DTLS_ANY_VERSION &&
882 s->max_proto_version != DTLS1_BAD_VER) {
883 *(p++) = DTLS1_VERSION >> 8;
884 *(p++) = DTLS1_VERSION & 0xff;
886 *(p++) = s->version >> 8;
887 *(p++) = s->version & 0xff;
890 /* field where we are to write out packet epoch, seq num and len */
894 /* Explicit IV length, block ciphers appropriate version flag */
895 if (s->enc_write_ctx) {
896 int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
897 if (mode == EVP_CIPH_CBC_MODE) {
898 eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
902 /* Need explicit part of IV for GCM mode */
903 else if (mode == EVP_CIPH_GCM_MODE)
904 eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
905 else if (mode == EVP_CIPH_CCM_MODE)
906 eivlen = EVP_CCM_TLS_EXPLICIT_IV_LEN;
912 /* lets setup the record stuff. */
913 SSL3_RECORD_set_data(&wr, p + eivlen); /* make room for IV in case of CBC */
914 SSL3_RECORD_set_length(&wr, len);
915 SSL3_RECORD_set_input(&wr, (unsigned char *)buf);
918 * we now 'read' from wr.input, wr.length bytes into wr.data
921 /* first we compress */
922 if (s->compress != NULL) {
923 if (!ssl3_do_compress(s, &wr)) {
924 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_DTLS1_WRITE,
925 SSL_R_COMPRESSION_FAILURE);
929 memcpy(SSL3_RECORD_get_data(&wr), SSL3_RECORD_get_input(&wr),
930 SSL3_RECORD_get_length(&wr));
931 SSL3_RECORD_reset_input(&wr);
935 * we should still have the output to wr.data and the input from
936 * wr.input. Length should be wr.length. wr.data still points in the
940 if (!SSL_WRITE_ETM(s) && mac_size != 0) {
941 if (!s->method->ssl3_enc->mac(s, &wr,
942 &(p[SSL3_RECORD_get_length(&wr) + eivlen]),
944 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_DTLS1_WRITE,
945 ERR_R_INTERNAL_ERROR);
948 SSL3_RECORD_add_length(&wr, mac_size);
951 /* this is true regardless of mac size */
952 SSL3_RECORD_set_data(&wr, p);
953 SSL3_RECORD_reset_input(&wr);
956 SSL3_RECORD_add_length(&wr, eivlen);
958 if (s->method->ssl3_enc->enc(s, &wr, 1, 1) < 1) {
959 if (!ossl_statem_in_error(s)) {
960 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_DTLS1_WRITE,
961 ERR_R_INTERNAL_ERROR);
966 if (SSL_WRITE_ETM(s) && mac_size != 0) {
967 if (!s->method->ssl3_enc->mac(s, &wr,
968 &(p[SSL3_RECORD_get_length(&wr)]), 1)) {
969 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_DTLS1_WRITE,
970 ERR_R_INTERNAL_ERROR);
973 SSL3_RECORD_add_length(&wr, mac_size);
976 /* record length after mac and block padding */
978 /* there's only one epoch between handshake and app data */
980 s2n(s->rlayer.d->w_epoch, pseq);
982 memcpy(pseq, &(s->rlayer.write_sequence[2]), 6);
984 s2n(SSL3_RECORD_get_length(&wr), pseq);
987 s->msg_callback(1, 0, SSL3_RT_HEADER, pseq - DTLS1_RT_HEADER_LENGTH,
988 DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
991 * we should now have wr.data pointing to the encrypted data, which is
994 SSL3_RECORD_set_type(&wr, type); /* not needed but helps for debugging */
995 SSL3_RECORD_add_length(&wr, DTLS1_RT_HEADER_LENGTH);
997 ssl3_record_sequence_update(&(s->rlayer.write_sequence[0]));
999 if (create_empty_fragment) {
1001 * we are in a recursive call; just return the length, don't write
1004 *written = wr.length;
1008 /* now let's set up wb */
1009 SSL3_BUFFER_set_left(wb, prefix_len + SSL3_RECORD_get_length(&wr));
1010 SSL3_BUFFER_set_offset(wb, 0);
1013 * memorize arguments so that ssl3_write_pending can detect bad write
1016 s->rlayer.wpend_tot = len;
1017 s->rlayer.wpend_buf = buf;
1018 s->rlayer.wpend_type = type;
1019 s->rlayer.wpend_ret = len;
1021 /* we now just need to write the buffer. Calls SSLfatal() as required. */
1022 return ssl3_write_pending(s, type, buf, len, written);
1025 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
1026 unsigned int *is_next_epoch)
1031 /* In current epoch, accept HM, CCS, DATA, & ALERT */
1032 if (rr->epoch == s->rlayer.d->r_epoch)
1033 return &s->rlayer.d->bitmap;
1036 * Only HM and ALERT messages can be from the next epoch and only if we
1037 * have already processed all of the unprocessed records from the last
1040 else if (rr->epoch == (unsigned long)(s->rlayer.d->r_epoch + 1) &&
1041 s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch &&
1042 (rr->type == SSL3_RT_HANDSHAKE || rr->type == SSL3_RT_ALERT)) {
1044 return &s->rlayer.d->next_bitmap;
1050 void dtls1_reset_seq_numbers(SSL *s, int rw)
1053 unsigned int seq_bytes = sizeof(s->rlayer.read_sequence);
1055 if (rw & SSL3_CC_READ) {
1056 seq = s->rlayer.read_sequence;
1057 s->rlayer.d->r_epoch++;
1058 memcpy(&s->rlayer.d->bitmap, &s->rlayer.d->next_bitmap,
1059 sizeof(s->rlayer.d->bitmap));
1060 memset(&s->rlayer.d->next_bitmap, 0, sizeof(s->rlayer.d->next_bitmap));
1063 * We must not use any buffered messages received from the previous
1066 dtls1_clear_received_buffer(s);
1068 seq = s->rlayer.write_sequence;
1069 memcpy(s->rlayer.d->last_write_sequence, seq,
1070 sizeof(s->rlayer.write_sequence));
1071 s->rlayer.d->w_epoch++;
1074 memset(seq, 0, seq_bytes);