1/* ssl/dtls1.h */ 2/* 3 * DTLS implementation written by Nagendra Modadugu 4 * (nagendra@cs.stanford.edu) for the OpenSSL project 2005. 5 */ 6/* ==================================================================== 7 * Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. All advertising materials mentioning features or use of this 22 * software must display the following acknowledgment: 23 * "This product includes software developed by the OpenSSL Project 24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 25 * 26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 27 * endorse or promote products derived from this software without 28 * prior written permission. For written permission, please contact 29 * openssl-core@OpenSSL.org. 30 * 31 * 5. Products derived from this software may not be called "OpenSSL" 32 * nor may "OpenSSL" appear in their names without prior written 33 * permission of the OpenSSL Project. 34 * 35 * 6. Redistributions of any form whatsoever must retain the following 36 * acknowledgment: 37 * "This product includes software developed by the OpenSSL Project 38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 39 * 40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 51 * OF THE POSSIBILITY OF SUCH DAMAGE. 52 * ==================================================================== 53 * 54 * This product includes cryptographic software written by Eric Young 55 * (eay@cryptsoft.com). This product includes software written by Tim 56 * Hudson (tjh@cryptsoft.com). 57 * 58 */ 59 60#ifndef HEADER_DTLS1_H 61#define HEADER_DTLS1_H 62 63#include <openssl/buffer.h> 64#include <openssl/pqueue.h> 65#ifdef OPENSSL_SYS_VMS 66#include <resource.h> 67#include <sys/timeb.h> 68#endif 69#ifdef OPENSSL_SYS_WIN32 70/* Needed for struct timeval */ 71#include <winsock.h> 72#elif defined(OPENSSL_SYS_NETWARE) && !defined(_WINSOCK2API_) 73#include <sys/timeval.h> 74#else 75#include <sys/time.h> 76#endif 77 78#ifdef __cplusplus 79extern "C" { 80#endif 81 82#define DTLS1_VERSION 0xFEFF 83#define DTLS1_BAD_VER 0x0100 84 85#if 0 86/* this alert description is not specified anywhere... */ 87#define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE 110 88#endif 89 90/* lengths of messages */ 91#define DTLS1_COOKIE_LENGTH 256 92 93#define DTLS1_RT_HEADER_LENGTH 13 94 95#define DTLS1_HM_HEADER_LENGTH 12 96 97#define DTLS1_HM_BAD_FRAGMENT -2 98#define DTLS1_HM_FRAGMENT_RETRY -3 99 100#define DTLS1_CCS_HEADER_LENGTH 1 101 102#ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE 103#define DTLS1_AL_HEADER_LENGTH 7 104#else 105#define DTLS1_AL_HEADER_LENGTH 2 106#endif 107 108 109typedef struct dtls1_bitmap_st 110 { 111 PQ_64BIT map; 112 unsigned long length; /* sizeof the bitmap in bits */ 113 PQ_64BIT max_seq_num; /* max record number seen so far */ 114 } DTLS1_BITMAP; 115 116struct dtls1_retransmit_state 117 { 118 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */ 119 const EVP_MD *write_hash; /* used for mac generation */ 120#ifndef OPENSSL_NO_COMP 121 COMP_CTX *compress; /* compression */ 122#else 123 char *compress; 124#endif 125 SSL_SESSION *session; 126 unsigned short epoch; 127 }; 128 129struct hm_header_st 130 { 131 unsigned char type; 132 unsigned long msg_len; 133 unsigned short seq; 134 unsigned long frag_off; 135 unsigned long frag_len; 136 unsigned int is_ccs; 137 struct dtls1_retransmit_state saved_retransmit_state; 138 }; 139 140struct ccs_header_st 141 { 142 unsigned char type; 143 unsigned short seq; 144 }; 145 146struct dtls1_timeout_st 147 { 148 /* Number of read timeouts so far */ 149 unsigned int read_timeouts; 150 151 /* Number of write timeouts so far */ 152 unsigned int write_timeouts; 153 154 /* Number of alerts received so far */ 155 unsigned int num_alerts; 156 }; 157 158typedef struct record_pqueue_st 159 { 160 unsigned short epoch; 161 pqueue q; 162 } record_pqueue; 163 164typedef struct hm_fragment_st 165 { 166 struct hm_header_st msg_header; 167 unsigned char *fragment; 168 unsigned char *reassembly; 169 } hm_fragment; 170 171typedef struct dtls1_state_st 172 { 173 unsigned int send_cookie; 174 unsigned char cookie[DTLS1_COOKIE_LENGTH]; 175 unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH]; 176 unsigned int cookie_len; 177 178 /* 179 * The current data and handshake epoch. This is initially 180 * undefined, and starts at zero once the initial handshake is 181 * completed 182 */ 183 unsigned short r_epoch; 184 unsigned short w_epoch; 185 186 /* records being received in the current epoch */ 187 DTLS1_BITMAP bitmap; 188 189 /* renegotiation starts a new set of sequence numbers */ 190 DTLS1_BITMAP next_bitmap; 191 192 /* handshake message numbers */ 193 unsigned short handshake_write_seq; 194 unsigned short next_handshake_write_seq; 195 196 unsigned short handshake_read_seq; 197 198 /* save last sequence number for retransmissions */ 199 unsigned char last_write_sequence[8]; 200 201 /* Received handshake records (processed and unprocessed) */ 202 record_pqueue unprocessed_rcds; 203 record_pqueue processed_rcds; 204 205 /* Buffered handshake messages */ 206 pqueue buffered_messages; 207 208 /* Buffered (sent) handshake records */ 209 pqueue sent_messages; 210 211 /* Buffered application records. 212 * Only for records between CCS and Finished 213 * to prevent either protocol violation or 214 * unnecessary message loss. 215 */ 216 record_pqueue buffered_app_data; 217 218 /* Is set when listening for new connections with dtls1_listen() */ 219 unsigned int listen; 220 221 unsigned int mtu; /* max DTLS packet size */ 222 223 struct hm_header_st w_msg_hdr; 224 struct hm_header_st r_msg_hdr; 225 226 struct dtls1_timeout_st timeout; 227 228 /* Indicates when the last handshake msg sent will timeout */ 229 struct timeval next_timeout; 230 231 /* Timeout duration */ 232 unsigned short timeout_duration; 233 234 /* storage for Alert/Handshake protocol data received but not 235 * yet processed by ssl3_read_bytes: */ 236 unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH]; 237 unsigned int alert_fragment_len; 238 unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH]; 239 unsigned int handshake_fragment_len; 240 241 unsigned int retransmitting; 242 unsigned int change_cipher_spec_ok; 243 244 } DTLS1_STATE; 245 246typedef struct dtls1_record_data_st 247 { 248 unsigned char *packet; 249 unsigned int packet_length; 250 SSL3_BUFFER rbuf; 251 SSL3_RECORD rrec; 252 } DTLS1_RECORD_DATA; 253 254 255/* Timeout multipliers (timeout slice is defined in apps/timeouts.h */ 256#define DTLS1_TMO_READ_COUNT 2 257#define DTLS1_TMO_WRITE_COUNT 2 258 259#define DTLS1_TMO_ALERT_COUNT 12 260 261#ifdef __cplusplus 262} 263#endif 264#endif 265 266