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