1 /* 2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved. 3 * 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 8 */ 9 10 typedef struct ssl_connection_st SSL_CONNECTION; 11 typedef struct ssl3_buffer_st SSL3_BUFFER; 12 13 #include <openssl/core_dispatch.h> 14 #include "recordmethod.h" 15 16 /***************************************************************************** 17 * * 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. * 20 * * 21 *****************************************************************************/ 22 23 struct ssl3_buffer_st { 24 /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see ssl3_setup_buffers() */ 25 unsigned char *buf; 26 /* default buffer size (or 0 if no default set) */ 27 size_t default_len; 28 /* buffer size */ 29 size_t len; 30 /* where to 'copy from' */ 31 size_t offset; 32 /* how many bytes left */ 33 size_t left; 34 /* 'buf' is from application for KTLS */ 35 int app_buffer; 36 }; 37 38 #define SEQ_NUM_SIZE 8 39 40 typedef struct ssl3_record_st { 41 /* Record layer version */ 42 /* r */ 43 int rec_version; 44 /* type of record */ 45 /* r */ 46 int type; 47 /* How many bytes available */ 48 /* rw */ 49 size_t length; 50 /* 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. 53 */ 54 /* rw */ 55 size_t orig_len; 56 /* read/write offset into 'buf' */ 57 /* r */ 58 size_t off; 59 /* pointer to the record data */ 60 /* rw */ 61 unsigned char *data; 62 /* where the decode bytes are */ 63 /* rw */ 64 unsigned char *input; 65 /* only used with decompression - malloc()ed */ 66 /* r */ 67 unsigned char *comp; 68 /* epoch number, needed by DTLS1 */ 69 /* r */ 70 uint16_t epoch; 71 /* sequence number, needed by DTLS1 */ 72 /* r */ 73 unsigned char seq_num[SEQ_NUM_SIZE]; 74 } SSL3_RECORD; 75 76 typedef struct tls_record_st { 77 void *rechandle; 78 int version; 79 int type; 80 /* The data buffer containing bytes from the record */ 81 unsigned char *data; 82 /* Number of remaining to be read in the data buffer */ 83 size_t length; 84 /* Offset into the data buffer where to start reading */ 85 size_t off; 86 /* epoch number. DTLS only */ 87 uint16_t epoch; 88 /* sequence number. DTLS only */ 89 unsigned char seq_num[SEQ_NUM_SIZE]; 90 #ifndef OPENSSL_NO_SCTP 91 struct bio_dgram_sctp_rcvinfo recordinfo; 92 #endif 93 } TLS_RECORD; 94 95 typedef struct record_pqueue_st { 96 uint16_t epoch; 97 struct pqueue_st *q; 98 } record_pqueue; 99 100 typedef struct dtls_record_layer_st { 101 /* 102 * The current data and handshake epoch. This is initially 103 * undefined, and starts at zero once the initial handshake is 104 * completed 105 */ 106 uint16_t r_epoch; 107 uint16_t w_epoch; 108 109 /* 110 * Buffered application records. Only for records between CCS and 111 * Finished to prevent either protocol violation or unnecessary message 112 * loss. 113 */ 114 record_pqueue buffered_app_data; 115 /* save last and current sequence numbers for retransmissions */ 116 unsigned char last_write_sequence[8]; 117 unsigned char curr_write_sequence[8]; 118 } DTLS_RECORD_LAYER; 119 120 /***************************************************************************** 121 * * 122 * This structure should be considered "opaque" to anything outside of the * 123 * record layer. No non-record layer code should be accessing the members of * 124 * this structure. * 125 * * 126 *****************************************************************************/ 127 128 typedef struct record_layer_st { 129 /* The parent SSL_CONNECTION structure */ 130 SSL_CONNECTION *s; 131 132 /* Method to use for the read record layer*/ 133 const OSSL_RECORD_METHOD *rrlmethod; 134 /* The read record layer object itself */ 135 OSSL_RECORD_LAYER *rrl; 136 /* BIO to store data destined for the next read record layer epoch */ 137 BIO *rrlnext; 138 /* Default read buffer length to be passed to the record layer */ 139 size_t default_read_buf_len; 140 141 /* 142 * Read as many input bytes as possible (for 143 * non-blocking reads) 144 */ 145 int read_ahead; 146 /* How many pipelines can be used to write data */ 147 size_t numwpipes; 148 /* write IO goes into here */ 149 SSL3_BUFFER wbuf[SSL_MAX_PIPELINES]; 150 /* number of bytes sent so far */ 151 size_t wnum; 152 unsigned char handshake_fragment[4]; 153 size_t handshake_fragment_len; 154 /* partial write - check the numbers match */ 155 /* number bytes written */ 156 size_t wpend_tot; 157 int wpend_type; 158 /* number of bytes submitted */ 159 size_t wpend_ret; 160 const unsigned char *wpend_buf; 161 162 unsigned char write_sequence[SEQ_NUM_SIZE]; 163 /* Count of the number of consecutive warning alerts received */ 164 unsigned int alert_count; 165 DTLS_RECORD_LAYER *d; 166 167 /* How many records we have read from the record layer */ 168 size_t num_recs; 169 /* The next record from the record layer that we need to process */ 170 size_t curr_rec; 171 /* Record layer data to be processed */ 172 TLS_RECORD tlsrecs[SSL_MAX_PIPELINES]; 173 174 } RECORD_LAYER; 175 176 /***************************************************************************** 177 * * 178 * The following macros/functions represent the libssl internal API to the * 179 * record layer. Any libssl code may call these functions/macros * 180 * * 181 *****************************************************************************/ 182 183 struct ssl_mac_buf_st { 184 unsigned char *mac; 185 int alloced; 186 }; 187 typedef struct ssl_mac_buf_st SSL_MAC_BUF; 188 189 #define MIN_SSL2_RECORD_LEN 9 190 191 #define RECORD_LAYER_set_read_ahead(rl, ra) ((rl)->read_ahead = (ra)) 192 #define RECORD_LAYER_get_read_ahead(rl) ((rl)->read_ahead) 193 #define RECORD_LAYER_get_packet(rl) ((rl)->packet) 194 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc)) 195 #define DTLS_RECORD_LAYER_get_w_epoch(rl) ((rl)->d->w_epoch) 196 #define RECORD_LAYER_get_rbuf(rl) (&(rl)->rbuf) 197 #define RECORD_LAYER_get_wbuf(rl) ((rl)->wbuf) 198 199 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL_CONNECTION *s); 200 void RECORD_LAYER_clear(RECORD_LAYER *rl); 201 void RECORD_LAYER_release(RECORD_LAYER *rl); 202 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl); 203 int RECORD_LAYER_processed_read_pending(const RECORD_LAYER *rl); 204 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl); 205 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl); 206 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl); 207 __owur size_t ssl3_pending(const SSL *s); 208 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, size_t len, 209 size_t *written); 210 int do_ssl3_write(SSL_CONNECTION *s, int type, const unsigned char *buf, 211 size_t *pipelens, size_t numpipes, 212 int create_empty_fragment, size_t *written); 213 __owur int ssl3_read_bytes(SSL *s, int type, int *recvd_type, 214 unsigned char *buf, size_t len, int peek, 215 size_t *readbytes); 216 __owur int ssl3_setup_buffers(SSL_CONNECTION *s); 217 __owur int ssl3_enc(SSL_CONNECTION *s, SSL3_RECORD *inrecs, size_t n_recs, 218 int send, SSL_MAC_BUF *mac, size_t macsize); 219 __owur int n_ssl3_mac(SSL_CONNECTION *s, SSL3_RECORD *rec, unsigned char *md, 220 int send); 221 __owur int ssl3_write_pending(SSL_CONNECTION *s, int type, 222 const unsigned char *buf, size_t len, 223 size_t *written); 224 __owur int tls1_enc(SSL_CONNECTION *s, SSL3_RECORD *recs, size_t n_recs, 225 int sending, SSL_MAC_BUF *mac, size_t macsize); 226 __owur int tls1_mac_old(SSL_CONNECTION *s, SSL3_RECORD *rec, unsigned char *md, 227 int send); 228 __owur int tls13_enc(SSL_CONNECTION *s, SSL3_RECORD *recs, size_t n_recs, 229 int send, SSL_MAC_BUF *mac, size_t macsize); 230 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl); 231 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl); 232 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl); 233 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e); 234 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl); 235 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq); 236 __owur int dtls1_read_bytes(SSL *s, int type, int *recvd_type, 237 unsigned char *buf, size_t len, int peek, 238 size_t *readbytes); 239 __owur int dtls1_write_bytes(SSL_CONNECTION *s, int type, const void *buf, 240 size_t len, size_t *written); 241 int do_dtls1_write(SSL_CONNECTION *s, int type, const unsigned char *buf, 242 size_t len, int create_empty_fragment, size_t *written); 243 void dtls1_reset_seq_numbers(SSL_CONNECTION *s, int rw); 244 void ssl_release_record(SSL_CONNECTION *s, TLS_RECORD *rr); 245 246 # define HANDLE_RLAYER_RETURN(s, ret) \ 247 ossl_tls_handle_rlayer_return(s, ret, OPENSSL_FILE, OPENSSL_LINE) 248 249 int ossl_tls_handle_rlayer_return(SSL_CONNECTION *s, int ret, char *file, 250 int line); 251 252 int ssl_set_new_record_layer(SSL_CONNECTION *s, int version, int direction, 253 int level, unsigned char *key, size_t keylen, 254 unsigned char *iv, size_t ivlen, 255 unsigned char *mackey, size_t mackeylen, 256 const EVP_CIPHER *ciph, size_t taglen, 257 int mactype, const EVP_MD *md, 258 const SSL_COMP *comp); 259 260 # define OSSL_FUNC_RLAYER_SKIP_EARLY_DATA 1 261 OSSL_CORE_MAKE_FUNC(int, rlayer_skip_early_data, (void *cbarg)) 262 # define OSSL_FUNC_RLAYER_MSG_CALLBACK 2 263 OSSL_CORE_MAKE_FUNC(void, rlayer_msg_callback, (int write_p, int version, 264 int content_type, 265 const void *buf, size_t len, 266 void *cbarg)) 267 # define OSSL_FUNC_RLAYER_SECURITY 3 268 OSSL_CORE_MAKE_FUNC(int, rlayer_security, (void *cbarg, int op, int bits, 269 int nid, void *other)) 270
