williamr@2: /* ssl/dtls1.h */ williamr@2: /* williamr@2: * DTLS implementation written by Nagendra Modadugu williamr@2: * (nagendra@cs.stanford.edu) for the OpenSSL project 2005. williamr@2: */ williamr@2: /* ==================================================================== williamr@2: * Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved. williamr@2: * williamr@2: * Redistribution and use in source and binary forms, with or without williamr@2: * modification, are permitted provided that the following conditions williamr@2: * are met: williamr@2: * williamr@2: * 1. Redistributions of source code must retain the above copyright williamr@2: * notice, this list of conditions and the following disclaimer. williamr@2: * williamr@2: * 2. Redistributions in binary form must reproduce the above copyright williamr@2: * notice, this list of conditions and the following disclaimer in williamr@2: * the documentation and/or other materials provided with the williamr@2: * distribution. williamr@2: * williamr@2: * 3. All advertising materials mentioning features or use of this williamr@2: * software must display the following acknowledgment: williamr@2: * "This product includes software developed by the OpenSSL Project williamr@2: * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" williamr@2: * williamr@2: * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to williamr@2: * endorse or promote products derived from this software without williamr@2: * prior written permission. For written permission, please contact williamr@2: * openssl-core@OpenSSL.org. williamr@2: * williamr@2: * 5. Products derived from this software may not be called "OpenSSL" williamr@2: * nor may "OpenSSL" appear in their names without prior written williamr@2: * permission of the OpenSSL Project. williamr@2: * williamr@2: * 6. Redistributions of any form whatsoever must retain the following williamr@2: * acknowledgment: williamr@2: * "This product includes software developed by the OpenSSL Project williamr@2: * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" williamr@2: * williamr@2: * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY williamr@2: * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE williamr@2: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR williamr@2: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR williamr@2: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, williamr@2: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT williamr@2: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; williamr@2: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) williamr@2: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, williamr@2: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) williamr@2: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED williamr@2: * OF THE POSSIBILITY OF SUCH DAMAGE. williamr@2: * ==================================================================== williamr@2: * williamr@2: * This product includes cryptographic software written by Eric Young williamr@2: * (eay@cryptsoft.com). This product includes software written by Tim williamr@2: * Hudson (tjh@cryptsoft.com). williamr@2: * williamr@2: */ williamr@2: williamr@2: #ifndef HEADER_DTLS1_H williamr@2: #define HEADER_DTLS1_H williamr@2: williamr@2: #include williamr@2: #include williamr@2: williamr@2: #ifdef __cplusplus williamr@2: extern "C" { williamr@2: #endif williamr@2: williamr@2: #define DTLS1_VERSION 0xFEFF williamr@2: #define DTLS1_BAD_VER 0x0100 williamr@2: williamr@2: #define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE 110 williamr@2: williamr@2: /* lengths of messages */ williamr@2: #define DTLS1_COOKIE_LENGTH 32 williamr@2: williamr@2: #define DTLS1_RT_HEADER_LENGTH 13 williamr@2: williamr@2: #define DTLS1_HM_HEADER_LENGTH 12 williamr@2: williamr@2: #define DTLS1_HM_BAD_FRAGMENT -2 williamr@2: #define DTLS1_HM_FRAGMENT_RETRY -3 williamr@2: williamr@2: #define DTLS1_CCS_HEADER_LENGTH 1 williamr@2: williamr@2: #define DTLS1_AL_HEADER_LENGTH 7 williamr@2: williamr@2: williamr@2: typedef struct dtls1_bitmap_st williamr@2: { williamr@2: PQ_64BIT map; williamr@2: unsigned long length; /* sizeof the bitmap in bits */ williamr@2: PQ_64BIT max_seq_num; /* max record number seen so far */ williamr@2: } DTLS1_BITMAP; williamr@2: williamr@2: struct hm_header_st williamr@2: { williamr@2: unsigned char type; williamr@2: unsigned long msg_len; williamr@2: unsigned short seq; williamr@2: unsigned long frag_off; williamr@2: unsigned long frag_len; williamr@2: unsigned int is_ccs; williamr@2: }; williamr@2: williamr@2: struct ccs_header_st williamr@2: { williamr@2: unsigned char type; williamr@2: unsigned short seq; williamr@2: }; williamr@2: williamr@2: struct dtls1_timeout_st williamr@2: { williamr@2: /* Number of read timeouts so far */ williamr@2: unsigned int read_timeouts; williamr@2: williamr@2: /* Number of write timeouts so far */ williamr@2: unsigned int write_timeouts; williamr@2: williamr@2: /* Number of alerts received so far */ williamr@2: unsigned int num_alerts; williamr@2: }; williamr@2: williamr@2: typedef struct record_pqueue_st williamr@2: { williamr@2: unsigned short epoch; williamr@2: pqueue q; williamr@2: } record_pqueue; williamr@2: williamr@2: typedef struct hm_fragment_st williamr@2: { williamr@2: struct hm_header_st msg_header; williamr@2: unsigned char *fragment; williamr@2: } hm_fragment; williamr@2: williamr@2: typedef struct dtls1_state_st williamr@2: { williamr@2: unsigned int send_cookie; williamr@2: unsigned char cookie[DTLS1_COOKIE_LENGTH]; williamr@2: unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH]; williamr@2: unsigned int cookie_len; williamr@2: williamr@2: /* williamr@2: * The current data and handshake epoch. This is initially williamr@2: * undefined, and starts at zero once the initial handshake is williamr@2: * completed williamr@2: */ williamr@2: unsigned short r_epoch; williamr@2: unsigned short w_epoch; williamr@2: williamr@2: /* records being received in the current epoch */ williamr@2: DTLS1_BITMAP bitmap; williamr@2: williamr@2: /* renegotiation starts a new set of sequence numbers */ williamr@2: DTLS1_BITMAP next_bitmap; williamr@2: williamr@2: /* handshake message numbers */ williamr@2: unsigned short handshake_write_seq; williamr@2: unsigned short next_handshake_write_seq; williamr@2: williamr@2: unsigned short handshake_read_seq; williamr@2: williamr@2: /* Received handshake records (processed and unprocessed) */ williamr@2: record_pqueue unprocessed_rcds; williamr@2: record_pqueue processed_rcds; williamr@2: williamr@2: /* Buffered handshake messages */ williamr@2: pqueue buffered_messages; williamr@2: williamr@2: /* Buffered (sent) handshake records */ williamr@2: pqueue sent_messages; williamr@2: williamr@2: unsigned int mtu; /* max wire packet size */ williamr@2: williamr@2: struct hm_header_st w_msg_hdr; williamr@2: struct hm_header_st r_msg_hdr; williamr@2: williamr@2: struct dtls1_timeout_st timeout; williamr@2: williamr@2: /* storage for Alert/Handshake protocol data received but not williamr@2: * yet processed by ssl3_read_bytes: */ williamr@2: unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH]; williamr@2: unsigned int alert_fragment_len; williamr@2: unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH]; williamr@2: unsigned int handshake_fragment_len; williamr@2: williamr@2: unsigned int retransmitting; williamr@2: williamr@2: } DTLS1_STATE; williamr@2: williamr@2: typedef struct dtls1_record_data_st williamr@2: { williamr@2: unsigned char *packet; williamr@2: unsigned int packet_length; williamr@2: SSL3_BUFFER rbuf; williamr@2: SSL3_RECORD rrec; williamr@2: } DTLS1_RECORD_DATA; williamr@2: williamr@2: williamr@2: /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */ williamr@2: #define DTLS1_TMO_READ_COUNT 2 williamr@2: #define DTLS1_TMO_WRITE_COUNT 2 williamr@2: williamr@2: #define DTLS1_TMO_ALERT_COUNT 12 williamr@2: williamr@2: #ifdef __cplusplus williamr@2: } williamr@2: #endif williamr@2: #endif williamr@2: