1 /* ssl/record/rec_layer.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-2002 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 "../ssl_locl.h"
114 /*****************************************************************************
116 * These structures should be considered "opaque" to anything outside of the *
117 * record layer. No non-record layer code should be accessing the members of *
118 * these structures. *
120 *****************************************************************************/
122 typedef struct record_pqueue_st {
123 unsigned short epoch;
127 typedef struct dtls1_record_data_st {
128 unsigned char *packet;
129 unsigned int packet_length;
132 # ifndef OPENSSL_NO_SCTP
133 struct bio_dgram_sctp_rcvinfo recordinfo;
137 typedef struct dtls_record_layer_st {
139 * The current data and handshake epoch. This is initially
140 * undefined, and starts at zero once the initial handshake is
143 unsigned short r_epoch;
144 unsigned short w_epoch;
146 /* records being received in the current epoch */
148 /* renegotiation starts a new set of sequence numbers */
149 DTLS1_BITMAP next_bitmap;
151 /* Received handshake records (processed and unprocessed) */
152 record_pqueue unprocessed_rcds;
153 record_pqueue processed_rcds;
155 * Buffered application records. Only for records between CCS and
156 * Finished to prevent either protocol violation or unnecessary message
159 record_pqueue buffered_app_data;
161 * storage for Alert/Handshake protocol data received but not yet
162 * processed by ssl3_read_bytes:
164 unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
165 unsigned int alert_fragment_len;
166 unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
167 unsigned int handshake_fragment_len;
169 /* save last and current sequence numbers for retransmissions */
170 unsigned char last_write_sequence[8];
171 unsigned char curr_write_sequence[8];
174 typedef struct record_layer_st {
175 /* The parent SSL structure */
178 * Read as many input bytes as possible (for
179 * non-blocking reads)
182 /* where we are when reading */
184 /* read IO goes into here */
186 /* write IO goes into here */
188 /* each decoded record goes in here */
190 /* goes out from here */
193 /* used internally to point at a raw packet */
194 unsigned char *packet;
195 unsigned int packet_length;
197 /* number of bytes sent so far */
201 * storage for Alert/Handshake protocol data received but not yet
202 * processed by ssl3_read_bytes:
204 unsigned char alert_fragment[2];
205 unsigned int alert_fragment_len;
206 unsigned char handshake_fragment[4];
207 unsigned int handshake_fragment_len;
209 /* partial write - check the numbers match */
210 /* number bytes written */
213 /* number of bytes submitted */
215 const unsigned char *wpend_buf;
217 unsigned char read_sequence[8];
218 unsigned char write_sequence[8];
220 DTLS_RECORD_LAYER *d;
224 /*****************************************************************************
226 * The following macros/functions represent the libssl internal API to the *
229 *****************************************************************************/
231 #define RECORD_LAYER_set_read_ahead(rl, ra) ((rl)->read_ahead = (ra))
232 #define RECORD_LAYER_get_read_ahead(rl) ((rl)->read_ahead)
233 #define RECORD_LAYER_setup_comp_buffer(rl) (SSL3_RECORD_setup(&(rl)->rrec))
234 #define RECORD_LAYER_get_packet(rl) ((rl)->packet)
235 #define RECORD_LAYER_get_packet_length(rl) ((rl)->packet_length)
236 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
237 #define RECORD_LAYER_get_read_sequence(rl) ((rl)->read_sequence)
238 #define DTLS_RECORD_LAYER_get_w_epoch(rl) ((rl)->d->w_epoch)
239 #define DTLS_RECORD_LAYER_get_processed_rcds(rl) \
240 ((rl)->d->processed_rcds)
241 #define DTLS_RECORD_LAYER_get_unprocessed_rcds(rl) \
242 ((rl)->d->unprocessed_rcds)
244 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s);
245 void RECORD_LAYER_clear(RECORD_LAYER *rl);
246 void RECORD_LAYER_release(RECORD_LAYER *rl);
247 int RECORD_LAYER_read_pending(RECORD_LAYER *rl);
248 int RECORD_LAYER_write_pending(RECORD_LAYER *rl);
249 int RECORD_LAYER_set_data(RECORD_LAYER *rl, const unsigned char *buf, int len);
250 void RECORD_LAYER_dup(RECORD_LAYER *dst, RECORD_LAYER *src);
251 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl);
252 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
253 void RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, const unsigned char *ws);
254 __owur int ssl3_pending(const SSL *s);
255 __owur int ssl23_read_bytes(SSL *s, int n);
256 __owur int ssl23_write_bytes(SSL *s);
257 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
258 __owur int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
259 unsigned int len, int create_empty_fragment);
260 __owur int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
261 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
262 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
263 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
264 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
265 __owur int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
266 __owur int dtls1_write_bytes(SSL *s, int type, const void *buf, int len);
267 __owur int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
268 unsigned int len, int create_empty_fragement);
269 void dtls1_reset_seq_numbers(SSL *s, int rw);
272 /*****************************************************************************
274 * The following macros/functions are private to the record layer. They *
275 * should not be used outside of the record layer. *
277 *****************************************************************************/
279 #define RECORD_LAYER_get_rbuf(rl) (&(rl)->rbuf)
280 #define RECORD_LAYER_get_wbuf(rl) (&(rl)->wbuf)
281 #define RECORD_LAYER_get_rrec(rl) (&(rl)->rrec)
282 #define RECORD_LAYER_get_wrec(rl) (&(rl)->wrec)
283 #define RECORD_LAYER_set_packet(rl, p) ((rl)->packet = (p))
284 #define RECORD_LAYER_reset_packet_length(rl) ((rl)->packet_length = 0)
285 #define RECORD_LAYER_get_rstate(rl) ((rl)->rstate)
286 #define RECORD_LAYER_set_rstate(rl, st) ((rl)->rstate = (st))
287 #define RECORD_LAYER_get_write_sequence(rl) ((rl)->write_sequence)
288 #define DTLS_RECORD_LAYER_get_r_epoch(rl) ((rl)->d->r_epoch)
290 __owur int ssl3_read_n(SSL *s, int n, int max, int extend);
291 __owur int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
293 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
294 unsigned int *is_next_epoch);
295 int dtls1_process_buffered_records(SSL *s);
296 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue);
297 int dtls1_buffer_record(SSL *s, record_pqueue *q,
298 unsigned char *priority);
299 void ssl3_record_sequence_update(unsigned char *seq);