blob: 56b0145d4cb1dda26b86ccf310bf85872084938e [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* 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
David Benjamin9e4e01e2015-09-15 01:48:04 -0400109#include <openssl/ssl.h>
110
Adam Langley95c29f32014-06-20 12:00:00 -0700111#include <assert.h>
Adam Langley87750b42014-06-20 12:00:00 -0700112#include <limits.h>
David Benjaminf0ae1702015-04-07 23:05:04 -0400113#include <string.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700114
115#include <openssl/buf.h>
116#include <openssl/err.h>
117#include <openssl/evp.h>
118#include <openssl/mem.h>
119#include <openssl/rand.h>
120
David Benjamin2ee94aa2015-04-07 22:38:30 -0400121#include "internal.h"
Adam Langley95c29f32014-06-20 12:00:00 -0700122
Adam Langleyfcf25832014-12-18 17:42:32 -0800123
David Benjamin0d56f882015-12-19 17:05:56 -0500124static int do_ssl3_write(SSL *ssl, int type, const uint8_t *buf, unsigned len);
Adam Langley95c29f32014-06-20 12:00:00 -0700125
David Benjamin24f346d2015-06-06 03:28:08 -0400126/* kMaxWarningAlerts is the number of consecutive warning alerts that will be
127 * processed. */
128static const uint8_t kMaxWarningAlerts = 4;
129
David Benjaminb8d28cf2015-07-28 21:34:45 -0400130/* ssl3_get_record reads a new input record. On success, it places it in
131 * |ssl->s3->rrec| and returns one. Otherwise it returns <= 0 on error or if
132 * more data is needed. */
133static int ssl3_get_record(SSL *ssl) {
134 int ret;
Adam Langley95c29f32014-06-20 12:00:00 -0700135again:
David Benjaminb8d28cf2015-07-28 21:34:45 -0400136 /* Ensure the buffer is large enough to decrypt in-place. */
137 ret = ssl_read_buffer_extend_to(ssl, ssl_record_prefix_len(ssl));
138 if (ret <= 0) {
139 return ret;
140 }
141 assert(ssl_read_buffer_len(ssl) >= ssl_record_prefix_len(ssl));
Adam Langley95c29f32014-06-20 12:00:00 -0700142
David Benjaminb8d28cf2015-07-28 21:34:45 -0400143 uint8_t *out = ssl_read_buffer(ssl) + ssl_record_prefix_len(ssl);
144 size_t max_out = ssl_read_buffer_len(ssl) - ssl_record_prefix_len(ssl);
145 uint8_t type, alert;
146 size_t len, consumed;
147 switch (tls_open_record(ssl, &type, out, &len, &consumed, &alert, max_out,
148 ssl_read_buffer(ssl), ssl_read_buffer_len(ssl))) {
149 case ssl_open_record_success:
150 ssl_read_buffer_consume(ssl, consumed);
David Benjamin6a08da22015-05-08 22:58:12 -0400151
David Benjaminb8d28cf2015-07-28 21:34:45 -0400152 if (len > 0xffff) {
153 OPENSSL_PUT_ERROR(SSL, ERR_R_OVERFLOW);
154 return -1;
155 }
Adam Langley95c29f32014-06-20 12:00:00 -0700156
David Benjaminb8d28cf2015-07-28 21:34:45 -0400157 SSL3_RECORD *rr = &ssl->s3->rrec;
158 rr->type = type;
159 rr->length = (uint16_t)len;
David Benjaminb8d28cf2015-07-28 21:34:45 -0400160 rr->data = out;
161 return 1;
Adam Langley95c29f32014-06-20 12:00:00 -0700162
David Benjaminb8d28cf2015-07-28 21:34:45 -0400163 case ssl_open_record_partial:
164 ret = ssl_read_buffer_extend_to(ssl, consumed);
165 if (ret <= 0) {
166 return ret;
167 }
168 goto again;
Adam Langley95c29f32014-06-20 12:00:00 -0700169
David Benjaminb8d28cf2015-07-28 21:34:45 -0400170 case ssl_open_record_discard:
171 ssl_read_buffer_consume(ssl, consumed);
172 goto again;
Adam Langley95c29f32014-06-20 12:00:00 -0700173
David Benjaminb8d28cf2015-07-28 21:34:45 -0400174 case ssl_open_record_error:
175 ssl3_send_alert(ssl, SSL3_AL_FATAL, alert);
176 return -1;
Adam Langleyfcf25832014-12-18 17:42:32 -0800177 }
Adam Langley95c29f32014-06-20 12:00:00 -0700178
David Benjaminb8d28cf2015-07-28 21:34:45 -0400179 assert(0);
180 OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
181 return -1;
Adam Langleyfcf25832014-12-18 17:42:32 -0800182}
Adam Langley95c29f32014-06-20 12:00:00 -0700183
David Benjaminc933a472015-05-30 16:14:58 -0400184int ssl3_write_app_data(SSL *ssl, const void *buf, int len) {
David Benjamind7ac1432016-03-10 00:41:25 -0500185 assert(!SSL_in_init(ssl) || SSL_in_false_start(ssl));
186
David Benjaminc933a472015-05-30 16:14:58 -0400187 return ssl3_write_bytes(ssl, SSL3_RT_APPLICATION_DATA, buf, len);
188}
189
Adam Langleyfcf25832014-12-18 17:42:32 -0800190/* Call this to write data in records of type |type|. It will return <= 0 if
191 * not all data has been sent or non-blocking IO. */
David Benjamin0d56f882015-12-19 17:05:56 -0500192int ssl3_write_bytes(SSL *ssl, int type, const void *buf_, int len) {
Adam Langleyfcf25832014-12-18 17:42:32 -0800193 const uint8_t *buf = buf_;
David Benjamina8571592016-03-10 01:41:55 -0500194 unsigned tot, n, nw;
Adam Langley95c29f32014-06-20 12:00:00 -0700195
David Benjamin0d56f882015-12-19 17:05:56 -0500196 ssl->rwstate = SSL_NOTHING;
197 assert(ssl->s3->wnum <= INT_MAX);
198 tot = ssl->s3->wnum;
199 ssl->s3->wnum = 0;
Adam Langley95c29f32014-06-20 12:00:00 -0700200
Adam Langleyfcf25832014-12-18 17:42:32 -0800201 /* Ensure that if we end up with a smaller value of data to write out than
202 * the the original len from a write which didn't complete for non-blocking
203 * I/O and also somehow ended up avoiding the check for this in
204 * ssl3_write_pending/SSL_R_BAD_WRITE_RETRY as it must never be possible to
205 * end up with (len-tot) as a large number that will then promptly send
206 * beyond the end of the users buffer ... so we trap and report the error in
207 * a way the user will notice. */
208 if (len < 0 || (size_t)len < tot) {
David Benjamin3570d732015-06-29 00:28:17 -0400209 OPENSSL_PUT_ERROR(SSL, SSL_R_BAD_LENGTH);
Adam Langleyfcf25832014-12-18 17:42:32 -0800210 return -1;
211 }
Adam Langley9611cfc2014-06-20 12:00:00 -0700212
Adam Langleyfcf25832014-12-18 17:42:32 -0800213 n = (len - tot);
214 for (;;) {
215 /* max contains the maximum number of bytes that we can put into a
216 * record. */
David Benjamin0d56f882015-12-19 17:05:56 -0500217 unsigned max = ssl->max_send_fragment;
Adam Langleyfcf25832014-12-18 17:42:32 -0800218 if (n > max) {
219 nw = max;
220 } else {
221 nw = n;
222 }
Adam Langley95c29f32014-06-20 12:00:00 -0700223
David Benjamina8571592016-03-10 01:41:55 -0500224 int ret = do_ssl3_write(ssl, type, &buf[tot], nw);
225 if (ret <= 0) {
David Benjamin0d56f882015-12-19 17:05:56 -0500226 ssl->s3->wnum = tot;
David Benjamina8571592016-03-10 01:41:55 -0500227 return ret;
Adam Langleyfcf25832014-12-18 17:42:32 -0800228 }
Adam Langley95c29f32014-06-20 12:00:00 -0700229
David Benjamina8571592016-03-10 01:41:55 -0500230 if (ret == (int)n || (type == SSL3_RT_APPLICATION_DATA &&
231 (ssl->mode & SSL_MODE_ENABLE_PARTIAL_WRITE))) {
232 return tot + ret;
Adam Langleyfcf25832014-12-18 17:42:32 -0800233 }
Adam Langley95c29f32014-06-20 12:00:00 -0700234
David Benjamina8571592016-03-10 01:41:55 -0500235 n -= ret;
236 tot += ret;
Adam Langleyfcf25832014-12-18 17:42:32 -0800237 }
238}
Adam Langley95c29f32014-06-20 12:00:00 -0700239
David Benjamin0d56f882015-12-19 17:05:56 -0500240static int ssl3_write_pending(SSL *ssl, int type, const uint8_t *buf,
David Benjamin2e0901b2015-11-02 17:50:10 -0500241 unsigned int len) {
David Benjamin0d56f882015-12-19 17:05:56 -0500242 if (ssl->s3->wpend_tot > (int)len ||
243 (ssl->s3->wpend_buf != buf &&
244 !(ssl->mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER)) ||
245 ssl->s3->wpend_type != type) {
David Benjamin2e0901b2015-11-02 17:50:10 -0500246 OPENSSL_PUT_ERROR(SSL, SSL_R_BAD_WRITE_RETRY);
247 return -1;
248 }
249
David Benjamin0d56f882015-12-19 17:05:56 -0500250 int ret = ssl_write_buffer_flush(ssl);
David Benjamin2e0901b2015-11-02 17:50:10 -0500251 if (ret <= 0) {
252 return ret;
253 }
David Benjamin0d56f882015-12-19 17:05:56 -0500254 return ssl->s3->wpend_ret;
David Benjamin2e0901b2015-11-02 17:50:10 -0500255}
256
David Benjaminb8d28cf2015-07-28 21:34:45 -0400257/* do_ssl3_write writes an SSL record of the given type. */
David Benjamin0d56f882015-12-19 17:05:56 -0500258static int do_ssl3_write(SSL *ssl, int type, const uint8_t *buf, unsigned len) {
David Benjaminb8d28cf2015-07-28 21:34:45 -0400259 /* If there is still data from the previous record, flush it. */
David Benjamin0d56f882015-12-19 17:05:56 -0500260 if (ssl_write_buffer_is_pending(ssl)) {
261 return ssl3_write_pending(ssl, type, buf, len);
Adam Langleyfcf25832014-12-18 17:42:32 -0800262 }
Adam Langley95c29f32014-06-20 12:00:00 -0700263
Adam Langleyfcf25832014-12-18 17:42:32 -0800264 /* If we have an alert to send, lets send it */
David Benjamin0d56f882015-12-19 17:05:56 -0500265 if (ssl->s3->alert_dispatch) {
266 int ret = ssl->method->ssl_dispatch_alert(ssl);
David Benjamin9faafda2015-04-04 19:23:10 -0400267 if (ret <= 0) {
268 return ret;
Adam Langleyfcf25832014-12-18 17:42:32 -0800269 }
270 /* if it went, fall through and send more stuff */
271 }
Adam Langley95c29f32014-06-20 12:00:00 -0700272
David Benjaminb8d28cf2015-07-28 21:34:45 -0400273 if (len > SSL3_RT_MAX_PLAIN_LENGTH) {
274 OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
Adam Langleyfcf25832014-12-18 17:42:32 -0800275 return -1;
276 }
Adam Langleyc6c8ae82014-06-20 12:00:00 -0700277
Adam Langleyfcf25832014-12-18 17:42:32 -0800278 if (len == 0) {
279 return 0;
280 }
Adam Langley95c29f32014-06-20 12:00:00 -0700281
David Benjamin0d56f882015-12-19 17:05:56 -0500282 size_t max_out = len + ssl_max_seal_overhead(ssl);
David Benjaminb8d28cf2015-07-28 21:34:45 -0400283 if (max_out < len) {
284 OPENSSL_PUT_ERROR(SSL, ERR_R_OVERFLOW);
David Benjamin9faafda2015-04-04 19:23:10 -0400285 return -1;
Adam Langleyfcf25832014-12-18 17:42:32 -0800286 }
David Benjaminb8d28cf2015-07-28 21:34:45 -0400287 uint8_t *out;
288 size_t ciphertext_len;
David Benjamin0d56f882015-12-19 17:05:56 -0500289 if (!ssl_write_buffer_init(ssl, &out, max_out) ||
290 !tls_seal_record(ssl, out, &ciphertext_len, max_out, type, buf, len)) {
David Benjaminb8d28cf2015-07-28 21:34:45 -0400291 return -1;
292 }
David Benjamin0d56f882015-12-19 17:05:56 -0500293 ssl_write_buffer_set_len(ssl, ciphertext_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700294
Adam Langleyfcf25832014-12-18 17:42:32 -0800295 /* memorize arguments so that ssl3_write_pending can detect bad write retries
296 * later */
David Benjamin0d56f882015-12-19 17:05:56 -0500297 ssl->s3->wpend_tot = len;
298 ssl->s3->wpend_buf = buf;
299 ssl->s3->wpend_type = type;
300 ssl->s3->wpend_ret = len;
Adam Langleyfcf25832014-12-18 17:42:32 -0800301
302 /* we now just need to write the buffer */
David Benjamin0d56f882015-12-19 17:05:56 -0500303 return ssl3_write_pending(ssl, type, buf, len);
Adam Langleyfcf25832014-12-18 17:42:32 -0800304}
Adam Langley95c29f32014-06-20 12:00:00 -0700305
David Benjamina6022772015-05-30 16:22:10 -0400306int ssl3_read_app_data(SSL *ssl, uint8_t *buf, int len, int peek) {
David Benjaminc79845c2016-03-10 01:28:00 -0500307 assert(!SSL_in_init(ssl));
David Benjamina6022772015-05-30 16:22:10 -0400308 return ssl3_read_bytes(ssl, SSL3_RT_APPLICATION_DATA, buf, len, peek);
309}
310
David Benjamina41280d2015-11-26 02:16:49 -0500311int ssl3_read_change_cipher_spec(SSL *ssl) {
312 uint8_t byte;
313 int ret = ssl3_read_bytes(ssl, SSL3_RT_CHANGE_CIPHER_SPEC, &byte, 1 /* len */,
314 0 /* no peek */);
315 if (ret <= 0) {
316 return ret;
317 }
318 assert(ret == 1);
319
320 if (ssl->s3->rrec.length != 0 || byte != SSL3_MT_CCS) {
321 OPENSSL_PUT_ERROR(SSL, SSL_R_BAD_CHANGE_CIPHER_SPEC);
322 ssl3_send_alert(ssl, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
323 return -1;
324 }
325
326 if (ssl->msg_callback != NULL) {
327 ssl->msg_callback(0, ssl->version, SSL3_RT_CHANGE_CIPHER_SPEC, &byte, 1,
328 ssl, ssl->msg_callback_arg);
329 }
330
331 return 1;
332}
333
David Benjamina6022772015-05-30 16:22:10 -0400334void ssl3_read_close_notify(SSL *ssl) {
335 ssl3_read_bytes(ssl, 0, NULL, 0, 0);
336}
337
David Benjamin1d5ef3b2015-10-12 19:54:18 -0400338static int ssl3_can_renegotiate(SSL *ssl) {
339 switch (ssl->renegotiate_mode) {
340 case ssl_renegotiate_never:
341 return 0;
342 case ssl_renegotiate_once:
343 return ssl->s3->total_renegotiations == 0;
344 case ssl_renegotiate_freely:
345 return 1;
Adam Langley27a0d082015-11-03 13:34:10 -0800346 case ssl_renegotiate_ignore:
347 return 1;
David Benjamin1d5ef3b2015-10-12 19:54:18 -0400348 }
349
350 assert(0);
351 return 0;
352}
353
Adam Langley95c29f32014-06-20 12:00:00 -0700354/* Return up to 'len' payload bytes received in 'type' records.
355 * 'type' is one of the following:
356 *
357 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
David Benjamina41280d2015-11-26 02:16:49 -0500358 * - SSL3_RT_CHANGE_CIPHER_SPEC (when ssl3_read_change_cipher_spec calls us)
359 * - SSL3_RT_APPLICATION_DATA (when ssl3_read_app_data calls us)
Adam Langley95c29f32014-06-20 12:00:00 -0700360 * - 0 (during a shutdown, no data has to be returned)
361 *
362 * If we don't have stored data to work from, read a SSL/TLS record first
363 * (possibly multiple records if we still don't have anything to return).
364 *
365 * This function must handle any surprises the peer may have for us, such as
David Benjamina41280d2015-11-26 02:16:49 -0500366 * Alert records (e.g. close_notify) or renegotiation requests. */
David Benjamin0d56f882015-12-19 17:05:56 -0500367int ssl3_read_bytes(SSL *ssl, int type, uint8_t *buf, int len, int peek) {
David Benjamin86058a22015-02-22 13:07:21 -0500368 int al, i, ret;
Adam Langleyfcf25832014-12-18 17:42:32 -0800369 unsigned int n;
370 SSL3_RECORD *rr;
David Benjamin82170242015-10-17 22:51:17 -0400371 void (*cb)(const SSL *ssl, int type, int value) = NULL;
Adam Langley95c29f32014-06-20 12:00:00 -0700372
David Benjamina41280d2015-11-26 02:16:49 -0500373 if ((type && type != SSL3_RT_APPLICATION_DATA && type != SSL3_RT_HANDSHAKE &&
374 type != SSL3_RT_CHANGE_CIPHER_SPEC) ||
Adam Langleyfcf25832014-12-18 17:42:32 -0800375 (peek && type != SSL3_RT_APPLICATION_DATA)) {
David Benjamin3570d732015-06-29 00:28:17 -0400376 OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
Adam Langleyfcf25832014-12-18 17:42:32 -0800377 return -1;
378 }
Adam Langley95c29f32014-06-20 12:00:00 -0700379
Adam Langley95c29f32014-06-20 12:00:00 -0700380start:
David Benjamin0d56f882015-12-19 17:05:56 -0500381 ssl->rwstate = SSL_NOTHING;
Adam Langley95c29f32014-06-20 12:00:00 -0700382
David Benjamin0d56f882015-12-19 17:05:56 -0500383 /* ssl->s3->rrec.type - is the type of record
384 * ssl->s3->rrec.data - data
385 * ssl->s3->rrec.off - offset into 'data' for next read
386 * ssl->s3->rrec.length - number of bytes. */
387 rr = &ssl->s3->rrec;
Adam Langley95c29f32014-06-20 12:00:00 -0700388
Adam Langleyfcf25832014-12-18 17:42:32 -0800389 /* get new packet if necessary */
David Benjaminb8d28cf2015-07-28 21:34:45 -0400390 if (rr->length == 0) {
David Benjamin0d56f882015-12-19 17:05:56 -0500391 ret = ssl3_get_record(ssl);
Adam Langleyfcf25832014-12-18 17:42:32 -0800392 if (ret <= 0) {
393 return ret;
394 }
395 }
Adam Langley95c29f32014-06-20 12:00:00 -0700396
Adam Langleyfcf25832014-12-18 17:42:32 -0800397 /* we now have a packet which can be read and processed */
Adam Langley95c29f32014-06-20 12:00:00 -0700398
Adam Langleyfcf25832014-12-18 17:42:32 -0800399 /* If the other end has shut down, throw anything we read away (even in
400 * 'peek' mode) */
David Benjamin0d56f882015-12-19 17:05:56 -0500401 if (ssl->shutdown & SSL_RECEIVED_SHUTDOWN) {
Adam Langleyfcf25832014-12-18 17:42:32 -0800402 rr->length = 0;
David Benjamin0d56f882015-12-19 17:05:56 -0500403 ssl->rwstate = SSL_NOTHING;
Adam Langleyfcf25832014-12-18 17:42:32 -0800404 return 0;
405 }
Adam Langley95c29f32014-06-20 12:00:00 -0700406
David Benjaminee0b02a2015-08-22 11:35:40 -0400407 if (type != 0 && type == rr->type) {
David Benjamin0d56f882015-12-19 17:05:56 -0500408 ssl->s3->warning_alert_count = 0;
David Benjamin24f346d2015-06-06 03:28:08 -0400409
David Benjamina41280d2015-11-26 02:16:49 -0500410 /* Make sure that we are not getting application data when we are doing a
411 * handshake for the first time. */
David Benjamin0d56f882015-12-19 17:05:56 -0500412 if (SSL_in_init(ssl) && type == SSL3_RT_APPLICATION_DATA &&
David Benjamin79978df2015-12-25 15:56:49 -0500413 ssl->s3->aead_read_ctx == NULL) {
David Benjaminb8a56f12014-12-23 11:41:02 -0500414 /* TODO(davidben): Is this check redundant with the handshake_func
415 * check? */
Adam Langleyfcf25832014-12-18 17:42:32 -0800416 al = SSL_AD_UNEXPECTED_MESSAGE;
David Benjamin3570d732015-06-29 00:28:17 -0400417 OPENSSL_PUT_ERROR(SSL, SSL_R_APP_DATA_IN_HANDSHAKE);
Adam Langleyfcf25832014-12-18 17:42:32 -0800418 goto f_err;
419 }
Adam Langley95c29f32014-06-20 12:00:00 -0700420
David Benjamin4cf369b2015-08-22 01:35:43 -0400421 /* Discard empty records. */
422 if (rr->length == 0) {
423 goto start;
424 }
425
Adam Langleyfcf25832014-12-18 17:42:32 -0800426 if (len <= 0) {
427 return len;
428 }
Adam Langley95c29f32014-06-20 12:00:00 -0700429
Adam Langleyfcf25832014-12-18 17:42:32 -0800430 if ((unsigned int)len > rr->length) {
431 n = rr->length;
432 } else {
433 n = (unsigned int)len;
434 }
Adam Langley95c29f32014-06-20 12:00:00 -0700435
David Benjamin7fc01002015-12-06 15:48:22 -0500436 memcpy(buf, rr->data, n);
Adam Langleyfcf25832014-12-18 17:42:32 -0800437 if (!peek) {
438 rr->length -= n;
David Benjamin7fc01002015-12-06 15:48:22 -0500439 rr->data += n;
Adam Langleyfcf25832014-12-18 17:42:32 -0800440 if (rr->length == 0) {
David Benjaminb8d28cf2015-07-28 21:34:45 -0400441 /* The record has been consumed, so we may now clear the buffer. */
David Benjamin0d56f882015-12-19 17:05:56 -0500442 ssl_read_buffer_discard(ssl);
Adam Langleyfcf25832014-12-18 17:42:32 -0800443 }
444 }
445
446 return n;
447 }
Adam Langley95c29f32014-06-20 12:00:00 -0700448
David Benjamin44d3eed2015-05-21 01:29:55 -0400449 /* Process unexpected records. */
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400450
David Benjamina41280d2015-11-26 02:16:49 -0500451 if (type == SSL3_RT_APPLICATION_DATA && rr->type == SSL3_RT_HANDSHAKE) {
David Benjaminb16346b2015-04-08 19:16:58 -0400452 /* If peer renegotiations are disabled, all out-of-order handshake records
David Benjamin44d3eed2015-05-21 01:29:55 -0400453 * are fatal. Renegotiations as a server are never supported. */
David Benjamin0d56f882015-12-19 17:05:56 -0500454 if (ssl->server || !ssl3_can_renegotiate(ssl)) {
David Benjaminb16346b2015-04-08 19:16:58 -0400455 al = SSL_AD_NO_RENEGOTIATION;
David Benjamin3570d732015-06-29 00:28:17 -0400456 OPENSSL_PUT_ERROR(SSL, SSL_R_NO_RENEGOTIATION);
David Benjaminb16346b2015-04-08 19:16:58 -0400457 goto f_err;
458 }
459
David Benjamin8fd5c232015-11-26 01:39:53 -0500460 /* This must be a HelloRequest, possibly fragmented over multiple records.
461 * Consume data from the handshake protocol until it is complete. */
462 static const uint8_t kHelloRequest[] = {SSL3_MT_HELLO_REQUEST, 0, 0, 0};
David Benjamin0d56f882015-12-19 17:05:56 -0500463 while (ssl->s3->hello_request_len < sizeof(kHelloRequest)) {
David Benjamin8fd5c232015-11-26 01:39:53 -0500464 if (rr->length == 0) {
465 /* Get a new record. */
466 goto start;
467 }
David Benjamin0d56f882015-12-19 17:05:56 -0500468 if (rr->data[0] != kHelloRequest[ssl->s3->hello_request_len]) {
David Benjamin8fd5c232015-11-26 01:39:53 -0500469 al = SSL_AD_DECODE_ERROR;
470 OPENSSL_PUT_ERROR(SSL, SSL_R_BAD_HELLO_REQUEST);
471 goto f_err;
472 }
David Benjamin7fc01002015-12-06 15:48:22 -0500473 rr->data++;
David Benjamin8fd5c232015-11-26 01:39:53 -0500474 rr->length--;
David Benjamin0d56f882015-12-19 17:05:56 -0500475 ssl->s3->hello_request_len++;
Adam Langleyfcf25832014-12-18 17:42:32 -0800476 }
David Benjamin0d56f882015-12-19 17:05:56 -0500477 ssl->s3->hello_request_len = 0;
Adam Langley95c29f32014-06-20 12:00:00 -0700478
David Benjamin0d56f882015-12-19 17:05:56 -0500479 if (ssl->msg_callback) {
480 ssl->msg_callback(0, ssl->version, SSL3_RT_HANDSHAKE, kHelloRequest,
481 sizeof(kHelloRequest), ssl, ssl->msg_callback_arg);
Adam Langleyfcf25832014-12-18 17:42:32 -0800482 }
Adam Langley95c29f32014-06-20 12:00:00 -0700483
David Benjamin0d56f882015-12-19 17:05:56 -0500484 if (!SSL_is_init_finished(ssl) || !ssl->s3->initial_handshake_complete) {
David Benjamincd90f3a2015-05-21 01:37:55 -0400485 /* This cannot happen. If a handshake is in progress, |type| must be
486 * |SSL3_RT_HANDSHAKE|. */
487 assert(0);
David Benjamin3570d732015-06-29 00:28:17 -0400488 OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
David Benjamincd90f3a2015-05-21 01:37:55 -0400489 goto err;
Adam Langleyfcf25832014-12-18 17:42:32 -0800490 }
David Benjamincd90f3a2015-05-21 01:37:55 -0400491
David Benjamin0d56f882015-12-19 17:05:56 -0500492 if (ssl->renegotiate_mode == ssl_renegotiate_ignore) {
Adam Langley27a0d082015-11-03 13:34:10 -0800493 goto start;
494 }
495
David Benjamincd90f3a2015-05-21 01:37:55 -0400496 /* Renegotiation is only supported at quiescent points in the application
497 * protocol, namely in HTTPS, just before reading the HTTP response. Require
498 * the record-layer be idle and avoid complexities of sending a handshake
499 * record while an application_data record is being written. */
David Benjamin0d56f882015-12-19 17:05:56 -0500500 if (ssl_write_buffer_is_pending(ssl)) {
David Benjamincd90f3a2015-05-21 01:37:55 -0400501 al = SSL_AD_NO_RENEGOTIATION;
David Benjamin3570d732015-06-29 00:28:17 -0400502 OPENSSL_PUT_ERROR(SSL, SSL_R_NO_RENEGOTIATION);
David Benjamincd90f3a2015-05-21 01:37:55 -0400503 goto f_err;
504 }
505
506 /* Begin a new handshake. */
David Benjamin0d56f882015-12-19 17:05:56 -0500507 ssl->s3->total_renegotiations++;
508 ssl->state = SSL_ST_CONNECT;
509 i = ssl->handshake_func(ssl);
David Benjamincd90f3a2015-05-21 01:37:55 -0400510 if (i < 0) {
511 return i;
512 }
513 if (i == 0) {
David Benjamin3570d732015-06-29 00:28:17 -0400514 OPENSSL_PUT_ERROR(SSL, SSL_R_SSL_HANDSHAKE_FAILURE);
David Benjamincd90f3a2015-05-21 01:37:55 -0400515 return -1;
516 }
517
518 /* The handshake completed synchronously. Continue reading records. */
Adam Langleyfcf25832014-12-18 17:42:32 -0800519 goto start;
520 }
David Benjaminb4188f02014-11-01 03:43:48 -0400521
David Benjamin0d3a8c62016-03-11 22:25:18 -0500522 /* If an alert record, process the alert. */
Adam Langleyfcf25832014-12-18 17:42:32 -0800523 if (rr->type == SSL3_RT_ALERT) {
David Benjamin0d3a8c62016-03-11 22:25:18 -0500524 /* Alerts records may not contain fragmented or multiple alerts. */
525 if (rr->length != 2) {
David Benjamin86058a22015-02-22 13:07:21 -0500526 al = SSL_AD_DECODE_ERROR;
David Benjamin3570d732015-06-29 00:28:17 -0400527 OPENSSL_PUT_ERROR(SSL, SSL_R_BAD_ALERT);
David Benjamin86058a22015-02-22 13:07:21 -0500528 goto f_err;
529 }
Adam Langley95c29f32014-06-20 12:00:00 -0700530
David Benjamin0d56f882015-12-19 17:05:56 -0500531 if (ssl->msg_callback) {
532 ssl->msg_callback(0, ssl->version, SSL3_RT_ALERT, rr->data, 2, ssl,
533 ssl->msg_callback_arg);
Adam Langleyfcf25832014-12-18 17:42:32 -0800534 }
David Benjamin7fc01002015-12-06 15:48:22 -0500535 const uint8_t alert_level = rr->data[0];
536 const uint8_t alert_descr = rr->data[1];
David Benjamin86058a22015-02-22 13:07:21 -0500537 rr->length -= 2;
David Benjamin7fc01002015-12-06 15:48:22 -0500538 rr->data += 2;
Adam Langley95c29f32014-06-20 12:00:00 -0700539
David Benjamin0d56f882015-12-19 17:05:56 -0500540 if (ssl->info_callback != NULL) {
541 cb = ssl->info_callback;
542 } else if (ssl->ctx->info_callback != NULL) {
543 cb = ssl->ctx->info_callback;
Adam Langleyfcf25832014-12-18 17:42:32 -0800544 }
Adam Langley95c29f32014-06-20 12:00:00 -0700545
Adam Langleyfcf25832014-12-18 17:42:32 -0800546 if (cb != NULL) {
David Benjamin86058a22015-02-22 13:07:21 -0500547 uint16_t alert = (alert_level << 8) | alert_descr;
David Benjamin0d56f882015-12-19 17:05:56 -0500548 cb(ssl, SSL_CB_READ_ALERT, alert);
Adam Langleyfcf25832014-12-18 17:42:32 -0800549 }
Adam Langley95c29f32014-06-20 12:00:00 -0700550
David Benjamin86058a22015-02-22 13:07:21 -0500551 if (alert_level == SSL3_AL_WARNING) {
Adam Langleyfcf25832014-12-18 17:42:32 -0800552 if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
David Benjamin282511d2016-03-10 00:23:55 -0500553 ssl->s3->clean_shutdown = 1;
David Benjamin0d56f882015-12-19 17:05:56 -0500554 ssl->shutdown |= SSL_RECEIVED_SHUTDOWN;
Adam Langleyfcf25832014-12-18 17:42:32 -0800555 return 0;
556 }
Adam Langley95c29f32014-06-20 12:00:00 -0700557
Adam Langleyfcf25832014-12-18 17:42:32 -0800558 /* This is a warning but we receive it if we requested renegotiation and
559 * the peer denied it. Terminate with a fatal alert because if
560 * application tried to renegotiatie it presumably had a good reason and
561 * expects it to succeed.
562 *
563 * In future we might have a renegotiation where we don't care if the
564 * peer refused it where we carry on. */
565 else if (alert_descr == SSL_AD_NO_RENEGOTIATION) {
566 al = SSL_AD_HANDSHAKE_FAILURE;
David Benjamin3570d732015-06-29 00:28:17 -0400567 OPENSSL_PUT_ERROR(SSL, SSL_R_NO_RENEGOTIATION);
Adam Langleyfcf25832014-12-18 17:42:32 -0800568 goto f_err;
569 }
David Benjamin24f346d2015-06-06 03:28:08 -0400570
David Benjamin0d56f882015-12-19 17:05:56 -0500571 ssl->s3->warning_alert_count++;
572 if (ssl->s3->warning_alert_count > kMaxWarningAlerts) {
David Benjamin24f346d2015-06-06 03:28:08 -0400573 al = SSL_AD_UNEXPECTED_MESSAGE;
David Benjamin3570d732015-06-29 00:28:17 -0400574 OPENSSL_PUT_ERROR(SSL, SSL_R_TOO_MANY_WARNING_ALERTS);
David Benjamin24f346d2015-06-06 03:28:08 -0400575 goto f_err;
576 }
David Benjamin86058a22015-02-22 13:07:21 -0500577 } else if (alert_level == SSL3_AL_FATAL) {
Adam Langleyfcf25832014-12-18 17:42:32 -0800578 char tmp[16];
Adam Langley95c29f32014-06-20 12:00:00 -0700579
David Benjamin0d56f882015-12-19 17:05:56 -0500580 ssl->rwstate = SSL_NOTHING;
David Benjamin3570d732015-06-29 00:28:17 -0400581 OPENSSL_PUT_ERROR(SSL, SSL_AD_REASON_OFFSET + alert_descr);
Adam Langleyfcf25832014-12-18 17:42:32 -0800582 BIO_snprintf(tmp, sizeof(tmp), "%d", alert_descr);
583 ERR_add_error_data(2, "SSL alert number ", tmp);
David Benjamin0d56f882015-12-19 17:05:56 -0500584 ssl->shutdown |= SSL_RECEIVED_SHUTDOWN;
585 SSL_CTX_remove_session(ssl->ctx, ssl->session);
Adam Langleyfcf25832014-12-18 17:42:32 -0800586 return 0;
587 } else {
588 al = SSL_AD_ILLEGAL_PARAMETER;
David Benjamin3570d732015-06-29 00:28:17 -0400589 OPENSSL_PUT_ERROR(SSL, SSL_R_UNKNOWN_ALERT_TYPE);
Adam Langleyfcf25832014-12-18 17:42:32 -0800590 goto f_err;
591 }
Adam Langley95c29f32014-06-20 12:00:00 -0700592
Adam Langleyfcf25832014-12-18 17:42:32 -0800593 goto start;
594 }
Adam Langley95c29f32014-06-20 12:00:00 -0700595
David Benjamin0d56f882015-12-19 17:05:56 -0500596 if (ssl->shutdown & SSL_SENT_SHUTDOWN) {
David Benjaminaa9361b2015-08-29 22:33:16 -0400597 /* close_notify has been sent, so discard all records other than alerts. */
Adam Langleyfcf25832014-12-18 17:42:32 -0800598 rr->length = 0;
David Benjaminaa9361b2015-08-29 22:33:16 -0400599 goto start;
Adam Langleyfcf25832014-12-18 17:42:32 -0800600 }
Adam Langley95c29f32014-06-20 12:00:00 -0700601
David Benjamine820df92015-02-08 16:06:54 -0500602 al = SSL_AD_UNEXPECTED_MESSAGE;
David Benjamin3570d732015-06-29 00:28:17 -0400603 OPENSSL_PUT_ERROR(SSL, SSL_R_UNEXPECTED_RECORD);
Adam Langley95c29f32014-06-20 12:00:00 -0700604
605f_err:
David Benjamin0d56f882015-12-19 17:05:56 -0500606 ssl3_send_alert(ssl, SSL3_AL_FATAL, al);
Adam Langley95c29f32014-06-20 12:00:00 -0700607err:
Adam Langleyfcf25832014-12-18 17:42:32 -0800608 return -1;
609}
Adam Langley95c29f32014-06-20 12:00:00 -0700610
David Benjamin0d56f882015-12-19 17:05:56 -0500611int ssl3_send_alert(SSL *ssl, int level, int desc) {
Adam Langleyfcf25832014-12-18 17:42:32 -0800612 /* If a fatal one, remove from cache */
David Benjamin0d56f882015-12-19 17:05:56 -0500613 if (level == 2 && ssl->session != NULL) {
614 SSL_CTX_remove_session(ssl->ctx, ssl->session);
Adam Langleyfcf25832014-12-18 17:42:32 -0800615 }
Adam Langley95c29f32014-06-20 12:00:00 -0700616
David Benjamin0d56f882015-12-19 17:05:56 -0500617 ssl->s3->alert_dispatch = 1;
618 ssl->s3->send_alert[0] = level;
619 ssl->s3->send_alert[1] = desc;
620 if (!ssl_write_buffer_is_pending(ssl)) {
David Benjaminb8d28cf2015-07-28 21:34:45 -0400621 /* Nothing is being written out, so the alert may be dispatched
622 * immediately. */
David Benjamin0d56f882015-12-19 17:05:56 -0500623 return ssl->method->ssl_dispatch_alert(ssl);
Adam Langleyfcf25832014-12-18 17:42:32 -0800624 }
Adam Langley95c29f32014-06-20 12:00:00 -0700625
Adam Langleyfcf25832014-12-18 17:42:32 -0800626 /* else data is still being written out, we will get written some time in the
627 * future */
628 return -1;
629}
Adam Langley95c29f32014-06-20 12:00:00 -0700630
David Benjamin0d56f882015-12-19 17:05:56 -0500631int ssl3_dispatch_alert(SSL *ssl) {
David Benjamin0d56f882015-12-19 17:05:56 -0500632 ssl->s3->alert_dispatch = 0;
David Benjamina8571592016-03-10 01:41:55 -0500633 int ret = do_ssl3_write(ssl, SSL3_RT_ALERT, &ssl->s3->send_alert[0], 2);
634 if (ret <= 0) {
David Benjamin0d56f882015-12-19 17:05:56 -0500635 ssl->s3->alert_dispatch = 1;
David Benjamina8571592016-03-10 01:41:55 -0500636 return ret;
Adam Langleyfcf25832014-12-18 17:42:32 -0800637 }
638
David Benjamina8571592016-03-10 01:41:55 -0500639 /* If the alert is fatal, flush the BIO now. */
640 if (ssl->s3->send_alert[0] == SSL3_AL_FATAL) {
641 BIO_flush(ssl->wbio);
642 }
643
644 if (ssl->msg_callback != NULL) {
645 ssl->msg_callback(1 /* write */, ssl->version, SSL3_RT_ALERT,
646 ssl->s3->send_alert, 2, ssl, ssl->msg_callback_arg);
647 }
648
649 void (*cb)(const SSL *ssl, int type, int value) = NULL;
650 if (ssl->info_callback != NULL) {
651 cb = ssl->info_callback;
652 } else if (ssl->ctx->info_callback != NULL) {
653 cb = ssl->ctx->info_callback;
654 }
655
656 if (cb != NULL) {
657 int alert = (ssl->s3->send_alert[0] << 8) | ssl->s3->send_alert[1];
658 cb(ssl, SSL_CB_WRITE_ALERT, alert);
659 }
660
661 return 1;
Adam Langleyfcf25832014-12-18 17:42:32 -0800662}