[thirdparty/openssl.git] / ssl / record / record_local.h

/*
 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/*****************************************************************************
 *                                                                           *
 * The following macros/functions are PRIVATE to the record layer. They      *
 * should NOT be used outside of the record layer.                           *
 *                                                                           *
 *****************************************************************************/

#define MAX_WARN_ALERT_COUNT    5

/* Functions/macros provided by the RECORD_LAYER component */

#define RECORD_LAYER_get_rrec(rl)               ((rl)->rrec)
#define RECORD_LAYER_set_packet(rl, p)          ((rl)->packet = (p))
#define RECORD_LAYER_reset_packet_length(rl)    ((rl)->packet_length = 0)
#define RECORD_LAYER_get_rstate(rl)             ((rl)->rstate)
#define RECORD_LAYER_set_rstate(rl, st)         ((rl)->rstate = (st))
#define RECORD_LAYER_get_read_sequence(rl)      ((rl)->read_sequence)
#define RECORD_LAYER_get_write_sequence(rl)     ((rl)->write_sequence)
#define RECORD_LAYER_get_numrpipes(rl)          ((rl)->numrpipes)
#define RECORD_LAYER_set_numrpipes(rl, n)       ((rl)->numrpipes = (n))
#define RECORD_LAYER_inc_empty_record_count(rl) ((rl)->empty_record_count++)
#define RECORD_LAYER_reset_empty_record_count(rl) \
                                                ((rl)->empty_record_count = 0)
#define RECORD_LAYER_get_empty_record_count(rl) ((rl)->empty_record_count)
#define RECORD_LAYER_is_first_record(rl)        ((rl)->is_first_record)
#define RECORD_LAYER_set_first_record(rl)       ((rl)->is_first_record = 1)
#define RECORD_LAYER_clear_first_record(rl)     ((rl)->is_first_record = 0)
#define DTLS_RECORD_LAYER_get_r_epoch(rl)       ((rl)->d->r_epoch)

__owur int ssl3_read_n(SSL *s, size_t n, size_t max, int extend, int clearold,
                       size_t *readbytes);

DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
                               unsigned int *is_next_epoch);
int dtls1_process_buffered_records(SSL *s);
int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue);
int dtls1_buffer_record(SSL *s, record_pqueue *q, unsigned char *priority);
void ssl3_record_sequence_update(unsigned char *seq);

/* Functions provided by the DTLS1_BITMAP component */

int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap);
void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);

/* Macros/functions provided by the SSL3_BUFFER component */

#define SSL3_BUFFER_get_buf(b)              ((b)->buf)
#define SSL3_BUFFER_set_buf(b, n)           ((b)->buf = (n))
#define SSL3_BUFFER_get_len(b)              ((b)->len)
#define SSL3_BUFFER_set_len(b, l)           ((b)->len = (l))
#define SSL3_BUFFER_get_left(b)             ((b)->left)
#define SSL3_BUFFER_set_left(b, l)          ((b)->left = (l))
#define SSL3_BUFFER_sub_left(b, l)          ((b)->left -= (l))
#define SSL3_BUFFER_get_offset(b)           ((b)->offset)
#define SSL3_BUFFER_set_offset(b, o)        ((b)->offset = (o))
#define SSL3_BUFFER_add_offset(b, o)        ((b)->offset += (o))
#define SSL3_BUFFER_is_initialised(b)       ((b)->buf != NULL)
#define SSL3_BUFFER_set_default_len(b, l)   ((b)->default_len = (l))
#define SSL3_BUFFER_set_app_buffer(b, l)    ((b)->app_buffer = (l))
#define SSL3_BUFFER_is_app_buffer(b)        ((b)->app_buffer)

void SSL3_BUFFER_clear(SSL3_BUFFER *b);
void SSL3_BUFFER_set_data(SSL3_BUFFER *b, const unsigned char *d, size_t n);
void SSL3_BUFFER_release(SSL3_BUFFER *b);
__owur int ssl3_setup_read_buffer(SSL *s);
__owur int ssl3_setup_write_buffer(SSL *s, size_t numwpipes, size_t len);
int ssl3_release_read_buffer(SSL *s);
int ssl3_release_write_buffer(SSL *s);

/* Macros/functions provided by the SSL3_RECORD component */

#define SSL3_RECORD_get_type(r)                 ((r)->type)
#define SSL3_RECORD_set_type(r, t)              ((r)->type = (t))
#define SSL3_RECORD_set_rec_version(r, v)       ((r)->rec_version = (v))
#define SSL3_RECORD_get_length(r)               ((r)->length)
#define SSL3_RECORD_set_length(r, l)            ((r)->length = (l))
#define SSL3_RECORD_add_length(r, l)            ((r)->length += (l))
#define SSL3_RECORD_sub_length(r, l)            ((r)->length -= (l))
#define SSL3_RECORD_get_data(r)                 ((r)->data)
#define SSL3_RECORD_set_data(r, d)              ((r)->data = (d))
#define SSL3_RECORD_get_input(r)                ((r)->input)
#define SSL3_RECORD_set_input(r, i)             ((r)->input = (i))
#define SSL3_RECORD_reset_input(r)              ((r)->input = (r)->data)
#define SSL3_RECORD_reset_data(r)               ((r)->data = (r)->input)
#define SSL3_RECORD_get_seq_num(r)              ((r)->seq_num)
#define SSL3_RECORD_get_off(r)                  ((r)->off)
#define SSL3_RECORD_set_off(r, o)               ((r)->off = (o))
#define SSL3_RECORD_add_off(r, o)               ((r)->off += (o))
#define SSL3_RECORD_get_epoch(r)                ((r)->epoch)
#define SSL3_RECORD_is_sslv2_record(r) \
            ((r)->rec_version == SSL2_VERSION)
#define SSL3_RECORD_is_read(r)                  ((r)->read)
#define SSL3_RECORD_set_read(r)                 ((r)->read = 1)

void SSL3_RECORD_clear(SSL3_RECORD *r, size_t);
void SSL3_RECORD_release(SSL3_RECORD *r, size_t num_recs);
void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num);
int ssl3_get_record(SSL *s);
__owur int ssl3_do_compress(SSL *ssl, SSL3_RECORD *wr);
__owur int ssl3_do_uncompress(SSL *ssl, SSL3_RECORD *rr);
__owur int ssl3_cbc_remove_padding_and_mac(size_t *reclen,
                                           size_t origreclen,
                                           unsigned char *recdata,
                                           unsigned char **mac,
                                           int *alloced,
                                           size_t block_size, size_t mac_size,
                                           OSSL_LIB_CTX *libctx);
__owur int tls1_cbc_remove_padding_and_mac(size_t *reclen,
                                           size_t origreclen,
                                           unsigned char *recdata,
                                           unsigned char **mac,
                                           int *alloced,
                                           size_t block_size, size_t mac_size,
                                           int aead,
                                           OSSL_LIB_CTX *libctx);
int dtls1_process_record(SSL *s, DTLS1_BITMAP *bitmap);
__owur int dtls1_get_record(SSL *s);
int early_data_count_ok(SSL *s, size_t length, size_t overhead, int send);
Commit	Line	Data
846e33c7	1	/*
33388b44	2	* Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
258f8721	3	*
2c18d164	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
846e33c7 RS	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
258f8721	8	*/
44cc35d3 MC	9
	10	/*****************************************************************************
	11	* *
	12	* The following macros/functions are PRIVATE to the record layer. They *
	13	* should NOT be used outside of the record layer. *
	14	* *
	15	*****************************************************************************/
	16
af58be76 MC	17	#define MAX_WARN_ALERT_COUNT 5
af58be76 MC	18
44cc35d3 MC	19	/* Functions/macros provided by the RECORD_LAYER component */
44cc35d3 MC	20
94777c9c	21	#define RECORD_LAYER_get_rrec(rl) ((rl)->rrec)
44cc35d3 MC	22	#define RECORD_LAYER_set_packet(rl, p) ((rl)->packet = (p))
	23	#define RECORD_LAYER_reset_packet_length(rl) ((rl)->packet_length = 0)
	24	#define RECORD_LAYER_get_rstate(rl) ((rl)->rstate)
	25	#define RECORD_LAYER_set_rstate(rl, st) ((rl)->rstate = (st))
	26	#define RECORD_LAYER_get_read_sequence(rl) ((rl)->read_sequence)
	27	#define RECORD_LAYER_get_write_sequence(rl) ((rl)->write_sequence)
94777c9c MC	28	#define RECORD_LAYER_get_numrpipes(rl) ((rl)->numrpipes)
94777c9c MC	29	#define RECORD_LAYER_set_numrpipes(rl, n) ((rl)->numrpipes = (n))
255cfeac MC	30	#define RECORD_LAYER_inc_empty_record_count(rl) ((rl)->empty_record_count++)
	31	#define RECORD_LAYER_reset_empty_record_count(rl) \
	32	((rl)->empty_record_count = 0)
	33	#define RECORD_LAYER_get_empty_record_count(rl) ((rl)->empty_record_count)
44efb88a	34	#define RECORD_LAYER_is_first_record(rl) ((rl)->is_first_record)
78fcddbb MC	35	#define RECORD_LAYER_set_first_record(rl) ((rl)->is_first_record = 1)
78fcddbb MC	36	#define RECORD_LAYER_clear_first_record(rl) ((rl)->is_first_record = 0)
44cc35d3 MC	37	#define DTLS_RECORD_LAYER_get_r_epoch(rl) ((rl)->d->r_epoch)
44cc35d3 MC	38
8e6d03ca	39	__owur int ssl3_read_n(SSL *s, size_t n, size_t max, int extend, int clearold,
54105ddd	40	size_t *readbytes);
44cc35d3	41
44cc35d3	42	DTLS1_BITMAP dtls1_get_bitmap(SSL s, SSL3_RECORD *rr,
a230b26e	43	unsigned int *is_next_epoch);
44cc35d3 MC	44	int dtls1_process_buffered_records(SSL *s);
44cc35d3 MC	45	int dtls1_retrieve_buffered_record(SSL s, record_pqueue queue);
a230b26e	46	int dtls1_buffer_record(SSL s, record_pqueue q, unsigned char *priority);
44cc35d3 MC	47	void ssl3_record_sequence_update(unsigned char *seq);
	48
	49	/* Functions provided by the DTLS1_BITMAP component */
	50
	51	int dtls1_record_replay_check(SSL s, DTLS1_BITMAP bitmap);
	52	void dtls1_record_bitmap_update(SSL s, DTLS1_BITMAP bitmap);
	53
44cc35d3 MC	54	/* Macros/functions provided by the SSL3_BUFFER component */
	55
	56	#define SSL3_BUFFER_get_buf(b) ((b)->buf)
	57	#define SSL3_BUFFER_set_buf(b, n) ((b)->buf = (n))
	58	#define SSL3_BUFFER_get_len(b) ((b)->len)
	59	#define SSL3_BUFFER_set_len(b, l) ((b)->len = (l))
	60	#define SSL3_BUFFER_get_left(b) ((b)->left)
747e1639	61	#define SSL3_BUFFER_set_left(b, l) ((b)->left = (l))
eda75751	62	#define SSL3_BUFFER_sub_left(b, l) ((b)->left -= (l))
747e1639 MC	63	#define SSL3_BUFFER_get_offset(b) ((b)->offset)
	64	#define SSL3_BUFFER_set_offset(b, o) ((b)->offset = (o))
	65	#define SSL3_BUFFER_add_offset(b, o) ((b)->offset += (o))
44cc35d3	66	#define SSL3_BUFFER_is_initialised(b) ((b)->buf != NULL)
dad78fb1	67	#define SSL3_BUFFER_set_default_len(b, l) ((b)->default_len = (l))
074a6e86 JB	68	#define SSL3_BUFFER_set_app_buffer(b, l) ((b)->app_buffer = (l))
074a6e86 JB	69	#define SSL3_BUFFER_is_app_buffer(b) ((b)->app_buffer)
44cc35d3	70
6b41b3f5	71	void SSL3_BUFFER_clear(SSL3_BUFFER *b);
eda75751	72	void SSL3_BUFFER_set_data(SSL3_BUFFER b, const unsigned char d, size_t n);
44cc35d3 MC	73	void SSL3_BUFFER_release(SSL3_BUFFER *b);
44cc35d3 MC	74	__owur int ssl3_setup_read_buffer(SSL *s);
7ee8627f	75	__owur int ssl3_setup_write_buffer(SSL *s, size_t numwpipes, size_t len);
44cc35d3 MC	76	int ssl3_release_read_buffer(SSL *s);
	77	int ssl3_release_write_buffer(SSL *s);
	78
	79	/* Macros/functions provided by the SSL3_RECORD component */
258f8721 MC	80
258f8721 MC	81	#define SSL3_RECORD_get_type(r) ((r)->type)
747e1639	82	#define SSL3_RECORD_set_type(r, t) ((r)->type = (t))
3295d242	83	#define SSL3_RECORD_set_rec_version(r, v) ((r)->rec_version = (v))
258f8721	84	#define SSL3_RECORD_get_length(r) ((r)->length)
747e1639 MC	85	#define SSL3_RECORD_set_length(r, l) ((r)->length = (l))
747e1639 MC	86	#define SSL3_RECORD_add_length(r, l) ((r)->length += (l))
753be41d	87	#define SSL3_RECORD_sub_length(r, l) ((r)->length -= (l))
258f8721	88	#define SSL3_RECORD_get_data(r) ((r)->data)
747e1639 MC	89	#define SSL3_RECORD_set_data(r, d) ((r)->data = (d))
	90	#define SSL3_RECORD_get_input(r) ((r)->input)
	91	#define SSL3_RECORD_set_input(r, i) ((r)->input = (i))
	92	#define SSL3_RECORD_reset_input(r) ((r)->input = (r)->data)
50ec7505	93	#define SSL3_RECORD_reset_data(r) ((r)->data = (r)->input)
258f8721	94	#define SSL3_RECORD_get_seq_num(r) ((r)->seq_num)
747e1639 MC	95	#define SSL3_RECORD_get_off(r) ((r)->off)
	96	#define SSL3_RECORD_set_off(r, o) ((r)->off = (o))
	97	#define SSL3_RECORD_add_off(r, o) ((r)->off += (o))
	98	#define SSL3_RECORD_get_epoch(r) ((r)->epoch)
32ec4153 MC	99	#define SSL3_RECORD_is_sslv2_record(r) \
32ec4153 MC	100	((r)->rec_version == SSL2_VERSION)
255cfeac MC	101	#define SSL3_RECORD_is_read(r) ((r)->read)
255cfeac MC	102	#define SSL3_RECORD_set_read(r) ((r)->read = 1)
258f8721	103
5607b275 MC	104	void SSL3_RECORD_clear(SSL3_RECORD *r, size_t);
5607b275 MC	105	void SSL3_RECORD_release(SSL3_RECORD *r, size_t num_recs);
258f8721	106	void SSL3_RECORD_set_seq_num(SSL3_RECORD r, const unsigned char seq_num);
fe589e61	107	int ssl3_get_record(SSL *s);
d102d9df	108	__owur int ssl3_do_compress(SSL ssl, SSL3_RECORD wr);
94777c9c	109	__owur int ssl3_do_uncompress(SSL ssl, SSL3_RECORD rr);
f0237a6c MC	110	__owur int ssl3_cbc_remove_padding_and_mac(size_t *reclen,
	111	size_t origreclen,
	112	unsigned char *recdata,
ec27e619 MC	113	unsigned char **mac,
ec27e619 MC	114	int *alloced,
f0237a6c	115	size_t block_size, size_t mac_size,
b4250010	116	OSSL_LIB_CTX *libctx);
f0237a6c MC	117	__owur int tls1_cbc_remove_padding_and_mac(size_t *reclen,
	118	size_t origreclen,
	119	unsigned char *recdata,
ec27e619 MC	120	unsigned char **mac,
ec27e619 MC	121	int *alloced,
f0237a6c MC	122	size_t block_size, size_t mac_size,
f0237a6c MC	123	int aead,
b4250010	124	OSSL_LIB_CTX *libctx);
1fb9fdc3	125	int dtls1_process_record(SSL s, DTLS1_BITMAP bitmap);
02a36fda	126	__owur int dtls1_get_record(SSL *s);
196f2cbb	127	int early_data_count_ok(SSL *s, size_t length, size_t overhead, int send);