29c74d7cb990444195a10b9040af14d70eca8027
[openssl.git] / ssl / record / record.h
1 /* ssl/record/record.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2015 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer.
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112 /*****************************************************************************
113  *                                                                           *
114  * These structures should be considered PRIVATE to the record layer. No     *
115  * non-record layer code should be using these structures in any way.        *
116  *                                                                           *
117  *****************************************************************************/
118
119 typedef struct ssl3_buffer_st {
120     /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see ssl3_setup_buffers() */
121     unsigned char *buf;
122     /* buffer size */
123     size_t len;
124     /* where to 'copy from' */
125     int offset;
126     /* how many bytes left */
127     int left;
128 } SSL3_BUFFER;
129
130 #define SEQ_NUM_SIZE                            8
131
132 typedef struct ssl3_record_st {
133     /* type of record */
134     /* r */
135     int type;
136
137     /* How many bytes available */
138     /* rw */
139     unsigned int length;
140
141     /*
142      * How many bytes were available before padding was removed? This is used
143      * to implement the MAC check in constant time for CBC records.
144      */
145     /* rw */
146     unsigned int orig_len;
147
148     /* read/write offset into 'buf' */
149     /* r */
150     unsigned int off;
151
152     /* pointer to the record data */
153     /* rw */
154     unsigned char *data;
155
156     /* where the decode bytes are */
157     /* rw */
158     unsigned char *input;
159
160     /* only used with decompression - malloc()ed */
161     /* r */
162     unsigned char *comp;
163
164     /* epoch number, needed by DTLS1 */
165     /* r */
166     unsigned long epoch;
167
168     /* sequence number, needed by DTLS1 */
169     /* r */
170     unsigned char seq_num[SEQ_NUM_SIZE];
171 } SSL3_RECORD;
172
173 typedef struct dtls1_bitmap_st {
174     /* Track 32 packets on 32-bit systems and 64 - on 64-bit systems */
175     unsigned long map;
176
177     /* Max record number seen so far, 64-bit value in big-endian encoding */
178     unsigned char max_seq_num[SEQ_NUM_SIZE];
179 } DTLS1_BITMAP;
180
181 typedef struct record_pqueue_st {
182     unsigned short epoch;
183     pqueue q;
184 } record_pqueue;
185
186 typedef struct dtls1_record_data_st {
187     unsigned char *packet;
188     unsigned int packet_length;
189     SSL3_BUFFER rbuf;
190     SSL3_RECORD rrec;
191 #  ifndef OPENSSL_NO_SCTP
192     struct bio_dgram_sctp_rcvinfo recordinfo;
193 #  endif
194 } DTLS1_RECORD_DATA;
195
196
197 typedef struct dtls_record_layer_st {
198     /*
199      * The current data and handshake epoch.  This is initially
200      * undefined, and starts at zero once the initial handshake is
201      * completed
202      */
203     unsigned short r_epoch;
204     unsigned short w_epoch;
205
206     /* records being received in the current epoch */
207     DTLS1_BITMAP bitmap;
208     /* renegotiation starts a new set of sequence numbers */
209     DTLS1_BITMAP next_bitmap;
210
211     /* Received handshake records (processed and unprocessed) */
212     record_pqueue unprocessed_rcds;
213     record_pqueue processed_rcds;
214     /*
215      * Buffered application records. Only for records between CCS and
216      * Finished to prevent either protocol violation or unnecessary message
217      * loss.
218      */
219     record_pqueue buffered_app_data;
220     /*
221      * storage for Alert/Handshake protocol data received but not yet
222      * processed by ssl3_read_bytes:
223      */
224     unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
225     unsigned int alert_fragment_len;
226     unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
227     unsigned int handshake_fragment_len;
228
229     /* save last and current sequence numbers for retransmissions */
230     unsigned char last_write_sequence[8];
231     unsigned char curr_write_sequence[8];
232 } DTLS_RECORD_LAYER;
233
234 /*****************************************************************************
235  *                                                                           *
236  * This structure should be considered "opaque" to anything outside of the   *
237  * record layer. No non-record layer code should be accessing the members of *
238  * this structure.                                                           *
239  *                                                                           *
240  *****************************************************************************/
241
242 typedef struct record_layer_st {
243     /* The parent SSL structure */
244     SSL *s;
245     /*
246      * Read as many input bytes as possible (for
247      * non-blocking reads)
248      */
249     int read_ahead;
250     /* where we are when reading */
251     int rstate;
252     /* read IO goes into here */
253     SSL3_BUFFER rbuf;
254     /* write IO goes into here */
255     SSL3_BUFFER wbuf;
256     /* each decoded record goes in here */
257     SSL3_RECORD rrec;
258     /* goes out from here */
259     SSL3_RECORD wrec;
260
261     /* used internally to point at a raw packet */
262     unsigned char *packet;
263     unsigned int packet_length;
264
265     /* number of bytes sent so far */
266     unsigned int wnum;
267
268     /*
269      * storage for Alert/Handshake protocol data received but not yet
270      * processed by ssl3_read_bytes:
271      */
272     unsigned char alert_fragment[2];
273     unsigned int alert_fragment_len;
274     unsigned char handshake_fragment[4];
275     unsigned int handshake_fragment_len;
276
277     /* partial write - check the numbers match */
278     /* number bytes written */
279     int wpend_tot;
280     int wpend_type;
281     /* number of bytes submitted */
282     int wpend_ret;
283     const unsigned char *wpend_buf;
284
285     unsigned char read_sequence[8];
286     unsigned char write_sequence[8];
287     
288     DTLS_RECORD_LAYER *d;
289 } RECORD_LAYER;
290
291
292 /*****************************************************************************
293  *                                                                           *
294  * The following macros/functions represent the libssl internal API to the   *
295  * record layer. Any libssl code may call these functions/macros             *
296  *                                                                           *
297  *****************************************************************************/
298
299 #define RECORD_LAYER_set_read_ahead(rl, ra)     ((rl)->read_ahead = (ra))
300 #define RECORD_LAYER_get_read_ahead(rl)         ((rl)->read_ahead)
301 #define RECORD_LAYER_get_packet(rl)             ((rl)->packet)
302 #define RECORD_LAYER_get_packet_length(rl)      ((rl)->packet_length)
303 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
304 #define DTLS_RECORD_LAYER_get_w_epoch(rl)       ((rl)->d->w_epoch)
305 #define DTLS_RECORD_LAYER_get_processed_rcds(rl) \
306                                                 ((rl)->d->processed_rcds)
307 #define DTLS_RECORD_LAYER_get_unprocessed_rcds(rl) \
308                                                 ((rl)->d->unprocessed_rcds)
309
310 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s);
311 void RECORD_LAYER_clear(RECORD_LAYER *rl);
312 void RECORD_LAYER_release(RECORD_LAYER *rl);
313 int RECORD_LAYER_read_pending(RECORD_LAYER *rl);
314 int RECORD_LAYER_write_pending(RECORD_LAYER *rl);
315 int RECORD_LAYER_set_data(RECORD_LAYER *rl, const unsigned char *buf, int len);
316 void RECORD_LAYER_dup(RECORD_LAYER *dst, RECORD_LAYER *src);
317 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl);
318 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
319 int RECORD_LAYER_setup_comp_buffer(RECORD_LAYER *rl);
320 __owur int ssl3_pending(const SSL *s);
321 __owur int ssl23_read_bytes(SSL *s, int n);
322 __owur int ssl23_write_bytes(SSL *s);
323 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
324 __owur int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
325                          unsigned int len, int create_empty_fragment);
326 __owur int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
327 __owur int ssl3_setup_buffers(SSL *s);
328 __owur int ssl3_enc(SSL *s, int send_data);
329 __owur int n_ssl3_mac(SSL *ssl, unsigned char *md, int send_data);
330 __owur int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
331                        unsigned int len);
332 __owur int tls1_enc(SSL *s, int snd);
333 __owur int tls1_mac(SSL *ssl, unsigned char *md, int snd);
334 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
335 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
336 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
337 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
338 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
339 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl);
340 __owur int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
341 __owur int dtls1_write_bytes(SSL *s, int type, const void *buf, int len);
342 __owur int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
343                    unsigned int len, int create_empty_fragement);
344 void dtls1_reset_seq_numbers(SSL *s, int rw);
345