Implement write pipeline support in libssl
[openssl.git] / ssl / record / ssl3_buffer.c
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-2002 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
111 #include "../ssl_locl.h"
112 #include "record_locl.h"
113
114 void SSL3_BUFFER_set_data(SSL3_BUFFER *b, const unsigned char *d, int n)
115 {
116     if (d != NULL)
117         memcpy(b->buf, d, n);
118     b->left = n;
119     b->offset = 0;
120 }
121
122 /*
123  * Clear the contents of an SSL3_BUFFER but retain any memory allocated
124  */
125 void SSL3_BUFFER_clear(SSL3_BUFFER *b)
126 {
127     unsigned char *buf = b->buf;
128     size_t len = b->len;
129
130     memset(b, 0, sizeof(*b));
131     b->buf = buf;
132     b->len = len;
133 }
134
135 void SSL3_BUFFER_release(SSL3_BUFFER *b)
136 {
137     OPENSSL_free(b->buf);
138     b->buf = NULL;
139 }
140
141 int ssl3_setup_read_buffer(SSL *s)
142 {
143     unsigned char *p;
144     size_t len, align = 0, headerlen;
145     SSL3_BUFFER *b;
146     
147     b = RECORD_LAYER_get_rbuf(&s->rlayer);
148
149     if (SSL_IS_DTLS(s))
150         headerlen = DTLS1_RT_HEADER_LENGTH;
151     else
152         headerlen = SSL3_RT_HEADER_LENGTH;
153
154 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
155     align = (-SSL3_RT_HEADER_LENGTH) & (SSL3_ALIGN_PAYLOAD - 1);
156 #endif
157
158     if (b->buf == NULL) {
159         len = SSL3_RT_MAX_PLAIN_LENGTH
160             + SSL3_RT_MAX_ENCRYPTED_OVERHEAD + headerlen + align;
161 #ifndef OPENSSL_NO_COMP
162         if (ssl_allow_compression(s))
163             len += SSL3_RT_MAX_COMPRESSED_OVERHEAD;
164 #endif
165         if ((p = OPENSSL_malloc(len)) == NULL)
166             goto err;
167         b->buf = p;
168         b->len = len;
169     }
170
171     RECORD_LAYER_set_packet(&s->rlayer, &(b->buf[0]));
172     return 1;
173
174  err:
175     SSLerr(SSL_F_SSL3_SETUP_READ_BUFFER, ERR_R_MALLOC_FAILURE);
176     return 0;
177 }
178
179 int ssl3_setup_write_buffer(SSL *s, unsigned int numwpipes)
180 {
181     unsigned char *p;
182     size_t len, align = 0, headerlen;
183     SSL3_BUFFER *wb;
184     unsigned int currpipe;
185
186     s->rlayer.numwpipes = numwpipes;
187
188
189     if (SSL_IS_DTLS(s))
190         headerlen = DTLS1_RT_HEADER_LENGTH + 1;
191     else
192         headerlen = SSL3_RT_HEADER_LENGTH;
193
194 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
195     align = (-SSL3_RT_HEADER_LENGTH) & (SSL3_ALIGN_PAYLOAD - 1);
196 #endif
197
198     len = s->max_send_fragment
199         + SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD + headerlen + align;
200 #ifndef OPENSSL_NO_COMP
201     if (ssl_allow_compression(s))
202         len += SSL3_RT_MAX_COMPRESSED_OVERHEAD;
203 #endif
204     if (!(s->options & SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS))
205         len += headerlen + align + SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD;
206
207     wb = RECORD_LAYER_get_wbuf(&s->rlayer);
208     for (currpipe = 0; currpipe < numwpipes; currpipe++) {
209         if (wb[currpipe].buf == NULL) {
210             if ((p = OPENSSL_malloc(len)) == NULL) {
211                 s->rlayer.numwpipes = currpipe;
212                 goto err;
213             }
214             wb[currpipe].buf = p;
215             wb[currpipe].len = len;
216         }
217     }
218
219     return 1;
220
221  err:
222     SSLerr(SSL_F_SSL3_SETUP_WRITE_BUFFER, ERR_R_MALLOC_FAILURE);
223     return 0;
224 }
225
226 int ssl3_setup_buffers(SSL *s)
227 {
228     if (!ssl3_setup_read_buffer(s))
229         return 0;
230     if (!ssl3_setup_write_buffer(s, 1))
231         return 0;
232     return 1;
233 }
234
235 int ssl3_release_write_buffer(SSL *s)
236 {
237     SSL3_BUFFER *wb;
238     unsigned int pipes;
239
240     pipes = s->rlayer.numwpipes;
241     while (pipes > 0) {
242         wb = &RECORD_LAYER_get_wbuf(&s->rlayer)[pipes - 1];
243
244         OPENSSL_free(wb->buf);
245         wb->buf = NULL;
246         pipes--;
247     }
248     s->rlayer.numwpipes = 0;
249     return 1;
250 }
251
252 int ssl3_release_read_buffer(SSL *s)
253 {
254     SSL3_BUFFER *b;
255
256     b = RECORD_LAYER_get_rbuf(&s->rlayer);
257     OPENSSL_free(b->buf);
258     b->buf = NULL;
259     return 1;
260 }