d2f5defe14c61d379782e6b26295f56dbb5d830a
[openssl.git] / ssl / d1_both.c
1 /* ssl/d1_both.c */
2 /*
3  * DTLS implementation written by Nagendra Modadugu
4  * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
5  */
6 /* ====================================================================
7  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
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
19  *    distribution.
20  *
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/)"
25  *
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.
30  *
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.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39  *
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  * ====================================================================
53  *
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).
57  *
58  */
59 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
60  * All rights reserved.
61  *
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.
65  *
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).
72  *
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.
79  *
80  * Redistribution and use in source and binary forms, with or without
81  * modification, are permitted provided that the following conditions
82  * are met:
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)"
97  *
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
108  * SUCH DAMAGE.
109  *
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.]
114  */
115
116 #include <limits.h>
117 #include <string.h>
118 #include <stdio.h>
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>
125
126 #define RSMBLY_BITMASK_SIZE(msg_len) (((msg_len) + 7) / 8)
127
128 #define RSMBLY_BITMASK_MARK(bitmask, start, end) { \
129                         if ((end) - (start) <= 8) { \
130                                 long ii; \
131                                 for (ii = (start); ii < (end); ii++) bitmask[((ii) >> 3)] |= (1 << ((ii) & 7)); \
132                         } else { \
133                                 long ii; \
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)]; \
137                         } }
138
139 #define RSMBLY_BITMASK_IS_COMPLETE(bitmask, msg_len, is_complete) { \
140                         long ii; \
141                         OPENSSL_assert((msg_len) > 0); \
142                         is_complete = 1; \
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; } }
146
147 static unsigned char bitmask_start_values[] =
148     { 0xff, 0xfe, 0xfc, 0xf8, 0xf0, 0xe0, 0xc0, 0x80 };
149 static unsigned char bitmask_end_values[] =
150     { 0xff, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f };
151
152 /* XDTLS:  figure out the right values */
153 static const unsigned int g_probable_mtu[] = { 1500, 512, 256 };
154
155 static void dtls1_fix_message_header(SSL *s, unsigned long frag_off,
156                                      unsigned long frag_len);
157 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p);
158 static void dtls1_set_message_header_int(SSL *s, unsigned char mt,
159                                          unsigned long len,
160                                          unsigned short seq_num,
161                                          unsigned long frag_off,
162                                          unsigned long frag_len);
163 static long dtls1_get_message_fragment(SSL *s, int st1, int stn, int mt,
164                                        long max, int *ok);
165
166 static hm_fragment *dtls1_hm_fragment_new(unsigned long frag_len,
167                                           int reassembly)
168 {
169     hm_fragment *frag = NULL;
170     unsigned char *buf = NULL;
171     unsigned char *bitmask = NULL;
172
173     frag = OPENSSL_malloc(sizeof(*frag));
174     if (frag == NULL)
175         return NULL;
176
177     if (frag_len) {
178         buf = OPENSSL_malloc(frag_len);
179         if (buf == NULL) {
180             OPENSSL_free(frag);
181             return NULL;
182         }
183     }
184
185     /* zero length fragment gets zero frag->fragment */
186     frag->fragment = buf;
187
188     /* Initialize reassembly bitmask if necessary */
189     if (reassembly) {
190         bitmask = OPENSSL_malloc(RSMBLY_BITMASK_SIZE(frag_len));
191         if (bitmask == NULL) {
192             OPENSSL_free(buf);
193             OPENSSL_free(frag);
194             return NULL;
195         }
196         memset(bitmask, 0, RSMBLY_BITMASK_SIZE(frag_len));
197     }
198
199     frag->reassembly = bitmask;
200
201     return frag;
202 }
203
204 void dtls1_hm_fragment_free(hm_fragment *frag)
205 {
206     if (!frag)
207         return;
208     if (frag->msg_header.is_ccs) {
209         EVP_CIPHER_CTX_free(frag->msg_header.
210                             saved_retransmit_state.enc_write_ctx);
211         EVP_MD_CTX_destroy(frag->msg_header.
212                            saved_retransmit_state.write_hash);
213     }
214     OPENSSL_free(frag->fragment);
215     OPENSSL_free(frag->reassembly);
216     OPENSSL_free(frag);
217 }
218
219 static int dtls1_query_mtu(SSL *s)
220 {
221     if (s->d1->link_mtu) {
222         s->d1->mtu =
223             s->d1->link_mtu - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
224         s->d1->link_mtu = 0;
225     }
226
227     /* AHA!  Figure out the MTU, and stick to the right size */
228     if (s->d1->mtu < dtls1_min_mtu(s)) {
229         if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
230             s->d1->mtu =
231                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
232
233             /*
234              * I've seen the kernel return bogus numbers when it doesn't know
235              * (initial write), so just make sure we have a reasonable number
236              */
237             if (s->d1->mtu < dtls1_min_mtu(s)) {
238                 /* Set to min mtu */
239                 s->d1->mtu = dtls1_min_mtu(s);
240                 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SET_MTU,
241                          s->d1->mtu, NULL);
242             }
243         } else
244             return 0;
245     }
246     return 1;
247 }
248
249 /*
250  * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
251  * SSL3_RT_CHANGE_CIPHER_SPEC)
252  */
253 int dtls1_do_write(SSL *s, int type)
254 {
255     int ret;
256     unsigned int curr_mtu;
257     int retry = 1;
258     unsigned int len, frag_off, mac_size, blocksize, used_len;
259
260     if (!dtls1_query_mtu(s))
261         return -1;
262
263     OPENSSL_assert(s->d1->mtu >= dtls1_min_mtu(s)); /* should have something
264                                                      * reasonable now */
265
266     if (s->init_off == 0 && type == SSL3_RT_HANDSHAKE)
267         OPENSSL_assert(s->init_num ==
268                        (int)s->d1->w_msg_hdr.msg_len +
269                        DTLS1_HM_HEADER_LENGTH);
270
271     if (s->write_hash) {
272         if (s->enc_write_ctx
273             && ((EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_GCM_MODE) ||
274                 (EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_CCM_MODE)))
275             mac_size = 0;
276         else
277             mac_size = EVP_MD_CTX_size(s->write_hash);
278     } else
279         mac_size = 0;
280
281     if (s->enc_write_ctx &&
282         (EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_CBC_MODE))
283         blocksize = 2 * EVP_CIPHER_block_size(s->enc_write_ctx->cipher);
284     else
285         blocksize = 0;
286
287     frag_off = 0;
288     /* s->init_num shouldn't ever be < 0...but just in case */
289     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;
294         else
295             curr_mtu = 0;
296
297         if (curr_mtu <= DTLS1_HM_HEADER_LENGTH) {
298             /*
299              * grr.. we could get an error if MTU picked was wrong
300              */
301             ret = BIO_flush(SSL_get_wbio(s));
302             if (ret <= 0)
303                 return ret;
304             used_len = DTLS1_RT_HEADER_LENGTH + mac_size + blocksize;
305             if (s->d1->mtu > used_len + DTLS1_HM_HEADER_LENGTH) {
306                 curr_mtu = s->d1->mtu - used_len;
307             } else {
308                 /* Shouldn't happen */
309                 return -1;
310             }
311         }
312
313         /*
314          * We just checked that s->init_num > 0 so this cast should be safe
315          */
316         if (((unsigned int)s->init_num) > curr_mtu)
317             len = curr_mtu;
318         else
319             len = s->init_num;
320
321         /* Shouldn't ever happen */
322         if (len > INT_MAX)
323             len = INT_MAX;
324
325         /*
326          * XDTLS: this function is too long.  split out the CCS part
327          */
328         if (type == SSL3_RT_HANDSHAKE) {
329             if (s->init_off != 0) {
330                 OPENSSL_assert(s->init_off > DTLS1_HM_HEADER_LENGTH);
331                 s->init_off -= DTLS1_HM_HEADER_LENGTH;
332                 s->init_num += DTLS1_HM_HEADER_LENGTH;
333
334                 /*
335                  * We just checked that s->init_num > 0 so this cast should
336                  * be safe
337                  */
338                 if (((unsigned int)s->init_num) > curr_mtu)
339                     len = curr_mtu;
340                 else
341                     len = s->init_num;
342             }
343
344             /* Shouldn't ever happen */
345             if (len > INT_MAX)
346                 len = INT_MAX;
347
348             if (len < DTLS1_HM_HEADER_LENGTH) {
349                 /*
350                  * len is so small that we really can't do anything sensible
351                  * so fail
352                  */
353                 return -1;
354             }
355             dtls1_fix_message_header(s, frag_off,
356                                      len - DTLS1_HM_HEADER_LENGTH);
357
358             dtls1_write_message_header(s,
359                                        (unsigned char *)&s->init_buf->
360                                        data[s->init_off]);
361         }
362
363         ret = dtls1_write_bytes(s, type, &s->init_buf->data[s->init_off],
364                                 len);
365         if (ret < 0) {
366             /*
367              * might need to update MTU here, but we don't know which
368              * previous packet caused the failure -- so can't really
369              * retransmit anything.  continue as if everything is fine and
370              * wait for an alert to handle the retransmit
371              */
372             if (retry && BIO_ctrl(SSL_get_wbio(s),
373                                   BIO_CTRL_DGRAM_MTU_EXCEEDED, 0, NULL) > 0) {
374                 if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
375                     if (!dtls1_query_mtu(s))
376                         return -1;
377                     /* Have one more go */
378                     retry = 0;
379                 } else
380                     return -1;
381             } else {
382                 return (-1);
383             }
384         } else {
385
386             /*
387              * bad if this assert fails, only part of the handshake message
388              * got sent.  but why would this happen?
389              */
390             OPENSSL_assert(len == (unsigned int)ret);
391
392             if (type == SSL3_RT_HANDSHAKE && !s->d1->retransmitting) {
393                 /*
394                  * should not be done for 'Hello Request's, but in that case
395                  * we'll ignore the result anyway
396                  */
397                 unsigned char *p =
398                     (unsigned char *)&s->init_buf->data[s->init_off];
399                 const struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
400                 int xlen;
401
402                 if (frag_off == 0 && s->version != DTLS1_BAD_VER) {
403                     /*
404                      * reconstruct message header is if it is being sent in
405                      * single fragment
406                      */
407                     *p++ = msg_hdr->type;
408                     l2n3(msg_hdr->msg_len, p);
409                     s2n(msg_hdr->seq, p);
410                     l2n3(0, p);
411                     l2n3(msg_hdr->msg_len, p);
412                     p -= DTLS1_HM_HEADER_LENGTH;
413                     xlen = ret;
414                 } else {
415                     p += DTLS1_HM_HEADER_LENGTH;
416                     xlen = ret - DTLS1_HM_HEADER_LENGTH;
417                 }
418
419                 ssl3_finish_mac(s, p, xlen);
420             }
421
422             if (ret == s->init_num) {
423                 if (s->msg_callback)
424                     s->msg_callback(1, s->version, type, s->init_buf->data,
425                                     (size_t)(s->init_off + s->init_num), s,
426                                     s->msg_callback_arg);
427
428                 s->init_off = 0; /* done writing this message */
429                 s->init_num = 0;
430
431                 return (1);
432             }
433             s->init_off += ret;
434             s->init_num -= ret;
435             frag_off += (ret -= DTLS1_HM_HEADER_LENGTH);
436         }
437     }
438     return (0);
439 }
440
441 /*
442  * Obtain handshake message of message type 'mt' (any if mt == -1), maximum
443  * acceptable body length 'max'. Read an entire handshake message.  Handshake
444  * messages arrive in fragments.
445  */
446 long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok)
447 {
448     int i, al;
449     struct hm_header_st *msg_hdr;
450     unsigned char *p;
451     unsigned long msg_len;
452
453     /*
454      * s3->tmp is used to store messages that are unexpected, caused by the
455      * absence of an optional handshake message
456      */
457     if (s->s3->tmp.reuse_message) {
458         s->s3->tmp.reuse_message = 0;
459         if ((mt >= 0) && (s->s3->tmp.message_type != mt)) {
460             al = SSL_AD_UNEXPECTED_MESSAGE;
461             SSLerr(SSL_F_DTLS1_GET_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
462             goto f_err;
463         }
464         *ok = 1;
465         s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
466         s->init_num = (int)s->s3->tmp.message_size;
467         return s->init_num;
468     }
469
470     msg_hdr = &s->d1->r_msg_hdr;
471     memset(msg_hdr, 0, sizeof(*msg_hdr));
472
473  again:
474     i = dtls1_get_message_fragment(s, st1, stn, mt, max, ok);
475     if (i == DTLS1_HM_BAD_FRAGMENT || i == DTLS1_HM_FRAGMENT_RETRY) {
476         /* bad fragment received */
477         goto again;
478     } else if (i <= 0 && !*ok) {
479         return i;
480     }
481
482     if (mt >= 0 && s->s3->tmp.message_type != mt) {
483         al = SSL_AD_UNEXPECTED_MESSAGE;
484         SSLerr(SSL_F_DTLS1_GET_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
485         goto f_err;
486     }
487
488     p = (unsigned char *)s->init_buf->data;
489
490     if (mt == SSL3_MT_CHANGE_CIPHER_SPEC) {
491         if (s->msg_callback) {
492             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
493                             p, 1, s, s->msg_callback_arg);
494         }
495         /*
496          * This isn't a real handshake message so skip the processing below.
497          * dtls1_get_message_fragment() will never return a CCS if mt == -1,
498          * so we are ok to continue in that case.
499          */
500         return i;
501     }
502
503     msg_len = msg_hdr->msg_len;
504
505     /* reconstruct message header */
506     *(p++) = msg_hdr->type;
507     l2n3(msg_len, p);
508     s2n(msg_hdr->seq, p);
509     l2n3(0, p);
510     l2n3(msg_len, p);
511     if (s->version != DTLS1_BAD_VER) {
512         p -= DTLS1_HM_HEADER_LENGTH;
513         msg_len += DTLS1_HM_HEADER_LENGTH;
514     }
515
516     ssl3_finish_mac(s, p, msg_len);
517     if (s->msg_callback)
518         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
519                         p, msg_len, s, s->msg_callback_arg);
520
521     memset(msg_hdr, 0, sizeof(*msg_hdr));
522
523     /* Don't change sequence numbers while listening */
524     if (!s->d1->listen)
525         s->d1->handshake_read_seq++;
526
527     s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
528     return s->init_num;
529
530  f_err:
531     ssl3_send_alert(s, SSL3_AL_FATAL, al);
532     *ok = 0;
533     return -1;
534 }
535
536 static int dtls1_preprocess_fragment(SSL *s, struct hm_header_st *msg_hdr,
537                                      int max)
538 {
539     size_t frag_off, frag_len, msg_len;
540
541     msg_len = msg_hdr->msg_len;
542     frag_off = msg_hdr->frag_off;
543     frag_len = msg_hdr->frag_len;
544
545     /* sanity checking */
546     if ((frag_off + frag_len) > msg_len) {
547         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
548         return SSL_AD_ILLEGAL_PARAMETER;
549     }
550
551     if ((frag_off + frag_len) > (unsigned long)max) {
552         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
553         return SSL_AD_ILLEGAL_PARAMETER;
554     }
555
556     if (s->d1->r_msg_hdr.frag_off == 0) { /* first fragment */
557         /*
558          * msg_len is limited to 2^24, but is effectively checked against max
559          * above
560          */
561         if (!BUF_MEM_grow_clean
562             (s->init_buf, msg_len + DTLS1_HM_HEADER_LENGTH)) {
563             SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, ERR_R_BUF_LIB);
564             return SSL_AD_INTERNAL_ERROR;
565         }
566
567         s->s3->tmp.message_size = msg_len;
568         s->d1->r_msg_hdr.msg_len = msg_len;
569         s->s3->tmp.message_type = msg_hdr->type;
570         s->d1->r_msg_hdr.type = msg_hdr->type;
571         s->d1->r_msg_hdr.seq = msg_hdr->seq;
572     } else if (msg_len != s->d1->r_msg_hdr.msg_len) {
573         /*
574          * They must be playing with us! BTW, failure to enforce upper limit
575          * would open possibility for buffer overrun.
576          */
577         SSLerr(SSL_F_DTLS1_PREPROCESS_FRAGMENT, SSL_R_EXCESSIVE_MESSAGE_SIZE);
578         return SSL_AD_ILLEGAL_PARAMETER;
579     }
580
581     return 0;                   /* no error */
582 }
583
584 static int dtls1_retrieve_buffered_fragment(SSL *s, long max, int *ok)
585 {
586     /*-
587      * (0) check whether the desired fragment is available
588      * if so:
589      * (1) copy over the fragment to s->init_buf->data[]
590      * (2) update s->init_num
591      */
592     pitem *item;
593     hm_fragment *frag;
594     int al;
595
596     *ok = 0;
597     item = pqueue_peek(s->d1->buffered_messages);
598     if (item == NULL)
599         return 0;
600
601     frag = (hm_fragment *)item->data;
602
603     /* Don't return if reassembly still in progress */
604     if (frag->reassembly != NULL)
605         return 0;
606
607     if (s->d1->handshake_read_seq == frag->msg_header.seq) {
608         unsigned long frag_len = frag->msg_header.frag_len;
609         pqueue_pop(s->d1->buffered_messages);
610
611         al = dtls1_preprocess_fragment(s, &frag->msg_header, max);
612
613         if (al == 0) {          /* no alert */
614             unsigned char *p =
615                 (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
616             memcpy(&p[frag->msg_header.frag_off], frag->fragment,
617                    frag->msg_header.frag_len);
618         }
619
620         dtls1_hm_fragment_free(frag);
621         pitem_free(item);
622
623         if (al == 0) {
624             *ok = 1;
625             return frag_len;
626         }
627
628         ssl3_send_alert(s, SSL3_AL_FATAL, al);
629         s->init_num = 0;
630         *ok = 0;
631         return -1;
632     } else
633         return 0;
634 }
635
636 /*
637  * dtls1_max_handshake_message_len returns the maximum number of bytes
638  * permitted in a DTLS handshake message for |s|. The minimum is 16KB, but
639  * may be greater if the maximum certificate list size requires it.
640  */
641 static unsigned long dtls1_max_handshake_message_len(const SSL *s)
642 {
643     unsigned long max_len =
644         DTLS1_HM_HEADER_LENGTH + SSL3_RT_MAX_ENCRYPTED_LENGTH;
645     if (max_len < (unsigned long)s->max_cert_list)
646         return s->max_cert_list;
647     return max_len;
648 }
649
650 static int
651 dtls1_reassemble_fragment(SSL *s, const struct hm_header_st *msg_hdr, int *ok)
652 {
653     hm_fragment *frag = NULL;
654     pitem *item = NULL;
655     int i = -1, is_complete;
656     unsigned char seq64be[8];
657     unsigned long frag_len = msg_hdr->frag_len;
658
659     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len ||
660         msg_hdr->msg_len > dtls1_max_handshake_message_len(s))
661         goto err;
662
663     if (frag_len == 0)
664         return DTLS1_HM_FRAGMENT_RETRY;
665
666     /* Try to find item in queue */
667     memset(seq64be, 0, sizeof(seq64be));
668     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
669     seq64be[7] = (unsigned char)msg_hdr->seq;
670     item = pqueue_find(s->d1->buffered_messages, seq64be);
671
672     if (item == NULL) {
673         frag = dtls1_hm_fragment_new(msg_hdr->msg_len, 1);
674         if (frag == NULL)
675             goto err;
676         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
677         frag->msg_header.frag_len = frag->msg_header.msg_len;
678         frag->msg_header.frag_off = 0;
679     } else {
680         frag = (hm_fragment *)item->data;
681         if (frag->msg_header.msg_len != msg_hdr->msg_len) {
682             item = NULL;
683             frag = NULL;
684             goto err;
685         }
686     }
687
688     /*
689      * If message is already reassembled, this must be a retransmit and can
690      * be dropped. In this case item != NULL and so frag does not need to be
691      * freed.
692      */
693     if (frag->reassembly == NULL) {
694         unsigned char devnull[256];
695
696         while (frag_len) {
697             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
698                                           devnull,
699                                           frag_len >
700                                           sizeof(devnull) ? sizeof(devnull) :
701                                           frag_len, 0);
702             if (i <= 0)
703                 goto err;
704             frag_len -= i;
705         }
706         return DTLS1_HM_FRAGMENT_RETRY;
707     }
708
709     /* read the body of the fragment (header has already been read */
710     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
711                                   frag->fragment + msg_hdr->frag_off,
712                                   frag_len, 0);
713     if ((unsigned long)i != frag_len)
714         i = -1;
715     if (i <= 0)
716         goto err;
717
718     RSMBLY_BITMASK_MARK(frag->reassembly, (long)msg_hdr->frag_off,
719                         (long)(msg_hdr->frag_off + frag_len));
720
721     RSMBLY_BITMASK_IS_COMPLETE(frag->reassembly, (long)msg_hdr->msg_len,
722                                is_complete);
723
724     if (is_complete) {
725         OPENSSL_free(frag->reassembly);
726         frag->reassembly = NULL;
727     }
728
729     if (item == NULL) {
730         item = pitem_new(seq64be, frag);
731         if (item == NULL) {
732             i = -1;
733             goto err;
734         }
735
736         item = pqueue_insert(s->d1->buffered_messages, item);
737         /*
738          * pqueue_insert fails iff a duplicate item is inserted. However,
739          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
740          * would have returned it and control would never have reached this
741          * branch.
742          */
743         OPENSSL_assert(item != NULL);
744     }
745
746     return DTLS1_HM_FRAGMENT_RETRY;
747
748  err:
749     if (item == NULL)
750         dtls1_hm_fragment_free(frag);
751     *ok = 0;
752     return i;
753 }
754
755 static int
756 dtls1_process_out_of_seq_message(SSL *s, const struct hm_header_st *msg_hdr,
757                                  int *ok)
758 {
759     int i = -1;
760     hm_fragment *frag = NULL;
761     pitem *item = NULL;
762     unsigned char seq64be[8];
763     unsigned long frag_len = msg_hdr->frag_len;
764
765     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len)
766         goto err;
767
768     /* Try to find item in queue, to prevent duplicate entries */
769     memset(seq64be, 0, sizeof(seq64be));
770     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
771     seq64be[7] = (unsigned char)msg_hdr->seq;
772     item = pqueue_find(s->d1->buffered_messages, seq64be);
773
774     /*
775      * If we already have an entry and this one is a fragment, don't discard
776      * it and rather try to reassemble it.
777      */
778     if (item != NULL && frag_len != msg_hdr->msg_len)
779         item = NULL;
780
781     /*
782      * Discard the message if sequence number was already there, is too far
783      * in the future, already in the queue or if we received a FINISHED
784      * before the SERVER_HELLO, which then must be a stale retransmit.
785      */
786     if (msg_hdr->seq <= s->d1->handshake_read_seq ||
787         msg_hdr->seq > s->d1->handshake_read_seq + 10 || item != NULL ||
788         (s->d1->handshake_read_seq == 0 && msg_hdr->type == SSL3_MT_FINISHED))
789     {
790         unsigned char devnull[256];
791
792         while (frag_len) {
793             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
794                                           devnull,
795                                           frag_len >
796                                           sizeof(devnull) ? sizeof(devnull) :
797                                           frag_len, 0);
798             if (i <= 0)
799                 goto err;
800             frag_len -= i;
801         }
802     } else {
803         if (frag_len != msg_hdr->msg_len)
804             return dtls1_reassemble_fragment(s, msg_hdr, ok);
805
806         if (frag_len > dtls1_max_handshake_message_len(s))
807             goto err;
808
809         frag = dtls1_hm_fragment_new(frag_len, 0);
810         if (frag == NULL)
811             goto err;
812
813         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
814
815         if (frag_len) {
816             /*
817              * read the body of the fragment (header has already been read
818              */
819             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
820                                           frag->fragment, frag_len, 0);
821             if ((unsigned long)i != frag_len)
822                 i = -1;
823             if (i <= 0)
824                 goto err;
825         }
826
827         item = pitem_new(seq64be, frag);
828         if (item == NULL)
829             goto err;
830
831         item = pqueue_insert(s->d1->buffered_messages, item);
832         /*
833          * pqueue_insert fails iff a duplicate item is inserted. However,
834          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
835          * would have returned it. Then, either |frag_len| !=
836          * |msg_hdr->msg_len| in which case |item| is set to NULL and it will
837          * have been processed with |dtls1_reassemble_fragment|, above, or
838          * the record will have been discarded.
839          */
840         OPENSSL_assert(item != NULL);
841     }
842
843     return DTLS1_HM_FRAGMENT_RETRY;
844
845  err:
846     if (item == NULL)
847         dtls1_hm_fragment_free(frag);
848     *ok = 0;
849     return i;
850 }
851
852 static long
853 dtls1_get_message_fragment(SSL *s, int st1, int stn, int mt, long max, int *ok)
854 {
855     unsigned char wire[DTLS1_HM_HEADER_LENGTH];
856     unsigned long len, frag_off, frag_len;
857     int i, al, recvd_type;
858     struct hm_header_st msg_hdr;
859
860  redo:
861     /* see if we have the required fragment already */
862     if ((frag_len = dtls1_retrieve_buffered_fragment(s, max, ok)) || *ok) {
863         if (*ok)
864             s->init_num = frag_len;
865         return frag_len;
866     }
867
868     /* read handshake message header */
869     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type, wire,
870                                   DTLS1_HM_HEADER_LENGTH, 0);
871     if (i <= 0) {               /* nbio, or an error */
872         s->rwstate = SSL_READING;
873         *ok = 0;
874         return i;
875     }
876     if(recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
877         /* This isn't a real handshake message - its a CCS.
878          * There is no message sequence number in a CCS to give us confidence
879          * that this was really intended to be at this point in the handshake
880          * sequence. Therefore we only allow this if we were explicitly looking
881          * for it (i.e. if |mt| is -1 we still don't allow it).
882          */
883         if(mt == SSL3_MT_CHANGE_CIPHER_SPEC) {
884             if (wire[0] != SSL3_MT_CCS) {
885                 al = SSL_AD_UNEXPECTED_MESSAGE;
886                 SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL_R_BAD_CHANGE_CIPHER_SPEC);
887                 goto f_err;
888             }
889
890             memcpy(s->init_buf->data, wire, i);
891             s->init_num = i - 1;
892             s->init_msg = s->init_buf->data + 1;
893             s->s3->tmp.message_type = SSL3_MT_CHANGE_CIPHER_SPEC;
894             s->s3->tmp.message_size = i - 1;
895             s->state = stn;
896             *ok = 1;
897             return i-1;
898         } else {
899             /*
900              * We weren't expecting a CCS yet. Probably something got
901              * re-ordered or this is a retransmit. We should drop this and try
902              * again.
903              */
904             s->init_num = 0;
905             goto redo;
906         }
907     }
908
909     /* Handshake fails if message header is incomplete */
910     if (i != DTLS1_HM_HEADER_LENGTH) {
911         al = SSL_AD_UNEXPECTED_MESSAGE;
912         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL_R_UNEXPECTED_MESSAGE);
913         goto f_err;
914     }
915
916     /* parse the message fragment header */
917     dtls1_get_message_header(wire, &msg_hdr);
918
919     len = msg_hdr.msg_len;
920     frag_off = msg_hdr.frag_off;
921     frag_len = msg_hdr.frag_len;
922
923     /*
924      * We must have at least frag_len bytes left in the record to be read.
925      * Fragments must not span records.
926      */
927     if (frag_len > RECORD_LAYER_get_rrec_length(&s->rlayer)) {
928         al = SSL3_AD_ILLEGAL_PARAMETER;
929         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL_R_BAD_LENGTH);
930         goto f_err;
931     }
932
933     /*
934      * if this is a future (or stale) message it gets buffered
935      * (or dropped)--no further processing at this time
936      * While listening, we accept seq 1 (ClientHello with cookie)
937      * although we're still expecting seq 0 (ClientHello)
938      */
939     if (msg_hdr.seq != s->d1->handshake_read_seq
940         && !(s->d1->listen && msg_hdr.seq == 1))
941         return dtls1_process_out_of_seq_message(s, &msg_hdr, ok);
942
943     if (frag_len && frag_len < len)
944         return dtls1_reassemble_fragment(s, &msg_hdr, ok);
945
946     if (!s->server && s->d1->r_msg_hdr.frag_off == 0 &&
947         wire[0] == SSL3_MT_HELLO_REQUEST) {
948         /*
949          * The server may always send 'Hello Request' messages -- we are
950          * doing a handshake anyway now, so ignore them if their format is
951          * correct. Does not count for 'Finished' MAC.
952          */
953         if (wire[1] == 0 && wire[2] == 0 && wire[3] == 0) {
954             if (s->msg_callback)
955                 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
956                                 wire, DTLS1_HM_HEADER_LENGTH, s,
957                                 s->msg_callback_arg);
958
959             s->init_num = 0;
960             goto redo;
961         } else {                /* Incorrectly formated Hello request */
962
963             al = SSL_AD_UNEXPECTED_MESSAGE;
964             SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT,
965                    SSL_R_UNEXPECTED_MESSAGE);
966             goto f_err;
967         }
968     }
969
970     if ((al = dtls1_preprocess_fragment(s, &msg_hdr, max)))
971         goto f_err;
972
973     if (frag_len > 0) {
974         unsigned char *p =
975             (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
976
977         i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
978                                       &p[frag_off], frag_len, 0);
979
980         /*
981          * This shouldn't ever fail due to NBIO because we already checked
982          * that we have enough data in the record
983          */
984         if (i <= 0) {
985             s->rwstate = SSL_READING;
986             *ok = 0;
987             return i;
988         }
989     } else
990         i = 0;
991
992     /*
993      * XDTLS: an incorrectly formatted fragment should cause the handshake
994      * to fail
995      */
996     if (i != (int)frag_len) {
997         al = SSL3_AD_ILLEGAL_PARAMETER;
998         SSLerr(SSL_F_DTLS1_GET_MESSAGE_FRAGMENT, SSL3_AD_ILLEGAL_PARAMETER);
999         goto f_err;
1000     }
1001
1002     *ok = 1;
1003     s->state = stn;
1004
1005     /*
1006      * Note that s->init_num is *not* used as current offset in
1007      * s->init_buf->data, but as a counter summing up fragments' lengths: as
1008      * soon as they sum up to handshake packet length, we assume we have got
1009      * all the fragments.
1010      */
1011     s->init_num = frag_len;
1012     return frag_len;
1013
1014  f_err:
1015     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1016     s->init_num = 0;
1017
1018     *ok = 0;
1019     return (-1);
1020 }
1021
1022 /*-
1023  * for these 2 messages, we need to
1024  * ssl->enc_read_ctx                    re-init
1025  * ssl->rlayer.read_sequence            zero
1026  * ssl->s3->read_mac_secret             re-init
1027  * ssl->session->read_sym_enc           assign
1028  * ssl->session->read_compression       assign
1029  * ssl->session->read_hash              assign
1030  */
1031 int dtls1_send_change_cipher_spec(SSL *s, int a, int b)
1032 {
1033     unsigned char *p;
1034
1035     if (s->state == a) {
1036         p = (unsigned char *)s->init_buf->data;
1037         *p++ = SSL3_MT_CCS;
1038         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1039         s->init_num = DTLS1_CCS_HEADER_LENGTH;
1040
1041         if (s->version == DTLS1_BAD_VER) {
1042             s->d1->next_handshake_write_seq++;
1043             s2n(s->d1->handshake_write_seq, p);
1044             s->init_num += 2;
1045         }
1046
1047         s->init_off = 0;
1048
1049         dtls1_set_message_header_int(s, SSL3_MT_CCS, 0,
1050                                      s->d1->handshake_write_seq, 0, 0);
1051
1052         /* buffer the message to handle re-xmits */
1053         if (!dtls1_buffer_message(s, 1)) {
1054             SSLerr(SSL_F_DTLS1_SEND_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
1055             return -1;
1056         }
1057
1058         s->state = b;
1059     }
1060
1061     /* SSL3_ST_CW_CHANGE_B */
1062     return (dtls1_do_write(s, SSL3_RT_CHANGE_CIPHER_SPEC));
1063 }
1064
1065 int dtls1_read_failed(SSL *s, int code)
1066 {
1067     if (code > 0) {
1068         fprintf(stderr, "invalid state reached %s:%d", __FILE__, __LINE__);
1069         return 1;
1070     }
1071
1072     if (!dtls1_is_timer_expired(s)) {
1073         /*
1074          * not a timeout, none of our business, let higher layers handle
1075          * this.  in fact it's probably an error
1076          */
1077         return code;
1078     }
1079 #ifndef OPENSSL_NO_HEARTBEATS
1080     /* done, no need to send a retransmit */
1081     if (!SSL_in_init(s) && !s->tlsext_hb_pending)
1082 #else
1083     /* done, no need to send a retransmit */
1084     if (!SSL_in_init(s))
1085 #endif
1086     {
1087         BIO_set_flags(SSL_get_rbio(s), BIO_FLAGS_READ);
1088         return code;
1089     }
1090
1091     return dtls1_handle_timeout(s);
1092 }
1093
1094 int dtls1_get_queue_priority(unsigned short seq, int is_ccs)
1095 {
1096     /*
1097      * The index of the retransmission queue actually is the message sequence
1098      * number, since the queue only contains messages of a single handshake.
1099      * However, the ChangeCipherSpec has no message sequence number and so
1100      * using only the sequence will result in the CCS and Finished having the
1101      * same index. To prevent this, the sequence number is multiplied by 2.
1102      * In case of a CCS 1 is subtracted. This does not only differ CSS and
1103      * Finished, it also maintains the order of the index (important for
1104      * priority queues) and fits in the unsigned short variable.
1105      */
1106     return seq * 2 - is_ccs;
1107 }
1108
1109 int dtls1_retransmit_buffered_messages(SSL *s)
1110 {
1111     pqueue sent = s->d1->sent_messages;
1112     piterator iter;
1113     pitem *item;
1114     hm_fragment *frag;
1115     int found = 0;
1116
1117     iter = pqueue_iterator(sent);
1118
1119     for (item = pqueue_next(&iter); item != NULL; item = pqueue_next(&iter)) {
1120         frag = (hm_fragment *)item->data;
1121         if (dtls1_retransmit_message(s, (unsigned short)
1122                                      dtls1_get_queue_priority
1123                                      (frag->msg_header.seq,
1124                                       frag->msg_header.is_ccs), 0,
1125                                      &found) <= 0 && found) {
1126             fprintf(stderr, "dtls1_retransmit_message() failed\n");
1127             return -1;
1128         }
1129     }
1130
1131     return 1;
1132 }
1133
1134 int dtls1_buffer_message(SSL *s, int is_ccs)
1135 {
1136     pitem *item;
1137     hm_fragment *frag;
1138     unsigned char seq64be[8];
1139
1140     /*
1141      * this function is called immediately after a message has been
1142      * serialized
1143      */
1144     OPENSSL_assert(s->init_off == 0);
1145
1146     frag = dtls1_hm_fragment_new(s->init_num, 0);
1147     if (!frag)
1148         return 0;
1149
1150     memcpy(frag->fragment, s->init_buf->data, s->init_num);
1151
1152     if (is_ccs) {
1153         /* For DTLS1_BAD_VER the header length is non-standard */
1154         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1155                        ((s->version==DTLS1_BAD_VER)?3:DTLS1_CCS_HEADER_LENGTH)
1156                        == (unsigned int)s->init_num);
1157     } else {
1158         OPENSSL_assert(s->d1->w_msg_hdr.msg_len +
1159                        DTLS1_HM_HEADER_LENGTH == (unsigned int)s->init_num);
1160     }
1161
1162     frag->msg_header.msg_len = s->d1->w_msg_hdr.msg_len;
1163     frag->msg_header.seq = s->d1->w_msg_hdr.seq;
1164     frag->msg_header.type = s->d1->w_msg_hdr.type;
1165     frag->msg_header.frag_off = 0;
1166     frag->msg_header.frag_len = s->d1->w_msg_hdr.msg_len;
1167     frag->msg_header.is_ccs = is_ccs;
1168
1169     /* save current state */
1170     frag->msg_header.saved_retransmit_state.enc_write_ctx = s->enc_write_ctx;
1171     frag->msg_header.saved_retransmit_state.write_hash = s->write_hash;
1172     frag->msg_header.saved_retransmit_state.compress = s->compress;
1173     frag->msg_header.saved_retransmit_state.session = s->session;
1174     frag->msg_header.saved_retransmit_state.epoch =
1175         DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1176
1177     memset(seq64be, 0, sizeof(seq64be));
1178     seq64be[6] =
1179         (unsigned
1180          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1181                                         frag->msg_header.is_ccs) >> 8);
1182     seq64be[7] =
1183         (unsigned
1184          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1185                                         frag->msg_header.is_ccs));
1186
1187     item = pitem_new(seq64be, frag);
1188     if (item == NULL) {
1189         dtls1_hm_fragment_free(frag);
1190         return 0;
1191     }
1192
1193     pqueue_insert(s->d1->sent_messages, item);
1194     return 1;
1195 }
1196
1197 int
1198 dtls1_retransmit_message(SSL *s, unsigned short seq, unsigned long frag_off,
1199                          int *found)
1200 {
1201     int ret;
1202     /* XDTLS: for now assuming that read/writes are blocking */
1203     pitem *item;
1204     hm_fragment *frag;
1205     unsigned long header_length;
1206     unsigned char seq64be[8];
1207     struct dtls1_retransmit_state saved_state;
1208
1209     /*-
1210       OPENSSL_assert(s->init_num == 0);
1211       OPENSSL_assert(s->init_off == 0);
1212      */
1213
1214     /* XDTLS:  the requested message ought to be found, otherwise error */
1215     memset(seq64be, 0, sizeof(seq64be));
1216     seq64be[6] = (unsigned char)(seq >> 8);
1217     seq64be[7] = (unsigned char)seq;
1218
1219     item = pqueue_find(s->d1->sent_messages, seq64be);
1220     if (item == NULL) {
1221         fprintf(stderr, "retransmit:  message %d non-existant\n", seq);
1222         *found = 0;
1223         return 0;
1224     }
1225
1226     *found = 1;
1227     frag = (hm_fragment *)item->data;
1228
1229     if (frag->msg_header.is_ccs)
1230         header_length = DTLS1_CCS_HEADER_LENGTH;
1231     else
1232         header_length = DTLS1_HM_HEADER_LENGTH;
1233
1234     memcpy(s->init_buf->data, frag->fragment,
1235            frag->msg_header.msg_len + header_length);
1236     s->init_num = frag->msg_header.msg_len + header_length;
1237
1238     dtls1_set_message_header_int(s, frag->msg_header.type,
1239                                  frag->msg_header.msg_len,
1240                                  frag->msg_header.seq, 0,
1241                                  frag->msg_header.frag_len);
1242
1243     /* save current state */
1244     saved_state.enc_write_ctx = s->enc_write_ctx;
1245     saved_state.write_hash = s->write_hash;
1246     saved_state.compress = s->compress;
1247     saved_state.session = s->session;
1248     saved_state.epoch = DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1249
1250     s->d1->retransmitting = 1;
1251
1252     /* restore state in which the message was originally sent */
1253     s->enc_write_ctx = frag->msg_header.saved_retransmit_state.enc_write_ctx;
1254     s->write_hash = frag->msg_header.saved_retransmit_state.write_hash;
1255     s->compress = frag->msg_header.saved_retransmit_state.compress;
1256     s->session = frag->msg_header.saved_retransmit_state.session;
1257     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer,
1258         frag->msg_header.saved_retransmit_state.epoch);
1259
1260     ret = dtls1_do_write(s, frag->msg_header.is_ccs ?
1261                          SSL3_RT_CHANGE_CIPHER_SPEC : SSL3_RT_HANDSHAKE);
1262
1263     /* restore current state */
1264     s->enc_write_ctx = saved_state.enc_write_ctx;
1265     s->write_hash = saved_state.write_hash;
1266     s->compress = saved_state.compress;
1267     s->session = saved_state.session;
1268     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer, saved_state.epoch);
1269
1270     s->d1->retransmitting = 0;
1271
1272     (void)BIO_flush(SSL_get_wbio(s));
1273     return ret;
1274 }
1275
1276 /* call this function when the buffered messages are no longer needed */
1277 void dtls1_clear_record_buffer(SSL *s)
1278 {
1279     pitem *item;
1280
1281     for (item = pqueue_pop(s->d1->sent_messages);
1282          item != NULL; item = pqueue_pop(s->d1->sent_messages)) {
1283         dtls1_hm_fragment_free((hm_fragment *)item->data);
1284         pitem_free(item);
1285     }
1286 }
1287
1288 void dtls1_set_message_header(SSL *s, unsigned char *p,
1289                                         unsigned char mt, unsigned long len,
1290                                         unsigned long frag_off,
1291                                         unsigned long frag_len)
1292 {
1293     /* Don't change sequence numbers while listening */
1294     if (frag_off == 0 && !s->d1->listen) {
1295         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1296         s->d1->next_handshake_write_seq++;
1297     }
1298
1299     dtls1_set_message_header_int(s, mt, len, s->d1->handshake_write_seq,
1300                                  frag_off, frag_len);
1301 }
1302
1303 /* don't actually do the writing, wait till the MTU has been retrieved */
1304 static void
1305 dtls1_set_message_header_int(SSL *s, unsigned char mt,
1306                              unsigned long len, unsigned short seq_num,
1307                              unsigned long frag_off, unsigned long frag_len)
1308 {
1309     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1310
1311     msg_hdr->type = mt;
1312     msg_hdr->msg_len = len;
1313     msg_hdr->seq = seq_num;
1314     msg_hdr->frag_off = frag_off;
1315     msg_hdr->frag_len = frag_len;
1316 }
1317
1318 static void
1319 dtls1_fix_message_header(SSL *s, unsigned long frag_off,
1320                          unsigned long frag_len)
1321 {
1322     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1323
1324     msg_hdr->frag_off = frag_off;
1325     msg_hdr->frag_len = frag_len;
1326 }
1327
1328 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p)
1329 {
1330     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1331
1332     *p++ = msg_hdr->type;
1333     l2n3(msg_hdr->msg_len, p);
1334
1335     s2n(msg_hdr->seq, p);
1336     l2n3(msg_hdr->frag_off, p);
1337     l2n3(msg_hdr->frag_len, p);
1338
1339     return p;
1340 }
1341
1342 unsigned int dtls1_link_min_mtu(void)
1343 {
1344     return (g_probable_mtu[(sizeof(g_probable_mtu) /
1345                             sizeof(g_probable_mtu[0])) - 1]);
1346 }
1347
1348 unsigned int dtls1_min_mtu(SSL *s)
1349 {
1350     return dtls1_link_min_mtu() - BIO_dgram_get_mtu_overhead(SSL_get_wbio(s));
1351 }
1352
1353 void
1354 dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr)
1355 {
1356     memset(msg_hdr, 0, sizeof(*msg_hdr));
1357     msg_hdr->type = *(data++);
1358     n2l3(data, msg_hdr->msg_len);
1359
1360     n2s(data, msg_hdr->seq);
1361     n2l3(data, msg_hdr->frag_off);
1362     n2l3(data, msg_hdr->frag_len);
1363 }
1364
1365 int dtls1_shutdown(SSL *s)
1366 {
1367     int ret;
1368 #ifndef OPENSSL_NO_SCTP
1369     BIO *wbio;
1370
1371     wbio = SSL_get_wbio(s);
1372     if (wbio != NULL && BIO_dgram_is_sctp(wbio) &&
1373         !(s->shutdown & SSL_SENT_SHUTDOWN)) {
1374         ret = BIO_dgram_sctp_wait_for_dry(wbio);
1375         if (ret < 0)
1376             return -1;
1377
1378         if (ret == 0)
1379             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 1,
1380                      NULL);
1381     }
1382 #endif
1383     ret = ssl3_shutdown(s);
1384 #ifndef OPENSSL_NO_SCTP
1385     BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN, 0, NULL);
1386 #endif
1387     return ret;
1388 }
1389
1390 #ifndef OPENSSL_NO_HEARTBEATS
1391 int dtls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length)
1392 {
1393     unsigned char *pl;
1394     unsigned short hbtype;
1395     unsigned int payload;
1396     unsigned int padding = 16;  /* Use minimum padding */
1397
1398     if (s->msg_callback)
1399         s->msg_callback(0, s->version, TLS1_RT_HEARTBEAT,
1400                         p, length, s, s->msg_callback_arg);
1401
1402     /* Read type and payload length first */
1403     if (1 + 2 + 16 > length)
1404         return 0;               /* silently discard */
1405     if (length > SSL3_RT_MAX_PLAIN_LENGTH)
1406         return 0;               /* silently discard per RFC 6520 sec. 4 */
1407
1408     hbtype = *p++;
1409     n2s(p, payload);
1410     if (1 + 2 + payload + 16 > length)
1411         return 0;               /* silently discard per RFC 6520 sec. 4 */
1412     pl = p;
1413
1414     if (hbtype == TLS1_HB_REQUEST) {
1415         unsigned char *buffer, *bp;
1416         unsigned int write_length = 1 /* heartbeat type */  +
1417             2 /* heartbeat length */  +
1418             payload + padding;
1419         int r;
1420
1421         if (write_length > SSL3_RT_MAX_PLAIN_LENGTH)
1422             return 0;
1423
1424         /*
1425          * Allocate memory for the response, size is 1 byte message type,
1426          * plus 2 bytes payload length, plus payload, plus padding
1427          */
1428         buffer = OPENSSL_malloc(write_length);
1429         if (buffer == NULL)
1430             return -1;
1431         bp = buffer;
1432
1433         /* Enter response type, length and copy payload */
1434         *bp++ = TLS1_HB_RESPONSE;
1435         s2n(payload, bp);
1436         memcpy(bp, pl, payload);
1437         bp += payload;
1438         /* Random padding */
1439         if (RAND_bytes(bp, padding) <= 0) {
1440             OPENSSL_free(buffer);
1441             return -1;
1442         }
1443
1444         r = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buffer, write_length);
1445
1446         if (r >= 0 && s->msg_callback)
1447             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
1448                             buffer, write_length, s, s->msg_callback_arg);
1449
1450         OPENSSL_free(buffer);
1451
1452         if (r < 0)
1453             return r;
1454     } else if (hbtype == TLS1_HB_RESPONSE) {
1455         unsigned int seq;
1456
1457         /*
1458          * We only send sequence numbers (2 bytes unsigned int), and 16
1459          * random bytes, so we just try to read the sequence number
1460          */
1461         n2s(pl, seq);
1462
1463         if (payload == 18 && seq == s->tlsext_hb_seq) {
1464             dtls1_stop_timer(s);
1465             s->tlsext_hb_seq++;
1466             s->tlsext_hb_pending = 0;
1467         }
1468     }
1469
1470     return 0;
1471 }
1472
1473 int dtls1_heartbeat(SSL *s)
1474 {
1475     unsigned char *buf, *p;
1476     int ret = -1;
1477     unsigned int payload = 18;  /* Sequence number + random bytes */
1478     unsigned int padding = 16;  /* Use minimum padding */
1479
1480     /* Only send if peer supports and accepts HB requests... */
1481     if (!(s->tlsext_heartbeat & SSL_TLSEXT_HB_ENABLED) ||
1482         s->tlsext_heartbeat & SSL_TLSEXT_HB_DONT_SEND_REQUESTS) {
1483         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PEER_DOESNT_ACCEPT);
1484         return -1;
1485     }
1486
1487     /* ...and there is none in flight yet... */
1488     if (s->tlsext_hb_pending) {
1489         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_TLS_HEARTBEAT_PENDING);
1490         return -1;
1491     }
1492
1493     /* ...and no handshake in progress. */
1494     if (SSL_in_init(s) || s->in_handshake) {
1495         SSLerr(SSL_F_DTLS1_HEARTBEAT, SSL_R_UNEXPECTED_MESSAGE);
1496         return -1;
1497     }
1498
1499     /*
1500      * Check if padding is too long, payload and padding must not exceed 2^14
1501      * - 3 = 16381 bytes in total.
1502      */
1503     OPENSSL_assert(payload + padding <= 16381);
1504
1505     /*-
1506      * Create HeartBeat message, we just use a sequence number
1507      * as payload to distuingish different messages and add
1508      * some random stuff.
1509      *  - Message Type, 1 byte
1510      *  - Payload Length, 2 bytes (unsigned int)
1511      *  - Payload, the sequence number (2 bytes uint)
1512      *  - Payload, random bytes (16 bytes uint)
1513      *  - Padding
1514      */
1515     buf = OPENSSL_malloc(1 + 2 + payload + padding);
1516     if (buf == NULL) {
1517         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_MALLOC_FAILURE);
1518         return -1;
1519     }
1520     p = buf;
1521     /* Message Type */
1522     *p++ = TLS1_HB_REQUEST;
1523     /* Payload length (18 bytes here) */
1524     s2n(payload, p);
1525     /* Sequence number */
1526     s2n(s->tlsext_hb_seq, p);
1527     /* 16 random bytes */
1528     if (RAND_bytes(p, 16) <= 0) {
1529         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1530         goto err;
1531     }
1532     p += 16;
1533     /* Random padding */
1534     if (RAND_bytes(p, padding) <= 0) {
1535         SSLerr(SSL_F_DTLS1_HEARTBEAT, ERR_R_INTERNAL_ERROR);
1536         goto err;
1537     }
1538
1539     ret = dtls1_write_bytes(s, TLS1_RT_HEARTBEAT, buf, 3 + payload + padding);
1540     if (ret >= 0) {
1541         if (s->msg_callback)
1542             s->msg_callback(1, s->version, TLS1_RT_HEARTBEAT,
1543                             buf, 3 + payload + padding,
1544                             s, s->msg_callback_arg);
1545
1546         dtls1_start_timer(s);
1547         s->tlsext_hb_pending = 1;
1548     }
1549
1550  err:
1551     OPENSSL_free(buf);
1552
1553     return ret;
1554 }
1555 #endif