blob: 26e19a6c0d0ed76099afac46e0e4ec1ae1939b7d [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
21 * The SSL 3.0 specification was drafted by Netscape in 1996,
22 * and became an IETF standard in 1999.
23 *
24 * http://wp.netscape.com/eng/ssl3/
25 * http://www.ietf.org/rfc/rfc2246.txt
26 * http://www.ietf.org/rfc/rfc4346.txt
27 */
28
Gilles Peskinedb09ef62020-06-03 01:43:33 +020029#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000032
SimonBd5800b72016-04-26 07:43:27 +010033#if defined(MBEDTLS_PLATFORM_C)
34#include "mbedtls/platform.h"
35#else
36#include <stdlib.h>
37#define mbedtls_calloc calloc
38#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010039#endif
40
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000041#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020042#include "mbedtls/ssl_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000043#include "mbedtls/debug.h"
44#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050045#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010046#include "mbedtls/version.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020047
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020048#include "ssl_invasive.h"
49
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Hanno Beckercd9dcda2018-08-28 17:18:56 +010061static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010062
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020063/*
64 * Start a timer.
65 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020066 */
Hanno Becker0f57a652020-02-05 10:37:26 +000067void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020068{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020069 if( ssl->f_set_timer == NULL )
70 return;
71
72 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
73 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020074}
75
76/*
77 * Return -1 is timer is expired, 0 if it isn't.
78 */
Hanno Becker7876d122020-02-05 10:39:31 +000079int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020080{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020081 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020082 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020083
84 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085 {
86 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020087 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020088 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089
90 return( 0 );
91}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020092
Hanno Beckercfe45792019-07-03 16:13:00 +010093#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010094static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t len,
97 mbedtls_record *rec );
98
Hanno Beckercfe45792019-07-03 16:13:00 +010099int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
100 unsigned char *buf,
101 size_t buflen )
102{
Hanno Becker54229812019-07-12 14:40:00 +0100103 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100104 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
105 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
106
107 /* We don't support record checking in TLS because
108 * (a) there doesn't seem to be a usecase for it, and
109 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
110 * and we'd need to backup the transform here.
111 */
112 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
113 {
114 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
115 goto exit;
116 }
117#if defined(MBEDTLS_SSL_PROTO_DTLS)
118 else
119 {
irwir734f0cf2019-09-26 21:03:24 +0300120 mbedtls_record rec;
121
Hanno Becker54229812019-07-12 14:40:00 +0100122 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
123 if( ret != 0 )
124 {
125 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
126 goto exit;
127 }
128
129 if( ssl->transform_in != NULL )
130 {
131 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
132 if( ret != 0 )
133 {
134 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
135 goto exit;
136 }
137 }
138 }
139#endif /* MBEDTLS_SSL_PROTO_DTLS */
140
141exit:
142 /* On success, we have decrypted the buffer in-place, so make
143 * sure we don't leak any plaintext data. */
144 mbedtls_platform_zeroize( buf, buflen );
145
146 /* For the purpose of this API, treat messages with unexpected CID
147 * as well as such from future epochs as unexpected. */
148 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
149 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
150 {
151 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
152 }
153
154 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
155 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100156}
157#endif /* MBEDTLS_SSL_RECORD_CHECKING */
158
Hanno Becker67bc7c32018-08-06 11:33:50 +0100159#define SSL_DONT_FORCE_FLUSH 0
160#define SSL_FORCE_FLUSH 1
161
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200162#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100163
Hanno Beckerd5847772018-08-28 10:09:23 +0100164/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100165static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
166 uint8_t slot );
167static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
168static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
169static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
170static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100171static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
172 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100173static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100174
Hanno Becker11682cc2018-08-22 14:41:02 +0100175static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176{
Hanno Becker89490712020-02-05 10:50:12 +0000177 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000178#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
179 size_t out_buf_len = ssl->out_buf_len;
180#else
181 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
182#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100183
Darryl Greenb33cc762019-11-28 14:29:44 +0000184 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100186
Darryl Greenb33cc762019-11-28 14:29:44 +0000187 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100188}
189
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
191{
Hanno Becker11682cc2018-08-22 14:41:02 +0100192 size_t const bytes_written = ssl->out_left;
193 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100194
195 /* Double-check that the write-index hasn't gone
196 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100197 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100198 {
199 /* Should never happen... */
200 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
201 }
202
203 return( (int) ( mtu - bytes_written ) );
204}
205
206static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
207{
Janos Follath865b3eb2019-12-16 11:46:15 +0000208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100209 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400210 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100211
212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400213 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100214
215 if( max_len > mfl )
216 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100217
218 /* By the standard (RFC 6066 Sect. 4), the MFL extension
219 * only limits the maximum record payload size, so in theory
220 * we would be allowed to pack multiple records of payload size
221 * MFL into a single datagram. However, this would mean that there's
222 * no way to explicitly communicate MTU restrictions to the peer.
223 *
224 * The following reduction of max_len makes sure that we never
225 * write datagrams larger than MFL + Record Expansion Overhead.
226 */
227 if( max_len <= ssl->out_left )
228 return( 0 );
229
230 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100231#endif
232
233 ret = ssl_get_remaining_space_in_datagram( ssl );
234 if( ret < 0 )
235 return( ret );
236 remaining = (size_t) ret;
237
238 ret = mbedtls_ssl_get_record_expansion( ssl );
239 if( ret < 0 )
240 return( ret );
241 expansion = (size_t) ret;
242
243 if( remaining <= expansion )
244 return( 0 );
245
246 remaining -= expansion;
247 if( remaining >= max_len )
248 remaining = max_len;
249
250 return( (int) remaining );
251}
252
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200253/*
254 * Double the retransmit timeout value, within the allowed range,
255 * returning -1 if the maximum value has already been reached.
256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200258{
259 uint32_t new_timeout;
260
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200261 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200262 return( -1 );
263
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
265 * in the following way: after the initial transmission and a first
266 * retransmission, back off to a temporary estimated MTU of 508 bytes.
267 * This value is guaranteed to be deliverable (if not guaranteed to be
268 * delivered) of any compliant IPv4 (and IPv6) network, and should work
269 * on most non-IP stacks too. */
270 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400271 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200272 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400273 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
274 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200275
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 new_timeout = 2 * ssl->handshake->retransmit_timeout;
277
278 /* Avoid arithmetic overflow and range overflow */
279 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200280 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200281 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200282 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200283 }
284
285 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000286 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
287 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200288
289 return( 0 );
290}
291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200293{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200294 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
296 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200297}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
301int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200302 const unsigned char *key_enc, const unsigned char *key_dec,
303 size_t keylen,
304 const unsigned char *iv_enc, const unsigned char *iv_dec,
305 size_t ivlen,
306 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200307 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
309int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
310int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
313#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000314
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100315/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000316 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200317 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000318
Hanno Beckerccc13d02020-05-04 12:30:04 +0100319#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
320 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100321
322static size_t ssl_compute_padding_length( size_t len,
323 size_t granularity )
324{
325 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
326}
327
Hanno Becker581bc1b2020-05-04 12:20:03 +0100328/* This functions transforms a (D)TLS plaintext fragment and a record content
329 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
330 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
331 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100332 *
333 * struct {
334 * opaque content[DTLSPlaintext.length];
335 * ContentType real_type;
336 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100337 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338 *
339 * Input:
340 * - `content`: The beginning of the buffer holding the
341 * plaintext to be wrapped.
342 * - `*content_size`: The length of the plaintext in Bytes.
343 * - `max_len`: The number of Bytes available starting from
344 * `content`. This must be `>= *content_size`.
345 * - `rec_type`: The desired record content type.
346 *
347 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100348 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
349 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100350 *
351 * Returns:
352 * - `0` on success.
353 * - A negative error code if `max_len` didn't offer enough space
354 * for the expansion.
355 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100356static int ssl_build_inner_plaintext( unsigned char *content,
357 size_t *content_size,
358 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100359 uint8_t rec_type,
360 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361{
362 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100363
364 /* Write real content type */
365 if( remaining == 0 )
366 return( -1 );
367 content[ len ] = rec_type;
368 len++;
369 remaining--;
370
371 if( remaining < pad )
372 return( -1 );
373 memset( content + len, 0, pad );
374 len += pad;
375 remaining -= pad;
376
377 *content_size = len;
378 return( 0 );
379}
380
Hanno Becker581bc1b2020-05-04 12:20:03 +0100381/* This function parses a (D)TLSInnerPlaintext structure.
382 * See ssl_build_inner_plaintext() for details. */
383static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100384 size_t *content_size,
385 uint8_t *rec_type )
386{
387 size_t remaining = *content_size;
388
389 /* Determine length of padding by skipping zeroes from the back. */
390 do
391 {
392 if( remaining == 0 )
393 return( -1 );
394 remaining--;
395 } while( content[ remaining ] == 0 );
396
397 *content_size = remaining;
398 *rec_type = content[ remaining ];
399
400 return( 0 );
401}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100402#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
403 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100404
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100405/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100406 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000407static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100408 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100409 mbedtls_record *rec,
410 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000411{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100412 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100413 *
414 * additional_data = seq_num + TLSCompressed.type +
415 * TLSCompressed.version + TLSCompressed.length;
416 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100417 * For the CID extension, this is extended as follows
418 * (quoting draft-ietf-tls-dtls-connection-id-05,
419 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 *
421 * additional_data = seq_num + DTLSPlaintext.type +
422 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100423 * cid +
424 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100425 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100426 *
427 * For TLS 1.3, the record sequence number is dropped from the AAD
428 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100429 */
430
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100431 unsigned char *cur = add_data;
432
433#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
434 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
435#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
436 {
437 ((void) minor_ver);
438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
457 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
458 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
459 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 }
461 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100462#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
465 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
466 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100467 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100468
469 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000470}
471
Hanno Becker9d062f92020-02-07 10:26:36 +0000472#if defined(MBEDTLS_SSL_PROTO_SSL3)
473
474#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
475
476/*
477 * SSLv3.0 MAC functions
478 */
479static void ssl_mac( mbedtls_md_context_t *md_ctx,
480 const unsigned char *secret,
481 const unsigned char *buf, size_t len,
482 const unsigned char *ctr, int type,
483 unsigned char out[SSL3_MAC_MAX_BYTES] )
484{
485 unsigned char header[11];
486 unsigned char padding[48];
487 int padlen;
488 int md_size = mbedtls_md_get_size( md_ctx->md_info );
489 int md_type = mbedtls_md_get_type( md_ctx->md_info );
490
491 /* Only MD5 and SHA-1 supported */
492 if( md_type == MBEDTLS_MD_MD5 )
493 padlen = 48;
494 else
495 padlen = 40;
496
497 memcpy( header, ctr, 8 );
498 header[ 8] = (unsigned char) type;
499 header[ 9] = (unsigned char)( len >> 8 );
500 header[10] = (unsigned char)( len );
501
502 memset( padding, 0x36, padlen );
503 mbedtls_md_starts( md_ctx );
504 mbedtls_md_update( md_ctx, secret, md_size );
505 mbedtls_md_update( md_ctx, padding, padlen );
506 mbedtls_md_update( md_ctx, header, 11 );
507 mbedtls_md_update( md_ctx, buf, len );
508 mbedtls_md_finish( md_ctx, out );
509
510 memset( padding, 0x5C, padlen );
511 mbedtls_md_starts( md_ctx );
512 mbedtls_md_update( md_ctx, secret, md_size );
513 mbedtls_md_update( md_ctx, padding, padlen );
514 mbedtls_md_update( md_ctx, out, md_size );
515 mbedtls_md_finish( md_ctx, out );
516}
517#endif /* MBEDTLS_SSL_PROTO_SSL3 */
518
Hanno Becker67a37db2020-05-28 16:27:07 +0100519#if defined(MBEDTLS_GCM_C) || \
520 defined(MBEDTLS_CCM_C) || \
521 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100522static int ssl_transform_aead_dynamic_iv_is_explicit(
523 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100524{
Hanno Becker17263802020-05-28 07:05:48 +0100525 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100526}
527
Hanno Becker17263802020-05-28 07:05:48 +0100528/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
529 *
530 * Concretely, this occurs in two variants:
531 *
532 * a) Fixed and dynamic IV lengths add up to total IV length, giving
533 * IV = fixed_iv || dynamic_iv
534 *
Hanno Becker15952812020-06-04 13:31:46 +0100535 * This variant is used in TLS 1.2 when used with GCM or CCM.
536 *
Hanno Becker17263802020-05-28 07:05:48 +0100537 * b) Fixed IV lengths matches total IV length, giving
538 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100539 *
540 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
541 *
542 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100543 *
544 * This function has the precondition that
545 *
546 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
547 *
548 * which has to be ensured by the caller. If this precondition
549 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100550 */
551static void ssl_build_record_nonce( unsigned char *dst_iv,
552 size_t dst_iv_len,
553 unsigned char const *fixed_iv,
554 size_t fixed_iv_len,
555 unsigned char const *dynamic_iv,
556 size_t dynamic_iv_len )
557{
558 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100559
560 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100561 memset( dst_iv, 0, dst_iv_len );
562 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100563
Hanno Becker17263802020-05-28 07:05:48 +0100564 dst_iv += dst_iv_len - dynamic_iv_len;
565 for( i = 0; i < dynamic_iv_len; i++ )
566 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100567}
Hanno Becker67a37db2020-05-28 16:27:07 +0100568#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100569
Hanno Beckera18d1322018-01-03 14:27:32 +0000570int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
571 mbedtls_ssl_transform *transform,
572 mbedtls_record *rec,
573 int (*f_rng)(void *, unsigned char *, size_t),
574 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000575{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100577 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000578 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100579 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100580 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 size_t post_avail;
582
583 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000584#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200585 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000586 ((void) ssl);
587#endif
588
589 /* The PRNG is used for dynamic IV generation that's used
590 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200591#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000592 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
593 ((void) f_rng);
594 ((void) p_rng);
595#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000598
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000599 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100600 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
603 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100604 if( rec == NULL
605 || rec->buf == NULL
606 || rec->buf_len < rec->data_offset
607 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100608#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100609 || rec->cid_len != 0
610#endif
611 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000612 {
613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100615 }
616
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000617 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100618 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000620 data, rec->data_len );
621
622 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
623
624 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
625 {
626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
627 (unsigned) rec->data_len,
628 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
629 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
630 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100631
Hanno Becker92313402020-05-20 13:58:58 +0100632 /* The following two code paths implement the (D)TLSInnerPlaintext
633 * structure present in TLS 1.3 and DTLS 1.2 + CID.
634 *
635 * See ssl_build_inner_plaintext() for more information.
636 *
637 * Note that this changes `rec->data_len`, and hence
638 * `post_avail` needs to be recalculated afterwards.
639 *
640 * Note also that the two code paths cannot occur simultaneously
641 * since they apply to different versions of the protocol. There
642 * is hence no risk of double-addition of the inner plaintext.
643 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100644#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
645 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
646 {
Hanno Becker13996922020-05-28 16:15:19 +0100647 size_t padding =
648 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100649 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100650 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100651 &rec->data_len,
652 post_avail,
653 rec->type,
654 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100655 {
656 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
657 }
658
659 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
660 }
661#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
662
Hanno Beckera0e20d02019-05-15 14:03:01 +0100663#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100664 /*
665 * Add CID information
666 */
667 rec->cid_len = transform->out_cid_len;
668 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
669 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100670
671 if( rec->cid_len != 0 )
672 {
Hanno Becker13996922020-05-28 16:15:19 +0100673 size_t padding =
674 ssl_compute_padding_length( rec->data_len,
675 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100676 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100677 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100678 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100679 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100680 * Note that this changes `rec->data_len`, and hence
681 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100682 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100683 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100684 &rec->data_len,
685 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100686 rec->type,
687 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100688 {
689 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
690 }
691
692 rec->type = MBEDTLS_SSL_MSG_CID;
693 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100694#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100695
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100696 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
697
Paul Bakker5121ce52009-01-03 21:22:43 +0000698 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100699 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000700 */
Hanno Becker52344c22018-01-03 15:24:20 +0000701#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 if( mode == MBEDTLS_MODE_STREAM ||
703 ( mode == MBEDTLS_MODE_CBC
704#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000705 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100706#endif
707 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000708 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000709 if( post_avail < transform->maclen )
710 {
711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
712 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
713 }
714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000716 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200717 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000718 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000719 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
720 data, rec->data_len, rec->ctr, rec->type, mac );
721 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200722 }
723 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200724#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
726 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000727 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200728 {
Hanno Becker992b6872017-11-09 18:57:39 +0000729 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
730
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100731 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
732 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000733
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000734 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100735 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000736 mbedtls_md_hmac_update( &transform->md_ctx_enc,
737 data, rec->data_len );
738 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
739 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
740
741 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200742 }
743 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200744#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
747 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200748 }
749
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000750 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
751 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200752
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753 rec->data_len += transform->maclen;
754 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100755 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200756 }
Hanno Becker52344c22018-01-03 15:24:20 +0000757#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000758
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200759 /*
760 * Encrypt
761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
763 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000764 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000765 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000766 size_t olen;
Paul Elliott9f352112020-12-09 14:55:45 +0000767 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %zu, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000768 "including %d bytes of padding",
769 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000770
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000771 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
772 transform->iv_enc, transform->ivlen,
773 data, rec->data_len,
774 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200775 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200777 return( ret );
778 }
779
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000780 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200781 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
783 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200784 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000785 }
Paul Bakker68884e32013-01-07 18:20:04 +0100786 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000788
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200789#if defined(MBEDTLS_GCM_C) || \
790 defined(MBEDTLS_CCM_C) || \
791 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200793 mode == MBEDTLS_MODE_CCM ||
794 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000795 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000796 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200797 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100798 unsigned char *dynamic_iv;
799 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100800 int dynamic_iv_is_explicit =
801 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000802
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100803 /* Check that there's space for the authentication tag. */
804 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000805 {
806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
807 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
808 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000809
Paul Bakker68884e32013-01-07 18:20:04 +0100810 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100811 * Build nonce for AEAD encryption.
812 *
813 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
814 * part of the IV is prepended to the ciphertext and
815 * can be chosen freely - in particular, it need not
816 * agree with the record sequence number.
817 * However, since ChaChaPoly as well as all AEAD modes
818 * in TLS 1.3 use the record sequence number as the
819 * dynamic part of the nonce, we uniformly use the
820 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100821 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100822 dynamic_iv = rec->ctr;
823 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200824
Hanno Becker17263802020-05-28 07:05:48 +0100825 ssl_build_record_nonce( iv, sizeof( iv ),
826 transform->iv_enc,
827 transform->fixed_ivlen,
828 dynamic_iv,
829 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100830
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100831 /*
832 * Build additional data for AEAD encryption.
833 * This depends on the TLS version.
834 */
835 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
836 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100837
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200838 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100839 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200840 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100841 dynamic_iv,
842 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000843 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100844 add_data, add_data_len );
Paul Elliott9f352112020-12-09 14:55:45 +0000845 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %zu, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200846 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000847 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000848
Paul Bakker68884e32013-01-07 18:20:04 +0100849 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200850 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200851 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000852
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100853 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000854 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100855 add_data, add_data_len,
856 data, rec->data_len, /* src */
857 data, rec->buf_len - (data - rec->buf), /* dst */
858 &rec->data_len,
859 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200860 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200862 return( ret );
863 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000864 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100865 data + rec->data_len - transform->taglen,
866 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100867 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000868 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100869
870 /*
871 * Prefix record content with dynamic IV in case it is explicit.
872 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100873 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100874 {
875 if( rec->data_offset < dynamic_iv_len )
876 {
877 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
878 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
879 }
880
881 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
882 rec->data_offset -= dynamic_iv_len;
883 rec->data_len += dynamic_iv_len;
884 }
885
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100886 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000887 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000888 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100889#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200890#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000892 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000893 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000894 size_t padlen, i;
895 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000896
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000897 /* Currently we're always using minimal padding
898 * (up to 255 bytes would be allowed). */
899 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
900 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000901 padlen = 0;
902
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000903 /* Check there's enough space in the buffer for the padding. */
904 if( post_avail < padlen + 1 )
905 {
906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
907 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
908 }
909
Paul Bakker5121ce52009-01-03 21:22:43 +0000910 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000911 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000912
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000913 rec->data_len += padlen + 1;
914 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000917 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000918 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
919 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000920 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000921 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000922 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000923 if( f_rng == NULL )
924 {
925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
926 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
927 }
928
929 if( rec->data_offset < transform->ivlen )
930 {
931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
932 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
933 }
934
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000935 /*
936 * Generate IV
937 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000939 if( ret != 0 )
940 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000941
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000942 memcpy( data - transform->ivlen, transform->iv_enc,
943 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000945 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000947
Paul Elliott9f352112020-12-09 14:55:45 +0000948 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %zu, "
949 "including %zu bytes of IV and %zu bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000950 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200951 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000952
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000953 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
954 transform->iv_enc,
955 transform->ivlen,
956 data, rec->data_len,
957 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200958 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200960 return( ret );
961 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200962
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
966 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200967 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000970 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200971 {
972 /*
973 * Save IV in SSL3 and TLS1
974 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000975 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
976 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000977 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000978 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200979#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 {
981 data -= transform->ivlen;
982 rec->data_offset -= transform->ivlen;
983 rec->data_len += transform->ivlen;
984 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100987 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100988 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000989 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
990
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100991 /*
992 * MAC(MAC_write_key, seq_num +
993 * TLSCipherText.type +
994 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100995 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100996 * IV + // except for TLS 1.0
997 * ENC(content + padding + padding_length));
998 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000999
1000 if( post_avail < transform->maclen)
1001 {
1002 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1003 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1004 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001005
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001006 ssl_extract_add_data_from_record( add_data, &add_data_len,
1007 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001010 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001011 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001012
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001013 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001014 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001015 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1016 data, rec->data_len );
1017 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1018 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001019
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001020 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001021
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 rec->data_len += transform->maclen;
1023 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001024 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001025 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001027 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001028 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001029#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1032 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001033 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001034
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001035 /* Make extra sure authentication was performed, exactly once */
1036 if( auth_done != 1 )
1037 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1039 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001040 }
1041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001043
1044 return( 0 );
1045}
1046
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001048/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001049 * Turn a bit into a mask:
1050 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
1051 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001052 *
1053 * This function can be used to write constant-time code by replacing branches
1054 * with bit operations using masks.
1055 *
1056 * This function is implemented without using comparison operators, as those
1057 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001058 */
1059static size_t mbedtls_ssl_cf_mask_from_bit( size_t bit )
1060{
1061 /* MSVC has a warning about unary minus on unsigned integer types,
1062 * but this is well-defined and precisely what we want to do here. */
1063#if defined(_MSC_VER)
1064#pragma warning( push )
1065#pragma warning( disable : 4146 )
1066#endif
1067 return -bit;
1068#if defined(_MSC_VER)
1069#pragma warning( pop )
1070#endif
1071}
1072
1073/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001074 * Constant-flow mask generation for "less than" comparison:
1075 * - if x < y, return all bits 1, that is (size_t) -1
1076 * - otherwise, return all bits 0, that is 0
1077 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001078 * This function can be used to write constant-time code by replacing branches
1079 * with bit operations using masks.
1080 *
1081 * This function is implemented without using comparison operators, as those
1082 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001083 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001084static size_t mbedtls_ssl_cf_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001085{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001086 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001087 const size_t sub = x - y;
1088
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001089 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001090 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1091
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001092 /* mask = (x < y) ? 0xff... : 0x00... */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001093 const size_t mask = mbedtls_ssl_cf_mask_from_bit( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001094
1095 return( mask );
1096}
1097
1098/*
1099 * Constant-flow mask generation for "greater or equal" comparison:
1100 * - if x >= y, return all bits 1, that is (size_t) -1
1101 * - otherwise, return all bits 0, that is 0
1102 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001103 * This function can be used to write constant-time code by replacing branches
1104 * with bit operations using masks.
1105 *
1106 * This function is implemented without using comparison operators, as those
1107 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001108 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001109static size_t mbedtls_ssl_cf_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001110{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001111 return( ~mbedtls_ssl_cf_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001112}
1113
1114/*
1115 * Constant-flow boolean "equal" comparison:
1116 * return x == y
1117 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001118 * This function can be used to write constant-time code by replacing branches
1119 * with bit operations - it can be used in conjunction with
1120 * mbedtls_ssl_cf_mask_from_bit().
1121 *
1122 * This function is implemented without using comparison operators, as those
1123 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001124 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001125static size_t mbedtls_ssl_cf_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001126{
1127 /* diff = 0 if x == y, non-zero otherwise */
1128 const size_t diff = x ^ y;
1129
1130 /* MSVC has a warning about unary minus on unsigned integer types,
1131 * but this is well-defined and precisely what we want to do here. */
1132#if defined(_MSC_VER)
1133#pragma warning( push )
1134#pragma warning( disable : 4146 )
1135#endif
1136
1137 /* diff_msb's most significant bit is equal to x != y */
1138 const size_t diff_msb = ( diff | -diff );
1139
1140#if defined(_MSC_VER)
1141#pragma warning( pop )
1142#endif
1143
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001144 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001145 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1146
1147 return( 1 ^ diff1 );
1148}
1149
1150/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001151 * Constant-flow conditional memcpy:
1152 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1153 * - otherwise, a no-op,
1154 * but with execution flow independent of the values of c1 and c2.
1155 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001156 * This function is implemented without using comparison operators, as those
1157 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001158 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001159static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1160 const unsigned char *src,
1161 size_t len,
1162 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001163{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001164 /* mask = c1 == c2 ? 0xff : 0x00 */
1165 const size_t equal = mbedtls_ssl_cf_bool_eq( c1, c2 );
Manuel Pégourié-Gonnard2a59fb42020-08-25 11:51:46 +02001166 const unsigned char mask = (unsigned char) mbedtls_ssl_cf_mask_from_bit( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001167
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001168 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001169 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001170 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001171}
1172
1173/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001174 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001175 *
1176 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1177 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001178 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001179MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001180 mbedtls_md_context_t *ctx,
1181 const unsigned char *add_data, size_t add_data_len,
1182 const unsigned char *data, size_t data_len_secret,
1183 size_t min_data_len, size_t max_data_len,
1184 unsigned char *output )
1185{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001186 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001187 * This function breaks the HMAC abstraction and uses the md_clone()
1188 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001189 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001190 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001191 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001192 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001193 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001194 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1195 * minlen, then cloning the context, and for each byte up to maxlen
1196 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001197 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001198 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001199 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001200 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001201 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1202 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001203 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001204 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001205 const unsigned char * const okey = ikey + block_size;
1206 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001207
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001208 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1209 mbedtls_md_context_t aux;
1210 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001212
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001213 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001214
1215#define MD_CHK( func_call ) \
1216 do { \
1217 ret = (func_call); \
1218 if( ret != 0 ) \
1219 goto cleanup; \
1220 } while( 0 )
1221
1222 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001223
1224 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1225 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001226 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1227 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001228
1229 /* For each possible length, compute the hash up to that point */
1230 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001231 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001232 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1233 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001234 /* Keep only the correct inner_hash in the output buffer */
1235 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1236 offset, data_len_secret );
1237
1238 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001239 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001240 }
1241
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001242 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001243 MD_CHK( mbedtls_md_starts( ctx ) );
1244 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1245 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1246 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001247
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001248 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001249 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001250
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001251#undef MD_CHK
1252
1253cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001254 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001255 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001256}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001257
1258/*
1259 * Constant-flow memcpy from variable position in buffer.
1260 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001261 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001262 */
1263MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1264 unsigned char *dst,
1265 const unsigned char *src_base,
1266 size_t offset_secret,
1267 size_t offset_min, size_t offset_max,
1268 size_t len )
1269{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001270 size_t offset;
1271
1272 for( offset = offset_min; offset <= offset_max; offset++ )
1273 {
1274 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1275 offset, offset_secret );
1276 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001277}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001278#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001279
Hanno Becker605949f2019-07-12 08:23:59 +01001280int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001281 mbedtls_ssl_transform *transform,
1282 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001283{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001284 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001286 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001287#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001288 size_t padlen = 0, correct = 1;
1289#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001290 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001291 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001292 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001293
Hanno Beckera18d1322018-01-03 14:27:32 +00001294#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001295 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001296 ((void) ssl);
1297#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001300 if( rec == NULL ||
1301 rec->buf == NULL ||
1302 rec->buf_len < rec->data_offset ||
1303 rec->buf_len - rec->data_offset < rec->data_len )
1304 {
1305 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001307 }
1308
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001309 data = rec->buf + rec->data_offset;
1310 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001311
Hanno Beckera0e20d02019-05-15 14:03:01 +01001312#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001313 /*
1314 * Match record's CID with incoming CID.
1315 */
Hanno Becker938489a2019-05-08 13:02:22 +01001316 if( rec->cid_len != transform->in_cid_len ||
1317 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1318 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001319 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001320 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001321#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1324 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001325 {
1326 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001327 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1328 transform->iv_dec,
1329 transform->ivlen,
1330 data, rec->data_len,
1331 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001332 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001334 return( ret );
1335 }
1336
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001337 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1340 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001341 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001342 }
Paul Bakker68884e32013-01-07 18:20:04 +01001343 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001345#if defined(MBEDTLS_GCM_C) || \
1346 defined(MBEDTLS_CCM_C) || \
1347 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001349 mode == MBEDTLS_MODE_CCM ||
1350 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001351 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001352 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001353 unsigned char *dynamic_iv;
1354 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001355
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001356 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001357 * Extract dynamic part of nonce for AEAD decryption.
1358 *
1359 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1360 * part of the IV is prepended to the ciphertext and
1361 * can be chosen freely - in particular, it need not
1362 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001363 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001364 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001365 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001366 {
1367 if( rec->data_len < dynamic_iv_len )
1368 {
Paul Elliott9f352112020-12-09 14:55:45 +00001369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%zu) < explicit_iv_len (%zu) ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001370 rec->data_len,
1371 dynamic_iv_len ) );
1372 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1373 }
1374 dynamic_iv = data;
1375
1376 data += dynamic_iv_len;
1377 rec->data_offset += dynamic_iv_len;
1378 rec->data_len -= dynamic_iv_len;
1379 }
Hanno Becker17263802020-05-28 07:05:48 +01001380 else
1381 {
1382 dynamic_iv = rec->ctr;
1383 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001384
1385 /* Check that there's space for the authentication tag. */
1386 if( rec->data_len < transform->taglen )
1387 {
Paul Elliott9f352112020-12-09 14:55:45 +00001388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%zu) < taglen (%zu) ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001389 rec->data_len,
1390 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001392 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001393 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001394
Hanno Beckerdf8be222020-05-21 15:30:57 +01001395 /*
1396 * Prepare nonce from dynamic and static parts.
1397 */
Hanno Becker17263802020-05-28 07:05:48 +01001398 ssl_build_record_nonce( iv, sizeof( iv ),
1399 transform->iv_dec,
1400 transform->fixed_ivlen,
1401 dynamic_iv,
1402 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001403
Hanno Beckerdf8be222020-05-21 15:30:57 +01001404 /*
1405 * Build additional data for AEAD encryption.
1406 * This depends on the TLS version.
1407 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001408 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1409 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001410 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001411 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001412
Hanno Beckerd96a6522019-07-10 13:55:25 +01001413 /* Because of the check above, we know that there are
1414 * explicit_iv_len Bytes preceeding data, and taglen
1415 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001416 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001417 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001418
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001419 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001420 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001421 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001422
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001423 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001424 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001425 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001426 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001427 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001428 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001429 data, rec->data_len + transform->taglen, /* src */
1430 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001431 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001432 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001433 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001434
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001435 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1436 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001437
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001438 return( ret );
1439 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001440 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001441
Hanno Beckerd96a6522019-07-10 13:55:25 +01001442 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001443 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001444 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001445 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1446 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001447 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001448 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001449 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001451#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001453 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001454 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001455
Paul Bakker5121ce52009-01-03 21:22:43 +00001456 /*
Paul Bakker45829992013-01-03 14:52:21 +01001457 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001460 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1461 {
1462 /* The ciphertext is prefixed with the CBC IV. */
1463 minlen += transform->ivlen;
1464 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001465#endif
Paul Bakker45829992013-01-03 14:52:21 +01001466
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001467 /* Size considerations:
1468 *
1469 * - The CBC cipher text must not be empty and hence
1470 * at least of size transform->ivlen.
1471 *
1472 * Together with the potential IV-prefix, this explains
1473 * the first of the two checks below.
1474 *
1475 * - The record must contain a MAC, either in plain or
1476 * encrypted, depending on whether Encrypt-then-MAC
1477 * is used or not.
1478 * - If it is, the message contains the IV-prefix,
1479 * the CBC ciphertext, and the MAC.
1480 * - If it is not, the padded plaintext, and hence
1481 * the CBC ciphertext, has at least length maclen + 1
1482 * because there is at least the padding length byte.
1483 *
1484 * As the CBC ciphertext is not empty, both cases give the
1485 * lower bound minlen + maclen + 1 on the record size, which
1486 * we test for in the second check below.
1487 */
1488 if( rec->data_len < minlen + transform->ivlen ||
1489 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001490 {
Paul Elliott9f352112020-12-09 14:55:45 +00001491 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%zu) < max( ivlen(%zu), maclen (%zu) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001492 "+ 1 ) ( + expl IV )", rec->data_len,
1493 transform->ivlen,
1494 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001496 }
1497
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001498 /*
1499 * Authenticate before decrypt if enabled
1500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001503 {
Hanno Becker992b6872017-11-09 18:57:39 +00001504 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001507
Hanno Beckerd96a6522019-07-10 13:55:25 +01001508 /* Update data_len in tandem with add_data.
1509 *
1510 * The subtraction is safe because of the previous check
1511 * data_len >= minlen + maclen + 1.
1512 *
1513 * Afterwards, we know that data + data_len is followed by at
1514 * least maclen Bytes, which justifies the call to
1515 * mbedtls_ssl_safer_memcmp() below.
1516 *
1517 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001518 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001519 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1520 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001521
Hanno Beckerd96a6522019-07-10 13:55:25 +01001522 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001523 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1524 add_data_len );
1525 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1526 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1528 data, rec->data_len );
1529 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1530 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001531
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1533 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001534 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001536
Hanno Beckerd96a6522019-07-10 13:55:25 +01001537 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001538 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1539 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001540 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001542 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001543 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001544 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001545 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001547
1548 /*
1549 * Check length sanity
1550 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001551
1552 /* We know from above that data_len > minlen >= 0,
1553 * so the following check in particular implies that
1554 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001555 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001556 {
Paul Elliott9f352112020-12-09 14:55:45 +00001557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%zu) %% ivlen (%zu) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001558 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001560 }
1561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001563 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001564 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001565 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001566 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001567 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001568 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001569 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001570
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001571 data += transform->ivlen;
1572 rec->data_offset += transform->ivlen;
1573 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001574 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001576
Hanno Beckerd96a6522019-07-10 13:55:25 +01001577 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1578
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001579 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1580 transform->iv_dec, transform->ivlen,
1581 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001582 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001584 return( ret );
1585 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001586
Hanno Beckerd96a6522019-07-10 13:55:25 +01001587 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001588 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1591 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001592 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001595 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001596 {
1597 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001598 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1599 * records is equivalent to CBC decryption of the concatenation
1600 * of the records; in other words, IVs are maintained across
1601 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001602 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001603 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1604 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001605 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001606#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001607
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001608 /* Safe since data_len >= minlen + maclen + 1, so after having
1609 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001610 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1611 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001612 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001613
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001614 if( auth_done == 1 )
1615 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001616 const size_t mask = mbedtls_ssl_cf_mask_ge(
1617 rec->data_len,
1618 padlen + 1 );
1619 correct &= mask;
1620 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001621 }
1622 else
Paul Bakker45829992013-01-03 14:52:21 +01001623 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001625 if( rec->data_len < transform->maclen + padlen + 1 )
1626 {
Paul Elliott9f352112020-12-09 14:55:45 +00001627 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%zu) < maclen (%zu) + padlen (%zu)",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001628 rec->data_len,
1629 transform->maclen,
1630 padlen + 1 ) );
1631 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001632#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001633
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001634 const size_t mask = mbedtls_ssl_cf_mask_ge(
1635 rec->data_len,
1636 transform->maclen + padlen + 1 );
1637 correct &= mask;
1638 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001639 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001640
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001641 padlen++;
1642
1643 /* Regardless of the validity of the padding,
1644 * we have data_len >= padlen here. */
1645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001647 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001648 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001649 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1650 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001651 * the protocol (known as part of POODLE), so we don't care if the
1652 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001653 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001654 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliott9f352112020-12-09 14:55:45 +00001656 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %zu, "
1657 "should be no more than %zu",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001658 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001659#endif
Paul Bakker45829992013-01-03 14:52:21 +01001660 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001661 }
1662 }
1663 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1665#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1666 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001667 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001668 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001669 /* The padding check involves a series of up to 256
1670 * consecutive memory reads at the end of the record
1671 * plaintext buffer. In order to hide the length and
1672 * validity of the padding, always perform exactly
1673 * `min(256,plaintext_len)` reads (but take into account
1674 * only the last `padlen` bytes for the padding check). */
1675 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001676 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001677
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001678 /* Index of first padding byte; it has been ensured above
1679 * that the subtraction is safe. */
1680 size_t const padding_idx = rec->data_len - padlen;
1681 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1682 size_t const start_idx = rec->data_len - num_checks;
1683 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001684
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001685 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001686 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001687 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001688 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001689 */
1690 const size_t mask = mbedtls_ssl_cf_mask_ge( idx, padding_idx );
1691 const size_t equal = mbedtls_ssl_cf_bool_eq( check[idx],
1692 padlen - 1 );
1693 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001694 }
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001695 correct &= mbedtls_ssl_cf_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001698 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001700#endif
Manuel Pégourié-Gonnard822b3722020-09-18 09:54:01 +02001701 padlen &= mbedtls_ssl_cf_mask_from_bit( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001702 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001703 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1705 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001706 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1708 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001709 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001710
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001711 /* If the padding was found to be invalid, padlen == 0
1712 * and the subtraction is safe. If the padding was found valid,
1713 * padlen hasn't been changed and the previous assertion
1714 * data_len >= padlen still holds. */
1715 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001716 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001717 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001718#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001719 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1721 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001722 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001723
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001724#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001726 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001727#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
1729 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001730 * Authenticate if not done yet.
1731 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001732 */
Hanno Becker52344c22018-01-03 15:24:20 +00001733#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001734 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001735 {
Hanno Becker992b6872017-11-09 18:57:39 +00001736 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001737 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001738
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001739 /* If the initial value of padlen was such that
1740 * data_len < maclen + padlen + 1, then padlen
1741 * got reset to 1, and the initial check
1742 * data_len >= minlen + maclen + 1
1743 * guarantees that at this point we still
1744 * have at least data_len >= maclen.
1745 *
1746 * If the initial value of padlen was such that
1747 * data_len >= maclen + padlen + 1, then we have
1748 * subtracted either padlen + 1 (if the padding was correct)
1749 * or 0 (if the padding was incorrect) since then,
1750 * hence data_len >= maclen in any case.
1751 */
1752 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001753 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1754 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001755
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001757 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001758 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001759 ssl_mac( &transform->md_ctx_dec,
1760 transform->mac_dec,
1761 data, rec->data_len,
1762 rec->ctr, rec->type,
1763 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001764 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001765 }
1766 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1768#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1769 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001770 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001771 {
1772 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001773 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001774 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001775 *
1776 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001777 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001778 *
1779 * Note that max_len + maclen is never more than the buffer
1780 * length, as we previously did in_msglen -= maclen too.
1781 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001782 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001783 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1784
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001785 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1786 add_data, add_data_len,
1787 data, rec->data_len, min_len, max_len,
1788 mac_expect );
1789 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001790 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001791 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1792 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001793 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001794
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001795 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1796 rec->data_len,
1797 min_len, max_len,
1798 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001799 }
1800 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1802 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1805 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001806 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001807
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001808#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001809 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001810 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001811#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001812
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001813 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001814 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001815 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816#if defined(MBEDTLS_SSL_DEBUG_ALL)
1817 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001818#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001819 correct = 0;
1820 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001821 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001822 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001823
1824 /*
1825 * Finally check the correct flag
1826 */
1827 if( correct == 0 )
1828 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001829#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001830
1831 /* Make extra sure authentication was performed, exactly once */
1832 if( auth_done != 1 )
1833 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001836 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001837
Hanno Beckerccc13d02020-05-04 12:30:04 +01001838#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1839 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1840 {
1841 /* Remove inner padding and infer true content type. */
1842 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1843 &rec->type );
1844
1845 if( ret != 0 )
1846 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1847 }
1848#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1849
Hanno Beckera0e20d02019-05-15 14:03:01 +01001850#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001851 if( rec->cid_len != 0 )
1852 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001853 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1854 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001855 if( ret != 0 )
1856 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1857 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001858#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001861
1862 return( 0 );
1863}
1864
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001865#undef MAC_NONE
1866#undef MAC_PLAINTEXT
1867#undef MAC_CIPHERTEXT
1868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001870/*
1871 * Compression/decompression functions
1872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001874{
Janos Follath865b3eb2019-12-16 11:46:15 +00001875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001876 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001877 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001878 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001879 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001880#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1881 size_t out_buf_len = ssl->out_buf_len;
1882#else
1883 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1884#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001887
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001888 if( len_pre == 0 )
1889 return( 0 );
1890
Paul Bakker2770fbd2012-07-03 13:30:23 +00001891 memcpy( msg_pre, ssl->out_msg, len_pre );
1892
Paul Elliott9f352112020-12-09 14:55:45 +00001893 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %zu, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001894 ssl->out_msglen ) );
1895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001897 ssl->out_msg, ssl->out_msglen );
1898
Paul Bakker48916f92012-09-16 19:57:18 +00001899 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1900 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1901 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001902 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001903
Paul Bakker48916f92012-09-16 19:57:18 +00001904 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001905 if( ret != Z_OK )
1906 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1908 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001909 }
1910
Darryl Greenb33cc762019-11-28 14:29:44 +00001911 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001912 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001913
Paul Elliott9f352112020-12-09 14:55:45 +00001914 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %zu, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001915 ssl->out_msglen ) );
1916
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001918 ssl->out_msg, ssl->out_msglen );
1919
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001921
1922 return( 0 );
1923}
1924
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001926{
Janos Follath865b3eb2019-12-16 11:46:15 +00001927 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001928 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001929 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001930 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001931 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001932#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1933 size_t in_buf_len = ssl->in_buf_len;
1934#else
1935 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1936#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001938 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001939
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001940 if( len_pre == 0 )
1941 return( 0 );
1942
Paul Bakker2770fbd2012-07-03 13:30:23 +00001943 memcpy( msg_pre, ssl->in_msg, len_pre );
1944
Paul Elliott9f352112020-12-09 14:55:45 +00001945 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %zu, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001946 ssl->in_msglen ) );
1947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001949 ssl->in_msg, ssl->in_msglen );
1950
Paul Bakker48916f92012-09-16 19:57:18 +00001951 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1952 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1953 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001954 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001955
Paul Bakker48916f92012-09-16 19:57:18 +00001956 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001957 if( ret != Z_OK )
1958 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1960 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001961 }
1962
Darryl Greenb33cc762019-11-28 14:29:44 +00001963 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001964 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001965
Paul Elliott9f352112020-12-09 14:55:45 +00001966 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %zu, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001967 ssl->in_msglen ) );
1968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001970 ssl->in_msg, ssl->in_msglen );
1971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001973
1974 return( 0 );
1975}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001977
Paul Bakker5121ce52009-01-03 21:22:43 +00001978/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001979 * Fill the input message buffer by appending data to it.
1980 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001981 *
1982 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1983 * available (from this read and/or a previous one). Otherwise, an error code
1984 * is returned (possibly EOF or WANT_READ).
1985 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001986 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1987 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1988 * since we always read a whole datagram at once.
1989 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001990 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001991 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001994{
Janos Follath865b3eb2019-12-16 11:46:15 +00001995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001996 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001997#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1998 size_t in_buf_len = ssl->in_buf_len;
1999#else
2000 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2001#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002004
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002005 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
2006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002008 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002010 }
2011
Darryl Greenb33cc762019-11-28 14:29:44 +00002012 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002013 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
2015 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002016 }
2017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002019 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00002020 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002021 uint32_t timeout;
2022
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002023 /*
2024 * The point is, we need to always read a full datagram at once, so we
2025 * sometimes read more then requested, and handle the additional data.
2026 * It could be the rest of the current record (while fetching the
2027 * header) and/or some other records in the same datagram.
2028 */
2029
2030 /*
2031 * Move to the next record in the already read datagram if applicable
2032 */
2033 if( ssl->next_record_offset != 0 )
2034 {
2035 if( ssl->in_left < ssl->next_record_offset )
2036 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2038 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002039 }
2040
2041 ssl->in_left -= ssl->next_record_offset;
2042
2043 if( ssl->in_left != 0 )
2044 {
Paul Elliott9f352112020-12-09 14:55:45 +00002045 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %zu",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002046 ssl->next_record_offset ) );
2047 memmove( ssl->in_hdr,
2048 ssl->in_hdr + ssl->next_record_offset,
2049 ssl->in_left );
2050 }
2051
2052 ssl->next_record_offset = 0;
2053 }
2054
Paul Elliott9f352112020-12-09 14:55:45 +00002055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %zu, nb_want: %zu",
Paul Bakker5121ce52009-01-03 21:22:43 +00002056 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002057
2058 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002059 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002060 */
2061 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002062 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002064 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002065 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002066
2067 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002068 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002069 * are not at the beginning of a new record, the caller did something
2070 * wrong.
2071 */
2072 if( ssl->in_left != 0 )
2073 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2075 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002076 }
2077
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002078 /*
2079 * Don't even try to read if time's out already.
2080 * This avoids by-passing the timer when repeatedly receiving messages
2081 * that will end up being dropped.
2082 */
Hanno Becker7876d122020-02-05 10:39:31 +00002083 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01002084 {
2085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002086 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01002087 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002088 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002089 {
Darryl Greenb33cc762019-11-28 14:29:44 +00002090 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002093 timeout = ssl->handshake->retransmit_timeout;
2094 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002095 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002096
Paul Elliott9f352112020-12-09 14:55:45 +00002097 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002098
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002099 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002100 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2101 timeout );
2102 else
2103 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2104
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002105 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002106
2107 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002109 }
2110
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002111 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002112 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002114 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002117 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002118 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2119 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002121 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002122 }
2123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002125 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002127 return( ret );
2128 }
2129
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002130 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002131 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002133 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002135 {
Hanno Becker786300f2020-02-05 10:46:40 +00002136 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002137 {
Hanno Becker786300f2020-02-05 10:46:40 +00002138 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2139 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002140 return( ret );
2141 }
2142
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002143 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002144 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002146 }
2147
Paul Bakker5121ce52009-01-03 21:22:43 +00002148 if( ret < 0 )
2149 return( ret );
2150
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002151 ssl->in_left = ret;
2152 }
2153 else
2154#endif
2155 {
Paul Elliott9f352112020-12-09 14:55:45 +00002156 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %zu, nb_want: %zu",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002157 ssl->in_left, nb_want ) );
2158
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002159 while( ssl->in_left < nb_want )
2160 {
2161 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002162
Hanno Becker7876d122020-02-05 10:39:31 +00002163 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002164 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2165 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002166 {
2167 if( ssl->f_recv_timeout != NULL )
2168 {
2169 ret = ssl->f_recv_timeout( ssl->p_bio,
2170 ssl->in_hdr + ssl->in_left, len,
2171 ssl->conf->read_timeout );
2172 }
2173 else
2174 {
2175 ret = ssl->f_recv( ssl->p_bio,
2176 ssl->in_hdr + ssl->in_left, len );
2177 }
2178 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002179
Paul Elliott9f352112020-12-09 14:55:45 +00002180 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %zu, nb_want: %zu",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002181 ssl->in_left, nb_want ) );
2182 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002183
2184 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002186
2187 if( ret < 0 )
2188 return( ret );
2189
makise-homuraaf9513b2020-08-24 18:26:27 +03002190 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002191 {
Darryl Green11999bb2018-03-13 15:22:58 +00002192 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliott9f352112020-12-09 14:55:45 +00002193 ( "f_recv returned %d bytes but only %zu were requested",
2194 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002195 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2196 }
2197
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002198 ssl->in_left += ret;
2199 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002200 }
2201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002203
2204 return( 0 );
2205}
2206
2207/*
2208 * Flush any data not yet written
2209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002211{
Janos Follath865b3eb2019-12-16 11:46:15 +00002212 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002213 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002216
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002217 if( ssl->f_send == NULL )
2218 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002220 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002222 }
2223
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002224 /* Avoid incrementing counter if data is flushed */
2225 if( ssl->out_left == 0 )
2226 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002228 return( 0 );
2229 }
2230
Paul Bakker5121ce52009-01-03 21:22:43 +00002231 while( ssl->out_left > 0 )
2232 {
Paul Elliott9f352112020-12-09 14:55:45 +00002233 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %zu, out_left: %zu",
Hanno Becker5903de42019-05-03 14:46:38 +01002234 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002235
Hanno Becker2b1e3542018-08-06 11:19:13 +01002236 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002237 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002240
2241 if( ret <= 0 )
2242 return( ret );
2243
makise-homuraaf9513b2020-08-24 18:26:27 +03002244 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002245 {
Darryl Green11999bb2018-03-13 15:22:58 +00002246 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliott9f352112020-12-09 14:55:45 +00002247 ( "f_send returned %d bytes but only %zu bytes were sent",
2248 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002249 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2250 }
2251
Paul Bakker5121ce52009-01-03 21:22:43 +00002252 ssl->out_left -= ret;
2253 }
2254
Hanno Becker2b1e3542018-08-06 11:19:13 +01002255#if defined(MBEDTLS_SSL_PROTO_DTLS)
2256 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002257 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002258 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002259 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002260 else
2261#endif
2262 {
2263 ssl->out_hdr = ssl->out_buf + 8;
2264 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002265 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002266
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002268
2269 return( 0 );
2270}
2271
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002272/*
2273 * Functions to handle the DTLS retransmission state machine
2274 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002275#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002276/*
2277 * Append current handshake message to current outgoing flight
2278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002280{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2283 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2284 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002285
2286 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002287 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002288 {
Paul Elliott9f352112020-12-09 14:55:45 +00002289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %zu bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002290 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002291 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002292 }
2293
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002294 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002295 {
Paul Elliott9f352112020-12-09 14:55:45 +00002296 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %zu bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002298 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002299 }
2300
2301 /* Copy current handshake message with headers */
2302 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2303 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002304 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002305 msg->next = NULL;
2306
2307 /* Append to the current flight */
2308 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002309 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002310 else
2311 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313 while( cur->next != NULL )
2314 cur = cur->next;
2315 cur->next = msg;
2316 }
2317
Hanno Becker3b235902018-08-06 09:54:53 +01002318 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002319 return( 0 );
2320}
2321
2322/*
2323 * Free the current flight of handshake messages
2324 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002325void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002326{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 mbedtls_ssl_flight_item *cur = flight;
2328 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002329
2330 while( cur != NULL )
2331 {
2332 next = cur->next;
2333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 mbedtls_free( cur->p );
2335 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002336
2337 cur = next;
2338 }
2339}
2340
2341/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002342 * Swap transform_out and out_ctr with the alternative ones
2343 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002344static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002345{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002347 unsigned char tmp_out_ctr[8];
2348
2349 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2350 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002352 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002353 }
2354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002356
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002357 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002358 tmp_transform = ssl->transform_out;
2359 ssl->transform_out = ssl->handshake->alt_transform_out;
2360 ssl->handshake->alt_transform_out = tmp_transform;
2361
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002362 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002363 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2364 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002365 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002366
2367 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002368 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2371 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002372 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002373 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2374 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002375 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2377 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002378 }
2379 }
2380#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002381
2382 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002383}
2384
2385/*
2386 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002387 */
2388int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2389{
2390 int ret = 0;
2391
2392 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2393
2394 ret = mbedtls_ssl_flight_transmit( ssl );
2395
2396 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2397
2398 return( ret );
2399}
2400
2401/*
2402 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002403 *
2404 * Need to remember the current message in case flush_output returns
2405 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002406 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002407 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002408int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002409{
Janos Follath865b3eb2019-12-16 11:46:15 +00002410 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002411 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002412
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002413 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002414 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002415 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002416
2417 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002418 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002419 ret = ssl_swap_epochs( ssl );
2420 if( ret != 0 )
2421 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002424 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425
2426 while( ssl->handshake->cur_msg != NULL )
2427 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002428 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002429 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002430
Hanno Beckere1dcb032018-08-17 16:47:58 +01002431 int const is_finished =
2432 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2433 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2434
Hanno Becker04da1892018-08-14 13:22:10 +01002435 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2436 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2437
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002438 /* Swap epochs before sending Finished: we can't do it after
2439 * sending ChangeCipherSpec, in case write returns WANT_READ.
2440 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002441 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002442 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002443 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002444 ret = ssl_swap_epochs( ssl );
2445 if( ret != 0 )
2446 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002447 }
2448
Hanno Becker67bc7c32018-08-06 11:33:50 +01002449 ret = ssl_get_remaining_payload_in_datagram( ssl );
2450 if( ret < 0 )
2451 return( ret );
2452 max_frag_len = (size_t) ret;
2453
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002454 /* CCS is copied as is, while HS messages may need fragmentation */
2455 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2456 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002457 if( max_frag_len == 0 )
2458 {
2459 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2460 return( ret );
2461
2462 continue;
2463 }
2464
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002465 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002466 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002467 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002468
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002469 /* Update position inside current message */
2470 ssl->handshake->cur_msg_p += cur->len;
2471 }
2472 else
2473 {
2474 const unsigned char * const p = ssl->handshake->cur_msg_p;
2475 const size_t hs_len = cur->len - 12;
2476 const size_t frag_off = p - ( cur->p + 12 );
2477 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002478 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002479
Hanno Beckere1dcb032018-08-17 16:47:58 +01002480 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002481 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002482 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002483 {
2484 ret = ssl_swap_epochs( ssl );
2485 if( ret != 0 )
2486 return( ret );
2487 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002488
Hanno Becker67bc7c32018-08-06 11:33:50 +01002489 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2490 return( ret );
2491
2492 continue;
2493 }
2494 max_hs_frag_len = max_frag_len - 12;
2495
2496 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2497 max_hs_frag_len : rem_len;
2498
2499 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002500 {
2501 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002502 (unsigned) cur_hs_frag_len,
2503 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002504 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002505
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002506 /* Messages are stored with handshake headers as if not fragmented,
2507 * copy beginning of headers then fill fragmentation fields.
2508 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2509 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002510
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002511 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2512 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2513 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2514
Hanno Becker67bc7c32018-08-06 11:33:50 +01002515 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2516 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2517 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002518
2519 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2520
Hanno Becker3f7b9732018-08-28 09:53:25 +01002521 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002522 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2523 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002524 ssl->out_msgtype = cur->type;
2525
2526 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002527 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002528 }
2529
2530 /* If done with the current message move to the next one if any */
2531 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2532 {
2533 if( cur->next != NULL )
2534 {
2535 ssl->handshake->cur_msg = cur->next;
2536 ssl->handshake->cur_msg_p = cur->next->p + 12;
2537 }
2538 else
2539 {
2540 ssl->handshake->cur_msg = NULL;
2541 ssl->handshake->cur_msg_p = NULL;
2542 }
2543 }
2544
2545 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002546 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002547 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002549 return( ret );
2550 }
2551 }
2552
Hanno Becker67bc7c32018-08-06 11:33:50 +01002553 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2554 return( ret );
2555
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002556 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2558 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002559 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002562 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002563 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002564
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002565 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002566
2567 return( 0 );
2568}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002569
2570/*
2571 * To be called when the last message of an incoming flight is received.
2572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002574{
2575 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002576 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002577 ssl->handshake->flight = NULL;
2578 ssl->handshake->cur_msg = NULL;
2579
2580 /* The next incoming flight will start with this msg_seq */
2581 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2582
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002583 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002584 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002585
Hanno Becker0271f962018-08-16 13:23:47 +01002586 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002587 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002588
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002589 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002590 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2593 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002594 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002596 }
2597 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002599}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002600
2601/*
2602 * To be called when the last message of an outgoing flight is send.
2603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002605{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002606 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002607 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2610 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002611 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002613 }
2614 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002616}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002618
Paul Bakker5121ce52009-01-03 21:22:43 +00002619/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002620 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002621 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002622
2623/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002624 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002625 *
2626 * - fill in handshake headers
2627 * - update handshake checksum
2628 * - DTLS: save message for resending
2629 * - then pass to the record layer
2630 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002631 * DTLS: except for HelloRequest, messages are only queued, and will only be
2632 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002633 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002634 * Inputs:
2635 * - ssl->out_msglen: 4 + actual handshake message len
2636 * (4 is the size of handshake headers for TLS)
2637 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2638 * - ssl->out_msg + 4: the handshake message body
2639 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002640 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002641 * - ssl->out_msglen: the length of the record contents
2642 * (including handshake headers but excluding record headers)
2643 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002644 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002645int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002646{
Janos Follath865b3eb2019-12-16 11:46:15 +00002647 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002648 const size_t hs_len = ssl->out_msglen - 4;
2649 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002650
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2652
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002653 /*
2654 * Sanity checks
2655 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002656 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002657 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2658 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002659 /* In SSLv3, the client might send a NoCertificate alert. */
2660#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2661 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2662 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2663 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2664#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2665 {
2666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2667 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2668 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002669 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002670
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002671 /* Whenever we send anything different from a
2672 * HelloRequest we should be in a handshake - double check. */
2673 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2674 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002675 ssl->handshake == NULL )
2676 {
2677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2678 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2679 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002680
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002682 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002683 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002685 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002686 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002688 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002689#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002690
Hanno Beckerb50a2532018-08-06 11:52:54 +01002691 /* Double-check that we did not exceed the bounds
2692 * of the outgoing record buffer.
2693 * This should never fail as the various message
2694 * writing functions must obey the bounds of the
2695 * outgoing record buffer, but better be safe.
2696 *
2697 * Note: We deliberately do not check for the MTU or MFL here.
2698 */
2699 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2700 {
2701 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2702 "size %u, maximum %u",
2703 (unsigned) ssl->out_msglen,
2704 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2705 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2706 }
2707
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002708 /*
2709 * Fill handshake headers
2710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002711 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002712 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002713 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2714 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2715 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002716
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002717 /*
2718 * DTLS has additional fields in the Handshake layer,
2719 * between the length field and the actual payload:
2720 * uint16 message_seq;
2721 * uint24 fragment_offset;
2722 * uint24 fragment_length;
2723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002725 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002726 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002727 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002728 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002729 {
2730 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2731 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002732 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002733 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002734 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2735 }
2736
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002737 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002738 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002739
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002740 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002741 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002742 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002743 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2744 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2745 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002746 }
2747 else
2748 {
2749 ssl->out_msg[4] = 0;
2750 ssl->out_msg[5] = 0;
2751 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002752
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002753 /* Handshake hashes are computed without fragmentation,
2754 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002755 memset( ssl->out_msg + 6, 0x00, 3 );
2756 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002757 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002759
Hanno Becker0207e532018-08-28 10:28:28 +01002760 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002761 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2762 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002763 }
2764
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002765 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002767 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002768 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2769 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002770 {
2771 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2772 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002774 return( ret );
2775 }
2776 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002777 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002778#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002779 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002780 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002781 {
2782 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2783 return( ret );
2784 }
2785 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002786
2787 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2788
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002789 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002790}
2791
2792/*
2793 * Record layer functions
2794 */
2795
2796/*
2797 * Write current record.
2798 *
2799 * Uses:
2800 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2801 * - ssl->out_msglen: length of the record content (excl headers)
2802 * - ssl->out_msg: record content
2803 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002804int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002805{
2806 int ret, done = 0;
2807 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002808 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002809
2810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002813 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002815 {
2816 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2817 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002819 return( ret );
2820 }
2821
2822 len = ssl->out_msglen;
2823 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2827 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002828 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002830
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831 ret = mbedtls_ssl_hw_record_write( ssl );
2832 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002833 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2835 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002836 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002837
2838 if( ret == 0 )
2839 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002840 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002842 if( !done )
2843 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002844 unsigned i;
2845 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002846#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2847 size_t out_buf_len = ssl->out_buf_len;
2848#else
2849 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2850#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002851 /* Skip writing the record content type to after the encryption,
2852 * as it may change when using the CID extension. */
2853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002855 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002856
Hanno Becker19859472018-08-06 09:40:20 +01002857 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002858 ssl->out_len[0] = (unsigned char)( len >> 8 );
2859 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002860
Paul Bakker48916f92012-09-16 19:57:18 +00002861 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002862 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002863 mbedtls_record rec;
2864
2865 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002866 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002867 rec.data_len = ssl->out_msglen;
2868 rec.data_offset = ssl->out_msg - rec.buf;
2869
2870 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2871 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2872 ssl->conf->transport, rec.ver );
2873 rec.type = ssl->out_msgtype;
2874
Hanno Beckera0e20d02019-05-15 14:03:01 +01002875#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002876 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002877 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002878#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002879
Hanno Beckera18d1322018-01-03 14:27:32 +00002880 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002881 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002882 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002884 return( ret );
2885 }
2886
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002887 if( rec.data_offset != 0 )
2888 {
2889 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2890 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2891 }
2892
Hanno Becker6430faf2019-05-08 11:57:13 +01002893 /* Update the record content type and CID. */
2894 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002895#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002896 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002897#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002898 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002899 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2900 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002901 }
2902
Hanno Becker5903de42019-05-03 14:46:38 +01002903 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002904
2905#if defined(MBEDTLS_SSL_PROTO_DTLS)
2906 /* In case of DTLS, double-check that we don't exceed
2907 * the remaining space in the datagram. */
2908 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2909 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002910 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002911 if( ret < 0 )
2912 return( ret );
2913
2914 if( protected_record_size > (size_t) ret )
2915 {
2916 /* Should never happen */
2917 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2918 }
2919 }
2920#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002921
Hanno Becker6430faf2019-05-08 11:57:13 +01002922 /* Now write the potentially updated record content type. */
2923 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2924
Paul Elliott9f352112020-12-09 14:55:45 +00002925 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
2926 "version = [%u:%u], msglen = %zu",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002927 ssl->out_hdr[0], ssl->out_hdr[1],
2928 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002929
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002931 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002932
2933 ssl->out_left += protected_record_size;
2934 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002935 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002936
Hanno Beckerdd772292020-02-05 10:38:31 +00002937 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002938 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2939 break;
2940
2941 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002942 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002943 {
2944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2945 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2946 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002947 }
2948
Hanno Becker67bc7c32018-08-06 11:33:50 +01002949#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002950 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2951 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002952 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002953 size_t remaining;
2954 ret = ssl_get_remaining_payload_in_datagram( ssl );
2955 if( ret < 0 )
2956 {
2957 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2958 ret );
2959 return( ret );
2960 }
2961
2962 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002963 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002964 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002965 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002966 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002967 else
2968 {
Hanno Becker513815a2018-08-20 11:56:09 +01002969 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002970 }
2971 }
2972#endif /* MBEDTLS_SSL_PROTO_DTLS */
2973
2974 if( ( flush == SSL_FORCE_FLUSH ) &&
2975 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002976 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002978 return( ret );
2979 }
2980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002982
2983 return( 0 );
2984}
2985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002987
2988static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2989{
2990 if( ssl->in_msglen < ssl->in_hslen ||
2991 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2992 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2993 {
2994 return( 1 );
2995 }
2996 return( 0 );
2997}
Hanno Becker44650b72018-08-16 12:51:11 +01002998
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002999static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01003000{
3001 return( ( ssl->in_msg[9] << 16 ) |
3002 ( ssl->in_msg[10] << 8 ) |
3003 ssl->in_msg[11] );
3004}
3005
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003006static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01003007{
3008 return( ( ssl->in_msg[6] << 16 ) |
3009 ( ssl->in_msg[7] << 8 ) |
3010 ssl->in_msg[8] );
3011}
3012
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003013static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01003014{
3015 uint32_t msg_len, frag_off, frag_len;
3016
3017 msg_len = ssl_get_hs_total_len( ssl );
3018 frag_off = ssl_get_hs_frag_off( ssl );
3019 frag_len = ssl_get_hs_frag_len( ssl );
3020
3021 if( frag_off > msg_len )
3022 return( -1 );
3023
3024 if( frag_len > msg_len - frag_off )
3025 return( -1 );
3026
3027 if( frag_len + 12 > ssl->in_msglen )
3028 return( -1 );
3029
3030 return( 0 );
3031}
3032
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003033/*
3034 * Mark bits in bitmask (used for DTLS HS reassembly)
3035 */
3036static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
3037{
3038 unsigned int start_bits, end_bits;
3039
3040 start_bits = 8 - ( offset % 8 );
3041 if( start_bits != 8 )
3042 {
3043 size_t first_byte_idx = offset / 8;
3044
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003045 /* Special case */
3046 if( len <= start_bits )
3047 {
3048 for( ; len != 0; len-- )
3049 mask[first_byte_idx] |= 1 << ( start_bits - len );
3050
3051 /* Avoid potential issues with offset or len becoming invalid */
3052 return;
3053 }
3054
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003055 offset += start_bits; /* Now offset % 8 == 0 */
3056 len -= start_bits;
3057
3058 for( ; start_bits != 0; start_bits-- )
3059 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
3060 }
3061
3062 end_bits = len % 8;
3063 if( end_bits != 0 )
3064 {
3065 size_t last_byte_idx = ( offset + len ) / 8;
3066
3067 len -= end_bits; /* Now len % 8 == 0 */
3068
3069 for( ; end_bits != 0; end_bits-- )
3070 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
3071 }
3072
3073 memset( mask + offset / 8, 0xFF, len / 8 );
3074}
3075
3076/*
3077 * Check that bitmask is full
3078 */
3079static int ssl_bitmask_check( unsigned char *mask, size_t len )
3080{
3081 size_t i;
3082
3083 for( i = 0; i < len / 8; i++ )
3084 if( mask[i] != 0xFF )
3085 return( -1 );
3086
3087 for( i = 0; i < len % 8; i++ )
3088 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
3089 return( -1 );
3090
3091 return( 0 );
3092}
3093
Hanno Becker56e205e2018-08-16 09:06:12 +01003094/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003095static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003096 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003097{
Hanno Becker56e205e2018-08-16 09:06:12 +01003098 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003099
Hanno Becker56e205e2018-08-16 09:06:12 +01003100 alloc_len = 12; /* Handshake header */
3101 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003102
Hanno Beckerd07df862018-08-16 09:14:58 +01003103 if( add_bitmap )
3104 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003105
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003106 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003107}
Hanno Becker56e205e2018-08-16 09:06:12 +01003108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003110
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003111static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003112{
3113 return( ( ssl->in_msg[1] << 16 ) |
3114 ( ssl->in_msg[2] << 8 ) |
3115 ssl->in_msg[3] );
3116}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003117
Simon Butcher99000142016-10-13 17:21:01 +01003118int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003119{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003121 {
Paul Elliott9f352112020-12-09 14:55:45 +00003122 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %zu",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003123 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003125 }
3126
Hanno Becker12555c62018-08-16 12:47:53 +01003127 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliott9f352112020-12-09 14:55:45 +00003130 " %zu, type = %u, hslen = %zu",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003131 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003134 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003135 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003136 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003137 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003138
Hanno Becker44650b72018-08-16 12:51:11 +01003139 if( ssl_check_hs_header( ssl ) != 0 )
3140 {
3141 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3142 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3143 }
3144
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003145 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003146 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3147 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3148 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3149 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003150 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003151 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3152 {
3153 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3154 recv_msg_seq,
3155 ssl->handshake->in_msg_seq ) );
3156 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3157 }
3158
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003159 /* Retransmit only on last message from previous flight, to avoid
3160 * too many retransmissions.
3161 * Besides, No sane server ever retransmits HelloVerifyRequest */
3162 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003164 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003166 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003167 recv_msg_seq,
3168 ssl->handshake->in_flight_start_seq ) );
3169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003171 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003173 return( ret );
3174 }
3175 }
3176 else
3177 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003179 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003180 recv_msg_seq,
3181 ssl->handshake->in_msg_seq ) );
3182 }
3183
Hanno Becker90333da2017-10-10 11:27:13 +01003184 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003185 }
3186 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003187
Hanno Becker6d97ef52018-08-16 13:09:04 +01003188 /* Message reassembly is handled alongside buffering of future
3189 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003190 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003191 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003192 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003193 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003195 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003196 }
3197 }
3198 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003200 /* With TLS we don't handle fragmentation (for now) */
3201 if( ssl->in_msglen < ssl->in_hslen )
3202 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3204 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003205 }
3206
Simon Butcher99000142016-10-13 17:21:01 +01003207 return( 0 );
3208}
3209
3210void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3211{
Hanno Becker0271f962018-08-16 13:23:47 +01003212 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003213
Hanno Becker0271f962018-08-16 13:23:47 +01003214 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003215 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003216 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003217 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003218
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003219 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003221 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003222 ssl->handshake != NULL )
3223 {
Hanno Becker0271f962018-08-16 13:23:47 +01003224 unsigned offset;
3225 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003226
Hanno Becker0271f962018-08-16 13:23:47 +01003227 /* Increment handshake sequence number */
3228 hs->in_msg_seq++;
3229
3230 /*
3231 * Clear up handshake buffering and reassembly structure.
3232 */
3233
3234 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003235 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003236
3237 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003238 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3239 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003240 offset++, hs_buf++ )
3241 {
3242 *hs_buf = *(hs_buf + 1);
3243 }
3244
3245 /* Create a fresh last entry */
3246 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003247 }
3248#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003249}
3250
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003251/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003252 * DTLS anti-replay: RFC 6347 4.1.2.6
3253 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003254 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3255 * Bit n is set iff record number in_window_top - n has been seen.
3256 *
3257 * Usually, in_window_top is the last record number seen and the lsb of
3258 * in_window is set. The only exception is the initial state (record number 0
3259 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003261#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003262void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003263{
3264 ssl->in_window_top = 0;
3265 ssl->in_window = 0;
3266}
3267
3268static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3269{
3270 return( ( (uint64_t) buf[0] << 40 ) |
3271 ( (uint64_t) buf[1] << 32 ) |
3272 ( (uint64_t) buf[2] << 24 ) |
3273 ( (uint64_t) buf[3] << 16 ) |
3274 ( (uint64_t) buf[4] << 8 ) |
3275 ( (uint64_t) buf[5] ) );
3276}
3277
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003278static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3279{
Janos Follath865b3eb2019-12-16 11:46:15 +00003280 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003281 unsigned char *original_in_ctr;
3282
3283 // save original in_ctr
3284 original_in_ctr = ssl->in_ctr;
3285
3286 // use counter from record
3287 ssl->in_ctr = record_in_ctr;
3288
3289 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3290
3291 // restore the counter
3292 ssl->in_ctr = original_in_ctr;
3293
3294 return ret;
3295}
3296
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003297/*
3298 * Return 0 if sequence number is acceptable, -1 otherwise
3299 */
Hanno Becker0183d692019-07-12 08:50:37 +01003300int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003301{
3302 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3303 uint64_t bit;
3304
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003305 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003306 return( 0 );
3307
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003308 if( rec_seqnum > ssl->in_window_top )
3309 return( 0 );
3310
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003311 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003312
3313 if( bit >= 64 )
3314 return( -1 );
3315
3316 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3317 return( -1 );
3318
3319 return( 0 );
3320}
3321
3322/*
3323 * Update replay window on new validated record
3324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003326{
3327 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3328
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003329 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003330 return;
3331
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003332 if( rec_seqnum > ssl->in_window_top )
3333 {
3334 /* Update window_top and the contents of the window */
3335 uint64_t shift = rec_seqnum - ssl->in_window_top;
3336
3337 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003338 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003339 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003340 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003341 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003342 ssl->in_window |= 1;
3343 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003344
3345 ssl->in_window_top = rec_seqnum;
3346 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003347 else
3348 {
3349 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003350 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003351
3352 if( bit < 64 ) /* Always true, but be extra sure */
3353 ssl->in_window |= (uint64_t) 1 << bit;
3354 }
3355}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003357
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003358#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003359/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003360 * Without any SSL context, check if a datagram looks like a ClientHello with
3361 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003362 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003363 *
3364 * - if cookie is valid, return 0
3365 * - if ClientHello looks superficially valid but cookie is not,
3366 * fill obuf and set olen, then
3367 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3368 * - otherwise return a specific error code
3369 */
3370static int ssl_check_dtls_clihlo_cookie(
3371 mbedtls_ssl_cookie_write_t *f_cookie_write,
3372 mbedtls_ssl_cookie_check_t *f_cookie_check,
3373 void *p_cookie,
3374 const unsigned char *cli_id, size_t cli_id_len,
3375 const unsigned char *in, size_t in_len,
3376 unsigned char *obuf, size_t buf_len, size_t *olen )
3377{
3378 size_t sid_len, cookie_len;
3379 unsigned char *p;
3380
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003381 /*
3382 * Structure of ClientHello with record and handshake headers,
3383 * and expected values. We don't need to check a lot, more checks will be
3384 * done when actually parsing the ClientHello - skipping those checks
3385 * avoids code duplication and does not make cookie forging any easier.
3386 *
3387 * 0-0 ContentType type; copied, must be handshake
3388 * 1-2 ProtocolVersion version; copied
3389 * 3-4 uint16 epoch; copied, must be 0
3390 * 5-10 uint48 sequence_number; copied
3391 * 11-12 uint16 length; (ignored)
3392 *
3393 * 13-13 HandshakeType msg_type; (ignored)
3394 * 14-16 uint24 length; (ignored)
3395 * 17-18 uint16 message_seq; copied
3396 * 19-21 uint24 fragment_offset; copied, must be 0
3397 * 22-24 uint24 fragment_length; (ignored)
3398 *
3399 * 25-26 ProtocolVersion client_version; (ignored)
3400 * 27-58 Random random; (ignored)
3401 * 59-xx SessionID session_id; 1 byte len + sid_len content
3402 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3403 * ...
3404 *
3405 * Minimum length is 61 bytes.
3406 */
3407 if( in_len < 61 ||
3408 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3409 in[3] != 0 || in[4] != 0 ||
3410 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3411 {
3412 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3413 }
3414
3415 sid_len = in[59];
3416 if( sid_len > in_len - 61 )
3417 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3418
3419 cookie_len = in[60 + sid_len];
3420 if( cookie_len > in_len - 60 )
3421 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3422
3423 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3424 cli_id, cli_id_len ) == 0 )
3425 {
3426 /* Valid cookie */
3427 return( 0 );
3428 }
3429
3430 /*
3431 * If we get here, we've got an invalid cookie, let's prepare HVR.
3432 *
3433 * 0-0 ContentType type; copied
3434 * 1-2 ProtocolVersion version; copied
3435 * 3-4 uint16 epoch; copied
3436 * 5-10 uint48 sequence_number; copied
3437 * 11-12 uint16 length; olen - 13
3438 *
3439 * 13-13 HandshakeType msg_type; hello_verify_request
3440 * 14-16 uint24 length; olen - 25
3441 * 17-18 uint16 message_seq; copied
3442 * 19-21 uint24 fragment_offset; copied
3443 * 22-24 uint24 fragment_length; olen - 25
3444 *
3445 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3446 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3447 *
3448 * Minimum length is 28.
3449 */
3450 if( buf_len < 28 )
3451 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3452
3453 /* Copy most fields and adapt others */
3454 memcpy( obuf, in, 25 );
3455 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3456 obuf[25] = 0xfe;
3457 obuf[26] = 0xff;
3458
3459 /* Generate and write actual cookie */
3460 p = obuf + 28;
3461 if( f_cookie_write( p_cookie,
3462 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3463 {
3464 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3465 }
3466
3467 *olen = p - obuf;
3468
3469 /* Go back and fill length fields */
3470 obuf[27] = (unsigned char)( *olen - 28 );
3471
3472 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3473 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3474 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3475
3476 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3477 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3478
3479 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3480}
3481
3482/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003483 * Handle possible client reconnect with the same UDP quadruplet
3484 * (RFC 6347 Section 4.2.8).
3485 *
3486 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3487 * that looks like a ClientHello.
3488 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003489 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003490 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003491 * - if the input looks like a ClientHello with a valid cookie,
3492 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003493 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003494 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003495 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003496 * This function is called (through ssl_check_client_reconnect()) when an
3497 * unexpected record is found in ssl_get_next_record(), which will discard the
3498 * record if we return 0, and bubble up the return value otherwise (this
3499 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3500 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003501 */
3502static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3503{
Janos Follath865b3eb2019-12-16 11:46:15 +00003504 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003505 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003506
Hanno Becker2fddd372019-07-10 14:37:41 +01003507 if( ssl->conf->f_cookie_write == NULL ||
3508 ssl->conf->f_cookie_check == NULL )
3509 {
3510 /* If we can't use cookies to verify reachability of the peer,
3511 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003512 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3513 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003514 return( 0 );
3515 }
3516
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003517 ret = ssl_check_dtls_clihlo_cookie(
3518 ssl->conf->f_cookie_write,
3519 ssl->conf->f_cookie_check,
3520 ssl->conf->p_cookie,
3521 ssl->cli_id, ssl->cli_id_len,
3522 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003523 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003524
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003525 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3526
3527 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003528 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003529 int send_ret;
3530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3531 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3532 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003533 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003534 * If the error is permanent we'll catch it later,
3535 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003536 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3537 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3538 (void) send_ret;
3539
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003540 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003541 }
3542
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003543 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003544 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003545 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003546 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003547 {
3548 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3549 return( ret );
3550 }
3551
3552 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003553 }
3554
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003555 return( ret );
3556}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003557#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003558
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003559static int ssl_check_record_type( uint8_t record_type )
3560{
3561 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3562 record_type != MBEDTLS_SSL_MSG_ALERT &&
3563 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3564 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3565 {
3566 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3567 }
3568
3569 return( 0 );
3570}
3571
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003572/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003573 * ContentType type;
3574 * ProtocolVersion version;
3575 * uint16 epoch; // DTLS only
3576 * uint48 sequence_number; // DTLS only
3577 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003578 *
3579 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003580 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003581 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3582 *
3583 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003584 * 1. proceed with the record if this function returns 0
3585 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3586 * 3. return CLIENT_RECONNECT if this function return that value
3587 * 4. drop the whole datagram if this function returns anything else.
3588 * Point 2 is needed when the peer is resending, and we have already received
3589 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003590 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003591static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592 unsigned char *buf,
3593 size_t len,
3594 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003595{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003596 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003597
Hanno Beckere5e7e782019-07-11 12:29:35 +01003598 size_t const rec_hdr_type_offset = 0;
3599 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003600
Hanno Beckere5e7e782019-07-11 12:29:35 +01003601 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3602 rec_hdr_type_len;
3603 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003604
Hanno Beckere5e7e782019-07-11 12:29:35 +01003605 size_t const rec_hdr_ctr_len = 8;
3606#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003607 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003608 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3609 rec_hdr_version_len;
3610
Hanno Beckera0e20d02019-05-15 14:03:01 +01003611#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003612 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3613 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003614 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003615#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3616#endif /* MBEDTLS_SSL_PROTO_DTLS */
3617
3618 size_t rec_hdr_len_offset; /* To be determined */
3619 size_t const rec_hdr_len_len = 2;
3620
3621 /*
3622 * Check minimum lengths for record header.
3623 */
3624
3625#if defined(MBEDTLS_SSL_PROTO_DTLS)
3626 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3627 {
3628 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3629 }
3630 else
3631#endif /* MBEDTLS_SSL_PROTO_DTLS */
3632 {
3633 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3634 }
3635
3636 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3637 {
3638 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3639 (unsigned) len,
3640 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3641 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3642 }
3643
3644 /*
3645 * Parse and validate record content type
3646 */
3647
3648 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003649
3650 /* Check record content type */
3651#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3652 rec->cid_len = 0;
3653
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003654 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003655 ssl->conf->cid_len != 0 &&
3656 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003657 {
3658 /* Shift pointers to account for record header including CID
3659 * struct {
3660 * ContentType special_type = tls12_cid;
3661 * ProtocolVersion version;
3662 * uint16 epoch;
3663 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003664 * opaque cid[cid_length]; // Additional field compared to
3665 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003666 * uint16 length;
3667 * opaque enc_content[DTLSCiphertext.length];
3668 * } DTLSCiphertext;
3669 */
3670
3671 /* So far, we only support static CID lengths
3672 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003673 rec_hdr_cid_len = ssl->conf->cid_len;
3674 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003675
Hanno Beckere5e7e782019-07-11 12:29:35 +01003676 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003677 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003678 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3679 (unsigned) len,
3680 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003681 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003682 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003683
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003684 /* configured CID len is guaranteed at most 255, see
3685 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3686 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003687 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003688 }
3689 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003690#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003691 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003692 if( ssl_check_record_type( rec->type ) )
3693 {
Hanno Becker54229812019-07-12 14:40:00 +01003694 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3695 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003696 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3697 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003698 }
3699
Hanno Beckere5e7e782019-07-11 12:29:35 +01003700 /*
3701 * Parse and validate record version
3702 */
3703
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003704 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3705 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003706 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3707 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003708 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003709
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003710 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003711 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3713 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003714 }
3715
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003716 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003717 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3719 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003720 }
3721
Hanno Beckere5e7e782019-07-11 12:29:35 +01003722 /*
3723 * Parse/Copy record sequence number.
3724 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003725
Hanno Beckere5e7e782019-07-11 12:29:35 +01003726#if defined(MBEDTLS_SSL_PROTO_DTLS)
3727 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003728 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003729 /* Copy explicit record sequence number from input buffer. */
3730 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3731 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003732 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003733 else
3734#endif /* MBEDTLS_SSL_PROTO_DTLS */
3735 {
3736 /* Copy implicit record sequence number from SSL context structure. */
3737 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3738 }
Paul Bakker40e46942009-01-03 21:51:57 +00003739
Hanno Beckere5e7e782019-07-11 12:29:35 +01003740 /*
3741 * Parse record length.
3742 */
3743
Hanno Beckere5e7e782019-07-11 12:29:35 +01003744 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003745 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3746 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003747 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003748
Paul Elliott9f352112020-12-09 14:55:45 +00003749 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
3750 "version = [%d:%d], msglen = %zu",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003751 rec->type,
3752 major_ver, minor_ver, rec->data_len ) );
3753
3754 rec->buf = buf;
3755 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003756
Hanno Beckerd417cc92019-07-26 08:20:27 +01003757 if( rec->data_len == 0 )
3758 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003759
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003760 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003761 * DTLS-related tests.
3762 * Check epoch before checking length constraint because
3763 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3764 * message gets duplicated before the corresponding Finished message,
3765 * the second ChangeCipherSpec should be discarded because it belongs
3766 * to an old epoch, but not because its length is shorter than
3767 * the minimum record length for packets using the new record transform.
3768 * Note that these two kinds of failures are handled differently,
3769 * as an unexpected record is silently skipped but an invalid
3770 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003771 */
3772#if defined(MBEDTLS_SSL_PROTO_DTLS)
3773 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3774 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003775 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003776
Hanno Becker955a5c92019-07-10 17:12:07 +01003777 /* Check that the datagram is large enough to contain a record
3778 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003779 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003780 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3782 (unsigned) len,
3783 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003784 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3785 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003786
Hanno Becker37cfe732019-07-10 17:20:01 +01003787 /* Records from other, non-matching epochs are silently discarded.
3788 * (The case of same-port Client reconnects must be considered in
3789 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003790 if( rec_epoch != ssl->in_epoch )
3791 {
3792 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003793 "expected %u, received %lu",
3794 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003795
Hanno Becker552f7472019-07-19 10:59:12 +01003796 /* Records from the next epoch are considered for buffering
3797 * (concretely: early Finished messages). */
3798 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003799 {
Hanno Becker552f7472019-07-19 10:59:12 +01003800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3801 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003802 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003803
Hanno Becker2fddd372019-07-10 14:37:41 +01003804 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003805 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003806#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003807 /* For records from the correct epoch, check whether their
3808 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003809 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3810 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003811 {
3812 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3813 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3814 }
3815#endif
3816 }
3817#endif /* MBEDTLS_SSL_PROTO_DTLS */
3818
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003819 return( 0 );
3820}
Paul Bakker5121ce52009-01-03 21:22:43 +00003821
Paul Bakker5121ce52009-01-03 21:22:43 +00003822
Hanno Becker2fddd372019-07-10 14:37:41 +01003823#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3824static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3825{
3826 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3827
3828 /*
3829 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3830 * access the first byte of record content (handshake type), as we
3831 * have an active transform (possibly iv_len != 0), so use the
3832 * fact that the record header len is 13 instead.
3833 */
3834 if( rec_epoch == 0 &&
3835 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3836 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3837 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3838 ssl->in_left > 13 &&
3839 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3840 {
3841 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3842 "from the same port" ) );
3843 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003844 }
3845
3846 return( 0 );
3847}
Hanno Becker2fddd372019-07-10 14:37:41 +01003848#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003849
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003850/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003851 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003852 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003853static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3854 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003855{
3856 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003858 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003859 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003860
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003861#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3862 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003866 ret = mbedtls_ssl_hw_record_read( ssl );
3867 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003868 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003869 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3870 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003871 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003872
3873 if( ret == 0 )
3874 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003875 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003876#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003877 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003878 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003879 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003880
Hanno Beckera18d1322018-01-03 14:27:32 +00003881 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003882 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003883 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003884 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003885
Hanno Beckera0e20d02019-05-15 14:03:01 +01003886#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003887 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3888 ssl->conf->ignore_unexpected_cid
3889 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3890 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003891 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003892 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003893 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003894#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003895
Paul Bakker5121ce52009-01-03 21:22:43 +00003896 return( ret );
3897 }
3898
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003899 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003900 {
3901 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003902 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003903 }
3904
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003905 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003906 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003907
Hanno Beckera0e20d02019-05-15 14:03:01 +01003908#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003909 /* We have already checked the record content type
3910 * in ssl_parse_record_header(), failing or silently
3911 * dropping the record in the case of an unknown type.
3912 *
3913 * Since with the use of CIDs, the record content type
3914 * might change during decryption, re-check the record
3915 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003916 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003917 {
3918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3919 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3920 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003921#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003922
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003923 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003924 {
3925#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3926 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003927 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003928 {
3929 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3931 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3932 }
3933#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3934
3935 ssl->nb_zero++;
3936
3937 /*
3938 * Three or more empty messages may be a DoS attack
3939 * (excessive CPU consumption).
3940 */
3941 if( ssl->nb_zero > 3 )
3942 {
3943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003944 "messages, possible DoS attack" ) );
3945 /* Treat the records as if they were not properly authenticated,
3946 * thereby failing the connection if we see more than allowed
3947 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003948 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3949 }
3950 }
3951 else
3952 ssl->nb_zero = 0;
3953
3954#if defined(MBEDTLS_SSL_PROTO_DTLS)
3955 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3956 {
3957 ; /* in_ctr read from peer, not maintained internally */
3958 }
3959 else
3960#endif
3961 {
3962 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003963 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003964 if( ++ssl->in_ctr[i - 1] != 0 )
3965 break;
3966
3967 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003968 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003969 {
3970 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3971 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3972 }
3973 }
3974
Paul Bakker5121ce52009-01-03 21:22:43 +00003975 }
3976
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003978 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003979 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003980 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003981 }
3982#endif
3983
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003984 /* Check actual (decrypted) record content length against
3985 * configured maximum. */
3986 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3987 {
3988 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3989 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3990 }
3991
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003992 return( 0 );
3993}
3994
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003995/*
3996 * Read a record.
3997 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003998 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3999 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4000 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004001 */
Hanno Becker1097b342018-08-15 14:09:41 +01004002
4003/* Helper functions for mbedtls_ssl_read_record(). */
4004static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01004005static int ssl_get_next_record( mbedtls_ssl_context *ssl );
4006static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01004007
Hanno Becker327c93b2018-08-15 13:56:18 +01004008int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01004009 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004010{
Janos Follath865b3eb2019-12-16 11:46:15 +00004011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004014
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004015 if( ssl->keep_current_message == 0 )
4016 {
4017 do {
Simon Butcher99000142016-10-13 17:21:01 +01004018
Hanno Becker26994592018-08-15 14:14:59 +01004019 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01004020 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004021 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01004022
Hanno Beckere74d5562018-08-15 14:26:08 +01004023 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004024 {
Hanno Becker40f50842018-08-15 14:48:01 +01004025#if defined(MBEDTLS_SSL_PROTO_DTLS)
4026 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004027
Hanno Becker40f50842018-08-15 14:48:01 +01004028 /* We only check for buffered messages if the
4029 * current datagram is fully consumed. */
4030 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004031 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004032 {
Hanno Becker40f50842018-08-15 14:48:01 +01004033 if( ssl_load_buffered_message( ssl ) == 0 )
4034 have_buffered = 1;
4035 }
4036
4037 if( have_buffered == 0 )
4038#endif /* MBEDTLS_SSL_PROTO_DTLS */
4039 {
4040 ret = ssl_get_next_record( ssl );
4041 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
4042 continue;
4043
4044 if( ret != 0 )
4045 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01004046 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004047 return( ret );
4048 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004049 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004050 }
4051
4052 ret = mbedtls_ssl_handle_message_type( ssl );
4053
Hanno Becker40f50842018-08-15 14:48:01 +01004054#if defined(MBEDTLS_SSL_PROTO_DTLS)
4055 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4056 {
4057 /* Buffer future message */
4058 ret = ssl_buffer_message( ssl );
4059 if( ret != 0 )
4060 return( ret );
4061
4062 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4063 }
4064#endif /* MBEDTLS_SSL_PROTO_DTLS */
4065
Hanno Becker90333da2017-10-10 11:27:13 +01004066 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4067 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004068
4069 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01004070 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00004071 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01004072 return( ret );
4073 }
4074
Hanno Becker327c93b2018-08-15 13:56:18 +01004075 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01004076 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004077 {
4078 mbedtls_ssl_update_handshake_status( ssl );
4079 }
Simon Butcher99000142016-10-13 17:21:01 +01004080 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004081 else
Simon Butcher99000142016-10-13 17:21:01 +01004082 {
Hanno Becker02f59072018-08-15 14:00:24 +01004083 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004084 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004085 }
4086
4087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4088
4089 return( 0 );
4090}
4091
Hanno Becker40f50842018-08-15 14:48:01 +01004092#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004093static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004094{
Hanno Becker40f50842018-08-15 14:48:01 +01004095 if( ssl->in_left > ssl->next_record_offset )
4096 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004097
Hanno Becker40f50842018-08-15 14:48:01 +01004098 return( 0 );
4099}
4100
4101static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4102{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004103 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004104 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004105 int ret = 0;
4106
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004107 if( hs == NULL )
4108 return( -1 );
4109
Hanno Beckere00ae372018-08-20 09:39:42 +01004110 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4111
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004112 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4113 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4114 {
4115 /* Check if we have seen a ChangeCipherSpec before.
4116 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004117 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004118 {
4119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4120 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004121 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004122 }
4123
Hanno Becker39b8bc92018-08-28 17:17:13 +01004124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004125 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4126 ssl->in_msglen = 1;
4127 ssl->in_msg[0] = 1;
4128
4129 /* As long as they are equal, the exact value doesn't matter. */
4130 ssl->in_left = 0;
4131 ssl->next_record_offset = 0;
4132
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004133 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004134 goto exit;
4135 }
Hanno Becker37f95322018-08-16 13:55:32 +01004136
Hanno Beckerb8f50142018-08-28 10:01:34 +01004137#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004138 /* Debug only */
4139 {
4140 unsigned offset;
4141 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4142 {
4143 hs_buf = &hs->buffering.hs[offset];
4144 if( hs_buf->is_valid == 1 )
4145 {
4146 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4147 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004148 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004149 }
4150 }
4151 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004152#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004153
4154 /* Check if we have buffered and/or fully reassembled the
4155 * next handshake message. */
4156 hs_buf = &hs->buffering.hs[0];
4157 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4158 {
4159 /* Synthesize a record containing the buffered HS message. */
4160 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4161 ( hs_buf->data[2] << 8 ) |
4162 hs_buf->data[3];
4163
4164 /* Double-check that we haven't accidentally buffered
4165 * a message that doesn't fit into the input buffer. */
4166 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4167 {
4168 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4169 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4170 }
4171
4172 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4173 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4174 hs_buf->data, msg_len + 12 );
4175
4176 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4177 ssl->in_hslen = msg_len + 12;
4178 ssl->in_msglen = msg_len + 12;
4179 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4180
4181 ret = 0;
4182 goto exit;
4183 }
4184 else
4185 {
4186 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4187 hs->in_msg_seq ) );
4188 }
4189
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004190 ret = -1;
4191
4192exit:
4193
4194 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4195 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004196}
4197
Hanno Beckera02b0b42018-08-21 17:20:27 +01004198static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4199 size_t desired )
4200{
4201 int offset;
4202 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4204 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004205
Hanno Becker01315ea2018-08-21 17:22:17 +01004206 /* Get rid of future records epoch first, if such exist. */
4207 ssl_free_buffered_record( ssl );
4208
4209 /* Check if we have enough space available now. */
4210 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4211 hs->buffering.total_bytes_buffered ) )
4212 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004213 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004214 return( 0 );
4215 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004216
Hanno Becker4f432ad2018-08-28 10:02:32 +01004217 /* We don't have enough space to buffer the next expected handshake
4218 * message. Remove buffers used for future messages to gain space,
4219 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004220 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4221 offset >= 0; offset-- )
4222 {
4223 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4224 offset ) );
4225
Hanno Beckerb309b922018-08-23 13:18:05 +01004226 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004227
4228 /* Check if we have enough space available now. */
4229 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4230 hs->buffering.total_bytes_buffered ) )
4231 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004232 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004233 return( 0 );
4234 }
4235 }
4236
4237 return( -1 );
4238}
4239
Hanno Becker40f50842018-08-15 14:48:01 +01004240static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4241{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004242 int ret = 0;
4243 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4244
4245 if( hs == NULL )
4246 return( 0 );
4247
4248 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4249
4250 switch( ssl->in_msgtype )
4251 {
4252 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4253 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004254
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004255 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004256 break;
4257
4258 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004259 {
4260 unsigned recv_msg_seq_offset;
4261 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4262 mbedtls_ssl_hs_buffer *hs_buf;
4263 size_t msg_len = ssl->in_hslen - 12;
4264
4265 /* We should never receive an old handshake
4266 * message - double-check nonetheless. */
4267 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4268 {
4269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4270 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4271 }
4272
4273 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4274 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4275 {
4276 /* Silently ignore -- message too far in the future */
4277 MBEDTLS_SSL_DEBUG_MSG( 2,
4278 ( "Ignore future HS message with sequence number %u, "
4279 "buffering window %u - %u",
4280 recv_msg_seq, ssl->handshake->in_msg_seq,
4281 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4282
4283 goto exit;
4284 }
4285
4286 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4287 recv_msg_seq, recv_msg_seq_offset ) );
4288
4289 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4290
4291 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004292 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004293 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004294 size_t reassembly_buf_sz;
4295
Hanno Becker37f95322018-08-16 13:55:32 +01004296 hs_buf->is_fragmented =
4297 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4298
4299 /* We copy the message back into the input buffer
4300 * after reassembly, so check that it's not too large.
4301 * This is an implementation-specific limitation
4302 * and not one from the standard, hence it is not
4303 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004304 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004305 {
4306 /* Ignore message */
4307 goto exit;
4308 }
4309
Hanno Beckere0b150f2018-08-21 15:51:03 +01004310 /* Check if we have enough space to buffer the message. */
4311 if( hs->buffering.total_bytes_buffered >
4312 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4313 {
4314 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4315 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4316 }
4317
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004318 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4319 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004320
4321 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4322 hs->buffering.total_bytes_buffered ) )
4323 {
4324 if( recv_msg_seq_offset > 0 )
4325 {
4326 /* If we can't buffer a future message because
4327 * of space limitations -- ignore. */
Paul Elliott9f352112020-12-09 14:55:45 +00004328 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %zu would exceed the compile-time limit %d (already %zu bytes buffered) -- ignore\n",
4329 msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4330 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004331 goto exit;
4332 }
Hanno Beckere1801392018-08-21 16:51:05 +01004333 else
4334 {
Paul Elliott9f352112020-12-09 14:55:45 +00004335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %zu would exceed the compile-time limit %d (already %zu bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4336 msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4337 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004338 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004339
Hanno Beckera02b0b42018-08-21 17:20:27 +01004340 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004341 {
Paul Elliott9f352112020-12-09 14:55:45 +00004342 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %zu (%zu with bitmap) would exceed the compile-time limit %d (already %zu bytes buffered) -- fail\n",
4343 msg_len,
4344 reassembly_buf_sz,
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004345 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004346 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004347 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4348 goto exit;
4349 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004350 }
4351
Paul Elliott9f352112020-12-09 14:55:45 +00004352 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %zu",
Hanno Beckere0b150f2018-08-21 15:51:03 +01004353 msg_len ) );
4354
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004355 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4356 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004357 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004358 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004359 goto exit;
4360 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004361 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004362
4363 /* Prepare final header: copy msg_type, length and message_seq,
4364 * then add standardised fragment_offset and fragment_length */
4365 memcpy( hs_buf->data, ssl->in_msg, 6 );
4366 memset( hs_buf->data + 6, 0, 3 );
4367 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4368
4369 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004370
4371 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004372 }
4373 else
4374 {
4375 /* Make sure msg_type and length are consistent */
4376 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4377 {
4378 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4379 /* Ignore */
4380 goto exit;
4381 }
4382 }
4383
Hanno Becker4422bbb2018-08-20 09:40:19 +01004384 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004385 {
4386 size_t frag_len, frag_off;
4387 unsigned char * const msg = hs_buf->data + 12;
4388
4389 /*
4390 * Check and copy current fragment
4391 */
4392
4393 /* Validation of header fields already done in
4394 * mbedtls_ssl_prepare_handshake_record(). */
4395 frag_off = ssl_get_hs_frag_off( ssl );
4396 frag_len = ssl_get_hs_frag_len( ssl );
4397
Paul Elliott9f352112020-12-09 14:55:45 +00004398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %zu, length = %zu",
Hanno Becker37f95322018-08-16 13:55:32 +01004399 frag_off, frag_len ) );
4400 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4401
4402 if( hs_buf->is_fragmented )
4403 {
4404 unsigned char * const bitmask = msg + msg_len;
4405 ssl_bitmask_set( bitmask, frag_off, frag_len );
4406 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4407 msg_len ) == 0 );
4408 }
4409 else
4410 {
4411 hs_buf->is_complete = 1;
4412 }
4413
4414 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4415 hs_buf->is_complete ? "" : "not yet " ) );
4416 }
4417
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004418 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004419 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004420
4421 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004422 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004423 break;
4424 }
4425
4426exit:
4427
4428 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4429 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004430}
4431#endif /* MBEDTLS_SSL_PROTO_DTLS */
4432
Hanno Becker1097b342018-08-15 14:09:41 +01004433static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004434{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004435 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004436 * Consume last content-layer message and potentially
4437 * update in_msglen which keeps track of the contents'
4438 * consumption state.
4439 *
4440 * (1) Handshake messages:
4441 * Remove last handshake message, move content
4442 * and adapt in_msglen.
4443 *
4444 * (2) Alert messages:
4445 * Consume whole record content, in_msglen = 0.
4446 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004447 * (3) Change cipher spec:
4448 * Consume whole record content, in_msglen = 0.
4449 *
4450 * (4) Application data:
4451 * Don't do anything - the record layer provides
4452 * the application data as a stream transport
4453 * and consumes through mbedtls_ssl_read only.
4454 *
4455 */
4456
4457 /* Case (1): Handshake messages */
4458 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004459 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004460 /* Hard assertion to be sure that no application data
4461 * is in flight, as corrupting ssl->in_msglen during
4462 * ssl->in_offt != NULL is fatal. */
4463 if( ssl->in_offt != NULL )
4464 {
4465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4466 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4467 }
4468
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004469 /*
4470 * Get next Handshake message in the current record
4471 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004472
Hanno Becker4a810fb2017-05-24 16:27:30 +01004473 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004474 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004475 * current handshake content: If DTLS handshake
4476 * fragmentation is used, that's the fragment
4477 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004478 * size here is faulty and should be changed at
4479 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004480 * (2) While it doesn't seem to cause problems, one
4481 * has to be very careful not to assume that in_hslen
4482 * is always <= in_msglen in a sensible communication.
4483 * Again, it's wrong for DTLS handshake fragmentation.
4484 * The following check is therefore mandatory, and
4485 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004486 * Additionally, ssl->in_hslen might be arbitrarily out of
4487 * bounds after handling a DTLS message with an unexpected
4488 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004489 */
4490 if( ssl->in_hslen < ssl->in_msglen )
4491 {
4492 ssl->in_msglen -= ssl->in_hslen;
4493 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4494 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004495
Hanno Becker4a810fb2017-05-24 16:27:30 +01004496 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4497 ssl->in_msg, ssl->in_msglen );
4498 }
4499 else
4500 {
4501 ssl->in_msglen = 0;
4502 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004503
Hanno Becker4a810fb2017-05-24 16:27:30 +01004504 ssl->in_hslen = 0;
4505 }
4506 /* Case (4): Application data */
4507 else if( ssl->in_offt != NULL )
4508 {
4509 return( 0 );
4510 }
4511 /* Everything else (CCS & Alerts) */
4512 else
4513 {
4514 ssl->in_msglen = 0;
4515 }
4516
Hanno Becker1097b342018-08-15 14:09:41 +01004517 return( 0 );
4518}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004519
Hanno Beckere74d5562018-08-15 14:26:08 +01004520static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4521{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004522 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004523 return( 1 );
4524
4525 return( 0 );
4526}
4527
Hanno Becker5f066e72018-08-16 14:56:31 +01004528#if defined(MBEDTLS_SSL_PROTO_DTLS)
4529
4530static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4531{
4532 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4533 if( hs == NULL )
4534 return;
4535
Hanno Becker01315ea2018-08-21 17:22:17 +01004536 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004537 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004538 hs->buffering.total_bytes_buffered -=
4539 hs->buffering.future_record.len;
4540
4541 mbedtls_free( hs->buffering.future_record.data );
4542 hs->buffering.future_record.data = NULL;
4543 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004544}
4545
4546static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4547{
4548 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4549 unsigned char * rec;
4550 size_t rec_len;
4551 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004552#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4553 size_t in_buf_len = ssl->in_buf_len;
4554#else
4555 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4556#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004557 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4558 return( 0 );
4559
4560 if( hs == NULL )
4561 return( 0 );
4562
Hanno Becker5f066e72018-08-16 14:56:31 +01004563 rec = hs->buffering.future_record.data;
4564 rec_len = hs->buffering.future_record.len;
4565 rec_epoch = hs->buffering.future_record.epoch;
4566
4567 if( rec == NULL )
4568 return( 0 );
4569
Hanno Becker4cb782d2018-08-20 11:19:05 +01004570 /* Only consider loading future records if the
4571 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004572 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004573 return( 0 );
4574
Hanno Becker5f066e72018-08-16 14:56:31 +01004575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4576
4577 if( rec_epoch != ssl->in_epoch )
4578 {
4579 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4580 goto exit;
4581 }
4582
4583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4584
4585 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004586 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004587 {
4588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4589 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4590 }
4591
4592 memcpy( ssl->in_hdr, rec, rec_len );
4593 ssl->in_left = rec_len;
4594 ssl->next_record_offset = 0;
4595
4596 ssl_free_buffered_record( ssl );
4597
4598exit:
4599 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4600 return( 0 );
4601}
4602
Hanno Becker519f15d2019-07-11 12:43:20 +01004603static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4604 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004605{
4606 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004607
4608 /* Don't buffer future records outside handshakes. */
4609 if( hs == NULL )
4610 return( 0 );
4611
4612 /* Only buffer handshake records (we are only interested
4613 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004614 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004615 return( 0 );
4616
4617 /* Don't buffer more than one future epoch record. */
4618 if( hs->buffering.future_record.data != NULL )
4619 return( 0 );
4620
Hanno Becker01315ea2018-08-21 17:22:17 +01004621 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004622 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004623 hs->buffering.total_bytes_buffered ) )
4624 {
Paul Elliott9f352112020-12-09 14:55:45 +00004625 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %zu would exceed the compile-time limit %d (already %zu bytes buffered) -- ignore\n",
4626 rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4627 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004628 return( 0 );
4629 }
4630
Hanno Becker5f066e72018-08-16 14:56:31 +01004631 /* Buffer record */
4632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004633 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004634 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004635
4636 /* ssl_parse_record_header() only considers records
4637 * of the next epoch as candidates for buffering. */
4638 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004639 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004640
4641 hs->buffering.future_record.data =
4642 mbedtls_calloc( 1, hs->buffering.future_record.len );
4643 if( hs->buffering.future_record.data == NULL )
4644 {
4645 /* If we run out of RAM trying to buffer a
4646 * record from the next epoch, just ignore. */
4647 return( 0 );
4648 }
4649
Hanno Becker519f15d2019-07-11 12:43:20 +01004650 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004651
Hanno Becker519f15d2019-07-11 12:43:20 +01004652 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004653 return( 0 );
4654}
4655
4656#endif /* MBEDTLS_SSL_PROTO_DTLS */
4657
Hanno Beckere74d5562018-08-15 14:26:08 +01004658static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004659{
Janos Follath865b3eb2019-12-16 11:46:15 +00004660 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004661 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004662
Hanno Becker5f066e72018-08-16 14:56:31 +01004663#if defined(MBEDTLS_SSL_PROTO_DTLS)
4664 /* We might have buffered a future record; if so,
4665 * and if the epoch matches now, load it.
4666 * On success, this call will set ssl->in_left to
4667 * the length of the buffered record, so that
4668 * the calls to ssl_fetch_input() below will
4669 * essentially be no-ops. */
4670 ret = ssl_load_buffered_record( ssl );
4671 if( ret != 0 )
4672 return( ret );
4673#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004674
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004675 /* Ensure that we have enough space available for the default form
4676 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4677 * with no space for CIDs counted in). */
4678 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4679 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004681 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004682 return( ret );
4683 }
4684
Hanno Beckere5e7e782019-07-11 12:29:35 +01004685 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4686 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004687 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004688#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004689 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004690 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004691 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4692 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004693 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004694 if( ret != 0 )
4695 return( ret );
4696
4697 /* Fall through to handling of unexpected records */
4698 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4699 }
4700
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004701 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4702 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004703#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004704 /* Reset in pointers to default state for TLS/DTLS records,
4705 * assuming no CID and no offset between record content and
4706 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004707 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004708
Hanno Becker7ae20e02019-07-12 08:33:49 +01004709 /* Setup internal message pointers from record structure. */
4710 ssl->in_msgtype = rec.type;
4711#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4712 ssl->in_len = ssl->in_cid + rec.cid_len;
4713#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4714 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4715 ssl->in_msglen = rec.data_len;
4716
Hanno Becker2fddd372019-07-10 14:37:41 +01004717 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004718 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004719 if( ret != 0 )
4720 return( ret );
4721#endif
4722
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004723 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004724 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004725
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004726 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4727 "(header)" ) );
4728 }
4729 else
4730 {
4731 /* Skip invalid record and the rest of the datagram */
4732 ssl->next_record_offset = 0;
4733 ssl->in_left = 0;
4734
4735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4736 "(header)" ) );
4737 }
4738
4739 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004740 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004741 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004742 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004743#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004744 {
4745 return( ret );
4746 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004747 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004749#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004750 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004751 {
Hanno Beckera8814792019-07-10 15:01:45 +01004752 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004753 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004754 if( ssl->next_record_offset < ssl->in_left )
4755 {
4756 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4757 }
4758 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004759 else
4760#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004761 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004762 /*
4763 * Fetch record contents from underlying transport.
4764 */
Hanno Beckera3175662019-07-11 12:50:29 +01004765 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004766 if( ret != 0 )
4767 {
4768 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4769 return( ret );
4770 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004771
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004772 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004773 }
4774
4775 /*
4776 * Decrypt record contents.
4777 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004778
Hanno Beckerfdf66042019-07-11 13:07:45 +01004779 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004782 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004783 {
4784 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004785 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004786 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004787 /* Except when waiting for Finished as a bad mac here
4788 * probably means something went wrong in the handshake
4789 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4790 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4791 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4792 {
4793#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4794 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4795 {
4796 mbedtls_ssl_send_alert_message( ssl,
4797 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4798 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4799 }
4800#endif
4801 return( ret );
4802 }
4803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004804#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004805 if( ssl->conf->badmac_limit != 0 &&
4806 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004807 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004808 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4809 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004810 }
4811#endif
4812
Hanno Becker4a810fb2017-05-24 16:27:30 +01004813 /* As above, invalid records cause
4814 * dismissal of the whole datagram. */
4815
4816 ssl->next_record_offset = 0;
4817 ssl->in_left = 0;
4818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004819 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004820 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004821 }
4822
4823 return( ret );
4824 }
4825 else
4826#endif
4827 {
4828 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004829#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4830 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004831 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004832 mbedtls_ssl_send_alert_message( ssl,
4833 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4834 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004835 }
4836#endif
4837 return( ret );
4838 }
4839 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004840
Hanno Becker44d89b22019-07-12 09:40:44 +01004841
4842 /* Reset in pointers to default state for TLS/DTLS records,
4843 * assuming no CID and no offset between record content and
4844 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004845 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004846#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4847 ssl->in_len = ssl->in_cid + rec.cid_len;
4848#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004849 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004850
Hanno Becker8685c822019-07-12 09:37:30 +01004851 /* The record content type may change during decryption,
4852 * so re-read it. */
4853 ssl->in_msgtype = rec.type;
4854 /* Also update the input buffer, because unfortunately
4855 * the server-side ssl_parse_client_hello() reparses the
4856 * record header when receiving a ClientHello initiating
4857 * a renegotiation. */
4858 ssl->in_hdr[0] = rec.type;
4859 ssl->in_msg = rec.buf + rec.data_offset;
4860 ssl->in_msglen = rec.data_len;
4861 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4862 ssl->in_len[1] = (unsigned char)( rec.data_len );
4863
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004864#if defined(MBEDTLS_ZLIB_SUPPORT)
4865 if( ssl->transform_in != NULL &&
4866 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4867 {
4868 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4869 {
4870 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4871 return( ret );
4872 }
4873
4874 /* Check actual (decompress) record content length against
4875 * configured maximum. */
4876 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4877 {
4878 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4879 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4880 }
4881 }
4882#endif /* MBEDTLS_ZLIB_SUPPORT */
4883
Simon Butcher99000142016-10-13 17:21:01 +01004884 return( 0 );
4885}
4886
4887int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4888{
Janos Follath865b3eb2019-12-16 11:46:15 +00004889 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004890
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004891 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004892 * Handle particular types of records
4893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004894 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004895 {
Simon Butcher99000142016-10-13 17:21:01 +01004896 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4897 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004898 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004899 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004900 }
4901
Hanno Beckere678eaa2018-08-21 14:57:46 +01004902 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004903 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004904 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004905 {
Paul Elliott9f352112020-12-09 14:55:45 +00004906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %zu",
Hanno Beckere678eaa2018-08-21 14:57:46 +01004907 ssl->in_msglen ) );
4908 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004909 }
4910
Hanno Beckere678eaa2018-08-21 14:57:46 +01004911 if( ssl->in_msg[0] != 1 )
4912 {
4913 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4914 ssl->in_msg[0] ) );
4915 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4916 }
4917
4918#if defined(MBEDTLS_SSL_PROTO_DTLS)
4919 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4920 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4921 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4922 {
4923 if( ssl->handshake == NULL )
4924 {
4925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4926 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4927 }
4928
4929 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4930 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4931 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004932#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004933 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004936 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004937 if( ssl->in_msglen != 2 )
4938 {
4939 /* Note: Standard allows for more than one 2 byte alert
4940 to be packed in a single message, but Mbed TLS doesn't
4941 currently support this. */
Paul Elliott9f352112020-12-09 14:55:45 +00004942 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %zu",
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004943 ssl->in_msglen ) );
4944 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4945 }
4946
Paul Elliott9f352112020-12-09 14:55:45 +00004947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004948 ssl->in_msg[0], ssl->in_msg[1] ) );
4949
4950 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004951 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004953 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004956 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004957 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004958 }
4959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4961 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004962 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4964 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004965 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004966
4967#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4968 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4969 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4970 {
Hanno Becker90333da2017-10-10 11:27:13 +01004971 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004972 /* Will be handled when trying to parse ServerHello */
4973 return( 0 );
4974 }
4975#endif
4976
4977#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4978 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4979 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4980 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4981 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4982 {
4983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4984 /* Will be handled in mbedtls_ssl_parse_certificate() */
4985 return( 0 );
4986 }
4987#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4988
4989 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004990 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004991 }
4992
Hanno Beckerc76c6192017-06-06 10:03:17 +01004993#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004994 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004995 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004996 /* Drop unexpected ApplicationData records,
4997 * except at the beginning of renegotiations */
4998 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4999 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
5000#if defined(MBEDTLS_SSL_RENEGOTIATION)
5001 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5002 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01005003#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01005004 )
5005 {
5006 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
5007 return( MBEDTLS_ERR_SSL_NON_FATAL );
5008 }
5009
5010 if( ssl->handshake != NULL &&
5011 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
5012 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005013 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01005014 }
5015 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005016#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005017
Paul Bakker5121ce52009-01-03 21:22:43 +00005018 return( 0 );
5019}
5020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005022{
irwir6c0da642019-09-26 21:07:41 +03005023 return( mbedtls_ssl_send_alert_message( ssl,
5024 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5025 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005026}
5027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005028int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00005029 unsigned char level,
5030 unsigned char message )
5031{
Janos Follath865b3eb2019-12-16 11:46:15 +00005032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005033
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005034 if( ssl == NULL || ssl->conf == NULL )
5035 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005038 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00005039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005040 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005041 ssl->out_msglen = 2;
5042 ssl->out_msg[0] = level;
5043 ssl->out_msg[1] = message;
5044
Hanno Becker67bc7c32018-08-06 11:33:50 +01005045 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00005046 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005047 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00005048 return( ret );
5049 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00005051
5052 return( 0 );
5053}
5054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005055int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005056{
Janos Follath865b3eb2019-12-16 11:46:15 +00005057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005061 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005062 ssl->out_msglen = 1;
5063 ssl->out_msg[0] = 1;
5064
Paul Bakker5121ce52009-01-03 21:22:43 +00005065 ssl->state++;
5066
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005067 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005068 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005069 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005070 return( ret );
5071 }
5072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005073 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005074
5075 return( 0 );
5076}
5077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005078int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005079{
Janos Follath865b3eb2019-12-16 11:46:15 +00005080 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005083
Hanno Becker327c93b2018-08-15 13:56:18 +01005084 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005085 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005086 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005087 return( ret );
5088 }
5089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005090 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005091 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005093 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5094 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005096 }
5097
Hanno Beckere678eaa2018-08-21 14:57:46 +01005098 /* CCS records are only accepted if they have length 1 and content '1',
5099 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005100
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005101 /*
5102 * Switch to our negotiated transform and session parameters for inbound
5103 * data.
5104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005106 ssl->transform_in = ssl->transform_negotiate;
5107 ssl->session_in = ssl->session_negotiate;
5108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005109#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005110 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005111 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005112#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005113 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005114#endif
5115
5116 /* Increment epoch */
5117 if( ++ssl->in_epoch == 0 )
5118 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005119 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005120 /* This is highly unlikely to happen for legitimate reasons, so
5121 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005122 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005123 }
5124 }
5125 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005126#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005127 memset( ssl->in_ctr, 0, 8 );
5128
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005129 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005131#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5132 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005133 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005134 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005135 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005136 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005137 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5138 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005139 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005140 }
5141 }
5142#endif
5143
Paul Bakker5121ce52009-01-03 21:22:43 +00005144 ssl->state++;
5145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005146 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005147
5148 return( 0 );
5149}
5150
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005151/* Once ssl->out_hdr as the address of the beginning of the
5152 * next outgoing record is set, deduce the other pointers.
5153 *
5154 * Note: For TLS, we save the implicit record sequence number
5155 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5156 * and the caller has to make sure there's space for this.
5157 */
5158
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005159static size_t ssl_transform_get_explicit_iv_len(
5160 mbedtls_ssl_transform const *transform )
5161{
5162 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5163 return( 0 );
5164
5165 return( transform->ivlen - transform->fixed_ivlen );
5166}
5167
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005168void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5169 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005170{
5171#if defined(MBEDTLS_SSL_PROTO_DTLS)
5172 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5173 {
5174 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005175#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005176 ssl->out_cid = ssl->out_ctr + 8;
5177 ssl->out_len = ssl->out_cid;
5178 if( transform != NULL )
5179 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005180#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005181 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005183 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005184 }
5185 else
5186#endif
5187 {
5188 ssl->out_ctr = ssl->out_hdr - 8;
5189 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005190#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005191 ssl->out_cid = ssl->out_len;
5192#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005193 ssl->out_iv = ssl->out_hdr + 5;
5194 }
5195
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005196 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005197 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005198 if( transform != NULL )
5199 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005200}
5201
5202/* Once ssl->in_hdr as the address of the beginning of the
5203 * next incoming record is set, deduce the other pointers.
5204 *
5205 * Note: For TLS, we save the implicit record sequence number
5206 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5207 * and the caller has to make sure there's space for this.
5208 */
5209
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005210void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005211{
Hanno Becker79594fd2019-05-08 09:38:41 +01005212 /* This function sets the pointers to match the case
5213 * of unprotected TLS/DTLS records, with both ssl->in_iv
5214 * and ssl->in_msg pointing to the beginning of the record
5215 * content.
5216 *
5217 * When decrypting a protected record, ssl->in_msg
5218 * will be shifted to point to the beginning of the
5219 * record plaintext.
5220 */
5221
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005222#if defined(MBEDTLS_SSL_PROTO_DTLS)
5223 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5224 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005225 /* This sets the header pointers to match records
5226 * without CID. When we receive a record containing
5227 * a CID, the fields are shifted accordingly in
5228 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005229 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005230#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005231 ssl->in_cid = ssl->in_ctr + 8;
5232 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005233#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005234 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005235#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005236 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005237 }
5238 else
5239#endif
5240 {
5241 ssl->in_ctr = ssl->in_hdr - 8;
5242 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005243#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005244 ssl->in_cid = ssl->in_len;
5245#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005246 ssl->in_iv = ssl->in_hdr + 5;
5247 }
5248
Hanno Becker79594fd2019-05-08 09:38:41 +01005249 /* This will be adjusted at record decryption time. */
5250 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005251}
5252
Paul Bakker5121ce52009-01-03 21:22:43 +00005253/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005254 * Setup an SSL context
5255 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005256
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005257void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005258{
5259 /* Set the incoming and outgoing record pointers. */
5260#if defined(MBEDTLS_SSL_PROTO_DTLS)
5261 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5262 {
5263 ssl->out_hdr = ssl->out_buf;
5264 ssl->in_hdr = ssl->in_buf;
5265 }
5266 else
5267#endif /* MBEDTLS_SSL_PROTO_DTLS */
5268 {
5269 ssl->out_hdr = ssl->out_buf + 8;
5270 ssl->in_hdr = ssl->in_buf + 8;
5271 }
5272
5273 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005274 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5275 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005276}
5277
Paul Bakker5121ce52009-01-03 21:22:43 +00005278/*
5279 * SSL get accessors
5280 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005281size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005282{
5283 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5284}
5285
Hanno Becker8b170a02017-10-10 11:51:19 +01005286int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5287{
5288 /*
5289 * Case A: We're currently holding back
5290 * a message for further processing.
5291 */
5292
5293 if( ssl->keep_current_message == 1 )
5294 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005296 return( 1 );
5297 }
5298
5299 /*
5300 * Case B: Further records are pending in the current datagram.
5301 */
5302
5303#if defined(MBEDTLS_SSL_PROTO_DTLS)
5304 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5305 ssl->in_left > ssl->next_record_offset )
5306 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005307 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005308 return( 1 );
5309 }
5310#endif /* MBEDTLS_SSL_PROTO_DTLS */
5311
5312 /*
5313 * Case C: A handshake message is being processed.
5314 */
5315
Hanno Becker8b170a02017-10-10 11:51:19 +01005316 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5317 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005318 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005319 return( 1 );
5320 }
5321
5322 /*
5323 * Case D: An application data message is being processed
5324 */
5325 if( ssl->in_offt != NULL )
5326 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005327 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005328 return( 1 );
5329 }
5330
5331 /*
5332 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005333 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005334 * we implement support for multiple alerts in single records.
5335 */
5336
5337 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5338 return( 0 );
5339}
5340
Paul Bakker43ca69c2011-01-15 17:35:19 +00005341
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005342int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005343{
Hanno Becker3136ede2018-08-17 15:28:19 +01005344 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005346 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005347
Hanno Becker5903de42019-05-03 14:46:38 +01005348 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5349
Hanno Becker78640902018-08-13 16:35:15 +01005350 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005351 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005353#if defined(MBEDTLS_ZLIB_SUPPORT)
5354 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5355 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005356#endif
5357
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005358 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360 case MBEDTLS_MODE_GCM:
5361 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005362 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005363 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005364 transform_expansion = transform->minlen;
5365 break;
5366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005367 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005368
5369 block_size = mbedtls_cipher_get_block_size(
5370 &transform->cipher_ctx_enc );
5371
Hanno Becker3136ede2018-08-17 15:28:19 +01005372 /* Expansion due to the addition of the MAC. */
5373 transform_expansion += transform->maclen;
5374
5375 /* Expansion due to the addition of CBC padding;
5376 * Theoretically up to 256 bytes, but we never use
5377 * more than the block size of the underlying cipher. */
5378 transform_expansion += block_size;
5379
5380 /* For TLS 1.1 or higher, an explicit IV is added
5381 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005382#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5383 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005384 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005385#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005386
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005387 break;
5388
5389 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005392 }
5393
Hanno Beckera0e20d02019-05-15 14:03:01 +01005394#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005395 if( transform->out_cid_len != 0 )
5396 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005397#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005398
Hanno Becker5903de42019-05-03 14:46:38 +01005399 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005400}
5401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005402#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005403/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005404 * Check record counters and renegotiate if they're above the limit.
5405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005406static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005407{
Hanno Beckerdd772292020-02-05 10:38:31 +00005408 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005409 int in_ctr_cmp;
5410 int out_ctr_cmp;
5411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005412 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5413 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005414 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005415 {
5416 return( 0 );
5417 }
5418
Andres AG2196c7f2016-12-15 17:01:16 +00005419 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5420 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005421 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005422 ssl->conf->renego_period + ep_len, 8 - ep_len );
5423
5424 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005425 {
5426 return( 0 );
5427 }
5428
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005429 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005431}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005433
5434/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005435 * Receive application data decrypted from the SSL layer
5436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005438{
Janos Follath865b3eb2019-12-16 11:46:15 +00005439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005440 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005441
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005442 if( ssl == NULL || ssl->conf == NULL )
5443 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005448 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005449 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005451 return( ret );
5452
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005453 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005455 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005456 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005457 return( ret );
5458 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005459 }
5460#endif
5461
Hanno Becker4a810fb2017-05-24 16:27:30 +01005462 /*
5463 * Check if renegotiation is necessary and/or handshake is
5464 * in process. If yes, perform/continue, and fall through
5465 * if an unexpected packet is received while the client
5466 * is waiting for the ServerHello.
5467 *
5468 * (There is no equivalent to the last condition on
5469 * the server-side as it is not treated as within
5470 * a handshake while waiting for the ClientHello
5471 * after a renegotiation request.)
5472 */
5473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005475 ret = ssl_check_ctr_renegotiate( ssl );
5476 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5477 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005478 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005480 return( ret );
5481 }
5482#endif
5483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005485 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005486 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005487 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5488 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005489 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005490 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005491 return( ret );
5492 }
5493 }
5494
Hanno Beckere41158b2017-10-23 13:30:32 +01005495 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005496 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005497 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005498 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005499 if( ssl->f_get_timer != NULL &&
5500 ssl->f_get_timer( ssl->p_timer ) == -1 )
5501 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005502 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005503 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005504
Hanno Becker327c93b2018-08-15 13:56:18 +01005505 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005506 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005507 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5508 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005509
Hanno Becker4a810fb2017-05-24 16:27:30 +01005510 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5511 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005512 }
5513
5514 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005515 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005516 {
5517 /*
5518 * OpenSSL sends empty messages to randomize the IV
5519 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005520 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005521 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005522 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005523 return( 0 );
5524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005525 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005526 return( ret );
5527 }
5528 }
5529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005530 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005533
Hanno Becker4a810fb2017-05-24 16:27:30 +01005534 /*
5535 * - For client-side, expect SERVER_HELLO_REQUEST.
5536 * - For server-side, expect CLIENT_HELLO.
5537 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5538 */
5539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005541 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005542 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005543 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005544 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005545 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005546
5547 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005548#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005549 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005550 {
5551 continue;
5552 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005555 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005556#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005557
Hanno Becker4a810fb2017-05-24 16:27:30 +01005558#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005559 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005560 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005561 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005563
5564 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005566 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005567 {
5568 continue;
5569 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005570#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005571 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005572 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005573#endif /* MBEDTLS_SSL_SRV_C */
5574
Hanno Becker21df7f92017-10-17 11:03:26 +01005575#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005576 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005577 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5578 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5579 ssl->conf->allow_legacy_renegotiation ==
5580 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5581 {
5582 /*
5583 * Accept renegotiation request
5584 */
Paul Bakker48916f92012-09-16 19:57:18 +00005585
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005586 /* DTLS clients need to know renego is server-initiated */
5587#if defined(MBEDTLS_SSL_PROTO_DTLS)
5588 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5589 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5590 {
5591 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5592 }
5593#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005594 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005595 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5596 ret != 0 )
5597 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005598 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5599 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005600 return( ret );
5601 }
5602 }
5603 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005604#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005605 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005606 /*
5607 * Refuse renegotiation
5608 */
5609
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005610 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005612#if defined(MBEDTLS_SSL_PROTO_SSL3)
5613 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005614 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005615 /* SSLv3 does not have a "no_renegotiation" warning, so
5616 we send a fatal alert and abort the connection. */
5617 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5618 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5619 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005620 }
5621 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005622#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5623#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5624 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5625 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005626 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005627 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5628 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5629 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005630 {
5631 return( ret );
5632 }
Paul Bakker48916f92012-09-16 19:57:18 +00005633 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005634 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005635#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5636 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005637 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005638 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5639 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005640 }
Paul Bakker48916f92012-09-16 19:57:18 +00005641 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005642
Hanno Becker90333da2017-10-10 11:27:13 +01005643 /* At this point, we don't know whether the renegotiation has been
5644 * completed or not. The cases to consider are the following:
5645 * 1) The renegotiation is complete. In this case, no new record
5646 * has been read yet.
5647 * 2) The renegotiation is incomplete because the client received
5648 * an application data record while awaiting the ServerHello.
5649 * 3) The renegotiation is incomplete because the client received
5650 * a non-handshake, non-application data message while awaiting
5651 * the ServerHello.
5652 * In each of these case, looping will be the proper action:
5653 * - For 1), the next iteration will read a new record and check
5654 * if it's application data.
5655 * - For 2), the loop condition isn't satisfied as application data
5656 * is present, hence continue is the same as break
5657 * - For 3), the loop condition is satisfied and read_record
5658 * will re-deliver the message that was held back by the client
5659 * when expecting the ServerHello.
5660 */
5661 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005662 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005663#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005664 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005665 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005666 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005667 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005668 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005669 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005671 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005673 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005674 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005675 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005676#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005678 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5679 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005682 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005683 }
5684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005687 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5688 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005689 }
5690
5691 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005692
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005693 /* We're going to return something now, cancel timer,
5694 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005695 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005696 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005697
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005698#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005699 /* If we requested renego but received AppData, resend HelloRequest.
5700 * Do it now, after setting in_offt, to avoid taking this branch
5701 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005703 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005704 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005705 {
Hanno Becker786300f2020-02-05 10:46:40 +00005706 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005707 {
Hanno Becker786300f2020-02-05 10:46:40 +00005708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5709 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005710 return( ret );
5711 }
5712 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005713#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005714#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005715 }
5716
5717 n = ( len < ssl->in_msglen )
5718 ? len : ssl->in_msglen;
5719
5720 memcpy( buf, ssl->in_offt, n );
5721 ssl->in_msglen -= n;
5722
gabor-mezei-arma3214132020-07-15 10:55:00 +02005723 /* Zeroising the plaintext buffer to erase unused application data
5724 from the memory. */
5725 mbedtls_platform_zeroize( ssl->in_offt, n );
5726
Paul Bakker5121ce52009-01-03 21:22:43 +00005727 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005728 {
5729 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005730 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005731 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005732 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005733 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005734 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005735 /* more data available */
5736 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005737 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005738
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005740
Paul Bakker23986e52011-04-24 08:57:21 +00005741 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005742}
5743
5744/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005745 * Send application data to be encrypted by the SSL layer, taking care of max
5746 * fragment length and buffer size.
5747 *
5748 * According to RFC 5246 Section 6.2.1:
5749 *
5750 * Zero-length fragments of Application data MAY be sent as they are
5751 * potentially useful as a traffic analysis countermeasure.
5752 *
5753 * Therefore, it is possible that the input message length is 0 and the
5754 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005755 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005756static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005757 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005758{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005759 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5760 const size_t max_len = (size_t) ret;
5761
5762 if( ret < 0 )
5763 {
5764 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5765 return( ret );
5766 }
5767
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005768 if( len > max_len )
5769 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005770#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005771 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005772 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliott9f352112020-12-09 14:55:45 +00005774 "maximum fragment length: %zu > %zu",
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005775 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005777 }
5778 else
5779#endif
5780 len = max_len;
5781 }
Paul Bakker887bd502011-06-08 13:10:54 +00005782
Paul Bakker5121ce52009-01-03 21:22:43 +00005783 if( ssl->out_left != 0 )
5784 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005785 /*
5786 * The user has previously tried to send the data and
5787 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5788 * written. In this case, we expect the high-level write function
5789 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005792 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005794 return( ret );
5795 }
5796 }
Paul Bakker887bd502011-06-08 13:10:54 +00005797 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005798 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005799 /*
5800 * The user is trying to send a message the first time, so we need to
5801 * copy the data into the internal buffers and setup the data structure
5802 * to keep track of partial writes
5803 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005804 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005805 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005806 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005807
Hanno Becker67bc7c32018-08-06 11:33:50 +01005808 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005809 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005810 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005811 return( ret );
5812 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005813 }
5814
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005815 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005816}
5817
5818/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005819 * Write application data, doing 1/n-1 splitting if necessary.
5820 *
5821 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005822 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005823 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005825#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005826static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005827 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005828{
Janos Follath865b3eb2019-12-16 11:46:15 +00005829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005830
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005831 if( ssl->conf->cbc_record_splitting ==
5832 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005833 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005834 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5835 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5836 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005837 {
5838 return( ssl_write_real( ssl, buf, len ) );
5839 }
5840
5841 if( ssl->split_done == 0 )
5842 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005843 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005844 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005845 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005846 }
5847
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005848 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5849 return( ret );
5850 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005851
5852 return( ret + 1 );
5853}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005854#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005855
5856/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005857 * Write application data (public-facing wrapper)
5858 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005859int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005860{
Janos Follath865b3eb2019-12-16 11:46:15 +00005861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005862
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005864
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005865 if( ssl == NULL || ssl->conf == NULL )
5866 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5867
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005868#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005869 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5870 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005871 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005872 return( ret );
5873 }
5874#endif
5875
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005876 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005877 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005878 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005879 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005880 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005881 return( ret );
5882 }
5883 }
5884
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005885#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005886 ret = ssl_write_split( ssl, buf, len );
5887#else
5888 ret = ssl_write_real( ssl, buf, len );
5889#endif
5890
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005891 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005892
5893 return( ret );
5894}
5895
5896/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005897 * Notify the peer that the connection is being closed
5898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005899int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005900{
Janos Follath865b3eb2019-12-16 11:46:15 +00005901 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005902
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005903 if( ssl == NULL || ssl->conf == NULL )
5904 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005907
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005908 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005909 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005911 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005912 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005913 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5914 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5915 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005916 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005917 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005918 return( ret );
5919 }
5920 }
5921
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005922 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005923
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005924 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005925}
5926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005927void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005928{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005929 if( transform == NULL )
5930 return;
5931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005932#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005933 deflateEnd( &transform->ctx_deflate );
5934 inflateEnd( &transform->ctx_inflate );
5935#endif
5936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005937 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5938 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005939
Hanno Beckerd56ed242018-01-03 15:32:51 +00005940#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005941 mbedtls_md_free( &transform->md_ctx_enc );
5942 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005943#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005944
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005945 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005946}
5947
Hanno Becker0271f962018-08-16 13:23:47 +01005948#if defined(MBEDTLS_SSL_PROTO_DTLS)
5949
Hanno Becker533ab5f2020-02-05 10:49:13 +00005950void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005951{
5952 unsigned offset;
5953 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5954
5955 if( hs == NULL )
5956 return;
5957
Hanno Becker283f5ef2018-08-24 09:34:47 +01005958 ssl_free_buffered_record( ssl );
5959
Hanno Becker0271f962018-08-16 13:23:47 +01005960 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005961 ssl_buffering_free_slot( ssl, offset );
5962}
5963
5964static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5965 uint8_t slot )
5966{
5967 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5968 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005969
5970 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5971 return;
5972
Hanno Beckere605b192018-08-21 15:59:07 +01005973 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005974 {
Hanno Beckere605b192018-08-21 15:59:07 +01005975 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005976 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005977 mbedtls_free( hs_buf->data );
5978 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005979 }
5980}
5981
5982#endif /* MBEDTLS_SSL_PROTO_DTLS */
5983
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005984/*
5985 * Convert version numbers to/from wire format
5986 * and, for DTLS, to/from TLS equivalent.
5987 *
5988 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005989 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005990 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5991 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005993void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005994 unsigned char ver[2] )
5995{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005996#if defined(MBEDTLS_SSL_PROTO_DTLS)
5997 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005998 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005999 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006000 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
6001
6002 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
6003 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
6004 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006005 else
6006#else
6007 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006008#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006009 {
6010 ver[0] = (unsigned char) major;
6011 ver[1] = (unsigned char) minor;
6012 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006013}
6014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006015void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006016 const unsigned char ver[2] )
6017{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006018#if defined(MBEDTLS_SSL_PROTO_DTLS)
6019 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006020 {
6021 *major = 255 - ver[0] + 2;
6022 *minor = 255 - ver[1] + 1;
6023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006024 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006025 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
6026 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006027 else
6028#else
6029 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006030#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006031 {
6032 *major = ver[0];
6033 *minor = ver[1];
6034 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006035}
6036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006037#endif /* MBEDTLS_SSL_TLS_C */