2 * Copyright 2022 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/bio.h>
11 #include <openssl/ssl.h>
12 #include <openssl/err.h>
13 #include "../../ssl_local.h"
14 #include "../record_local.h"
16 typedef struct dtls_bitmap_st {
17 /* Track 64 packets */
19 /* Max record number seen so far, 64-bit value in big-endian encoding */
20 unsigned char max_seq_num[SEQ_NUM_SIZE];
23 /* Protocol version specific function pointers */
24 struct record_functions_st
27 * Returns either OSSL_RECORD_RETURN_SUCCESS, OSSL_RECORD_RETURN_FATAL or
28 * OSSL_RECORD_RETURN_NON_FATAL_ERR if we can keep trying to find an
29 * alternative record layer.
31 int (*set_crypto_state)(OSSL_RECORD_LAYER *rl, int level,
32 unsigned char *key, size_t keylen,
33 unsigned char *iv, size_t ivlen,
34 unsigned char *mackey, size_t mackeylen,
35 const EVP_CIPHER *ciph,
39 const SSL_COMP *comp);
43 * 0: if the record is publicly invalid, or an internal error, or AEAD
44 * decryption failed, or EtM decryption failed.
45 * 1: Success or MtE decryption failed (MAC will be randomised)
47 int (*cipher)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *recs, size_t n_recs,
48 int sending, SSL_MAC_BUF *macs, size_t macsize);
49 /* Returns 1 for success or 0 for error */
50 int (*mac)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec, unsigned char *md,
53 /* Return 1 for success or 0 for error */
54 int (*set_protocol_version)(OSSL_RECORD_LAYER *rl, int version);
56 /* Read related functions */
58 int (*read_n)(OSSL_RECORD_LAYER *rl, size_t n, size_t max, int extend,
59 int clearold, size_t *readbytes);
61 int (*get_more_records)(OSSL_RECORD_LAYER *rl);
63 /* Return 1 for success or 0 for error */
64 int (*validate_record_header)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
66 /* Return 1 for success or 0 for error */
67 int (*post_process_record)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
69 /* Write related functions */
71 size_t (*get_max_records)(OSSL_RECORD_LAYER *rl, int type, size_t len,
72 size_t maxfrag, size_t *preffrag);
74 /* Return 1 for success or 0 for error */
75 int (*write_records)(OSSL_RECORD_LAYER *rl, OSSL_RECORD_TEMPLATE *templates,
79 struct ossl_record_layer_st
92 * A BIO containing any data read in the previous epoch that was destined
97 /* The transport BIO */
101 * A BIO where we will send any data read by us that is destined for the
106 /* Types match the equivalent fields in the SSL object */
110 /* write IO goes into here */
111 SSL3_BUFFER wbuf[SSL_MAX_PIPELINES + 1];
113 /* Next wbuf with pending data still to write */
116 /* How many pipelines can be used to write data */
119 /* read IO goes into here */
121 /* each decoded record goes in here */
122 SSL3_RECORD rrec[SSL_MAX_PIPELINES];
124 /* How many records have we got available in the rrec bufer */
127 /* The record number in the rrec buffer that can be read next */
130 /* The number of records that have been released via tls_release_record */
133 /* where we are when reading */
136 /* used internally to point at a raw packet */
137 unsigned char *packet;
138 size_t packet_length;
140 /* Sequence number for the next record */
141 unsigned char sequence[SEQ_NUM_SIZE];
146 * Read as many input bytes as possible (for non-blocking reads)
150 /* The number of consecutive empty records we have received */
151 size_t empty_record_count;
154 * Do we need to send a prefix empty record before application data as a
155 * countermeasure against known-IV weakness (necessary for SSLv3 and
158 int need_empty_fragments;
160 /* cryptographic state */
161 EVP_CIPHER_CTX *enc_ctx;
163 /* used for mac generation */
169 /* Set to 1 if this is the first handshake. 0 otherwise */
170 int is_first_handshake;
172 /* The negotiated maximum fragment length */
173 unsigned int max_frag_len;
175 /* The maxium amount of early data we can receive/send */
176 uint32_t max_early_data;
178 /* The amount of early data that we have sent/received */
179 size_t early_data_count;
181 /* TLSv1.3 record padding */
182 size_t block_padding;
184 /* Only used by SSLv3 */
185 unsigned char mac_secret[EVP_MAX_MD_SIZE];
187 /* TLSv1.0/TLSv1.1/TLSv1.2 */
190 /* Flags for GOST ciphers */
196 unsigned char iv[EVP_MAX_IV_LENGTH];
198 unsigned char read_iv[EVP_MAX_IV_LENGTH];
199 int allow_plain_alerts;
201 /* TLS "any" fields */
202 /* Set to true if this is the first record in a connection */
203 unsigned int is_first_record;
207 /* DTLS received handshake records (processed and unprocessed) */
208 record_pqueue unprocessed_rcds;
209 record_pqueue processed_rcds;
211 /* records being received in the current epoch */
213 /* renegotiation starts a new set of sequence numbers */
214 DTLS_BITMAP next_bitmap;
217 * Whether we are currently in a hanshake or not. Only maintained for DTLS
223 OSSL_FUNC_rlayer_skip_early_data_fn *skip_early_data;
224 OSSL_FUNC_rlayer_msg_callback_fn *msg_callback;
225 OSSL_FUNC_rlayer_security_fn *security;
226 OSSL_FUNC_rlayer_padding_fn *padding;
228 size_t max_pipelines;
230 /* Function pointers for version specific functions */
231 struct record_functions_st *funcs;
234 typedef struct dtls_rlayer_record_data_st {
235 unsigned char *packet;
236 size_t packet_length;
239 } DTLS_RLAYER_RECORD_DATA;
241 extern struct record_functions_st ssl_3_0_funcs;
242 extern struct record_functions_st tls_1_funcs;
243 extern struct record_functions_st tls_1_3_funcs;
244 extern struct record_functions_st tls_any_funcs;
245 extern struct record_functions_st dtls_1_funcs;
246 extern struct record_functions_st dtls_any_funcs;
248 void ossl_rlayer_fatal(OSSL_RECORD_LAYER *rl, int al, int reason,
249 const char *fmt, ...);
251 #define RLAYERfatal(rl, al, r) RLAYERfatal_data((rl), (al), (r), NULL)
252 #define RLAYERfatal_data \
254 ERR_set_debug(OPENSSL_FILE, OPENSSL_LINE, OPENSSL_FUNC), \
257 #define RLAYER_USE_EXPLICIT_IV(rl) ((rl)->version == TLS1_1_VERSION \
258 || (rl)->version == TLS1_2_VERSION \
261 int ossl_set_tls_provider_parameters(OSSL_RECORD_LAYER *rl,
263 const EVP_CIPHER *ciph,
266 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
267 __owur int ssl3_cbc_digest_record(const EVP_MD *md,
268 unsigned char *md_out,
270 const unsigned char *header,
271 const unsigned char *data,
273 size_t data_plus_mac_plus_padding_size,
274 const unsigned char *mac_secret,
275 size_t mac_secret_length, char is_sslv3);
277 int tls_default_read_n(OSSL_RECORD_LAYER *rl, size_t n, size_t max, int extend,
278 int clearold, size_t *readbytes);
279 int tls_get_more_records(OSSL_RECORD_LAYER *rl);
280 int dtls_get_more_records(OSSL_RECORD_LAYER *rl);
282 int tls_default_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
283 int tls_default_validate_record_header(OSSL_RECORD_LAYER *rl, SSL3_RECORD *re);
284 int tls_do_uncompress(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
285 int tls_default_post_process_record(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
286 int tls13_common_post_process_record(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
289 tls_int_new_record_layer(OSSL_LIB_CTX *libctx, const char *propq, int vers,
290 int role, int direction, int level, unsigned char *key,
291 size_t keylen, unsigned char *iv, size_t ivlen,
292 unsigned char *mackey, size_t mackeylen,
293 const EVP_CIPHER *ciph, size_t taglen,
295 const EVP_MD *md, const SSL_COMP *comp, BIO *prev,
296 BIO *transport, BIO *next,
297 BIO_ADDR *local, BIO_ADDR *peer,
298 const OSSL_PARAM *settings, const OSSL_PARAM *options,
299 const OSSL_DISPATCH *fns, void *cbarg,
300 OSSL_RECORD_LAYER **retrl);
301 int tls_free(OSSL_RECORD_LAYER *rl);
302 int tls_reset(OSSL_RECORD_LAYER *rl);
303 int tls_unprocessed_read_pending(OSSL_RECORD_LAYER *rl);
304 int tls_processed_read_pending(OSSL_RECORD_LAYER *rl);
305 size_t tls_app_data_pending(OSSL_RECORD_LAYER *rl);
306 int tls_write_pending(OSSL_RECORD_LAYER *rl);
307 size_t tls_get_max_record_len(OSSL_RECORD_LAYER *rl);
308 size_t tls_get_max_records(OSSL_RECORD_LAYER *rl, int type, size_t len,
309 size_t maxfrag, size_t *preffrag);
310 int tls_write_records(OSSL_RECORD_LAYER *rl, OSSL_RECORD_TEMPLATE *templates,
312 int tls_retry_write_records(OSSL_RECORD_LAYER *rl);
313 int tls_get_alert_code(OSSL_RECORD_LAYER *rl);
314 int tls_set1_bio(OSSL_RECORD_LAYER *rl, BIO *bio);
315 int tls_read_record(OSSL_RECORD_LAYER *rl, void **rechandle, int *rversion,
316 int *type, unsigned char **data, size_t *datalen,
317 uint16_t *epoch, unsigned char *seq_num);
318 int tls_release_record(OSSL_RECORD_LAYER *rl, void *rechandle);
319 int tls_default_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
320 int tls_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
321 void tls_set_plain_alerts(OSSL_RECORD_LAYER *rl, int allow);
322 void tls_set_first_handshake(OSSL_RECORD_LAYER *rl, int first);
323 void tls_set_max_pipelines(OSSL_RECORD_LAYER *rl, size_t max_pipelines);
324 void tls_get_state(OSSL_RECORD_LAYER *rl, const char **shortstr,
325 const char **longstr);
326 int tls_set_options(OSSL_RECORD_LAYER *rl, const OSSL_PARAM *options);
327 int tls_setup_read_buffer(OSSL_RECORD_LAYER *rl);
328 int tls_setup_write_buffer(OSSL_RECORD_LAYER *rl, size_t numwpipes,
329 size_t firstlen, size_t nextlen);
331 int tls_write_records_multiblock(OSSL_RECORD_LAYER *rl,
332 OSSL_RECORD_TEMPLATE *templates,
335 size_t tls_get_max_records_default(OSSL_RECORD_LAYER *rl, int type, size_t len,
336 size_t maxfrag, size_t *preffrag);
337 size_t tls_get_max_records_multiblock(OSSL_RECORD_LAYER *rl, int type,
338 size_t len, size_t maxfrag,
340 int tls_write_records_default(OSSL_RECORD_LAYER *rl,
341 OSSL_RECORD_TEMPLATE *templates,