Fix DTLS replay protection
[openssl.git] / ssl / 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 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap);
187 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);
188 static DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
189                                       unsigned int *is_next_epoch);
190 #if 0
191 static int dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr,
192                                         unsigned short *priority,
193                                         unsigned long *offset);
194 #endif
195 static int dtls1_buffer_record(SSL *s, record_pqueue *q,
196                                unsigned char *priority);
197 static int dtls1_process_record(SSL *s, DTLS1_BITMAP *bitmap);
198
199 /* copy buffered record into SSL structure */
200 static int dtls1_copy_record(SSL *s, pitem *item)
201 {
202     DTLS1_RECORD_DATA *rdata;
203
204     rdata = (DTLS1_RECORD_DATA *)item->data;
205
206     if (s->s3->rbuf.buf != NULL)
207         OPENSSL_free(s->s3->rbuf.buf);
208
209     s->packet = rdata->packet;
210     s->packet_length = rdata->packet_length;
211     memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
212     memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
213
214     /* Set proper sequence number for mac calculation */
215     memcpy(&(s->s3->read_sequence[2]), &(rdata->packet[5]), 6);
216
217     return (1);
218 }
219
220 static 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->packet;
243     rdata->packet_length = s->packet_length;
244     memcpy(&(rdata->rbuf), &(s->s3->rbuf), sizeof(SSL3_BUFFER));
245     memcpy(&(rdata->rrec), &(s->s3->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->packet = NULL;
260     s->packet_length = 0;
261     memset(&(s->s3->rbuf), 0, sizeof(SSL3_BUFFER));
262     memset(&(s->s3->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 static 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)->d1->unprocessed_rcds))
310
311 /*
312  * retrieve a buffered record that belongs to the current epoch, ie,
313  * processed
314  */
315 #define dtls1_get_processed_record(s) \
316                    dtls1_retrieve_buffered_record((s), \
317                    &((s)->d1->processed_rcds))
318
319 static int dtls1_process_buffered_records(SSL *s)
320 {
321     pitem *item;
322     SSL3_BUFFER *rb;
323     SSL3_RECORD *rr;
324     DTLS1_BITMAP *bitmap;
325     unsigned int is_next_epoch;
326     int replayok = 1;
327
328     item = pqueue_peek(s->d1->unprocessed_rcds.q);
329     if (item) {
330         /* Check if epoch is current. */
331         if (s->d1->unprocessed_rcds.epoch != s->d1->r_epoch)
332             return 1;         /* Nothing to do. */
333
334         rr = &s->s3->rrec;
335         rb = &s->s3->rbuf;
336
337         if (rb->left > 0) {
338             /*
339              * We've still got data from the current packet to read. There could
340              * be a record from the new epoch in it - so don't overwrite it
341              * with the unprocessed records yet (we'll do it when we've
342              * finished reading the current packet).
343              */
344             return 1;
345         }
346
347
348         /* Process all the records. */
349         while (pqueue_peek(s->d1->unprocessed_rcds.q)) {
350             dtls1_get_unprocessed_record(s);
351             bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
352             if (bitmap == NULL) {
353                 /*
354                  * Should not happen. This will only ever be NULL when the
355                  * current record is from a different epoch. But that cannot
356                  * be the case because we already checked the epoch above
357                  */
358                  SSLerr(SSL_F_DTLS1_PROCESS_BUFFERED_RECORDS,
359                         ERR_R_INTERNAL_ERROR);
360                  return 0;
361             }
362 #ifndef OPENSSL_NO_SCTP
363             /* Only do replay check if no SCTP bio */
364             if (!BIO_dgram_is_sctp(SSL_get_rbio(s)))
365 #endif
366             {
367                 /*
368                  * Check whether this is a repeat, or aged record. We did this
369                  * check once already when we first received the record - but
370                  * we might have updated the window since then due to
371                  * records we subsequently processed.
372                  */
373                 replayok = dtls1_record_replay_check(s, bitmap);
374             }
375
376             if (!replayok || !dtls1_process_record(s, bitmap)) {
377                 /* dump this record */
378                 rr->length = 0;
379                 s->packet_length = 0;
380                 continue;
381             }
382
383             if (dtls1_buffer_record(s, &(s->d1->processed_rcds),
384                                     s->s3->rrec.seq_num) < 0)
385                 return 0;
386         }
387     }
388
389     /*
390      * sync epoch numbers once all the unprocessed records have been
391      * processed
392      */
393     s->d1->processed_rcds.epoch = s->d1->r_epoch;
394     s->d1->unprocessed_rcds.epoch = s->d1->r_epoch + 1;
395
396     return 1;
397 }
398
399 #if 0
400
401 static int dtls1_get_buffered_record(SSL *s)
402 {
403     pitem *item;
404     PQ_64BIT priority =
405         (((PQ_64BIT) s->d1->handshake_read_seq) << 32) |
406         ((PQ_64BIT) s->d1->r_msg_hdr.frag_off);
407
408     /* if we're not (re)negotiating, nothing buffered */
409     if (!SSL_in_init(s))
410         return 0;
411
412     item = pqueue_peek(s->d1->rcvd_records);
413     if (item && item->priority == priority) {
414         /*
415          * Check if we've received the record of interest.  It must be a
416          * handshake record, since data records as passed up without
417          * buffering
418          */
419         DTLS1_RECORD_DATA *rdata;
420         item = pqueue_pop(s->d1->rcvd_records);
421         rdata = (DTLS1_RECORD_DATA *)item->data;
422
423         if (s->s3->rbuf.buf != NULL)
424             OPENSSL_free(s->s3->rbuf.buf);
425
426         s->packet = rdata->packet;
427         s->packet_length = rdata->packet_length;
428         memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
429         memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
430
431         OPENSSL_free(item->data);
432         pitem_free(item);
433
434         /* s->d1->next_expected_seq_num++; */
435         return (1);
436     }
437
438     return 0;
439 }
440
441 #endif
442
443 static int dtls1_process_record(SSL *s, DTLS1_BITMAP *bitmap)
444 {
445     int i, al;
446     int enc_err;
447     SSL_SESSION *sess;
448     SSL3_RECORD *rr;
449     unsigned int mac_size, orig_len;
450     unsigned char md[EVP_MAX_MD_SIZE];
451
452     rr = &(s->s3->rrec);
453     sess = s->session;
454
455     /*
456      * At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
457      * and we have that many bytes in s->packet
458      */
459     rr->input = &(s->packet[DTLS1_RT_HEADER_LENGTH]);
460
461     /*
462      * ok, we can now read from 's->packet' data into 'rr' rr->input points
463      * at rr->length bytes, which need to be copied into rr->data by either
464      * the decryption or by the decompression When the data is 'copied' into
465      * the rr->data buffer, rr->input will be pointed at the new buffer
466      */
467
468     /*
469      * We now have - encrypted [ MAC [ compressed [ plain ] ] ] rr->length
470      * bytes of encrypted compressed stuff.
471      */
472
473     /* check is not needed I believe */
474     if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
475         al = SSL_AD_RECORD_OVERFLOW;
476         SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
477         goto f_err;
478     }
479
480     /* decrypt in place in 'rr->input' */
481     rr->data = rr->input;
482
483     enc_err = s->method->ssl3_enc->enc(s, 0);
484     /*-
485      * enc_err is:
486      *    0: (in non-constant time) if the record is publically invalid.
487      *    1: if the padding is valid
488      *   -1: if the padding is invalid
489      */
490     if (enc_err == 0) {
491         /* For DTLS we simply ignore bad packets. */
492         rr->length = 0;
493         s->packet_length = 0;
494         goto err;
495     }
496 #ifdef TLS_DEBUG
497     printf("dec %d\n", rr->length);
498     {
499         unsigned int z;
500         for (z = 0; z < rr->length; z++)
501             printf("%02X%c", rr->data[z], ((z + 1) % 16) ? ' ' : '\n');
502     }
503     printf("\n");
504 #endif
505
506     /* r->length is now the compressed data plus mac */
507     if ((sess != NULL) &&
508         (s->enc_read_ctx != NULL) && (EVP_MD_CTX_md(s->read_hash) != NULL)) {
509         /* s->read_hash != NULL => mac_size != -1 */
510         unsigned char *mac = NULL;
511         unsigned char mac_tmp[EVP_MAX_MD_SIZE];
512         mac_size = EVP_MD_CTX_size(s->read_hash);
513         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
514
515         /*
516          * kludge: *_cbc_remove_padding passes padding length in rr->type
517          */
518         orig_len = rr->length + ((unsigned int)rr->type >> 8);
519
520         /*
521          * orig_len is the length of the record before any padding was
522          * removed. This is public information, as is the MAC in use,
523          * therefore we can safely process the record in a different amount
524          * of time if it's too short to possibly contain a MAC.
525          */
526         if (orig_len < mac_size ||
527             /* CBC records must have a padding length byte too. */
528             (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
529              orig_len < mac_size + 1)) {
530             al = SSL_AD_DECODE_ERROR;
531             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_LENGTH_TOO_SHORT);
532             goto f_err;
533         }
534
535         if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
536             /*
537              * We update the length so that the TLS header bytes can be
538              * constructed correctly but we need to extract the MAC in
539              * constant time from within the record, without leaking the
540              * contents of the padding bytes.
541              */
542             mac = mac_tmp;
543             ssl3_cbc_copy_mac(mac_tmp, rr, mac_size, orig_len);
544             rr->length -= mac_size;
545         } else {
546             /*
547              * In this case there's no padding, so |orig_len| equals
548              * |rec->length| and we checked that there's enough bytes for
549              * |mac_size| above.
550              */
551             rr->length -= mac_size;
552             mac = &rr->data[rr->length];
553         }
554
555         i = s->method->ssl3_enc->mac(s, md, 0 /* not send */ );
556         if (i < 0 || mac == NULL
557             || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0)
558             enc_err = -1;
559         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + mac_size)
560             enc_err = -1;
561     }
562
563     if (enc_err < 0) {
564         /* decryption failed, silently discard message */
565         rr->length = 0;
566         s->packet_length = 0;
567         goto err;
568     }
569
570     /* r->length is now just compressed */
571     if (s->expand != NULL) {
572         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH) {
573             al = SSL_AD_RECORD_OVERFLOW;
574             SSLerr(SSL_F_DTLS1_PROCESS_RECORD,
575                    SSL_R_COMPRESSED_LENGTH_TOO_LONG);
576             goto f_err;
577         }
578         if (!ssl3_do_uncompress(s)) {
579             al = SSL_AD_DECOMPRESSION_FAILURE;
580             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_BAD_DECOMPRESSION);
581             goto f_err;
582         }
583     }
584
585     if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH) {
586         al = SSL_AD_RECORD_OVERFLOW;
587         SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
588         goto f_err;
589     }
590
591     rr->off = 0;
592     /*-
593      * So at this point the following is true
594      * ssl->s3->rrec.type   is the type of record
595      * ssl->s3->rrec.length == number of bytes in record
596      * ssl->s3->rrec.off    == offset to first valid byte
597      * ssl->s3->rrec.data   == where to take bytes from, increment
598      *                         after use :-).
599      */
600
601     /* we have pulled in a full packet so zero things */
602     s->packet_length = 0;
603
604     /* Mark receipt of record. */
605     dtls1_record_bitmap_update(s, bitmap);
606
607     return (1);
608
609  f_err:
610     ssl3_send_alert(s, SSL3_AL_FATAL, al);
611  err:
612     return (0);
613 }
614
615 /*-
616  * Call this to get a new input record.
617  * It will return <= 0 if more data is needed, normally due to an error
618  * or non-blocking IO.
619  * When it finishes, one packet has been decoded and can be found in
620  * ssl->s3->rrec.type    - is the type of record
621  * ssl->s3->rrec.data,   - data
622  * ssl->s3->rrec.length, - number of bytes
623  */
624 /* used only by dtls1_read_bytes */
625 int dtls1_get_record(SSL *s)
626 {
627     int ssl_major, ssl_minor;
628     int i, n;
629     SSL3_RECORD *rr;
630     unsigned char *p = NULL;
631     unsigned short version;
632     DTLS1_BITMAP *bitmap;
633     unsigned int is_next_epoch;
634
635     rr = &(s->s3->rrec);
636
637  again:
638     /*
639      * The epoch may have changed.  If so, process all the pending records.
640      * This is a non-blocking operation.
641      */
642     if (!dtls1_process_buffered_records(s))
643         return -1;
644
645     /* if we're renegotiating, then there may be buffered records */
646     if (dtls1_get_processed_record(s))
647         return 1;
648
649     /* get something from the wire */
650     /* check if we have the header */
651     if ((s->rstate != SSL_ST_READ_BODY) ||
652         (s->packet_length < DTLS1_RT_HEADER_LENGTH)) {
653         n = ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH, s->s3->rbuf.len, 0);
654         /* read timeout is handled by dtls1_read_bytes */
655         if (n <= 0)
656             return (n);         /* error or non-blocking */
657
658         /* this packet contained a partial record, dump it */
659         if (s->packet_length != DTLS1_RT_HEADER_LENGTH) {
660             s->packet_length = 0;
661             goto again;
662         }
663
664         s->rstate = SSL_ST_READ_BODY;
665
666         p = s->packet;
667
668         if (s->msg_callback)
669             s->msg_callback(0, 0, SSL3_RT_HEADER, p, DTLS1_RT_HEADER_LENGTH,
670                             s, s->msg_callback_arg);
671
672         /* Pull apart the header into the DTLS1_RECORD */
673         rr->type = *(p++);
674         ssl_major = *(p++);
675         ssl_minor = *(p++);
676         version = (ssl_major << 8) | ssl_minor;
677
678         /* sequence number is 64 bits, with top 2 bytes = epoch */
679         n2s(p, rr->epoch);
680
681         memcpy(&(s->s3->read_sequence[2]), p, 6);
682         p += 6;
683
684         n2s(p, rr->length);
685
686         /* Lets check version */
687         if (!s->first_packet) {
688             if (version != s->version) {
689                 /* unexpected version, silently discard */
690                 rr->length = 0;
691                 s->packet_length = 0;
692                 goto again;
693             }
694         }
695
696         if ((version & 0xff00) != (s->version & 0xff00)) {
697             /* wrong version, silently discard record */
698             rr->length = 0;
699             s->packet_length = 0;
700             goto again;
701         }
702
703         if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
704             /* record too long, silently discard it */
705             rr->length = 0;
706             s->packet_length = 0;
707             goto again;
708         }
709
710         /* now s->rstate == SSL_ST_READ_BODY */
711     }
712
713     /* s->rstate == SSL_ST_READ_BODY, get and decode the data */
714
715     if (rr->length > s->packet_length - DTLS1_RT_HEADER_LENGTH) {
716         /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
717         i = rr->length;
718         n = ssl3_read_n(s, i, i, 1);
719         /* this packet contained a partial record, dump it */
720         if (n != i) {
721             rr->length = 0;
722             s->packet_length = 0;
723             goto again;
724         }
725
726         /*
727          * now n == rr->length, and s->packet_length ==
728          * DTLS1_RT_HEADER_LENGTH + rr->length
729          */
730     }
731     s->rstate = SSL_ST_READ_HEADER; /* set state for later operations */
732
733     /* match epochs.  NULL means the packet is dropped on the floor */
734     bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
735     if (bitmap == NULL) {
736         rr->length = 0;
737         s->packet_length = 0;   /* dump this record */
738         goto again;             /* get another record */
739     }
740 #ifndef OPENSSL_NO_SCTP
741     /* Only do replay check if no SCTP bio */
742     if (!BIO_dgram_is_sctp(SSL_get_rbio(s))) {
743 #endif
744         /*
745          * Check whether this is a repeat, or aged record. Don't check if
746          * we're listening and this message is a ClientHello. They can look
747          * as if they're replayed, since they arrive from different
748          * connections and would be dropped unnecessarily.
749          */
750         if (!(s->d1->listen && rr->type == SSL3_RT_HANDSHAKE &&
751               s->packet_length > DTLS1_RT_HEADER_LENGTH &&
752               s->packet[DTLS1_RT_HEADER_LENGTH] == SSL3_MT_CLIENT_HELLO) &&
753             !dtls1_record_replay_check(s, bitmap)) {
754             rr->length = 0;
755             s->packet_length = 0; /* dump this record */
756             goto again;         /* get another record */
757         }
758 #ifndef OPENSSL_NO_SCTP
759     }
760 #endif
761
762     /* just read a 0 length packet */
763     if (rr->length == 0)
764         goto again;
765
766     /*
767      * If this record is from the next epoch (either HM or ALERT), and a
768      * handshake is currently in progress, buffer it since it cannot be
769      * processed at this time. However, do not buffer anything while
770      * listening.
771      */
772     if (is_next_epoch) {
773         if ((SSL_in_init(s) || s->in_handshake) && !s->d1->listen) {
774             if (dtls1_buffer_record
775                 (s, &(s->d1->unprocessed_rcds), rr->seq_num) < 0)
776                 return -1;
777         }
778         rr->length = 0;
779         s->packet_length = 0;
780         goto again;
781     }
782
783     if (!dtls1_process_record(s, bitmap)) {
784         rr->length = 0;
785         s->packet_length = 0;   /* dump this record */
786         goto again;             /* get another record */
787     }
788
789     return (1);
790
791 }
792
793 /*-
794  * Return up to 'len' payload bytes received in 'type' records.
795  * 'type' is one of the following:
796  *
797  *   -  SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
798  *   -  SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
799  *   -  0 (during a shutdown, no data has to be returned)
800  *
801  * If we don't have stored data to work from, read a SSL/TLS record first
802  * (possibly multiple records if we still don't have anything to return).
803  *
804  * This function must handle any surprises the peer may have for us, such as
805  * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
806  * a surprise, but handled as if it were), or renegotiation requests.
807  * Also if record payloads contain fragments too small to process, we store
808  * them until there is enough for the respective protocol (the record protocol
809  * may use arbitrary fragmentation and even interleaving):
810  *     Change cipher spec protocol
811  *             just 1 byte needed, no need for keeping anything stored
812  *     Alert protocol
813  *             2 bytes needed (AlertLevel, AlertDescription)
814  *     Handshake protocol
815  *             4 bytes needed (HandshakeType, uint24 length) -- we just have
816  *             to detect unexpected Client Hello and Hello Request messages
817  *             here, anything else is handled by higher layers
818  *     Application data protocol
819  *             none of our business
820  */
821 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
822 {
823     int al, i, j, ret;
824     unsigned int n;
825     SSL3_RECORD *rr;
826     void (*cb) (const SSL *ssl, int type2, int val) = NULL;
827
828     if (s->s3->rbuf.buf == NULL) /* Not initialized yet */
829         if (!ssl3_setup_buffers(s))
830             return (-1);
831
832     /* XXX: check what the second '&& type' is about */
833     if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
834          (type != SSL3_RT_HANDSHAKE) && type) ||
835         (peek && (type != SSL3_RT_APPLICATION_DATA))) {
836         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
837         return -1;
838     }
839
840     /*
841      * check whether there's a handshake message (client hello?) waiting
842      */
843     if ((ret = have_handshake_fragment(s, type, buf, len, peek)))
844         return ret;
845
846     /*
847      * Now s->d1->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE.
848      */
849
850 #ifndef OPENSSL_NO_SCTP
851     /*
852      * Continue handshake if it had to be interrupted to read app data with
853      * SCTP.
854      */
855     if ((!s->in_handshake && SSL_in_init(s)) ||
856         (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
857          (s->state == DTLS1_SCTP_ST_SR_READ_SOCK
858           || s->state == DTLS1_SCTP_ST_CR_READ_SOCK)
859          && s->s3->in_read_app_data != 2))
860 #else
861     if (!s->in_handshake && SSL_in_init(s))
862 #endif
863     {
864         /* type == SSL3_RT_APPLICATION_DATA */
865         i = s->handshake_func(s);
866         if (i < 0)
867             return (i);
868         if (i == 0) {
869             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
870             return (-1);
871         }
872     }
873
874  start:
875     s->rwstate = SSL_NOTHING;
876
877     /*-
878      * s->s3->rrec.type         - is the type of record
879      * s->s3->rrec.data,    - data
880      * s->s3->rrec.off,     - offset into 'data' for next read
881      * s->s3->rrec.length,  - number of bytes.
882      */
883     rr = &(s->s3->rrec);
884
885     /*
886      * We are not handshaking and have no data yet, so process data buffered
887      * during the last handshake in advance, if any.
888      */
889     if (s->state == SSL_ST_OK && rr->length == 0) {
890         pitem *item;
891         item = pqueue_pop(s->d1->buffered_app_data.q);
892         if (item) {
893 #ifndef OPENSSL_NO_SCTP
894             /* Restore bio_dgram_sctp_rcvinfo struct */
895             if (BIO_dgram_is_sctp(SSL_get_rbio(s))) {
896                 DTLS1_RECORD_DATA *rdata = (DTLS1_RECORD_DATA *)item->data;
897                 BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SCTP_SET_RCVINFO,
898                          sizeof(rdata->recordinfo), &rdata->recordinfo);
899             }
900 #endif
901
902             dtls1_copy_record(s, item);
903
904             OPENSSL_free(item->data);
905             pitem_free(item);
906         }
907     }
908
909     /* Check for timeout */
910     if (dtls1_handle_timeout(s) > 0)
911         goto start;
912
913     /* get new packet if necessary */
914     if ((rr->length == 0) || (s->rstate == SSL_ST_READ_BODY)) {
915         ret = dtls1_get_record(s);
916         if (ret <= 0) {
917             ret = dtls1_read_failed(s, ret);
918             /* anything other than a timeout is an error */
919             if (ret <= 0)
920                 return (ret);
921             else
922                 goto start;
923         }
924     }
925
926     if (s->d1->listen && rr->type != SSL3_RT_HANDSHAKE) {
927         rr->length = 0;
928         goto start;
929     }
930
931     /* we now have a packet which can be read and processed */
932
933     if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
934                                    * reset by ssl3_get_finished */
935         && (rr->type != SSL3_RT_HANDSHAKE)) {
936         /*
937          * We now have application data between CCS and Finished. Most likely
938          * the packets were reordered on their way, so buffer the application
939          * data for later processing rather than dropping the connection.
940          */
941         if (dtls1_buffer_record(s, &(s->d1->buffered_app_data), rr->seq_num) <
942             0) {
943             SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
944             return -1;
945         }
946         rr->length = 0;
947         goto start;
948     }
949
950     /*
951      * If the other end has shut down, throw anything we read away (even in
952      * 'peek' mode)
953      */
954     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
955         rr->length = 0;
956         s->rwstate = SSL_NOTHING;
957         return (0);
958     }
959
960     if (type == rr->type) {     /* SSL3_RT_APPLICATION_DATA or
961                                  * SSL3_RT_HANDSHAKE */
962         /*
963          * make sure that we are not getting application data when we are
964          * doing a handshake for the first time
965          */
966         if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
967             (s->enc_read_ctx == NULL)) {
968             al = SSL_AD_UNEXPECTED_MESSAGE;
969             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
970             goto f_err;
971         }
972
973         if (len <= 0)
974             return (len);
975
976         if ((unsigned int)len > rr->length)
977             n = rr->length;
978         else
979             n = (unsigned int)len;
980
981         memcpy(buf, &(rr->data[rr->off]), n);
982         if (!peek) {
983             rr->length -= n;
984             rr->off += n;
985             if (rr->length == 0) {
986                 s->rstate = SSL_ST_READ_HEADER;
987                 rr->off = 0;
988             }
989         }
990 #ifndef OPENSSL_NO_SCTP
991         /*
992          * We were about to renegotiate but had to read belated application
993          * data first, so retry.
994          */
995         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
996             rr->type == SSL3_RT_APPLICATION_DATA &&
997             (s->state == DTLS1_SCTP_ST_SR_READ_SOCK
998              || s->state == DTLS1_SCTP_ST_CR_READ_SOCK)) {
999             s->rwstate = SSL_READING;
1000             BIO_clear_retry_flags(SSL_get_rbio(s));
1001             BIO_set_retry_read(SSL_get_rbio(s));
1002         }
1003
1004         /*
1005          * We might had to delay a close_notify alert because of reordered
1006          * app data. If there was an alert and there is no message to read
1007          * anymore, finally set shutdown.
1008          */
1009         if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
1010             s->d1->shutdown_received
1011             && !BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
1012             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1013             return (0);
1014         }
1015 #endif
1016         return (n);
1017     }
1018
1019     /*
1020      * If we get here, then type != rr->type; if we have a handshake message,
1021      * then it was unexpected (Hello Request or Client Hello).
1022      */
1023
1024     /*
1025      * In case of record types for which we have 'fragment' storage, fill
1026      * that so that we can process the data at a fixed place.
1027      */
1028     {
1029         unsigned int k, dest_maxlen = 0;
1030         unsigned char *dest = NULL;
1031         unsigned int *dest_len = NULL;
1032
1033         if (rr->type == SSL3_RT_HANDSHAKE) {
1034             dest_maxlen = sizeof s->d1->handshake_fragment;
1035             dest = s->d1->handshake_fragment;
1036             dest_len = &s->d1->handshake_fragment_len;
1037         } else if (rr->type == SSL3_RT_ALERT) {
1038             dest_maxlen = sizeof(s->d1->alert_fragment);
1039             dest = s->d1->alert_fragment;
1040             dest_len = &s->d1->alert_fragment_len;
1041         }
1042 #ifndef OPENSSL_NO_HEARTBEATS
1043         else if (rr->type == TLS1_RT_HEARTBEAT) {
1044             dtls1_process_heartbeat(s);
1045
1046             /* Exit and notify application to read again */
1047             rr->length = 0;
1048             s->rwstate = SSL_READING;
1049             BIO_clear_retry_flags(SSL_get_rbio(s));
1050             BIO_set_retry_read(SSL_get_rbio(s));
1051             return (-1);
1052         }
1053 #endif
1054         /* else it's a CCS message, or application data or wrong */
1055         else if (rr->type != SSL3_RT_CHANGE_CIPHER_SPEC) {
1056             /*
1057              * Application data while renegotiating is allowed. Try again
1058              * reading.
1059              */
1060             if (rr->type == SSL3_RT_APPLICATION_DATA) {
1061                 BIO *bio;
1062                 s->s3->in_read_app_data = 2;
1063                 bio = SSL_get_rbio(s);
1064                 s->rwstate = SSL_READING;
1065                 BIO_clear_retry_flags(bio);
1066                 BIO_set_retry_read(bio);
1067                 return (-1);
1068             }
1069
1070             /* Not certain if this is the right error handling */
1071             al = SSL_AD_UNEXPECTED_MESSAGE;
1072             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1073             goto f_err;
1074         }
1075
1076         if (dest_maxlen > 0) {
1077             /*
1078              * XDTLS: In a pathalogical case, the Client Hello may be
1079              * fragmented--don't always expect dest_maxlen bytes
1080              */
1081             if (rr->length < dest_maxlen) {
1082 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1083                 /*
1084                  * for normal alerts rr->length is 2, while
1085                  * dest_maxlen is 7 if we were to handle this
1086                  * non-existing alert...
1087                  */
1088                 FIX ME
1089 #endif
1090                  s->rstate = SSL_ST_READ_HEADER;
1091                 rr->length = 0;
1092                 goto start;
1093             }
1094
1095             /* now move 'n' bytes: */
1096             for (k = 0; k < dest_maxlen; k++) {
1097                 dest[k] = rr->data[rr->off++];
1098                 rr->length--;
1099             }
1100             *dest_len = dest_maxlen;
1101         }
1102     }
1103
1104     /*-
1105      * s->d1->handshake_fragment_len == 12  iff  rr->type == SSL3_RT_HANDSHAKE;
1106      * s->d1->alert_fragment_len == 7      iff  rr->type == SSL3_RT_ALERT.
1107      * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
1108      */
1109
1110     /* If we are a client, check for an incoming 'Hello Request': */
1111     if ((!s->server) &&
1112         (s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
1113         (s->d1->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
1114         (s->session != NULL) && (s->session->cipher != NULL)) {
1115         s->d1->handshake_fragment_len = 0;
1116
1117         if ((s->d1->handshake_fragment[1] != 0) ||
1118             (s->d1->handshake_fragment[2] != 0) ||
1119             (s->d1->handshake_fragment[3] != 0)) {
1120             al = SSL_AD_DECODE_ERROR;
1121             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
1122             goto f_err;
1123         }
1124
1125         /*
1126          * no need to check sequence number on HELLO REQUEST messages
1127          */
1128
1129         if (s->msg_callback)
1130             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
1131                             s->d1->handshake_fragment, 4, s,
1132                             s->msg_callback_arg);
1133
1134         if (SSL_is_init_finished(s) &&
1135             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
1136             !s->s3->renegotiate) {
1137             s->d1->handshake_read_seq++;
1138             s->new_session = 1;
1139             ssl3_renegotiate(s);
1140             if (ssl3_renegotiate_check(s)) {
1141                 i = s->handshake_func(s);
1142                 if (i < 0)
1143                     return (i);
1144                 if (i == 0) {
1145                     SSLerr(SSL_F_DTLS1_READ_BYTES,
1146                            SSL_R_SSL_HANDSHAKE_FAILURE);
1147                     return (-1);
1148                 }
1149
1150                 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1151                     if (s->s3->rbuf.left == 0) { /* no read-ahead left? */
1152                         BIO *bio;
1153                         /*
1154                          * In the case where we try to read application data,
1155                          * but we trigger an SSL handshake, we return -1 with
1156                          * the retry option set.  Otherwise renegotiation may
1157                          * cause nasty problems in the blocking world
1158                          */
1159                         s->rwstate = SSL_READING;
1160                         bio = SSL_get_rbio(s);
1161                         BIO_clear_retry_flags(bio);
1162                         BIO_set_retry_read(bio);
1163                         return (-1);
1164                     }
1165                 }
1166             }
1167         }
1168         /*
1169          * we either finished a handshake or ignored the request, now try
1170          * again to obtain the (application) data we were asked for
1171          */
1172         goto start;
1173     }
1174
1175     if (s->d1->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH) {
1176         int alert_level = s->d1->alert_fragment[0];
1177         int alert_descr = s->d1->alert_fragment[1];
1178
1179         s->d1->alert_fragment_len = 0;
1180
1181         if (s->msg_callback)
1182             s->msg_callback(0, s->version, SSL3_RT_ALERT,
1183                             s->d1->alert_fragment, 2, s, s->msg_callback_arg);
1184
1185         if (s->info_callback != NULL)
1186             cb = s->info_callback;
1187         else if (s->ctx->info_callback != NULL)
1188             cb = s->ctx->info_callback;
1189
1190         if (cb != NULL) {
1191             j = (alert_level << 8) | alert_descr;
1192             cb(s, SSL_CB_READ_ALERT, j);
1193         }
1194
1195         if (alert_level == SSL3_AL_WARNING) {
1196             s->s3->warn_alert = alert_descr;
1197             if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
1198 #ifndef OPENSSL_NO_SCTP
1199                 /*
1200                  * With SCTP and streams the socket may deliver app data
1201                  * after a close_notify alert. We have to check this first so
1202                  * that nothing gets discarded.
1203                  */
1204                 if (BIO_dgram_is_sctp(SSL_get_rbio(s)) &&
1205                     BIO_dgram_sctp_msg_waiting(SSL_get_rbio(s))) {
1206                     s->d1->shutdown_received = 1;
1207                     s->rwstate = SSL_READING;
1208                     BIO_clear_retry_flags(SSL_get_rbio(s));
1209                     BIO_set_retry_read(SSL_get_rbio(s));
1210                     return -1;
1211                 }
1212 #endif
1213                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1214                 return (0);
1215             }
1216 #if 0
1217             /* XXX: this is a possible improvement in the future */
1218             /* now check if it's a missing record */
1219             if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE) {
1220                 unsigned short seq;
1221                 unsigned int frag_off;
1222                 unsigned char *p = &(s->d1->alert_fragment[2]);
1223
1224                 n2s(p, seq);
1225                 n2l3(p, frag_off);
1226
1227                 dtls1_retransmit_message(s,
1228                                          dtls1_get_queue_priority
1229                                          (frag->msg_header.seq, 0), frag_off,
1230                                          &found);
1231                 if (!found && SSL_in_init(s)) {
1232                     /*
1233                      * fprintf( stderr,"in init = %d\n", SSL_in_init(s));
1234                      */
1235                     /*
1236                      * requested a message not yet sent, send an alert
1237                      * ourselves
1238                      */
1239                     ssl3_send_alert(s, SSL3_AL_WARNING,
1240                                     DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
1241                 }
1242             }
1243 #endif
1244         } else if (alert_level == SSL3_AL_FATAL) {
1245             char tmp[16];
1246
1247             s->rwstate = SSL_NOTHING;
1248             s->s3->fatal_alert = alert_descr;
1249             SSLerr(SSL_F_DTLS1_READ_BYTES,
1250                    SSL_AD_REASON_OFFSET + alert_descr);
1251             BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
1252             ERR_add_error_data(2, "SSL alert number ", tmp);
1253             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1254             SSL_CTX_remove_session(s->ctx, s->session);
1255             return (0);
1256         } else {
1257             al = SSL_AD_ILLEGAL_PARAMETER;
1258             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
1259             goto f_err;
1260         }
1261
1262         goto start;
1263     }
1264
1265     if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
1266                                             * shutdown */
1267         s->rwstate = SSL_NOTHING;
1268         rr->length = 0;
1269         return (0);
1270     }
1271
1272     if (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC) {
1273         struct ccs_header_st ccs_hdr;
1274         unsigned int ccs_hdr_len = DTLS1_CCS_HEADER_LENGTH;
1275
1276         dtls1_get_ccs_header(rr->data, &ccs_hdr);
1277
1278         if (s->version == DTLS1_BAD_VER)
1279             ccs_hdr_len = 3;
1280
1281         /*
1282          * 'Change Cipher Spec' is just a single byte, so we know exactly
1283          * what the record payload has to look like
1284          */
1285         /* XDTLS: check that epoch is consistent */
1286         if ((rr->length != ccs_hdr_len) ||
1287             (rr->off != 0) || (rr->data[0] != SSL3_MT_CCS)) {
1288             i = SSL_AD_ILLEGAL_PARAMETER;
1289             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_BAD_CHANGE_CIPHER_SPEC);
1290             goto err;
1291         }
1292
1293         rr->length = 0;
1294
1295         if (s->msg_callback)
1296             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
1297                             rr->data, 1, s, s->msg_callback_arg);
1298
1299         /*
1300          * We can't process a CCS now, because previous handshake messages
1301          * are still missing, so just drop it.
1302          */
1303         if (!s->d1->change_cipher_spec_ok) {
1304             goto start;
1305         }
1306
1307         s->d1->change_cipher_spec_ok = 0;
1308
1309         s->s3->change_cipher_spec = 1;
1310         if (!ssl3_do_change_cipher_spec(s))
1311             goto err;
1312
1313         /* do this whenever CCS is processed */
1314         dtls1_reset_seq_numbers(s, SSL3_CC_READ);
1315
1316         if (s->version == DTLS1_BAD_VER)
1317             s->d1->handshake_read_seq++;
1318
1319 #ifndef OPENSSL_NO_SCTP
1320         /*
1321          * Remember that a CCS has been received, so that an old key of
1322          * SCTP-Auth can be deleted when a CCS is sent. Will be ignored if no
1323          * SCTP is used
1324          */
1325         BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD, 1, NULL);
1326 #endif
1327
1328         goto start;
1329     }
1330
1331     /*
1332      * Unexpected handshake message (Client Hello, or protocol violation)
1333      */
1334     if ((s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
1335         !s->in_handshake) {
1336         struct hm_header_st msg_hdr;
1337
1338         /* this may just be a stale retransmit */
1339         dtls1_get_message_header(rr->data, &msg_hdr);
1340         if (rr->epoch != s->d1->r_epoch) {
1341             rr->length = 0;
1342             goto start;
1343         }
1344
1345         /*
1346          * If we are server, we may have a repeated FINISHED of the client
1347          * here, then retransmit our CCS and FINISHED.
1348          */
1349         if (msg_hdr.type == SSL3_MT_FINISHED) {
1350             if (dtls1_check_timeout_num(s) < 0)
1351                 return -1;
1352
1353             dtls1_retransmit_buffered_messages(s);
1354             rr->length = 0;
1355             goto start;
1356         }
1357
1358         if (((s->state & SSL_ST_MASK) == SSL_ST_OK) &&
1359             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
1360 #if 0                           /* worked only because C operator preferences
1361                                  * are not as expected (and because this is
1362                                  * not really needed for clients except for
1363                                  * detecting protocol violations): */
1364             s->state = SSL_ST_BEFORE | (s->server)
1365                 ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1366 #else
1367             s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1368 #endif
1369             s->renegotiate = 1;
1370             s->new_session = 1;
1371         }
1372         i = s->handshake_func(s);
1373         if (i < 0)
1374             return (i);
1375         if (i == 0) {
1376             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
1377             return (-1);
1378         }
1379
1380         if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1381             if (s->s3->rbuf.left == 0) { /* no read-ahead left? */
1382                 BIO *bio;
1383                 /*
1384                  * In the case where we try to read application data, but we
1385                  * trigger an SSL handshake, we return -1 with the retry
1386                  * option set.  Otherwise renegotiation may cause nasty
1387                  * problems in the blocking world
1388                  */
1389                 s->rwstate = SSL_READING;
1390                 bio = SSL_get_rbio(s);
1391                 BIO_clear_retry_flags(bio);
1392                 BIO_set_retry_read(bio);
1393                 return (-1);
1394             }
1395         }
1396         goto start;
1397     }
1398
1399     switch (rr->type) {
1400     default:
1401 #ifndef OPENSSL_NO_TLS
1402         /* TLS just ignores unknown message types */
1403         if (s->version == TLS1_VERSION) {
1404             rr->length = 0;
1405             goto start;
1406         }
1407 #endif
1408         al = SSL_AD_UNEXPECTED_MESSAGE;
1409         SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1410         goto f_err;
1411     case SSL3_RT_CHANGE_CIPHER_SPEC:
1412     case SSL3_RT_ALERT:
1413     case SSL3_RT_HANDSHAKE:
1414         /*
1415          * we already handled all of these, with the possible exception of
1416          * SSL3_RT_HANDSHAKE when s->in_handshake is set, but that should not
1417          * happen when type != rr->type
1418          */
1419         al = SSL_AD_UNEXPECTED_MESSAGE;
1420         SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
1421         goto f_err;
1422     case SSL3_RT_APPLICATION_DATA:
1423         /*
1424          * At this point, we were expecting handshake data, but have
1425          * application data.  If the library was running inside ssl3_read()
1426          * (i.e. in_read_app_data is set) and it makes sense to read
1427          * application data at this point (session renegotiation not yet
1428          * started), we will indulge it.
1429          */
1430         if (s->s3->in_read_app_data &&
1431             (s->s3->total_renegotiations != 0) &&
1432             (((s->state & SSL_ST_CONNECT) &&
1433               (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1434               (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1435              ) || ((s->state & SSL_ST_ACCEPT) &&
1436                    (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1437                    (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1438              )
1439             )) {
1440             s->s3->in_read_app_data = 2;
1441             return (-1);
1442         } else {
1443             al = SSL_AD_UNEXPECTED_MESSAGE;
1444             SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1445             goto f_err;
1446         }
1447     }
1448     /* not reached */
1449
1450  f_err:
1451     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1452  err:
1453     return (-1);
1454 }
1455
1456 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, int len)
1457 {
1458     int i;
1459
1460 #ifndef OPENSSL_NO_SCTP
1461     /*
1462      * Check if we have to continue an interrupted handshake for reading
1463      * belated app data with SCTP.
1464      */
1465     if ((SSL_in_init(s) && !s->in_handshake) ||
1466         (BIO_dgram_is_sctp(SSL_get_wbio(s)) &&
1467          (s->state == DTLS1_SCTP_ST_SR_READ_SOCK
1468           || s->state == DTLS1_SCTP_ST_CR_READ_SOCK)))
1469 #else
1470     if (SSL_in_init(s) && !s->in_handshake)
1471 #endif
1472     {
1473         i = s->handshake_func(s);
1474         if (i < 0)
1475             return (i);
1476         if (i == 0) {
1477             SSLerr(SSL_F_DTLS1_WRITE_APP_DATA_BYTES,
1478                    SSL_R_SSL_HANDSHAKE_FAILURE);
1479             return -1;
1480         }
1481     }
1482
1483     if (len > SSL3_RT_MAX_PLAIN_LENGTH) {
1484         SSLerr(SSL_F_DTLS1_WRITE_APP_DATA_BYTES, SSL_R_DTLS_MESSAGE_TOO_BIG);
1485         return -1;
1486     }
1487
1488     i = dtls1_write_bytes(s, type, buf_, len);
1489     return i;
1490 }
1491
1492         /*
1493          * this only happens when a client hello is received and a handshake
1494          * is started.
1495          */
1496 static int
1497 have_handshake_fragment(SSL *s, int type, unsigned char *buf,
1498                         int len, int peek)
1499 {
1500
1501     if ((type == SSL3_RT_HANDSHAKE) && (s->d1->handshake_fragment_len > 0))
1502         /* (partially) satisfy request from storage */
1503     {
1504         unsigned char *src = s->d1->handshake_fragment;
1505         unsigned char *dst = buf;
1506         unsigned int k, n;
1507
1508         /* peek == 0 */
1509         n = 0;
1510         while ((len > 0) && (s->d1->handshake_fragment_len > 0)) {
1511             *dst++ = *src++;
1512             len--;
1513             s->d1->handshake_fragment_len--;
1514             n++;
1515         }
1516         /* move any remaining fragment bytes: */
1517         for (k = 0; k < s->d1->handshake_fragment_len; k++)
1518             s->d1->handshake_fragment[k] = *src++;
1519         return n;
1520     }
1521
1522     return 0;
1523 }
1524
1525 /*
1526  * Call this to write data in records of type 'type' It will return <= 0 if
1527  * not all data has been sent or non-blocking IO.
1528  */
1529 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len)
1530 {
1531     int i;
1532
1533     OPENSSL_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH);
1534     s->rwstate = SSL_NOTHING;
1535     i = do_dtls1_write(s, type, buf, len, 0);
1536     return i;
1537 }
1538
1539 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
1540                    unsigned int len, int create_empty_fragment)
1541 {
1542     unsigned char *p, *pseq;
1543     int i, mac_size, clear = 0;
1544     int prefix_len = 0;
1545     int eivlen;
1546     SSL3_RECORD *wr;
1547     SSL3_BUFFER *wb;
1548     SSL_SESSION *sess;
1549
1550     /*
1551      * first check if there is a SSL3_BUFFER still being written out.  This
1552      * will happen with non blocking IO
1553      */
1554     if (s->s3->wbuf.left != 0) {
1555         OPENSSL_assert(0);      /* XDTLS: want to see if we ever get here */
1556         return (ssl3_write_pending(s, type, buf, len));
1557     }
1558
1559     /* If we have an alert to send, lets send it */
1560     if (s->s3->alert_dispatch) {
1561         i = s->method->ssl_dispatch_alert(s);
1562         if (i <= 0)
1563             return (i);
1564         /* if it went, fall through and send more stuff */
1565     }
1566
1567     if (len == 0 && !create_empty_fragment)
1568         return 0;
1569
1570     wr = &(s->s3->wrec);
1571     wb = &(s->s3->wbuf);
1572     sess = s->session;
1573
1574     if ((sess == NULL) ||
1575         (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL))
1576         clear = 1;
1577
1578     if (clear)
1579         mac_size = 0;
1580     else {
1581         mac_size = EVP_MD_CTX_size(s->write_hash);
1582         if (mac_size < 0)
1583             goto err;
1584     }
1585
1586     /* DTLS implements explicit IV, so no need for empty fragments */
1587 #if 0
1588     /*
1589      * 'create_empty_fragment' is true only when this function calls itself
1590      */
1591     if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done
1592         && SSL_version(s) != DTLS1_VERSION && SSL_version(s) != DTLS1_BAD_VER)
1593     {
1594         /*
1595          * countermeasure against known-IV weakness in CBC ciphersuites (see
1596          * http://www.openssl.org/~bodo/tls-cbc.txt)
1597          */
1598
1599         if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA) {
1600             /*
1601              * recursive function call with 'create_empty_fragment' set; this
1602              * prepares and buffers the data for an empty fragment (these
1603              * 'prefix_len' bytes are sent out later together with the actual
1604              * payload)
1605              */
1606             prefix_len = s->method->do_ssl_write(s, type, buf, 0, 1);
1607             if (prefix_len <= 0)
1608                 goto err;
1609
1610             if (s->s3->wbuf.len <
1611                 (size_t)prefix_len + SSL3_RT_MAX_PACKET_SIZE) {
1612                 /* insufficient space */
1613                 SSLerr(SSL_F_DO_DTLS1_WRITE, ERR_R_INTERNAL_ERROR);
1614                 goto err;
1615             }
1616         }
1617
1618         s->s3->empty_fragment_done = 1;
1619     }
1620 #endif
1621     p = wb->buf + prefix_len;
1622
1623     /* write the header */
1624
1625     *(p++) = type & 0xff;
1626     wr->type = type;
1627     /*
1628      * Special case: for hello verify request, client version 1.0 and we
1629      * haven't decided which version to use yet send back using version 1.0
1630      * header: otherwise some clients will ignore it.
1631      */
1632     if (s->method->version == DTLS_ANY_VERSION) {
1633         *(p++) = DTLS1_VERSION >> 8;
1634         *(p++) = DTLS1_VERSION & 0xff;
1635     } else {
1636         *(p++) = s->version >> 8;
1637         *(p++) = s->version & 0xff;
1638     }
1639
1640     /* field where we are to write out packet epoch, seq num and len */
1641     pseq = p;
1642     p += 10;
1643
1644     /* Explicit IV length, block ciphers appropriate version flag */
1645     if (s->enc_write_ctx) {
1646         int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
1647         if (mode == EVP_CIPH_CBC_MODE) {
1648             eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
1649             if (eivlen <= 1)
1650                 eivlen = 0;
1651         }
1652         /* Need explicit part of IV for GCM mode */
1653         else if (mode == EVP_CIPH_GCM_MODE)
1654             eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
1655         else
1656             eivlen = 0;
1657     } else
1658         eivlen = 0;
1659
1660     /* lets setup the record stuff. */
1661     wr->data = p + eivlen;      /* make room for IV in case of CBC */
1662     wr->length = (int)len;
1663     wr->input = (unsigned char *)buf;
1664
1665     /*
1666      * we now 'read' from wr->input, wr->length bytes into wr->data
1667      */
1668
1669     /* first we compress */
1670     if (s->compress != NULL) {
1671         if (!ssl3_do_compress(s)) {
1672             SSLerr(SSL_F_DO_DTLS1_WRITE, SSL_R_COMPRESSION_FAILURE);
1673             goto err;
1674         }
1675     } else {
1676         memcpy(wr->data, wr->input, wr->length);
1677         wr->input = wr->data;
1678     }
1679
1680     /*
1681      * we should still have the output to wr->data and the input from
1682      * wr->input.  Length should be wr->length. wr->data still points in the
1683      * wb->buf
1684      */
1685
1686     if (mac_size != 0) {
1687         if (s->method->ssl3_enc->mac(s, &(p[wr->length + eivlen]), 1) < 0)
1688             goto err;
1689         wr->length += mac_size;
1690     }
1691
1692     /* this is true regardless of mac size */
1693     wr->input = p;
1694     wr->data = p;
1695
1696     if (eivlen)
1697         wr->length += eivlen;
1698
1699     if (s->method->ssl3_enc->enc(s, 1) < 1)
1700         goto err;
1701
1702     /* record length after mac and block padding */
1703     /*
1704      * if (type == SSL3_RT_APPLICATION_DATA || (type == SSL3_RT_ALERT && !
1705      * SSL_in_init(s)))
1706      */
1707
1708     /* there's only one epoch between handshake and app data */
1709
1710     s2n(s->d1->w_epoch, pseq);
1711
1712     /* XDTLS: ?? */
1713     /*
1714      * else s2n(s->d1->handshake_epoch, pseq);
1715      */
1716
1717     memcpy(pseq, &(s->s3->write_sequence[2]), 6);
1718     pseq += 6;
1719     s2n(wr->length, pseq);
1720
1721     if (s->msg_callback)
1722         s->msg_callback(1, 0, SSL3_RT_HEADER, pseq - DTLS1_RT_HEADER_LENGTH,
1723                         DTLS1_RT_HEADER_LENGTH, s, s->msg_callback_arg);
1724
1725     /*
1726      * we should now have wr->data pointing to the encrypted data, which is
1727      * wr->length long
1728      */
1729     wr->type = type;            /* not needed but helps for debugging */
1730     wr->length += DTLS1_RT_HEADER_LENGTH;
1731
1732 #if 0                           /* this is now done at the message layer */
1733     /* buffer the record, making it easy to handle retransmits */
1734     if (type == SSL3_RT_HANDSHAKE || type == SSL3_RT_CHANGE_CIPHER_SPEC)
1735         dtls1_buffer_record(s, wr->data, wr->length,
1736                             *((PQ_64BIT *) & (s->s3->write_sequence[0])));
1737 #endif
1738
1739     ssl3_record_sequence_update(&(s->s3->write_sequence[0]));
1740
1741     if (create_empty_fragment) {
1742         /*
1743          * we are in a recursive call; just return the length, don't write
1744          * out anything here
1745          */
1746         return wr->length;
1747     }
1748
1749     /* now let's set up wb */
1750     wb->left = prefix_len + wr->length;
1751     wb->offset = 0;
1752
1753     /*
1754      * memorize arguments so that ssl3_write_pending can detect bad write
1755      * retries later
1756      */
1757     s->s3->wpend_tot = len;
1758     s->s3->wpend_buf = buf;
1759     s->s3->wpend_type = type;
1760     s->s3->wpend_ret = len;
1761
1762     /* we now just need to write the buffer */
1763     return ssl3_write_pending(s, type, buf, len);
1764  err:
1765     return -1;
1766 }
1767
1768 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap)
1769 {
1770     int cmp;
1771     unsigned int shift;
1772     const unsigned char *seq = s->s3->read_sequence;
1773
1774     cmp = satsub64be(seq, bitmap->max_seq_num);
1775     if (cmp > 0) {
1776         memcpy(s->s3->rrec.seq_num, seq, 8);
1777         return 1;               /* this record in new */
1778     }
1779     shift = -cmp;
1780     if (shift >= sizeof(bitmap->map) * 8)
1781         return 0;               /* stale, outside the window */
1782     else if (bitmap->map & (1UL << shift))
1783         return 0;               /* record previously received */
1784
1785     memcpy(s->s3->rrec.seq_num, seq, 8);
1786     return 1;
1787 }
1788
1789 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap)
1790 {
1791     int cmp;
1792     unsigned int shift;
1793     const unsigned char *seq = s->s3->read_sequence;
1794
1795     cmp = satsub64be(seq, bitmap->max_seq_num);
1796     if (cmp > 0) {
1797         shift = cmp;
1798         if (shift < sizeof(bitmap->map) * 8)
1799             bitmap->map <<= shift, bitmap->map |= 1UL;
1800         else
1801             bitmap->map = 1UL;
1802         memcpy(bitmap->max_seq_num, seq, 8);
1803     } else {
1804         shift = -cmp;
1805         if (shift < sizeof(bitmap->map) * 8)
1806             bitmap->map |= 1UL << shift;
1807     }
1808 }
1809
1810 int dtls1_dispatch_alert(SSL *s)
1811 {
1812     int i, j;
1813     void (*cb) (const SSL *ssl, int type, int val) = NULL;
1814     unsigned char buf[DTLS1_AL_HEADER_LENGTH];
1815     unsigned char *ptr = &buf[0];
1816
1817     s->s3->alert_dispatch = 0;
1818
1819     memset(buf, 0x00, sizeof(buf));
1820     *ptr++ = s->s3->send_alert[0];
1821     *ptr++ = s->s3->send_alert[1];
1822
1823 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1824     if (s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE) {
1825         s2n(s->d1->handshake_read_seq, ptr);
1826 # if 0
1827         if (s->d1->r_msg_hdr.frag_off == 0)
1828             /*
1829              * waiting for a new msg
1830              */
1831             else
1832             s2n(s->d1->r_msg_hdr.seq, ptr); /* partial msg read */
1833 # endif
1834
1835 # if 0
1836         fprintf(stderr,
1837                 "s->d1->handshake_read_seq = %d, s->d1->r_msg_hdr.seq = %d\n",
1838                 s->d1->handshake_read_seq, s->d1->r_msg_hdr.seq);
1839 # endif
1840         l2n3(s->d1->r_msg_hdr.frag_off, ptr);
1841     }
1842 #endif
1843
1844     i = do_dtls1_write(s, SSL3_RT_ALERT, &buf[0], sizeof(buf), 0);
1845     if (i <= 0) {
1846         s->s3->alert_dispatch = 1;
1847         /* fprintf( stderr, "not done with alert\n" ); */
1848     } else {
1849         if (s->s3->send_alert[0] == SSL3_AL_FATAL
1850 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1851             || s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1852 #endif
1853             )
1854             (void)BIO_flush(s->wbio);
1855
1856         if (s->msg_callback)
1857             s->msg_callback(1, s->version, SSL3_RT_ALERT, s->s3->send_alert,
1858                             2, s, s->msg_callback_arg);
1859
1860         if (s->info_callback != NULL)
1861             cb = s->info_callback;
1862         else if (s->ctx->info_callback != NULL)
1863             cb = s->ctx->info_callback;
1864
1865         if (cb != NULL) {
1866             j = (s->s3->send_alert[0] << 8) | s->s3->send_alert[1];
1867             cb(s, SSL_CB_WRITE_ALERT, j);
1868         }
1869     }
1870     return (i);
1871 }
1872
1873 static DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
1874                                       unsigned int *is_next_epoch)
1875 {
1876
1877     *is_next_epoch = 0;
1878
1879     /* In current epoch, accept HM, CCS, DATA, & ALERT */
1880     if (rr->epoch == s->d1->r_epoch)
1881         return &s->d1->bitmap;
1882
1883     /*
1884      * Only HM and ALERT messages can be from the next epoch and only if we
1885      * have already processed all of the unprocessed records from the last
1886      * epoch
1887      */
1888     else if (rr->epoch == (unsigned long)(s->d1->r_epoch + 1) &&
1889              s->d1->unprocessed_rcds.epoch != s->d1->r_epoch &&
1890              (rr->type == SSL3_RT_HANDSHAKE || rr->type == SSL3_RT_ALERT)) {
1891         *is_next_epoch = 1;
1892         return &s->d1->next_bitmap;
1893     }
1894
1895     return NULL;
1896 }
1897
1898 #if 0
1899 static int
1900 dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr,
1901                              unsigned short *priority, unsigned long *offset)
1902 {
1903
1904     /* alerts are passed up immediately */
1905     if (rr->type == SSL3_RT_APPLICATION_DATA || rr->type == SSL3_RT_ALERT)
1906         return 0;
1907
1908     /*
1909      * Only need to buffer if a handshake is underway. (this implies that
1910      * Hello Request and Client Hello are passed up immediately)
1911      */
1912     if (SSL_in_init(s)) {
1913         unsigned char *data = rr->data;
1914         /* need to extract the HM/CCS sequence number here */
1915         if (rr->type == SSL3_RT_HANDSHAKE ||
1916             rr->type == SSL3_RT_CHANGE_CIPHER_SPEC) {
1917             unsigned short seq_num;
1918             struct hm_header_st msg_hdr;
1919             struct ccs_header_st ccs_hdr;
1920
1921             if (rr->type == SSL3_RT_HANDSHAKE) {
1922                 dtls1_get_message_header(data, &msg_hdr);
1923                 seq_num = msg_hdr.seq;
1924                 *offset = msg_hdr.frag_off;
1925             } else {
1926                 dtls1_get_ccs_header(data, &ccs_hdr);
1927                 seq_num = ccs_hdr.seq;
1928                 *offset = 0;
1929             }
1930
1931             /*
1932              * this is either a record we're waiting for, or a retransmit of
1933              * something we happened to previously receive (higher layers
1934              * will drop the repeat silently
1935              */
1936             if (seq_num < s->d1->handshake_read_seq)
1937                 return 0;
1938             if (rr->type == SSL3_RT_HANDSHAKE &&
1939                 seq_num == s->d1->handshake_read_seq &&
1940                 msg_hdr.frag_off < s->d1->r_msg_hdr.frag_off)
1941                 return 0;
1942             else if (seq_num == s->d1->handshake_read_seq &&
1943                      (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC ||
1944                       msg_hdr.frag_off == s->d1->r_msg_hdr.frag_off))
1945                 return 0;
1946             else {
1947                 *priority = seq_num;
1948                 return 1;
1949             }
1950         } else                  /* unknown record type */
1951             return 0;
1952     }
1953
1954     return 0;
1955 }
1956 #endif
1957
1958 void dtls1_reset_seq_numbers(SSL *s, int rw)
1959 {
1960     unsigned char *seq;
1961     unsigned int seq_bytes = sizeof(s->s3->read_sequence);
1962
1963     if (rw & SSL3_CC_READ) {
1964         seq = s->s3->read_sequence;
1965         s->d1->r_epoch++;
1966         memcpy(&(s->d1->bitmap), &(s->d1->next_bitmap), sizeof(DTLS1_BITMAP));
1967         memset(&(s->d1->next_bitmap), 0x00, sizeof(DTLS1_BITMAP));
1968     } else {
1969         seq = s->s3->write_sequence;
1970         memcpy(s->d1->last_write_sequence, seq,
1971                sizeof(s->s3->write_sequence));
1972         s->d1->w_epoch++;
1973     }
1974
1975     memset(seq, 0x00, seq_bytes);
1976 }