]> git.ipfire.org Git - thirdparty/openssl.git/blame - ssl/record/record_locl.h
Remove unused parameters from internal functions
[thirdparty/openssl.git] / ssl / record / record_locl.h
CommitLineData
258f8721
MC
1/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57/* ====================================================================
58 * Copyright (c) 1998-2015 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
108 *
109 */
110
44cc35d3
MC
111
112/*****************************************************************************
113 * *
114 * The following macros/functions are PRIVATE to the record layer. They *
115 * should NOT be used outside of the record layer. *
116 * *
117 *****************************************************************************/
118
119/* Functions/macros provided by the RECORD_LAYER component */
120
121#define RECORD_LAYER_get_rbuf(rl) (&(rl)->rbuf)
122#define RECORD_LAYER_get_wbuf(rl) (&(rl)->wbuf)
123#define RECORD_LAYER_get_rrec(rl) (&(rl)->rrec)
124#define RECORD_LAYER_get_wrec(rl) (&(rl)->wrec)
125#define RECORD_LAYER_set_packet(rl, p) ((rl)->packet = (p))
126#define RECORD_LAYER_reset_packet_length(rl) ((rl)->packet_length = 0)
127#define RECORD_LAYER_get_rstate(rl) ((rl)->rstate)
128#define RECORD_LAYER_set_rstate(rl, st) ((rl)->rstate = (st))
129#define RECORD_LAYER_get_read_sequence(rl) ((rl)->read_sequence)
130#define RECORD_LAYER_get_write_sequence(rl) ((rl)->write_sequence)
131#define DTLS_RECORD_LAYER_get_r_epoch(rl) ((rl)->d->r_epoch)
132
133__owur int ssl3_read_n(SSL *s, int n, int max, int extend);
134
135void RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, const unsigned char *ws);
136DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
137 unsigned int *is_next_epoch);
138int dtls1_process_buffered_records(SSL *s);
139int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue);
140int dtls1_buffer_record(SSL *s, record_pqueue *q,
141 unsigned char *priority);
142void ssl3_record_sequence_update(unsigned char *seq);
143
144/* Functions provided by the DTLS1_BITMAP component */
145
146int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap);
147void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);
148
149
150/* Macros/functions provided by the SSL3_BUFFER component */
151
152#define SSL3_BUFFER_get_buf(b) ((b)->buf)
153#define SSL3_BUFFER_set_buf(b, n) ((b)->buf = (n))
154#define SSL3_BUFFER_get_len(b) ((b)->len)
155#define SSL3_BUFFER_set_len(b, l) ((b)->len = (l))
156#define SSL3_BUFFER_get_left(b) ((b)->left)
747e1639
MC
157#define SSL3_BUFFER_set_left(b, l) ((b)->left = (l))
158#define SSL3_BUFFER_add_left(b, l) ((b)->left += (l))
159#define SSL3_BUFFER_get_offset(b) ((b)->offset)
160#define SSL3_BUFFER_set_offset(b, o) ((b)->offset = (o))
161#define SSL3_BUFFER_add_offset(b, o) ((b)->offset += (o))
44cc35d3
MC
162#define SSL3_BUFFER_is_initialised(b) ((b)->buf != NULL)
163
6b41b3f5 164void SSL3_BUFFER_clear(SSL3_BUFFER *b);
44cc35d3
MC
165void SSL3_BUFFER_set_data(SSL3_BUFFER *b, const unsigned char *d, int n);
166void SSL3_BUFFER_release(SSL3_BUFFER *b);
167__owur int ssl3_setup_read_buffer(SSL *s);
168__owur int ssl3_setup_write_buffer(SSL *s);
169int ssl3_release_read_buffer(SSL *s);
170int ssl3_release_write_buffer(SSL *s);
171
172/* Macros/functions provided by the SSL3_RECORD component */
258f8721
MC
173
174#define SSL3_RECORD_get_type(r) ((r)->type)
747e1639 175#define SSL3_RECORD_set_type(r, t) ((r)->type = (t))
258f8721 176#define SSL3_RECORD_get_length(r) ((r)->length)
747e1639
MC
177#define SSL3_RECORD_set_length(r, l) ((r)->length = (l))
178#define SSL3_RECORD_add_length(r, l) ((r)->length += (l))
258f8721 179#define SSL3_RECORD_get_data(r) ((r)->data)
747e1639
MC
180#define SSL3_RECORD_set_data(r, d) ((r)->data = (d))
181#define SSL3_RECORD_get_input(r) ((r)->input)
182#define SSL3_RECORD_set_input(r, i) ((r)->input = (i))
183#define SSL3_RECORD_reset_input(r) ((r)->input = (r)->data)
258f8721 184#define SSL3_RECORD_get_seq_num(r) ((r)->seq_num)
747e1639
MC
185#define SSL3_RECORD_get_off(r) ((r)->off)
186#define SSL3_RECORD_set_off(r, o) ((r)->off = (o))
187#define SSL3_RECORD_add_off(r, o) ((r)->off += (o))
188#define SSL3_RECORD_get_epoch(r) ((r)->epoch)
32ec4153
MC
189#define SSL3_RECORD_is_sslv2_record(r) \
190 ((r)->rec_version == SSL2_VERSION)
258f8721
MC
191
192void SSL3_RECORD_clear(SSL3_RECORD *r);
193void SSL3_RECORD_release(SSL3_RECORD *r);
bd2e3a95 194int SSL3_RECORD_setup(SSL3_RECORD *r);
258f8721 195void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num);
fe589e61
MC
196int ssl3_get_record(SSL *s);
197__owur int ssl3_do_compress(SSL *ssl);
198__owur int ssl3_do_uncompress(SSL *ssl);
02a36fda
MC
199void ssl3_cbc_copy_mac(unsigned char *out,
200 const SSL3_RECORD *rec, unsigned md_size);
a773b52a 201__owur int ssl3_cbc_remove_padding(SSL3_RECORD *rec,
02a36fda
MC
202 unsigned block_size, unsigned mac_size);
203__owur int tls1_cbc_remove_padding(const SSL *s,
204 SSL3_RECORD *rec,
205 unsigned block_size, unsigned mac_size);
fe589e61 206int dtls1_process_record(SSL *s);
02a36fda 207__owur int dtls1_get_record(SSL *s);