1 /* ssl/record/rec_layer_d1.c */
3 * DTLS implementation written by Nagendra Modadugu
4 * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
6 /* ====================================================================
7 * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * openssl-core@openssl.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
59 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
60 * All rights reserved.
62 * This package is an SSL implementation written
63 * by Eric Young (eay@cryptsoft.com).
64 * The implementation was written so as to conform with Netscapes SSL.
66 * This library is free for commercial and non-commercial use as long as
67 * the following conditions are aheared to. The following conditions
68 * apply to all code found in this distribution, be it the RC4, RSA,
69 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
70 * included with this distribution is covered by the same copyright terms
71 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
73 * Copyright remains Eric Young's, and as such any Copyright notices in
74 * the code are not to be removed.
75 * If this package is used in a product, Eric Young should be given attribution
76 * as the author of the parts of the library used.
77 * This can be in the form of a textual message at program startup or
78 * in documentation (online or textual) provided with the package.
80 * Redistribution and use in source and binary forms, with or without
81 * modification, are permitted provided that the following conditions
83 * 1. Redistributions of source code must retain the copyright
84 * notice, this list of conditions and the following disclaimer.
85 * 2. Redistributions in binary form must reproduce the above copyright
86 * notice, this list of conditions and the following disclaimer in the
87 * documentation and/or other materials provided with the distribution.
88 * 3. All advertising materials mentioning features or use of this software
89 * must display the following acknowledgement:
90 * "This product includes cryptographic software written by
91 * Eric Young (eay@cryptsoft.com)"
92 * The word 'cryptographic' can be left out if the rouines from the library
93 * being used are not cryptographic related :-).
94 * 4. If you include any Windows specific code (or a derivative thereof) from
95 * the apps directory (application code) you must include an acknowledgement:
96 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
98 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
99 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
100 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
101 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
102 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
103 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
104 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
105 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
106 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
107 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
110 * The licence and distribution terms for any publically available version or
111 * derivative of this code cannot be changed. i.e. this code cannot simply be
112 * copied and put under another distribution licence
113 * [including the GNU Public Licence.]
119 #include "../ssl_locl.h"
120 #include <openssl/evp.h>
121 #include <openssl/buffer.h>
122 #include <openssl/pqueue.h>
123 #include <openssl/rand.h>
124 #include "record_locl.h"
126 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl)
128 DTLS_RECORD_LAYER *d;
130 if ((d = OPENSSL_malloc(sizeof *d)) == NULL) {
137 d->unprocessed_rcds.q = pqueue_new();
138 d->processed_rcds.q = pqueue_new();
139 d->buffered_app_data.q = pqueue_new();
141 if (!d->unprocessed_rcds.q || !d->processed_rcds.q
142 || !d->buffered_app_data.q) {
143 if (d->unprocessed_rcds.q)
144 pqueue_free(d->unprocessed_rcds.q);
145 if (d->processed_rcds.q)
146 pqueue_free(d->processed_rcds.q);
147 if (d->buffered_app_data.q)
148 pqueue_free(d->buffered_app_data.q);
157 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl)
159 DTLS_RECORD_LAYER_clear(rl);
160 pqueue_free(rl->d->unprocessed_rcds.q);
161 pqueue_free(rl->d->processed_rcds.q);
162 pqueue_free(rl->d->buffered_app_data.q);
167 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl)
169 DTLS_RECORD_LAYER *d;
171 DTLS1_RECORD_DATA *rdata;
172 pqueue unprocessed_rcds;
173 pqueue processed_rcds;
174 pqueue buffered_app_data;
178 while ((item = pqueue_pop(d->unprocessed_rcds.q)) != NULL) {
179 rdata = (DTLS1_RECORD_DATA *)item->data;
180 OPENSSL_free(rdata->rbuf.buf);
181 OPENSSL_free(item->data);
185 while ((item = pqueue_pop(d->processed_rcds.q)) != NULL) {
186 rdata = (DTLS1_RECORD_DATA *)item->data;
187 OPENSSL_free(rdata->rbuf.buf);
188 OPENSSL_free(item->data);
192 while ((item = pqueue_pop(d->buffered_app_data.q)) != NULL) {
193 rdata = (DTLS1_RECORD_DATA *)item->data;
194 OPENSSL_free(rdata->rbuf.buf);
195 OPENSSL_free(item->data);
199 unprocessed_rcds = d->unprocessed_rcds.q;
200 processed_rcds = d->processed_rcds.q;
201 buffered_app_data = d->buffered_app_data.q;
202 memset(d, 0, sizeof *d);
203 d->unprocessed_rcds.q = unprocessed_rcds;
204 d->processed_rcds.q = processed_rcds;
205 d->buffered_app_data.q = buffered_app_data;
208 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e)
210 if (e == rl->d->w_epoch - 1) {
211 memcpy(rl->d->curr_write_sequence,
213 sizeof(rl->write_sequence));
214 memcpy(rl->write_sequence,
215 rl->d->last_write_sequence,
216 sizeof(rl->write_sequence));
217 } else if (e == rl->d->w_epoch + 1) {
218 memcpy(rl->d->last_write_sequence,
220 sizeof(unsigned char[8]));
221 memcpy(rl->write_sequence,
222 rl->d->curr_write_sequence,
223 sizeof(rl->write_sequence));
228 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl)
230 memcpy(rl->write_sequence, rl->read_sequence, sizeof(rl->write_sequence));
233 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
236 /* copy buffered record into SSL structure */
237 static int dtls1_copy_record(SSL *s, pitem *item)
239 DTLS1_RECORD_DATA *rdata;
241 rdata = (DTLS1_RECORD_DATA *)item->data;
243 SSL3_BUFFER_release(&s->rlayer.rbuf);
245 s->rlayer.packet = rdata->packet;
246 s->rlayer.packet_length = rdata->packet_length;
247 memcpy(&s->rlayer.rbuf, &(rdata->rbuf), sizeof(SSL3_BUFFER));
248 memcpy(&s->rlayer.rrec, &(rdata->rrec), sizeof(SSL3_RECORD));
250 /* Set proper sequence number for mac calculation */
251 memcpy(&(s->rlayer.read_sequence[2]), &(rdata->packet[5]), 6);
256 int dtls1_buffer_record(SSL *s, record_pqueue *queue, unsigned char *priority)
258 DTLS1_RECORD_DATA *rdata;
261 /* Limit the size of the queue to prevent DOS attacks */
262 if (pqueue_size(queue->q) >= 100)
265 rdata = OPENSSL_malloc(sizeof(DTLS1_RECORD_DATA));
266 item = pitem_new(priority, rdata);
267 if (rdata == NULL || item == NULL) {
272 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
276 rdata->packet = s->rlayer.packet;
277 rdata->packet_length = s->rlayer.packet_length;
278 memcpy(&(rdata->rbuf), &s->rlayer.rbuf, sizeof(SSL3_BUFFER));
279 memcpy(&(rdata->rrec), &s->rlayer.rrec, sizeof(SSL3_RECORD));
283 #ifndef OPENSSL_NO_SCTP
284 /* Store bio_dgram_sctp_rcvinfo struct */
285 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
286 (s->state == SSL3_ST_SR_FINISHED_A
287 || s->state == SSL3_ST_CR_FINISHED_A)) {
288 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_GET_RCVINFO,
289 sizeof(rdata->recordinfo), &rdata->recordinfo);
293 s->rlayer.packet = NULL;
294 s->rlayer.packet_length = 0;
295 memset(&s->rlayer.rbuf, 0, sizeof(SSL3_BUFFER));
296 memset(&s->rlayer.rrec, 0, sizeof(SSL3_RECORD));
298 if (!ssl3_setup_buffers(s)) {
299 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
300 OPENSSL_free(rdata->rbuf.buf);
306 /* insert should not fail, since duplicates are dropped */
307 if (pqueue_insert(queue->q, item) == NULL) {
308 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
309 OPENSSL_free(rdata->rbuf.buf);
318 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
322 item = pqueue_pop(queue->q);
324 dtls1_copy_record(s, item);
326 OPENSSL_free(item->data);
336 * retrieve a buffered record that belongs to the new epoch, i.e., not
339 #define dtls1_get_unprocessed_record(s) \
340 dtls1_retrieve_buffered_record((s), \
341 &((s)->rlayer.d->unprocessed_rcds))
344 int dtls1_process_buffered_records(SSL *s)
348 item = pqueue_peek(s->rlayer.d->unprocessed_rcds.q);
350 /* Check if epoch is current. */
351 if (s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch)
352 return (1); /* Nothing to do. */
354 /* Process all the records. */
355 while (pqueue_peek(s->rlayer.d->unprocessed_rcds.q)) {
356 dtls1_get_unprocessed_record(s);
357 if (!dtls1_process_record(s))
359 if (dtls1_buffer_record(s, &(s->rlayer.d->processed_rcds),
360 SSL3_RECORD_get_seq_num(&s->rlayer.rrec)) < 0)
366 * sync epoch numbers once all the unprocessed records have been
369 s->rlayer.d->processed_rcds.epoch = s->rlayer.d->r_epoch;
370 s->rlayer.d->unprocessed_rcds.epoch = s->rlayer.d->r_epoch + 1;
377 * Return up to 'len' payload bytes received in 'type' records.
378 * 'type' is one of the following:
380 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
381 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
382 * - 0 (during a shutdown, no data has to be returned)
384 * If we don't have stored data to work from, read a SSL/TLS record first
385 * (possibly multiple records if we still don't have anything to return).
387 * This function must handle any surprises the peer may have for us, such as
388 * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
389 * a surprise, but handled as if it were), or renegotiation requests.
390 * Also if record payloads contain fragments too small to process, we store
391 * them until there is enough for the respective protocol (the record protocol
392 * may use arbitrary fragmentation and even interleaving):
393 * Change cipher spec protocol
394 * just 1 byte needed, no need for keeping anything stored
396 * 2 bytes needed (AlertLevel, AlertDescription)
398 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
399 * to detect unexpected Client Hello and Hello Request messages
400 * here, anything else is handled by higher layers
401 * Application data protocol
402 * none of our business
404 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
409 void (*cb) (const SSL *ssl, int type2, int val) = NULL;
411 if (!SSL3_BUFFER_is_initialised(&s->rlayer.rbuf)) {
412 /* Not initialized yet */
413 if (!ssl3_setup_buffers(s))
417 if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
418 (type != SSL3_RT_HANDSHAKE)) ||
419 (peek && (type != SSL3_RT_APPLICATION_DATA))) {
420 SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
425 * check whether there's a handshake message (client hello?) waiting
427 if ((ret = have_handshake_fragment(s, type, buf, len, peek)))
431 * Now s->rlayer.d->handshake_fragment_len == 0 if
432 * type == SSL3_RT_HANDSHAKE.
435 #ifndef OPENSSL_NO_SCTP
437 * Continue handshake if it had to be interrupted to read app data with
440 if ((!s->in_handshake && SSL_in_init(s)) ||
441 (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
442 (s->state == DTLS1_SCTP_ST_SR_READ_SOCK
443 || s->state == DTLS1_SCTP_ST_CR_READ_SOCK)
444 && s->s3->in_read_app_data != 2))
446 if (!s->in_handshake && SSL_in_init(s))
449 /* type == SSL3_RT_APPLICATION_DATA */
450 i = s->handshake_func(s);
454 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
460 s->rwstate = SSL_NOTHING;
463 * s->s3->rrec.type - is the type of record
464 * s->s3->rrec.data, - data
465 * s->s3->rrec.off, - offset into 'data' for next read
466 * s->s3->rrec.length, - number of bytes.
468 rr = &s->rlayer.rrec;
471 * We are not handshaking and have no data yet, so process data buffered
472 * during the last handshake in advance, if any.
474 if (s->state == SSL_ST_OK && SSL3_RECORD_get_length(rr) == 0) {
476 item = pqueue_pop(s->rlayer.d->buffered_app_data.q);
478 #ifndef OPENSSL_NO_SCTP
479 /* Restore bio_dgram_sctp_rcvinfo struct */
480 if (BIO_dgram_is_sctp(SSL_get_rbio(s))) {
481 DTLS1_RECORD_DATA *rdata = (DTLS1_RECORD_DATA *)item->data;
482 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_SET_RCVINFO,
483 sizeof(rdata->recordinfo), &rdata->recordinfo);
487 dtls1_copy_record(s, item);
489 OPENSSL_free(item->data);
494 /* Check for timeout */
495 if (dtls1_handle_timeout(s) > 0)
498 /* get new packet if necessary */
499 if ((SSL3_RECORD_get_length(rr) == 0)
500 || (s->rlayer.rstate == SSL_ST_READ_BODY)) {
501 ret = dtls1_get_record(s);
503 ret = dtls1_read_failed(s, ret);
504 /* anything other than a timeout is an error */
512 if (s->d1->listen && rr->type != SSL3_RT_HANDSHAKE) {
513 SSL3_RECORD_set_length(rr, 0);
517 /* we now have a packet which can be read and processed */
519 if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
520 * reset by ssl3_get_finished */
521 && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
523 * We now have application data between CCS and Finished. Most likely
524 * the packets were reordered on their way, so buffer the application
525 * data for later processing rather than dropping the connection.
527 if (dtls1_buffer_record(s, &(s->rlayer.d->buffered_app_data),
528 SSL3_RECORD_get_seq_num(rr)) < 0) {
529 SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
532 SSL3_RECORD_set_length(rr, 0);
537 * If the other end has shut down, throw anything we read away (even in
540 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
541 SSL3_RECORD_set_length(rr, 0);
542 s->rwstate = SSL_NOTHING;
546 if (type == SSL3_RECORD_get_type(rr)) {
547 /* SSL3_RT_APPLICATION_DATA or
548 * SSL3_RT_HANDSHAKE */
550 * make sure that we are not getting application data when we are
551 * doing a handshake for the first time
553 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
554 (s->enc_read_ctx == NULL)) {
555 al = SSL_AD_UNEXPECTED_MESSAGE;
556 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
563 if ((unsigned int)len > SSL3_RECORD_get_length(rr))
564 n = SSL3_RECORD_get_length(rr);
566 n = (unsigned int)len;
568 memcpy(buf, &(SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)]), n);
570 SSL3_RECORD_add_length(rr, -n);
571 SSL3_RECORD_add_off(rr, n);
572 if (SSL3_RECORD_get_length(rr) == 0) {
573 s->rlayer.rstate = SSL_ST_READ_HEADER;
574 SSL3_RECORD_set_off(rr, 0);
577 #ifndef OPENSSL_NO_SCTP
579 * We were about to renegotiate but had to read belated application
580 * data first, so retry.
582 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
583 SSL3_RECORD_get_type(rr) == SSL3_RT_APPLICATION_DATA &&
584 (s->state == DTLS1_SCTP_ST_SR_READ_SOCK
585 || s->state == DTLS1_SCTP_ST_CR_READ_SOCK)) {
586 s->rwstate = SSL_READING;
587 BIO_clear_retry_flags(SSL_get_rbio(s));
588 BIO_set_retry_read(SSL_get_rbio(s));
592 * We might had to delay a close_notify alert because of reordered
593 * app data. If there was an alert and there is no message to read
594 * anymore, finally set shutdown.
596 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
597 s->d1->shutdown_received
598 && !BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
599 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
607 * If we get here, then type != rr->type; if we have a handshake message,
608 * then it was unexpected (Hello Request or Client Hello).
612 * In case of record types for which we have 'fragment' storage, fill
613 * that so that we can process the data at a fixed place.
616 unsigned int k, dest_maxlen = 0;
617 unsigned char *dest = NULL;
618 unsigned int *dest_len = NULL;
620 if (SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) {
621 dest_maxlen = sizeof s->rlayer.d->handshake_fragment;
622 dest = s->rlayer.d->handshake_fragment;
623 dest_len = &s->rlayer.d->handshake_fragment_len;
624 } else if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
625 dest_maxlen = sizeof(s->rlayer.d->alert_fragment);
626 dest = s->rlayer.d->alert_fragment;
627 dest_len = &s->rlayer.d->alert_fragment_len;
629 #ifndef OPENSSL_NO_HEARTBEATS
630 else if (SSL3_RECORD_get_type(rr) == TLS1_RT_HEARTBEAT) {
631 /* We allow a 0 return */
632 if (dtls1_process_heartbeat(s, SSL3_RECORD_get_data(rr),
633 SSL3_RECORD_get_length(rr)) < 0) {
636 /* Exit and notify application to read again */
637 SSL3_RECORD_set_length(rr, 0);
638 s->rwstate = SSL_READING;
639 BIO_clear_retry_flags(SSL_get_rbio(s));
640 BIO_set_retry_read(SSL_get_rbio(s));
644 /* else it's a CCS message, or application data or wrong */
645 else if (SSL3_RECORD_get_type(rr) != SSL3_RT_CHANGE_CIPHER_SPEC) {
647 * Application data while renegotiating is allowed. Try again
650 if (SSL3_RECORD_get_type(rr) == SSL3_RT_APPLICATION_DATA) {
652 s->s3->in_read_app_data = 2;
653 bio = SSL_get_rbio(s);
654 s->rwstate = SSL_READING;
655 BIO_clear_retry_flags(bio);
656 BIO_set_retry_read(bio);
660 /* Not certain if this is the right error handling */
661 al = SSL_AD_UNEXPECTED_MESSAGE;
662 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
666 if (dest_maxlen > 0) {
668 * XDTLS: In a pathalogical case, the Client Hello may be
669 * fragmented--don't always expect dest_maxlen bytes
671 if (SSL3_RECORD_get_length(rr) < dest_maxlen) {
672 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
674 * for normal alerts rr->length is 2, while
675 * dest_maxlen is 7 if we were to handle this
676 * non-existing alert...
680 s->rlayer.rstate = SSL_ST_READ_HEADER;
681 SSL3_RECORD_set_length(rr, 0);
685 /* now move 'n' bytes: */
686 for (k = 0; k < dest_maxlen; k++) {
687 dest[k] = SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)];
688 SSL3_RECORD_add_off(rr, 1);
689 SSL3_RECORD_add_length(rr, -1);
691 *dest_len = dest_maxlen;
696 * s->rlayer.d->handshake_fragment_len == 12 iff rr->type == SSL3_RT_HANDSHAKE;
697 * s->rlayer.d->alert_fragment_len == 7 iff rr->type == SSL3_RT_ALERT.
698 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
701 /* If we are a client, check for an incoming 'Hello Request': */
703 (s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
704 (s->rlayer.d->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
705 (s->session != NULL) && (s->session->cipher != NULL)) {
706 s->rlayer.d->handshake_fragment_len = 0;
708 if ((s->rlayer.d->handshake_fragment[1] != 0) ||
709 (s->rlayer.d->handshake_fragment[2] != 0) ||
710 (s->rlayer.d->handshake_fragment[3] != 0)) {
711 al = SSL_AD_DECODE_ERROR;
712 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
717 * no need to check sequence number on HELLO REQUEST messages
721 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
722 s->rlayer.d->handshake_fragment, 4, s,
723 s->msg_callback_arg);
725 if (SSL_is_init_finished(s) &&
726 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
727 !s->s3->renegotiate) {
728 s->d1->handshake_read_seq++;
731 if (ssl3_renegotiate_check(s)) {
732 i = s->handshake_func(s);
736 SSLerr(SSL_F_DTLS1_READ_BYTES,
737 SSL_R_SSL_HANDSHAKE_FAILURE);
741 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
742 if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
743 /* no read-ahead left? */
746 * In the case where we try to read application data,
747 * but we trigger an SSL handshake, we return -1 with
748 * the retry option set. Otherwise renegotiation may
749 * cause nasty problems in the blocking world
751 s->rwstate = SSL_READING;
752 bio = SSL_get_rbio(s);
753 BIO_clear_retry_flags(bio);
754 BIO_set_retry_read(bio);
761 * we either finished a handshake or ignored the request, now try
762 * again to obtain the (application) data we were asked for
767 if (s->rlayer.d->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH) {
768 int alert_level = s->rlayer.d->alert_fragment[0];
769 int alert_descr = s->rlayer.d->alert_fragment[1];
771 s->rlayer.d->alert_fragment_len = 0;
774 s->msg_callback(0, s->version, SSL3_RT_ALERT,
775 s->rlayer.d->alert_fragment, 2, s,
776 s->msg_callback_arg);
778 if (s->info_callback != NULL)
779 cb = s->info_callback;
780 else if (s->ctx->info_callback != NULL)
781 cb = s->ctx->info_callback;
784 j = (alert_level << 8) | alert_descr;
785 cb(s, SSL_CB_READ_ALERT, j);
788 if (alert_level == SSL3_AL_WARNING) {
789 s->s3->warn_alert = alert_descr;
790 if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
791 #ifndef OPENSSL_NO_SCTP
793 * With SCTP and streams the socket may deliver app data
794 * after a close_notify alert. We have to check this first so
795 * that nothing gets discarded.
797 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
798 BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
799 s->d1->shutdown_received = 1;
800 s->rwstate = SSL_READING;
801 BIO_clear_retry_flags(SSL_get_rbio(s));
802 BIO_set_retry_read(SSL_get_rbio(s));
806 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
810 /* XXX: this is a possible improvement in the future */
811 /* now check if it's a missing record */
812 if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE) {
814 unsigned int frag_off;
815 unsigned char *p = &(s->rlayer.d->alert_fragment[2]);
820 dtls1_retransmit_message(s,
821 dtls1_get_queue_priority
822 (frag->msg_header.seq, 0), frag_off,
824 if (!found && SSL_in_init(s)) {
826 * fprintf( stderr,"in init = %d\n", SSL_in_init(s));
829 * requested a message not yet sent, send an alert
832 ssl3_send_alert(s, SSL3_AL_WARNING,
833 DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
837 } else if (alert_level == SSL3_AL_FATAL) {
840 s->rwstate = SSL_NOTHING;
841 s->s3->fatal_alert = alert_descr;
842 SSLerr(SSL_F_DTLS1_READ_BYTES,
843 SSL_AD_REASON_OFFSET + alert_descr);
844 BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
845 ERR_add_error_data(2, "SSL alert number ", tmp);
846 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
847 SSL_CTX_remove_session(s->ctx, s->session);
850 al = SSL_AD_ILLEGAL_PARAMETER;
851 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
858 if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
860 s->rwstate = SSL_NOTHING;
861 SSL3_RECORD_set_length(rr, 0);
865 if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
866 struct ccs_header_st ccs_hdr;
867 unsigned int ccs_hdr_len = DTLS1_CCS_HEADER_LENGTH;
869 dtls1_get_ccs_header(SSL3_RECORD_get_data(rr), &ccs_hdr);
871 if (s->version == DTLS1_BAD_VER)
875 * 'Change Cipher Spec' is just a single byte, so we know exactly
876 * what the record payload has to look like
878 /* XDTLS: check that epoch is consistent */
879 if ((SSL3_RECORD_get_length(rr) != ccs_hdr_len)
880 || (SSL3_RECORD_get_off(rr) != 0)
881 || (SSL3_RECORD_get_data(rr)[0] != SSL3_MT_CCS)) {
882 i = SSL_AD_ILLEGAL_PARAMETER;
883 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_CHANGE_CIPHER_SPEC);
887 SSL3_RECORD_set_length(rr, 0);
890 s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
891 SSL3_RECORD_get_data(rr), 1, s, s->msg_callback_arg);
894 * We can't process a CCS now, because previous handshake messages
895 * are still missing, so just drop it.
897 if (!s->d1->change_cipher_spec_ok) {
901 s->d1->change_cipher_spec_ok = 0;
903 s->s3->change_cipher_spec = 1;
904 if (!ssl3_do_change_cipher_spec(s))
907 /* do this whenever CCS is processed */
908 dtls1_reset_seq_numbers(s, SSL3_CC_READ);
910 if (s->version == DTLS1_BAD_VER)
911 s->d1->handshake_read_seq++;
913 #ifndef OPENSSL_NO_SCTP
915 * Remember that a CCS has been received, so that an old key of
916 * SCTP-Auth can be deleted when a CCS is sent. Will be ignored if no
919 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD, 1, NULL);
926 * Unexpected handshake message (Client Hello, or protocol violation)
928 if ((s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
930 struct hm_header_st msg_hdr;
932 /* this may just be a stale retransmit */
933 dtls1_get_message_header(rr->data, &msg_hdr);
934 if (SSL3_RECORD_get_epoch(rr) != s->rlayer.d->r_epoch) {
935 SSL3_RECORD_set_length(rr, 0);
940 * If we are server, we may have a repeated FINISHED of the client
941 * here, then retransmit our CCS and FINISHED.
943 if (msg_hdr.type == SSL3_MT_FINISHED) {
944 if (dtls1_check_timeout_num(s) < 0)
947 dtls1_retransmit_buffered_messages(s);
948 SSL3_RECORD_set_length(rr, 0);
952 if (((s->state & SSL_ST_MASK) == SSL_ST_OK) &&
953 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
954 s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
958 i = s->handshake_func(s);
962 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
966 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
967 if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
968 /* no read-ahead left? */
971 * In the case where we try to read application data, but we
972 * trigger an SSL handshake, we return -1 with the retry
973 * option set. Otherwise renegotiation may cause nasty
974 * problems in the blocking world
976 s->rwstate = SSL_READING;
977 bio = SSL_get_rbio(s);
978 BIO_clear_retry_flags(bio);
979 BIO_set_retry_read(bio);
986 switch (SSL3_RECORD_get_type(rr)) {
988 /* TLS just ignores unknown message types */
989 if (s->version == TLS1_VERSION) {
990 SSL3_RECORD_set_length(rr, 0);
993 al = SSL_AD_UNEXPECTED_MESSAGE;
994 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
996 case SSL3_RT_CHANGE_CIPHER_SPEC:
998 case SSL3_RT_HANDSHAKE:
1000 * we already handled all of these, with the possible exception of
1001 * SSL3_RT_HANDSHAKE when s->in_handshake is set, but that should not
1002 * happen when type != rr->type
1004 al = SSL_AD_UNEXPECTED_MESSAGE;
1005 SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
1007 case SSL3_RT_APPLICATION_DATA:
1009 * At this point, we were expecting handshake data, but have
1010 * application data. If the library was running inside ssl3_read()
1011 * (i.e. in_read_app_data is set) and it makes sense to read
1012 * application data at this point (session renegotiation not yet
1013 * started), we will indulge it.
1015 if (s->s3->in_read_app_data &&
1016 (s->s3->total_renegotiations != 0) &&
1017 (((s->state & SSL_ST_CONNECT) &&
1018 (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1019 (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1020 ) || ((s->state & SSL_ST_ACCEPT) &&
1021 (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1022 (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1025 s->s3->in_read_app_data = 2;
1028 al = SSL_AD_UNEXPECTED_MESSAGE;
1029 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1036 ssl3_send_alert(s, SSL3_AL_FATAL, al);
1043 * this only happens when a client hello is received and a handshake
1046 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
1050 if ((type == SSL3_RT_HANDSHAKE)
1051 && (s->rlayer.d->handshake_fragment_len > 0))
1052 /* (partially) satisfy request from storage */
1054 unsigned char *src = s->rlayer.d->handshake_fragment;
1055 unsigned char *dst = buf;
1060 while ((len > 0) && (s->rlayer.d->handshake_fragment_len > 0)) {
1063 s->rlayer.d->handshake_fragment_len--;
1066 /* move any remaining fragment bytes: */
1067 for (k = 0; k < s->rlayer.d->handshake_fragment_len; k++)
1068 s->rlayer.d->handshake_fragment[k] = *src++;
1076 * Call this to write data in records of type 'type' It will return <= 0 if
1077 * not all data has been sent or non-blocking IO.
1079 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len)
1083 OPENSSL_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH);
1084 s->rwstate = SSL_NOTHING;
1085 i = do_dtls1_write(s, type, buf, len, 0);
1089 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
1090 unsigned int len, int create_empty_fragment)
1092 unsigned char *p, *pseq;
1093 int i, mac_size, clear = 0;
1100 wb = &s->rlayer.wbuf;
1103 * first check if there is a SSL3_BUFFER still being written out. This
1104 * will happen with non blocking IO
1106 if (SSL3_BUFFER_get_left(wb) != 0) {
1107 OPENSSL_assert(0); /* XDTLS: want to see if we ever get here */
1108 return (ssl3_write_pending(s, type, buf, len));
1111 /* If we have an alert to send, lets send it */
1112 if (s->s3->alert_dispatch) {
1113 i = s->method->ssl_dispatch_alert(s);
1116 /* if it went, fall through and send more stuff */
1119 if (len == 0 && !create_empty_fragment)
1122 wr = &s->rlayer.wrec;
1125 if ((sess == NULL) ||
1126 (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL))
1132 mac_size = EVP_MD_CTX_size(s->write_hash);
1137 p = SSL3_BUFFER_get_buf(wb) + prefix_len;
1139 /* write the header */
1141 *(p++) = type & 0xff;
1142 SSL3_RECORD_set_type(wr, type);
1144 * Special case: for hello verify request, client version 1.0 and we
1145 * haven't decided which version to use yet send back using version 1.0
1146 * header: otherwise some clients will ignore it.
1148 if (s->method->version == DTLS_ANY_VERSION) {
1149 *(p++) = DTLS1_VERSION >> 8;
1150 *(p++) = DTLS1_VERSION & 0xff;
1152 *(p++) = s->version >> 8;
1153 *(p++) = s->version & 0xff;
1156 /* field where we are to write out packet epoch, seq num and len */
1160 /* Explicit IV length, block ciphers appropriate version flag */
1161 if (s->enc_write_ctx) {
1162 int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
1163 if (mode == EVP_CIPH_CBC_MODE) {
1164 eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
1168 /* Need explicit part of IV for GCM mode */
1169 else if (mode == EVP_CIPH_GCM_MODE)
1170 eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
1176 /* lets setup the record stuff. */
1177 SSL3_RECORD_set_data(wr, p + eivlen); /* make room for IV in case of CBC */
1178 SSL3_RECORD_set_length(wr, (int)len);
1179 SSL3_RECORD_set_input(wr, (unsigned char *)buf);
1182 * we now 'read' from wr->input, wr->length bytes into wr->data
1185 /* first we compress */
1186 if (s->compress != NULL) {
1187 if (!ssl3_do_compress(s)) {
1188 SSLerr(SSL_F_DO_DTLS1_WRITE, SSL_R_COMPRESSION_FAILURE);
1192 memcpy(SSL3_RECORD_get_data(wr), SSL3_RECORD_get_input(wr),
1193 SSL3_RECORD_get_length(wr));
1194 SSL3_RECORD_reset_input(wr);
1198 * we should still have the output to wr->data and the input from
1199 * wr->input. Length should be wr->length. wr->data still points in the
1203 if (mac_size != 0) {
1204 if (s->method->ssl3_enc->mac(s,
1205 &(p[SSL3_RECORD_get_length(wr) + eivlen]), 1) < 0)
1207 SSL3_RECORD_add_length(wr, mac_size);
1210 /* this is true regardless of mac size */
1211 SSL3_RECORD_set_data(wr, p);
1212 SSL3_RECORD_reset_input(wr);
1215 SSL3_RECORD_add_length(wr, eivlen);
1217 if (s->method->ssl3_enc->enc(s, 1) < 1)
1220 /* record length after mac and block padding */
1222 * if (type == SSL3_RT_APPLICATION_DATA || (type == SSL3_RT_ALERT && !
1226 /* there's only one epoch between handshake and app data */
1228 s2n(s->rlayer.d->w_epoch, pseq);
1232 * else s2n(s->d1->handshake_epoch, pseq);
1235 memcpy(pseq, &(s->rlayer.write_sequence[2]), 6);
1237 s2n(SSL3_RECORD_get_length(wr), pseq);
1239 if (s->msg_callback)
1240 s->msg_callback(1, 0, SSL3_RT_HEADER, pseq - DTLS1_RT_HEADER_LENGTH,
1241 DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
1244 * we should now have wr->data pointing to the encrypted data, which is
1247 SSL3_RECORD_set_type(wr, type); /* not needed but helps for debugging */
1248 SSL3_RECORD_add_length(wr, DTLS1_RT_HEADER_LENGTH);
1250 ssl3_record_sequence_update(&(s->rlayer.write_sequence[0]));
1252 if (create_empty_fragment) {
1254 * we are in a recursive call; just return the length, don't write
1260 /* now let's set up wb */
1261 SSL3_BUFFER_set_left(wb, prefix_len + SSL3_RECORD_get_length(wr));
1262 SSL3_BUFFER_set_offset(wb, 0);
1265 * memorize arguments so that ssl3_write_pending can detect bad write
1268 s->rlayer.wpend_tot = len;
1269 s->rlayer.wpend_buf = buf;
1270 s->rlayer.wpend_type = type;
1271 s->rlayer.wpend_ret = len;
1273 /* we now just need to write the buffer */
1274 return ssl3_write_pending(s, type, buf, len);
1279 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
1280 unsigned int *is_next_epoch)
1285 /* In current epoch, accept HM, CCS, DATA, & ALERT */
1286 if (rr->epoch == s->rlayer.d->r_epoch)
1287 return &s->rlayer.d->bitmap;
1289 /* Only HM and ALERT messages can be from the next epoch */
1290 else if (rr->epoch == (unsigned long)(s->rlayer.d->r_epoch + 1) &&
1291 (rr->type == SSL3_RT_HANDSHAKE || rr->type == SSL3_RT_ALERT)) {
1293 return &s->rlayer.d->next_bitmap;
1299 void dtls1_reset_seq_numbers(SSL *s, int rw)
1302 unsigned int seq_bytes = sizeof(s->rlayer.read_sequence);
1304 if (rw & SSL3_CC_READ) {
1305 seq = s->rlayer.read_sequence;
1306 s->rlayer.d->r_epoch++;
1307 memcpy(&(s->rlayer.d->bitmap), &(s->rlayer.d->next_bitmap),
1308 sizeof(DTLS1_BITMAP));
1309 memset(&(s->rlayer.d->next_bitmap), 0x00, sizeof(DTLS1_BITMAP));
1311 seq = s->rlayer.write_sequence;
1312 memcpy(s->rlayer.d->last_write_sequence, seq,
1313 sizeof(s->rlayer.write_sequence));
1314 s->rlayer.d->w_epoch++;
1317 memset(seq, 0x00, seq_bytes);