be6aac719f7ebeac96c257f32dd828141271e15f
[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 int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
122                                    int 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                      int len, int peek)
340 {
341     int al, i, j, ret;
342     unsigned int 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     if ((ret = have_handshake_fragment(s, type, buf, len)))
363         return ret;
364
365     /*
366      * Now s->rlayer.d->handshake_fragment_len == 0 if
367      * type == SSL3_RT_HANDSHAKE.
368      */
369
370 #ifndef OPENSSL_NO_SCTP
371     /*
372      * Continue handshake if it had to be interrupted to read app data with
373      * SCTP.
374      */
375     if ((!ossl_statem_get_in_handshake(s) && SSL_in_init(s)) ||
376         (BIO_dgram_is_sctp(SSL_get_rbio(s))
377          && ossl_statem_in_sctp_read_sock(s)
378          && s->s3->in_read_app_data != 2))
379 #else
380     if (!ossl_statem_get_in_handshake(s) && SSL_in_init(s))
381 #endif
382     {
383         /* type == SSL3_RT_APPLICATION_DATA */
384         i = s->handshake_func(s);
385         if (i < 0)
386             return (i);
387         if (i == 0) {
388             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
389             return (-1);
390         }
391     }
392
393  start:
394     s->rwstate = SSL_NOTHING;
395
396     /*-
397      * s->s3->rrec.type         - is the type of record
398      * s->s3->rrec.data,    - data
399      * s->s3->rrec.off,     - offset into 'data' for next read
400      * s->s3->rrec.length,  - number of bytes.
401      */
402     rr = s->rlayer.rrec;
403
404     /*
405      * We are not handshaking and have no data yet, so process data buffered
406      * during the last handshake in advance, if any.
407      */
408     if (SSL_is_init_finished(s) && SSL3_RECORD_get_length(rr) == 0) {
409         pitem *item;
410         item = pqueue_pop(s->rlayer.d->buffered_app_data.q);
411         if (item) {
412 #ifndef OPENSSL_NO_SCTP
413             /* Restore bio_dgram_sctp_rcvinfo struct */
414             if (BIO_dgram_is_sctp(SSL_get_rbio(s))) {
415                 DTLS1_RECORD_DATA *rdata = (DTLS1_RECORD_DATA *)item->data;
416                 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_SET_RCVINFO,
417                          sizeof(rdata->recordinfo), &rdata->recordinfo);
418             }
419 #endif
420
421             dtls1_copy_record(s, item);
422
423             OPENSSL_free(item->data);
424             pitem_free(item);
425         }
426     }
427
428     /* Check for timeout */
429     if (dtls1_handle_timeout(s) > 0)
430         goto start;
431
432     /* get new packet if necessary */
433     if ((SSL3_RECORD_get_length(rr) == 0)
434         || (s->rlayer.rstate == SSL_ST_READ_BODY)) {
435         ret = dtls1_get_record(s);
436         if (ret <= 0) {
437             ret = dtls1_read_failed(s, ret);
438             /* anything other than a timeout is an error */
439             if (ret <= 0)
440                 return (ret);
441             else
442                 goto start;
443         }
444     }
445
446     /* we now have a packet which can be read and processed */
447
448     if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
449                                    * reset by ssl3_get_finished */
450         && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
451         /*
452          * We now have application data between CCS and Finished. Most likely
453          * the packets were reordered on their way, so buffer the application
454          * data for later processing rather than dropping the connection.
455          */
456         if (dtls1_buffer_record(s, &(s->rlayer.d->buffered_app_data),
457                                 SSL3_RECORD_get_seq_num(rr)) < 0) {
458             SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
459             return -1;
460         }
461         SSL3_RECORD_set_length(rr, 0);
462         goto start;
463     }
464
465     /*
466      * If the other end has shut down, throw anything we read away (even in
467      * 'peek' mode)
468      */
469     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
470         SSL3_RECORD_set_length(rr, 0);
471         s->rwstate = SSL_NOTHING;
472         return (0);
473     }
474
475     if (type == SSL3_RECORD_get_type(rr)
476         || (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
477             && type == SSL3_RT_HANDSHAKE && recvd_type != NULL)) {
478         /*
479          * SSL3_RT_APPLICATION_DATA or
480          * SSL3_RT_HANDSHAKE or
481          * SSL3_RT_CHANGE_CIPHER_SPEC
482          */
483         /*
484          * make sure that we are not getting application data when we are
485          * doing a handshake for the first time
486          */
487         if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
488             (s->enc_read_ctx == NULL)) {
489             al = SSL_AD_UNEXPECTED_MESSAGE;
490             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
491             goto f_err;
492         }
493
494         if (recvd_type != NULL)
495             *recvd_type = SSL3_RECORD_get_type(rr);
496
497         if (len <= 0)
498             return (len);
499
500         if ((unsigned int)len > SSL3_RECORD_get_length(rr))
501             n = SSL3_RECORD_get_length(rr);
502         else
503             n = (unsigned int)len;
504
505         memcpy(buf, &(SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)]), n);
506         if (!peek) {
507             SSL3_RECORD_sub_length(rr, n);
508             SSL3_RECORD_add_off(rr, n);
509             if (SSL3_RECORD_get_length(rr) == 0) {
510                 s->rlayer.rstate = SSL_ST_READ_HEADER;
511                 SSL3_RECORD_set_off(rr, 0);
512             }
513         }
514 #ifndef OPENSSL_NO_SCTP
515         /*
516          * We were about to renegotiate but had to read belated application
517          * data first, so retry.
518          */
519         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
520             SSL3_RECORD_get_type(rr) == SSL3_RT_APPLICATION_DATA &&
521             ossl_statem_in_sctp_read_sock(s)) {
522             s->rwstate = SSL_READING;
523             BIO_clear_retry_flags(SSL_get_rbio(s));
524             BIO_set_retry_read(SSL_get_rbio(s));
525         }
526
527         /*
528          * We might had to delay a close_notify alert because of reordered
529          * app data. If there was an alert and there is no message to read
530          * anymore, finally set shutdown.
531          */
532         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
533             s->d1->shutdown_received
534             && !BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
535             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
536             return (0);
537         }
538 #endif
539         return (n);
540     }
541
542     /*
543      * If we get here, then type != rr->type; if we have a handshake message,
544      * then it was unexpected (Hello Request or Client Hello).
545      */
546
547     /*
548      * In case of record types for which we have 'fragment' storage, fill
549      * that so that we can process the data at a fixed place.
550      */
551     {
552         unsigned int k, dest_maxlen = 0;
553         unsigned char *dest = NULL;
554         unsigned int *dest_len = NULL;
555
556         if (SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) {
557             dest_maxlen = sizeof s->rlayer.d->handshake_fragment;
558             dest = s->rlayer.d->handshake_fragment;
559             dest_len = &s->rlayer.d->handshake_fragment_len;
560         } else if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
561             dest_maxlen = sizeof(s->rlayer.d->alert_fragment);
562             dest = s->rlayer.d->alert_fragment;
563             dest_len = &s->rlayer.d->alert_fragment_len;
564         }
565 #ifndef OPENSSL_NO_HEARTBEATS
566         else if (SSL3_RECORD_get_type(rr) == DTLS1_RT_HEARTBEAT) {
567             /* We allow a 0 return */
568             if (dtls1_process_heartbeat(s, SSL3_RECORD_get_data(rr),
569                                         SSL3_RECORD_get_length(rr)) < 0) {
570                 return -1;
571             }
572             /* Exit and notify application to read again */
573             SSL3_RECORD_set_length(rr, 0);
574             s->rwstate = SSL_READING;
575             BIO_clear_retry_flags(SSL_get_rbio(s));
576             BIO_set_retry_read(SSL_get_rbio(s));
577             return (-1);
578         }
579 #endif
580         /* else it's a CCS message, or application data or wrong */
581         else if (SSL3_RECORD_get_type(rr) != SSL3_RT_CHANGE_CIPHER_SPEC) {
582             /*
583              * Application data while renegotiating is allowed. Try again
584              * reading.
585              */
586             if (SSL3_RECORD_get_type(rr) == SSL3_RT_APPLICATION_DATA) {
587                 BIO *bio;
588                 s->s3->in_read_app_data = 2;
589                 bio = SSL_get_rbio(s);
590                 s->rwstate = SSL_READING;
591                 BIO_clear_retry_flags(bio);
592                 BIO_set_retry_read(bio);
593                 return (-1);
594             }
595
596             /* Not certain if this is the right error handling */
597             al = SSL_AD_UNEXPECTED_MESSAGE;
598             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
599             goto f_err;
600         }
601
602         if (dest_maxlen > 0) {
603             /*
604              * XDTLS: In a pathological case, the Client Hello may be
605              * fragmented--don't always expect dest_maxlen bytes
606              */
607             if (SSL3_RECORD_get_length(rr) < dest_maxlen) {
608 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
609                 /*
610                  * for normal alerts rr->length is 2, while
611                  * dest_maxlen is 7 if we were to handle this
612                  * non-existing alert...
613                  */
614                 FIX ME;
615 #endif
616                 s->rlayer.rstate = SSL_ST_READ_HEADER;
617                 SSL3_RECORD_set_length(rr, 0);
618                 goto start;
619             }
620
621             /* now move 'n' bytes: */
622             for (k = 0; k < dest_maxlen; k++) {
623                 dest[k] = SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)];
624                 SSL3_RECORD_add_off(rr, 1);
625                 SSL3_RECORD_add_length(rr, -1);
626             }
627             *dest_len = dest_maxlen;
628         }
629     }
630
631     /*-
632      * s->rlayer.d->handshake_fragment_len == 12  iff  rr->type == SSL3_RT_HANDSHAKE;
633      * s->rlayer.d->alert_fragment_len == 7      iff  rr->type == SSL3_RT_ALERT.
634      * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
635      */
636
637     /* If we are a client, check for an incoming 'Hello Request': */
638     if ((!s->server) &&
639         (s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
640         (s->rlayer.d->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
641         (s->session != NULL) && (s->session->cipher != NULL)) {
642         s->rlayer.d->handshake_fragment_len = 0;
643
644         if ((s->rlayer.d->handshake_fragment[1] != 0) ||
645             (s->rlayer.d->handshake_fragment[2] != 0) ||
646             (s->rlayer.d->handshake_fragment[3] != 0)) {
647             al = SSL_AD_DECODE_ERROR;
648             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
649             goto f_err;
650         }
651
652         /*
653          * no need to check sequence number on HELLO REQUEST messages
654          */
655
656         if (s->msg_callback)
657             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
658                             s->rlayer.d->handshake_fragment, 4, s,
659                             s->msg_callback_arg);
660
661         if (SSL_is_init_finished(s) &&
662             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
663             !s->s3->renegotiate) {
664             s->d1->handshake_read_seq++;
665             s->new_session = 1;
666             ssl3_renegotiate(s);
667             if (ssl3_renegotiate_check(s)) {
668                 i = s->handshake_func(s);
669                 if (i < 0)
670                     return (i);
671                 if (i == 0) {
672                     SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
673                     return (-1);
674                 }
675
676                 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
677                     if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
678                         /* no read-ahead left? */
679                         BIO *bio;
680                         /*
681                          * In the case where we try to read application data,
682                          * but we trigger an SSL handshake, we return -1 with
683                          * the retry option set.  Otherwise renegotiation may
684                          * cause nasty problems in the blocking world
685                          */
686                         s->rwstate = SSL_READING;
687                         bio = SSL_get_rbio(s);
688                         BIO_clear_retry_flags(bio);
689                         BIO_set_retry_read(bio);
690                         return (-1);
691                     }
692                 }
693             }
694         }
695         /*
696          * we either finished a handshake or ignored the request, now try
697          * again to obtain the (application) data we were asked for
698          */
699         goto start;
700     }
701
702     if (s->rlayer.d->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH) {
703         int alert_level = s->rlayer.d->alert_fragment[0];
704         int alert_descr = s->rlayer.d->alert_fragment[1];
705
706         s->rlayer.d->alert_fragment_len = 0;
707
708         if (s->msg_callback)
709             s->msg_callback(0, s->version, SSL3_RT_ALERT,
710                             s->rlayer.d->alert_fragment, 2, s,
711                             s->msg_callback_arg);
712
713         if (s->info_callback != NULL)
714             cb = s->info_callback;
715         else if (s->ctx->info_callback != NULL)
716             cb = s->ctx->info_callback;
717
718         if (cb != NULL) {
719             j = (alert_level << 8) | alert_descr;
720             cb(s, SSL_CB_READ_ALERT, j);
721         }
722
723         if (alert_level == SSL3_AL_WARNING) {
724             s->s3->warn_alert = alert_descr;
725             if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
726 #ifndef OPENSSL_NO_SCTP
727                 /*
728                  * With SCTP and streams the socket may deliver app data
729                  * after a close_notify alert. We have to check this first so
730                  * that nothing gets discarded.
731                  */
732                 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
733                     BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
734                     s->d1->shutdown_received = 1;
735                     s->rwstate = SSL_READING;
736                     BIO_clear_retry_flags(SSL_get_rbio(s));
737                     BIO_set_retry_read(SSL_get_rbio(s));
738                     return -1;
739                 }
740 #endif
741                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
742                 return (0);
743             }
744 #if 0
745             /* XXX: this is a possible improvement in the future */
746             /* now check if it's a missing record */
747             if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE) {
748                 unsigned short seq;
749                 unsigned int frag_off;
750                 unsigned char *p = &(s->rlayer.d->alert_fragment[2]);
751
752                 n2s(p, seq);
753                 n2l3(p, frag_off);
754
755                 dtls1_retransmit_message(s,
756                                          dtls1_get_queue_priority
757                                          (frag->msg_header.seq, 0), frag_off,
758                                          &found);
759                 if (!found && SSL_in_init(s)) {
760                     /*
761                      * fprintf( stderr,"in init = %d\n", SSL_in_init(s));
762                      */
763                     /*
764                      * requested a message not yet sent, send an alert
765                      * ourselves
766                      */
767                     ssl3_send_alert(s, SSL3_AL_WARNING,
768                                     DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
769                 }
770             }
771 #endif
772         } else if (alert_level == SSL3_AL_FATAL) {
773             char tmp[16];
774
775             s->rwstate = SSL_NOTHING;
776             s->s3->fatal_alert = alert_descr;
777             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
778             BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
779             ERR_add_error_data(2, "SSL alert number ", tmp);
780             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
781             SSL_CTX_remove_session(s->session_ctx, s->session);
782             return (0);
783         } else {
784             al = SSL_AD_ILLEGAL_PARAMETER;
785             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
786             goto f_err;
787         }
788
789         goto start;
790     }
791
792     if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
793                                             * shutdown */
794         s->rwstate = SSL_NOTHING;
795         SSL3_RECORD_set_length(rr, 0);
796         return (0);
797     }
798
799     if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
800         /*
801          * We can't process a CCS now, because previous handshake messages
802          * are still missing, so just drop it.
803          */
804         SSL3_RECORD_set_length(rr, 0);
805         goto start;
806     }
807
808     /*
809      * Unexpected handshake message (Client Hello, or protocol violation)
810      */
811     if ((s->rlayer.d->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
812         !ossl_statem_get_in_handshake(s)) {
813         struct hm_header_st msg_hdr;
814
815         /* this may just be a stale retransmit */
816         dtls1_get_message_header(rr->data, &msg_hdr);
817         if (SSL3_RECORD_get_epoch(rr) != s->rlayer.d->r_epoch) {
818             SSL3_RECORD_set_length(rr, 0);
819             goto start;
820         }
821
822         /*
823          * If we are server, we may have a repeated FINISHED of the client
824          * here, then retransmit our CCS and FINISHED.
825          */
826         if (msg_hdr.type == SSL3_MT_FINISHED) {
827             if (dtls1_check_timeout_num(s) < 0)
828                 return -1;
829
830             dtls1_retransmit_buffered_messages(s);
831             SSL3_RECORD_set_length(rr, 0);
832             goto start;
833         }
834
835         if (SSL_is_init_finished(s) &&
836             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
837             ossl_statem_set_in_init(s, 1);
838             s->renegotiate = 1;
839             s->new_session = 1;
840         }
841         i = s->handshake_func(s);
842         if (i < 0)
843             return (i);
844         if (i == 0) {
845             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
846             return (-1);
847         }
848
849         if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
850             if (SSL3_BUFFER_get_left(&s->rlayer.rbuf) == 0) {
851                 /* no read-ahead left? */
852                 BIO *bio;
853                 /*
854                  * In the case where we try to read application data, but we
855                  * trigger an SSL handshake, we return -1 with the retry
856                  * option set.  Otherwise renegotiation may cause nasty
857                  * problems in the blocking world
858                  */
859                 s->rwstate = SSL_READING;
860                 bio = SSL_get_rbio(s);
861                 BIO_clear_retry_flags(bio);
862                 BIO_set_retry_read(bio);
863                 return (-1);
864             }
865         }
866         goto start;
867     }
868
869     switch (SSL3_RECORD_get_type(rr)) {
870     default:
871         /* TLS just ignores unknown message types */
872         if (s->version == TLS1_VERSION) {
873             SSL3_RECORD_set_length(rr, 0);
874             goto start;
875         }
876         al = SSL_AD_UNEXPECTED_MESSAGE;
877         SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
878         goto f_err;
879     case SSL3_RT_CHANGE_CIPHER_SPEC:
880     case SSL3_RT_ALERT:
881     case SSL3_RT_HANDSHAKE:
882         /*
883          * we already handled all of these, with the possible exception of
884          * SSL3_RT_HANDSHAKE when ossl_statem_get_in_handshake(s) is true, but
885          * that should not happen when type != rr->type
886          */
887         al = SSL_AD_UNEXPECTED_MESSAGE;
888         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
889         goto f_err;
890     case SSL3_RT_APPLICATION_DATA:
891         /*
892          * At this point, we were expecting handshake data, but have
893          * application data.  If the library was running inside ssl3_read()
894          * (i.e. in_read_app_data is set) and it makes sense to read
895          * application data at this point (session renegotiation not yet
896          * started), we will indulge it.
897          */
898         if (s->s3->in_read_app_data &&
899             (s->s3->total_renegotiations != 0) &&
900             ossl_statem_app_data_allowed(s)) {
901             s->s3->in_read_app_data = 2;
902             return (-1);
903         } else {
904             al = SSL_AD_UNEXPECTED_MESSAGE;
905             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
906             goto f_err;
907         }
908     }
909     /* not reached */
910
911  f_err:
912     ssl3_send_alert(s, SSL3_AL_FATAL, al);
913     return (-1);
914 }
915
916         /*
917          * this only happens when a client hello is received and a handshake
918          * is started.
919          */
920 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
921                                    int len)
922 {
923
924     if ((type == SSL3_RT_HANDSHAKE)
925         && (s->rlayer.d->handshake_fragment_len > 0))
926         /* (partially) satisfy request from storage */
927     {
928         unsigned char *src = s->rlayer.d->handshake_fragment;
929         unsigned char *dst = buf;
930         unsigned int k, n;
931
932         /* peek == 0 */
933         n = 0;
934         while ((len > 0) && (s->rlayer.d->handshake_fragment_len > 0)) {
935             *dst++ = *src++;
936             len--;
937             s->rlayer.d->handshake_fragment_len--;
938             n++;
939         }
940         /* move any remaining fragment bytes: */
941         for (k = 0; k < s->rlayer.d->handshake_fragment_len; k++)
942             s->rlayer.d->handshake_fragment[k] = *src++;
943         return n;
944     }
945
946     return 0;
947 }
948
949 /*
950  * Call this to write data in records of type 'type' It will return <= 0 if
951  * not all data has been sent or non-blocking IO.
952  */
953 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len)
954 {
955     int i;
956
957     OPENSSL_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH);
958     s->rwstate = SSL_NOTHING;
959     i = do_dtls1_write(s, type, buf, len, 0);
960     return i;
961 }
962
963 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
964                    unsigned int len, int create_empty_fragment)
965 {
966     unsigned char *p, *pseq;
967     int i, mac_size, clear = 0;
968     int prefix_len = 0;
969     int eivlen;
970     SSL3_RECORD wr;
971     SSL3_BUFFER *wb;
972     SSL_SESSION *sess;
973
974     wb = &s->rlayer.wbuf[0];
975
976     /*
977      * first check if there is a SSL3_BUFFER still being written out.  This
978      * will happen with non blocking IO
979      */
980     if (SSL3_BUFFER_get_left(wb) != 0) {
981         OPENSSL_assert(0);      /* XDTLS: want to see if we ever get here */
982         return (ssl3_write_pending(s, type, buf, len));
983     }
984
985     /* If we have an alert to send, lets send it */
986     if (s->s3->alert_dispatch) {
987         i = s->method->ssl_dispatch_alert(s);
988         if (i <= 0)
989             return (i);
990         /* if it went, fall through and send more stuff */
991     }
992
993     if (len == 0 && !create_empty_fragment)
994         return 0;
995
996     sess = s->session;
997
998     if ((sess == NULL) ||
999         (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL))
1000         clear = 1;
1001
1002     if (clear)
1003         mac_size = 0;
1004     else {
1005         mac_size = EVP_MD_CTX_size(s->write_hash);
1006         if (mac_size < 0)
1007             goto err;
1008     }
1009
1010     p = SSL3_BUFFER_get_buf(wb) + prefix_len;
1011
1012     /* write the header */
1013
1014     *(p++) = type & 0xff;
1015     SSL3_RECORD_set_type(&wr, type);
1016     /*
1017      * Special case: for hello verify request, client version 1.0 and we
1018      * haven't decided which version to use yet send back using version 1.0
1019      * header: otherwise some clients will ignore it.
1020      */
1021     if (s->method->version == DTLS_ANY_VERSION &&
1022         s->max_proto_version != DTLS1_BAD_VER) {
1023         *(p++) = DTLS1_VERSION >> 8;
1024         *(p++) = DTLS1_VERSION & 0xff;
1025     } else {
1026         *(p++) = s->version >> 8;
1027         *(p++) = s->version & 0xff;
1028     }
1029
1030     /* field where we are to write out packet epoch, seq num and len */
1031     pseq = p;
1032     p += 10;
1033
1034     /* Explicit IV length, block ciphers appropriate version flag */
1035     if (s->enc_write_ctx) {
1036         int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
1037         if (mode == EVP_CIPH_CBC_MODE) {
1038             eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
1039             if (eivlen <= 1)
1040                 eivlen = 0;
1041         }
1042         /* Need explicit part of IV for GCM mode */
1043         else if (mode == EVP_CIPH_GCM_MODE)
1044             eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
1045         else if (mode == EVP_CIPH_CCM_MODE)
1046             eivlen = EVP_CCM_TLS_EXPLICIT_IV_LEN;
1047         else
1048             eivlen = 0;
1049     } else
1050         eivlen = 0;
1051
1052     /* lets setup the record stuff. */
1053     SSL3_RECORD_set_data(&wr, p + eivlen); /* make room for IV in case of CBC */
1054     SSL3_RECORD_set_length(&wr, (int)len);
1055     SSL3_RECORD_set_input(&wr, (unsigned char *)buf);
1056
1057     /*
1058      * we now 'read' from wr.input, wr.length bytes into wr.data
1059      */
1060
1061     /* first we compress */
1062     if (s->compress != NULL) {
1063         if (!ssl3_do_compress(s, &wr)) {
1064             SSLerr(SSL_F_DO_DTLS1_WRITE, SSL_R_COMPRESSION_FAILURE);
1065             goto err;
1066         }
1067     } else {
1068         memcpy(SSL3_RECORD_get_data(&wr), SSL3_RECORD_get_input(&wr),
1069                SSL3_RECORD_get_length(&wr));
1070         SSL3_RECORD_reset_input(&wr);
1071     }
1072
1073     /*
1074      * we should still have the output to wr.data and the input from
1075      * wr.input.  Length should be wr.length. wr.data still points in the
1076      * wb->buf
1077      */
1078
1079     if (mac_size != 0) {
1080         if (s->method->ssl3_enc->mac(s, &wr,
1081                                      &(p[SSL3_RECORD_get_length(&wr) + eivlen]),
1082                                      1) < 0)
1083             goto err;
1084         SSL3_RECORD_add_length(&wr, mac_size);
1085     }
1086
1087     /* this is true regardless of mac size */
1088     SSL3_RECORD_set_data(&wr, p);
1089     SSL3_RECORD_reset_input(&wr);
1090
1091     if (eivlen)
1092         SSL3_RECORD_add_length(&wr, eivlen);
1093
1094     if (s->method->ssl3_enc->enc(s, &wr, 1, 1) < 1)
1095         goto err;
1096
1097     /* record length after mac and block padding */
1098     /*
1099      * if (type == SSL3_RT_APPLICATION_DATA || (type == SSL3_RT_ALERT && !
1100      * SSL_in_init(s)))
1101      */
1102
1103     /* there's only one epoch between handshake and app data */
1104
1105     s2n(s->rlayer.d->w_epoch, pseq);
1106
1107     /* XDTLS: ?? */
1108     /*
1109      * else s2n(s->d1->handshake_epoch, pseq);
1110      */
1111
1112     memcpy(pseq, &(s->rlayer.write_sequence[2]), 6);
1113     pseq += 6;
1114     s2n(SSL3_RECORD_get_length(&wr), pseq);
1115
1116     if (s->msg_callback)
1117         s->msg_callback(1, 0, SSL3_RT_HEADER, pseq - DTLS1_RT_HEADER_LENGTH,
1118                         DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
1119
1120     /*
1121      * we should now have wr.data pointing to the encrypted data, which is
1122      * wr->length long
1123      */
1124     SSL3_RECORD_set_type(&wr, type); /* not needed but helps for debugging */
1125     SSL3_RECORD_add_length(&wr, DTLS1_RT_HEADER_LENGTH);
1126
1127     ssl3_record_sequence_update(&(s->rlayer.write_sequence[0]));
1128
1129     if (create_empty_fragment) {
1130         /*
1131          * we are in a recursive call; just return the length, don't write
1132          * out anything here
1133          */
1134         return wr.length;
1135     }
1136
1137     /* now let's set up wb */
1138     SSL3_BUFFER_set_left(wb, prefix_len + SSL3_RECORD_get_length(&wr));
1139     SSL3_BUFFER_set_offset(wb, 0);
1140
1141     /*
1142      * memorize arguments so that ssl3_write_pending can detect bad write
1143      * retries later
1144      */
1145     s->rlayer.wpend_tot = len;
1146     s->rlayer.wpend_buf = buf;
1147     s->rlayer.wpend_type = type;
1148     s->rlayer.wpend_ret = len;
1149
1150     /* we now just need to write the buffer */
1151     return ssl3_write_pending(s, type, buf, len);
1152  err:
1153     return -1;
1154 }
1155
1156 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
1157                                unsigned int *is_next_epoch)
1158 {
1159
1160     *is_next_epoch = 0;
1161
1162     /* In current epoch, accept HM, CCS, DATA, & ALERT */
1163     if (rr->epoch == s->rlayer.d->r_epoch)
1164         return &s->rlayer.d->bitmap;
1165
1166     /*
1167      * Only HM and ALERT messages can be from the next epoch and only if we
1168      * have already processed all of the unprocessed records from the last
1169      * epoch
1170      */
1171     else if (rr->epoch == (unsigned long)(s->rlayer.d->r_epoch + 1) &&
1172              s->rlayer.d->unprocessed_rcds.epoch != s->rlayer.d->r_epoch &&
1173              (rr->type == SSL3_RT_HANDSHAKE || rr->type == SSL3_RT_ALERT)) {
1174         *is_next_epoch = 1;
1175         return &s->rlayer.d->next_bitmap;
1176     }
1177
1178     return NULL;
1179 }
1180
1181 void dtls1_reset_seq_numbers(SSL *s, int rw)
1182 {
1183     unsigned char *seq;
1184     unsigned int seq_bytes = sizeof(s->rlayer.read_sequence);
1185
1186     if (rw & SSL3_CC_READ) {
1187         seq = s->rlayer.read_sequence;
1188         s->rlayer.d->r_epoch++;
1189         memcpy(&s->rlayer.d->bitmap, &s->rlayer.d->next_bitmap,
1190                sizeof(s->rlayer.d->bitmap));
1191         memset(&s->rlayer.d->next_bitmap, 0, sizeof(s->rlayer.d->next_bitmap));
1192     } else {
1193         seq = s->rlayer.write_sequence;
1194         memcpy(s->rlayer.d->last_write_sequence, seq,
1195                sizeof(s->rlayer.write_sequence));
1196         s->rlayer.d->w_epoch++;
1197     }
1198
1199     memset(seq, 0, seq_bytes);
1200 }