Tidy up rec_layer.h. Add some comments regarding which functions should be
[openssl.git] / ssl / record / rec_layer.h
1 /* ssl/record/rec_layer.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2002 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer.
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112 #include "../ssl_locl.h"
113
114 /*****************************************************************************
115  *                                                                           *
116  * These structures should be considered "opaque" to anything outside of the *
117  * record layer. No non-record layer code should be accessing the members of *
118  * these structures.                                                         *
119  *                                                                           *
120  *****************************************************************************/
121
122 typedef struct dtls1_bitmap_st {
123     unsigned long map;          /* track 32 packets on 32-bit systems and 64
124                                  * - on 64-bit systems */
125     unsigned char max_seq_num[8]; /* max record number seen so far, 64-bit
126                                    * value in big-endian encoding */
127 } DTLS1_BITMAP;
128
129
130 typedef struct record_pqueue_st {
131     unsigned short epoch;
132     pqueue q;
133 } record_pqueue;
134
135 typedef struct record_layer_st {
136     /* The parent SSL structure */
137     SSL *s;
138     /*
139      * Read as many input bytes as possible (for
140      * non-blocking reads)
141      */
142     int read_ahead;
143     /* read IO goes into here */
144     SSL3_BUFFER rbuf;
145     /* write IO goes into here */
146     SSL3_BUFFER wbuf;
147     /* each decoded record goes in here */
148     SSL3_RECORD rrec;
149     /* goes out from here */
150     SSL3_RECORD wrec;
151 } RECORD_LAYER;
152
153
154 /*****************************************************************************
155  *                                                                           *
156  * The following macros/functions represent the libssl internal API to the   *
157  * record layer.                                                             *
158  *                                                                           *
159  *****************************************************************************/
160
161 #define RECORD_LAYER_set_ssl(rl, s)             ((rl)->s = (s))
162 #define RECORD_LAYER_set_read_ahead(rl, ra)     ((rl)->read_ahead = (ra))
163 #define RECORD_LAYER_get_read_ahead(rl)         ((rl)->read_ahead)
164 #define RECORD_LAYER_get_rbuf(rl)               (&(rl)->rbuf)
165 #define RECORD_LAYER_get_wbuf(rl)               (&(rl)->wbuf)
166 #define RECORD_LAYER_get_rrec(rl)               (&(rl)->rrec)
167 #define RECORD_LAYER_get_wrec(rl)               (&(rl)->wrec)
168
169 __owur int ssl23_read_bytes(SSL *s, int n);
170 __owur int ssl23_write_bytes(SSL *s);
171 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
172 __owur int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
173                          unsigned int len, int create_empty_fragment);
174 __owur int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
175 __owur int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
176 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len);
177 __owur int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
178                    unsigned int len, int create_empty_fragement);
179 void dtls1_reset_seq_numbers(SSL *s, int rw);
180
181
182 /*****************************************************************************
183  *                                                                           *
184  * The following functions are private to the record layer. They should not  *
185  * be used outside of the record layer.                                      *
186  *                                                                           *
187  *****************************************************************************/
188
189 __owur int ssl3_read_n(SSL *s, int n, int max, int extend);
190 __owur int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
191                        unsigned int len);
192 int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap);
193 void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);
194 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
195                                       unsigned int *is_next_epoch);
196 int dtls1_process_buffered_records(SSL *s);
197 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue);
198 int dtls1_buffer_record(SSL *s, record_pqueue *q,
199                                unsigned char *priority);
200