• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
79 extern "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 #ifndef OPENSSL_NO_SSL_INTERN
109 
110 #ifndef OPENSSL_NO_SCTP
111 #define DTLS1_SCTP_AUTH_LABEL	"EXPORTER_DTLS_OVER_SCTP"
112 #endif
113 
114 typedef struct dtls1_bitmap_st
115 	{
116 	unsigned long map;		/* track 32 packets on 32-bit systems
117 					   and 64 - on 64-bit systems */
118 	unsigned char max_seq_num[8];	/* max record number seen so far,
119 					   64-bit value in big-endian
120 					   encoding */
121 	} DTLS1_BITMAP;
122 
123 struct dtls1_retransmit_state
124 	{
125 	EVP_CIPHER_CTX *enc_write_ctx;	/* cryptographic state */
126 	EVP_MD_CTX *write_hash;			/* used for mac generation */
127 #ifndef OPENSSL_NO_COMP
128 	COMP_CTX *compress;				/* compression */
129 #else
130 	char *compress;
131 #endif
132 	SSL_SESSION *session;
133 	unsigned short epoch;
134 	};
135 
136 struct hm_header_st
137 	{
138 	unsigned char type;
139 	unsigned long msg_len;
140 	unsigned short seq;
141 	unsigned long frag_off;
142 	unsigned long frag_len;
143 	unsigned int is_ccs;
144 	struct dtls1_retransmit_state saved_retransmit_state;
145 	};
146 
147 struct ccs_header_st
148 	{
149 	unsigned char type;
150 	unsigned short seq;
151 	};
152 
153 struct dtls1_timeout_st
154 	{
155 	/* Number of read timeouts so far */
156 	unsigned int read_timeouts;
157 
158 	/* Number of write timeouts so far */
159 	unsigned int write_timeouts;
160 
161 	/* Number of alerts received so far */
162 	unsigned int num_alerts;
163 	};
164 
165 typedef struct record_pqueue_st
166 	{
167 	unsigned short epoch;
168 	pqueue q;
169 	} record_pqueue;
170 
171 typedef struct hm_fragment_st
172 	{
173 	struct hm_header_st msg_header;
174 	unsigned char *fragment;
175 	unsigned char *reassembly;
176 	} hm_fragment;
177 
178 typedef struct dtls1_state_st
179 	{
180 	unsigned int send_cookie;
181 	unsigned char cookie[DTLS1_COOKIE_LENGTH];
182 	unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];
183 	unsigned int cookie_len;
184 
185 	/*
186 	 * The current data and handshake epoch.  This is initially
187 	 * undefined, and starts at zero once the initial handshake is
188 	 * completed
189 	 */
190 	unsigned short r_epoch;
191 	unsigned short w_epoch;
192 
193 	/* records being received in the current epoch */
194 	DTLS1_BITMAP bitmap;
195 
196 	/* renegotiation starts a new set of sequence numbers */
197 	DTLS1_BITMAP next_bitmap;
198 
199 	/* handshake message numbers */
200 	unsigned short handshake_write_seq;
201 	unsigned short next_handshake_write_seq;
202 
203 	unsigned short handshake_read_seq;
204 
205 	/* save last sequence number for retransmissions */
206 	unsigned char last_write_sequence[8];
207 
208 	/* Received handshake records (processed and unprocessed) */
209 	record_pqueue unprocessed_rcds;
210 	record_pqueue processed_rcds;
211 
212 	/* Buffered handshake messages */
213 	pqueue buffered_messages;
214 
215 	/* Buffered (sent) handshake records */
216 	pqueue sent_messages;
217 
218 	/* Buffered application records.
219 	 * Only for records between CCS and Finished
220 	 * to prevent either protocol violation or
221 	 * unnecessary message loss.
222 	 */
223 	record_pqueue buffered_app_data;
224 
225 	/* Is set when listening for new connections with dtls1_listen() */
226 	unsigned int listen;
227 
228 	unsigned int mtu; /* max DTLS packet size */
229 
230 	struct hm_header_st w_msg_hdr;
231 	struct hm_header_st r_msg_hdr;
232 
233 	struct dtls1_timeout_st timeout;
234 
235 	/* Indicates when the last handshake msg or heartbeat sent will timeout */
236 	struct timeval next_timeout;
237 
238 	/* Timeout duration */
239 	unsigned short timeout_duration;
240 
241 	/* storage for Alert/Handshake protocol data received but not
242 	 * yet processed by ssl3_read_bytes: */
243 	unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
244 	unsigned int alert_fragment_len;
245 	unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
246 	unsigned int handshake_fragment_len;
247 
248 	unsigned int retransmitting;
249 	unsigned int change_cipher_spec_ok;
250 
251 #ifndef OPENSSL_NO_SCTP
252 	/* used when SSL_ST_XX_FLUSH is entered */
253 	int next_state;
254 
255 	int shutdown_received;
256 #endif
257 
258 	} DTLS1_STATE;
259 
260 typedef struct dtls1_record_data_st
261 	{
262 	unsigned char *packet;
263 	unsigned int   packet_length;
264 	SSL3_BUFFER    rbuf;
265 	SSL3_RECORD    rrec;
266 #ifndef OPENSSL_NO_SCTP
267 	struct bio_dgram_sctp_rcvinfo recordinfo;
268 #endif
269 	} DTLS1_RECORD_DATA;
270 
271 #endif
272 
273 /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */
274 #define DTLS1_TMO_READ_COUNT                      2
275 #define DTLS1_TMO_WRITE_COUNT                     2
276 
277 #define DTLS1_TMO_ALERT_COUNT                     12
278 
279 #ifdef  __cplusplus
280 }
281 #endif
282 #endif
283 
284