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