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