d2bb67832307590961ee8c8ec4a6c75132df1613
[openssl.git] / ssl / record / rec_layer_d1.c
1 /*
2  * Copyright 2005-2016 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 <stdio.h>
11 #include <errno.h>
12 #define USE_SOCKETS
13 #include "../ssl_locl.h"
14 #include <openssl/evp.h>
15 #include <openssl/buffer.h>
16 #include "record_locl.h"
17
18 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl)
19 {
20     DTLS_RECORD_LAYER *d;
21
22     if ((d = OPENSSL_malloc(sizeof(*d))) == NULL)
23         return (0);
24
25     rl->d = d;
26
27     d->unprocessed_rcds.q = pqueue_new();
28     d->processed_rcds.q = pqueue_new();
29     d->buffered_app_data.q = pqueue_new();
30
31     if (d->unprocessed_rcds.q == NULL || d->processed_rcds.q == NULL
32         || d->buffered_app_data.q == NULL) {
33         pqueue_free(d->unprocessed_rcds.q);
34         pqueue_free(d->processed_rcds.q);
35         pqueue_free(d->buffered_app_data.q);
36         OPENSSL_free(d);
37         rl->d = NULL;
38         return (0);
39     }
40
41     return 1;
42 }
43
44 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl)
45 {
46     DTLS_RECORD_LAYER_clear(rl);
47     pqueue_free(rl->d->unprocessed_rcds.q);
48     pqueue_free(rl->d->processed_rcds.q);
49     pqueue_free(rl->d->buffered_app_data.q);
50     OPENSSL_free(rl->d);
51     rl->d = NULL;
52 }
53
54 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl)
55 {
56     DTLS_RECORD_LAYER *d;
57     pitem *item = NULL;
58     DTLS1_RECORD_DATA *rdata;
59     pqueue *unprocessed_rcds;
60     pqueue *processed_rcds;
61     pqueue *buffered_app_data;
62
63     d = rl->d;
64
65     while ((item = pqueue_pop(d->unprocessed_rcds.q)) != NULL) {
66         rdata = (DTLS1_RECORD_DATA *)item->data;
67         OPENSSL_free(rdata->rbuf.buf);
68         OPENSSL_free(item->data);
69         pitem_free(item);
70     }
71
72     while ((item = pqueue_pop(d->processed_rcds.q)) != NULL) {
73         rdata = (DTLS1_RECORD_DATA *)item->data;
74         OPENSSL_free(rdata->rbuf.buf);
75         OPENSSL_free(item->data);
76         pitem_free(item);
77     }
78
79     while ((item = pqueue_pop(d->buffered_app_data.q)) != NULL) {
80         rdata = (DTLS1_RECORD_DATA *)item->data;
81         OPENSSL_free(rdata->rbuf.buf);
82         OPENSSL_free(item->data);
83         pitem_free(item);
84     }
85
86     unprocessed_rcds = d->unprocessed_rcds.q;
87     processed_rcds = d->processed_rcds.q;
88     buffered_app_data = d->buffered_app_data.q;
89     memset(d, 0, sizeof(*d));
90     d->unprocessed_rcds.q = unprocessed_rcds;
91     d->processed_rcds.q = processed_rcds;
92     d->buffered_app_data.q = buffered_app_data;
93 }
94
95 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e)
96 {
97     if (e == rl->d->w_epoch - 1) {
98         memcpy(rl->d->curr_write_sequence,
99                rl->write_sequence, sizeof(rl->write_sequence));
100         memcpy(rl->write_sequence,
101                rl->d->last_write_sequence, sizeof(rl->write_sequence));
102     } else if (e == rl->d->w_epoch + 1) {
103         memcpy(rl->d->last_write_sequence,
104                rl->write_sequence, sizeof(unsigned char[8]));
105         memcpy(rl->write_sequence,
106                rl->d->curr_write_sequence, sizeof(rl->write_sequence));
107     }
108     rl->d->w_epoch = e;
109 }
110
111 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl)
112 {
113     memcpy(rl->write_sequence, rl->read_sequence, sizeof(rl->write_sequence));
114 }
115
116 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq)
117 {
118     memcpy(rl->write_sequence, seq, SEQ_NUM_SIZE);
119 }
120
121 static size_t have_handshake_fragment(SSL *s, int type, unsigned char *buf,
122                                       size_t len);
123
124 /* copy buffered record into SSL structure */
125 static int dtls1_copy_record(SSL *s, pitem *item)
126 {
127     DTLS1_RECORD_DATA *rdata;
128
129     rdata = (DTLS1_RECORD_DATA *)item->data;
130
131     SSL3_BUFFER_release(&s->rlayer.rbuf);
132
133     s->rlayer.packet = rdata->packet;
134     s->rlayer.packet_length = rdata->packet_length;
135     memcpy(&s->rlayer.rbuf, &(rdata->rbuf), sizeof(SSL3_BUFFER));
136     memcpy(&s->rlayer.rrec, &(rdata->rrec), sizeof(SSL3_RECORD));
137
138     /* Set proper sequence number for mac calculation */
139     memcpy(&(s->rlayer.read_sequence[2]), &(rdata->packet[5]), 6);
140
141     return (1);
142 }
143
144 int dtls1_buffer_record(SSL *s, record_pqueue *queue, unsigned char *priority)
145 {
146     DTLS1_RECORD_DATA *rdata;
147     pitem *item;
148
149     /* Limit the size of the queue to prevent DOS attacks */
150     if (pqueue_size(queue->q) >= 100)
151         return 0;
152
153     rdata = OPENSSL_malloc(sizeof(*rdata));
154     item = pitem_new(priority, rdata);
155     if (rdata == NULL || item == NULL) {
156         OPENSSL_free(rdata);
157         pitem_free(item);
158         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
159         return -1;
160     }
161
162     rdata->packet = s->rlayer.packet;
163     rdata->packet_length = s->rlayer.packet_length;
164     memcpy(&(rdata->rbuf), &s->rlayer.rbuf, sizeof(SSL3_BUFFER));
165     memcpy(&(rdata->rrec), &s->rlayer.rrec, sizeof(SSL3_RECORD));
166
167     item->data = rdata;
168
169 #ifndef OPENSSL_NO_SCTP
170     /* Store bio_dgram_sctp_rcvinfo struct */
171     if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
172         (SSL_get_state(s) == TLS_ST_SR_FINISHED
173          || SSL_get_state(s) == TLS_ST_CR_FINISHED)) {
174         BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_GET_RCVINFO,
175                  sizeof(rdata->recordinfo), &rdata->recordinfo);
176     }
177 #endif
178
179     s->rlayer.packet = NULL;
180     s->rlayer.packet_length = 0;
181     memset(&s->rlayer.rbuf, 0, sizeof(s->rlayer.rbuf));
182     memset(&s->rlayer.rrec, 0, sizeof(s->rlayer.rrec));
183
184     if (!ssl3_setup_buffers(s)) {
185         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
186         OPENSSL_free(rdata->rbuf.buf);
187         OPENSSL_free(rdata);
188         pitem_free(item);
189         return (-1);
190     }
191
192     /* insert should not fail, since duplicates are dropped */
193     if (pqueue_insert(queue->q, item) == NULL) {
194         SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
195         OPENSSL_free(rdata->rbuf.buf);
196         OPENSSL_free(rdata);
197         pitem_free(item);
198         return (-1);
199     }
200
201     return (1);
202 }
203
204 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
205 {
206     pitem *item;
207
208     item = pqueue_pop(queue->q);
209     if (item) {
210         dtls1_copy_record(s, item);
211
212         OPENSSL_free(item->data);
213         pitem_free(item);
214
215         return (1);
216     }
217
218     return (0);
219 }
220
221 /*
222  * retrieve a buffered record that belongs to the new epoch, i.e., not
223  * processed yet
224  */
225 #define dtls1_get_unprocessed_record(s) \
226                    dtls1_retrieve_buffered_record((s), \
227                    &((s)->rlayer.d->unprocessed_rcds))
228
229 int dtls1_process_buffered_records(SSL *s)
230 {
231     pitem *item;
232     SSL3_BUFFER *rb;
233     SSL3_RECORD *rr;
234     DTLS1_BITMAP *bitmap;
235     unsigned int is_next_epoch;
236     int replayok = 1;
237
238     item = pqueue_peek(s->rlayer.d->unprocessed_rcds.q);
239     if (item) {
240         /* Check if epoch is current. */
241         if (s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch)
242             return 1;         /* Nothing to do. */
243
244         rr = RECORD_LAYER_get_rrec(&s->rlayer);
245
246         rb = RECORD_LAYER_get_rbuf(&s->rlayer);
247
248         if (SSL3_BUFFER_get_left(rb) > 0) {
249             /*
250              * We've still got data from the current packet to read. There could
251              * be a record from the new epoch in it - so don't overwrite it
252              * with the unprocessed records yet (we'll do it when we've
253              * finished reading the current packet).
254              */
255             return 1;
256         }
257
258         /* Process all the records. */
259         while (pqueue_peek(s->rlayer.d->unprocessed_rcds.q)) {
260             dtls1_get_unprocessed_record(s);
261             bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
262             if (bitmap == NULL) {
263                 /*
264                  * Should not happen. This will only ever be NULL when the
265                  * current record is from a different epoch. But that cannot
266                  * be the case because we already checked the epoch above
267                  */
268                  SSLerr(SSL_F_DTLS1_PROCESS_BUFFERED_RECORDS,
269                         ERR_R_INTERNAL_ERROR);
270                  return 0;
271             }
272 #ifndef OPENSSL_NO_SCTP
273             /* Only do replay check if no SCTP bio */
274             if (!BIO_dgram_is_sctp(SSL_get_rbio(s)))
275 #endif
276             {
277                 /*
278                  * Check whether this is a repeat, or aged record. We did this
279                  * check once already when we first received the record - but
280                  * we might have updated the window since then due to
281                  * records we subsequently processed.
282                  */
283                 replayok = dtls1_record_replay_check(s, bitmap);
284             }
285
286             if (!replayok || !dtls1_process_record(s, bitmap)) {
287                 /* dump this record */
288                 rr->length = 0;
289                 RECORD_LAYER_reset_packet_length(&s->rlayer);
290                 continue;
291             }
292
293             if (dtls1_buffer_record(s, &(s->rlayer.d->processed_rcds),
294                     SSL3_RECORD_get_seq_num(s->rlayer.rrec)) < 0)
295                 return 0;
296         }
297     }
298
299     /*
300      * sync epoch numbers once all the unprocessed records have been
301      * processed
302      */
303     s->rlayer.d->processed_rcds.epoch = s->rlayer.d->r_epoch;
304     s->rlayer.d->unprocessed_rcds.epoch = s->rlayer.d->r_epoch + 1;
305
306     return 1;
307 }
308
309 /*-
310  * Return up to 'len' payload bytes received in 'type' records.
311  * 'type' is one of the following:
312  *
313  *   -  SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
314  *   -  SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
315  *   -  0 (during a shutdown, no data has to be returned)
316  *
317  * If we don't have stored data to work from, read a SSL/TLS record first
318  * (possibly multiple records if we still don't have anything to return).
319  *
320  * This function must handle any surprises the peer may have for us, such as
321  * Alert records (e.g. close_notify) or renegotiation requests. ChangeCipherSpec
322  * messages are treated as if they were handshake messages *if* the |recd_type|
323  * argument is non NULL.
324  * Also if record payloads contain fragments too small to process, we store
325  * them until there is enough for the respective protocol (the record protocol
326  * may use arbitrary fragmentation and even interleaving):
327  *     Change cipher spec protocol
328  *             just 1 byte needed, no need for keeping anything stored
329  *     Alert protocol
330  *             2 bytes needed (AlertLevel, AlertDescription)
331  *     Handshake protocol
332  *             4 bytes needed (HandshakeType, uint24 length) -- we just have
333  *             to detect unexpected Client Hello and Hello Request messages
334  *             here, anything else is handled by higher layers
335  *     Application data protocol
336  *             none of our business
337  */
338 int dtls1_read_bytes(SSL *s, int type, int *recvd_type, unsigned char *buf,
339                      size_t len, int peek, size_t *readbytes)
340 {
341     int al, i, j, iret;
342     size_t ret, n;
343     SSL3_RECORD *rr;
344     void (*cb) (const SSL *ssl, int type2, int val) = NULL;
345
346     if (!SSL3_BUFFER_is_initialised(&s->rlayer.rbuf)) {
347         /* Not initialized yet */
348         if (!ssl3_setup_buffers(s))
349             return (-1);
350     }
351
352     if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
353          (type != SSL3_RT_HANDSHAKE)) ||
354         (peek && (type != SSL3_RT_APPLICATION_DATA))) {
355         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
356         return -1;
357     }
358
359     /*
360      * check whether there's a handshake message (client hello?) waiting
361      */
362     ret = have_handshake_fragment(s, type, buf, len);
363     if (ret > 0) {
364         *recvd_type = SSL3_RT_HANDSHAKE;
365         *readbytes = ret;
366         return 1;
367     }
368
369     /*
370      * Now s->rlayer.d->handshake_fragment_len == 0 if
371      * type == SSL3_RT_HANDSHAKE.
372      */
373
374 #ifndef OPENSSL_NO_SCTP
375     /*
376      * Continue handshake if it had to be interrupted to read app data with
377      * SCTP.
378      */
379     if ((!ossl_statem_get_in_handshake(s) && SSL_in_init(s)) ||
380         (BIO_dgram_is_sctp(SSL_get_rbio(s))
381          && ossl_statem_in_sctp_read_sock(s)
382          && s->s3->in_read_app_data != 2))
383 #else
384     if (!ossl_statem_get_in_handshake(s) && SSL_in_init(s))
385 #endif
386     {
387         /* type == SSL3_RT_APPLICATION_DATA */
388         i = s->handshake_func(s);
389         if (i < 0)
390             return i;
391         if (i == 0) {
392             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
393             return -1;
394         }
395     }
396
397  start:
398     s->rwstate = SSL_NOTHING;
399
400     /*-
401      * s->s3->rrec.type         - is the type of record
402      * s->s3->rrec.data,    - data
403      * s->s3->rrec.off,     - offset into 'data' for next read
404      * s->s3->rrec.length,  - number of bytes.
405      */
406     rr = s->rlayer.rrec;
407
408     /*
409      * We are not handshaking and have no data yet, so process data buffered
410      * during the last handshake in advance, if any.
411      */
412     if (SSL_is_init_finished(s) && SSL3_RECORD_get_length(rr) == 0) {
413         pitem *item;
414         item = pqueue_pop(s->rlayer.d->buffered_app_data.q);
415         if (item) {
416 #ifndef OPENSSL_NO_SCTP
417             /* Restore bio_dgram_sctp_rcvinfo struct */
418             if (BIO_dgram_is_sctp(SSL_get_rbio(s))) {
419                 DTLS1_RECORD_DATA *rdata = (DTLS1_RECORD_DATA *)item->data;
420                 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_SET_RCVINFO,
421                          sizeof(rdata->recordinfo), &rdata->recordinfo);
422             }
423 #endif
424
425             dtls1_copy_record(s, item);
426
427             OPENSSL_free(item->data);
428             pitem_free(item);
429         }
430     }
431
432     /* Check for timeout */
433     if (dtls1_handle_timeout(s) > 0)
434         goto start;
435
436     /* get new packet if necessary */
437     if ((SSL3_RECORD_get_length(rr) == 0)
438         || (s->rlayer.rstate == SSL_ST_READ_BODY)) {
439         iret = dtls1_get_record(s);
440         if (iret <= 0) {
441             iret = dtls1_read_failed(s, iret);
442             /* anything other than a timeout is an error */
443             if (iret <= 0)
444                 return iret;
445             else
446                 goto start;
447         }
448     }
449
450     /*
451      * Reset the count of consecutive warning alerts if we've got a non-empty
452      * record that isn't an alert.
453      */
454     if (SSL3_RECORD_get_type(rr) != SSL3_RT_ALERT
455             && SSL3_RECORD_get_length(rr) != 0)
456         s->rlayer.alert_count = 0;
457
458     /* we now have a packet which can be read and processed */
459
460     if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
461                                    * reset by ssl3_get_finished */
462         && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
463         /*
464          * We now have application data between CCS and Finished. Most likely
465          * the packets were reordered on their way, so buffer the application
466          * data for later processing rather than dropping the connection.
467          */
468         if (dtls1_buffer_record(s, &(s->rlayer.d->buffered_app_data),
469                                 SSL3_RECORD_get_seq_num(rr)) < 0) {
470             SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
471             return -1;
472         }
473         SSL3_RECORD_set_length(rr, 0);
474         goto start;
475     }
476
477     /*
478      * If the other end has shut down, throw anything we read away (even in
479      * 'peek' mode)
480      */
481     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
482         SSL3_RECORD_set_length(rr, 0);
483         s->rwstate = SSL_NOTHING;
484         return 0;
485     }
486
487     if (type == SSL3_RECORD_get_type(rr)
488         || (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
489             && type == SSL3_RT_HANDSHAKE && recvd_type != NULL)) {
490         /*
491          * SSL3_RT_APPLICATION_DATA or
492          * SSL3_RT_HANDSHAKE or
493          * SSL3_RT_CHANGE_CIPHER_SPEC
494          */
495         /*
496          * make sure that we are not getting application data when we are
497          * doing a handshake for the first time
498          */
499         if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
500             (s->enc_read_ctx == NULL)) {
501             al = SSL_AD_UNEXPECTED_MESSAGE;
502             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
503             goto f_err;
504         }
505
506         if (recvd_type != NULL)
507             *recvd_type = SSL3_RECORD_get_type(rr);
508
509         if (len == 0)
510             return 0;
511
512         if (len > SSL3_RECORD_get_length(rr))
513             n = SSL3_RECORD_get_length(rr);
514         else
515             n = len;
516
517         memcpy(buf, &(SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)]), n);
518         if (!peek) {
519             SSL3_RECORD_sub_length(rr, n);
520             SSL3_RECORD_add_off(rr, n);
521             if (SSL3_RECORD_get_length(rr) == 0) {
522                 s->rlayer.rstate = SSL_ST_READ_HEADER;
523                 SSL3_RECORD_set_off(rr, 0);
524             }
525         }
526 #ifndef OPENSSL_NO_SCTP
527         /*
528          * We were about to renegotiate but had to read belated application
529          * data first, so retry.
530          */
531         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
532             SSL3_RECORD_get_type(rr) == SSL3_RT_APPLICATION_DATA &&
533             ossl_statem_in_sctp_read_sock(s)) {
534             s->rwstate = SSL_READING;
535             BIO_clear_retry_flags(SSL_get_rbio(s));
536             BIO_set_retry_read(SSL_get_rbio(s));
537         }
538
539         /*
540          * We might had to delay a close_notify alert because of reordered
541          * app data. If there was an alert and there is no message to read
542          * anymore, finally set shutdown.
543          */
544         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
545             s->d1->shutdown_received
546             && !BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
547             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
548             return 0;
549         }
550 #endif
551         *readbytes = n;
552         return 1;
553     }
554
555     /*
556      * If we get here, then type != rr->type; if we have a handshake message,
557      * then it was unexpected (Hello Request or Client Hello).
558      */
559
560     /*
561      * In case of record types for which we have 'fragment' storage, fill
562      * that so that we can process the data at a fixed place.
563      */
564     {
565         size_t k, dest_maxlen = 0;
566         unsigned char *dest = NULL;
567         size_t *dest_len = NULL;
568
569         if (SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) {
570             dest_maxlen = sizeof s->rlayer.d->handshake_fragment;
571             dest = s->rlayer.d->handshake_fragment;
572             dest_len = &s->rlayer.d->handshake_fragment_len;
573         } else if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
574             dest_maxlen = sizeof(s->rlayer.d->alert_fragment);
575             dest = s->rlayer.d->alert_fragment;
576             dest_len = &s->rlayer.d->alert_fragment_len;
577         }
578 #ifndef OPENSSL_NO_HEARTBEATS
579         else if (SSL3_RECORD_get_type(rr) == DTLS1_RT_HEARTBEAT) {
580             /* We allow a 0 return */
581             if (dtls1_process_heartbeat(s, SSL3_RECORD_get_data(rr),
582                                         SSL3_RECORD_get_length(rr)) < 0) {
583                 return -1;
584             }
585             /* Exit and notify application to read again */
586             SSL3_RECORD_set_length(rr, 0);
587             s->rwstate = SSL_READING;
588             BIO_clear_retry_flags(SSL_get_rbio(s));
589             BIO_set_retry_read(SSL_get_rbio(s));
590             return -1;
591         }
592 #endif
593         /* else it's a CCS message, or application data or wrong */
594         else if (SSL3_RECORD_get_type(rr) != SSL3_RT_CHANGE_CIPHER_SPEC) {
595             /*
596              * Application data while renegotiating is allowed. Try again
597              * reading.
598              */
599             if (SSL3_RECORD_get_type(rr) == SSL3_RT_APPLICATION_DATA) {
600                 BIO *bio;
601                 s->s3->in_read_app_data = 2;
602                 bio = SSL_get_rbio(s);
603                 s->rwstate = SSL_READING;
604                 BIO_clear_retry_flags(bio);
605                 BIO_set_retry_read(bio);
606                 return -1;
607             }
608
609             /* Not certain if this is the right error handling */
610             al = SSL_AD_UNEXPECTED_MESSAGE;
611             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
612             goto f_err;
613         }
614
615         if (dest_maxlen > 0) {
616             /*
617              * XDTLS: In a pathological case, the Client Hello may be
618              * fragmented--don't always expect dest_maxlen bytes
619              */
620             if (SSL3_RECORD_get_length(rr) < dest_maxlen) {
621 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
622                 /*
623                  * for normal alerts rr->length is 2, while
624                  * dest_maxlen is 7 if we were to handle this
625                  * non-existing alert...
626                  */
627                 FIX ME;
628 #endif
629                 s->rlayer.rstate = SSL_ST_READ_HEADER;
630                 SSL3_RECORD_set_length(rr, 0);
631                 goto start;
632             }
633
634             /* now move 'n' bytes: */
635             for (k = 0; k < dest_maxlen; k++) {
636                 dest[k] = SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)];
637                 SSL3_RECORD_add_off(rr, 1);
638                 SSL3_RECORD_add_length(rr, -1);
639             }
640             *dest_len = dest_maxlen;
641         }
642     }
643
644     /*-
645      * s->rlayer.d->handshake_fragment_len == 12  iff  rr->type == SSL3_RT_HANDSHAKE;
646      * s->rlayer.d->alert_fragment_len == 7      iff  rr->type == SSL3_RT_ALERT.
647      * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
648      */
649
650     /* If we are a client, check for an incoming 'Hello Request': */
651     if ((!s->server) &&
652         (s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
653         (s->rlayer.d->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
654         (s->session != NULL) && (s->session->cipher != NULL)) {
655         s->rlayer.d->handshake_fragment_len = 0;
656
657         if ((s->rlayer.d->handshake_fragment[1] != 0) ||
658             (s->rlayer.d->handshake_fragment[2] != 0) ||
659             (s->rlayer.d->handshake_fragment[3] != 0)) {
660             al = SSL_AD_DECODE_ERROR;
661             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
662             goto f_err;
663         }
664
665         /*
666          * no need to check sequence number on HELLO REQUEST messages
667          */
668
669         if (s->msg_callback)
670             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
671                             s->rlayer.d->handshake_fragment, 4, s,
672                             s->msg_callback_arg);
673
674         if (SSL_is_init_finished(s) &&
675             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
676             !s->s3->renegotiate) {
677             s->d1->handshake_read_seq++;
678             s->new_session = 1;
679             ssl3_renegotiate(s);
680             if (ssl3_renegotiate_check(s)) {
681                 i = s->handshake_func(s);
682                 if (i < 0)
683                     return i;
684                 if (i == 0) {
685                     SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
686                     return -1;
687                 }
688
689                 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
690                     if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
691                         /* no read-ahead left? */
692                         BIO *bio;
693                         /*
694                          * In the case where we try to read application data,
695                          * but we trigger an SSL handshake, we return -1 with
696                          * the retry option set.  Otherwise renegotiation may
697                          * cause nasty problems in the blocking world
698                          */
699                         s->rwstate = SSL_READING;
700                         bio = SSL_get_rbio(s);
701                         BIO_clear_retry_flags(bio);
702                         BIO_set_retry_read(bio);
703                         return -1;
704                     }
705                 }
706             }
707         }
708         /*
709          * we either finished a handshake or ignored the request, now try
710          * again to obtain the (application) data we were asked for
711          */
712         goto start;
713     }
714
715     if (s->rlayer.d->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH) {
716         int alert_level = s->rlayer.d->alert_fragment[0];
717         int alert_descr = s->rlayer.d->alert_fragment[1];
718
719         s->rlayer.d->alert_fragment_len = 0;
720
721         if (s->msg_callback)
722             s->msg_callback(0, s->version, SSL3_RT_ALERT,
723                             s->rlayer.d->alert_fragment, 2, s,
724                             s->msg_callback_arg);
725
726         if (s->info_callback != NULL)
727             cb = s->info_callback;
728         else if (s->ctx->info_callback != NULL)
729             cb = s->ctx->info_callback;
730
731         if (cb != NULL) {
732             j = (alert_level << 8) | alert_descr;
733             cb(s, SSL_CB_READ_ALERT, j);
734         }
735
736         if (alert_level == SSL3_AL_WARNING) {
737             s->s3->warn_alert = alert_descr;
738
739             s->rlayer.alert_count++;
740             if (s->rlayer.alert_count == MAX_WARN_ALERT_COUNT) {
741                 al = SSL_AD_UNEXPECTED_MESSAGE;
742                 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_TOO_MANY_WARN_ALERTS);
743                 goto f_err;
744             }
745
746             if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
747 #ifndef OPENSSL_NO_SCTP
748                 /*
749                  * With SCTP and streams the socket may deliver app data
750                  * after a close_notify alert. We have to check this first so
751                  * that nothing gets discarded.
752                  */
753                 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
754                     BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
755                     s->d1->shutdown_received = 1;
756                     s->rwstate = SSL_READING;
757                     BIO_clear_retry_flags(SSL_get_rbio(s));
758                     BIO_set_retry_read(SSL_get_rbio(s));
759                     return -1;
760                 }
761 #endif
762                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
763                 return 0;
764             }
765 #if 0
766             /* XXX: this is a possible improvement in the future */
767             /* now check if it's a missing record */
768             if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE) {
769                 unsigned short seq;
770                 unsigned int frag_off;
771                 unsigned char *p = &(s->rlayer.d->alert_fragment[2]);
772
773                 n2s(p, seq);
774                 n2l3(p, frag_off);
775
776                 dtls1_retransmit_message(s,
777                                          dtls1_get_queue_priority
778                                          (frag->msg_header.seq, 0), frag_off,
779                                          &found);
780                 if (!found && SSL_in_init(s)) {
781                     /*
782                      * fprintf( stderr,"in init = %d\n", SSL_in_init(s));
783                      */
784                     /*
785                      * requested a message not yet sent, send an alert
786                      * ourselves
787                      */
788                     ssl3_send_alert(s, SSL3_AL_WARNING,
789                                     DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
790                 }
791             }
792 #endif
793         } else if (alert_level == SSL3_AL_FATAL) {
794             char tmp[16];
795
796             s->rwstate = SSL_NOTHING;
797             s->s3->fatal_alert = alert_descr;
798             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
799             BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
800             ERR_add_error_data(2, "SSL alert number ", tmp);
801             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
802             SSL_CTX_remove_session(s->session_ctx, s->session);
803             return 0;
804         } else {
805             al = SSL_AD_ILLEGAL_PARAMETER;
806             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
807             goto f_err;
808         }
809
810         goto start;
811     }
812
813     if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
814                                             * shutdown */
815         s->rwstate = SSL_NOTHING;
816         SSL3_RECORD_set_length(rr, 0);
817         return 0;
818     }
819
820     if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
821         /*
822          * We can't process a CCS now, because previous handshake messages
823          * are still missing, so just drop it.
824          */
825         SSL3_RECORD_set_length(rr, 0);
826         goto start;
827     }
828
829     /*
830      * Unexpected handshake message (Client Hello, or protocol violation)
831      */
832     if ((s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
833         !ossl_statem_get_in_handshake(s)) {
834         struct hm_header_st msg_hdr;
835
836         /* this may just be a stale retransmit */
837         dtls1_get_message_header(rr->data, &msg_hdr);
838         if (SSL3_RECORD_get_epoch(rr) != s->rlayer.d->r_epoch) {
839             SSL3_RECORD_set_length(rr, 0);
840             goto start;
841         }
842
843         /*
844          * If we are server, we may have a repeated FINISHED of the client
845          * here, then retransmit our CCS and FINISHED.
846          */
847         if (msg_hdr.type == SSL3_MT_FINISHED) {
848             if (dtls1_check_timeout_num(s) < 0)
849                 return -1;
850
851             dtls1_retransmit_buffered_messages(s);
852             SSL3_RECORD_set_length(rr, 0);
853             goto start;
854         }
855
856         if (SSL_is_init_finished(s) &&
857             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
858             ossl_statem_set_in_init(s, 1);
859             s->renegotiate = 1;
860             s->new_session = 1;
861         }
862         i = s->handshake_func(s);
863         if (i < 0)
864             return i;
865         if (i == 0) {
866             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
867             return -1;
868         }
869
870         if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
871             if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
872                 /* no read-ahead left? */
873                 BIO *bio;
874                 /*
875                  * In the case where we try to read application data, but we
876                  * trigger an SSL handshake, we return -1 with the retry
877                  * option set.  Otherwise renegotiation may cause nasty
878                  * problems in the blocking world
879                  */
880                 s->rwstate = SSL_READING;
881                 bio = SSL_get_rbio(s);
882                 BIO_clear_retry_flags(bio);
883                 BIO_set_retry_read(bio);
884                 return -1;
885             }
886         }
887         goto start;
888     }
889
890     switch (SSL3_RECORD_get_type(rr)) {
891     default:
892         /* TLS just ignores unknown message types */
893         if (s->version == TLS1_VERSION) {
894             SSL3_RECORD_set_length(rr, 0);
895             goto start;
896         }
897         al = SSL_AD_UNEXPECTED_MESSAGE;
898         SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
899         goto f_err;
900     case SSL3_RT_CHANGE_CIPHER_SPEC:
901     case SSL3_RT_ALERT:
902     case SSL3_RT_HANDSHAKE:
903         /*
904          * we already handled all of these, with the possible exception of
905          * SSL3_RT_HANDSHAKE when ossl_statem_get_in_handshake(s) is true, but
906          * that should not happen when type != rr->type
907          */
908         al = SSL_AD_UNEXPECTED_MESSAGE;
909         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
910         goto f_err;
911     case SSL3_RT_APPLICATION_DATA:
912         /*
913          * At this point, we were expecting handshake data, but have
914          * application data.  If the library was running inside ssl3_read()
915          * (i.e. in_read_app_data is set) and it makes sense to read
916          * application data at this point (session renegotiation not yet
917          * started), we will indulge it.
918          */
919         if (s->s3->in_read_app_data &&
920             (s->s3->total_renegotiations != 0) &&
921             ossl_statem_app_data_allowed(s)) {
922             s->s3->in_read_app_data = 2;
923             return -1;
924         } else {
925             al = SSL_AD_UNEXPECTED_MESSAGE;
926             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
927             goto f_err;
928         }
929     }
930     /* not reached */
931
932  f_err:
933     ssl3_send_alert(s, SSL3_AL_FATAL, al);
934     return -1;
935 }
936
937 /*
938  * this only happens when a client hello is received and a handshake
939  * is started.
940  */
941 static size_t have_handshake_fragment(SSL *s, int type, unsigned char *buf,
942                                       size_t len)
943 {
944
945     if ((type == SSL3_RT_HANDSHAKE)
946         && (s->rlayer.d->handshake_fragment_len > 0))
947         /* (partially) satisfy request from storage */
948     {
949         unsigned char *src = s->rlayer.d->handshake_fragment;
950         unsigned char *dst = buf;
951         size_t k, n;
952
953         /* peek == 0 */
954         n = 0;
955         while ((len > 0) && (s->rlayer.d->handshake_fragment_len > 0)) {
956             *dst++ = *src++;
957             len--;
958             s->rlayer.d->handshake_fragment_len--;
959             n++;
960         }
961         /* move any remaining fragment bytes: */
962         for (k = 0; k < s->rlayer.d->handshake_fragment_len; k++)
963             s->rlayer.d->handshake_fragment[k] = *src++;
964         return n;
965     }
966
967     return 0;
968 }
969
970 /*
971  * Call this to write data in records of type 'type' It will return <= 0 if
972  * not all data has been sent or non-blocking IO.
973  */
974 int dtls1_write_bytes(SSL *s, int type, const void *buf, size_t len,
975                       size_t *written)
976 {
977     int i;
978
979     OPENSSL_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH);
980     s->rwstate = SSL_NOTHING;
981     i = do_dtls1_write(s, type, buf, len, 0, written);
982     return i;
983 }
984
985 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
986                    size_t len, int create_empty_fragment, size_t *written)
987 {
988     unsigned char *p, *pseq;
989     int i, mac_size, clear = 0;
990     size_t prefix_len = 0;
991     int eivlen;
992     SSL3_RECORD wr;
993     SSL3_BUFFER *wb;
994     SSL_SESSION *sess;
995
996     wb = &s->rlayer.wbuf[0];
997
998     /*
999      * first check if there is a SSL3_BUFFER still being written out.  This
1000      * will happen with non blocking IO
1001      */
1002     if (SSL3_BUFFER_get_left(wb) != 0) {
1003         OPENSSL_assert(0);      /* XDTLS: want to see if we ever get here */
1004         return ssl3_write_pending(s, type, buf, len, written);
1005     }
1006
1007     /* If we have an alert to send, lets send it */
1008     if (s->s3->alert_dispatch) {
1009         i = s->method->ssl_dispatch_alert(s);
1010         if (i <= 0)
1011             return i;
1012         /* if it went, fall through and send more stuff */
1013     }
1014
1015     if (len == 0 && !create_empty_fragment)
1016         return 0;
1017
1018     sess = s->session;
1019
1020     if ((sess == NULL) ||
1021         (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL))
1022         clear = 1;
1023
1024     if (clear)
1025         mac_size = 0;
1026     else {
1027         mac_size = EVP_MD_CTX_size(s->write_hash);
1028         if (mac_size < 0)
1029             goto err;
1030     }
1031
1032     p = SSL3_BUFFER_get_buf(wb) + prefix_len;
1033
1034     /* write the header */
1035
1036     *(p++) = type & 0xff;
1037     SSL3_RECORD_set_type(&wr, type);
1038     /*
1039      * Special case: for hello verify request, client version 1.0 and we
1040      * haven't decided which version to use yet send back using version 1.0
1041      * header: otherwise some clients will ignore it.
1042      */
1043     if (s->method->version == DTLS_ANY_VERSION &&
1044         s->max_proto_version != DTLS1_BAD_VER) {
1045         *(p++) = DTLS1_VERSION >> 8;
1046         *(p++) = DTLS1_VERSION & 0xff;
1047     } else {
1048         *(p++) = s->version >> 8;
1049         *(p++) = s->version & 0xff;
1050     }
1051
1052     /* field where we are to write out packet epoch, seq num and len */
1053     pseq = p;
1054     p += 10;
1055
1056     /* Explicit IV length, block ciphers appropriate version flag */
1057     if (s->enc_write_ctx) {
1058         int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
1059         if (mode == EVP_CIPH_CBC_MODE) {
1060             eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
1061             if (eivlen <= 1)
1062                 eivlen = 0;
1063         }
1064         /* Need explicit part of IV for GCM mode */
1065         else if (mode == EVP_CIPH_GCM_MODE)
1066             eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
1067         else if (mode == EVP_CIPH_CCM_MODE)
1068             eivlen = EVP_CCM_TLS_EXPLICIT_IV_LEN;
1069         else
1070             eivlen = 0;
1071     } else
1072         eivlen = 0;
1073
1074     /* lets setup the record stuff. */
1075     SSL3_RECORD_set_data(&wr, p + eivlen); /* make room for IV in case of CBC */
1076     SSL3_RECORD_set_length(&wr, len);
1077     SSL3_RECORD_set_input(&wr, (unsigned char *)buf);
1078
1079     /*
1080      * we now 'read' from wr.input, wr.length bytes into wr.data
1081      */
1082
1083     /* first we compress */
1084     if (s->compress != NULL) {
1085         if (!ssl3_do_compress(s, &wr)) {
1086             SSLerr(SSL_F_DO_DTLS1_WRITE, SSL_R_COMPRESSION_FAILURE);
1087             goto err;
1088         }
1089     } else {
1090         memcpy(SSL3_RECORD_get_data(&wr), SSL3_RECORD_get_input(&wr),
1091                SSL3_RECORD_get_length(&wr));
1092         SSL3_RECORD_reset_input(&wr);
1093     }
1094
1095     /*
1096      * we should still have the output to wr.data and the input from
1097      * wr.input.  Length should be wr.length. wr.data still points in the
1098      * wb->buf
1099      */
1100
1101     if (!SSL_USE_ETM(s) && mac_size != 0) {
1102         if (!s->method->ssl3_enc->mac(s, &wr,
1103                                       &(p[SSL3_RECORD_get_length(&wr) + eivlen]),
1104                                       1))
1105             goto err;
1106         SSL3_RECORD_add_length(&wr, mac_size);
1107     }
1108
1109     /* this is true regardless of mac size */
1110     SSL3_RECORD_set_data(&wr, p);
1111     SSL3_RECORD_reset_input(&wr);
1112
1113     if (eivlen)
1114         SSL3_RECORD_add_length(&wr, eivlen);
1115
1116     if (s->method->ssl3_enc->enc(s, &wr, 1, 1) < 1)
1117         goto err;
1118
1119     if (SSL_USE_ETM(s) && mac_size != 0) {
1120         if (!s->method->ssl3_enc->mac(s, &wr,
1121                                       &(p[SSL3_RECORD_get_length(&wr)]), 1))
1122             goto err;
1123         SSL3_RECORD_add_length(&wr, mac_size);
1124     }
1125
1126     /* record length after mac and block padding */
1127     /*
1128      * if (type == SSL3_RT_APPLICATION_DATA || (type == SSL3_RT_ALERT && !
1129      * SSL_in_init(s)))
1130      */
1131
1132     /* there's only one epoch between handshake and app data */
1133
1134     s2n(s->rlayer.d->w_epoch, pseq);
1135
1136     /* XDTLS: ?? */
1137     /*
1138      * else s2n(s->d1->handshake_epoch, pseq);
1139      */
1140
1141     memcpy(pseq, &(s->rlayer.write_sequence[2]), 6);
1142     pseq += 6;
1143     s2n(SSL3_RECORD_get_length(&wr), pseq);
1144
1145     if (s->msg_callback)
1146         s->msg_callback(1, 0, SSL3_RT_HEADER, pseq - DTLS1_RT_HEADER_LENGTH,
1147                         DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
1148
1149     /*
1150      * we should now have wr.data pointing to the encrypted data, which is
1151      * wr->length long
1152      */
1153     SSL3_RECORD_set_type(&wr, type); /* not needed but helps for debugging */
1154     SSL3_RECORD_add_length(&wr, DTLS1_RT_HEADER_LENGTH);
1155
1156     ssl3_record_sequence_update(&(s->rlayer.write_sequence[0]));
1157
1158     if (create_empty_fragment) {
1159         /*
1160          * we are in a recursive call; just return the length, don't write
1161          * out anything here
1162          */
1163         *written = wr.length;
1164         return 1;
1165     }
1166
1167     /* now let's set up wb */
1168     SSL3_BUFFER_set_left(wb, prefix_len + SSL3_RECORD_get_length(&wr));
1169     SSL3_BUFFER_set_offset(wb, 0);
1170
1171     /*
1172      * memorize arguments so that ssl3_write_pending can detect bad write
1173      * retries later
1174      */
1175     s->rlayer.wpend_tot = len;
1176     s->rlayer.wpend_buf = buf;
1177     s->rlayer.wpend_type = type;
1178     s->rlayer.wpend_ret = len;
1179
1180     /* we now just need to write the buffer */
1181     return ssl3_write_pending(s, type, buf, len, written);
1182  err:
1183     return -1;
1184 }
1185
1186 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
1187                                unsigned int *is_next_epoch)
1188 {
1189
1190     *is_next_epoch = 0;
1191
1192     /* In current epoch, accept HM, CCS, DATA, & ALERT */
1193     if (rr->epoch == s->rlayer.d->r_epoch)
1194         return &s->rlayer.d->bitmap;
1195
1196     /*
1197      * Only HM and ALERT messages can be from the next epoch and only if we
1198      * have already processed all of the unprocessed records from the last
1199      * epoch
1200      */
1201     else if (rr->epoch == (unsigned long)(s->rlayer.d->r_epoch + 1) &&
1202              s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch &&
1203              (rr->type == SSL3_RT_HANDSHAKE || rr->type == SSL3_RT_ALERT)) {
1204         *is_next_epoch = 1;
1205         return &s->rlayer.d->next_bitmap;
1206     }
1207
1208     return NULL;
1209 }
1210
1211 void dtls1_reset_seq_numbers(SSL *s, int rw)
1212 {
1213     unsigned char *seq;
1214     unsigned int seq_bytes = sizeof(s->rlayer.read_sequence);
1215
1216     if (rw & SSL3_CC_READ) {
1217         seq = s->rlayer.read_sequence;
1218         s->rlayer.d->r_epoch++;
1219         memcpy(&s->rlayer.d->bitmap, &s->rlayer.d->next_bitmap,
1220                sizeof(s->rlayer.d->bitmap));
1221         memset(&s->rlayer.d->next_bitmap, 0, sizeof(s->rlayer.d->next_bitmap));
1222
1223         /*
1224          * We must not use any buffered messages received from the previous
1225          * epoch
1226          */
1227         dtls1_clear_received_buffer(s);
1228     } else {
1229         seq = s->rlayer.write_sequence;
1230         memcpy(s->rlayer.d->last_write_sequence, seq,
1231                sizeof(s->rlayer.write_sequence));
1232         s->rlayer.d->w_epoch++;
1233     }
1234
1235     memset(seq, 0, seq_bytes);
1236 }