2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 typedef struct ssl_connection_st SSL_CONNECTION;
11 typedef struct ssl3_buffer_st SSL3_BUFFER;
13 #include <openssl/core_dispatch.h>
14 #include "recordmethod.h"
16 /*****************************************************************************
18 * These structures should be considered PRIVATE to the record layer. No *
19 * non-record layer code should be using these structures in any way. *
21 *****************************************************************************/
23 struct ssl3_buffer_st {
24 /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see ssl3_setup_buffers() */
26 /* default buffer size (or 0 if no default set) */
30 /* where to 'copy from' */
32 /* how many bytes left */
34 /* 'buf' is from application for KTLS */
38 #define SEQ_NUM_SIZE 8
40 typedef struct ssl3_record_st {
41 /* Record layer version */
47 /* How many bytes available */
51 * How many bytes were available before padding was removed? This is used
52 * to implement the MAC check in constant time for CBC records.
56 /* read/write offset into 'buf' */
59 /* pointer to the record data */
62 /* where the decode bytes are */
65 /* only used with decompression - malloc()ed */
68 /* Whether the data from this record has already been read or not */
71 /* epoch number, needed by DTLS1 */
74 /* sequence number, needed by DTLS1 */
76 unsigned char seq_num[SEQ_NUM_SIZE];
79 typedef struct tls_record_st {
83 /* The data buffer containing bytes from the record */
85 /* Number of remaining to be read in the data buffer */
87 /* Offset into the data buffer where to start reading */
89 /* epoch number. DTLS only */
91 /* sequence number. DTLS only */
92 unsigned char seq_num[SEQ_NUM_SIZE];
93 #ifndef OPENSSL_NO_SCTP
94 struct bio_dgram_sctp_rcvinfo recordinfo;
98 typedef struct dtls1_bitmap_st {
99 /* Track 32 packets on 32-bit systems and 64 - on 64-bit systems */
101 /* Max record number seen so far, 64-bit value in big-endian encoding */
102 unsigned char max_seq_num[SEQ_NUM_SIZE];
105 typedef struct record_pqueue_st {
106 unsigned short epoch;
110 typedef struct dtls1_record_data_st {
111 unsigned char *packet;
112 size_t packet_length;
115 #ifndef OPENSSL_NO_SCTP
116 struct bio_dgram_sctp_rcvinfo recordinfo;
120 typedef struct dtls_record_layer_st {
122 * The current data and handshake epoch. This is initially
123 * undefined, and starts at zero once the initial handshake is
126 unsigned short r_epoch;
127 unsigned short w_epoch;
128 /* records being received in the current epoch */
130 /* renegotiation starts a new set of sequence numbers */
131 DTLS1_BITMAP next_bitmap;
133 * Buffered application records. Only for records between CCS and
134 * Finished to prevent either protocol violation or unnecessary message
137 record_pqueue buffered_app_data;
138 /* save last and current sequence numbers for retransmissions */
139 unsigned char last_write_sequence[8];
140 unsigned char curr_write_sequence[8];
143 /*****************************************************************************
145 * This structure should be considered "opaque" to anything outside of the *
146 * record layer. No non-record layer code should be accessing the members of *
149 *****************************************************************************/
151 typedef struct record_layer_st {
152 /* The parent SSL_CONNECTION structure */
155 * Read as many input bytes as possible (for
156 * non-blocking reads)
159 /* where we are when reading */
161 /* How many pipelines can be used to read data */
163 /* How many pipelines can be used to write data */
165 /* read IO goes into here */
167 /* write IO goes into here */
168 SSL3_BUFFER wbuf[SSL_MAX_PIPELINES];
169 /* each decoded record goes in here */
170 SSL3_RECORD rrec[SSL_MAX_PIPELINES];
171 /* used internally to point at a raw packet */
172 unsigned char *packet;
173 size_t packet_length;
174 /* number of bytes sent so far */
176 unsigned char handshake_fragment[4];
177 size_t handshake_fragment_len;
178 /* The number of consecutive empty records we have received */
179 size_t empty_record_count;
180 /* partial write - check the numbers match */
181 /* number bytes written */
184 /* number of bytes submitted */
186 const unsigned char *wpend_buf;
187 unsigned char read_sequence[SEQ_NUM_SIZE];
188 unsigned char write_sequence[SEQ_NUM_SIZE];
189 /* Set to true if this is the first record in a connection */
190 unsigned int is_first_record;
191 /* Count of the number of consecutive warning alerts received */
192 unsigned int alert_count;
193 DTLS_RECORD_LAYER *d;
195 /* TODO(RECLAYER): Tidy me up. New fields for record management */
197 /* How many records we have read from the record layer */
199 /* The next record from the record layer that we need to process */
201 /* Record layer data to be processed */
202 TLS_RECORD tlsrecs[SSL_MAX_PIPELINES];
206 /*****************************************************************************
208 * The following macros/functions represent the libssl internal API to the *
209 * record layer. Any libssl code may call these functions/macros *
211 *****************************************************************************/
213 struct ssl_mac_buf_st {
217 typedef struct ssl_mac_buf_st SSL_MAC_BUF;
219 #define MIN_SSL2_RECORD_LEN 9
221 #define RECORD_LAYER_set_read_ahead(rl, ra) ((rl)->read_ahead = (ra))
222 #define RECORD_LAYER_get_read_ahead(rl) ((rl)->read_ahead)
223 #define RECORD_LAYER_get_packet(rl) ((rl)->packet)
224 #define RECORD_LAYER_get_packet_length(rl) ((rl)->packet_length)
225 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
226 #define DTLS_RECORD_LAYER_get_w_epoch(rl) ((rl)->d->w_epoch)
227 #define RECORD_LAYER_get_rbuf(rl) (&(rl)->rbuf)
228 #define RECORD_LAYER_get_wbuf(rl) ((rl)->wbuf)
230 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL_CONNECTION *s);
231 void RECORD_LAYER_clear(RECORD_LAYER *rl);
232 void RECORD_LAYER_release(RECORD_LAYER *rl);
233 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl);
234 int RECORD_LAYER_processed_read_pending(const RECORD_LAYER *rl);
235 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl);
236 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl);
237 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
238 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl);
239 size_t RECORD_LAYER_get_rrec_length(RECORD_LAYER *rl);
240 __owur size_t ssl3_pending(const SSL *s);
241 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, size_t len,
243 int do_ssl3_write(SSL_CONNECTION *s, int type, const unsigned char *buf,
244 size_t *pipelens, size_t numpipes,
245 int create_empty_fragment, size_t *written);
246 __owur int ssl3_read_bytes(SSL *s, int type, int *recvd_type,
247 unsigned char *buf, size_t len, int peek,
249 __owur int ssl3_setup_buffers(SSL_CONNECTION *s);
250 __owur int ssl3_enc(SSL_CONNECTION *s, SSL3_RECORD *inrecs, size_t n_recs,
251 int send, SSL_MAC_BUF *mac, size_t macsize);
252 __owur int n_ssl3_mac(SSL_CONNECTION *s, SSL3_RECORD *rec, unsigned char *md,
254 __owur int ssl3_write_pending(SSL_CONNECTION *s, int type,
255 const unsigned char *buf, size_t len,
257 __owur int tls1_enc(SSL_CONNECTION *s, SSL3_RECORD *recs, size_t n_recs,
258 int sending, SSL_MAC_BUF *mac, size_t macsize);
259 __owur int tls1_mac_old(SSL_CONNECTION *s, SSL3_RECORD *rec, unsigned char *md,
261 __owur int tls13_enc(SSL_CONNECTION *s, SSL3_RECORD *recs, size_t n_recs,
262 int send, SSL_MAC_BUF *mac, size_t macsize);
263 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
264 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
265 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
266 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
267 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
268 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq);
269 __owur int dtls1_read_bytes(SSL *s, int type, int *recvd_type,
270 unsigned char *buf, size_t len, int peek,
272 __owur int dtls1_write_bytes(SSL_CONNECTION *s, int type, const void *buf,
273 size_t len, size_t *written);
274 int do_dtls1_write(SSL_CONNECTION *s, int type, const unsigned char *buf,
275 size_t len, int create_empty_fragment, size_t *written);
276 void dtls1_reset_seq_numbers(SSL_CONNECTION *s, int rw);
277 int dtls_buffer_listen_record(SSL_CONNECTION *s, size_t len, unsigned char *seq,
279 void ssl_release_record(SSL_CONNECTION *s, TLS_RECORD *rr);
281 # define HANDLE_RLAYER_RETURN(s, ret) \
282 ossl_tls_handle_rlayer_return(s, ret, OPENSSL_FILE, OPENSSL_LINE)
284 int ossl_tls_handle_rlayer_return(SSL_CONNECTION *s, int ret, char *file,
287 int ssl_set_new_record_layer(SSL_CONNECTION *s, int version, int direction,
288 int level, unsigned char *key, size_t keylen,
289 unsigned char *iv, size_t ivlen,
290 unsigned char *mackey, size_t mackeylen,
291 const EVP_CIPHER *ciph, size_t taglen,
292 int mactype, const EVP_MD *md,
293 const SSL_COMP *comp);
295 # define OSSL_FUNC_RLAYER_SKIP_EARLY_DATA 1
296 OSSL_CORE_MAKE_FUNC(const OSSL_PARAM *, rlayer_skip_early_data, (void *cbarg))
297 # define OSSL_FUNC_RLAYER_MSG_CALLBACK 2
298 OSSL_CORE_MAKE_FUNC(void, rlayer_msg_callback, (int write_p, int version,
300 const void *buf, size_t len,
302 # define OSSL_FUNC_RLAYER_SECURITY 3
303 OSSL_CORE_MAKE_FUNC(int, rlayer_security, (void *cbarg, int op, int bits,
304 int nid, void *other))