1 /* $OpenBSD: dtls1.h,v 1.17 2015/02/09 10:53:28 jsing Exp $ */ 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 #if defined(_WIN32) 64 #include <winsock2.h> 65 #else 66 #include <sys/time.h> 67 #endif 68 69 #include <stdio.h> 70 #include <stdlib.h> 71 #include <string.h> 72 73 #include <openssl/buffer.h> 74 75 #ifdef __cplusplus 76 extern "C" { 77 #endif 78 79 #define DTLS1_VERSION 0xFEFF 80 81 /* lengths of messages */ 82 #define DTLS1_COOKIE_LENGTH 256 83 84 #define DTLS1_RT_HEADER_LENGTH 13 85 86 #define DTLS1_HM_HEADER_LENGTH 12 87 88 #define DTLS1_HM_BAD_FRAGMENT -2 89 #define DTLS1_HM_FRAGMENT_RETRY -3 90 91 #define DTLS1_CCS_HEADER_LENGTH 1 92 93 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE 94 #define DTLS1_AL_HEADER_LENGTH 7 95 #else 96 #define DTLS1_AL_HEADER_LENGTH 2 97 #endif 98 99 #ifndef OPENSSL_NO_SSL_INTERN 100 101 102 typedef struct dtls1_bitmap_st { 103 unsigned long map; /* track 32 packets on 32-bit systems 104 and 64 - on 64-bit systems */ 105 unsigned char max_seq_num[8]; /* max record number seen so far, 106 64-bit value in big-endian 107 encoding */ 108 } DTLS1_BITMAP; 109 110 struct dtls1_retransmit_state { 111 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */ 112 EVP_MD_CTX *write_hash; /* used for mac generation */ 113 SSL_SESSION *session; 114 unsigned short epoch; 115 }; 116 117 struct hm_header_st { 118 unsigned char type; 119 unsigned long msg_len; 120 unsigned short seq; 121 unsigned long frag_off; 122 unsigned long frag_len; 123 unsigned int is_ccs; 124 struct dtls1_retransmit_state saved_retransmit_state; 125 }; 126 127 struct ccs_header_st { 128 unsigned char type; 129 unsigned short seq; 130 }; 131 132 struct dtls1_timeout_st { 133 /* Number of read timeouts so far */ 134 unsigned int read_timeouts; 135 136 /* Number of write timeouts so far */ 137 unsigned int write_timeouts; 138 139 /* Number of alerts received so far */ 140 unsigned int num_alerts; 141 }; 142 143 struct _pqueue; 144 145 typedef struct record_pqueue_st { 146 unsigned short epoch; 147 struct _pqueue *q; 148 } record_pqueue; 149 150 typedef struct hm_fragment_st { 151 struct hm_header_st msg_header; 152 unsigned char *fragment; 153 unsigned char *reassembly; 154 } hm_fragment; 155 156 typedef struct dtls1_state_st { 157 unsigned int send_cookie; 158 unsigned char cookie[DTLS1_COOKIE_LENGTH]; 159 unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH]; 160 unsigned int cookie_len; 161 162 /* 163 * The current data and handshake epoch. This is initially 164 * undefined, and starts at zero once the initial handshake is 165 * completed 166 */ 167 unsigned short r_epoch; 168 unsigned short w_epoch; 169 170 /* records being received in the current epoch */ 171 DTLS1_BITMAP bitmap; 172 173 /* renegotiation starts a new set of sequence numbers */ 174 DTLS1_BITMAP next_bitmap; 175 176 /* handshake message numbers */ 177 unsigned short handshake_write_seq; 178 unsigned short next_handshake_write_seq; 179 180 unsigned short handshake_read_seq; 181 182 /* save last sequence number for retransmissions */ 183 unsigned char last_write_sequence[8]; 184 185 /* Received handshake records (processed and unprocessed) */ 186 record_pqueue unprocessed_rcds; 187 record_pqueue processed_rcds; 188 189 /* Buffered handshake messages */ 190 struct _pqueue *buffered_messages; 191 192 /* Buffered (sent) handshake records */ 193 struct _pqueue *sent_messages; 194 195 /* Buffered application records. 196 * Only for records between CCS and Finished 197 * to prevent either protocol violation or 198 * unnecessary message loss. 199 */ 200 record_pqueue buffered_app_data; 201 202 /* Is set when listening for new connections with dtls1_listen() */ 203 unsigned int listen; 204 205 unsigned int mtu; /* max DTLS packet size */ 206 207 struct hm_header_st w_msg_hdr; 208 struct hm_header_st r_msg_hdr; 209 210 struct dtls1_timeout_st timeout; 211 212 /* Indicates when the last handshake msg or heartbeat sent will timeout */ 213 struct timeval next_timeout; 214 215 /* Timeout duration */ 216 unsigned short timeout_duration; 217 218 /* storage for Alert/Handshake protocol data received but not 219 * yet processed by ssl3_read_bytes: */ 220 unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH]; 221 unsigned int alert_fragment_len; 222 unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH]; 223 unsigned int handshake_fragment_len; 224 225 unsigned int retransmitting; 226 unsigned int change_cipher_spec_ok; 227 228 229 } DTLS1_STATE; 230 231 typedef struct dtls1_record_data_st { 232 unsigned char *packet; 233 unsigned int packet_length; 234 SSL3_BUFFER rbuf; 235 SSL3_RECORD rrec; 236 } DTLS1_RECORD_DATA; 237 238 #endif 239 240 /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */ 241 #define DTLS1_TMO_READ_COUNT 2 242 #define DTLS1_TMO_WRITE_COUNT 2 243 244 #define DTLS1_TMO_ALERT_COUNT 12 245 246 #ifdef __cplusplus 247 } 248 #endif 249 #endif 250