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