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/buffer.h>
121 #include <openssl/rand.h>
122 #include <openssl/objects.h>
123 #include <openssl/evp.h>
124 #include <openssl/x509.h>
126 #define RSMBLY_BITMASK_SIZE(msg_len) (((msg_len) + 7) / 8)
128 #define RSMBLY_BITMASK_MARK(bitmask, start, end) { \
129 if ((end) - (start) <= 8) { \
131 for (ii = (start); ii < (end); ii++) bitmask[((ii) >> 3)] |= (1 << ((ii) & 7)); \
134 bitmask[((start) >> 3)] |= bitmask_start_values[((start) & 7)]; \
135 for (ii = (((start) >> 3) + 1); ii < ((((end) - 1)) >> 3); ii++) bitmask[ii] = 0xff; \
136 bitmask[(((end) - 1) >> 3)] |= bitmask_end_values[((end) & 7)]; \
139 #define RSMBLY_BITMASK_IS_COMPLETE(bitmask, msg_len, is_complete) { \
141 OPENSSL_assert((msg_len) > 0); \
143 if (bitmask[(((msg_len) - 1) >> 3)] != bitmask_end_values[((msg_len) & 7)]) is_complete = 0; \
144 if (is_complete) for (ii = (((msg_len) - 1) >> 3) - 1; ii >= 0 ; ii--) \
145 if (bitmask[ii] != 0xff) { is_complete = 0; break; } }
148 #define RSMBLY_BITMASK_PRINT(bitmask, msg_len) { \
150 printf("bitmask: "); for (ii = 0; ii < (msg_len); ii++) \
151 printf("%d ", (bitmask[ii >> 3] & (1 << (ii & 7))) >> (ii & 7)); \
155 static unsigned char bitmask_start_values[] = {0xff, 0xfe, 0xfc, 0xf8, 0xf0, 0xe0, 0xc0, 0x80};
156 static unsigned char bitmask_end_values[] = {0xff, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f};
158 /* XDTLS: figure out the right values */
159 static const unsigned int g_probable_mtu[] = {1500, 512, 256};
161 static void dtls1_fix_message_header(SSL *s, unsigned long frag_off,
162 unsigned long frag_len);
163 static unsigned char *dtls1_write_message_header(SSL *s,
165 static void dtls1_set_message_header_int(SSL *s, unsigned char mt,
166 unsigned long len, unsigned short seq_num, unsigned long frag_off,
167 unsigned long frag_len);
168 static long dtls1_get_message_fragment(SSL *s, int st1, int stn,
172 dtls1_hm_fragment_new(unsigned long frag_len, int reassembly)
174 hm_fragment *frag = NULL;
175 unsigned char *buf = NULL;
176 unsigned char *bitmask = NULL;
178 frag = (hm_fragment *)OPENSSL_malloc(sizeof(hm_fragment));
184 buf = (unsigned char *)OPENSSL_malloc(frag_len);
192 /* zero length fragment gets zero frag->fragment */
193 frag->fragment = buf;
195 /* Initialize reassembly bitmask if necessary */
198 bitmask = (unsigned char *)OPENSSL_malloc(RSMBLY_BITMASK_SIZE(frag_len));
201 if (buf != NULL) OPENSSL_free(buf);
205 memset(bitmask, 0, RSMBLY_BITMASK_SIZE(frag_len));
208 frag->reassembly = bitmask;
213 void dtls1_hm_fragment_free(hm_fragment *frag)
216 if (frag->msg_header.is_ccs)
218 EVP_CIPHER_CTX_free(frag->msg_header.saved_retransmit_state.enc_write_ctx);
219 EVP_MD_CTX_destroy(frag->msg_header.saved_retransmit_state.write_hash);
221 if (frag->fragment) OPENSSL_free(frag->fragment);
222 if (frag->reassembly) OPENSSL_free(frag->reassembly);
226 static int dtls1_query_mtu(SSL *s)
230 s->d1->mtu = s->d1->link_mtu-BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
234 /* AHA! Figure out the MTU, and stick to the right size */
235 if (s->d1->mtu < dtls1_min_mtu(s))
237 if(!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU))
240 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
242 /* I've seen the kernel return bogus numbers when it doesn't know
243 * (initial write), so just make sure we have a reasonable number */
244 if (s->d1->mtu < dtls1_min_mtu(s))
247 s->d1->mtu = dtls1_min_mtu(s);
248 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SET_MTU,
258 /* send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or SSL3_RT_CHANGE_CIPHER_SPEC) */
259 int dtls1_do_write(SSL *s, int type)
262 unsigned int curr_mtu;
264 unsigned int len, frag_off, mac_size, blocksize, used_len;
266 if(!dtls1_query_mtu(s))
269 OPENSSL_assert(s->d1->mtu >= dtls1_min_mtu(s)); /* should have something reasonable now */
271 if ( s->init_off == 0 && type == SSL3_RT_HANDSHAKE)
272 OPENSSL_assert(s->init_num ==
273 (int)s->d1->w_msg_hdr.msg_len + DTLS1_HM_HEADER_LENGTH);
276 mac_size = EVP_MD_CTX_size(s->write_hash);
280 if (s->enc_write_ctx &&
281 (EVP_CIPHER_mode( s->enc_write_ctx->cipher) & EVP_CIPH_CBC_MODE))
282 blocksize = 2 * EVP_CIPHER_block_size(s->enc_write_ctx->cipher);
287 /* s->init_num shouldn't ever be < 0...but just in case */
288 while( s->init_num > 0)
290 used_len = BIO_wpending(SSL_get_wbio(s)) + DTLS1_RT_HEADER_LENGTH
291 + mac_size + blocksize;
292 if(s->d1->mtu > used_len)
293 curr_mtu = s->d1->mtu - used_len;
297 if ( curr_mtu <= DTLS1_HM_HEADER_LENGTH)
299 /* grr.. we could get an error if MTU picked was wrong */
300 ret = BIO_flush(SSL_get_wbio(s));
303 used_len = DTLS1_RT_HEADER_LENGTH + mac_size + blocksize;
304 if(s->d1->mtu > used_len + DTLS1_HM_HEADER_LENGTH)
305 curr_mtu = s->d1->mtu - used_len;
307 /* Shouldn't happen */
311 /* We just checked that s->init_num > 0 so this cast should be safe */
312 if (((unsigned int)s->init_num) > curr_mtu)
317 /* Shouldn't ever happen */
321 /* XDTLS: this function is too long. split out the CCS part */
322 if ( type == SSL3_RT_HANDSHAKE)
324 if ( s->init_off != 0)
326 OPENSSL_assert(s->init_off > DTLS1_HM_HEADER_LENGTH);
327 s->init_off -= DTLS1_HM_HEADER_LENGTH;
328 s->init_num += DTLS1_HM_HEADER_LENGTH;
330 /* We just checked that s->init_num > 0 so this cast should be safe */
331 if (((unsigned int)s->init_num) > curr_mtu)
337 /* Shouldn't ever happen */
341 if ( len < DTLS1_HM_HEADER_LENGTH )
344 * len is so small that we really can't do anything sensible
349 dtls1_fix_message_header(s, frag_off,
350 len - DTLS1_HM_HEADER_LENGTH);
352 dtls1_write_message_header(s, (unsigned char *)&s->init_buf->data[s->init_off]);
355 ret=dtls1_write_bytes(s,type,&s->init_buf->data[s->init_off],
359 /* might need to update MTU here, but we don't know
360 * which previous packet caused the failure -- so can't
361 * really retransmit anything. continue as if everything
362 * is fine and wait for an alert to handle the
365 if ( retry && BIO_ctrl(SSL_get_wbio(s),
366 BIO_CTRL_DGRAM_MTU_EXCEEDED, 0, NULL) > 0 )
368 if(!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU))
370 if(!dtls1_query_mtu(s))
372 /* Have one more go */
386 /* bad if this assert fails, only part of the handshake
387 * message got sent. but why would this happen? */
388 OPENSSL_assert(len == (unsigned int)ret);
390 if (type == SSL3_RT_HANDSHAKE && ! s->d1->retransmitting)
392 /* should not be done for 'Hello Request's, but in that case
393 * we'll ignore the result anyway */
394 unsigned char *p = (unsigned char *)&s->init_buf->data[s->init_off];
395 const struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
398 if (frag_off == 0 && s->version != DTLS1_BAD_VER)
400 /* reconstruct message header is if it
401 * is being sent in single fragment */
402 *p++ = msg_hdr->type;
403 l2n3(msg_hdr->msg_len,p);
404 s2n (msg_hdr->seq,p);
406 l2n3(msg_hdr->msg_len,p);
407 p -= DTLS1_HM_HEADER_LENGTH;
412 p += DTLS1_HM_HEADER_LENGTH;
413 xlen = ret - DTLS1_HM_HEADER_LENGTH;
416 ssl3_finish_mac(s, p, xlen);
419 if (ret == s->init_num)
422 s->msg_callback(1, s->version, type, s->init_buf->data,
423 (size_t)(s->init_off + s->init_num), s,
424 s->msg_callback_arg);
426 s->init_off = 0; /* done writing this message */
433 frag_off += (ret -= DTLS1_HM_HEADER_LENGTH);
440 /* Obtain handshake message of message type 'mt' (any if mt == -1),
441 * maximum acceptable body length 'max'.
442 * Read an entire handshake message. Handshake messages arrive in
445 long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok)
448 struct hm_header_st *msg_hdr;
450 unsigned long msg_len;
452 /* s3->tmp is used to store messages that are unexpected, caused
453 * by the absence of an optional handshake message */
454 if (s->s3->tmp.reuse_message)
456 s->s3->tmp.reuse_message=0;
457 if ((mt >= 0) && (s->s3->tmp.message_type != mt))
459 al=SSL_AD_UNEXPECTED_MESSAGE;
460 SSLerr(SSL_F_DTLS1_GET_MESSAGE,SSL_R_UNEXPECTED_MESSAGE);
464 s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
465 s->init_num = (int)s->s3->tmp.message_size;
469 msg_hdr = &s->d1->r_msg_hdr;
470 memset(msg_hdr, 0x00, sizeof(struct hm_header_st));
473 i = dtls1_get_message_fragment(s, st1, stn, max, ok);
474 if ( i == DTLS1_HM_BAD_FRAGMENT ||
475 i == DTLS1_HM_FRAGMENT_RETRY) /* bad fragment received */
477 else if ( i <= 0 && !*ok)
480 p = (unsigned char *)s->init_buf->data;
481 msg_len = msg_hdr->msg_len;
483 /* reconstruct message header */
484 *(p++) = msg_hdr->type;
486 s2n (msg_hdr->seq,p);
489 if (s->version != DTLS1_BAD_VER) {
490 p -= DTLS1_HM_HEADER_LENGTH;
491 msg_len += DTLS1_HM_HEADER_LENGTH;
494 ssl3_finish_mac(s, p, msg_len);
496 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
498 s, s->msg_callback_arg);
500 memset(msg_hdr, 0x00, sizeof(struct hm_header_st));
502 /* Don't change sequence numbers while listening */
504 s->d1->handshake_read_seq++;
506 s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
510 ssl3_send_alert(s,SSL3_AL_FATAL,al);
516 static int dtls1_preprocess_fragment(SSL *s,struct hm_header_st *msg_hdr,int max)
518 size_t frag_off,frag_len,msg_len;
520 msg_len = msg_hdr->msg_len;
521 frag_off = msg_hdr->frag_off;
522 frag_len = msg_hdr->frag_len;
524 /* sanity checking */
525 if ( (frag_off+frag_len) > msg_len)
527 SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT,SSL_R_EXCESSIVE_MESSAGE_SIZE);
528 return SSL_AD_ILLEGAL_PARAMETER;
531 if ( (frag_off+frag_len) > (unsigned long)max)
533 SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT,SSL_R_EXCESSIVE_MESSAGE_SIZE);
534 return SSL_AD_ILLEGAL_PARAMETER;
537 if ( s->d1->r_msg_hdr.frag_off == 0) /* first fragment */
539 /* msg_len is limited to 2^24, but is effectively checked
540 * against max above */
541 if (!BUF_MEM_grow_clean(s->init_buf,msg_len+DTLS1_HM_HEADER_LENGTH))
543 SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT,ERR_R_BUF_LIB);
544 return SSL_AD_INTERNAL_ERROR;
547 s->s3->tmp.message_size = msg_len;
548 s->d1->r_msg_hdr.msg_len = msg_len;
549 s->s3->tmp.message_type = msg_hdr->type;
550 s->d1->r_msg_hdr.type = msg_hdr->type;
551 s->d1->r_msg_hdr.seq = msg_hdr->seq;
553 else if (msg_len != s->d1->r_msg_hdr.msg_len)
555 /* They must be playing with us! BTW, failure to enforce
556 * upper limit would open possibility for buffer overrun. */
557 SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT,SSL_R_EXCESSIVE_MESSAGE_SIZE);
558 return SSL_AD_ILLEGAL_PARAMETER;
561 return 0; /* no error */
566 dtls1_retrieve_buffered_fragment(SSL *s, long max, int *ok)
568 /* (0) check whether the desired fragment is available
570 * (1) copy over the fragment to s->init_buf->data[]
571 * (2) update s->init_num
578 item = pqueue_peek(s->d1->buffered_messages);
582 frag = (hm_fragment *)item->data;
584 /* Don't return if reassembly still in progress */
585 if (frag->reassembly != NULL)
588 if ( s->d1->handshake_read_seq == frag->msg_header.seq)
590 unsigned long frag_len = frag->msg_header.frag_len;
591 pqueue_pop(s->d1->buffered_messages);
593 al=dtls1_preprocess_fragment(s,&frag->msg_header,max);
595 if (al==0) /* no alert */
597 unsigned char *p = (unsigned char *)s->init_buf->data+DTLS1_HM_HEADER_LENGTH;
598 memcpy(&p[frag->msg_header.frag_off],
599 frag->fragment,frag->msg_header.frag_len);
602 dtls1_hm_fragment_free(frag);
611 ssl3_send_alert(s,SSL3_AL_FATAL,al);
620 /* dtls1_max_handshake_message_len returns the maximum number of bytes
621 * permitted in a DTLS handshake message for |s|. The minimum is 16KB, but may
622 * be greater if the maximum certificate list size requires it. */
623 static unsigned long dtls1_max_handshake_message_len(const SSL *s)
625 unsigned long max_len = DTLS1_HM_HEADER_LENGTH + SSL3_RT_MAX_ENCRYPTED_LENGTH;
626 if (max_len < (unsigned long)s->max_cert_list)
627 return s->max_cert_list;
632 dtls1_reassemble_fragment(SSL *s, const struct hm_header_st* msg_hdr, int *ok)
634 hm_fragment *frag = NULL;
636 int i = -1, is_complete;
637 unsigned char seq64be[8];
638 unsigned long frag_len = msg_hdr->frag_len;
640 if ((msg_hdr->frag_off+frag_len) > msg_hdr->msg_len ||
641 msg_hdr->msg_len > dtls1_max_handshake_message_len(s))
645 return DTLS1_HM_FRAGMENT_RETRY;
647 /* Try to find item in queue */
648 memset(seq64be,0,sizeof(seq64be));
649 seq64be[6] = (unsigned char) (msg_hdr->seq>>8);
650 seq64be[7] = (unsigned char) msg_hdr->seq;
651 item = pqueue_find(s->d1->buffered_messages, seq64be);
655 frag = dtls1_hm_fragment_new(msg_hdr->msg_len, 1);
658 memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
659 frag->msg_header.frag_len = frag->msg_header.msg_len;
660 frag->msg_header.frag_off = 0;
664 frag = (hm_fragment*) item->data;
665 if (frag->msg_header.msg_len != msg_hdr->msg_len)
674 /* If message is already reassembled, this must be a
675 * retransmit and can be dropped. In this case item != NULL and so frag
676 * does not need to be freed.
678 if (frag->reassembly == NULL)
680 unsigned char devnull [256];
684 i = s->method->ssl_read_bytes(s,SSL3_RT_HANDSHAKE,
686 frag_len>sizeof(devnull)?sizeof(devnull):frag_len,0);
690 return DTLS1_HM_FRAGMENT_RETRY;
693 /* read the body of the fragment (header has already been read */
694 i = s->method->ssl_read_bytes(s,SSL3_RT_HANDSHAKE,
695 frag->fragment + msg_hdr->frag_off,frag_len,0);
696 if ((unsigned long)i!=frag_len)
701 RSMBLY_BITMASK_MARK(frag->reassembly, (long)msg_hdr->frag_off,
702 (long)(msg_hdr->frag_off + frag_len));
704 RSMBLY_BITMASK_IS_COMPLETE(frag->reassembly, (long)msg_hdr->msg_len,
709 OPENSSL_free(frag->reassembly);
710 frag->reassembly = NULL;
715 item = pitem_new(seq64be, frag);
722 item = pqueue_insert(s->d1->buffered_messages, item);
723 /* pqueue_insert fails iff a duplicate item is inserted.
724 * However, |item| cannot be a duplicate. If it were,
725 * |pqueue_find|, above, would have returned it and control
726 * would never have reached this branch. */
727 OPENSSL_assert(item != NULL);
730 return DTLS1_HM_FRAGMENT_RETRY;
733 if (frag != NULL && item == NULL) dtls1_hm_fragment_free(frag);
740 dtls1_process_out_of_seq_message(SSL *s, const struct hm_header_st* msg_hdr, int *ok)
743 hm_fragment *frag = NULL;
745 unsigned char seq64be[8];
746 unsigned long frag_len = msg_hdr->frag_len;
748 if ((msg_hdr->frag_off+frag_len) > msg_hdr->msg_len)
751 /* Try to find item in queue, to prevent duplicate entries */
752 memset(seq64be,0,sizeof(seq64be));
753 seq64be[6] = (unsigned char) (msg_hdr->seq>>8);
754 seq64be[7] = (unsigned char) msg_hdr->seq;
755 item = pqueue_find(s->d1->buffered_messages, seq64be);
757 /* If we already have an entry and this one is a fragment,
758 * don't discard it and rather try to reassemble it.
760 if (item != NULL && frag_len != msg_hdr->msg_len)
763 /* Discard the message if sequence number was already there, is
764 * too far in the future, already in the queue or if we received
765 * a FINISHED before the SERVER_HELLO, which then must be a stale
768 if (msg_hdr->seq <= s->d1->handshake_read_seq ||
769 msg_hdr->seq > s->d1->handshake_read_seq + 10 || item != NULL ||
770 (s->d1->handshake_read_seq == 0 && msg_hdr->type == SSL3_MT_FINISHED))
772 unsigned char devnull [256];
776 i = s->method->ssl_read_bytes(s,SSL3_RT_HANDSHAKE,
778 frag_len>sizeof(devnull)?sizeof(devnull):frag_len,0);
785 if (frag_len != msg_hdr->msg_len)
786 return dtls1_reassemble_fragment(s, msg_hdr, ok);
788 if (frag_len > dtls1_max_handshake_message_len(s))
791 frag = dtls1_hm_fragment_new(frag_len, 0);
795 memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
799 /* read the body of the fragment (header has already been read */
800 i = s->method->ssl_read_bytes(s,SSL3_RT_HANDSHAKE,
801 frag->fragment,frag_len,0);
802 if ((unsigned long)i!=frag_len)
808 item = pitem_new(seq64be, frag);
812 item = pqueue_insert(s->d1->buffered_messages, item);
813 /* pqueue_insert fails iff a duplicate item is inserted.
814 * However, |item| cannot be a duplicate. If it were,
815 * |pqueue_find|, above, would have returned it. Then, either
816 * |frag_len| != |msg_hdr->msg_len| in which case |item| is set
817 * to NULL and it will have been processed with
818 * |dtls1_reassemble_fragment|, above, or the record will have
820 OPENSSL_assert(item != NULL);
823 return DTLS1_HM_FRAGMENT_RETRY;
826 if (frag != NULL && item == NULL) dtls1_hm_fragment_free(frag);
833 dtls1_get_message_fragment(SSL *s, int st1, int stn, long max, int *ok)
835 unsigned char wire[DTLS1_HM_HEADER_LENGTH];
836 unsigned long len, frag_off, frag_len;
838 struct hm_header_st msg_hdr;
841 /* see if we have the required fragment already */
842 if ((frag_len = dtls1_retrieve_buffered_fragment(s,max,ok)) || *ok)
844 if (*ok) s->init_num = frag_len;
848 /* read handshake message header */
849 i=s->method->ssl_read_bytes(s,SSL3_RT_HANDSHAKE,wire,
850 DTLS1_HM_HEADER_LENGTH, 0);
851 if (i <= 0) /* nbio, or an error */
853 s->rwstate=SSL_READING;
857 /* Handshake fails if message header is incomplete */
858 if (i != DTLS1_HM_HEADER_LENGTH)
860 al=SSL_AD_UNEXPECTED_MESSAGE;
861 SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT,SSL_R_UNEXPECTED_MESSAGE);
865 /* parse the message fragment header */
866 dtls1_get_message_header(wire, &msg_hdr);
869 * if this is a future (or stale) message it gets buffered
870 * (or dropped)--no further processing at this time
871 * While listening, we accept seq 1 (ClientHello with cookie)
872 * although we're still expecting seq 0 (ClientHello)
874 if (msg_hdr.seq != s->d1->handshake_read_seq && !(s->d1->listen && msg_hdr.seq == 1))
875 return dtls1_process_out_of_seq_message(s, &msg_hdr, ok);
877 len = msg_hdr.msg_len;
878 frag_off = msg_hdr.frag_off;
879 frag_len = msg_hdr.frag_len;
881 if (frag_len && frag_len < len)
882 return dtls1_reassemble_fragment(s, &msg_hdr, ok);
884 if (!s->server && s->d1->r_msg_hdr.frag_off == 0 &&
885 wire[0] == SSL3_MT_HELLO_REQUEST)
887 /* The server may always send 'Hello Request' messages --
888 * we are doing a handshake anyway now, so ignore them
889 * if their format is correct. Does not count for
891 if (wire[1] == 0 && wire[2] == 0 && wire[3] == 0)
894 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
895 wire, DTLS1_HM_HEADER_LENGTH, s,
896 s->msg_callback_arg);
901 else /* Incorrectly formated Hello request */
903 al=SSL_AD_UNEXPECTED_MESSAGE;
904 SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT,SSL_R_UNEXPECTED_MESSAGE);
909 if ((al=dtls1_preprocess_fragment(s,&msg_hdr,max)))
912 /* XDTLS: ressurect this when restart is in place */
917 unsigned char *p=(unsigned char *)s->init_buf->data+DTLS1_HM_HEADER_LENGTH;
919 i=s->method->ssl_read_bytes(s,SSL3_RT_HANDSHAKE,
920 &p[frag_off],frag_len,0);
921 /* XDTLS: fix this--message fragments cannot span multiple packets */
924 s->rwstate=SSL_READING;
932 /* XDTLS: an incorrectly formatted fragment should cause the
933 * handshake to fail */
934 if (i != (int)frag_len)
936 al=SSL3_AD_ILLEGAL_PARAMETER;
937 SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT,SSL3_AD_ILLEGAL_PARAMETER);
943 /* Note that s->init_num is *not* used as current offset in
944 * s->init_buf->data, but as a counter summing up fragments'
945 * lengths: as soon as they sum up to handshake packet
946 * length, we assume we have got all the fragments. */
947 s->init_num = frag_len;
951 ssl3_send_alert(s,SSL3_AL_FATAL,al);
958 int dtls1_send_finished(SSL *s, int a, int b, const char *sender, int slen)
966 d=(unsigned char *)s->init_buf->data;
967 p= &(d[DTLS1_HM_HEADER_LENGTH]);
969 i=s->method->ssl3_enc->final_finish_mac(s,
970 sender,slen,s->s3->tmp.finish_md);
971 s->s3->tmp.finish_md_len = i;
972 memcpy(p, s->s3->tmp.finish_md, i);
976 /* Copy the finished so we can use it for
977 * renegotiation checks
979 if(s->type == SSL_ST_CONNECT)
981 OPENSSL_assert(i <= EVP_MAX_MD_SIZE);
982 memcpy(s->s3->previous_client_finished,
983 s->s3->tmp.finish_md, i);
984 s->s3->previous_client_finished_len=i;
988 OPENSSL_assert(i <= EVP_MAX_MD_SIZE);
989 memcpy(s->s3->previous_server_finished,
990 s->s3->tmp.finish_md, i);
991 s->s3->previous_server_finished_len=i;
994 #ifdef OPENSSL_SYS_WIN16
995 /* MSVC 1.5 does not clear the top bytes of the word unless
1001 d = dtls1_set_message_header(s, d, SSL3_MT_FINISHED, l, 0, l);
1002 s->init_num=(int)l+DTLS1_HM_HEADER_LENGTH;
1005 /* buffer the message to handle re-xmits */
1006 dtls1_buffer_message(s, 0);
1011 /* SSL3_ST_SEND_xxxxxx_HELLO_B */
1012 return(dtls1_do_write(s,SSL3_RT_HANDSHAKE));
1015 /* for these 2 messages, we need to
1016 * ssl->enc_read_ctx re-init
1017 * ssl->s3->read_sequence zero
1018 * ssl->s3->read_mac_secret re-init
1019 * ssl->session->read_sym_enc assign
1020 * ssl->session->read_compression assign
1021 * ssl->session->read_hash assign
1023 int dtls1_send_change_cipher_spec(SSL *s, int a, int b)
1029 p=(unsigned char *)s->init_buf->data;
1031 s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1032 s->init_num=DTLS1_CCS_HEADER_LENGTH;
1034 if (s->version == DTLS1_BAD_VER) {
1035 s->d1->next_handshake_write_seq++;
1036 s2n(s->d1->handshake_write_seq,p);
1042 dtls1_set_message_header_int(s, SSL3_MT_CCS, 0,
1043 s->d1->handshake_write_seq, 0, 0);
1045 /* buffer the message to handle re-xmits */
1046 dtls1_buffer_message(s, 1);
1051 /* SSL3_ST_CW_CHANGE_B */
1052 return(dtls1_do_write(s,SSL3_RT_CHANGE_CIPHER_SPEC));
1055 static int dtls1_add_cert_to_buf(BUF_MEM *buf, unsigned long *l, X509 *x)
1061 if (!BUF_MEM_grow_clean(buf,(int)(n+(*l)+3)))
1063 SSLerr(SSL_F_DTLS1_ADD_CERT_TO_BUF,ERR_R_BUF_LIB);
1066 p=(unsigned char *)&(buf->data[*l]);
1073 unsigned long dtls1_output_cert_chain(SSL *s, X509 *x)
1077 unsigned long l= 3 + DTLS1_HM_HEADER_LENGTH;
1080 /* TLSv1 sends a chain with nothing in it, instead of an alert */
1082 if (!BUF_MEM_grow_clean(buf,10))
1084 SSLerr(SSL_F_DTLS1_OUTPUT_CERT_CHAIN,ERR_R_BUF_LIB);
1089 X509_STORE_CTX xs_ctx;
1091 if (!X509_STORE_CTX_init(&xs_ctx,s->ctx->cert_store,x,NULL))
1093 SSLerr(SSL_F_DTLS1_OUTPUT_CERT_CHAIN,ERR_R_X509_LIB);
1097 X509_verify_cert(&xs_ctx);
1098 /* Don't leave errors in the queue */
1100 for (i=0; i < sk_X509_num(xs_ctx.chain); i++)
1102 x = sk_X509_value(xs_ctx.chain, i);
1104 if (!dtls1_add_cert_to_buf(buf, &l, x))
1106 X509_STORE_CTX_cleanup(&xs_ctx);
1110 X509_STORE_CTX_cleanup(&xs_ctx);
1112 /* Thawte special :-) */
1113 for (i=0; i<sk_X509_num(s->ctx->extra_certs); i++)
1115 x=sk_X509_value(s->ctx->extra_certs,i);
1116 if (!dtls1_add_cert_to_buf(buf, &l, x))
1120 l-= (3 + DTLS1_HM_HEADER_LENGTH);
1122 p=(unsigned char *)&(buf->data[DTLS1_HM_HEADER_LENGTH]);
1125 p=(unsigned char *)&(buf->data[0]);
1126 p = dtls1_set_message_header(s, p, SSL3_MT_CERTIFICATE, l, 0, l);
1128 l+=DTLS1_HM_HEADER_LENGTH;
1132 int dtls1_read_failed(SSL *s, int code)
1136 fprintf( stderr, "invalid state reached %s:%d", __FILE__, __LINE__);
1140 if (!dtls1_is_timer_expired(s))
1142 /* not a timeout, none of our business,
1143 let higher layers handle this. in fact it's probably an error */
1147 if ( ! SSL_in_init(s)) /* done, no need to send a retransmit */
1149 BIO_set_flags(SSL_get_rbio(s), BIO_FLAGS_READ);
1153 #if 0 /* for now, each alert contains only one record number */
1154 item = pqueue_peek(state->rcvd_records);
1157 /* send an alert immediately for all the missing records */
1162 #if 0 /* no more alert sending, just retransmit the last set of messages */
1163 if ( state->timeout.read_timeouts >= DTLS1_TMO_READ_COUNT)
1164 ssl3_send_alert(s,SSL3_AL_WARNING,
1165 DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
1168 return dtls1_handle_timeout(s);
1172 dtls1_get_queue_priority(unsigned short seq, int is_ccs)
1174 /* The index of the retransmission queue actually is the message sequence number,
1175 * since the queue only contains messages of a single handshake. However, the
1176 * ChangeCipherSpec has no message sequence number and so using only the sequence
1177 * will result in the CCS and Finished having the same index. To prevent this,
1178 * the sequence number is multiplied by 2. In case of a CCS 1 is subtracted.
1179 * This does not only differ CSS and Finished, it also maintains the order of the
1180 * index (important for priority queues) and fits in the unsigned short variable.
1182 return seq * 2 - is_ccs;
1186 dtls1_retransmit_buffered_messages(SSL *s)
1188 pqueue sent = s->d1->sent_messages;
1194 iter = pqueue_iterator(sent);
1196 for ( item = pqueue_next(&iter); item != NULL; item = pqueue_next(&iter))
1198 frag = (hm_fragment *)item->data;
1199 if ( dtls1_retransmit_message(s,
1200 (unsigned short)dtls1_get_queue_priority(frag->msg_header.seq, frag->msg_header.is_ccs),
1201 0, &found) <= 0 && found)
1203 fprintf(stderr, "dtls1_retransmit_message() failed\n");
1212 dtls1_buffer_message(SSL *s, int is_ccs)
1216 unsigned char seq64be[8];
1218 /* this function is called immediately after a message has
1219 * been serialized */
1220 OPENSSL_assert(s->init_off == 0);
1222 frag = dtls1_hm_fragment_new(s->init_num, 0);
1226 memcpy(frag->fragment, s->init_buf->data, s->init_num);
1230 OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1231 ((s->version==DTLS1_VERSION)?DTLS1_CCS_HEADER_LENGTH:3) == (unsigned int)s->init_num);
1235 OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1236 DTLS1_HM_HEADER_LENGTH == (unsigned int)s->init_num);
1239 frag->msg_header.msg_len = s->d1->w_msg_hdr.msg_len;
1240 frag->msg_header.seq = s->d1->w_msg_hdr.seq;
1241 frag->msg_header.type = s->d1->w_msg_hdr.type;
1242 frag->msg_header.frag_off = 0;
1243 frag->msg_header.frag_len = s->d1->w_msg_hdr.msg_len;
1244 frag->msg_header.is_ccs = is_ccs;
1246 /* save current state*/
1247 frag->msg_header.saved_retransmit_state.enc_write_ctx = s->enc_write_ctx;
1248 frag->msg_header.saved_retransmit_state.write_hash = s->write_hash;
1249 frag->msg_header.saved_retransmit_state.compress = s->compress;
1250 frag->msg_header.saved_retransmit_state.session = s->session;
1251 frag->msg_header.saved_retransmit_state.epoch = s->d1->w_epoch;
1253 memset(seq64be,0,sizeof(seq64be));
1254 seq64be[6] = (unsigned char)(dtls1_get_queue_priority(frag->msg_header.seq,
1255 frag->msg_header.is_ccs)>>8);
1256 seq64be[7] = (unsigned char)(dtls1_get_queue_priority(frag->msg_header.seq,
1257 frag->msg_header.is_ccs));
1259 item = pitem_new(seq64be, frag);
1262 dtls1_hm_fragment_free(frag);
1267 fprintf( stderr, "buffered messge: \ttype = %xx\n", msg_buf->type);
1268 fprintf( stderr, "\t\t\t\t\tlen = %d\n", msg_buf->len);
1269 fprintf( stderr, "\t\t\t\t\tseq_num = %d\n", msg_buf->seq_num);
1272 pqueue_insert(s->d1->sent_messages, item);
1277 dtls1_retransmit_message(SSL *s, unsigned short seq, unsigned long frag_off,
1281 /* XDTLS: for now assuming that read/writes are blocking */
1284 unsigned long header_length;
1285 unsigned char seq64be[8];
1286 struct dtls1_retransmit_state saved_state;
1287 unsigned char save_write_sequence[8];
1290 OPENSSL_assert(s->init_num == 0);
1291 OPENSSL_assert(s->init_off == 0);
1294 /* XDTLS: the requested message ought to be found, otherwise error */
1295 memset(seq64be,0,sizeof(seq64be));
1296 seq64be[6] = (unsigned char)(seq>>8);
1297 seq64be[7] = (unsigned char)seq;
1299 item = pqueue_find(s->d1->sent_messages, seq64be);
1302 fprintf(stderr, "retransmit: message %d non-existant\n", seq);
1308 frag = (hm_fragment *)item->data;
1310 if ( frag->msg_header.is_ccs)
1311 header_length = DTLS1_CCS_HEADER_LENGTH;
1313 header_length = DTLS1_HM_HEADER_LENGTH;
1315 memcpy(s->init_buf->data, frag->fragment,
1316 frag->msg_header.msg_len + header_length);
1317 s->init_num = frag->msg_header.msg_len + header_length;
1319 dtls1_set_message_header_int(s, frag->msg_header.type,
1320 frag->msg_header.msg_len, frag->msg_header.seq, 0,
1321 frag->msg_header.frag_len);
1323 /* save current state */
1324 saved_state.enc_write_ctx = s->enc_write_ctx;
1325 saved_state.write_hash = s->write_hash;
1326 saved_state.compress = s->compress;
1327 saved_state.session = s->session;
1328 saved_state.epoch = s->d1->w_epoch;
1329 saved_state.epoch = s->d1->w_epoch;
1331 s->d1->retransmitting = 1;
1333 /* restore state in which the message was originally sent */
1334 s->enc_write_ctx = frag->msg_header.saved_retransmit_state.enc_write_ctx;
1335 s->write_hash = frag->msg_header.saved_retransmit_state.write_hash;
1336 s->compress = frag->msg_header.saved_retransmit_state.compress;
1337 s->session = frag->msg_header.saved_retransmit_state.session;
1338 s->d1->w_epoch = frag->msg_header.saved_retransmit_state.epoch;
1340 if (frag->msg_header.saved_retransmit_state.epoch == saved_state.epoch - 1)
1342 memcpy(save_write_sequence, s->s3->write_sequence, sizeof(s->s3->write_sequence));
1343 memcpy(s->s3->write_sequence, s->d1->last_write_sequence, sizeof(s->s3->write_sequence));
1346 ret = dtls1_do_write(s, frag->msg_header.is_ccs ?
1347 SSL3_RT_CHANGE_CIPHER_SPEC : SSL3_RT_HANDSHAKE);
1349 /* restore current state */
1350 s->enc_write_ctx = saved_state.enc_write_ctx;
1351 s->write_hash = saved_state.write_hash;
1352 s->compress = saved_state.compress;
1353 s->session = saved_state.session;
1354 s->d1->w_epoch = saved_state.epoch;
1356 if (frag->msg_header.saved_retransmit_state.epoch == saved_state.epoch - 1)
1358 memcpy(s->d1->last_write_sequence, s->s3->write_sequence, sizeof(s->s3->write_sequence));
1359 memcpy(s->s3->write_sequence, save_write_sequence, sizeof(s->s3->write_sequence));
1362 s->d1->retransmitting = 0;
1364 (void)BIO_flush(SSL_get_wbio(s));
1368 /* call this function when the buffered messages are no longer needed */
1370 dtls1_clear_record_buffer(SSL *s)
1374 for(item = pqueue_pop(s->d1->sent_messages);
1375 item != NULL; item = pqueue_pop(s->d1->sent_messages))
1377 dtls1_hm_fragment_free((hm_fragment *)item->data);
1384 dtls1_set_message_header(SSL *s, unsigned char *p, unsigned char mt,
1385 unsigned long len, unsigned long frag_off, unsigned long frag_len)
1387 /* Don't change sequence numbers while listening */
1388 if (frag_off == 0 && !s->d1->listen)
1390 s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1391 s->d1->next_handshake_write_seq++;
1394 dtls1_set_message_header_int(s, mt, len, s->d1->handshake_write_seq,
1395 frag_off, frag_len);
1397 return p += DTLS1_HM_HEADER_LENGTH;
1401 /* don't actually do the writing, wait till the MTU has been retrieved */
1403 dtls1_set_message_header_int(SSL *s, unsigned char mt,
1404 unsigned long len, unsigned short seq_num, unsigned long frag_off,
1405 unsigned long frag_len)
1407 struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1410 msg_hdr->msg_len = len;
1411 msg_hdr->seq = seq_num;
1412 msg_hdr->frag_off = frag_off;
1413 msg_hdr->frag_len = frag_len;
1417 dtls1_fix_message_header(SSL *s, unsigned long frag_off,
1418 unsigned long frag_len)
1420 struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1422 msg_hdr->frag_off = frag_off;
1423 msg_hdr->frag_len = frag_len;
1426 static unsigned char *
1427 dtls1_write_message_header(SSL *s, unsigned char *p)
1429 struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1431 *p++ = msg_hdr->type;
1432 l2n3(msg_hdr->msg_len, p);
1434 s2n(msg_hdr->seq, p);
1435 l2n3(msg_hdr->frag_off, p);
1436 l2n3(msg_hdr->frag_len, p);
1442 dtls1_link_min_mtu(void)
1444 return (g_probable_mtu[(sizeof(g_probable_mtu) /
1445 sizeof(g_probable_mtu[0])) - 1]);
1449 dtls1_min_mtu(SSL *s)
1451 return dtls1_link_min_mtu()-BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
1456 dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr)
1458 memset(msg_hdr, 0x00, sizeof(struct hm_header_st));
1459 msg_hdr->type = *(data++);
1460 n2l3(data, msg_hdr->msg_len);
1462 n2s(data, msg_hdr->seq);
1463 n2l3(data, msg_hdr->frag_off);
1464 n2l3(data, msg_hdr->frag_len);
1468 dtls1_get_ccs_header(unsigned char *data, struct ccs_header_st *ccs_hdr)
1470 memset(ccs_hdr, 0x00, sizeof(struct ccs_header_st));
1472 ccs_hdr->type = *(data++);