1 /* ssl/record/record.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
58 /* ====================================================================
59 * Copyright (c) 1998-2015 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
112 #include <openssl/pqueue.h>
114 /*****************************************************************************
116 * These structures should be considered PRIVATE to the record layer. No *
117 * non-record layer code should be using these structures in any way. *
119 *****************************************************************************/
121 typedef struct ssl3_buffer_st {
122 /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see ssl3_setup_buffers() */
126 /* where to 'copy from' */
128 /* how many bytes left */
132 #define SEQ_NUM_SIZE 8
134 typedef struct ssl3_record_st {
135 /* Record layer version */
143 /* How many bytes available */
148 * How many bytes were available before padding was removed? This is used
149 * to implement the MAC check in constant time for CBC records.
152 unsigned int orig_len;
154 /* read/write offset into 'buf' */
158 /* pointer to the record data */
162 /* where the decode bytes are */
164 unsigned char *input;
166 /* only used with decompression - malloc()ed */
170 /* epoch number, needed by DTLS1 */
174 /* sequence number, needed by DTLS1 */
176 unsigned char seq_num[SEQ_NUM_SIZE];
179 typedef struct dtls1_bitmap_st {
180 /* Track 32 packets on 32-bit systems and 64 - on 64-bit systems */
183 /* Max record number seen so far, 64-bit value in big-endian encoding */
184 unsigned char max_seq_num[SEQ_NUM_SIZE];
187 typedef struct record_pqueue_st {
188 unsigned short epoch;
192 typedef struct dtls1_record_data_st {
193 unsigned char *packet;
194 unsigned int packet_length;
197 # ifndef OPENSSL_NO_SCTP
198 struct bio_dgram_sctp_rcvinfo recordinfo;
203 typedef struct dtls_record_layer_st {
205 * The current data and handshake epoch. This is initially
206 * undefined, and starts at zero once the initial handshake is
209 unsigned short r_epoch;
210 unsigned short w_epoch;
212 /* records being received in the current epoch */
214 /* renegotiation starts a new set of sequence numbers */
215 DTLS1_BITMAP next_bitmap;
217 /* Received handshake records (processed and unprocessed) */
218 record_pqueue unprocessed_rcds;
219 record_pqueue processed_rcds;
221 * Buffered application records. Only for records between CCS and
222 * Finished to prevent either protocol violation or unnecessary message
225 record_pqueue buffered_app_data;
227 * storage for Alert/Handshake protocol data received but not yet
228 * processed by ssl3_read_bytes:
230 unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
231 unsigned int alert_fragment_len;
232 unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
233 unsigned int handshake_fragment_len;
235 /* save last and current sequence numbers for retransmissions */
236 unsigned char last_write_sequence[8];
237 unsigned char curr_write_sequence[8];
240 /*****************************************************************************
242 * This structure should be considered "opaque" to anything outside of the *
243 * record layer. No non-record layer code should be accessing the members of *
246 *****************************************************************************/
248 typedef struct record_layer_st {
249 /* The parent SSL structure */
252 * Read as many input bytes as possible (for
253 * non-blocking reads)
256 /* where we are when reading */
258 /* read IO goes into here */
260 /* write IO goes into here */
262 /* each decoded record goes in here */
264 /* goes out from here */
267 /* used internally to point at a raw packet */
268 unsigned char *packet;
269 unsigned int packet_length;
271 /* number of bytes sent so far */
275 * storage for Alert/Handshake protocol data received but not yet
276 * processed by ssl3_read_bytes:
278 unsigned char alert_fragment[2];
279 unsigned int alert_fragment_len;
280 unsigned char handshake_fragment[4];
281 unsigned int handshake_fragment_len;
283 /* partial write - check the numbers match */
284 /* number bytes written */
287 /* number of bytes submitted */
289 const unsigned char *wpend_buf;
291 unsigned char read_sequence[8];
292 unsigned char write_sequence[8];
294 DTLS_RECORD_LAYER *d;
298 /*****************************************************************************
300 * The following macros/functions represent the libssl internal API to the *
301 * record layer. Any libssl code may call these functions/macros *
303 *****************************************************************************/
305 #define MIN_SSL2_RECORD_LEN 9
307 #define RECORD_LAYER_set_read_ahead(rl, ra) ((rl)->read_ahead = (ra))
308 #define RECORD_LAYER_get_read_ahead(rl) ((rl)->read_ahead)
309 #define RECORD_LAYER_get_packet(rl) ((rl)->packet)
310 #define RECORD_LAYER_get_packet_length(rl) ((rl)->packet_length)
311 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
312 #define DTLS_RECORD_LAYER_get_w_epoch(rl) ((rl)->d->w_epoch)
313 #define DTLS_RECORD_LAYER_get_processed_rcds(rl) \
314 ((rl)->d->processed_rcds)
315 #define DTLS_RECORD_LAYER_get_unprocessed_rcds(rl) \
316 ((rl)->d->unprocessed_rcds)
318 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s);
319 void RECORD_LAYER_clear(RECORD_LAYER *rl);
320 void RECORD_LAYER_release(RECORD_LAYER *rl);
321 int RECORD_LAYER_read_pending(RECORD_LAYER *rl);
322 int RECORD_LAYER_write_pending(RECORD_LAYER *rl);
323 int RECORD_LAYER_set_data(RECORD_LAYER *rl, const unsigned char *buf, int len);
324 void RECORD_LAYER_dup(RECORD_LAYER *dst, RECORD_LAYER *src);
325 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl);
326 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
327 int RECORD_LAYER_setup_comp_buffer(RECORD_LAYER *rl);
328 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl);
329 unsigned int RECORD_LAYER_get_rrec_length(RECORD_LAYER *rl);
330 __owur int ssl3_pending(const SSL *s);
331 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
332 __owur int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
333 unsigned int len, int create_empty_fragment);
334 __owur int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
335 __owur int ssl3_setup_buffers(SSL *s);
336 __owur int ssl3_enc(SSL *s, int send_data);
337 __owur int n_ssl3_mac(SSL *ssl, unsigned char *md, int send_data);
338 __owur int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
340 __owur int tls1_enc(SSL *s, int snd);
341 __owur int tls1_mac(SSL *ssl, unsigned char *md, int snd);
342 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
343 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
344 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
345 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
346 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
347 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl);
348 __owur int dtls1_read_bytes(SSL *s, int type, 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);