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