Check for alerts while waiting for a dry event
[openssl.git] / ssl / statem / statem_dtls.c
1 /*
2  * Copyright 2005-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <limits.h>
11 #include <string.h>
12 #include <stdio.h>
13 #include "../ssl_locl.h"
14 #include "statem_locl.h"
15 #include "internal/cryptlib.h"
16 #include <openssl/buffer.h>
17 #include <openssl/objects.h>
18 #include <openssl/evp.h>
19 #include <openssl/x509.h>
20
21 #define RSMBLY_BITMASK_SIZE(msg_len) (((msg_len) + 7) / 8)
22
23 #define RSMBLY_BITMASK_MARK(bitmask, start, end) { \
24                         if ((end) - (start) <= 8) { \
25                                 long ii; \
26                                 for (ii = (start); ii < (end); ii++) bitmask[((ii) >> 3)] |= (1 << ((ii) & 7)); \
27                         } else { \
28                                 long ii; \
29                                 bitmask[((start) >> 3)] |= bitmask_start_values[((start) & 7)]; \
30                                 for (ii = (((start) >> 3) + 1); ii < ((((end) - 1)) >> 3); ii++) bitmask[ii] = 0xff; \
31                                 bitmask[(((end) - 1) >> 3)] |= bitmask_end_values[((end) & 7)]; \
32                         } }
33
34 #define RSMBLY_BITMASK_IS_COMPLETE(bitmask, msg_len, is_complete) { \
35                         long ii; \
36                         is_complete = 1; \
37                         if (bitmask[(((msg_len) - 1) >> 3)] != bitmask_end_values[((msg_len) & 7)]) is_complete = 0; \
38                         if (is_complete) for (ii = (((msg_len) - 1) >> 3) - 1; ii >= 0 ; ii--) \
39                                 if (bitmask[ii] != 0xff) { is_complete = 0; break; } }
40
41 static unsigned char bitmask_start_values[] =
42     { 0xff, 0xfe, 0xfc, 0xf8, 0xf0, 0xe0, 0xc0, 0x80 };
43 static unsigned char bitmask_end_values[] =
44     { 0xff, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f };
45
46 static void dtls1_fix_message_header(SSL *s, size_t frag_off,
47                                      size_t frag_len);
48 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p);
49 static void dtls1_set_message_header_int(SSL *s, unsigned char mt,
50                                          size_t len,
51                                          unsigned short seq_num,
52                                          size_t frag_off,
53                                          size_t frag_len);
54 static int dtls_get_reassembled_message(SSL *s, int *errtype, size_t *len);
55
56 static hm_fragment *dtls1_hm_fragment_new(size_t frag_len, int reassembly)
57 {
58     hm_fragment *frag = NULL;
59     unsigned char *buf = NULL;
60     unsigned char *bitmask = NULL;
61
62     frag = OPENSSL_malloc(sizeof(*frag));
63     if (frag == NULL)
64         return NULL;
65
66     if (frag_len) {
67         buf = OPENSSL_malloc(frag_len);
68         if (buf == NULL) {
69             OPENSSL_free(frag);
70             return NULL;
71         }
72     }
73
74     /* zero length fragment gets zero frag->fragment */
75     frag->fragment = buf;
76
77     /* Initialize reassembly bitmask if necessary */
78     if (reassembly) {
79         bitmask = OPENSSL_zalloc(RSMBLY_BITMASK_SIZE(frag_len));
80         if (bitmask == NULL) {
81             OPENSSL_free(buf);
82             OPENSSL_free(frag);
83             return NULL;
84         }
85     }
86
87     frag->reassembly = bitmask;
88
89     return frag;
90 }
91
92 void dtls1_hm_fragment_free(hm_fragment *frag)
93 {
94     if (!frag)
95         return;
96     if (frag->msg_header.is_ccs) {
97         EVP_CIPHER_CTX_free(frag->msg_header.
98                             saved_retransmit_state.enc_write_ctx);
99         EVP_MD_CTX_free(frag->msg_header.saved_retransmit_state.write_hash);
100     }
101     OPENSSL_free(frag->fragment);
102     OPENSSL_free(frag->reassembly);
103     OPENSSL_free(frag);
104 }
105
106 /*
107  * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
108  * SSL3_RT_CHANGE_CIPHER_SPEC)
109  */
110 int dtls1_do_write(SSL *s, int type)
111 {
112     int ret;
113     size_t written;
114     size_t curr_mtu;
115     int retry = 1;
116     size_t len, frag_off, mac_size, blocksize, used_len;
117
118     if (!dtls1_query_mtu(s))
119         return -1;
120
121     if (s->d1->mtu < dtls1_min_mtu(s))
122         /* should have something reasonable now */
123         return -1;
124
125     if (s->init_off == 0 && type == SSL3_RT_HANDSHAKE) {
126         if (!ossl_assert(s->init_num ==
127                          s->d1->w_msg_hdr.msg_len + DTLS1_HM_HEADER_LENGTH))
128             return -1;
129     }
130
131     if (s->write_hash) {
132         if (s->enc_write_ctx
133             && (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_write_ctx)) &
134                 EVP_CIPH_FLAG_AEAD_CIPHER) != 0)
135             mac_size = 0;
136         else
137             mac_size = EVP_MD_CTX_size(s->write_hash);
138     } else
139         mac_size = 0;
140
141     if (s->enc_write_ctx &&
142         (EVP_CIPHER_CTX_mode(s->enc_write_ctx) == EVP_CIPH_CBC_MODE))
143         blocksize = 2 * EVP_CIPHER_CTX_block_size(s->enc_write_ctx);
144     else
145         blocksize = 0;
146
147     frag_off = 0;
148     s->rwstate = SSL_NOTHING;
149
150     /* s->init_num shouldn't ever be < 0...but just in case */
151     while (s->init_num > 0) {
152         if (type == SSL3_RT_HANDSHAKE && s->init_off != 0) {
153             /* We must be writing a fragment other than the first one */
154
155             if (frag_off > 0) {
156                 /* This is the first attempt at writing out this fragment */
157
158                 if (s->init_off <= DTLS1_HM_HEADER_LENGTH) {
159                     /*
160                      * Each fragment that was already sent must at least have
161                      * contained the message header plus one other byte.
162                      * Therefore |init_off| must have progressed by at least
163                      * |DTLS1_HM_HEADER_LENGTH + 1| bytes. If not something went
164                      * wrong.
165                      */
166                     return -1;
167                 }
168
169                 /*
170                  * Adjust |init_off| and |init_num| to allow room for a new
171                  * message header for this fragment.
172                  */
173                 s->init_off -= DTLS1_HM_HEADER_LENGTH;
174                 s->init_num += DTLS1_HM_HEADER_LENGTH;
175             } else {
176                 /*
177                  * We must have been called again after a retry so use the
178                  * fragment offset from our last attempt. We do not need
179                  * to adjust |init_off| and |init_num| as above, because
180                  * that should already have been done before the retry.
181                  */
182                 frag_off = s->d1->w_msg_hdr.frag_off;
183             }
184         }
185
186         used_len = BIO_wpending(s->wbio) + DTLS1_RT_HEADER_LENGTH
187             + mac_size + blocksize;
188         if (s->d1->mtu > used_len)
189             curr_mtu = s->d1->mtu - used_len;
190         else
191             curr_mtu = 0;
192
193         if (curr_mtu <= DTLS1_HM_HEADER_LENGTH) {
194             /*
195              * grr.. we could get an error if MTU picked was wrong
196              */
197             ret = BIO_flush(s->wbio);
198             if (ret <= 0) {
199                 s->rwstate = SSL_WRITING;
200                 return ret;
201             }
202             used_len = DTLS1_RT_HEADER_LENGTH + mac_size + blocksize;
203             if (s->d1->mtu > used_len + DTLS1_HM_HEADER_LENGTH) {
204                 curr_mtu = s->d1->mtu - used_len;
205             } else {
206                 /* Shouldn't happen */
207                 return -1;
208             }
209         }
210
211         /*
212          * We just checked that s->init_num > 0 so this cast should be safe
213          */
214         if (((unsigned int)s->init_num) > curr_mtu)
215             len = curr_mtu;
216         else
217             len = s->init_num;
218
219         if (len > s->max_send_fragment)
220             len = s->max_send_fragment;
221
222         /*
223          * XDTLS: this function is too long.  split out the CCS part
224          */
225         if (type == SSL3_RT_HANDSHAKE) {
226             if (len < DTLS1_HM_HEADER_LENGTH) {
227                 /*
228                  * len is so small that we really can't do anything sensible
229                  * so fail
230                  */
231                 return -1;
232             }
233             dtls1_fix_message_header(s, frag_off, len - DTLS1_HM_HEADER_LENGTH);
234
235             dtls1_write_message_header(s,
236                                        (unsigned char *)&s->init_buf->
237                                        data[s->init_off]);
238         }
239
240         ret = dtls1_write_bytes(s, type, &s->init_buf->data[s->init_off], len,
241                                 &written);
242         if (ret < 0) {
243             /*
244              * might need to update MTU here, but we don't know which
245              * previous packet caused the failure -- so can't really
246              * retransmit anything.  continue as if everything is fine and
247              * wait for an alert to handle the retransmit
248              */
249             if (retry && BIO_ctrl(SSL_get_wbio(s),
250                                   BIO_CTRL_DGRAM_MTU_EXCEEDED, 0, NULL) > 0) {
251                 if (!(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
252                     if (!dtls1_query_mtu(s))
253                         return -1;
254                     /* Have one more go */
255                     retry = 0;
256                 } else
257                     return -1;
258             } else {
259                 return -1;
260             }
261         } else {
262
263             /*
264              * bad if this assert fails, only part of the handshake message
265              * got sent.  but why would this happen?
266              */
267             if (!ossl_assert(len == written))
268                 return -1;
269
270             if (type == SSL3_RT_HANDSHAKE && !s->d1->retransmitting) {
271                 /*
272                  * should not be done for 'Hello Request's, but in that case
273                  * we'll ignore the result anyway
274                  */
275                 unsigned char *p =
276                     (unsigned char *)&s->init_buf->data[s->init_off];
277                 const struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
278                 size_t xlen;
279
280                 if (frag_off == 0 && s->version != DTLS1_BAD_VER) {
281                     /*
282                      * reconstruct message header is if it is being sent in
283                      * single fragment
284                      */
285                     *p++ = msg_hdr->type;
286                     l2n3(msg_hdr->msg_len, p);
287                     s2n(msg_hdr->seq, p);
288                     l2n3(0, p);
289                     l2n3(msg_hdr->msg_len, p);
290                     p -= DTLS1_HM_HEADER_LENGTH;
291                     xlen = written;
292                 } else {
293                     p += DTLS1_HM_HEADER_LENGTH;
294                     xlen = written - DTLS1_HM_HEADER_LENGTH;
295                 }
296
297                 if (!ssl3_finish_mac(s, p, xlen))
298                     return -1;
299             }
300
301             if (written == s->init_num) {
302                 if (s->msg_callback)
303                     s->msg_callback(1, s->version, type, s->init_buf->data,
304                                     (size_t)(s->init_off + s->init_num), s,
305                                     s->msg_callback_arg);
306
307                 s->init_off = 0; /* done writing this message */
308                 s->init_num = 0;
309
310                 return 1;
311             }
312             s->init_off += written;
313             s->init_num -= written;
314             written -= DTLS1_HM_HEADER_LENGTH;
315             frag_off += written;
316
317             /*
318              * We save the fragment offset for the next fragment so we have it
319              * available in case of an IO retry. We don't know the length of the
320              * next fragment yet so just set that to 0 for now. It will be
321              * updated again later.
322              */
323             dtls1_fix_message_header(s, frag_off, 0);
324         }
325     }
326     return 0;
327 }
328
329 int dtls_get_message(SSL *s, int *mt, size_t *len)
330 {
331     struct hm_header_st *msg_hdr;
332     unsigned char *p;
333     size_t msg_len;
334     size_t tmplen;
335     int errtype;
336
337     msg_hdr = &s->d1->r_msg_hdr;
338     memset(msg_hdr, 0, sizeof(*msg_hdr));
339
340  again:
341     if (!dtls_get_reassembled_message(s, &errtype, &tmplen)) {
342         if (errtype == DTLS1_HM_BAD_FRAGMENT
343                 || errtype == DTLS1_HM_FRAGMENT_RETRY) {
344             /* bad fragment received */
345             goto again;
346         }
347         return 0;
348     }
349
350     *mt = s->s3->tmp.message_type;
351
352     p = (unsigned char *)s->init_buf->data;
353     *len = s->init_num;
354
355     if (*mt == SSL3_MT_CHANGE_CIPHER_SPEC) {
356         if (s->msg_callback) {
357             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
358                             p, 1, s, s->msg_callback_arg);
359         }
360         /*
361          * This isn't a real handshake message so skip the processing below.
362          */
363         return 1;
364     }
365
366     msg_len = msg_hdr->msg_len;
367
368     /* reconstruct message header */
369     *(p++) = msg_hdr->type;
370     l2n3(msg_len, p);
371     s2n(msg_hdr->seq, p);
372     l2n3(0, p);
373     l2n3(msg_len, p);
374     if (s->version != DTLS1_BAD_VER) {
375         p -= DTLS1_HM_HEADER_LENGTH;
376         msg_len += DTLS1_HM_HEADER_LENGTH;
377     }
378
379     /*
380      * If receiving Finished, record MAC of prior handshake messages for
381      * Finished verification.
382      */
383     if (*mt == SSL3_MT_FINISHED && !ssl3_take_mac(s)) {
384         /* SSLfatal() already called */
385         return 0;
386     }
387
388     if (!ssl3_finish_mac(s, p, msg_len))
389         return 0;
390     if (s->msg_callback)
391         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
392                         p, msg_len, s, s->msg_callback_arg);
393
394     memset(msg_hdr, 0, sizeof(*msg_hdr));
395
396     s->d1->handshake_read_seq++;
397
398     s->init_msg = s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
399
400     return 1;
401 }
402
403 /*
404  * dtls1_max_handshake_message_len returns the maximum number of bytes
405  * permitted in a DTLS handshake message for |s|. The minimum is 16KB, but
406  * may be greater if the maximum certificate list size requires it.
407  */
408 static size_t dtls1_max_handshake_message_len(const SSL *s)
409 {
410     size_t max_len = DTLS1_HM_HEADER_LENGTH + SSL3_RT_MAX_ENCRYPTED_LENGTH;
411     if (max_len < s->max_cert_list)
412         return s->max_cert_list;
413     return max_len;
414 }
415
416 static int dtls1_preprocess_fragment(SSL *s, struct hm_header_st *msg_hdr)
417 {
418     size_t frag_off, frag_len, msg_len;
419
420     msg_len = msg_hdr->msg_len;
421     frag_off = msg_hdr->frag_off;
422     frag_len = msg_hdr->frag_len;
423
424     /* sanity checking */
425     if ((frag_off + frag_len) > msg_len
426             || msg_len > dtls1_max_handshake_message_len(s)) {
427         SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_DTLS1_PREPROCESS_FRAGMENT,
428                  SSL_R_EXCESSIVE_MESSAGE_SIZE);
429         return 0;
430     }
431
432     if (s->d1->r_msg_hdr.frag_off == 0) { /* first fragment */
433         /*
434          * msg_len is limited to 2^24, but is effectively checked against
435          * dtls_max_handshake_message_len(s) above
436          */
437         if (!BUF_MEM_grow_clean(s->init_buf, msg_len + DTLS1_HM_HEADER_LENGTH)) {
438             SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS1_PREPROCESS_FRAGMENT,
439                      ERR_R_BUF_LIB);
440             return 0;
441         }
442
443         s->s3->tmp.message_size = msg_len;
444         s->d1->r_msg_hdr.msg_len = msg_len;
445         s->s3->tmp.message_type = msg_hdr->type;
446         s->d1->r_msg_hdr.type = msg_hdr->type;
447         s->d1->r_msg_hdr.seq = msg_hdr->seq;
448     } else if (msg_len != s->d1->r_msg_hdr.msg_len) {
449         /*
450          * They must be playing with us! BTW, failure to enforce upper limit
451          * would open possibility for buffer overrun.
452          */
453         SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_DTLS1_PREPROCESS_FRAGMENT,
454                  SSL_R_EXCESSIVE_MESSAGE_SIZE);
455         return 0;
456     }
457
458     return 1;
459 }
460
461 /*
462  * Returns 1 if there is a buffered fragment available, 0 if not, or -1 on a
463  * fatal error.
464  */
465 static int dtls1_retrieve_buffered_fragment(SSL *s, size_t *len)
466 {
467     /*-
468      * (0) check whether the desired fragment is available
469      * if so:
470      * (1) copy over the fragment to s->init_buf->data[]
471      * (2) update s->init_num
472      */
473     pitem *item;
474     hm_fragment *frag;
475     int ret;
476
477     do {
478         item = pqueue_peek(s->d1->buffered_messages);
479         if (item == NULL)
480             return 0;
481
482         frag = (hm_fragment *)item->data;
483
484         if (frag->msg_header.seq < s->d1->handshake_read_seq) {
485             /* This is a stale message that has been buffered so clear it */
486             pqueue_pop(s->d1->buffered_messages);
487             dtls1_hm_fragment_free(frag);
488             pitem_free(item);
489             item = NULL;
490             frag = NULL;
491         }
492     } while (item == NULL);
493
494     /* Don't return if reassembly still in progress */
495     if (frag->reassembly != NULL)
496         return 0;
497
498     if (s->d1->handshake_read_seq == frag->msg_header.seq) {
499         size_t frag_len = frag->msg_header.frag_len;
500         pqueue_pop(s->d1->buffered_messages);
501
502         /* Calls SSLfatal() as required */
503         ret = dtls1_preprocess_fragment(s, &frag->msg_header);
504
505         if (ret) {
506             unsigned char *p =
507                 (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
508             memcpy(&p[frag->msg_header.frag_off], frag->fragment,
509                    frag->msg_header.frag_len);
510         }
511
512         dtls1_hm_fragment_free(frag);
513         pitem_free(item);
514
515         if (ret) {
516             *len = frag_len;
517             return 1;
518         }
519
520         /* Fatal error */
521         s->init_num = 0;
522         return -1;
523     } else {
524         return 0;
525     }
526 }
527
528 static int
529 dtls1_reassemble_fragment(SSL *s, const struct hm_header_st *msg_hdr)
530 {
531     hm_fragment *frag = NULL;
532     pitem *item = NULL;
533     int i = -1, is_complete;
534     unsigned char seq64be[8];
535     size_t frag_len = msg_hdr->frag_len;
536     size_t readbytes;
537
538     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len ||
539         msg_hdr->msg_len > dtls1_max_handshake_message_len(s))
540         goto err;
541
542     if (frag_len == 0) {
543         return DTLS1_HM_FRAGMENT_RETRY;
544     }
545
546     /* Try to find item in queue */
547     memset(seq64be, 0, sizeof(seq64be));
548     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
549     seq64be[7] = (unsigned char)msg_hdr->seq;
550     item = pqueue_find(s->d1->buffered_messages, seq64be);
551
552     if (item == NULL) {
553         frag = dtls1_hm_fragment_new(msg_hdr->msg_len, 1);
554         if (frag == NULL)
555             goto err;
556         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
557         frag->msg_header.frag_len = frag->msg_header.msg_len;
558         frag->msg_header.frag_off = 0;
559     } else {
560         frag = (hm_fragment *)item->data;
561         if (frag->msg_header.msg_len != msg_hdr->msg_len) {
562             item = NULL;
563             frag = NULL;
564             goto err;
565         }
566     }
567
568     /*
569      * If message is already reassembled, this must be a retransmit and can
570      * be dropped. In this case item != NULL and so frag does not need to be
571      * freed.
572      */
573     if (frag->reassembly == NULL) {
574         unsigned char devnull[256];
575
576         while (frag_len) {
577             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
578                                           devnull,
579                                           frag_len >
580                                           sizeof(devnull) ? sizeof(devnull) :
581                                           frag_len, 0, &readbytes);
582             if (i <= 0)
583                 goto err;
584             frag_len -= readbytes;
585         }
586         return DTLS1_HM_FRAGMENT_RETRY;
587     }
588
589     /* read the body of the fragment (header has already been read */
590     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
591                                   frag->fragment + msg_hdr->frag_off,
592                                   frag_len, 0, &readbytes);
593     if (i <= 0 || readbytes != frag_len)
594         i = -1;
595     if (i <= 0)
596         goto err;
597
598     RSMBLY_BITMASK_MARK(frag->reassembly, (long)msg_hdr->frag_off,
599                         (long)(msg_hdr->frag_off + frag_len));
600
601     if (!ossl_assert(msg_hdr->msg_len > 0))
602         goto err;
603     RSMBLY_BITMASK_IS_COMPLETE(frag->reassembly, (long)msg_hdr->msg_len,
604                                is_complete);
605
606     if (is_complete) {
607         OPENSSL_free(frag->reassembly);
608         frag->reassembly = NULL;
609     }
610
611     if (item == NULL) {
612         item = pitem_new(seq64be, frag);
613         if (item == NULL) {
614             i = -1;
615             goto err;
616         }
617
618         item = pqueue_insert(s->d1->buffered_messages, item);
619         /*
620          * pqueue_insert fails iff a duplicate item is inserted. However,
621          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
622          * would have returned it and control would never have reached this
623          * branch.
624          */
625         if (!ossl_assert(item != NULL))
626             goto err;
627     }
628
629     return DTLS1_HM_FRAGMENT_RETRY;
630
631  err:
632     if (item == NULL)
633         dtls1_hm_fragment_free(frag);
634     return -1;
635 }
636
637 static int
638 dtls1_process_out_of_seq_message(SSL *s, const struct hm_header_st *msg_hdr)
639 {
640     int i = -1;
641     hm_fragment *frag = NULL;
642     pitem *item = NULL;
643     unsigned char seq64be[8];
644     size_t frag_len = msg_hdr->frag_len;
645     size_t readbytes;
646
647     if ((msg_hdr->frag_off + frag_len) > msg_hdr->msg_len)
648         goto err;
649
650     /* Try to find item in queue, to prevent duplicate entries */
651     memset(seq64be, 0, sizeof(seq64be));
652     seq64be[6] = (unsigned char)(msg_hdr->seq >> 8);
653     seq64be[7] = (unsigned char)msg_hdr->seq;
654     item = pqueue_find(s->d1->buffered_messages, seq64be);
655
656     /*
657      * If we already have an entry and this one is a fragment, don't discard
658      * it and rather try to reassemble it.
659      */
660     if (item != NULL && frag_len != msg_hdr->msg_len)
661         item = NULL;
662
663     /*
664      * Discard the message if sequence number was already there, is too far
665      * in the future, already in the queue or if we received a FINISHED
666      * before the SERVER_HELLO, which then must be a stale retransmit.
667      */
668     if (msg_hdr->seq <= s->d1->handshake_read_seq ||
669         msg_hdr->seq > s->d1->handshake_read_seq + 10 || item != NULL ||
670         (s->d1->handshake_read_seq == 0 && msg_hdr->type == SSL3_MT_FINISHED)) {
671         unsigned char devnull[256];
672
673         while (frag_len) {
674             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
675                                           devnull,
676                                           frag_len >
677                                           sizeof(devnull) ? sizeof(devnull) :
678                                           frag_len, 0, &readbytes);
679             if (i <= 0)
680                 goto err;
681             frag_len -= readbytes;
682         }
683     } else {
684         if (frag_len != msg_hdr->msg_len) {
685             return dtls1_reassemble_fragment(s, msg_hdr);
686         }
687
688         if (frag_len > dtls1_max_handshake_message_len(s))
689             goto err;
690
691         frag = dtls1_hm_fragment_new(frag_len, 0);
692         if (frag == NULL)
693             goto err;
694
695         memcpy(&(frag->msg_header), msg_hdr, sizeof(*msg_hdr));
696
697         if (frag_len) {
698             /*
699              * read the body of the fragment (header has already been read
700              */
701             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
702                                           frag->fragment, frag_len, 0,
703                                           &readbytes);
704             if (i<=0 || readbytes != frag_len)
705                 i = -1;
706             if (i <= 0)
707                 goto err;
708         }
709
710         item = pitem_new(seq64be, frag);
711         if (item == NULL)
712             goto err;
713
714         item = pqueue_insert(s->d1->buffered_messages, item);
715         /*
716          * pqueue_insert fails iff a duplicate item is inserted. However,
717          * |item| cannot be a duplicate. If it were, |pqueue_find|, above,
718          * would have returned it. Then, either |frag_len| !=
719          * |msg_hdr->msg_len| in which case |item| is set to NULL and it will
720          * have been processed with |dtls1_reassemble_fragment|, above, or
721          * the record will have been discarded.
722          */
723         if (!ossl_assert(item != NULL))
724             goto err;
725     }
726
727     return DTLS1_HM_FRAGMENT_RETRY;
728
729  err:
730     if (item == NULL)
731         dtls1_hm_fragment_free(frag);
732     return 0;
733 }
734
735 static int dtls_get_reassembled_message(SSL *s, int *errtype, size_t *len)
736 {
737     unsigned char wire[DTLS1_HM_HEADER_LENGTH];
738     size_t mlen, frag_off, frag_len;
739     int i, ret, recvd_type;
740     struct hm_header_st msg_hdr;
741     size_t readbytes;
742
743     *errtype = 0;
744
745  redo:
746     /* see if we have the required fragment already */
747     ret = dtls1_retrieve_buffered_fragment(s, &frag_len);
748     if (ret < 0) {
749         /* SSLfatal() already called */
750         return 0;
751     }
752     if (ret > 0) {
753         s->init_num = frag_len;
754         *len = frag_len;
755         return 1;
756     }
757
758     /* read handshake message header */
759     i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type, wire,
760                                   DTLS1_HM_HEADER_LENGTH, 0, &readbytes);
761     if (i <= 0) {               /* nbio, or an error */
762         s->rwstate = SSL_READING;
763         *len = 0;
764         return 0;
765     }
766     if (recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
767         if (wire[0] != SSL3_MT_CCS) {
768             SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE,
769                      SSL_F_DTLS_GET_REASSEMBLED_MESSAGE,
770                      SSL_R_BAD_CHANGE_CIPHER_SPEC);
771             goto f_err;
772         }
773
774         memcpy(s->init_buf->data, wire, readbytes);
775         s->init_num = readbytes - 1;
776         s->init_msg = s->init_buf->data + 1;
777         s->s3->tmp.message_type = SSL3_MT_CHANGE_CIPHER_SPEC;
778         s->s3->tmp.message_size = readbytes - 1;
779         *len = readbytes - 1;
780         return 1;
781     }
782
783     /* Handshake fails if message header is incomplete */
784     if (readbytes != DTLS1_HM_HEADER_LENGTH) {
785         SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE,
786                  SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_UNEXPECTED_MESSAGE);
787         goto f_err;
788     }
789
790     /* parse the message fragment header */
791     dtls1_get_message_header(wire, &msg_hdr);
792
793     mlen = msg_hdr.msg_len;
794     frag_off = msg_hdr.frag_off;
795     frag_len = msg_hdr.frag_len;
796
797     /*
798      * We must have at least frag_len bytes left in the record to be read.
799      * Fragments must not span records.
800      */
801     if (frag_len > RECORD_LAYER_get_rrec_length(&s->rlayer)) {
802         SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER,
803                  SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_BAD_LENGTH);
804         goto f_err;
805     }
806
807     /*
808      * if this is a future (or stale) message it gets buffered
809      * (or dropped)--no further processing at this time
810      * While listening, we accept seq 1 (ClientHello with cookie)
811      * although we're still expecting seq 0 (ClientHello)
812      */
813     if (msg_hdr.seq != s->d1->handshake_read_seq) {
814         *errtype = dtls1_process_out_of_seq_message(s, &msg_hdr);
815         return 0;
816     }
817
818     if (frag_len && frag_len < mlen) {
819         *errtype = dtls1_reassemble_fragment(s, &msg_hdr);
820         return 0;
821     }
822
823     if (!s->server
824             && s->d1->r_msg_hdr.frag_off == 0
825             && s->statem.hand_state != TLS_ST_OK
826             && wire[0] == SSL3_MT_HELLO_REQUEST) {
827         /*
828          * The server may always send 'Hello Request' messages -- we are
829          * doing a handshake anyway now, so ignore them if their format is
830          * correct. Does not count for 'Finished' MAC.
831          */
832         if (wire[1] == 0 && wire[2] == 0 && wire[3] == 0) {
833             if (s->msg_callback)
834                 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
835                                 wire, DTLS1_HM_HEADER_LENGTH, s,
836                                 s->msg_callback_arg);
837
838             s->init_num = 0;
839             goto redo;
840         } else {                /* Incorrectly formatted Hello request */
841
842             SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE,
843                      SSL_F_DTLS_GET_REASSEMBLED_MESSAGE,
844                      SSL_R_UNEXPECTED_MESSAGE);
845             goto f_err;
846         }
847     }
848
849     if (!dtls1_preprocess_fragment(s, &msg_hdr)) {
850         /* SSLfatal() already called */
851         goto f_err;
852     }
853
854     if (frag_len > 0) {
855         unsigned char *p =
856             (unsigned char *)s->init_buf->data + DTLS1_HM_HEADER_LENGTH;
857
858         i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
859                                       &p[frag_off], frag_len, 0, &readbytes);
860
861         /*
862          * This shouldn't ever fail due to NBIO because we already checked
863          * that we have enough data in the record
864          */
865         if (i <= 0) {
866             s->rwstate = SSL_READING;
867             *len = 0;
868             return 0;
869         }
870     } else {
871         readbytes = 0;
872     }
873
874     /*
875      * XDTLS: an incorrectly formatted fragment should cause the handshake
876      * to fail
877      */
878     if (readbytes != frag_len) {
879         SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER,
880                  SSL_F_DTLS_GET_REASSEMBLED_MESSAGE, SSL_R_BAD_LENGTH);
881         goto f_err;
882     }
883
884     /*
885      * Note that s->init_num is *not* used as current offset in
886      * s->init_buf->data, but as a counter summing up fragments' lengths: as
887      * soon as they sum up to handshake packet length, we assume we have got
888      * all the fragments.
889      */
890     *len = s->init_num = frag_len;
891     return 1;
892
893  f_err:
894     s->init_num = 0;
895     *len = 0;
896     return 0;
897 }
898
899 /*-
900  * for these 2 messages, we need to
901  * ssl->enc_read_ctx                    re-init
902  * ssl->rlayer.read_sequence            zero
903  * ssl->s3->read_mac_secret             re-init
904  * ssl->session->read_sym_enc           assign
905  * ssl->session->read_compression       assign
906  * ssl->session->read_hash              assign
907  */
908 int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt)
909 {
910     if (s->version == DTLS1_BAD_VER) {
911         s->d1->next_handshake_write_seq++;
912
913         if (!WPACKET_put_bytes_u16(pkt, s->d1->handshake_write_seq)) {
914             SSLfatal(s, SSL_AD_INTERNAL_ERROR,
915                      SSL_F_DTLS_CONSTRUCT_CHANGE_CIPHER_SPEC,
916                      ERR_R_INTERNAL_ERROR);
917             return 0;
918         }
919     }
920
921     return 1;
922 }
923
924 #ifndef OPENSSL_NO_SCTP
925 /*
926  * Wait for a dry event. Should only be called at a point in the handshake
927  * where we are not expecting any data from the peer except an alert.
928  */
929 WORK_STATE dtls_wait_for_dry(SSL *s)
930 {
931     int ret, errtype;
932     size_t len;
933
934     /* read app data until dry event */
935     ret = BIO_dgram_sctp_wait_for_dry(SSL_get_wbio(s));
936     if (ret < 0) {
937         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS_WAIT_FOR_DRY,
938                  ERR_R_INTERNAL_ERROR);
939         return WORK_ERROR;
940     }
941
942     if (ret == 0) {
943         /*
944          * We're not expecting any more messages from the peer at this point -
945          * but we could get an alert. If an alert is waiting then we will never
946          * return successfully. Therefore we attempt to read a message. This
947          * should never succeed but will process any waiting alerts.
948          */
949         if (dtls_get_reassembled_message(s, &errtype, &len)) {
950             /* The call succeeded! This should never happen */
951             SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_DTLS_WAIT_FOR_DRY,
952                      SSL_R_UNEXPECTED_MESSAGE);
953             return WORK_ERROR;
954         }
955
956         s->s3->in_read_app_data = 2;
957         s->rwstate = SSL_READING;
958         BIO_clear_retry_flags(SSL_get_rbio(s));
959         BIO_set_retry_read(SSL_get_rbio(s));
960         return WORK_MORE_A;
961     }
962     return WORK_FINISHED_CONTINUE;
963 }
964 #endif
965
966 int dtls1_read_failed(SSL *s, int code)
967 {
968     if (code > 0) {
969         SSLfatal(s, SSL_AD_INTERNAL_ERROR,
970                  SSL_F_DTLS1_READ_FAILED, ERR_R_INTERNAL_ERROR);
971         return 0;
972     }
973
974     if (!dtls1_is_timer_expired(s) || ossl_statem_in_error(s)) {
975         /*
976          * not a timeout, none of our business, let higher layers handle
977          * this.  in fact it's probably an error
978          */
979         return code;
980     }
981     /* done, no need to send a retransmit */
982     if (!SSL_in_init(s))
983     {
984         BIO_set_flags(SSL_get_rbio(s), BIO_FLAGS_READ);
985         return code;
986     }
987
988     return dtls1_handle_timeout(s);
989 }
990
991 int dtls1_get_queue_priority(unsigned short seq, int is_ccs)
992 {
993     /*
994      * The index of the retransmission queue actually is the message sequence
995      * number, since the queue only contains messages of a single handshake.
996      * However, the ChangeCipherSpec has no message sequence number and so
997      * using only the sequence will result in the CCS and Finished having the
998      * same index. To prevent this, the sequence number is multiplied by 2.
999      * In case of a CCS 1 is subtracted. This does not only differ CSS and
1000      * Finished, it also maintains the order of the index (important for
1001      * priority queues) and fits in the unsigned short variable.
1002      */
1003     return seq * 2 - is_ccs;
1004 }
1005
1006 int dtls1_retransmit_buffered_messages(SSL *s)
1007 {
1008     pqueue *sent = s->d1->sent_messages;
1009     piterator iter;
1010     pitem *item;
1011     hm_fragment *frag;
1012     int found = 0;
1013
1014     iter = pqueue_iterator(sent);
1015
1016     for (item = pqueue_next(&iter); item != NULL; item = pqueue_next(&iter)) {
1017         frag = (hm_fragment *)item->data;
1018         if (dtls1_retransmit_message(s, (unsigned short)
1019                                      dtls1_get_queue_priority
1020                                      (frag->msg_header.seq,
1021                                       frag->msg_header.is_ccs), &found) <= 0)
1022             return -1;
1023     }
1024
1025     return 1;
1026 }
1027
1028 int dtls1_buffer_message(SSL *s, int is_ccs)
1029 {
1030     pitem *item;
1031     hm_fragment *frag;
1032     unsigned char seq64be[8];
1033
1034     /*
1035      * this function is called immediately after a message has been
1036      * serialized
1037      */
1038     if (!ossl_assert(s->init_off == 0))
1039         return 0;
1040
1041     frag = dtls1_hm_fragment_new(s->init_num, 0);
1042     if (frag == NULL)
1043         return 0;
1044
1045     memcpy(frag->fragment, s->init_buf->data, s->init_num);
1046
1047     if (is_ccs) {
1048         /* For DTLS1_BAD_VER the header length is non-standard */
1049         if (!ossl_assert(s->d1->w_msg_hdr.msg_len +
1050                          ((s->version ==
1051                            DTLS1_BAD_VER) ? 3 : DTLS1_CCS_HEADER_LENGTH)
1052                          == (unsigned int)s->init_num))
1053             return 0;
1054     } else {
1055         if (!ossl_assert(s->d1->w_msg_hdr.msg_len +
1056                          DTLS1_HM_HEADER_LENGTH == (unsigned int)s->init_num))
1057             return 0;
1058     }
1059
1060     frag->msg_header.msg_len = s->d1->w_msg_hdr.msg_len;
1061     frag->msg_header.seq = s->d1->w_msg_hdr.seq;
1062     frag->msg_header.type = s->d1->w_msg_hdr.type;
1063     frag->msg_header.frag_off = 0;
1064     frag->msg_header.frag_len = s->d1->w_msg_hdr.msg_len;
1065     frag->msg_header.is_ccs = is_ccs;
1066
1067     /* save current state */
1068     frag->msg_header.saved_retransmit_state.enc_write_ctx = s->enc_write_ctx;
1069     frag->msg_header.saved_retransmit_state.write_hash = s->write_hash;
1070     frag->msg_header.saved_retransmit_state.compress = s->compress;
1071     frag->msg_header.saved_retransmit_state.session = s->session;
1072     frag->msg_header.saved_retransmit_state.epoch =
1073         DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1074
1075     memset(seq64be, 0, sizeof(seq64be));
1076     seq64be[6] =
1077         (unsigned
1078          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1079                                         frag->msg_header.is_ccs) >> 8);
1080     seq64be[7] =
1081         (unsigned
1082          char)(dtls1_get_queue_priority(frag->msg_header.seq,
1083                                         frag->msg_header.is_ccs));
1084
1085     item = pitem_new(seq64be, frag);
1086     if (item == NULL) {
1087         dtls1_hm_fragment_free(frag);
1088         return 0;
1089     }
1090
1091     pqueue_insert(s->d1->sent_messages, item);
1092     return 1;
1093 }
1094
1095 int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found)
1096 {
1097     int ret;
1098     /* XDTLS: for now assuming that read/writes are blocking */
1099     pitem *item;
1100     hm_fragment *frag;
1101     unsigned long header_length;
1102     unsigned char seq64be[8];
1103     struct dtls1_retransmit_state saved_state;
1104
1105     /* XDTLS:  the requested message ought to be found, otherwise error */
1106     memset(seq64be, 0, sizeof(seq64be));
1107     seq64be[6] = (unsigned char)(seq >> 8);
1108     seq64be[7] = (unsigned char)seq;
1109
1110     item = pqueue_find(s->d1->sent_messages, seq64be);
1111     if (item == NULL) {
1112         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DTLS1_RETRANSMIT_MESSAGE,
1113                  ERR_R_INTERNAL_ERROR);
1114         *found = 0;
1115         return 0;
1116     }
1117
1118     *found = 1;
1119     frag = (hm_fragment *)item->data;
1120
1121     if (frag->msg_header.is_ccs)
1122         header_length = DTLS1_CCS_HEADER_LENGTH;
1123     else
1124         header_length = DTLS1_HM_HEADER_LENGTH;
1125
1126     memcpy(s->init_buf->data, frag->fragment,
1127            frag->msg_header.msg_len + header_length);
1128     s->init_num = frag->msg_header.msg_len + header_length;
1129
1130     dtls1_set_message_header_int(s, frag->msg_header.type,
1131                                  frag->msg_header.msg_len,
1132                                  frag->msg_header.seq, 0,
1133                                  frag->msg_header.frag_len);
1134
1135     /* save current state */
1136     saved_state.enc_write_ctx = s->enc_write_ctx;
1137     saved_state.write_hash = s->write_hash;
1138     saved_state.compress = s->compress;
1139     saved_state.session = s->session;
1140     saved_state.epoch = DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer);
1141
1142     s->d1->retransmitting = 1;
1143
1144     /* restore state in which the message was originally sent */
1145     s->enc_write_ctx = frag->msg_header.saved_retransmit_state.enc_write_ctx;
1146     s->write_hash = frag->msg_header.saved_retransmit_state.write_hash;
1147     s->compress = frag->msg_header.saved_retransmit_state.compress;
1148     s->session = frag->msg_header.saved_retransmit_state.session;
1149     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer,
1150                                         frag->msg_header.
1151                                         saved_retransmit_state.epoch);
1152
1153     ret = dtls1_do_write(s, frag->msg_header.is_ccs ?
1154                          SSL3_RT_CHANGE_CIPHER_SPEC : SSL3_RT_HANDSHAKE);
1155
1156     /* restore current state */
1157     s->enc_write_ctx = saved_state.enc_write_ctx;
1158     s->write_hash = saved_state.write_hash;
1159     s->compress = saved_state.compress;
1160     s->session = saved_state.session;
1161     DTLS_RECORD_LAYER_set_saved_w_epoch(&s->rlayer, saved_state.epoch);
1162
1163     s->d1->retransmitting = 0;
1164
1165     (void)BIO_flush(s->wbio);
1166     return ret;
1167 }
1168
1169 void dtls1_set_message_header(SSL *s,
1170                               unsigned char mt, size_t len,
1171                               size_t frag_off, size_t frag_len)
1172 {
1173     if (frag_off == 0) {
1174         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1175         s->d1->next_handshake_write_seq++;
1176     }
1177
1178     dtls1_set_message_header_int(s, mt, len, s->d1->handshake_write_seq,
1179                                  frag_off, frag_len);
1180 }
1181
1182 /* don't actually do the writing, wait till the MTU has been retrieved */
1183 static void
1184 dtls1_set_message_header_int(SSL *s, unsigned char mt,
1185                              size_t len, unsigned short seq_num,
1186                              size_t frag_off, size_t frag_len)
1187 {
1188     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1189
1190     msg_hdr->type = mt;
1191     msg_hdr->msg_len = len;
1192     msg_hdr->seq = seq_num;
1193     msg_hdr->frag_off = frag_off;
1194     msg_hdr->frag_len = frag_len;
1195 }
1196
1197 static void
1198 dtls1_fix_message_header(SSL *s, size_t frag_off, size_t frag_len)
1199 {
1200     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1201
1202     msg_hdr->frag_off = frag_off;
1203     msg_hdr->frag_len = frag_len;
1204 }
1205
1206 static unsigned char *dtls1_write_message_header(SSL *s, unsigned char *p)
1207 {
1208     struct hm_header_st *msg_hdr = &s->d1->w_msg_hdr;
1209
1210     *p++ = msg_hdr->type;
1211     l2n3(msg_hdr->msg_len, p);
1212
1213     s2n(msg_hdr->seq, p);
1214     l2n3(msg_hdr->frag_off, p);
1215     l2n3(msg_hdr->frag_len, p);
1216
1217     return p;
1218 }
1219
1220 void dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr)
1221 {
1222     memset(msg_hdr, 0, sizeof(*msg_hdr));
1223     msg_hdr->type = *(data++);
1224     n2l3(data, msg_hdr->msg_len);
1225
1226     n2s(data, msg_hdr->seq);
1227     n2l3(data, msg_hdr->frag_off);
1228     n2l3(data, msg_hdr->frag_len);
1229 }
1230
1231 int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype)
1232 {
1233     unsigned char *header;
1234
1235     if (htype == SSL3_MT_CHANGE_CIPHER_SPEC) {
1236         s->d1->handshake_write_seq = s->d1->next_handshake_write_seq;
1237         dtls1_set_message_header_int(s, SSL3_MT_CCS, 0,
1238                                      s->d1->handshake_write_seq, 0, 0);
1239         if (!WPACKET_put_bytes_u8(pkt, SSL3_MT_CCS))
1240             return 0;
1241     } else {
1242         dtls1_set_message_header(s, htype, 0, 0, 0);
1243         /*
1244          * We allocate space at the start for the message header. This gets
1245          * filled in later
1246          */
1247         if (!WPACKET_allocate_bytes(pkt, DTLS1_HM_HEADER_LENGTH, &header)
1248                 || !WPACKET_start_sub_packet(pkt))
1249             return 0;
1250     }
1251
1252     return 1;
1253 }
1254
1255 int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype)
1256 {
1257     size_t msglen;
1258
1259     if ((htype != SSL3_MT_CHANGE_CIPHER_SPEC && !WPACKET_close(pkt))
1260             || !WPACKET_get_length(pkt, &msglen)
1261             || msglen > INT_MAX)
1262         return 0;
1263
1264     if (htype != SSL3_MT_CHANGE_CIPHER_SPEC) {
1265         s->d1->w_msg_hdr.msg_len = msglen - DTLS1_HM_HEADER_LENGTH;
1266         s->d1->w_msg_hdr.frag_len = msglen - DTLS1_HM_HEADER_LENGTH;
1267     }
1268     s->init_num = (int)msglen;
1269     s->init_off = 0;
1270
1271     if (htype != DTLS1_MT_HELLO_VERIFY_REQUEST) {
1272         /* Buffer the message to handle re-xmits */
1273         if (!dtls1_buffer_message(s, htype == SSL3_MT_CHANGE_CIPHER_SPEC
1274                                      ? 1 : 0))
1275             return 0;
1276     }
1277
1278     return 1;
1279 }