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