5ec13720cd259c0508f802b1a705332226a72989
[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
66 #ifdef  __cplusplus
67 extern "C" {
68 #endif
69
70 #define DTLS1_VERSION                   0x0100
71 #define DTLS1_VERSION_MAJOR             0x01
72 #define DTLS1_VERSION_MINOR             0x00
73
74 #define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE    110
75
76 /* lengths of messages */
77 #define DTLS1_COOKIE_LENGTH                     32
78
79 #define DTLS1_RT_HEADER_LENGTH                  13
80
81 #define DTLS1_HM_HEADER_LENGTH                  12
82
83 #define DTLS1_HM_BAD_FRAGMENT                   -2
84 #define DTLS1_HM_FRAGMENT_RETRY                 -3
85
86 #define DTLS1_CCS_HEADER_LENGTH                  3
87
88 #define DTLS1_AL_HEADER_LENGTH                   7
89
90
91 typedef struct dtls1_bitmap_st
92         {
93         BN_ULLONG map;
94         unsigned long length;     /* sizeof the bitmap in bits */
95         BN_ULLONG max_seq_num;  /* max record number seen so far */
96         } DTLS1_BITMAP;
97
98 struct hm_header_st
99         {
100         unsigned char type;
101         unsigned long msg_len;
102         unsigned short seq;
103         unsigned long frag_off;
104         unsigned long frag_len;
105         unsigned int is_ccs;
106         };
107
108 struct ccs_header_st
109         {
110         unsigned char type;
111         unsigned short seq;
112         };
113
114 struct dtls1_timeout_st
115         {
116         /* Number of read timeouts so far */
117         unsigned int read_timeouts;
118         
119         /* Number of write timeouts so far */
120         unsigned int write_timeouts;
121         
122         /* Number of alerts received so far */
123         unsigned int num_alerts;
124         };
125
126 typedef struct record_pqueue_st
127         {
128         unsigned short epoch;
129         pqueue q;
130         } record_pqueue;
131
132 typedef struct hm_fragment_st
133         {
134         struct hm_header_st msg_header;
135         unsigned char *fragment;
136         } hm_fragment;
137
138 typedef struct dtls1_state_st
139         {
140         unsigned int send_cookie;
141         unsigned char cookie[DTLS1_COOKIE_LENGTH];
142         unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];
143         unsigned int cookie_len;
144
145         /* 
146          * The current data and handshake epoch.  This is initially
147          * undefined, and starts at zero once the initial handshake is
148          * completed 
149          */
150         unsigned short r_epoch;
151         unsigned short w_epoch;
152
153         /* records being received in the current epoch */
154         DTLS1_BITMAP bitmap;
155
156         /* renegotiation starts a new set of sequence numbers */
157         DTLS1_BITMAP next_bitmap;
158
159         /* handshake message numbers */
160         unsigned short handshake_write_seq;
161         unsigned short next_handshake_write_seq;
162
163         unsigned short handshake_read_seq;
164
165         /* only matters for handshake messages */  
166         BN_ULLONG next_expected_seq_num; 
167
168         /* Received handshake records (processed and unprocessed) */
169         record_pqueue unprocessed_rcds;
170         record_pqueue processed_rcds;
171
172         /* Buffered handshake messages */
173         pqueue buffered_messages;
174
175         /* Buffered (sent) handshake records */
176         pqueue sent_messages;
177
178         unsigned int mtu; /* max wire packet size */
179
180         struct hm_header_st w_msg_hdr;
181         struct hm_header_st r_msg_hdr;
182
183         struct dtls1_timeout_st timeout;
184         
185         /* storage for Alert/Handshake protocol data received but not
186          * yet processed by ssl3_read_bytes: */
187         unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
188         unsigned int alert_fragment_len;
189         unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
190         unsigned int handshake_fragment_len;
191
192         unsigned int retransmitting;
193
194         } DTLS1_STATE;
195
196 typedef struct dtls1_record_data_st
197         {
198         unsigned char *packet;
199         unsigned int   packet_length;
200         SSL3_BUFFER    rbuf;
201         SSL3_RECORD    rrec;
202         } DTLS1_RECORD_DATA;
203
204
205 /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */
206 #define DTLS1_TMO_READ_COUNT                      2
207 #define DTLS1_TMO_WRITE_COUNT                     2
208
209 #define DTLS1_TMO_ALERT_COUNT                     12
210
211 #ifdef  __cplusplus
212 }
213 #endif
214 #endif
215