Address feedback on SSLv2 ClientHello processing
[openssl.git] / ssl / record / record_locl.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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 /*****************************************************************************
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
17 /* Functions/macros provided by the RECORD_LAYER component */
18
19 #define RECORD_LAYER_get_rbuf(rl)               (&(rl)->rbuf)
20 #define RECORD_LAYER_get_wbuf(rl)               ((rl)->wbuf)
21 #define RECORD_LAYER_get_rrec(rl)               ((rl)->rrec)
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)
28 #define RECORD_LAYER_get_numrpipes(rl)          ((rl)->numrpipes)
29 #define RECORD_LAYER_set_numrpipes(rl, n)       ((rl)->numrpipes = (n))
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)
34 #define RECORD_LAYER_is_first_record(rl)        ((rl)->is_first_record)
35 #define RECORD_LAYER_set_first_record(rl, val)  ((rl)->is_first_record = (val))
36 #define DTLS_RECORD_LAYER_get_r_epoch(rl)       ((rl)->d->r_epoch)
37
38 __owur int ssl3_read_n(SSL *s, int n, int max, int extend, int clearold);
39
40 void RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, const unsigned char *ws);
41 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
42                                       unsigned int *is_next_epoch);
43 int dtls1_process_buffered_records(SSL *s);
44 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue);
45 int dtls1_buffer_record(SSL *s, record_pqueue *q,
46                                unsigned char *priority);
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
54
55 /* Macros/functions provided by the SSL3_BUFFER component */
56
57 #define SSL3_BUFFER_get_buf(b)              ((b)->buf)
58 #define SSL3_BUFFER_set_buf(b, n)           ((b)->buf = (n))
59 #define SSL3_BUFFER_get_len(b)              ((b)->len)
60 #define SSL3_BUFFER_set_len(b, l)           ((b)->len = (l))
61 #define SSL3_BUFFER_get_left(b)             ((b)->left)
62 #define SSL3_BUFFER_set_left(b, l)          ((b)->left = (l))
63 #define SSL3_BUFFER_add_left(b, l)          ((b)->left += (l))
64 #define SSL3_BUFFER_get_offset(b)           ((b)->offset)
65 #define SSL3_BUFFER_set_offset(b, o)        ((b)->offset = (o))
66 #define SSL3_BUFFER_add_offset(b, o)        ((b)->offset += (o))
67 #define SSL3_BUFFER_is_initialised(b)       ((b)->buf != NULL)
68 #define SSL3_BUFFER_set_default_len(b, l)   ((b)->default_len = (l))
69
70 void SSL3_BUFFER_clear(SSL3_BUFFER *b);
71 void SSL3_BUFFER_set_data(SSL3_BUFFER *b, const unsigned char *d, int n);
72 void SSL3_BUFFER_release(SSL3_BUFFER *b);
73 __owur int ssl3_setup_read_buffer(SSL *s);
74 __owur int ssl3_setup_write_buffer(SSL *s, unsigned int numwpipes, size_t len);
75 int ssl3_release_read_buffer(SSL *s);
76 int ssl3_release_write_buffer(SSL *s);
77
78 /* Macros/functions provided by the SSL3_RECORD component */
79
80 #define SSL3_RECORD_get_type(r)                 ((r)->type)
81 #define SSL3_RECORD_set_type(r, t)              ((r)->type = (t))
82 #define SSL3_RECORD_get_length(r)               ((r)->length)
83 #define SSL3_RECORD_set_length(r, l)            ((r)->length = (l))
84 #define SSL3_RECORD_add_length(r, l)            ((r)->length += (l))
85 #define SSL3_RECORD_sub_length(r, l)            ((r)->length -= (l))
86 #define SSL3_RECORD_get_data(r)                 ((r)->data)
87 #define SSL3_RECORD_set_data(r, d)              ((r)->data = (d))
88 #define SSL3_RECORD_get_input(r)                ((r)->input)
89 #define SSL3_RECORD_set_input(r, i)             ((r)->input = (i))
90 #define SSL3_RECORD_reset_input(r)              ((r)->input = (r)->data)
91 #define SSL3_RECORD_get_seq_num(r)              ((r)->seq_num)
92 #define SSL3_RECORD_get_off(r)                  ((r)->off)
93 #define SSL3_RECORD_set_off(r, o)               ((r)->off = (o))
94 #define SSL3_RECORD_add_off(r, o)               ((r)->off += (o))
95 #define SSL3_RECORD_get_epoch(r)                ((r)->epoch)
96 #define SSL3_RECORD_is_sslv2_record(r) \
97             ((r)->rec_version == SSL2_VERSION)
98 #define SSL3_RECORD_is_read(r)                  ((r)->read)
99 #define SSL3_RECORD_set_read(r)                 ((r)->read = 1)
100
101 void SSL3_RECORD_clear(SSL3_RECORD *r, unsigned int num_recs);
102 void SSL3_RECORD_release(SSL3_RECORD *r, unsigned int num_recs);
103 void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num);
104 int ssl3_get_record(SSL *s);
105 __owur int ssl3_do_compress(SSL *ssl, SSL3_RECORD *wr);
106 __owur int ssl3_do_uncompress(SSL *ssl, SSL3_RECORD *rr);
107 void ssl3_cbc_copy_mac(unsigned char *out,
108                        const SSL3_RECORD *rec, unsigned md_size);
109 __owur int ssl3_cbc_remove_padding(SSL3_RECORD *rec,
110                             unsigned block_size, unsigned mac_size);
111 __owur int tls1_cbc_remove_padding(const SSL *s,
112                             SSL3_RECORD *rec,
113                             unsigned block_size, unsigned mac_size);
114 int dtls1_process_record(SSL *s);
115 __owur int dtls1_get_record(SSL *s);