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