3 * DTLS implementation written by Nagendra Modadugu
4 * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
6 /* ====================================================================
7 * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
59 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
60 * All rights reserved.
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.
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).
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.
80 * Redistribution and use in source and binary forms, with or without
81 * modification, are permitted provided that the following conditions
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)"
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
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.]
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>
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)
129 if (sizeof(long) == 8) do
130 { const union { long one; char little; } is_endian = {1};
133 if (is_endian.little) break;
134 /* not reached on little-endians */
135 /* following test is redundant, because input is
136 * always aligned, but I take no chances... */
137 if (((size_t)v1|(size_t)v2)&0x7) break;
141 if (l>128) return 128;
142 else if (l<-128) return -128;
146 ret = (int)v1[7]-(int)v2[7];
148 brw = ret>>8; /* brw is either 0 or -1 */
151 { brw += (int)v1[i]-(int)v2[i];
158 { brw += (int)v1[i]-(int)v2[i];
163 brw <<= 8; /* brw is either 0 or -256 */
165 if (sat&0xff) return brw | 0x80;
166 else return brw + (ret&0xFF);
169 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
171 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap);
172 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);
173 static DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
174 unsigned int *is_next_epoch);
176 static int dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr,
177 unsigned short *priority, unsigned long *offset);
179 static int dtls1_buffer_record(SSL *s, record_pqueue *q,
180 unsigned char *priority);
181 static int dtls1_process_record(SSL *s);
182 static void dtls1_clear_timeouts(SSL *s);
184 /* copy buffered record into SSL structure */
186 dtls1_copy_record(SSL *s, pitem *item)
188 DTLS1_RECORD_DATA *rdata;
190 rdata = (DTLS1_RECORD_DATA *)item->data;
192 if (s->s3->rbuf.buf != NULL)
193 OPENSSL_free(s->s3->rbuf.buf);
195 s->packet = rdata->packet;
196 s->packet_length = rdata->packet_length;
197 memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
198 memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
205 dtls1_buffer_record(SSL *s, record_pqueue *queue, unsigned char *priority)
207 DTLS1_RECORD_DATA *rdata;
210 rdata = OPENSSL_malloc(sizeof(DTLS1_RECORD_DATA));
211 item = pitem_new(priority, rdata);
212 if (rdata == NULL || item == NULL)
214 if (rdata != NULL) OPENSSL_free(rdata);
215 if (item != NULL) pitem_free(item);
217 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
221 rdata->packet = s->packet;
222 rdata->packet_length = s->packet_length;
223 memcpy(&(rdata->rbuf), &(s->s3->rbuf), sizeof(SSL3_BUFFER));
224 memcpy(&(rdata->rrec), &(s->s3->rrec), sizeof(SSL3_RECORD));
228 /* insert should not fail, since duplicates are dropped */
229 if (pqueue_insert(queue->q, item) == NULL)
237 s->packet_length = 0;
238 memset(&(s->s3->rbuf), 0, sizeof(SSL3_BUFFER));
239 memset(&(s->s3->rrec), 0, sizeof(SSL3_RECORD));
241 if (!ssl3_setup_buffers(s))
243 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
254 dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
258 item = pqueue_pop(queue->q);
261 dtls1_copy_record(s, item);
263 OPENSSL_free(item->data);
273 /* retrieve a buffered record that belongs to the new epoch, i.e., not processed
275 #define dtls1_get_unprocessed_record(s) \
276 dtls1_retrieve_buffered_record((s), \
277 &((s)->d1->unprocessed_rcds))
279 /* retrieve a buffered record that belongs to the current epoch, ie, processed */
280 #define dtls1_get_processed_record(s) \
281 dtls1_retrieve_buffered_record((s), \
282 &((s)->d1->processed_rcds))
285 dtls1_process_buffered_records(SSL *s)
289 item = pqueue_peek(s->d1->unprocessed_rcds.q);
292 DTLS1_RECORD_DATA *rdata;
293 rdata = (DTLS1_RECORD_DATA *)item->data;
295 /* Check if epoch is current. */
296 if (s->d1->unprocessed_rcds.epoch != s->d1->r_epoch)
297 return(1); /* Nothing to do. */
299 /* Process all the records. */
300 while (pqueue_peek(s->d1->unprocessed_rcds.q))
302 dtls1_get_unprocessed_record(s);
303 if ( ! dtls1_process_record(s))
305 dtls1_buffer_record(s, &(s->d1->processed_rcds),
306 s->s3->rrec.seq_num);
310 /* sync epoch numbers once all the unprocessed records
311 * have been processed */
312 s->d1->processed_rcds.epoch = s->d1->r_epoch;
313 s->d1->unprocessed_rcds.epoch = s->d1->r_epoch + 1;
322 dtls1_get_buffered_record(SSL *s)
326 (((PQ_64BIT)s->d1->handshake_read_seq) << 32) |
327 ((PQ_64BIT)s->d1->r_msg_hdr.frag_off);
329 if ( ! SSL_in_init(s)) /* if we're not (re)negotiating,
334 item = pqueue_peek(s->d1->rcvd_records);
335 if (item && item->priority == priority)
337 /* Check if we've received the record of interest. It must be
338 * a handshake record, since data records as passed up without
340 DTLS1_RECORD_DATA *rdata;
341 item = pqueue_pop(s->d1->rcvd_records);
342 rdata = (DTLS1_RECORD_DATA *)item->data;
344 if (s->s3->rbuf.buf != NULL)
345 OPENSSL_free(s->s3->rbuf.buf);
347 s->packet = rdata->packet;
348 s->packet_length = rdata->packet_length;
349 memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
350 memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
352 OPENSSL_free(item->data);
355 /* s->d1->next_expected_seq_num++; */
365 dtls1_process_record(SSL *s)
372 unsigned int mac_size;
373 unsigned char md[EVP_MAX_MD_SIZE];
379 /* At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
380 * and we have that many bytes in s->packet
382 rr->input= &(s->packet[DTLS1_RT_HEADER_LENGTH]);
384 /* ok, we can now read from 's->packet' data into 'rr'
385 * rr->input points at rr->length bytes, which
386 * need to be copied into rr->data by either
387 * the decryption or by the decompression
388 * When the data is 'copied' into the rr->data buffer,
389 * rr->input will be pointed at the new buffer */
391 /* We now have - encrypted [ MAC [ compressed [ plain ] ] ]
392 * rr->length bytes of encrypted compressed stuff. */
394 /* check is not needed I believe */
395 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
397 al=SSL_AD_RECORD_OVERFLOW;
398 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
402 /* decrypt in place in 'rr->input' */
405 enc_err = s->method->ssl3_enc->enc(s,0);
409 /* SSLerr() and ssl3_send_alert() have been called */
412 /* otherwise enc_err == -1 */
413 goto decryption_failed_or_bad_record_mac;
417 printf("dec %d\n",rr->length);
418 { unsigned int z; for (z=0; z<rr->length; z++) printf("%02X%c",rr->data[z],((z+1)%16)?' ':'\n'); }
422 /* r->length is now the compressed data plus mac */
423 if ( (sess == NULL) ||
424 (s->enc_read_ctx == NULL) ||
425 (s->read_hash == NULL))
430 /* !clear => s->read_hash != NULL => mac_size != -1 */
431 mac_size=EVP_MD_CTX_size(s->read_hash);
433 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH+mac_size)
435 #if 0 /* OK only for stream ciphers (then rr->length is visible from ciphertext anyway) */
436 al=SSL_AD_RECORD_OVERFLOW;
437 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_PRE_MAC_LENGTH_TOO_LONG);
440 goto decryption_failed_or_bad_record_mac;
443 /* check the MAC for rr->input (it's in mac_size bytes at the tail) */
444 if (rr->length < mac_size)
446 #if 0 /* OK only for stream ciphers */
447 al=SSL_AD_DECODE_ERROR;
448 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_LENGTH_TOO_SHORT);
451 goto decryption_failed_or_bad_record_mac;
454 rr->length-=mac_size;
455 i=s->method->ssl3_enc->mac(s,md,0);
456 if (memcmp(md,&(rr->data[rr->length]),mac_size) != 0)
458 goto decryption_failed_or_bad_record_mac;
462 /* r->length is now just compressed */
463 if (s->expand != NULL)
465 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH)
467 al=SSL_AD_RECORD_OVERFLOW;
468 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_COMPRESSED_LENGTH_TOO_LONG);
471 if (!ssl3_do_uncompress(s))
473 al=SSL_AD_DECOMPRESSION_FAILURE;
474 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_BAD_DECOMPRESSION);
479 if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH)
481 al=SSL_AD_RECORD_OVERFLOW;
482 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DATA_LENGTH_TOO_LONG);
487 /* So at this point the following is true
488 * ssl->s3->rrec.type is the type of record
489 * ssl->s3->rrec.length == number of bytes in record
490 * ssl->s3->rrec.off == offset to first valid byte
491 * ssl->s3->rrec.data == where to take bytes from, increment
495 /* we have pulled in a full packet so zero things */
497 dtls1_record_bitmap_update(s, &(s->d1->bitmap));/* Mark receipt of record. */
500 decryption_failed_or_bad_record_mac:
501 /* Separate 'decryption_failed' alert was introduced with TLS 1.0,
502 * SSL 3.0 only has 'bad_record_mac'. But unless a decryption
503 * failure is directly visible from the ciphertext anyway,
504 * we should not reveal which kind of error occured -- this
505 * might become visible to an attacker (e.g. via logfile) */
506 al=SSL_AD_BAD_RECORD_MAC;
507 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
509 ssl3_send_alert(s,SSL3_AL_FATAL,al);
515 /* Call this to get a new input record.
516 * It will return <= 0 if more data is needed, normally due to an error
517 * or non-blocking IO.
518 * When it finishes, one packet has been decoded and can be found in
519 * ssl->s3->rrec.type - is the type of record
520 * ssl->s3->rrec.data, - data
521 * ssl->s3->rrec.length, - number of bytes
523 /* used only by dtls1_read_bytes */
524 int dtls1_get_record(SSL *s)
526 int ssl_major,ssl_minor,al;
531 unsigned short version;
532 DTLS1_BITMAP *bitmap;
533 unsigned int is_next_epoch;
538 /* The epoch may have changed. If so, process all the
539 * pending records. This is a non-blocking operation. */
540 if ( ! dtls1_process_buffered_records(s))
543 /* if we're renegotiating, then there may be buffered records */
544 if (dtls1_get_processed_record(s))
547 /* get something from the wire */
549 /* check if we have the header */
550 if ( (s->rstate != SSL_ST_READ_BODY) ||
551 (s->packet_length < DTLS1_RT_HEADER_LENGTH))
553 n=ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH, s->s3->rbuf.len, 0);
554 /* read timeout is handled by dtls1_read_bytes */
555 if (n <= 0) return(n); /* error or non-blocking */
557 OPENSSL_assert(s->packet_length == DTLS1_RT_HEADER_LENGTH);
559 s->rstate=SSL_ST_READ_BODY;
563 /* Pull apart the header into the DTLS1_RECORD */
567 version=(ssl_major<<8)|ssl_minor;
569 /* sequence number is 64 bits, with top 2 bytes = epoch */
572 memcpy(&(s->s3->read_sequence[2]), p, 6);
577 /* Lets check version */
578 if (!s->first_packet)
580 if (version != s->version)
582 SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_WRONG_VERSION_NUMBER);
583 /* Send back error using their
584 * version number :-) */
586 al=SSL_AD_PROTOCOL_VERSION;
591 if ((version & 0xff00) != (DTLS1_VERSION & 0xff00))
593 SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_WRONG_VERSION_NUMBER);
597 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
599 al=SSL_AD_RECORD_OVERFLOW;
600 SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_PACKET_LENGTH_TOO_LONG);
604 /* now s->rstate == SSL_ST_READ_BODY */
607 /* s->rstate == SSL_ST_READ_BODY, get and decode the data */
609 if (rr->length > s->packet_length-DTLS1_RT_HEADER_LENGTH)
611 /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
613 n=ssl3_read_n(s,i,i,1);
614 if (n <= 0) return(n); /* error or non-blocking io */
616 /* this packet contained a partial record, dump it */
619 s->packet_length = 0;
623 /* now n == rr->length,
624 * and s->packet_length == DTLS1_RT_HEADER_LENGTH + rr->length */
626 s->rstate=SSL_ST_READ_HEADER; /* set state for later operations */
628 /* match epochs. NULL means the packet is dropped on the floor */
629 bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
632 s->packet_length = 0; /* dump this record */
633 goto again; /* get another record */
636 /* check whether this is a repeat, or aged record */
637 if ( ! dtls1_record_replay_check(s, bitmap))
640 s->packet_length=0; /* dump this record */
641 goto again; /* get another record */
644 /* just read a 0 length packet */
645 if (rr->length == 0) goto again;
647 /* If this record is from the next epoch (either HM or ALERT),
648 * buffer it since it cannot be processed at this time. Records
649 * from the next epoch are marked as received even though they
650 * are not processed, so as to prevent any potential resource
654 dtls1_record_bitmap_update(s, bitmap);
655 dtls1_buffer_record(s, &(s->d1->unprocessed_rcds), rr->seq_num);
656 s->packet_length = 0;
660 if ( ! dtls1_process_record(s))
663 dtls1_clear_timeouts(s); /* done waiting */
667 ssl3_send_alert(s,SSL3_AL_FATAL,al);
672 /* Return up to 'len' payload bytes received in 'type' records.
673 * 'type' is one of the following:
675 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
676 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
677 * - 0 (during a shutdown, no data has to be returned)
679 * If we don't have stored data to work from, read a SSL/TLS record first
680 * (possibly multiple records if we still don't have anything to return).
682 * This function must handle any surprises the peer may have for us, such as
683 * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
684 * a surprise, but handled as if it were), or renegotiation requests.
685 * Also if record payloads contain fragments too small to process, we store
686 * them until there is enough for the respective protocol (the record protocol
687 * may use arbitrary fragmentation and even interleaving):
688 * Change cipher spec protocol
689 * just 1 byte needed, no need for keeping anything stored
691 * 2 bytes needed (AlertLevel, AlertDescription)
693 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
694 * to detect unexpected Client Hello and Hello Request messages
695 * here, anything else is handled by higher layers
696 * Application data protocol
697 * none of our business
699 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
704 void (*cb)(const SSL *ssl,int type2,int val)=NULL;
706 if (s->s3->rbuf.buf == NULL) /* Not initialized yet */
707 if (!ssl3_setup_buffers(s))
710 /* XXX: check what the second '&& type' is about */
711 if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
712 (type != SSL3_RT_HANDSHAKE) && type) ||
713 (peek && (type != SSL3_RT_APPLICATION_DATA)))
715 SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
719 /* check whether there's a handshake message (client hello?) waiting */
720 if ( (ret = have_handshake_fragment(s, type, buf, len, peek)))
723 /* Now s->d1->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE. */
725 if (!s->in_handshake && SSL_in_init(s))
727 /* type == SSL3_RT_APPLICATION_DATA */
728 i=s->handshake_func(s);
729 if (i < 0) return(i);
732 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
738 s->rwstate=SSL_NOTHING;
740 /* s->s3->rrec.type - is the type of record
741 * s->s3->rrec.data, - data
742 * s->s3->rrec.off, - offset into 'data' for next read
743 * s->s3->rrec.length, - number of bytes. */
746 /* get new packet if necessary */
747 if ((rr->length == 0) || (s->rstate == SSL_ST_READ_BODY))
749 ret=dtls1_get_record(s);
752 ret = dtls1_read_failed(s, ret);
753 /* anything other than a timeout is an error */
761 /* we now have a packet which can be read and processed */
763 if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
764 * reset by ssl3_get_finished */
765 && (rr->type != SSL3_RT_HANDSHAKE))
767 al=SSL_AD_UNEXPECTED_MESSAGE;
768 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_DATA_BETWEEN_CCS_AND_FINISHED);
772 /* If the other end has shut down, throw anything we read away
773 * (even in 'peek' mode) */
774 if (s->shutdown & SSL_RECEIVED_SHUTDOWN)
777 s->rwstate=SSL_NOTHING;
782 if (type == rr->type) /* SSL3_RT_APPLICATION_DATA or SSL3_RT_HANDSHAKE */
784 /* make sure that we are not getting application data when we
785 * are doing a handshake for the first time */
786 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
787 (s->enc_read_ctx == NULL))
789 al=SSL_AD_UNEXPECTED_MESSAGE;
790 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_APP_DATA_IN_HANDSHAKE);
794 if (len <= 0) return(len);
796 if ((unsigned int)len > rr->length)
799 n = (unsigned int)len;
801 memcpy(buf,&(rr->data[rr->off]),n);
808 s->rstate=SSL_ST_READ_HEADER;
816 /* If we get here, then type != rr->type; if we have a handshake
817 * message, then it was unexpected (Hello Request or Client Hello). */
819 /* In case of record types for which we have 'fragment' storage,
820 * fill that so that we can process the data at a fixed place.
823 unsigned int k, dest_maxlen = 0;
824 unsigned char *dest = NULL;
825 unsigned int *dest_len = NULL;
827 if (rr->type == SSL3_RT_HANDSHAKE)
829 dest_maxlen = sizeof s->d1->handshake_fragment;
830 dest = s->d1->handshake_fragment;
831 dest_len = &s->d1->handshake_fragment_len;
833 else if (rr->type == SSL3_RT_ALERT)
835 dest_maxlen = sizeof(s->d1->alert_fragment);
836 dest = s->d1->alert_fragment;
837 dest_len = &s->d1->alert_fragment_len;
839 /* else it's a CCS message, or it's wrong */
840 else if (rr->type != SSL3_RT_CHANGE_CIPHER_SPEC)
842 /* Not certain if this is the right error handling */
843 al=SSL_AD_UNEXPECTED_MESSAGE;
844 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
851 /* XDTLS: In a pathalogical case, the Client Hello
852 * may be fragmented--don't always expect dest_maxlen bytes */
853 if ( rr->length < dest_maxlen)
855 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
857 * for normal alerts rr->length is 2, while
858 * dest_maxlen is 7 if we were to handle this
859 * non-existing alert...
863 s->rstate=SSL_ST_READ_HEADER;
868 /* now move 'n' bytes: */
869 for ( k = 0; k < dest_maxlen; k++)
871 dest[k] = rr->data[rr->off++];
874 *dest_len = dest_maxlen;
878 /* s->d1->handshake_fragment_len == 12 iff rr->type == SSL3_RT_HANDSHAKE;
879 * s->d1->alert_fragment_len == 7 iff rr->type == SSL3_RT_ALERT.
880 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.) */
882 /* If we are a client, check for an incoming 'Hello Request': */
884 (s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
885 (s->d1->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
886 (s->session != NULL) && (s->session->cipher != NULL))
888 s->d1->handshake_fragment_len = 0;
890 if ((s->d1->handshake_fragment[1] != 0) ||
891 (s->d1->handshake_fragment[2] != 0) ||
892 (s->d1->handshake_fragment[3] != 0))
894 al=SSL_AD_DECODE_ERROR;
895 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_HELLO_REQUEST);
899 /* no need to check sequence number on HELLO REQUEST messages */
902 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
903 s->d1->handshake_fragment, 4, s, s->msg_callback_arg);
905 if (SSL_is_init_finished(s) &&
906 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
910 if (ssl3_renegotiate_check(s))
912 i=s->handshake_func(s);
913 if (i < 0) return(i);
916 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
920 if (!(s->mode & SSL_MODE_AUTO_RETRY))
922 if (s->s3->rbuf.left == 0) /* no read-ahead left? */
925 /* In the case where we try to read application data,
926 * but we trigger an SSL handshake, we return -1 with
927 * the retry option set. Otherwise renegotiation may
928 * cause nasty problems in the blocking world */
929 s->rwstate=SSL_READING;
931 BIO_clear_retry_flags(bio);
932 BIO_set_retry_read(bio);
938 /* we either finished a handshake or ignored the request,
939 * now try again to obtain the (application) data we were asked for */
943 if (s->d1->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH)
945 int alert_level = s->d1->alert_fragment[0];
946 int alert_descr = s->d1->alert_fragment[1];
948 s->d1->alert_fragment_len = 0;
951 s->msg_callback(0, s->version, SSL3_RT_ALERT,
952 s->d1->alert_fragment, 2, s, s->msg_callback_arg);
954 if (s->info_callback != NULL)
956 else if (s->ctx->info_callback != NULL)
957 cb=s->ctx->info_callback;
961 j = (alert_level << 8) | alert_descr;
962 cb(s, SSL_CB_READ_ALERT, j);
965 if (alert_level == 1) /* warning */
967 s->s3->warn_alert = alert_descr;
968 if (alert_descr == SSL_AD_CLOSE_NOTIFY)
970 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
974 /* XXX: this is a possible improvement in the future */
975 /* now check if it's a missing record */
976 if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
979 unsigned int frag_off;
980 unsigned char *p = &(s->d1->alert_fragment[2]);
985 dtls1_retransmit_message(s, seq, frag_off, &found);
986 if ( ! found && SSL_in_init(s))
988 /* fprintf( stderr,"in init = %d\n", SSL_in_init(s)); */
989 /* requested a message not yet sent,
990 send an alert ourselves */
991 ssl3_send_alert(s,SSL3_AL_WARNING,
992 DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
997 else if (alert_level == 2) /* fatal */
1001 s->rwstate=SSL_NOTHING;
1002 s->s3->fatal_alert = alert_descr;
1003 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
1004 BIO_snprintf(tmp,sizeof tmp,"%d",alert_descr);
1005 ERR_add_error_data(2,"SSL alert number ",tmp);
1006 s->shutdown|=SSL_RECEIVED_SHUTDOWN;
1007 SSL_CTX_remove_session(s->ctx,s->session);
1012 al=SSL_AD_ILLEGAL_PARAMETER;
1013 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNKNOWN_ALERT_TYPE);
1020 if (s->shutdown & SSL_SENT_SHUTDOWN) /* but we have not received a shutdown */
1022 s->rwstate=SSL_NOTHING;
1027 if (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
1029 struct ccs_header_st ccs_hdr;
1031 dtls1_get_ccs_header(rr->data, &ccs_hdr);
1033 /* 'Change Cipher Spec' is just a single byte, so we know
1034 * exactly what the record payload has to look like */
1035 /* XDTLS: check that epoch is consistent */
1036 if ( (rr->length != DTLS1_CCS_HEADER_LENGTH) ||
1037 (rr->off != 0) || (rr->data[0] != SSL3_MT_CCS))
1039 i=SSL_AD_ILLEGAL_PARAMETER;
1040 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_CHANGE_CIPHER_SPEC);
1046 if (s->msg_callback)
1047 s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
1048 rr->data, 1, s, s->msg_callback_arg);
1050 s->s3->change_cipher_spec=1;
1051 if (!ssl3_do_change_cipher_spec(s))
1054 /* do this whenever CCS is processed */
1055 dtls1_reset_seq_numbers(s, SSL3_CC_READ);
1060 /* Unexpected handshake message (Client Hello, or protocol violation) */
1061 if ((s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
1064 struct hm_header_st msg_hdr;
1066 /* this may just be a stale retransmit */
1067 dtls1_get_message_header(rr->data, &msg_hdr);
1068 if( rr->epoch != s->d1->r_epoch)
1074 if (((s->state&SSL_ST_MASK) == SSL_ST_OK) &&
1075 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS))
1077 #if 0 /* worked only because C operator preferences are not as expected (and
1078 * because this is not really needed for clients except for detecting
1079 * protocol violations): */
1080 s->state=SSL_ST_BEFORE|(s->server)
1084 s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1088 i=s->handshake_func(s);
1089 if (i < 0) return(i);
1092 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1096 if (!(s->mode & SSL_MODE_AUTO_RETRY))
1098 if (s->s3->rbuf.left == 0) /* no read-ahead left? */
1101 /* In the case where we try to read application data,
1102 * but we trigger an SSL handshake, we return -1 with
1103 * the retry option set. Otherwise renegotiation may
1104 * cause nasty problems in the blocking world */
1105 s->rwstate=SSL_READING;
1106 bio=SSL_get_rbio(s);
1107 BIO_clear_retry_flags(bio);
1108 BIO_set_retry_read(bio);
1118 #ifndef OPENSSL_NO_TLS
1119 /* TLS just ignores unknown message types */
1120 if (s->version == TLS1_VERSION)
1126 al=SSL_AD_UNEXPECTED_MESSAGE;
1127 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1129 case SSL3_RT_CHANGE_CIPHER_SPEC:
1131 case SSL3_RT_HANDSHAKE:
1132 /* we already handled all of these, with the possible exception
1133 * of SSL3_RT_HANDSHAKE when s->in_handshake is set, but that
1134 * should not happen when type != rr->type */
1135 al=SSL_AD_UNEXPECTED_MESSAGE;
1136 SSLerr(SSL_F_DTLS1_READ_BYTES,ERR_R_INTERNAL_ERROR);
1138 case SSL3_RT_APPLICATION_DATA:
1139 /* At this point, we were expecting handshake data,
1140 * but have application data. If the library was
1141 * running inside ssl3_read() (i.e. in_read_app_data
1142 * is set) and it makes sense to read application data
1143 * at this point (session renegotiation not yet started),
1144 * we will indulge it.
1146 if (s->s3->in_read_app_data &&
1147 (s->s3->total_renegotiations != 0) &&
1149 (s->state & SSL_ST_CONNECT) &&
1150 (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1151 (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1153 (s->state & SSL_ST_ACCEPT) &&
1154 (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1155 (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1159 s->s3->in_read_app_data=2;
1164 al=SSL_AD_UNEXPECTED_MESSAGE;
1165 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1172 ssl3_send_alert(s,SSL3_AL_FATAL,al);
1178 dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, int len)
1183 if (SSL_in_init(s) && !s->in_handshake)
1185 i=s->handshake_func(s);
1186 if (i < 0) return(i);
1189 SSLerr(SSL_F_DTLS1_WRITE_APP_DATA_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1199 /* dtls1_write_bytes sends one record at a time, sized according to
1200 * the currently known MTU */
1201 i = dtls1_write_bytes(s, type, buf_, len);
1202 if (i <= 0) return i;
1204 if ((i == (int)n) ||
1205 (type == SSL3_RT_APPLICATION_DATA &&
1206 (s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE)))
1208 /* next chunk of data should get another prepended empty fragment
1209 * in ciphersuites with known-IV weakness: */
1210 s->s3->empty_fragment_done = 0;
1222 /* this only happens when a client hello is received and a handshake
1225 have_handshake_fragment(SSL *s, int type, unsigned char *buf,
1229 if ((type == SSL3_RT_HANDSHAKE) && (s->d1->handshake_fragment_len > 0))
1230 /* (partially) satisfy request from storage */
1232 unsigned char *src = s->d1->handshake_fragment;
1233 unsigned char *dst = buf;
1238 while ((len > 0) && (s->d1->handshake_fragment_len > 0))
1241 len--; s->d1->handshake_fragment_len--;
1244 /* move any remaining fragment bytes: */
1245 for (k = 0; k < s->d1->handshake_fragment_len; k++)
1246 s->d1->handshake_fragment[k] = *src++;
1256 /* Call this to write data in records of type 'type'
1257 * It will return <= 0 if not all data has been sent or non-blocking IO.
1259 int dtls1_write_bytes(SSL *s, int type, const void *buf_, int len)
1261 const unsigned char *buf=buf_;
1262 unsigned int tot,n,nw;
1266 s->rwstate=SSL_NOTHING;
1271 /* handshake layer figures out MTU for itself, but data records
1272 * are also sent through this interface, so need to figure out MTU */
1274 mtu = BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_MTU, 0, NULL);
1275 mtu += DTLS1_HM_HEADER_LENGTH; /* HM already inserted */
1279 if (mtu > SSL3_RT_MAX_PLAIN_LENGTH)
1280 mtu = SSL3_RT_MAX_PLAIN_LENGTH;
1287 i=do_dtls1_write(s, type, &(buf[tot]), nw, 0);
1294 if ( (int)s->s3->wnum + i == len)
1302 int do_dtls1_write(SSL *s, int type, const unsigned char *buf, unsigned int len, int create_empty_fragment)
1304 unsigned char *p,*pseq;
1305 int i,mac_size,clear=0;
1312 /* first check if there is a SSL3_BUFFER still being written
1313 * out. This will happen with non blocking IO */
1314 if (s->s3->wbuf.left != 0)
1316 OPENSSL_assert(0); /* XDTLS: want to see if we ever get here */
1317 return(ssl3_write_pending(s,type,buf,len));
1320 /* If we have an alert to send, lets send it */
1321 if (s->s3->alert_dispatch)
1323 i=s->method->ssl_dispatch_alert(s);
1326 /* if it went, fall through and send more stuff */
1329 if (len == 0 && !create_empty_fragment)
1336 if ( (sess == NULL) ||
1337 (s->enc_write_ctx == NULL) ||
1338 (EVP_MD_CTX_md(s->write_hash) == NULL))
1344 mac_size=EVP_MD_CTX_size(s->write_hash);
1346 /* DTLS implements explicit IV, so no need for empty fragments */
1348 /* 'create_empty_fragment' is true only when this function calls itself */
1349 if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done
1350 && SSL_version(s) != DTLS1_VERSION)
1352 /* countermeasure against known-IV weakness in CBC ciphersuites
1353 * (see http://www.openssl.org/~bodo/tls-cbc.txt)
1356 if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA)
1358 /* recursive function call with 'create_empty_fragment' set;
1359 * this prepares and buffers the data for an empty fragment
1360 * (these 'prefix_len' bytes are sent out later
1361 * together with the actual payload) */
1362 prefix_len = s->method->do_ssl_write(s, type, buf, 0, 1);
1363 if (prefix_len <= 0)
1366 if (s->s3->wbuf.len < (size_t)prefix_len + SSL3_RT_MAX_PACKET_SIZE)
1368 /* insufficient space */
1369 SSLerr(SSL_F_DO_DTLS1_WRITE, ERR_R_INTERNAL_ERROR);
1374 s->s3->empty_fragment_done = 1;
1378 p = wb->buf + prefix_len;
1380 /* write the header */
1385 *(p++)=(s->version>>8);
1386 *(p++)=s->version&0xff;
1388 /* field where we are to write out packet epoch, seq num and len */
1392 /* lets setup the record stuff. */
1394 /* Make space for the explicit IV in case of CBC.
1395 * (this is a bit of a boundary violation, but what the heck).
1397 if ( s->enc_write_ctx &&
1398 (EVP_CIPHER_mode( s->enc_write_ctx->cipher ) & EVP_CIPH_CBC_MODE))
1399 bs = EVP_CIPHER_block_size(s->enc_write_ctx->cipher);
1403 wr->data=p + bs; /* make room for IV in case of CBC */
1404 wr->length=(int)len;
1405 wr->input=(unsigned char *)buf;
1407 /* we now 'read' from wr->input, wr->length bytes into
1410 /* first we compress */
1411 if (s->compress != NULL)
1413 if (!ssl3_do_compress(s))
1415 SSLerr(SSL_F_DO_DTLS1_WRITE,SSL_R_COMPRESSION_FAILURE);
1421 memcpy(wr->data,wr->input,wr->length);
1425 /* we should still have the output to wr->data and the input
1426 * from wr->input. Length should be wr->length.
1427 * wr->data still points in the wb->buf */
1431 s->method->ssl3_enc->mac(s,&(p[wr->length + bs]),1);
1432 wr->length+=mac_size;
1435 /* this is true regardless of mac size */
1440 /* ssl3_enc can only have an error on read */
1441 if (bs) /* bs != 0 in case of CBC */
1443 RAND_pseudo_bytes(p,bs);
1444 /* master IV and last CBC residue stand for
1445 * the rest of randomness */
1449 s->method->ssl3_enc->enc(s,1);
1451 /* record length after mac and block padding */
1452 /* if (type == SSL3_RT_APPLICATION_DATA ||
1453 (type == SSL3_RT_ALERT && ! SSL_in_init(s))) */
1455 /* there's only one epoch between handshake and app data */
1457 s2n(s->d1->w_epoch, pseq);
1461 s2n(s->d1->handshake_epoch, pseq); */
1463 memcpy(pseq, &(s->s3->write_sequence[2]), 6);
1465 s2n(wr->length,pseq);
1467 /* we should now have
1468 * wr->data pointing to the encrypted data, which is
1469 * wr->length long */
1470 wr->type=type; /* not needed but helps for debugging */
1471 wr->length+=DTLS1_RT_HEADER_LENGTH;
1473 #if 0 /* this is now done at the message layer */
1474 /* buffer the record, making it easy to handle retransmits */
1475 if ( type == SSL3_RT_HANDSHAKE || type == SSL3_RT_CHANGE_CIPHER_SPEC)
1476 dtls1_buffer_record(s, wr->data, wr->length,
1477 *((PQ_64BIT *)&(s->s3->write_sequence[0])));
1480 ssl3_record_sequence_update(&(s->s3->write_sequence[0]));
1482 if (create_empty_fragment)
1484 /* we are in a recursive call;
1485 * just return the length, don't write out anything here
1490 /* now let's set up wb */
1491 wb->left = prefix_len + wr->length;
1494 /* memorize arguments so that ssl3_write_pending can detect bad write retries later */
1495 s->s3->wpend_tot=len;
1496 s->s3->wpend_buf=buf;
1497 s->s3->wpend_type=type;
1498 s->s3->wpend_ret=len;
1500 /* we now just need to write the buffer */
1501 return ssl3_write_pending(s,type,buf,len);
1508 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap)
1512 const unsigned char *seq = s->s3->read_sequence;
1514 cmp = satsub64be(seq,bitmap->max_seq_num);
1517 memcpy (s->s3->rrec.seq_num,seq,8);
1518 return 1; /* this record in new */
1521 if (shift >= sizeof(bitmap->map)*8)
1522 return 0; /* stale, outside the window */
1523 else if (bitmap->map & (1UL<<shift))
1524 return 0; /* record previously received */
1526 memcpy (s->s3->rrec.seq_num,seq,8);
1531 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap)
1535 const unsigned char *seq = s->s3->read_sequence;
1537 cmp = satsub64be(seq,bitmap->max_seq_num);
1541 if (shift < sizeof(bitmap->map)*8)
1542 bitmap->map <<= shift, bitmap->map |= 1UL;
1545 memcpy(bitmap->max_seq_num,seq,8);
1549 if (shift < sizeof(bitmap->map)*8)
1550 bitmap->map |= 1UL<<shift;
1555 int dtls1_dispatch_alert(SSL *s)
1558 void (*cb)(const SSL *ssl,int type,int val)=NULL;
1559 unsigned char buf[DTLS1_AL_HEADER_LENGTH];
1560 unsigned char *ptr = &buf[0];
1562 s->s3->alert_dispatch=0;
1564 memset(buf, 0x00, sizeof(buf));
1565 *ptr++ = s->s3->send_alert[0];
1566 *ptr++ = s->s3->send_alert[1];
1568 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1569 if (s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
1571 s2n(s->d1->handshake_read_seq, ptr);
1573 if ( s->d1->r_msg_hdr.frag_off == 0) /* waiting for a new msg */
1576 s2n(s->d1->r_msg_hdr.seq, ptr); /* partial msg read */
1580 fprintf(stderr, "s->d1->handshake_read_seq = %d, s->d1->r_msg_hdr.seq = %d\n",s->d1->handshake_read_seq,s->d1->r_msg_hdr.seq);
1582 l2n3(s->d1->r_msg_hdr.frag_off, ptr);
1586 i = do_dtls1_write(s, SSL3_RT_ALERT, &buf[0], sizeof(buf), 0);
1589 s->s3->alert_dispatch=1;
1590 /* fprintf( stderr, "not done with alert\n" ); */
1594 if (s->s3->send_alert[0] == SSL3_AL_FATAL
1595 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1596 || s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1599 (void)BIO_flush(s->wbio);
1601 if (s->msg_callback)
1602 s->msg_callback(1, s->version, SSL3_RT_ALERT, s->s3->send_alert,
1603 2, s, s->msg_callback_arg);
1605 if (s->info_callback != NULL)
1606 cb=s->info_callback;
1607 else if (s->ctx->info_callback != NULL)
1608 cb=s->ctx->info_callback;
1612 j=(s->s3->send_alert[0]<<8)|s->s3->send_alert[1];
1613 cb(s,SSL_CB_WRITE_ALERT,j);
1620 static DTLS1_BITMAP *
1621 dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr, unsigned int *is_next_epoch)
1626 /* In current epoch, accept HM, CCS, DATA, & ALERT */
1627 if (rr->epoch == s->d1->r_epoch)
1628 return &s->d1->bitmap;
1630 /* Only HM and ALERT messages can be from the next epoch */
1631 else if (rr->epoch == (unsigned long)(s->d1->r_epoch + 1) &&
1632 (rr->type == SSL3_RT_HANDSHAKE ||
1633 rr->type == SSL3_RT_ALERT))
1636 return &s->d1->next_bitmap;
1644 dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr, unsigned short *priority,
1645 unsigned long *offset)
1648 /* alerts are passed up immediately */
1649 if ( rr->type == SSL3_RT_APPLICATION_DATA ||
1650 rr->type == SSL3_RT_ALERT)
1653 /* Only need to buffer if a handshake is underway.
1654 * (this implies that Hello Request and Client Hello are passed up
1656 if ( SSL_in_init(s))
1658 unsigned char *data = rr->data;
1659 /* need to extract the HM/CCS sequence number here */
1660 if ( rr->type == SSL3_RT_HANDSHAKE ||
1661 rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
1663 unsigned short seq_num;
1664 struct hm_header_st msg_hdr;
1665 struct ccs_header_st ccs_hdr;
1667 if ( rr->type == SSL3_RT_HANDSHAKE)
1669 dtls1_get_message_header(data, &msg_hdr);
1670 seq_num = msg_hdr.seq;
1671 *offset = msg_hdr.frag_off;
1675 dtls1_get_ccs_header(data, &ccs_hdr);
1676 seq_num = ccs_hdr.seq;
1680 /* this is either a record we're waiting for, or a
1681 * retransmit of something we happened to previously
1682 * receive (higher layers will drop the repeat silently */
1683 if ( seq_num < s->d1->handshake_read_seq)
1685 if (rr->type == SSL3_RT_HANDSHAKE &&
1686 seq_num == s->d1->handshake_read_seq &&
1687 msg_hdr.frag_off < s->d1->r_msg_hdr.frag_off)
1689 else if ( seq_num == s->d1->handshake_read_seq &&
1690 (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC ||
1691 msg_hdr.frag_off == s->d1->r_msg_hdr.frag_off))
1695 *priority = seq_num;
1699 else /* unknown record type */
1708 dtls1_reset_seq_numbers(SSL *s, int rw)
1711 unsigned int seq_bytes = sizeof(s->s3->read_sequence);
1713 if ( rw & SSL3_CC_READ)
1715 seq = s->s3->read_sequence;
1717 memcpy(&(s->d1->bitmap), &(s->d1->next_bitmap), sizeof(DTLS1_BITMAP));
1718 memset(&(s->d1->next_bitmap), 0x00, sizeof(DTLS1_BITMAP));
1722 seq = s->s3->write_sequence;
1726 memset(seq, 0x00, seq_bytes);
1731 dtls1_clear_timeouts(SSL *s)
1733 memset(&(s->d1->timeout), 0x00, sizeof(struct dtls1_timeout_st));