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 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf,
127 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap,
129 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);
130 static DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
131 unsigned int *is_next_epoch);
133 static int dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr,
134 unsigned short *priority, unsigned long *offset);
136 static int dtls1_buffer_record(SSL *s, record_pqueue *q,
138 static int dtls1_process_record(SSL *s);
139 #if PQ_64BIT_IS_INTEGER
140 static PQ_64BIT bytes_to_long_long(unsigned char *bytes, PQ_64BIT *num);
142 static void dtls1_clear_timeouts(SSL *s);
144 /* copy buffered record into SSL structure */
146 dtls1_copy_record(SSL *s, pitem *item)
148 DTLS1_RECORD_DATA *rdata;
150 rdata = (DTLS1_RECORD_DATA *)item->data;
152 if (s->s3->rbuf.buf != NULL)
153 OPENSSL_free(s->s3->rbuf.buf);
155 s->packet = rdata->packet;
156 s->packet_length = rdata->packet_length;
157 memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
158 memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
165 dtls1_buffer_record(SSL *s, record_pqueue *queue, PQ_64BIT *priority)
167 DTLS1_RECORD_DATA *rdata;
170 /* Limit the size of the queue to prevent DOS attacks */
171 if (pqueue_size(queue->q) >= 100)
174 rdata = OPENSSL_malloc(sizeof(DTLS1_RECORD_DATA));
175 item = pitem_new(*priority, rdata);
176 if (rdata == NULL || item == NULL)
178 if (rdata != NULL) OPENSSL_free(rdata);
179 if (item != NULL) pitem_free(item);
181 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
185 rdata->packet = s->packet;
186 rdata->packet_length = s->packet_length;
187 memcpy(&(rdata->rbuf), &(s->s3->rbuf), sizeof(SSL3_BUFFER));
188 memcpy(&(rdata->rrec), &(s->s3->rrec), sizeof(SSL3_RECORD));
192 /* insert should not fail, since duplicates are dropped */
193 if (pqueue_insert(queue->q, item) == NULL)
201 s->packet_length = 0;
202 memset(&(s->s3->rbuf), 0, sizeof(SSL3_BUFFER));
203 memset(&(s->s3->rrec), 0, sizeof(SSL3_RECORD));
205 if (!ssl3_setup_buffers(s))
207 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
218 dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
222 item = pqueue_pop(queue->q);
225 dtls1_copy_record(s, item);
227 OPENSSL_free(item->data);
237 /* retrieve a buffered record that belongs to the new epoch, i.e., not processed
239 #define dtls1_get_unprocessed_record(s) \
240 dtls1_retrieve_buffered_record((s), \
241 &((s)->d1->unprocessed_rcds))
243 /* retrieve a buffered record that belongs to the current epoch, ie, processed */
244 #define dtls1_get_processed_record(s) \
245 dtls1_retrieve_buffered_record((s), \
246 &((s)->d1->processed_rcds))
249 dtls1_process_buffered_records(SSL *s)
253 item = pqueue_peek(s->d1->unprocessed_rcds.q);
256 DTLS1_RECORD_DATA *rdata;
257 rdata = (DTLS1_RECORD_DATA *)item->data;
259 /* Check if epoch is current. */
260 if (s->d1->unprocessed_rcds.epoch != s->d1->r_epoch)
261 return(1); /* Nothing to do. */
263 /* Process all the records. */
264 while (pqueue_peek(s->d1->unprocessed_rcds.q))
266 dtls1_get_unprocessed_record(s);
267 if ( ! dtls1_process_record(s))
269 dtls1_buffer_record(s, &(s->d1->processed_rcds),
270 &s->s3->rrec.seq_num);
274 /* sync epoch numbers once all the unprocessed records
275 * have been processed */
276 s->d1->processed_rcds.epoch = s->d1->r_epoch;
277 s->d1->unprocessed_rcds.epoch = s->d1->r_epoch + 1;
286 dtls1_get_buffered_record(SSL *s)
290 (((PQ_64BIT)s->d1->handshake_read_seq) << 32) |
291 ((PQ_64BIT)s->d1->r_msg_hdr.frag_off);
293 if ( ! SSL_in_init(s)) /* if we're not (re)negotiating,
298 item = pqueue_peek(s->d1->rcvd_records);
299 if (item && item->priority == priority)
301 /* Check if we've received the record of interest. It must be
302 * a handshake record, since data records as passed up without
304 DTLS1_RECORD_DATA *rdata;
305 item = pqueue_pop(s->d1->rcvd_records);
306 rdata = (DTLS1_RECORD_DATA *)item->data;
308 if (s->s3->rbuf.buf != NULL)
309 OPENSSL_free(s->s3->rbuf.buf);
311 s->packet = rdata->packet;
312 s->packet_length = rdata->packet_length;
313 memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
314 memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
316 OPENSSL_free(item->data);
319 /* s->d1->next_expected_seq_num++; */
329 dtls1_process_record(SSL *s)
336 unsigned int mac_size;
337 unsigned char md[EVP_MAX_MD_SIZE];
343 /* At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
344 * and we have that many bytes in s->packet
346 rr->input= &(s->packet[DTLS1_RT_HEADER_LENGTH]);
348 /* ok, we can now read from 's->packet' data into 'rr'
349 * rr->input points at rr->length bytes, which
350 * need to be copied into rr->data by either
351 * the decryption or by the decompression
352 * When the data is 'copied' into the rr->data buffer,
353 * rr->input will be pointed at the new buffer */
355 /* We now have - encrypted [ MAC [ compressed [ plain ] ] ]
356 * rr->length bytes of encrypted compressed stuff. */
358 /* check is not needed I believe */
359 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
361 al=SSL_AD_RECORD_OVERFLOW;
362 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
366 /* decrypt in place in 'rr->input' */
369 enc_err = s->method->ssl3_enc->enc(s,0);
373 /* SSLerr() and ssl3_send_alert() have been called */
376 /* otherwise enc_err == -1 */
377 goto decryption_failed_or_bad_record_mac;
381 printf("dec %d\n",rr->length);
382 { unsigned int z; for (z=0; z<rr->length; z++) printf("%02X%c",rr->data[z],((z+1)%16)?' ':'\n'); }
386 /* r->length is now the compressed data plus mac */
387 if ( (sess == NULL) ||
388 (s->enc_read_ctx == NULL) ||
389 (s->read_hash == NULL))
394 mac_size=EVP_MD_size(s->read_hash);
396 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH+mac_size)
398 #if 0 /* OK only for stream ciphers (then rr->length is visible from ciphertext anyway) */
399 al=SSL_AD_RECORD_OVERFLOW;
400 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_PRE_MAC_LENGTH_TOO_LONG);
403 goto decryption_failed_or_bad_record_mac;
406 /* check the MAC for rr->input (it's in mac_size bytes at the tail) */
407 if (rr->length < mac_size)
409 #if 0 /* OK only for stream ciphers */
410 al=SSL_AD_DECODE_ERROR;
411 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_LENGTH_TOO_SHORT);
414 goto decryption_failed_or_bad_record_mac;
417 rr->length-=mac_size;
418 i=s->method->ssl3_enc->mac(s,md,0);
419 if (memcmp(md,&(rr->data[rr->length]),mac_size) != 0)
421 goto decryption_failed_or_bad_record_mac;
425 /* r->length is now just compressed */
426 if (s->expand != NULL)
428 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH)
430 al=SSL_AD_RECORD_OVERFLOW;
431 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_COMPRESSED_LENGTH_TOO_LONG);
434 if (!ssl3_do_uncompress(s))
436 al=SSL_AD_DECOMPRESSION_FAILURE;
437 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_BAD_DECOMPRESSION);
442 if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH)
444 al=SSL_AD_RECORD_OVERFLOW;
445 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DATA_LENGTH_TOO_LONG);
450 /* So at this point the following is true
451 * ssl->s3->rrec.type is the type of record
452 * ssl->s3->rrec.length == number of bytes in record
453 * ssl->s3->rrec.off == offset to first valid byte
454 * ssl->s3->rrec.data == where to take bytes from, increment
458 /* we have pulled in a full packet so zero things */
460 dtls1_record_bitmap_update(s, &(s->d1->bitmap));/* Mark receipt of record. */
463 decryption_failed_or_bad_record_mac:
464 /* Separate 'decryption_failed' alert was introduced with TLS 1.0,
465 * SSL 3.0 only has 'bad_record_mac'. But unless a decryption
466 * failure is directly visible from the ciphertext anyway,
467 * we should not reveal which kind of error occured -- this
468 * might become visible to an attacker (e.g. via logfile) */
469 al=SSL_AD_BAD_RECORD_MAC;
470 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
472 ssl3_send_alert(s,SSL3_AL_FATAL,al);
478 /* Call this to get a new input record.
479 * It will return <= 0 if more data is needed, normally due to an error
480 * or non-blocking IO.
481 * When it finishes, one packet has been decoded and can be found in
482 * ssl->s3->rrec.type - is the type of record
483 * ssl->s3->rrec.data, - data
484 * ssl->s3->rrec.length, - number of bytes
486 /* used only by dtls1_read_bytes */
487 int dtls1_get_record(SSL *s)
489 int ssl_major,ssl_minor;
493 unsigned char *p = NULL;
494 unsigned short version;
495 DTLS1_BITMAP *bitmap;
496 unsigned int is_next_epoch;
501 /* The epoch may have changed. If so, process all the
502 * pending records. This is a non-blocking operation. */
503 if ( ! dtls1_process_buffered_records(s))
506 /* if we're renegotiating, then there may be buffered records */
507 if (dtls1_get_processed_record(s))
510 /* get something from the wire */
512 /* check if we have the header */
513 if ( (s->rstate != SSL_ST_READ_BODY) ||
514 (s->packet_length < DTLS1_RT_HEADER_LENGTH))
516 n=ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH, s->s3->rbuf.len, 0);
517 /* read timeout is handled by dtls1_read_bytes */
518 if (n <= 0) return(n); /* error or non-blocking */
520 /* this packet contained a partial record, dump it */
521 if (s->packet_length != DTLS1_RT_HEADER_LENGTH)
523 s->packet_length = 0;
527 s->rstate=SSL_ST_READ_BODY;
531 /* Pull apart the header into the DTLS1_RECORD */
535 version=(ssl_major<<8)|ssl_minor;
537 /* sequence number is 64 bits, with top 2 bytes = epoch */
540 memcpy(&(s->s3->read_sequence[2]), p, 6);
545 /* Lets check version */
546 if (!s->first_packet)
548 if (version != s->version && version != DTLS1_BAD_VER)
550 /* unexpected version, silently discard */
552 s->packet_length = 0;
557 if ((version & 0xff00) != (DTLS1_VERSION & 0xff00) &&
558 (version & 0xff00) != (DTLS1_BAD_VER & 0xff00))
560 /* wrong version, silently discard record */
562 s->packet_length = 0;
566 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
568 /* record too long, silently discard it */
570 s->packet_length = 0;
574 s->client_version = version;
575 /* now s->rstate == SSL_ST_READ_BODY */
578 /* s->rstate == SSL_ST_READ_BODY, get and decode the data */
580 if (rr->length > s->packet_length-DTLS1_RT_HEADER_LENGTH)
582 /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
584 n=ssl3_read_n(s,i,i,1);
585 if (n <= 0) return(n); /* error or non-blocking io */
587 /* this packet contained a partial record, dump it */
591 s->packet_length = 0;
595 /* now n == rr->length,
596 * and s->packet_length == DTLS1_RT_HEADER_LENGTH + rr->length */
598 s->rstate=SSL_ST_READ_HEADER; /* set state for later operations */
600 /* match epochs. NULL means the packet is dropped on the floor */
601 bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
605 s->packet_length = 0; /* dump this record */
606 goto again; /* get another record */
609 /* Check whether this is a repeat, or aged record.
610 * Don't check if we're listening and this message is
611 * a ClientHello. They can look as if they're replayed,
612 * since they arrive from different connections and
613 * would be dropped unnecessarily.
615 if (!(s->d1->listen && rr->type == SSL3_RT_HANDSHAKE &&
616 *p == SSL3_MT_CLIENT_HELLO) &&
617 ! dtls1_record_replay_check(s, bitmap, &(rr->seq_num)))
620 s->packet_length=0; /* dump this record */
621 goto again; /* get another record */
624 /* just read a 0 length packet */
625 if (rr->length == 0) goto again;
627 /* If this record is from the next epoch (either HM or ALERT),
628 * and a handshake is currently in progress, buffer it since it
629 * cannot be processed at this time. */
632 if (SSL_in_init(s) || s->in_handshake)
634 dtls1_buffer_record(s, &(s->d1->unprocessed_rcds), &rr->seq_num);
637 s->packet_length = 0;
641 if ( ! dtls1_process_record(s))
644 dtls1_clear_timeouts(s); /* done waiting */
649 /* Return up to 'len' payload bytes received in 'type' records.
650 * 'type' is one of the following:
652 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
653 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
654 * - 0 (during a shutdown, no data has to be returned)
656 * If we don't have stored data to work from, read a SSL/TLS record first
657 * (possibly multiple records if we still don't have anything to return).
659 * This function must handle any surprises the peer may have for us, such as
660 * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
661 * a surprise, but handled as if it were), or renegotiation requests.
662 * Also if record payloads contain fragments too small to process, we store
663 * them until there is enough for the respective protocol (the record protocol
664 * may use arbitrary fragmentation and even interleaving):
665 * Change cipher spec protocol
666 * just 1 byte needed, no need for keeping anything stored
668 * 2 bytes needed (AlertLevel, AlertDescription)
670 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
671 * to detect unexpected Client Hello and Hello Request messages
672 * here, anything else is handled by higher layers
673 * Application data protocol
674 * none of our business
676 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
681 void (*cb)(const SSL *ssl,int type2,int val)=NULL;
683 if (s->s3->rbuf.buf == NULL) /* Not initialized yet */
684 if (!ssl3_setup_buffers(s))
687 /* XXX: check what the second '&& type' is about */
688 if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
689 (type != SSL3_RT_HANDSHAKE) && type) ||
690 (peek && (type != SSL3_RT_APPLICATION_DATA)))
692 SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
696 /* check whether there's a handshake message (client hello?) waiting */
697 if ( (ret = have_handshake_fragment(s, type, buf, len, peek)))
700 /* Now s->d1->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE. */
702 if (!s->in_handshake && SSL_in_init(s))
704 /* type == SSL3_RT_APPLICATION_DATA */
705 i=s->handshake_func(s);
706 if (i < 0) return(i);
709 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
715 s->rwstate=SSL_NOTHING;
717 /* s->s3->rrec.type - is the type of record
718 * s->s3->rrec.data, - data
719 * s->s3->rrec.off, - offset into 'data' for next read
720 * s->s3->rrec.length, - number of bytes. */
723 /* We are not handshaking and have no data yet,
724 * so process data buffered during the last handshake
725 * in advance, if any.
727 if (s->state == SSL_ST_OK && rr->length == 0)
730 item = pqueue_pop(s->d1->buffered_app_data.q);
733 dtls1_copy_record(s, item);
735 OPENSSL_free(item->data);
740 /* Check for timeout */
741 if (dtls1_handle_timeout(s) > 0)
744 /* get new packet if necessary */
745 if ((rr->length == 0) || (s->rstate == SSL_ST_READ_BODY))
747 ret=dtls1_get_record(s);
750 ret = dtls1_read_failed(s, ret);
751 /* anything other than a timeout is an error */
759 /* we now have a packet which can be read and processed */
761 if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
762 * reset by ssl3_get_finished */
763 && (rr->type != SSL3_RT_HANDSHAKE))
765 /* We now have application data between CCS and Finished.
766 * Most likely the packets were reordered on their way, so
767 * buffer the application data for later processing rather
768 * than dropping the connection.
770 dtls1_buffer_record(s, &(s->d1->buffered_app_data), &rr->seq_num);
775 /* If the other end has shut down, throw anything we read away
776 * (even in 'peek' mode) */
777 if (s->shutdown & SSL_RECEIVED_SHUTDOWN)
780 s->rwstate=SSL_NOTHING;
785 if (type == rr->type) /* SSL3_RT_APPLICATION_DATA or SSL3_RT_HANDSHAKE */
787 /* make sure that we are not getting application data when we
788 * are doing a handshake for the first time */
789 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
790 (s->enc_read_ctx == NULL))
792 al=SSL_AD_UNEXPECTED_MESSAGE;
793 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_APP_DATA_IN_HANDSHAKE);
797 if (len <= 0) return(len);
799 if ((unsigned int)len > rr->length)
802 n = (unsigned int)len;
804 memcpy(buf,&(rr->data[rr->off]),n);
811 s->rstate=SSL_ST_READ_HEADER;
819 /* If we get here, then type != rr->type; if we have a handshake
820 * message, then it was unexpected (Hello Request or Client Hello). */
822 /* In case of record types for which we have 'fragment' storage,
823 * fill that so that we can process the data at a fixed place.
826 unsigned int k, dest_maxlen = 0;
827 unsigned char *dest = NULL;
828 unsigned int *dest_len = NULL;
830 if (rr->type == SSL3_RT_HANDSHAKE)
832 dest_maxlen = sizeof s->d1->handshake_fragment;
833 dest = s->d1->handshake_fragment;
834 dest_len = &s->d1->handshake_fragment_len;
836 else if (rr->type == SSL3_RT_ALERT)
838 dest_maxlen = sizeof(s->d1->alert_fragment);
839 dest = s->d1->alert_fragment;
840 dest_len = &s->d1->alert_fragment_len;
842 /* else it's a CCS message, or application data or wrong */
843 else if (rr->type != SSL3_RT_CHANGE_CIPHER_SPEC)
845 /* Application data while renegotiating
846 * is allowed. Try again reading.
848 if (rr->type == SSL3_RT_APPLICATION_DATA)
851 s->s3->in_read_app_data=2;
853 s->rwstate=SSL_READING;
854 BIO_clear_retry_flags(bio);
855 BIO_set_retry_read(bio);
859 /* Not certain if this is the right error handling */
860 al=SSL_AD_UNEXPECTED_MESSAGE;
861 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
867 /* XDTLS: In a pathalogical case, the Client Hello
868 * may be fragmented--don't always expect dest_maxlen bytes */
869 if ( rr->length < dest_maxlen)
871 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
873 * for normal alerts rr->length is 2, while
874 * dest_maxlen is 7 if we were to handle this
875 * non-existing alert...
879 s->rstate=SSL_ST_READ_HEADER;
884 /* now move 'n' bytes: */
885 for ( k = 0; k < dest_maxlen; k++)
887 dest[k] = rr->data[rr->off++];
890 *dest_len = dest_maxlen;
894 /* s->d1->handshake_fragment_len == 12 iff rr->type == SSL3_RT_HANDSHAKE;
895 * s->d1->alert_fragment_len == 7 iff rr->type == SSL3_RT_ALERT.
896 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.) */
898 /* If we are a client, check for an incoming 'Hello Request': */
900 (s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
901 (s->d1->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
902 (s->session != NULL) && (s->session->cipher != NULL))
904 s->d1->handshake_fragment_len = 0;
906 if ((s->d1->handshake_fragment[1] != 0) ||
907 (s->d1->handshake_fragment[2] != 0) ||
908 (s->d1->handshake_fragment[3] != 0))
910 al=SSL_AD_DECODE_ERROR;
911 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_HELLO_REQUEST);
915 /* no need to check sequence number on HELLO REQUEST messages */
918 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
919 s->d1->handshake_fragment, 4, s, s->msg_callback_arg);
921 if (SSL_is_init_finished(s) &&
922 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
926 if (ssl3_renegotiate_check(s))
928 i=s->handshake_func(s);
929 if (i < 0) return(i);
932 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
936 if (!(s->mode & SSL_MODE_AUTO_RETRY))
938 if (s->s3->rbuf.left == 0) /* no read-ahead left? */
941 /* In the case where we try to read application data,
942 * but we trigger an SSL handshake, we return -1 with
943 * the retry option set. Otherwise renegotiation may
944 * cause nasty problems in the blocking world */
945 s->rwstate=SSL_READING;
947 BIO_clear_retry_flags(bio);
948 BIO_set_retry_read(bio);
954 /* we either finished a handshake or ignored the request,
955 * now try again to obtain the (application) data we were asked for */
959 if (s->d1->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH)
961 int alert_level = s->d1->alert_fragment[0];
962 int alert_descr = s->d1->alert_fragment[1];
964 s->d1->alert_fragment_len = 0;
967 s->msg_callback(0, s->version, SSL3_RT_ALERT,
968 s->d1->alert_fragment, 2, s, s->msg_callback_arg);
970 if (s->info_callback != NULL)
972 else if (s->ctx->info_callback != NULL)
973 cb=s->ctx->info_callback;
977 j = (alert_level << 8) | alert_descr;
978 cb(s, SSL_CB_READ_ALERT, j);
981 if (alert_level == 1) /* warning */
983 s->s3->warn_alert = alert_descr;
984 if (alert_descr == SSL_AD_CLOSE_NOTIFY)
986 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
990 /* XXX: this is a possible improvement in the future */
991 /* now check if it's a missing record */
992 if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
995 unsigned int frag_off;
996 unsigned char *p = &(s->d1->alert_fragment[2]);
1001 dtls1_retransmit_message(s,
1002 dtls1_get_queue_priority(frag->msg_header.seq, 0),
1004 if ( ! found && SSL_in_init(s))
1006 /* fprintf( stderr,"in init = %d\n", SSL_in_init(s)); */
1007 /* requested a message not yet sent,
1008 send an alert ourselves */
1009 ssl3_send_alert(s,SSL3_AL_WARNING,
1010 DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
1015 else if (alert_level == 2) /* fatal */
1019 s->rwstate=SSL_NOTHING;
1020 s->s3->fatal_alert = alert_descr;
1021 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
1022 BIO_snprintf(tmp,sizeof tmp,"%d",alert_descr);
1023 ERR_add_error_data(2,"SSL alert number ",tmp);
1024 s->shutdown|=SSL_RECEIVED_SHUTDOWN;
1025 SSL_CTX_remove_session(s->ctx,s->session);
1030 al=SSL_AD_ILLEGAL_PARAMETER;
1031 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNKNOWN_ALERT_TYPE);
1038 if (s->shutdown & SSL_SENT_SHUTDOWN) /* but we have not received a shutdown */
1040 s->rwstate=SSL_NOTHING;
1045 if (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
1047 struct ccs_header_st ccs_hdr;
1048 unsigned int ccs_hdr_len = DTLS1_CCS_HEADER_LENGTH;
1050 dtls1_get_ccs_header(rr->data, &ccs_hdr);
1052 /* 'Change Cipher Spec' is just a single byte, so we know
1053 * exactly what the record payload has to look like */
1054 /* XDTLS: check that epoch is consistent */
1055 if (s->client_version == DTLS1_BAD_VER || s->version == DTLS1_BAD_VER)
1058 if ((rr->length != ccs_hdr_len) || (rr->off != 0) || (rr->data[0] != SSL3_MT_CCS))
1060 i=SSL_AD_ILLEGAL_PARAMETER;
1061 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_CHANGE_CIPHER_SPEC);
1067 if (s->msg_callback)
1068 s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
1069 rr->data, 1, s, s->msg_callback_arg);
1071 /* We can't process a CCS now, because previous handshake
1072 * messages are still missing, so just drop it.
1074 if (!s->d1->change_cipher_spec_ok)
1079 s->d1->change_cipher_spec_ok = 0;
1081 s->s3->change_cipher_spec=1;
1082 if (!ssl3_do_change_cipher_spec(s))
1085 /* do this whenever CCS is processed */
1086 dtls1_reset_seq_numbers(s, SSL3_CC_READ);
1088 if (s->client_version == DTLS1_BAD_VER)
1089 s->d1->handshake_read_seq++;
1094 /* Unexpected handshake message (Client Hello, or protocol violation) */
1095 if ((s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
1098 struct hm_header_st msg_hdr;
1100 /* this may just be a stale retransmit */
1101 dtls1_get_message_header(rr->data, &msg_hdr);
1102 if( rr->epoch != s->d1->r_epoch)
1108 /* If we are server, we may have a repeated FINISHED of the
1109 * client here, then retransmit our CCS and FINISHED.
1111 if (msg_hdr.type == SSL3_MT_FINISHED)
1113 dtls1_retransmit_buffered_messages(s);
1118 if (((s->state&SSL_ST_MASK) == SSL_ST_OK) &&
1119 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS))
1121 #if 0 /* worked only because C operator preferences are not as expected (and
1122 * because this is not really needed for clients except for detecting
1123 * protocol violations): */
1124 s->state=SSL_ST_BEFORE|(s->server)
1128 s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1132 i=s->handshake_func(s);
1133 if (i < 0) return(i);
1136 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1140 if (!(s->mode & SSL_MODE_AUTO_RETRY))
1142 if (s->s3->rbuf.left == 0) /* no read-ahead left? */
1145 /* In the case where we try to read application data,
1146 * but we trigger an SSL handshake, we return -1 with
1147 * the retry option set. Otherwise renegotiation may
1148 * cause nasty problems in the blocking world */
1149 s->rwstate=SSL_READING;
1150 bio=SSL_get_rbio(s);
1151 BIO_clear_retry_flags(bio);
1152 BIO_set_retry_read(bio);
1162 #ifndef OPENSSL_NO_TLS
1163 /* TLS just ignores unknown message types */
1164 if (s->version == TLS1_VERSION)
1170 al=SSL_AD_UNEXPECTED_MESSAGE;
1171 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1173 case SSL3_RT_CHANGE_CIPHER_SPEC:
1175 case SSL3_RT_HANDSHAKE:
1176 /* we already handled all of these, with the possible exception
1177 * of SSL3_RT_HANDSHAKE when s->in_handshake is set, but that
1178 * should not happen when type != rr->type */
1179 al=SSL_AD_UNEXPECTED_MESSAGE;
1180 SSLerr(SSL_F_DTLS1_READ_BYTES,ERR_R_INTERNAL_ERROR);
1182 case SSL3_RT_APPLICATION_DATA:
1183 /* At this point, we were expecting handshake data,
1184 * but have application data. If the library was
1185 * running inside ssl3_read() (i.e. in_read_app_data
1186 * is set) and it makes sense to read application data
1187 * at this point (session renegotiation not yet started),
1188 * we will indulge it.
1190 if (s->s3->in_read_app_data &&
1191 (s->s3->total_renegotiations != 0) &&
1193 (s->state & SSL_ST_CONNECT) &&
1194 (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1195 (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1197 (s->state & SSL_ST_ACCEPT) &&
1198 (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1199 (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1203 s->s3->in_read_app_data=2;
1208 al=SSL_AD_UNEXPECTED_MESSAGE;
1209 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1216 ssl3_send_alert(s,SSL3_AL_FATAL,al);
1222 dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, int len)
1226 if (SSL_in_init(s) && !s->in_handshake)
1228 i=s->handshake_func(s);
1229 if (i < 0) return(i);
1232 SSLerr(SSL_F_DTLS1_WRITE_APP_DATA_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1237 if (len > SSL3_RT_MAX_PLAIN_LENGTH)
1239 SSLerr(SSL_F_DTLS1_WRITE_APP_DATA_BYTES,SSL_R_DTLS_MESSAGE_TOO_BIG);
1243 i = dtls1_write_bytes(s, type, buf_, len);
1248 /* this only happens when a client hello is received and a handshake
1251 have_handshake_fragment(SSL *s, int type, unsigned char *buf,
1255 if ((type == SSL3_RT_HANDSHAKE) && (s->d1->handshake_fragment_len > 0))
1256 /* (partially) satisfy request from storage */
1258 unsigned char *src = s->d1->handshake_fragment;
1259 unsigned char *dst = buf;
1264 while ((len > 0) && (s->d1->handshake_fragment_len > 0))
1267 len--; s->d1->handshake_fragment_len--;
1270 /* move any remaining fragment bytes: */
1271 for (k = 0; k < s->d1->handshake_fragment_len; k++)
1272 s->d1->handshake_fragment[k] = *src++;
1282 /* Call this to write data in records of type 'type'
1283 * It will return <= 0 if not all data has been sent or non-blocking IO.
1285 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len)
1289 OPENSSL_assert(len <= SSL3_RT_MAX_PLAIN_LENGTH);
1290 s->rwstate=SSL_NOTHING;
1291 i=do_dtls1_write(s, type, buf, len, 0);
1295 int do_dtls1_write(SSL *s, int type, const unsigned char *buf, unsigned int len, int create_empty_fragment)
1297 unsigned char *p,*pseq;
1298 int i,mac_size,clear=0;
1305 /* first check if there is a SSL3_BUFFER still being written
1306 * out. This will happen with non blocking IO */
1307 if (s->s3->wbuf.left != 0)
1309 OPENSSL_assert(0); /* XDTLS: want to see if we ever get here */
1310 return(ssl3_write_pending(s,type,buf,len));
1313 /* If we have an alert to send, lets send it */
1314 if (s->s3->alert_dispatch)
1316 i=s->method->ssl_dispatch_alert(s);
1319 /* if it went, fall through and send more stuff */
1322 if (len == 0 && !create_empty_fragment)
1329 if ( (sess == NULL) ||
1330 (s->enc_write_ctx == NULL) ||
1331 (s->write_hash == NULL))
1337 mac_size=EVP_MD_size(s->write_hash);
1339 /* DTLS implements explicit IV, so no need for empty fragments */
1341 /* 'create_empty_fragment' is true only when this function calls itself */
1342 if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done
1343 && SSL_version(s) != DTLS1_VERSION && SSL_version(s) != DTLS1_BAD_VER)
1345 /* countermeasure against known-IV weakness in CBC ciphersuites
1346 * (see http://www.openssl.org/~bodo/tls-cbc.txt)
1349 if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA)
1351 /* recursive function call with 'create_empty_fragment' set;
1352 * this prepares and buffers the data for an empty fragment
1353 * (these 'prefix_len' bytes are sent out later
1354 * together with the actual payload) */
1355 prefix_len = s->method->do_ssl_write(s, type, buf, 0, 1);
1356 if (prefix_len <= 0)
1359 if (s->s3->wbuf.len < (size_t)prefix_len + SSL3_RT_MAX_PACKET_SIZE)
1361 /* insufficient space */
1362 SSLerr(SSL_F_DO_DTLS1_WRITE, ERR_R_INTERNAL_ERROR);
1367 s->s3->empty_fragment_done = 1;
1371 p = wb->buf + prefix_len;
1373 /* write the header */
1378 if (s->client_version == DTLS1_BAD_VER)
1379 *(p++) = DTLS1_BAD_VER>>8,
1380 *(p++) = DTLS1_BAD_VER&0xff;
1382 *(p++)=(s->version>>8),
1383 *(p++)=s->version&0xff;
1385 /* field where we are to write out packet epoch, seq num and len */
1389 /* lets setup the record stuff. */
1391 /* Make space for the explicit IV in case of CBC.
1392 * (this is a bit of a boundary violation, but what the heck).
1394 if ( s->enc_write_ctx &&
1395 (EVP_CIPHER_mode( s->enc_write_ctx->cipher ) & EVP_CIPH_CBC_MODE))
1396 bs = EVP_CIPHER_block_size(s->enc_write_ctx->cipher);
1400 wr->data=p + bs; /* make room for IV in case of CBC */
1401 wr->length=(int)len;
1402 wr->input=(unsigned char *)buf;
1404 /* we now 'read' from wr->input, wr->length bytes into
1407 /* first we compress */
1408 if (s->compress != NULL)
1410 if (!ssl3_do_compress(s))
1412 SSLerr(SSL_F_DO_DTLS1_WRITE,SSL_R_COMPRESSION_FAILURE);
1418 memcpy(wr->data,wr->input,wr->length);
1422 /* we should still have the output to wr->data and the input
1423 * from wr->input. Length should be wr->length.
1424 * wr->data still points in the wb->buf */
1428 s->method->ssl3_enc->mac(s,&(p[wr->length + bs]),1);
1429 wr->length+=mac_size;
1432 /* this is true regardless of mac size */
1437 /* ssl3_enc can only have an error on read */
1438 if (bs) /* bs != 0 in case of CBC */
1440 RAND_pseudo_bytes(p,bs);
1441 /* master IV and last CBC residue stand for
1442 * the rest of randomness */
1446 s->method->ssl3_enc->enc(s,1);
1448 /* record length after mac and block padding */
1449 /* if (type == SSL3_RT_APPLICATION_DATA ||
1450 (type == SSL3_RT_ALERT && ! SSL_in_init(s))) */
1452 /* there's only one epoch between handshake and app data */
1454 s2n(s->d1->w_epoch, pseq);
1458 s2n(s->d1->handshake_epoch, pseq); */
1460 memcpy(pseq, &(s->s3->write_sequence[2]), 6);
1462 s2n(wr->length,pseq);
1464 /* we should now have
1465 * wr->data pointing to the encrypted data, which is
1466 * wr->length long */
1467 wr->type=type; /* not needed but helps for debugging */
1468 wr->length+=DTLS1_RT_HEADER_LENGTH;
1470 #if 0 /* this is now done at the message layer */
1471 /* buffer the record, making it easy to handle retransmits */
1472 if ( type == SSL3_RT_HANDSHAKE || type == SSL3_RT_CHANGE_CIPHER_SPEC)
1473 dtls1_buffer_record(s, wr->data, wr->length,
1474 *((PQ_64BIT *)&(s->s3->write_sequence[0])));
1477 ssl3_record_sequence_update(&(s->s3->write_sequence[0]));
1479 if (create_empty_fragment)
1481 /* we are in a recursive call;
1482 * just return the length, don't write out anything here
1487 /* now let's set up wb */
1488 wb->left = prefix_len + wr->length;
1491 /* memorize arguments so that ssl3_write_pending can detect bad write retries later */
1492 s->s3->wpend_tot=len;
1493 s->s3->wpend_buf=buf;
1494 s->s3->wpend_type=type;
1495 s->s3->wpend_ret=len;
1497 /* we now just need to write the buffer */
1498 return ssl3_write_pending(s,type,buf,len);
1505 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap,
1508 #if PQ_64BIT_IS_INTEGER
1509 PQ_64BIT mask = 0x0000000000000001L;
1511 PQ_64BIT rcd_num, tmp;
1513 pq_64bit_init(&rcd_num);
1514 pq_64bit_init(&tmp);
1516 /* this is the sequence number for the record just read */
1517 pq_64bit_bin2num(&rcd_num, s->s3->read_sequence, 8);
1520 if (pq_64bit_gt(&rcd_num, &(bitmap->max_seq_num)) ||
1521 pq_64bit_eq(&rcd_num, &(bitmap->max_seq_num)))
1523 pq_64bit_assign(seq_num, &rcd_num);
1524 pq_64bit_free(&rcd_num);
1525 pq_64bit_free(&tmp);
1526 return 1; /* this record is new */
1529 pq_64bit_sub(&tmp, &(bitmap->max_seq_num), &rcd_num);
1531 if ( pq_64bit_get_word(&tmp) > bitmap->length)
1533 pq_64bit_free(&rcd_num);
1534 pq_64bit_free(&tmp);
1535 return 0; /* stale, outside the window */
1538 #if PQ_64BIT_IS_BIGNUM
1541 pq_64bit_sub(&tmp, &(bitmap->max_seq_num), &rcd_num);
1542 pq_64bit_sub_word(&tmp, 1);
1543 offset = pq_64bit_get_word(&tmp);
1544 if ( pq_64bit_is_bit_set(&(bitmap->map), offset))
1546 pq_64bit_free(&rcd_num);
1547 pq_64bit_free(&tmp);
1552 mask <<= (bitmap->max_seq_num - rcd_num - 1);
1553 if (bitmap->map & mask)
1554 return 0; /* record previously received */
1557 pq_64bit_assign(seq_num, &rcd_num);
1558 pq_64bit_free(&rcd_num);
1559 pq_64bit_free(&tmp);
1564 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap)
1571 pq_64bit_init(&rcd_num);
1572 pq_64bit_init(&tmp);
1574 pq_64bit_bin2num(&rcd_num, s->s3->read_sequence, 8);
1576 /* unfortunate code complexity due to 64-bit manipulation support
1577 * on 32-bit machines */
1578 if ( pq_64bit_gt(&rcd_num, &(bitmap->max_seq_num)) ||
1579 pq_64bit_eq(&rcd_num, &(bitmap->max_seq_num)))
1581 pq_64bit_sub(&tmp, &rcd_num, &(bitmap->max_seq_num));
1582 pq_64bit_add_word(&tmp, 1);
1584 shift = (unsigned int)pq_64bit_get_word(&tmp);
1586 pq_64bit_lshift(&(tmp), &(bitmap->map), shift);
1587 pq_64bit_assign(&(bitmap->map), &tmp);
1589 pq_64bit_set_bit(&(bitmap->map), 0);
1590 pq_64bit_add_word(&rcd_num, 1);
1591 pq_64bit_assign(&(bitmap->max_seq_num), &rcd_num);
1593 pq_64bit_assign_word(&tmp, 1);
1594 pq_64bit_lshift(&tmp, &tmp, bitmap->length);
1595 ctx = pq_64bit_ctx_new(&ctx);
1596 pq_64bit_mod(&(bitmap->map), &(bitmap->map), &tmp, ctx);
1597 pq_64bit_ctx_free(ctx);
1601 pq_64bit_sub(&tmp, &(bitmap->max_seq_num), &rcd_num);
1602 pq_64bit_sub_word(&tmp, 1);
1603 shift = (unsigned int)pq_64bit_get_word(&tmp);
1605 pq_64bit_set_bit(&(bitmap->map), shift);
1608 pq_64bit_free(&rcd_num);
1609 pq_64bit_free(&tmp);
1613 int dtls1_dispatch_alert(SSL *s)
1616 void (*cb)(const SSL *ssl,int type,int val)=NULL;
1617 unsigned char buf[DTLS1_AL_HEADER_LENGTH];
1618 unsigned char *ptr = &buf[0];
1620 s->s3->alert_dispatch=0;
1622 memset(buf, 0x00, sizeof(buf));
1623 *ptr++ = s->s3->send_alert[0];
1624 *ptr++ = s->s3->send_alert[1];
1626 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1627 if (s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
1629 s2n(s->d1->handshake_read_seq, ptr);
1631 if ( s->d1->r_msg_hdr.frag_off == 0) /* waiting for a new msg */
1634 s2n(s->d1->r_msg_hdr.seq, ptr); /* partial msg read */
1638 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);
1640 l2n3(s->d1->r_msg_hdr.frag_off, ptr);
1644 i = do_dtls1_write(s, SSL3_RT_ALERT, &buf[0], sizeof(buf), 0);
1647 s->s3->alert_dispatch=1;
1648 /* fprintf( stderr, "not done with alert\n" ); */
1652 if (s->s3->send_alert[0] == SSL3_AL_FATAL
1653 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1654 || s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1657 (void)BIO_flush(s->wbio);
1659 if (s->msg_callback)
1660 s->msg_callback(1, s->version, SSL3_RT_ALERT, s->s3->send_alert,
1661 2, s, s->msg_callback_arg);
1663 if (s->info_callback != NULL)
1664 cb=s->info_callback;
1665 else if (s->ctx->info_callback != NULL)
1666 cb=s->ctx->info_callback;
1670 j=(s->s3->send_alert[0]<<8)|s->s3->send_alert[1];
1671 cb(s,SSL_CB_WRITE_ALERT,j);
1678 static DTLS1_BITMAP *
1679 dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr, unsigned int *is_next_epoch)
1684 /* In current epoch, accept HM, CCS, DATA, & ALERT */
1685 if (rr->epoch == s->d1->r_epoch)
1686 return &s->d1->bitmap;
1688 /* Only HM and ALERT messages can be from the next epoch */
1689 else if (rr->epoch == (unsigned long)(s->d1->r_epoch + 1) &&
1690 (rr->type == SSL3_RT_HANDSHAKE ||
1691 rr->type == SSL3_RT_ALERT))
1694 return &s->d1->next_bitmap;
1702 dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr, unsigned short *priority,
1703 unsigned long *offset)
1706 /* alerts are passed up immediately */
1707 if ( rr->type == SSL3_RT_APPLICATION_DATA ||
1708 rr->type == SSL3_RT_ALERT)
1711 /* Only need to buffer if a handshake is underway.
1712 * (this implies that Hello Request and Client Hello are passed up
1714 if ( SSL_in_init(s))
1716 unsigned char *data = rr->data;
1717 /* need to extract the HM/CCS sequence number here */
1718 if ( rr->type == SSL3_RT_HANDSHAKE ||
1719 rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
1721 unsigned short seq_num;
1722 struct hm_header_st msg_hdr;
1723 struct ccs_header_st ccs_hdr;
1725 if ( rr->type == SSL3_RT_HANDSHAKE)
1727 dtls1_get_message_header(data, &msg_hdr);
1728 seq_num = msg_hdr.seq;
1729 *offset = msg_hdr.frag_off;
1733 dtls1_get_ccs_header(data, &ccs_hdr);
1734 seq_num = ccs_hdr.seq;
1738 /* this is either a record we're waiting for, or a
1739 * retransmit of something we happened to previously
1740 * receive (higher layers will drop the repeat silently */
1741 if ( seq_num < s->d1->handshake_read_seq)
1743 if (rr->type == SSL3_RT_HANDSHAKE &&
1744 seq_num == s->d1->handshake_read_seq &&
1745 msg_hdr.frag_off < s->d1->r_msg_hdr.frag_off)
1747 else if ( seq_num == s->d1->handshake_read_seq &&
1748 (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC ||
1749 msg_hdr.frag_off == s->d1->r_msg_hdr.frag_off))
1753 *priority = seq_num;
1757 else /* unknown record type */
1766 dtls1_reset_seq_numbers(SSL *s, int rw)
1769 unsigned int seq_bytes = sizeof(s->s3->read_sequence);
1771 if ( rw & SSL3_CC_READ)
1773 seq = s->s3->read_sequence;
1776 pq_64bit_assign(&(s->d1->bitmap.map), &(s->d1->next_bitmap.map));
1777 s->d1->bitmap.length = s->d1->next_bitmap.length;
1778 pq_64bit_assign(&(s->d1->bitmap.max_seq_num),
1779 &(s->d1->next_bitmap.max_seq_num));
1781 pq_64bit_free(&(s->d1->next_bitmap.map));
1782 pq_64bit_free(&(s->d1->next_bitmap.max_seq_num));
1783 memset(&(s->d1->next_bitmap), 0x00, sizeof(DTLS1_BITMAP));
1784 pq_64bit_init(&(s->d1->next_bitmap.map));
1785 pq_64bit_init(&(s->d1->next_bitmap.max_seq_num));
1789 seq = s->s3->write_sequence;
1790 memcpy(s->d1->last_write_sequence, seq, sizeof(s->s3->write_sequence));
1794 memset(seq, 0x00, seq_bytes);
1797 #if PQ_64BIT_IS_INTEGER
1799 bytes_to_long_long(unsigned char *bytes, PQ_64BIT *num)
1803 _num = (((PQ_64BIT)bytes[0]) << 56) |
1804 (((PQ_64BIT)bytes[1]) << 48) |
1805 (((PQ_64BIT)bytes[2]) << 40) |
1806 (((PQ_64BIT)bytes[3]) << 32) |
1807 (((PQ_64BIT)bytes[4]) << 24) |
1808 (((PQ_64BIT)bytes[5]) << 16) |
1809 (((PQ_64BIT)bytes[6]) << 8) |
1810 (((PQ_64BIT)bytes[7]) );
1819 dtls1_clear_timeouts(SSL *s)
1821 memset(&(s->d1->timeout), 0x00, sizeof(struct dtls1_timeout_st));