36ae3a1021f6b59f0418a398f66ebc43bf2cc4fc
[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     /* Record layer version */
134     /* r */
135     int rec_version;
136
137     /* type of record */
138     /* r */
139     int type;
140
141     /* How many bytes available */
142     /* rw */
143     unsigned int length;
144
145     /*
146      * How many bytes were available before padding was removed? This is used
147      * to implement the MAC check in constant time for CBC records.
148      */
149     /* rw */
150     unsigned int orig_len;
151
152     /* read/write offset into 'buf' */
153     /* r */
154     unsigned int off;
155
156     /* pointer to the record data */
157     /* rw */
158     unsigned char *data;
159
160     /* where the decode bytes are */
161     /* rw */
162     unsigned char *input;
163
164     /* only used with decompression - malloc()ed */
165     /* r */
166     unsigned char *comp;
167
168     /* epoch number, needed by DTLS1 */
169     /* r */
170     unsigned long epoch;
171
172     /* sequence number, needed by DTLS1 */
173     /* r */
174     unsigned char seq_num[SEQ_NUM_SIZE];
175 } SSL3_RECORD;
176
177 typedef struct dtls1_bitmap_st {
178     /* Track 32 packets on 32-bit systems and 64 - on 64-bit systems */
179     unsigned long map;
180
181     /* Max record number seen so far, 64-bit value in big-endian encoding */
182     unsigned char max_seq_num[SEQ_NUM_SIZE];
183 } DTLS1_BITMAP;
184
185 typedef struct record_pqueue_st {
186     unsigned short epoch;
187     struct pqueue_st *q;
188 } record_pqueue;
189
190 typedef struct dtls1_record_data_st {
191     unsigned char *packet;
192     unsigned int packet_length;
193     SSL3_BUFFER rbuf;
194     SSL3_RECORD rrec;
195 #  ifndef OPENSSL_NO_SCTP
196     struct bio_dgram_sctp_rcvinfo recordinfo;
197 #  endif
198 } DTLS1_RECORD_DATA;
199
200
201 typedef struct dtls_record_layer_st {
202     /*
203      * The current data and handshake epoch.  This is initially
204      * undefined, and starts at zero once the initial handshake is
205      * completed
206      */
207     unsigned short r_epoch;
208     unsigned short w_epoch;
209
210     /* records being received in the current epoch */
211     DTLS1_BITMAP bitmap;
212     /* renegotiation starts a new set of sequence numbers */
213     DTLS1_BITMAP next_bitmap;
214
215     /* Received handshake records (processed and unprocessed) */
216     record_pqueue unprocessed_rcds;
217     record_pqueue processed_rcds;
218     /*
219      * Buffered application records. Only for records between CCS and
220      * Finished to prevent either protocol violation or unnecessary message
221      * loss.
222      */
223     record_pqueue buffered_app_data;
224     /*
225      * storage for Alert/Handshake protocol data received but not yet
226      * processed by ssl3_read_bytes:
227      */
228     unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
229     unsigned int alert_fragment_len;
230     unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
231     unsigned int handshake_fragment_len;
232
233     /* save last and current sequence numbers for retransmissions */
234     unsigned char last_write_sequence[8];
235     unsigned char curr_write_sequence[8];
236 } DTLS_RECORD_LAYER;
237
238 /*****************************************************************************
239  *                                                                           *
240  * This structure should be considered "opaque" to anything outside of the   *
241  * record layer. No non-record layer code should be accessing the members of *
242  * this structure.                                                           *
243  *                                                                           *
244  *****************************************************************************/
245
246 typedef struct record_layer_st {
247     /* The parent SSL structure */
248     SSL *s;
249     /*
250      * Read as many input bytes as possible (for
251      * non-blocking reads)
252      */
253     int read_ahead;
254     /* where we are when reading */
255     int rstate;
256     /* read IO goes into here */
257     SSL3_BUFFER rbuf;
258     /* write IO goes into here */
259     SSL3_BUFFER wbuf;
260     /* each decoded record goes in here */
261     SSL3_RECORD rrec;
262     /* goes out from here */
263     SSL3_RECORD wrec;
264
265     /* used internally to point at a raw packet */
266     unsigned char *packet;
267     unsigned int packet_length;
268
269     /* number of bytes sent so far */
270     unsigned int wnum;
271
272     /*
273      * storage for Alert/Handshake protocol data received but not yet
274      * processed by ssl3_read_bytes:
275      */
276     unsigned char alert_fragment[2];
277     unsigned int alert_fragment_len;
278     unsigned char handshake_fragment[4];
279     unsigned int handshake_fragment_len;
280
281     /* partial write - check the numbers match */
282     /* number bytes written */
283     int wpend_tot;
284     int wpend_type;
285     /* number of bytes submitted */
286     int wpend_ret;
287     const unsigned char *wpend_buf;
288
289     unsigned char read_sequence[SEQ_NUM_SIZE];
290     unsigned char write_sequence[SEQ_NUM_SIZE];
291     
292     DTLS_RECORD_LAYER *d;
293 } RECORD_LAYER;
294
295
296 /*****************************************************************************
297  *                                                                           *
298  * The following macros/functions represent the libssl internal API to the   *
299  * record layer. Any libssl code may call these functions/macros             *
300  *                                                                           *
301  *****************************************************************************/
302
303 #define MIN_SSL2_RECORD_LEN     9
304
305 #define RECORD_LAYER_set_read_ahead(rl, ra)     ((rl)->read_ahead = (ra))
306 #define RECORD_LAYER_get_read_ahead(rl)         ((rl)->read_ahead)
307 #define RECORD_LAYER_get_packet(rl)             ((rl)->packet)
308 #define RECORD_LAYER_get_packet_length(rl)      ((rl)->packet_length)
309 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
310 #define DTLS_RECORD_LAYER_get_w_epoch(rl)       ((rl)->d->w_epoch)
311 #define DTLS_RECORD_LAYER_get_processed_rcds(rl) \
312                                                 ((rl)->d->processed_rcds)
313 #define DTLS_RECORD_LAYER_get_unprocessed_rcds(rl) \
314                                                 ((rl)->d->unprocessed_rcds)
315
316 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s);
317 void RECORD_LAYER_clear(RECORD_LAYER *rl);
318 void RECORD_LAYER_release(RECORD_LAYER *rl);
319 int RECORD_LAYER_read_pending(RECORD_LAYER *rl);
320 int RECORD_LAYER_write_pending(RECORD_LAYER *rl);
321 int RECORD_LAYER_set_data(RECORD_LAYER *rl, const unsigned char *buf, int len);
322 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl);
323 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
324 int RECORD_LAYER_setup_comp_buffer(RECORD_LAYER *rl);
325 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl);
326 unsigned int RECORD_LAYER_get_rrec_length(RECORD_LAYER *rl);
327 __owur int ssl3_pending(const SSL *s);
328 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
329 __owur int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
330                          unsigned int len, int create_empty_fragment);
331 __owur int ssl3_read_bytes(SSL *s, int type, int *recvd_type,
332                            unsigned char *buf, int len, int peek);
333 __owur int ssl3_setup_buffers(SSL *s);
334 __owur int ssl3_enc(SSL *s, int send_data);
335 __owur int n_ssl3_mac(SSL *ssl, unsigned char *md, int send_data);
336 __owur int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
337                        unsigned int len);
338 __owur int tls1_enc(SSL *s, int snd);
339 __owur int tls1_mac(SSL *ssl, unsigned char *md, int snd);
340 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
341 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
342 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
343 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
344 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
345 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl);
346 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq);
347 __owur int dtls1_read_bytes(SSL *s, int type, int *recvd_type,
348                             unsigned char *buf, int len, int peek);
349 __owur int dtls1_write_bytes(SSL *s, int type, const void *buf, int len);
350 __owur int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
351                    unsigned int len, int create_empty_fragement);
352 void dtls1_reset_seq_numbers(SSL *s, int rw);
353