2 * Copyright 1995-2023 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 #include <openssl/core_dispatch.h>
11 #include "internal/recordmethod.h"
13 /*****************************************************************************
15 * These structures should be considered PRIVATE to the record layer. No *
16 * non-record layer code should be using these structures in any way. *
18 *****************************************************************************/
20 #define SEQ_NUM_SIZE 8
22 typedef struct tls_record_st {
26 /* The data buffer containing bytes from the record */
27 const unsigned char *data;
29 * Buffer that we allocated to store data. If non NULL always the same as
30 * data (but non-const)
32 unsigned char *allocdata;
33 /* Number of remaining to be read in the data buffer */
35 /* Offset into the data buffer where to start reading */
37 /* epoch number. DTLS only */
39 /* sequence number. DTLS only */
40 unsigned char seq_num[SEQ_NUM_SIZE];
41 #ifndef OPENSSL_NO_SCTP
42 struct bio_dgram_sctp_rcvinfo recordinfo;
46 typedef struct record_pqueue_st {
51 typedef struct dtls_record_layer_st {
53 * The current data and handshake epoch. This is initially
54 * undefined, and starts at zero once the initial handshake is
61 * Buffered application records. Only for records between CCS and
62 * Finished to prevent either protocol violation or unnecessary message
65 record_pqueue buffered_app_data;
68 /*****************************************************************************
70 * This structure should be considered "opaque" to anything outside of the *
71 * record layer. No non-record layer code should be accessing the members of *
74 *****************************************************************************/
76 typedef struct record_layer_st {
77 /* The parent SSL_CONNECTION structure */
80 /* Custom record layer: always selected if set */
81 const OSSL_RECORD_METHOD *custom_rlmethod;
82 /* Record layer specific argument */
84 /* Method to use for the read record layer*/
85 const OSSL_RECORD_METHOD *rrlmethod;
86 /* Method to use for the write record layer*/
87 const OSSL_RECORD_METHOD *wrlmethod;
88 /* The read record layer object itself */
89 OSSL_RECORD_LAYER *rrl;
90 /* The write record layer object itself */
91 OSSL_RECORD_LAYER *wrl;
92 /* BIO to store data destined for the next read record layer epoch */
94 /* Default read buffer length to be passed to the record layer */
95 size_t default_read_buf_len;
98 * Read as many input bytes as possible (for
103 /* number of bytes sent so far */
105 unsigned char handshake_fragment[4];
106 size_t handshake_fragment_len;
107 /* partial write - check the numbers match */
108 /* number bytes written */
111 const unsigned char *wpend_buf;
113 /* Count of the number of consecutive warning alerts received */
114 unsigned int alert_count;
115 DTLS_RECORD_LAYER *d;
117 /* TLS1.3 padding callback */
118 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
119 void *record_padding_arg;
120 size_t block_padding;
122 /* How many records we have read from the record layer */
124 /* The next record from the record layer that we need to process */
126 /* Record layer data to be processed */
127 TLS_RECORD tlsrecs[SSL_MAX_PIPELINES];
131 /*****************************************************************************
133 * The following macros/functions represent the libssl internal API to the *
134 * record layer. Any libssl code may call these functions/macros *
136 *****************************************************************************/
138 #define RECORD_LAYER_set_read_ahead(rl, ra) ((rl)->read_ahead = (ra))
139 #define RECORD_LAYER_get_read_ahead(rl) ((rl)->read_ahead)
140 #define DTLS_RECORD_LAYER_get_w_epoch(rl) ((rl)->d->w_epoch)
142 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL_CONNECTION *s);
143 void RECORD_LAYER_clear(RECORD_LAYER *rl);
144 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl);
145 int RECORD_LAYER_processed_read_pending(const RECORD_LAYER *rl);
146 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl);
147 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl);
148 __owur size_t ssl3_pending(const SSL *s);
149 __owur int ssl3_write_bytes(SSL *s, uint8_t type, const void *buf, size_t len,
151 __owur int ssl3_read_bytes(SSL *s, uint8_t type, uint8_t *recvd_type,
152 unsigned char *buf, size_t len, int peek,
155 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
156 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
157 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
158 __owur int dtls1_read_bytes(SSL *s, uint8_t type, uint8_t *recvd_type,
159 unsigned char *buf, size_t len, int peek,
161 __owur int dtls1_write_bytes(SSL_CONNECTION *s, uint8_t type, const void *buf,
162 size_t len, size_t *written);
163 int do_dtls1_write(SSL_CONNECTION *s, uint8_t type, const unsigned char *buf,
164 size_t len, size_t *written);
165 void dtls1_increment_epoch(SSL_CONNECTION *s, int rw);
166 int ssl_release_record(SSL_CONNECTION *s, TLS_RECORD *rr, size_t length);
168 # define HANDLE_RLAYER_READ_RETURN(s, ret) \
169 ossl_tls_handle_rlayer_return(s, 0, ret, OPENSSL_FILE, OPENSSL_LINE)
171 # define HANDLE_RLAYER_WRITE_RETURN(s, ret) \
172 ossl_tls_handle_rlayer_return(s, 1, ret, OPENSSL_FILE, OPENSSL_LINE)
174 int ossl_tls_handle_rlayer_return(SSL_CONNECTION *s, int writing, int ret,
175 char *file, int line);
177 int ssl_set_new_record_layer(SSL_CONNECTION *s, int version,
178 int direction, int level,
179 unsigned char *secret, size_t secretlen,
180 unsigned char *key, size_t keylen,
181 unsigned char *iv, size_t ivlen,
182 unsigned char *mackey, size_t mackeylen,
183 const EVP_CIPHER *ciph, size_t taglen,
184 int mactype, const EVP_MD *md,
185 const SSL_COMP *comp, const EVP_MD *kdfdigest);
186 int ssl_set_record_protocol_version(SSL_CONNECTION *s, int vers);
188 # define OSSL_FUNC_RLAYER_SKIP_EARLY_DATA 1
189 OSSL_CORE_MAKE_FUNC(int, rlayer_skip_early_data, (void *cbarg))
190 # define OSSL_FUNC_RLAYER_MSG_CALLBACK 2
191 OSSL_CORE_MAKE_FUNC(void, rlayer_msg_callback, (int write_p, int version,
193 const void *buf, size_t len,
195 # define OSSL_FUNC_RLAYER_SECURITY 3
196 OSSL_CORE_MAKE_FUNC(int, rlayer_security, (void *cbarg, int op, int bits,
197 int nid, void *other))
198 # define OSSL_FUNC_RLAYER_PADDING 4
199 OSSL_CORE_MAKE_FUNC(size_t, rlayer_padding, (void *cbarg, int type, size_t len))