blob: de350ebc0198b56780249c31fe2f3f12dba76476 [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"
gabor-mezei-arm944c1072021-09-27 11:28:54 +020047#include "constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020048
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020049#include "ssl_invasive.h"
50
Rich Evans00ab4702015-02-06 13:43:58 +000051#include <string.h>
52
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
54#include "mbedtls/psa_util.h"
55#include "psa/crypto.h"
56#endif
57
Janos Follath23bdca02016-10-07 14:47:14 +010058#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000059#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020060#endif
61
Hanno Beckercd9dcda2018-08-28 17:18:56 +010062static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010063
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064/*
65 * Start a timer.
66 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020067 */
Hanno Becker0f57a652020-02-05 10:37:26 +000068void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020069{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020070 if( ssl->f_set_timer == NULL )
71 return;
72
73 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
74 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020075}
76
77/*
78 * Return -1 is timer is expired, 0 if it isn't.
79 */
Hanno Becker7876d122020-02-05 10:39:31 +000080int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020081{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020082 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020083 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020084
85 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020086 {
87 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020089 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020090
91 return( 0 );
92}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020093
Hanno Beckercfe45792019-07-03 16:13:00 +010094#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010095static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t len,
98 mbedtls_record *rec );
99
Hanno Beckercfe45792019-07-03 16:13:00 +0100100int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
101 unsigned char *buf,
102 size_t buflen )
103{
Hanno Becker54229812019-07-12 14:40:00 +0100104 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
106 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
107
108 /* We don't support record checking in TLS because
109 * (a) there doesn't seem to be a usecase for it, and
110 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
111 * and we'd need to backup the transform here.
112 */
113 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
114 {
115 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
116 goto exit;
117 }
118#if defined(MBEDTLS_SSL_PROTO_DTLS)
119 else
120 {
irwir734f0cf2019-09-26 21:03:24 +0300121 mbedtls_record rec;
122
Hanno Becker54229812019-07-12 14:40:00 +0100123 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
124 if( ret != 0 )
125 {
126 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
127 goto exit;
128 }
129
130 if( ssl->transform_in != NULL )
131 {
132 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
133 if( ret != 0 )
134 {
135 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
136 goto exit;
137 }
138 }
139 }
140#endif /* MBEDTLS_SSL_PROTO_DTLS */
141
142exit:
143 /* On success, we have decrypted the buffer in-place, so make
144 * sure we don't leak any plaintext data. */
145 mbedtls_platform_zeroize( buf, buflen );
146
147 /* For the purpose of this API, treat messages with unexpected CID
148 * as well as such from future epochs as unexpected. */
149 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
150 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
151 {
152 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
153 }
154
155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
156 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100157}
158#endif /* MBEDTLS_SSL_RECORD_CHECKING */
159
Hanno Becker67bc7c32018-08-06 11:33:50 +0100160#define SSL_DONT_FORCE_FLUSH 0
161#define SSL_FORCE_FLUSH 1
162
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200163#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100164
Hanno Beckerd5847772018-08-28 10:09:23 +0100165/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100166static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
167 uint8_t slot );
168static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
169static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
170static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
171static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100172static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
173 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100174static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100175
Hanno Becker11682cc2018-08-22 14:41:02 +0100176static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100177{
Hanno Becker89490712020-02-05 10:50:12 +0000178 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000179#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
180 size_t out_buf_len = ssl->out_buf_len;
181#else
182 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
183#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100184
Darryl Greenb33cc762019-11-28 14:29:44 +0000185 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100186 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100187
Darryl Greenb33cc762019-11-28 14:29:44 +0000188 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100189}
190
Hanno Becker67bc7c32018-08-06 11:33:50 +0100191static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
192{
Hanno Becker11682cc2018-08-22 14:41:02 +0100193 size_t const bytes_written = ssl->out_left;
194 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100195
196 /* Double-check that the write-index hasn't gone
197 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100198 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100199 {
200 /* Should never happen... */
201 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
202 }
203
204 return( (int) ( mtu - bytes_written ) );
205}
206
207static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
208{
Janos Follath865b3eb2019-12-16 11:46:15 +0000209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100210 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400211 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100212
213#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400214 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100215
216 if( max_len > mfl )
217 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100218
219 /* By the standard (RFC 6066 Sect. 4), the MFL extension
220 * only limits the maximum record payload size, so in theory
221 * we would be allowed to pack multiple records of payload size
222 * MFL into a single datagram. However, this would mean that there's
223 * no way to explicitly communicate MTU restrictions to the peer.
224 *
225 * The following reduction of max_len makes sure that we never
226 * write datagrams larger than MFL + Record Expansion Overhead.
227 */
228 if( max_len <= ssl->out_left )
229 return( 0 );
230
231 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100232#endif
233
234 ret = ssl_get_remaining_space_in_datagram( ssl );
235 if( ret < 0 )
236 return( ret );
237 remaining = (size_t) ret;
238
239 ret = mbedtls_ssl_get_record_expansion( ssl );
240 if( ret < 0 )
241 return( ret );
242 expansion = (size_t) ret;
243
244 if( remaining <= expansion )
245 return( 0 );
246
247 remaining -= expansion;
248 if( remaining >= max_len )
249 remaining = max_len;
250
251 return( (int) remaining );
252}
253
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254/*
255 * Double the retransmit timeout value, within the allowed range,
256 * returning -1 if the maximum value has already been reached.
257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200259{
260 uint32_t new_timeout;
261
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200262 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200263 return( -1 );
264
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200265 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
266 * in the following way: after the initial transmission and a first
267 * retransmission, back off to a temporary estimated MTU of 508 bytes.
268 * This value is guaranteed to be deliverable (if not guaranteed to be
269 * delivered) of any compliant IPv4 (and IPv6) network, and should work
270 * on most non-IP stacks too. */
271 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400272 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200273 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
275 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200276
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200277 new_timeout = 2 * ssl->handshake->retransmit_timeout;
278
279 /* Avoid arithmetic overflow and range overflow */
280 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200281 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200282 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200283 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200284 }
285
286 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289
290 return( 0 );
291}
292
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200294{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200295 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000296 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
297 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200298}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
302int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200303 const unsigned char *key_enc, const unsigned char *key_dec,
304 size_t keylen,
305 const unsigned char *iv_enc, const unsigned char *iv_dec,
306 size_t ivlen,
307 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200308 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
310int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
313int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
314#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000315
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100316/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000317 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200318 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000319
Hanno Beckerccc13d02020-05-04 12:30:04 +0100320#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
321 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100322
323static size_t ssl_compute_padding_length( size_t len,
324 size_t granularity )
325{
326 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
327}
328
Hanno Becker581bc1b2020-05-04 12:20:03 +0100329/* This functions transforms a (D)TLS plaintext fragment and a record content
330 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
331 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
332 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100333 *
334 * struct {
335 * opaque content[DTLSPlaintext.length];
336 * ContentType real_type;
337 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100338 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339 *
340 * Input:
341 * - `content`: The beginning of the buffer holding the
342 * plaintext to be wrapped.
343 * - `*content_size`: The length of the plaintext in Bytes.
344 * - `max_len`: The number of Bytes available starting from
345 * `content`. This must be `>= *content_size`.
346 * - `rec_type`: The desired record content type.
347 *
348 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100349 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
350 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100351 *
352 * Returns:
353 * - `0` on success.
354 * - A negative error code if `max_len` didn't offer enough space
355 * for the expansion.
356 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357static int ssl_build_inner_plaintext( unsigned char *content,
358 size_t *content_size,
359 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100360 uint8_t rec_type,
361 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100362{
363 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100364
365 /* Write real content type */
366 if( remaining == 0 )
367 return( -1 );
368 content[ len ] = rec_type;
369 len++;
370 remaining--;
371
372 if( remaining < pad )
373 return( -1 );
374 memset( content + len, 0, pad );
375 len += pad;
376 remaining -= pad;
377
378 *content_size = len;
379 return( 0 );
380}
381
Hanno Becker581bc1b2020-05-04 12:20:03 +0100382/* This function parses a (D)TLSInnerPlaintext structure.
383 * See ssl_build_inner_plaintext() for details. */
384static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100385 size_t *content_size,
386 uint8_t *rec_type )
387{
388 size_t remaining = *content_size;
389
390 /* Determine length of padding by skipping zeroes from the back. */
391 do
392 {
393 if( remaining == 0 )
394 return( -1 );
395 remaining--;
396 } while( content[ remaining ] == 0 );
397
398 *content_size = remaining;
399 *rec_type = content[ remaining ];
400
401 return( 0 );
402}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100403#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
404 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100405
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100406/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100407 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000408static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100409 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100410 mbedtls_record *rec,
411 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000412{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100413 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100414 *
415 * additional_data = seq_num + TLSCompressed.type +
416 * TLSCompressed.version + TLSCompressed.length;
417 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100418 * For the CID extension, this is extended as follows
419 * (quoting draft-ietf-tls-dtls-connection-id-05,
420 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100421 *
422 * additional_data = seq_num + DTLSPlaintext.type +
423 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100424 * cid +
425 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100426 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100427 *
428 * For TLS 1.3, the record sequence number is dropped from the AAD
429 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100430 */
431
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100432 unsigned char *cur = add_data;
433
434#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
435 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
436#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
437 {
438 ((void) minor_ver);
439 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
440 cur += sizeof( rec->ctr );
441 }
442
443 *cur = rec->type;
444 cur++;
445
446 memcpy( cur, rec->ver, sizeof( rec->ver ) );
447 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100448
Hanno Beckera0e20d02019-05-15 14:03:01 +0100449#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100450 if( rec->cid_len != 0 )
451 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100452 memcpy( cur, rec->cid, rec->cid_len );
453 cur += rec->cid_len;
454
455 *cur = rec->cid_len;
456 cur++;
457
Joe Subbianic54e9082021-07-19 11:56:54 +0100458 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100459 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 {
Joe Subbianic54e9082021-07-19 11:56:54 +0100464 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100465 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100466 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100467
468 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000469}
470
Hanno Becker9d062f92020-02-07 10:26:36 +0000471#if defined(MBEDTLS_SSL_PROTO_SSL3)
472
473#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
474
475/*
476 * SSLv3.0 MAC functions
477 */
478static void ssl_mac( mbedtls_md_context_t *md_ctx,
479 const unsigned char *secret,
480 const unsigned char *buf, size_t len,
481 const unsigned char *ctr, int type,
482 unsigned char out[SSL3_MAC_MAX_BYTES] )
483{
484 unsigned char header[11];
485 unsigned char padding[48];
486 int padlen;
487 int md_size = mbedtls_md_get_size( md_ctx->md_info );
488 int md_type = mbedtls_md_get_type( md_ctx->md_info );
489
490 /* Only MD5 and SHA-1 supported */
491 if( md_type == MBEDTLS_MD_MD5 )
492 padlen = 48;
493 else
494 padlen = 40;
495
496 memcpy( header, ctr, 8 );
Joe Subbiania651e6f2021-08-23 11:35:25 +0100497 header[8] = (unsigned char) type;
Joe Subbiani11b71312021-08-23 12:49:14 +0100498 MBEDTLS_PUT_UINT16_BE( len, header, 9);
Hanno Becker9d062f92020-02-07 10:26:36 +0000499
500 memset( padding, 0x36, padlen );
501 mbedtls_md_starts( md_ctx );
502 mbedtls_md_update( md_ctx, secret, md_size );
503 mbedtls_md_update( md_ctx, padding, padlen );
504 mbedtls_md_update( md_ctx, header, 11 );
505 mbedtls_md_update( md_ctx, buf, len );
506 mbedtls_md_finish( md_ctx, out );
507
508 memset( padding, 0x5C, padlen );
509 mbedtls_md_starts( md_ctx );
510 mbedtls_md_update( md_ctx, secret, md_size );
511 mbedtls_md_update( md_ctx, padding, padlen );
512 mbedtls_md_update( md_ctx, out, md_size );
513 mbedtls_md_finish( md_ctx, out );
514}
515#endif /* MBEDTLS_SSL_PROTO_SSL3 */
516
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#if defined(MBEDTLS_GCM_C) || \
518 defined(MBEDTLS_CCM_C) || \
519 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100520static int ssl_transform_aead_dynamic_iv_is_explicit(
521 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100522{
Hanno Becker17263802020-05-28 07:05:48 +0100523 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100524}
525
Hanno Becker17263802020-05-28 07:05:48 +0100526/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
527 *
528 * Concretely, this occurs in two variants:
529 *
530 * a) Fixed and dynamic IV lengths add up to total IV length, giving
531 * IV = fixed_iv || dynamic_iv
532 *
Hanno Becker15952812020-06-04 13:31:46 +0100533 * This variant is used in TLS 1.2 when used with GCM or CCM.
534 *
Hanno Becker17263802020-05-28 07:05:48 +0100535 * b) Fixed IV lengths matches total IV length, giving
536 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100537 *
538 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
539 *
540 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100541 *
542 * This function has the precondition that
543 *
544 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
545 *
546 * which has to be ensured by the caller. If this precondition
547 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100548 */
549static void ssl_build_record_nonce( unsigned char *dst_iv,
550 size_t dst_iv_len,
551 unsigned char const *fixed_iv,
552 size_t fixed_iv_len,
553 unsigned char const *dynamic_iv,
554 size_t dynamic_iv_len )
555{
556 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100557
558 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100559 memset( dst_iv, 0, dst_iv_len );
560 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100561
Hanno Becker17263802020-05-28 07:05:48 +0100562 dst_iv += dst_iv_len - dynamic_iv_len;
563 for( i = 0; i < dynamic_iv_len; i++ )
564 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100565}
Hanno Becker67a37db2020-05-28 16:27:07 +0100566#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100567
Hanno Beckera18d1322018-01-03 14:27:32 +0000568int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
569 mbedtls_ssl_transform *transform,
570 mbedtls_record *rec,
571 int (*f_rng)(void *, unsigned char *, size_t),
572 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000573{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100575 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000576 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100577 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100578 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000579 size_t post_avail;
580
581 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000582#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200583 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000584 ((void) ssl);
585#endif
586
587 /* The PRNG is used for dynamic IV generation that's used
588 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200589#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000590 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
591 ((void) f_rng);
592 ((void) p_rng);
593#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000597 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100598 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
600 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
601 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100602 if( rec == NULL
603 || rec->buf == NULL
604 || rec->buf_len < rec->data_offset
605 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100606#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100607 || rec->cid_len != 0
608#endif
609 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000610 {
611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100613 }
614
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000615 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000618 data, rec->data_len );
619
620 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
621
622 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
623 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
625 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000626 rec->data_len,
627 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000628 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
629 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100630
Hanno Becker92313402020-05-20 13:58:58 +0100631 /* The following two code paths implement the (D)TLSInnerPlaintext
632 * structure present in TLS 1.3 and DTLS 1.2 + CID.
633 *
634 * See ssl_build_inner_plaintext() for more information.
635 *
636 * Note that this changes `rec->data_len`, and hence
637 * `post_avail` needs to be recalculated afterwards.
638 *
639 * Note also that the two code paths cannot occur simultaneously
640 * since they apply to different versions of the protocol. There
641 * is hence no risk of double-addition of the inner plaintext.
642 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100643#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
644 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
645 {
Hanno Becker13996922020-05-28 16:15:19 +0100646 size_t padding =
647 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100648 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100649 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100650 &rec->data_len,
651 post_avail,
652 rec->type,
653 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100654 {
655 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
656 }
657
658 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
659 }
660#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
661
Hanno Beckera0e20d02019-05-15 14:03:01 +0100662#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100663 /*
664 * Add CID information
665 */
666 rec->cid_len = transform->out_cid_len;
667 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
668 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100669
670 if( rec->cid_len != 0 )
671 {
Hanno Becker13996922020-05-28 16:15:19 +0100672 size_t padding =
673 ssl_compute_padding_length( rec->data_len,
674 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100675 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100676 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100677 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100678 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100679 * Note that this changes `rec->data_len`, and hence
680 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100681 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100682 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100683 &rec->data_len,
684 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100685 rec->type,
686 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100687 {
688 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
689 }
690
691 rec->type = MBEDTLS_SSL_MSG_CID;
692 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100694
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100695 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
696
Paul Bakker5121ce52009-01-03 21:22:43 +0000697 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100698 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000699 */
Hanno Becker52344c22018-01-03 15:24:20 +0000700#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 if( mode == MBEDTLS_MODE_STREAM ||
702 ( mode == MBEDTLS_MODE_CBC
703#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000704 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100705#endif
706 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000707 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000708 if( post_avail < transform->maclen )
709 {
710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
711 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
712 }
713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000715 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200716 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000717 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000718 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
719 data, rec->data_len, rec->ctr, rec->type, mac );
720 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200721 }
722 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200723#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
725 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200727 {
Hanno Becker992b6872017-11-09 18:57:39 +0000728 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
729
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100730 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
731 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000732
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000733 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100734 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000735 mbedtls_md_hmac_update( &transform->md_ctx_enc,
736 data, rec->data_len );
737 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
738 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
739
740 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200741 }
742 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200743#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200744 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
746 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200747 }
748
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
750 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200751
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000752 rec->data_len += transform->maclen;
753 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100754 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200755 }
Hanno Becker52344c22018-01-03 15:24:20 +0000756#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000757
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200758 /*
759 * Encrypt
760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
762 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000763 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000764 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000766 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000767 "including %d bytes of padding",
768 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000769
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000770 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
771 transform->iv_enc, transform->ivlen,
772 data, rec->data_len,
773 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200776 return( ret );
777 }
778
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
782 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200783 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000784 }
Paul Bakker68884e32013-01-07 18:20:04 +0100785 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000787
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200788#if defined(MBEDTLS_GCM_C) || \
789 defined(MBEDTLS_CCM_C) || \
790 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200792 mode == MBEDTLS_MODE_CCM ||
793 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000794 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200796 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100797 unsigned char *dynamic_iv;
798 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100799 int dynamic_iv_is_explicit =
800 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000801
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100802 /* Check that there's space for the authentication tag. */
803 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 {
805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
806 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
807 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000808
Paul Bakker68884e32013-01-07 18:20:04 +0100809 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100810 * Build nonce for AEAD encryption.
811 *
812 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
813 * part of the IV is prepended to the ciphertext and
814 * can be chosen freely - in particular, it need not
815 * agree with the record sequence number.
816 * However, since ChaChaPoly as well as all AEAD modes
817 * in TLS 1.3 use the record sequence number as the
818 * dynamic part of the nonce, we uniformly use the
819 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100820 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100821 dynamic_iv = rec->ctr;
822 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200823
Hanno Becker17263802020-05-28 07:05:48 +0100824 ssl_build_record_nonce( iv, sizeof( iv ),
825 transform->iv_enc,
826 transform->fixed_ivlen,
827 dynamic_iv,
828 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100829
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100830 /*
831 * Build additional data for AEAD encryption.
832 * This depends on the TLS version.
833 */
834 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
835 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100836
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200837 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100838 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200839 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100840 dynamic_iv,
841 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000842 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100843 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000844 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200845 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000847
Paul Bakker68884e32013-01-07 18:20:04 +0100848 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200849 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200850 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000851
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100852 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100854 add_data, add_data_len,
855 data, rec->data_len, /* src */
856 data, rec->buf_len - (data - rec->buf), /* dst */
857 &rec->data_len,
858 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200861 return( ret );
862 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100864 data + rec->data_len - transform->taglen,
865 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100866 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100868
869 /*
870 * Prefix record content with dynamic IV in case it is explicit.
871 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100872 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100873 {
874 if( rec->data_offset < dynamic_iv_len )
875 {
876 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
877 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
878 }
879
880 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
881 rec->data_offset -= dynamic_iv_len;
882 rec->data_len += dynamic_iv_len;
883 }
884
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100885 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000886 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000887 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100888#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200889#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000891 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 size_t padlen, i;
894 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000895
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896 /* Currently we're always using minimal padding
897 * (up to 255 bytes would be allowed). */
898 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
899 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000900 padlen = 0;
901
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 /* Check there's enough space in the buffer for the padding. */
903 if( post_avail < padlen + 1 )
904 {
905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
906 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
907 }
908
Paul Bakker5121ce52009-01-03 21:22:43 +0000909 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000910 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000911
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 rec->data_len += padlen + 1;
913 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000916 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000917 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
918 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000919 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000920 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000921 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 if( f_rng == NULL )
923 {
924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
925 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
926 }
927
928 if( rec->data_offset < transform->ivlen )
929 {
930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
931 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
932 }
933
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000934 /*
935 * Generate IV
936 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000938 if( ret != 0 )
939 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000940
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000941 memcpy( data - transform->ivlen, transform->iv_enc,
942 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000943
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000946
Paul Elliottd48d5c62021-01-07 14:47:05 +0000947 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
948 "including %" MBEDTLS_PRINTF_SIZET
949 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " 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é-Gonnard2ddec432020-08-24 12:49:23 +02001049 * Constant-flow mask generation for "greater or equal" comparison:
1050 * - if x >= y, return all bits 1, that is (size_t) -1
1051 * - otherwise, return all bits 0, that is 0
1052 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001053 * 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é-Gonnard2ddec432020-08-24 12:49:23 +02001058 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001059static size_t mbedtls_cf_size_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001060{
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001061 return( ~mbedtls_cf_size_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001062}
1063
1064/*
1065 * Constant-flow boolean "equal" comparison:
1066 * return x == y
1067 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001068 * This function can be used to write constant-time code by replacing branches
1069 * with bit operations - it can be used in conjunction with
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001070 * mbedtls_cf_size_mask().
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001071 *
1072 * This function is implemented without using comparison operators, as those
1073 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001074 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001075static size_t mbedtls_cf_size_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001076{
1077 /* diff = 0 if x == y, non-zero otherwise */
1078 const size_t diff = x ^ y;
1079
1080 /* MSVC has a warning about unary minus on unsigned integer types,
1081 * but this is well-defined and precisely what we want to do here. */
1082#if defined(_MSC_VER)
1083#pragma warning( push )
1084#pragma warning( disable : 4146 )
1085#endif
1086
1087 /* diff_msb's most significant bit is equal to x != y */
1088 const size_t diff_msb = ( diff | -diff );
1089
1090#if defined(_MSC_VER)
1091#pragma warning( pop )
1092#endif
1093
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001094 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001095 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1096
1097 return( 1 ^ diff1 );
1098}
1099
1100/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001101 * Constant-flow conditional memcpy:
1102 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1103 * - otherwise, a no-op,
1104 * but with execution flow independent of the values of c1 and c2.
1105 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001106 * 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é-Gonnard7a8b1e62020-07-15 11:52:14 +02001108 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001109static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
1110 const unsigned char *src,
1111 size_t len,
1112 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001113{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001114 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001115 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
1116 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001118 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001119 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001120 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001121}
1122
1123/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001124 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001125 *
1126 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1127 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001128 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001129MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001130 mbedtls_md_context_t *ctx,
1131 const unsigned char *add_data, size_t add_data_len,
1132 const unsigned char *data, size_t data_len_secret,
1133 size_t min_data_len, size_t max_data_len,
1134 unsigned char *output )
1135{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001136 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001137 * This function breaks the HMAC abstraction and uses the md_clone()
1138 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001139 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001140 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001141 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001142 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001143 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001144 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1145 * minlen, then cloning the context, and for each byte up to maxlen
1146 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001147 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001148 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001149 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001150 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001151 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1152 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001153 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001154 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001155 const unsigned char * const okey = ikey + block_size;
1156 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001157
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001158 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1159 mbedtls_md_context_t aux;
1160 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001162
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001163 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001164
1165#define MD_CHK( func_call ) \
1166 do { \
1167 ret = (func_call); \
1168 if( ret != 0 ) \
1169 goto cleanup; \
1170 } while( 0 )
1171
1172 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001173
1174 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1175 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001176 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1177 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001178
1179 /* For each possible length, compute the hash up to that point */
1180 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001181 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001182 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1183 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001184 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001185 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1186 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001187
1188 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001189 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001190 }
1191
Manuel Pégourié-Gonnard21bfbdd2021-05-17 12:28:08 +02001192 /* The context needs to finish() before it starts() again */
1193 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1194
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001195 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001196 MD_CHK( mbedtls_md_starts( ctx ) );
1197 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1198 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1199 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001200
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001201 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001202 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001203
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001204#undef MD_CHK
1205
1206cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001207 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001208 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001209}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001210
1211/*
1212 * Constant-flow memcpy from variable position in buffer.
1213 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001214 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001215 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001216MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001217 unsigned char *dst,
1218 const unsigned char *src_base,
1219 size_t offset_secret,
1220 size_t offset_min, size_t offset_max,
1221 size_t len )
1222{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001223 size_t offset;
1224
1225 for( offset = offset_min; offset <= offset_max; offset++ )
1226 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001227 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1228 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001229 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001230}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001231#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001232
Hanno Becker605949f2019-07-12 08:23:59 +01001233int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001234 mbedtls_ssl_transform *transform,
1235 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001236{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001237 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001238 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001239 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001240#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001241 size_t padlen = 0, correct = 1;
1242#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001243 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001244 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001245 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001246
Hanno Beckera18d1322018-01-03 14:27:32 +00001247#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001248 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001249 ((void) ssl);
1250#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001253 if( rec == NULL ||
1254 rec->buf == NULL ||
1255 rec->buf_len < rec->data_offset ||
1256 rec->buf_len - rec->data_offset < rec->data_len )
1257 {
1258 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001260 }
1261
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001262 data = rec->buf + rec->data_offset;
1263 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001264
Hanno Beckera0e20d02019-05-15 14:03:01 +01001265#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001266 /*
1267 * Match record's CID with incoming CID.
1268 */
Hanno Becker938489a2019-05-08 13:02:22 +01001269 if( rec->cid_len != transform->in_cid_len ||
1270 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1271 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001272 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001273 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001274#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1277 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001278 {
1279 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001280 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1281 transform->iv_dec,
1282 transform->ivlen,
1283 data, rec->data_len,
1284 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001285 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001287 return( ret );
1288 }
1289
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001290 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001291 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1293 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001294 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001295 }
Paul Bakker68884e32013-01-07 18:20:04 +01001296 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001298#if defined(MBEDTLS_GCM_C) || \
1299 defined(MBEDTLS_CCM_C) || \
1300 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001302 mode == MBEDTLS_MODE_CCM ||
1303 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001304 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001305 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001306 unsigned char *dynamic_iv;
1307 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001308
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001309 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001310 * Extract dynamic part of nonce for AEAD decryption.
1311 *
1312 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1313 * part of the IV is prepended to the ciphertext and
1314 * can be chosen freely - in particular, it need not
1315 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001316 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001317 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001318 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001319 {
1320 if( rec->data_len < dynamic_iv_len )
1321 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001322 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1323 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001324 rec->data_len,
1325 dynamic_iv_len ) );
1326 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1327 }
1328 dynamic_iv = data;
1329
1330 data += dynamic_iv_len;
1331 rec->data_offset += dynamic_iv_len;
1332 rec->data_len -= dynamic_iv_len;
1333 }
Hanno Becker17263802020-05-28 07:05:48 +01001334 else
1335 {
1336 dynamic_iv = rec->ctr;
1337 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001338
1339 /* Check that there's space for the authentication tag. */
1340 if( rec->data_len < transform->taglen )
1341 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1343 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001344 rec->data_len,
1345 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001347 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001348 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001349
Hanno Beckerdf8be222020-05-21 15:30:57 +01001350 /*
1351 * Prepare nonce from dynamic and static parts.
1352 */
Hanno Becker17263802020-05-28 07:05:48 +01001353 ssl_build_record_nonce( iv, sizeof( iv ),
1354 transform->iv_dec,
1355 transform->fixed_ivlen,
1356 dynamic_iv,
1357 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001358
Hanno Beckerdf8be222020-05-21 15:30:57 +01001359 /*
1360 * Build additional data for AEAD encryption.
1361 * This depends on the TLS version.
1362 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001363 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1364 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001365 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001366 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001367
Hanno Beckerd96a6522019-07-10 13:55:25 +01001368 /* Because of the check above, we know that there are
1369 * explicit_iv_len Bytes preceeding data, and taglen
1370 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001371 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001372 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001373
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001374 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001375 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001376 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001377
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001378 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001379 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001380 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001381 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001382 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001383 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001384 data, rec->data_len + transform->taglen, /* src */
1385 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001386 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001387 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1391 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001392
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001393 return( ret );
1394 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001395 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001396
Hanno Beckerd96a6522019-07-10 13:55:25 +01001397 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001398 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001399 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001400 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1401 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001402 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001403 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001404 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001405#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001406#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001408 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001409 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001410
Paul Bakker5121ce52009-01-03 21:22:43 +00001411 /*
Paul Bakker45829992013-01-03 14:52:21 +01001412 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001413 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001415 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1416 {
1417 /* The ciphertext is prefixed with the CBC IV. */
1418 minlen += transform->ivlen;
1419 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001420#endif
Paul Bakker45829992013-01-03 14:52:21 +01001421
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001422 /* Size considerations:
1423 *
1424 * - The CBC cipher text must not be empty and hence
1425 * at least of size transform->ivlen.
1426 *
1427 * Together with the potential IV-prefix, this explains
1428 * the first of the two checks below.
1429 *
1430 * - The record must contain a MAC, either in plain or
1431 * encrypted, depending on whether Encrypt-then-MAC
1432 * is used or not.
1433 * - If it is, the message contains the IV-prefix,
1434 * the CBC ciphertext, and the MAC.
1435 * - If it is not, the padded plaintext, and hence
1436 * the CBC ciphertext, has at least length maclen + 1
1437 * because there is at least the padding length byte.
1438 *
1439 * As the CBC ciphertext is not empty, both cases give the
1440 * lower bound minlen + maclen + 1 on the record size, which
1441 * we test for in the second check below.
1442 */
1443 if( rec->data_len < minlen + transform->ivlen ||
1444 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001445 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001446 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1447 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1448 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001449 "+ 1 ) ( + expl IV )", rec->data_len,
1450 transform->ivlen,
1451 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001453 }
1454
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001455 /*
1456 * Authenticate before decrypt if enabled
1457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001459 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001460 {
Hanno Becker992b6872017-11-09 18:57:39 +00001461 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001464
Hanno Beckerd96a6522019-07-10 13:55:25 +01001465 /* Update data_len in tandem with add_data.
1466 *
1467 * The subtraction is safe because of the previous check
1468 * data_len >= minlen + maclen + 1.
1469 *
1470 * Afterwards, we know that data + data_len is followed by at
1471 * least maclen Bytes, which justifies the call to
1472 * mbedtls_ssl_safer_memcmp() below.
1473 *
1474 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001475 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001476 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1477 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001478
Hanno Beckerd96a6522019-07-10 13:55:25 +01001479 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001480 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1481 add_data_len );
1482 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1483 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1485 data, rec->data_len );
1486 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1487 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001488
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001489 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1490 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001491 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001492 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001493
Hanno Beckerd96a6522019-07-10 13:55:25 +01001494 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001495 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1496 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001500 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001501 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001502 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001504
1505 /*
1506 * Check length sanity
1507 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001508
1509 /* We know from above that data_len > minlen >= 0,
1510 * so the following check in particular implies that
1511 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001512 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001513 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001514 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1515 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001516 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001518 }
1519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001521 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001522 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001523 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001524 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001525 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001526 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001528
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001529 data += transform->ivlen;
1530 rec->data_offset += transform->ivlen;
1531 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001532 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001534
Hanno Beckerd96a6522019-07-10 13:55:25 +01001535 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1536
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1538 transform->iv_dec, transform->ivlen,
1539 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001540 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001542 return( ret );
1543 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001544
Hanno Beckerd96a6522019-07-10 13:55:25 +01001545 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001546 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001547 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001548 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1549 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001550 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001553 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001554 {
1555 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001556 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1557 * records is equivalent to CBC decryption of the concatenation
1558 * of the records; in other words, IVs are maintained across
1559 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001560 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001561 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1562 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001563 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001564#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001565
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001566 /* Safe since data_len >= minlen + maclen + 1, so after having
1567 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001568 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1569 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001570 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001571
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001572 if( auth_done == 1 )
1573 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001574 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001575 rec->data_len,
1576 padlen + 1 );
1577 correct &= mask;
1578 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001579 }
1580 else
Paul Bakker45829992013-01-03 14:52:21 +01001581 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001583 if( rec->data_len < transform->maclen + padlen + 1 )
1584 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1586 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1587 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001588 rec->data_len,
1589 transform->maclen,
1590 padlen + 1 ) );
1591 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001592#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001593
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001594 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001595 rec->data_len,
1596 transform->maclen + padlen + 1 );
1597 correct &= mask;
1598 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001599 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001600
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001601 padlen++;
1602
1603 /* Regardless of the validity of the padding,
1604 * we have data_len >= padlen here. */
1605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001607 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001608 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001609 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1610 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001611 * the protocol (known as part of POODLE), so we don't care if the
1612 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001613 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001614 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliottd48d5c62021-01-07 14:47:05 +00001616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %" MBEDTLS_PRINTF_SIZET ", "
1617 "should be no more than %" MBEDTLS_PRINTF_SIZET,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001618 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001619#endif
Paul Bakker45829992013-01-03 14:52:21 +01001620 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001621 }
1622 }
1623 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1625#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1626 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001627 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001628 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001629 /* The padding check involves a series of up to 256
1630 * consecutive memory reads at the end of the record
1631 * plaintext buffer. In order to hide the length and
1632 * validity of the padding, always perform exactly
1633 * `min(256,plaintext_len)` reads (but take into account
1634 * only the last `padlen` bytes for the padding check). */
1635 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001636 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001637
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001638 /* Index of first padding byte; it has been ensured above
1639 * that the subtraction is safe. */
1640 size_t const padding_idx = rec->data_len - padlen;
1641 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1642 size_t const start_idx = rec->data_len - num_checks;
1643 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001644
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001645 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001646 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001647 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001648 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001649 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001650 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1651 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1652 padlen - 1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001653 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001654 }
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001655 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001658 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001660#endif
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001661 padlen &= mbedtls_cf_size_mask( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001662 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001663 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1665 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001666 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001667 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1668 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001669 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001670
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001671 /* If the padding was found to be invalid, padlen == 0
1672 * and the subtraction is safe. If the padding was found valid,
1673 * padlen hasn't been changed and the previous assertion
1674 * data_len >= padlen still holds. */
1675 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001676 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001677 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001678#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001679 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001680 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1681 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001682 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001683
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001684#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001685 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001686 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001687#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001688
1689 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001690 * Authenticate if not done yet.
1691 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001692 */
Hanno Becker52344c22018-01-03 15:24:20 +00001693#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001694 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001695 {
Hanno Becker992b6872017-11-09 18:57:39 +00001696 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001697 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001698
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001699 /* If the initial value of padlen was such that
1700 * data_len < maclen + padlen + 1, then padlen
1701 * got reset to 1, and the initial check
1702 * data_len >= minlen + maclen + 1
1703 * guarantees that at this point we still
1704 * have at least data_len >= maclen.
1705 *
1706 * If the initial value of padlen was such that
1707 * data_len >= maclen + padlen + 1, then we have
1708 * subtracted either padlen + 1 (if the padding was correct)
1709 * or 0 (if the padding was incorrect) since then,
1710 * hence data_len >= maclen in any case.
1711 */
1712 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001713 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1714 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001717 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001718 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001719 ssl_mac( &transform->md_ctx_dec,
1720 transform->mac_dec,
1721 data, rec->data_len,
1722 rec->ctr, rec->type,
1723 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001724 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001725 }
1726 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1728#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1729 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001730 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001731 {
1732 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001733 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001734 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001735 *
1736 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001737 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001738 *
1739 * Note that max_len + maclen is never more than the buffer
1740 * length, as we previously did in_msglen -= maclen too.
1741 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001742 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001743 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1744
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001745 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1746 add_data, add_data_len,
1747 data, rec->data_len, min_len, max_len,
1748 mac_expect );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001749 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001750 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001751 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1752 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001753 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001754
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001755 mbedtls_cf_memcpy_offset( mac_peer, data,
1756 rec->data_len,
1757 min_len, max_len,
1758 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001759 }
1760 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1762 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1765 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001766 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001767
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001768#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001769 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001770 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001771#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001772
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001773 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001774 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001775 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001776#if defined(MBEDTLS_SSL_DEBUG_ALL)
1777 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001778#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001779 correct = 0;
1780 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001781 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001782 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001783
1784 /*
1785 * Finally check the correct flag
1786 */
1787 if( correct == 0 )
1788 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001789#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001790
1791 /* Make extra sure authentication was performed, exactly once */
1792 if( auth_done != 1 )
1793 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1795 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001796 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001797
Hanno Beckerccc13d02020-05-04 12:30:04 +01001798#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1799 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1800 {
1801 /* Remove inner padding and infer true content type. */
1802 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1803 &rec->type );
1804
1805 if( ret != 0 )
1806 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1807 }
1808#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1809
Hanno Beckera0e20d02019-05-15 14:03:01 +01001810#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001811 if( rec->cid_len != 0 )
1812 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001813 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1814 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001815 if( ret != 0 )
1816 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1817 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001818#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001821
1822 return( 0 );
1823}
1824
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001825#undef MAC_NONE
1826#undef MAC_PLAINTEXT
1827#undef MAC_CIPHERTEXT
1828
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001829#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001830/*
1831 * Compression/decompression functions
1832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001834{
Janos Follath865b3eb2019-12-16 11:46:15 +00001835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001836 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001837 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001838 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001839 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001840#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1841 size_t out_buf_len = ssl->out_buf_len;
1842#else
1843 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1844#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001845
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001847
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001848 if( len_pre == 0 )
1849 return( 0 );
1850
Paul Bakker2770fbd2012-07-03 13:30:23 +00001851 memcpy( msg_pre, ssl->out_msg, len_pre );
1852
Paul Elliottd48d5c62021-01-07 14:47:05 +00001853 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001854 ssl->out_msglen ) );
1855
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001857 ssl->out_msg, ssl->out_msglen );
1858
Paul Bakker48916f92012-09-16 19:57:18 +00001859 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1860 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1861 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001862 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001863
Paul Bakker48916f92012-09-16 19:57:18 +00001864 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001865 if( ret != Z_OK )
1866 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1868 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001869 }
1870
Darryl Greenb33cc762019-11-28 14:29:44 +00001871 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001872 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001873
Paul Elliottd48d5c62021-01-07 14:47:05 +00001874 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001875 ssl->out_msglen ) );
1876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001878 ssl->out_msg, ssl->out_msglen );
1879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001881
1882 return( 0 );
1883}
1884
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001886{
Janos Follath865b3eb2019-12-16 11:46:15 +00001887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001888 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001889 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001890 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001891 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001892#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1893 size_t in_buf_len = ssl->in_buf_len;
1894#else
1895 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1896#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001897
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001899
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001900 if( len_pre == 0 )
1901 return( 0 );
1902
Paul Bakker2770fbd2012-07-03 13:30:23 +00001903 memcpy( msg_pre, ssl->in_msg, len_pre );
1904
Paul Elliottd48d5c62021-01-07 14:47:05 +00001905 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001906 ssl->in_msglen ) );
1907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001909 ssl->in_msg, ssl->in_msglen );
1910
Paul Bakker48916f92012-09-16 19:57:18 +00001911 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1912 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1913 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001914 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001915
Paul Bakker48916f92012-09-16 19:57:18 +00001916 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001917 if( ret != Z_OK )
1918 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1920 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001921 }
1922
Darryl Greenb33cc762019-11-28 14:29:44 +00001923 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001924 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001925
Paul Elliottd48d5c62021-01-07 14:47:05 +00001926 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001927 ssl->in_msglen ) );
1928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001930 ssl->in_msg, ssl->in_msglen );
1931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001933
1934 return( 0 );
1935}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001936#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001937
Paul Bakker5121ce52009-01-03 21:22:43 +00001938/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001939 * Fill the input message buffer by appending data to it.
1940 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001941 *
1942 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1943 * available (from this read and/or a previous one). Otherwise, an error code
1944 * is returned (possibly EOF or WANT_READ).
1945 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001946 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1947 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1948 * since we always read a whole datagram at once.
1949 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001950 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001951 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001954{
Janos Follath865b3eb2019-12-16 11:46:15 +00001955 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001956 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001957#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1958 size_t in_buf_len = ssl->in_buf_len;
1959#else
1960 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1961#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001964
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001965 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001968 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001970 }
1971
Darryl Greenb33cc762019-11-28 14:29:44 +00001972 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001973 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1975 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001976 }
1977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001979 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001980 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001981 uint32_t timeout;
1982
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001983 /*
1984 * The point is, we need to always read a full datagram at once, so we
1985 * sometimes read more then requested, and handle the additional data.
1986 * It could be the rest of the current record (while fetching the
1987 * header) and/or some other records in the same datagram.
1988 */
1989
1990 /*
1991 * Move to the next record in the already read datagram if applicable
1992 */
1993 if( ssl->next_record_offset != 0 )
1994 {
1995 if( ssl->in_left < ssl->next_record_offset )
1996 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1998 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001999 }
2000
2001 ssl->in_left -= ssl->next_record_offset;
2002
2003 if( ssl->in_left != 0 )
2004 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002005 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
2006 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002007 ssl->next_record_offset ) );
2008 memmove( ssl->in_hdr,
2009 ssl->in_hdr + ssl->next_record_offset,
2010 ssl->in_left );
2011 }
2012
2013 ssl->next_record_offset = 0;
2014 }
2015
Paul Elliottd48d5c62021-01-07 14:47:05 +00002016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2017 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00002018 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002019
2020 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002021 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002022 */
2023 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002024 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002026 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002027 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002028
2029 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002030 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002031 * are not at the beginning of a new record, the caller did something
2032 * wrong.
2033 */
2034 if( ssl->in_left != 0 )
2035 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2037 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002038 }
2039
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002040 /*
2041 * Don't even try to read if time's out already.
2042 * This avoids by-passing the timer when repeatedly receiving messages
2043 * that will end up being dropped.
2044 */
Hanno Becker7876d122020-02-05 10:39:31 +00002045 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01002046 {
2047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002048 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01002049 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002050 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002051 {
Darryl Greenb33cc762019-11-28 14:29:44 +00002052 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002055 timeout = ssl->handshake->retransmit_timeout;
2056 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002057 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002058
Paul Elliott9f352112020-12-09 14:55:45 +00002059 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002060
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002061 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002062 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2063 timeout );
2064 else
2065 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2066
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002067 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002068
2069 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002071 }
2072
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002073 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002074 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002076 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002079 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002080 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2081 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002083 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002084 }
2085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002087 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002089 return( ret );
2090 }
2091
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002092 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002093 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002095 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002097 {
Hanno Becker786300f2020-02-05 10:46:40 +00002098 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002099 {
Hanno Becker786300f2020-02-05 10:46:40 +00002100 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2101 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002102 return( ret );
2103 }
2104
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002105 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002106 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002108 }
2109
Paul Bakker5121ce52009-01-03 21:22:43 +00002110 if( ret < 0 )
2111 return( ret );
2112
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002113 ssl->in_left = ret;
2114 }
2115 else
2116#endif
2117 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2119 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002120 ssl->in_left, nb_want ) );
2121
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002122 while( ssl->in_left < nb_want )
2123 {
2124 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002125
Hanno Becker7876d122020-02-05 10:39:31 +00002126 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002127 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2128 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002129 {
2130 if( ssl->f_recv_timeout != NULL )
2131 {
2132 ret = ssl->f_recv_timeout( ssl->p_bio,
2133 ssl->in_hdr + ssl->in_left, len,
2134 ssl->conf->read_timeout );
2135 }
2136 else
2137 {
2138 ret = ssl->f_recv( ssl->p_bio,
2139 ssl->in_hdr + ssl->in_left, len );
2140 }
2141 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002142
Paul Elliottd48d5c62021-01-07 14:47:05 +00002143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2144 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002145 ssl->in_left, nb_want ) );
2146 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002147
2148 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002150
2151 if( ret < 0 )
2152 return( ret );
2153
makise-homuraaf9513b2020-08-24 18:26:27 +03002154 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002155 {
Darryl Green11999bb2018-03-13 15:22:58 +00002156 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002157 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002158 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002159 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2160 }
2161
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002162 ssl->in_left += ret;
2163 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002164 }
2165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002167
2168 return( 0 );
2169}
2170
2171/*
2172 * Flush any data not yet written
2173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002175{
Janos Follath865b3eb2019-12-16 11:46:15 +00002176 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002177 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002180
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002181 if( ssl->f_send == NULL )
2182 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002184 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002186 }
2187
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002188 /* Avoid incrementing counter if data is flushed */
2189 if( ssl->out_left == 0 )
2190 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002192 return( 0 );
2193 }
2194
Paul Bakker5121ce52009-01-03 21:22:43 +00002195 while( ssl->out_left > 0 )
2196 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002197 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2198 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002199 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002200
Hanno Becker2b1e3542018-08-06 11:19:13 +01002201 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002202 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002205
2206 if( ret <= 0 )
2207 return( ret );
2208
makise-homuraaf9513b2020-08-24 18:26:27 +03002209 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002210 {
Darryl Green11999bb2018-03-13 15:22:58 +00002211 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002212 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002213 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002214 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2215 }
2216
Paul Bakker5121ce52009-01-03 21:22:43 +00002217 ssl->out_left -= ret;
2218 }
2219
Hanno Becker2b1e3542018-08-06 11:19:13 +01002220#if defined(MBEDTLS_SSL_PROTO_DTLS)
2221 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002222 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002223 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002224 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002225 else
2226#endif
2227 {
2228 ssl->out_hdr = ssl->out_buf + 8;
2229 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002230 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002233
2234 return( 0 );
2235}
2236
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002237/*
2238 * Functions to handle the DTLS retransmission state machine
2239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002240#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002241/*
2242 * Append current handshake message to current outgoing flight
2243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002245{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002246 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002247 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2248 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2249 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002250
2251 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002252 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002253 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002254 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002256 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002257 }
2258
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002259 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002260 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002261 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2262 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002263 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002264 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002265 }
2266
2267 /* Copy current handshake message with headers */
2268 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2269 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002270 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002271 msg->next = NULL;
2272
2273 /* Append to the current flight */
2274 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002275 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002276 else
2277 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002279 while( cur->next != NULL )
2280 cur = cur->next;
2281 cur->next = msg;
2282 }
2283
Hanno Becker3b235902018-08-06 09:54:53 +01002284 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002285 return( 0 );
2286}
2287
2288/*
2289 * Free the current flight of handshake messages
2290 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002291void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002292{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293 mbedtls_ssl_flight_item *cur = flight;
2294 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002295
2296 while( cur != NULL )
2297 {
2298 next = cur->next;
2299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300 mbedtls_free( cur->p );
2301 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002302
2303 cur = next;
2304 }
2305}
2306
2307/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002308 * Swap transform_out and out_ctr with the alternative ones
2309 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002310static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002311{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002313 unsigned char tmp_out_ctr[8];
2314
2315 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2316 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002318 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002319 }
2320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002322
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002323 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002324 tmp_transform = ssl->transform_out;
2325 ssl->transform_out = ssl->handshake->alt_transform_out;
2326 ssl->handshake->alt_transform_out = tmp_transform;
2327
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002328 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002329 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2330 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002331 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002332
2333 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002334 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2337 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002338 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002339 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2340 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002341 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2343 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002344 }
2345 }
2346#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002347
2348 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002349}
2350
2351/*
2352 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002353 */
2354int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2355{
2356 int ret = 0;
2357
2358 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2359
2360 ret = mbedtls_ssl_flight_transmit( ssl );
2361
2362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2363
2364 return( ret );
2365}
2366
2367/*
2368 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002369 *
2370 * Need to remember the current message in case flush_output returns
2371 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002372 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002373 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002374int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002375{
Janos Follath865b3eb2019-12-16 11:46:15 +00002376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002377 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002380 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002381 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002382
2383 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002384 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002385 ret = ssl_swap_epochs( ssl );
2386 if( ret != 0 )
2387 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002390 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002391
2392 while( ssl->handshake->cur_msg != NULL )
2393 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002394 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002395 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002396
Hanno Beckere1dcb032018-08-17 16:47:58 +01002397 int const is_finished =
2398 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2399 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2400
Hanno Becker04da1892018-08-14 13:22:10 +01002401 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2402 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2403
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002404 /* Swap epochs before sending Finished: we can't do it after
2405 * sending ChangeCipherSpec, in case write returns WANT_READ.
2406 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002407 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002408 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002409 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002410 ret = ssl_swap_epochs( ssl );
2411 if( ret != 0 )
2412 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002413 }
2414
Hanno Becker67bc7c32018-08-06 11:33:50 +01002415 ret = ssl_get_remaining_payload_in_datagram( ssl );
2416 if( ret < 0 )
2417 return( ret );
2418 max_frag_len = (size_t) ret;
2419
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002420 /* CCS is copied as is, while HS messages may need fragmentation */
2421 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2422 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002423 if( max_frag_len == 0 )
2424 {
2425 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2426 return( ret );
2427
2428 continue;
2429 }
2430
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002431 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002432 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002433 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002434
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002435 /* Update position inside current message */
2436 ssl->handshake->cur_msg_p += cur->len;
2437 }
2438 else
2439 {
2440 const unsigned char * const p = ssl->handshake->cur_msg_p;
2441 const size_t hs_len = cur->len - 12;
2442 const size_t frag_off = p - ( cur->p + 12 );
2443 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002444 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002445
Hanno Beckere1dcb032018-08-17 16:47:58 +01002446 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002447 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002448 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002449 {
2450 ret = ssl_swap_epochs( ssl );
2451 if( ret != 0 )
2452 return( ret );
2453 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002454
Hanno Becker67bc7c32018-08-06 11:33:50 +01002455 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2456 return( ret );
2457
2458 continue;
2459 }
2460 max_hs_frag_len = max_frag_len - 12;
2461
2462 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2463 max_hs_frag_len : rem_len;
2464
2465 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002466 {
2467 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002468 (unsigned) cur_hs_frag_len,
2469 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002470 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002471
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002472 /* Messages are stored with handshake headers as if not fragmented,
2473 * copy beginning of headers then fill fragmentation fields.
2474 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2475 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani61f7d732021-06-24 09:06:23 +01002476
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002477 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2478 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2479 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002480
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002481 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2482 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2483 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002484
2485 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2486
Hanno Becker3f7b9732018-08-28 09:53:25 +01002487 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002488 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2489 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002490 ssl->out_msgtype = cur->type;
2491
2492 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002493 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002494 }
2495
2496 /* If done with the current message move to the next one if any */
2497 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2498 {
2499 if( cur->next != NULL )
2500 {
2501 ssl->handshake->cur_msg = cur->next;
2502 ssl->handshake->cur_msg_p = cur->next->p + 12;
2503 }
2504 else
2505 {
2506 ssl->handshake->cur_msg = NULL;
2507 ssl->handshake->cur_msg_p = NULL;
2508 }
2509 }
2510
2511 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002512 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002513 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002515 return( ret );
2516 }
2517 }
2518
Hanno Becker67bc7c32018-08-06 11:33:50 +01002519 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2520 return( ret );
2521
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002522 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2524 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002525 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002526 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002528 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002529 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002530
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002531 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002532
2533 return( 0 );
2534}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002535
2536/*
2537 * To be called when the last message of an incoming flight is received.
2538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002540{
2541 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002542 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002543 ssl->handshake->flight = NULL;
2544 ssl->handshake->cur_msg = NULL;
2545
2546 /* The next incoming flight will start with this msg_seq */
2547 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2548
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002549 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002550 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002551
Hanno Becker0271f962018-08-16 13:23:47 +01002552 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002553 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002554
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002555 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002556 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002557
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2559 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002562 }
2563 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002565}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002566
2567/*
2568 * To be called when the last message of an outgoing flight is send.
2569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002571{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002572 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002573 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2576 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002577 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002579 }
2580 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002582}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002584
Paul Bakker5121ce52009-01-03 21:22:43 +00002585/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002586 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002587 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002588
2589/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002590 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002591 *
2592 * - fill in handshake headers
2593 * - update handshake checksum
2594 * - DTLS: save message for resending
2595 * - then pass to the record layer
2596 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002597 * DTLS: except for HelloRequest, messages are only queued, and will only be
2598 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002599 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002600 * Inputs:
2601 * - ssl->out_msglen: 4 + actual handshake message len
2602 * (4 is the size of handshake headers for TLS)
2603 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2604 * - ssl->out_msg + 4: the handshake message body
2605 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002606 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002607 * - ssl->out_msglen: the length of the record contents
2608 * (including handshake headers but excluding record headers)
2609 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002610 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002611int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002612{
Janos Follath865b3eb2019-12-16 11:46:15 +00002613 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002614 const size_t hs_len = ssl->out_msglen - 4;
2615 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002616
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2618
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002619 /*
2620 * Sanity checks
2621 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002622 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002623 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2624 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002625 /* In SSLv3, the client might send a NoCertificate alert. */
2626#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2627 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2628 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2629 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2630#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2631 {
2632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2633 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2634 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002635 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002636
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002637 /* Whenever we send anything different from a
2638 * HelloRequest we should be in a handshake - double check. */
2639 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2640 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002641 ssl->handshake == NULL )
2642 {
2643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2644 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2645 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002648 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002649 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002650 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002651 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002652 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2653 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002654 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002655#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002656
Hanno Beckerb50a2532018-08-06 11:52:54 +01002657 /* Double-check that we did not exceed the bounds
2658 * of the outgoing record buffer.
2659 * This should never fail as the various message
2660 * writing functions must obey the bounds of the
2661 * outgoing record buffer, but better be safe.
2662 *
2663 * Note: We deliberately do not check for the MTU or MFL here.
2664 */
2665 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2666 {
2667 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002668 "size %" MBEDTLS_PRINTF_SIZET
2669 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002670 ssl->out_msglen,
2671 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002672 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2673 }
2674
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002675 /*
2676 * Fill handshake headers
2677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002679 {
Joe Subbianiad1115a2021-07-16 14:27:50 +01002680 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2681 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2682 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002683
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002684 /*
2685 * DTLS has additional fields in the Handshake layer,
2686 * between the length field and the actual payload:
2687 * uint16 message_seq;
2688 * uint24 fragment_offset;
2689 * uint24 fragment_length;
2690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002692 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002693 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002694 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002695 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002696 {
2697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002698 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002699 hs_len,
2700 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002701 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2702 }
2703
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002704 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002705 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002706
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002707 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002708 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002709 {
Joe Subbianic54e9082021-07-19 11:56:54 +01002710 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002711 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002712 }
2713 else
2714 {
2715 ssl->out_msg[4] = 0;
2716 ssl->out_msg[5] = 0;
2717 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002718
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002719 /* Handshake hashes are computed without fragmentation,
2720 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002721 memset( ssl->out_msg + 6, 0x00, 3 );
2722 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002723 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002725
Hanno Becker0207e532018-08-28 10:28:28 +01002726 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002727 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2728 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002729 }
2730
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002731 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002733 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002734 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2735 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002736 {
2737 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2738 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002740 return( ret );
2741 }
2742 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002743 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002744#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002745 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002746 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002747 {
2748 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2749 return( ret );
2750 }
2751 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002752
2753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2754
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002755 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002756}
2757
2758/*
2759 * Record layer functions
2760 */
2761
2762/*
2763 * Write current record.
2764 *
2765 * Uses:
2766 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2767 * - ssl->out_msglen: length of the record content (excl headers)
2768 * - ssl->out_msg: record content
2769 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002770int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002771{
2772 int ret, done = 0;
2773 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002774 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002775
2776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002779 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002781 {
2782 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002785 return( ret );
2786 }
2787
2788 len = ssl->out_msglen;
2789 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002791
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2793 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002794 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 ret = mbedtls_ssl_hw_record_write( ssl );
2798 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002799 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002800 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2801 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002802 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002803
2804 if( ret == 0 )
2805 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002806 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002808 if( !done )
2809 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002810 unsigned i;
2811 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002812#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2813 size_t out_buf_len = ssl->out_buf_len;
2814#else
2815 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2816#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002817 /* Skip writing the record content type to after the encryption,
2818 * as it may change when using the CID extension. */
2819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002821 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002822
Hanno Becker19859472018-08-06 09:40:20 +01002823 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbianic54e9082021-07-19 11:56:54 +01002824 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002825
Paul Bakker48916f92012-09-16 19:57:18 +00002826 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002827 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002828 mbedtls_record rec;
2829
2830 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002831 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002832 rec.data_len = ssl->out_msglen;
2833 rec.data_offset = ssl->out_msg - rec.buf;
2834
2835 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2836 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2837 ssl->conf->transport, rec.ver );
2838 rec.type = ssl->out_msgtype;
2839
Hanno Beckera0e20d02019-05-15 14:03:01 +01002840#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002841 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002842 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002843#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002844
Hanno Beckera18d1322018-01-03 14:27:32 +00002845 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002846 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002847 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002849 return( ret );
2850 }
2851
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002852 if( rec.data_offset != 0 )
2853 {
2854 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2855 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2856 }
2857
Hanno Becker6430faf2019-05-08 11:57:13 +01002858 /* Update the record content type and CID. */
2859 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002860#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002861 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002862#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002863 ssl->out_msglen = len = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01002864 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002865 }
2866
Hanno Becker5903de42019-05-03 14:46:38 +01002867 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002868
2869#if defined(MBEDTLS_SSL_PROTO_DTLS)
2870 /* In case of DTLS, double-check that we don't exceed
2871 * the remaining space in the datagram. */
2872 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2873 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002874 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002875 if( ret < 0 )
2876 return( ret );
2877
2878 if( protected_record_size > (size_t) ret )
2879 {
2880 /* Should never happen */
2881 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2882 }
2883 }
2884#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002885
Hanno Becker6430faf2019-05-08 11:57:13 +01002886 /* Now write the potentially updated record content type. */
2887 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2888
Paul Elliott9f352112020-12-09 14:55:45 +00002889 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002890 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002891 ssl->out_hdr[0], ssl->out_hdr[1],
2892 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002893
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002895 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002896
2897 ssl->out_left += protected_record_size;
2898 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002899 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002900
Hanno Beckerdd772292020-02-05 10:38:31 +00002901 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002902 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2903 break;
2904
2905 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002906 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002907 {
2908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2909 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2910 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002911 }
2912
Hanno Becker67bc7c32018-08-06 11:33:50 +01002913#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002914 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2915 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002916 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002917 size_t remaining;
2918 ret = ssl_get_remaining_payload_in_datagram( ssl );
2919 if( ret < 0 )
2920 {
2921 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2922 ret );
2923 return( ret );
2924 }
2925
2926 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002927 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002928 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002929 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002930 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002931 else
2932 {
Hanno Becker513815a2018-08-20 11:56:09 +01002933 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002934 }
2935 }
2936#endif /* MBEDTLS_SSL_PROTO_DTLS */
2937
2938 if( ( flush == SSL_FORCE_FLUSH ) &&
2939 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002940 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002942 return( ret );
2943 }
2944
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002946
2947 return( 0 );
2948}
2949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002951
2952static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2953{
2954 if( ssl->in_msglen < ssl->in_hslen ||
2955 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2956 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2957 {
2958 return( 1 );
2959 }
2960 return( 0 );
2961}
Hanno Becker44650b72018-08-16 12:51:11 +01002962
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002963static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002964{
2965 return( ( ssl->in_msg[9] << 16 ) |
2966 ( ssl->in_msg[10] << 8 ) |
2967 ssl->in_msg[11] );
2968}
2969
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002970static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002971{
2972 return( ( ssl->in_msg[6] << 16 ) |
2973 ( ssl->in_msg[7] << 8 ) |
2974 ssl->in_msg[8] );
2975}
2976
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002977static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002978{
2979 uint32_t msg_len, frag_off, frag_len;
2980
2981 msg_len = ssl_get_hs_total_len( ssl );
2982 frag_off = ssl_get_hs_frag_off( ssl );
2983 frag_len = ssl_get_hs_frag_len( ssl );
2984
2985 if( frag_off > msg_len )
2986 return( -1 );
2987
2988 if( frag_len > msg_len - frag_off )
2989 return( -1 );
2990
2991 if( frag_len + 12 > ssl->in_msglen )
2992 return( -1 );
2993
2994 return( 0 );
2995}
2996
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002997/*
2998 * Mark bits in bitmask (used for DTLS HS reassembly)
2999 */
3000static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
3001{
3002 unsigned int start_bits, end_bits;
3003
3004 start_bits = 8 - ( offset % 8 );
3005 if( start_bits != 8 )
3006 {
3007 size_t first_byte_idx = offset / 8;
3008
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003009 /* Special case */
3010 if( len <= start_bits )
3011 {
3012 for( ; len != 0; len-- )
3013 mask[first_byte_idx] |= 1 << ( start_bits - len );
3014
3015 /* Avoid potential issues with offset or len becoming invalid */
3016 return;
3017 }
3018
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003019 offset += start_bits; /* Now offset % 8 == 0 */
3020 len -= start_bits;
3021
3022 for( ; start_bits != 0; start_bits-- )
3023 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
3024 }
3025
3026 end_bits = len % 8;
3027 if( end_bits != 0 )
3028 {
3029 size_t last_byte_idx = ( offset + len ) / 8;
3030
3031 len -= end_bits; /* Now len % 8 == 0 */
3032
3033 for( ; end_bits != 0; end_bits-- )
3034 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
3035 }
3036
3037 memset( mask + offset / 8, 0xFF, len / 8 );
3038}
3039
3040/*
3041 * Check that bitmask is full
3042 */
3043static int ssl_bitmask_check( unsigned char *mask, size_t len )
3044{
3045 size_t i;
3046
3047 for( i = 0; i < len / 8; i++ )
3048 if( mask[i] != 0xFF )
3049 return( -1 );
3050
3051 for( i = 0; i < len % 8; i++ )
3052 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
3053 return( -1 );
3054
3055 return( 0 );
3056}
3057
Hanno Becker56e205e2018-08-16 09:06:12 +01003058/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003059static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003060 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003061{
Hanno Becker56e205e2018-08-16 09:06:12 +01003062 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003063
Hanno Becker56e205e2018-08-16 09:06:12 +01003064 alloc_len = 12; /* Handshake header */
3065 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003066
Hanno Beckerd07df862018-08-16 09:14:58 +01003067 if( add_bitmap )
3068 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003069
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003070 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003071}
Hanno Becker56e205e2018-08-16 09:06:12 +01003072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003074
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003075static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003076{
3077 return( ( ssl->in_msg[1] << 16 ) |
3078 ( ssl->in_msg[2] << 8 ) |
3079 ssl->in_msg[3] );
3080}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003081
Simon Butcher99000142016-10-13 17:21:01 +01003082int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003083{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003085 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003086 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003087 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003089 }
3090
Hanno Becker12555c62018-08-16 12:47:53 +01003091 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003092
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00003094 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003095 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003098 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003099 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003101 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003102
Hanno Becker44650b72018-08-16 12:51:11 +01003103 if( ssl_check_hs_header( ssl ) != 0 )
3104 {
3105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3106 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3107 }
3108
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003109 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003110 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3111 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3112 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3113 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003114 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003115 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3116 {
3117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3118 recv_msg_seq,
3119 ssl->handshake->in_msg_seq ) );
3120 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3121 }
3122
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003123 /* Retransmit only on last message from previous flight, to avoid
3124 * too many retransmissions.
3125 * Besides, No sane server ever retransmits HelloVerifyRequest */
3126 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003128 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003130 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003131 recv_msg_seq,
3132 ssl->handshake->in_flight_start_seq ) );
3133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003135 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003137 return( ret );
3138 }
3139 }
3140 else
3141 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003143 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003144 recv_msg_seq,
3145 ssl->handshake->in_msg_seq ) );
3146 }
3147
Hanno Becker90333da2017-10-10 11:27:13 +01003148 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003149 }
3150 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003151
Hanno Becker6d97ef52018-08-16 13:09:04 +01003152 /* Message reassembly is handled alongside buffering of future
3153 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003154 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003155 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003156 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003157 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003159 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003160 }
3161 }
3162 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003164 /* With TLS we don't handle fragmentation (for now) */
3165 if( ssl->in_msglen < ssl->in_hslen )
3166 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3168 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003169 }
3170
Simon Butcher99000142016-10-13 17:21:01 +01003171 return( 0 );
3172}
3173
3174void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3175{
Hanno Becker0271f962018-08-16 13:23:47 +01003176 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003177
Hanno Becker0271f962018-08-16 13:23:47 +01003178 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003179 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003180 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003181 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003182
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003183 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003185 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003186 ssl->handshake != NULL )
3187 {
Hanno Becker0271f962018-08-16 13:23:47 +01003188 unsigned offset;
3189 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003190
Hanno Becker0271f962018-08-16 13:23:47 +01003191 /* Increment handshake sequence number */
3192 hs->in_msg_seq++;
3193
3194 /*
3195 * Clear up handshake buffering and reassembly structure.
3196 */
3197
3198 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003199 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003200
3201 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003202 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3203 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003204 offset++, hs_buf++ )
3205 {
3206 *hs_buf = *(hs_buf + 1);
3207 }
3208
3209 /* Create a fresh last entry */
3210 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003211 }
3212#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003213}
3214
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003215/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003216 * DTLS anti-replay: RFC 6347 4.1.2.6
3217 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003218 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3219 * Bit n is set iff record number in_window_top - n has been seen.
3220 *
3221 * Usually, in_window_top is the last record number seen and the lsb of
3222 * in_window is set. The only exception is the initial state (record number 0
3223 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003226void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003227{
3228 ssl->in_window_top = 0;
3229 ssl->in_window = 0;
3230}
3231
3232static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3233{
3234 return( ( (uint64_t) buf[0] << 40 ) |
3235 ( (uint64_t) buf[1] << 32 ) |
3236 ( (uint64_t) buf[2] << 24 ) |
3237 ( (uint64_t) buf[3] << 16 ) |
3238 ( (uint64_t) buf[4] << 8 ) |
3239 ( (uint64_t) buf[5] ) );
3240}
3241
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003242static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3243{
Janos Follath865b3eb2019-12-16 11:46:15 +00003244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003245 unsigned char *original_in_ctr;
3246
3247 // save original in_ctr
3248 original_in_ctr = ssl->in_ctr;
3249
3250 // use counter from record
3251 ssl->in_ctr = record_in_ctr;
3252
3253 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3254
3255 // restore the counter
3256 ssl->in_ctr = original_in_ctr;
3257
3258 return ret;
3259}
3260
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003261/*
3262 * Return 0 if sequence number is acceptable, -1 otherwise
3263 */
Hanno Becker0183d692019-07-12 08:50:37 +01003264int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003265{
3266 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3267 uint64_t bit;
3268
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003269 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003270 return( 0 );
3271
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003272 if( rec_seqnum > ssl->in_window_top )
3273 return( 0 );
3274
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003275 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003276
3277 if( bit >= 64 )
3278 return( -1 );
3279
3280 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3281 return( -1 );
3282
3283 return( 0 );
3284}
3285
3286/*
3287 * Update replay window on new validated record
3288 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003290{
3291 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3292
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003293 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003294 return;
3295
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003296 if( rec_seqnum > ssl->in_window_top )
3297 {
3298 /* Update window_top and the contents of the window */
3299 uint64_t shift = rec_seqnum - ssl->in_window_top;
3300
3301 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003302 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003303 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003304 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003305 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003306 ssl->in_window |= 1;
3307 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003308
3309 ssl->in_window_top = rec_seqnum;
3310 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003311 else
3312 {
3313 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003314 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003315
3316 if( bit < 64 ) /* Always true, but be extra sure */
3317 ssl->in_window |= (uint64_t) 1 << bit;
3318 }
3319}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003321
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003322#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003323/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003324 * Without any SSL context, check if a datagram looks like a ClientHello with
3325 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003326 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003327 *
3328 * - if cookie is valid, return 0
3329 * - if ClientHello looks superficially valid but cookie is not,
3330 * fill obuf and set olen, then
3331 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3332 * - otherwise return a specific error code
3333 */
3334static int ssl_check_dtls_clihlo_cookie(
3335 mbedtls_ssl_cookie_write_t *f_cookie_write,
3336 mbedtls_ssl_cookie_check_t *f_cookie_check,
3337 void *p_cookie,
3338 const unsigned char *cli_id, size_t cli_id_len,
3339 const unsigned char *in, size_t in_len,
3340 unsigned char *obuf, size_t buf_len, size_t *olen )
3341{
3342 size_t sid_len, cookie_len;
3343 unsigned char *p;
3344
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003345 /*
3346 * Structure of ClientHello with record and handshake headers,
3347 * and expected values. We don't need to check a lot, more checks will be
3348 * done when actually parsing the ClientHello - skipping those checks
3349 * avoids code duplication and does not make cookie forging any easier.
3350 *
3351 * 0-0 ContentType type; copied, must be handshake
3352 * 1-2 ProtocolVersion version; copied
3353 * 3-4 uint16 epoch; copied, must be 0
3354 * 5-10 uint48 sequence_number; copied
3355 * 11-12 uint16 length; (ignored)
3356 *
3357 * 13-13 HandshakeType msg_type; (ignored)
3358 * 14-16 uint24 length; (ignored)
3359 * 17-18 uint16 message_seq; copied
3360 * 19-21 uint24 fragment_offset; copied, must be 0
3361 * 22-24 uint24 fragment_length; (ignored)
3362 *
3363 * 25-26 ProtocolVersion client_version; (ignored)
3364 * 27-58 Random random; (ignored)
3365 * 59-xx SessionID session_id; 1 byte len + sid_len content
3366 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3367 * ...
3368 *
3369 * Minimum length is 61 bytes.
3370 */
3371 if( in_len < 61 ||
3372 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3373 in[3] != 0 || in[4] != 0 ||
3374 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3375 {
3376 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3377 }
3378
3379 sid_len = in[59];
3380 if( sid_len > in_len - 61 )
3381 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3382
3383 cookie_len = in[60 + sid_len];
3384 if( cookie_len > in_len - 60 )
3385 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3386
3387 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3388 cli_id, cli_id_len ) == 0 )
3389 {
3390 /* Valid cookie */
3391 return( 0 );
3392 }
3393
3394 /*
3395 * If we get here, we've got an invalid cookie, let's prepare HVR.
3396 *
3397 * 0-0 ContentType type; copied
3398 * 1-2 ProtocolVersion version; copied
3399 * 3-4 uint16 epoch; copied
3400 * 5-10 uint48 sequence_number; copied
3401 * 11-12 uint16 length; olen - 13
3402 *
3403 * 13-13 HandshakeType msg_type; hello_verify_request
3404 * 14-16 uint24 length; olen - 25
3405 * 17-18 uint16 message_seq; copied
3406 * 19-21 uint24 fragment_offset; copied
3407 * 22-24 uint24 fragment_length; olen - 25
3408 *
3409 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3410 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3411 *
3412 * Minimum length is 28.
3413 */
3414 if( buf_len < 28 )
3415 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3416
3417 /* Copy most fields and adapt others */
3418 memcpy( obuf, in, 25 );
3419 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3420 obuf[25] = 0xfe;
3421 obuf[26] = 0xff;
3422
3423 /* Generate and write actual cookie */
3424 p = obuf + 28;
3425 if( f_cookie_write( p_cookie,
3426 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3427 {
3428 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3429 }
3430
3431 *olen = p - obuf;
3432
3433 /* Go back and fill length fields */
3434 obuf[27] = (unsigned char)( *olen - 28 );
3435
Joe Subbianiad1115a2021-07-16 14:27:50 +01003436 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3437 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3438 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003439
Joe Subbianic54e9082021-07-19 11:56:54 +01003440 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003441
3442 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3443}
3444
3445/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003446 * Handle possible client reconnect with the same UDP quadruplet
3447 * (RFC 6347 Section 4.2.8).
3448 *
3449 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3450 * that looks like a ClientHello.
3451 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003452 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003453 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003454 * - if the input looks like a ClientHello with a valid cookie,
3455 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003456 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003457 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003458 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003459 * This function is called (through ssl_check_client_reconnect()) when an
3460 * unexpected record is found in ssl_get_next_record(), which will discard the
3461 * record if we return 0, and bubble up the return value otherwise (this
3462 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3463 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003464 */
3465static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3466{
Janos Follath865b3eb2019-12-16 11:46:15 +00003467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003468 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003469
Hanno Becker2fddd372019-07-10 14:37:41 +01003470 if( ssl->conf->f_cookie_write == NULL ||
3471 ssl->conf->f_cookie_check == NULL )
3472 {
3473 /* If we can't use cookies to verify reachability of the peer,
3474 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3476 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003477 return( 0 );
3478 }
3479
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003480 ret = ssl_check_dtls_clihlo_cookie(
3481 ssl->conf->f_cookie_write,
3482 ssl->conf->f_cookie_check,
3483 ssl->conf->p_cookie,
3484 ssl->cli_id, ssl->cli_id_len,
3485 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003486 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003487
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003488 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3489
3490 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003491 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003492 int send_ret;
3493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3494 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3495 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003496 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003497 * If the error is permanent we'll catch it later,
3498 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003499 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3500 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3501 (void) send_ret;
3502
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003503 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003504 }
3505
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003506 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003507 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003509 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003510 {
3511 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3512 return( ret );
3513 }
3514
3515 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003516 }
3517
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003518 return( ret );
3519}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003520#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003521
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003522static int ssl_check_record_type( uint8_t record_type )
3523{
3524 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3525 record_type != MBEDTLS_SSL_MSG_ALERT &&
3526 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3527 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3528 {
3529 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3530 }
3531
3532 return( 0 );
3533}
3534
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003535/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003536 * ContentType type;
3537 * ProtocolVersion version;
3538 * uint16 epoch; // DTLS only
3539 * uint48 sequence_number; // DTLS only
3540 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003541 *
3542 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003543 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003544 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3545 *
3546 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003547 * 1. proceed with the record if this function returns 0
3548 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3549 * 3. return CLIENT_RECONNECT if this function return that value
3550 * 4. drop the whole datagram if this function returns anything else.
3551 * Point 2 is needed when the peer is resending, and we have already received
3552 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003553 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003554static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003555 unsigned char *buf,
3556 size_t len,
3557 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003558{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003559 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003560
Hanno Beckere5e7e782019-07-11 12:29:35 +01003561 size_t const rec_hdr_type_offset = 0;
3562 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003563
Hanno Beckere5e7e782019-07-11 12:29:35 +01003564 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3565 rec_hdr_type_len;
3566 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003567
Hanno Beckere5e7e782019-07-11 12:29:35 +01003568 size_t const rec_hdr_ctr_len = 8;
3569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003570 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003571 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3572 rec_hdr_version_len;
3573
Hanno Beckera0e20d02019-05-15 14:03:01 +01003574#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003575 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3576 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003577 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003578#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3579#endif /* MBEDTLS_SSL_PROTO_DTLS */
3580
3581 size_t rec_hdr_len_offset; /* To be determined */
3582 size_t const rec_hdr_len_len = 2;
3583
3584 /*
3585 * Check minimum lengths for record header.
3586 */
3587
3588#if defined(MBEDTLS_SSL_PROTO_DTLS)
3589 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3590 {
3591 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3592 }
3593 else
3594#endif /* MBEDTLS_SSL_PROTO_DTLS */
3595 {
3596 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3597 }
3598
3599 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3600 {
3601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3602 (unsigned) len,
3603 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3604 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3605 }
3606
3607 /*
3608 * Parse and validate record content type
3609 */
3610
3611 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003612
3613 /* Check record content type */
3614#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3615 rec->cid_len = 0;
3616
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003617 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003618 ssl->conf->cid_len != 0 &&
3619 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003620 {
3621 /* Shift pointers to account for record header including CID
3622 * struct {
3623 * ContentType special_type = tls12_cid;
3624 * ProtocolVersion version;
3625 * uint16 epoch;
3626 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003627 * opaque cid[cid_length]; // Additional field compared to
3628 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003629 * uint16 length;
3630 * opaque enc_content[DTLSCiphertext.length];
3631 * } DTLSCiphertext;
3632 */
3633
3634 /* So far, we only support static CID lengths
3635 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003636 rec_hdr_cid_len = ssl->conf->cid_len;
3637 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003638
Hanno Beckere5e7e782019-07-11 12:29:35 +01003639 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003640 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3642 (unsigned) len,
3643 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003644 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003645 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003646
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003647 /* configured CID len is guaranteed at most 255, see
3648 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3649 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003650 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003651 }
3652 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003653#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003654 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003655 if( ssl_check_record_type( rec->type ) )
3656 {
Hanno Becker54229812019-07-12 14:40:00 +01003657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3658 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003659 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3660 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003661 }
3662
Hanno Beckere5e7e782019-07-11 12:29:35 +01003663 /*
3664 * Parse and validate record version
3665 */
3666
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003667 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3668 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003669 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3670 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003671 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003672
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003673 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003674 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003675 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3676 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003677 }
3678
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003679 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003681 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3682 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003683 }
3684
Hanno Beckere5e7e782019-07-11 12:29:35 +01003685 /*
3686 * Parse/Copy record sequence number.
3687 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003688
Hanno Beckere5e7e782019-07-11 12:29:35 +01003689#if defined(MBEDTLS_SSL_PROTO_DTLS)
3690 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003691 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003692 /* Copy explicit record sequence number from input buffer. */
3693 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3694 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003695 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003696 else
3697#endif /* MBEDTLS_SSL_PROTO_DTLS */
3698 {
3699 /* Copy implicit record sequence number from SSL context structure. */
3700 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3701 }
Paul Bakker40e46942009-01-03 21:51:57 +00003702
Hanno Beckere5e7e782019-07-11 12:29:35 +01003703 /*
3704 * Parse record length.
3705 */
3706
Hanno Beckere5e7e782019-07-11 12:29:35 +01003707 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003708 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3709 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003710 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003711
Paul Elliott9f352112020-12-09 14:55:45 +00003712 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003713 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003714 rec->type,
3715 major_ver, minor_ver, rec->data_len ) );
3716
3717 rec->buf = buf;
3718 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003719
Hanno Beckerd417cc92019-07-26 08:20:27 +01003720 if( rec->data_len == 0 )
3721 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003722
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003723 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003724 * DTLS-related tests.
3725 * Check epoch before checking length constraint because
3726 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3727 * message gets duplicated before the corresponding Finished message,
3728 * the second ChangeCipherSpec should be discarded because it belongs
3729 * to an old epoch, but not because its length is shorter than
3730 * the minimum record length for packets using the new record transform.
3731 * Note that these two kinds of failures are handled differently,
3732 * as an unexpected record is silently skipped but an invalid
3733 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003734 */
3735#if defined(MBEDTLS_SSL_PROTO_DTLS)
3736 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3737 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003738 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003739
Hanno Becker955a5c92019-07-10 17:12:07 +01003740 /* Check that the datagram is large enough to contain a record
3741 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003742 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003743 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003744 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3745 (unsigned) len,
3746 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003747 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3748 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003749
Hanno Becker37cfe732019-07-10 17:20:01 +01003750 /* Records from other, non-matching epochs are silently discarded.
3751 * (The case of same-port Client reconnects must be considered in
3752 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003753 if( rec_epoch != ssl->in_epoch )
3754 {
3755 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003756 "expected %u, received %lu",
3757 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003758
Hanno Becker552f7472019-07-19 10:59:12 +01003759 /* Records from the next epoch are considered for buffering
3760 * (concretely: early Finished messages). */
3761 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003762 {
Hanno Becker552f7472019-07-19 10:59:12 +01003763 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3764 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003765 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003766
Hanno Becker2fddd372019-07-10 14:37:41 +01003767 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003768 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003769#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003770 /* For records from the correct epoch, check whether their
3771 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003772 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3773 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003774 {
3775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3776 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3777 }
3778#endif
3779 }
3780#endif /* MBEDTLS_SSL_PROTO_DTLS */
3781
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003782 return( 0 );
3783}
Paul Bakker5121ce52009-01-03 21:22:43 +00003784
Paul Bakker5121ce52009-01-03 21:22:43 +00003785
Hanno Becker2fddd372019-07-10 14:37:41 +01003786#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3787static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3788{
3789 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3790
3791 /*
3792 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3793 * access the first byte of record content (handshake type), as we
3794 * have an active transform (possibly iv_len != 0), so use the
3795 * fact that the record header len is 13 instead.
3796 */
3797 if( rec_epoch == 0 &&
3798 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3799 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3800 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3801 ssl->in_left > 13 &&
3802 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3803 {
3804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3805 "from the same port" ) );
3806 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003807 }
3808
3809 return( 0 );
3810}
Hanno Becker2fddd372019-07-10 14:37:41 +01003811#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003812
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003813/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003814 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003815 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003816static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3817 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003818{
3819 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003821 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003822 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003823
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003824#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3825 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003827 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003828
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003829 ret = mbedtls_ssl_hw_record_read( ssl );
3830 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003831 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003832 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3833 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003834 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003835
3836 if( ret == 0 )
3837 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003838 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003839#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003840 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003841 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003842 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003843
Hanno Beckera18d1322018-01-03 14:27:32 +00003844 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003845 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003846 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003847 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003848
Hanno Beckera0e20d02019-05-15 14:03:01 +01003849#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003850 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3851 ssl->conf->ignore_unexpected_cid
3852 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3853 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003854 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003855 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003856 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003857#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003858
Paul Bakker5121ce52009-01-03 21:22:43 +00003859 return( ret );
3860 }
3861
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003862 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003863 {
3864 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003865 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003866 }
3867
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003868 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003869 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003870
Hanno Beckera0e20d02019-05-15 14:03:01 +01003871#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003872 /* We have already checked the record content type
3873 * in ssl_parse_record_header(), failing or silently
3874 * dropping the record in the case of an unknown type.
3875 *
3876 * Since with the use of CIDs, the record content type
3877 * might change during decryption, re-check the record
3878 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003879 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003880 {
3881 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3882 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3883 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003884#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003885
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003886 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003887 {
3888#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3889 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003890 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003891 {
3892 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3893 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3894 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3895 }
3896#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3897
3898 ssl->nb_zero++;
3899
3900 /*
3901 * Three or more empty messages may be a DoS attack
3902 * (excessive CPU consumption).
3903 */
3904 if( ssl->nb_zero > 3 )
3905 {
3906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003907 "messages, possible DoS attack" ) );
3908 /* Treat the records as if they were not properly authenticated,
3909 * thereby failing the connection if we see more than allowed
3910 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003911 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3912 }
3913 }
3914 else
3915 ssl->nb_zero = 0;
3916
3917#if defined(MBEDTLS_SSL_PROTO_DTLS)
3918 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3919 {
3920 ; /* in_ctr read from peer, not maintained internally */
3921 }
3922 else
3923#endif
3924 {
3925 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003926 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003927 if( ++ssl->in_ctr[i - 1] != 0 )
3928 break;
3929
3930 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003931 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003932 {
3933 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3934 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3935 }
3936 }
3937
Paul Bakker5121ce52009-01-03 21:22:43 +00003938 }
3939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003940#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003941 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003942 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003944 }
3945#endif
3946
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003947 /* Check actual (decrypted) record content length against
3948 * configured maximum. */
3949 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3950 {
3951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3952 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3953 }
3954
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003955 return( 0 );
3956}
3957
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003958/*
3959 * Read a record.
3960 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003961 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3962 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3963 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003964 */
Hanno Becker1097b342018-08-15 14:09:41 +01003965
3966/* Helper functions for mbedtls_ssl_read_record(). */
3967static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003968static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3969static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003970
Hanno Becker327c93b2018-08-15 13:56:18 +01003971int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003972 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003973{
Janos Follath865b3eb2019-12-16 11:46:15 +00003974 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003975
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003976 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003977
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003978 if( ssl->keep_current_message == 0 )
3979 {
3980 do {
Simon Butcher99000142016-10-13 17:21:01 +01003981
Hanno Becker26994592018-08-15 14:14:59 +01003982 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003983 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003984 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003985
Hanno Beckere74d5562018-08-15 14:26:08 +01003986 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003987 {
Hanno Becker40f50842018-08-15 14:48:01 +01003988#if defined(MBEDTLS_SSL_PROTO_DTLS)
3989 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003990
Hanno Becker40f50842018-08-15 14:48:01 +01003991 /* We only check for buffered messages if the
3992 * current datagram is fully consumed. */
3993 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003994 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003995 {
Hanno Becker40f50842018-08-15 14:48:01 +01003996 if( ssl_load_buffered_message( ssl ) == 0 )
3997 have_buffered = 1;
3998 }
3999
4000 if( have_buffered == 0 )
4001#endif /* MBEDTLS_SSL_PROTO_DTLS */
4002 {
4003 ret = ssl_get_next_record( ssl );
4004 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
4005 continue;
4006
4007 if( ret != 0 )
4008 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01004009 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004010 return( ret );
4011 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004012 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004013 }
4014
4015 ret = mbedtls_ssl_handle_message_type( ssl );
4016
Hanno Becker40f50842018-08-15 14:48:01 +01004017#if defined(MBEDTLS_SSL_PROTO_DTLS)
4018 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4019 {
4020 /* Buffer future message */
4021 ret = ssl_buffer_message( ssl );
4022 if( ret != 0 )
4023 return( ret );
4024
4025 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4026 }
4027#endif /* MBEDTLS_SSL_PROTO_DTLS */
4028
Hanno Becker90333da2017-10-10 11:27:13 +01004029 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4030 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004031
4032 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01004033 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00004034 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01004035 return( ret );
4036 }
4037
Hanno Becker327c93b2018-08-15 13:56:18 +01004038 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01004039 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004040 {
4041 mbedtls_ssl_update_handshake_status( ssl );
4042 }
Simon Butcher99000142016-10-13 17:21:01 +01004043 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004044 else
Simon Butcher99000142016-10-13 17:21:01 +01004045 {
Hanno Becker02f59072018-08-15 14:00:24 +01004046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004047 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004048 }
4049
4050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4051
4052 return( 0 );
4053}
4054
Hanno Becker40f50842018-08-15 14:48:01 +01004055#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004056static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004057{
Hanno Becker40f50842018-08-15 14:48:01 +01004058 if( ssl->in_left > ssl->next_record_offset )
4059 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004060
Hanno Becker40f50842018-08-15 14:48:01 +01004061 return( 0 );
4062}
4063
4064static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4065{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004066 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004067 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004068 int ret = 0;
4069
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004070 if( hs == NULL )
4071 return( -1 );
4072
Hanno Beckere00ae372018-08-20 09:39:42 +01004073 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4074
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004075 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4076 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4077 {
4078 /* Check if we have seen a ChangeCipherSpec before.
4079 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004080 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004081 {
4082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4083 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004084 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004085 }
4086
Hanno Becker39b8bc92018-08-28 17:17:13 +01004087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004088 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4089 ssl->in_msglen = 1;
4090 ssl->in_msg[0] = 1;
4091
4092 /* As long as they are equal, the exact value doesn't matter. */
4093 ssl->in_left = 0;
4094 ssl->next_record_offset = 0;
4095
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004096 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004097 goto exit;
4098 }
Hanno Becker37f95322018-08-16 13:55:32 +01004099
Hanno Beckerb8f50142018-08-28 10:01:34 +01004100#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004101 /* Debug only */
4102 {
4103 unsigned offset;
4104 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4105 {
4106 hs_buf = &hs->buffering.hs[offset];
4107 if( hs_buf->is_valid == 1 )
4108 {
4109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4110 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004111 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004112 }
4113 }
4114 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004115#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004116
4117 /* Check if we have buffered and/or fully reassembled the
4118 * next handshake message. */
4119 hs_buf = &hs->buffering.hs[0];
4120 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4121 {
4122 /* Synthesize a record containing the buffered HS message. */
4123 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4124 ( hs_buf->data[2] << 8 ) |
4125 hs_buf->data[3];
4126
4127 /* Double-check that we haven't accidentally buffered
4128 * a message that doesn't fit into the input buffer. */
4129 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4130 {
4131 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4132 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4133 }
4134
4135 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4136 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4137 hs_buf->data, msg_len + 12 );
4138
4139 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4140 ssl->in_hslen = msg_len + 12;
4141 ssl->in_msglen = msg_len + 12;
4142 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4143
4144 ret = 0;
4145 goto exit;
4146 }
4147 else
4148 {
4149 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4150 hs->in_msg_seq ) );
4151 }
4152
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004153 ret = -1;
4154
4155exit:
4156
4157 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4158 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004159}
4160
Hanno Beckera02b0b42018-08-21 17:20:27 +01004161static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4162 size_t desired )
4163{
4164 int offset;
4165 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004166 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4167 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004168
Hanno Becker01315ea2018-08-21 17:22:17 +01004169 /* Get rid of future records epoch first, if such exist. */
4170 ssl_free_buffered_record( ssl );
4171
4172 /* Check if we have enough space available now. */
4173 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4174 hs->buffering.total_bytes_buffered ) )
4175 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004176 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004177 return( 0 );
4178 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004179
Hanno Becker4f432ad2018-08-28 10:02:32 +01004180 /* We don't have enough space to buffer the next expected handshake
4181 * message. Remove buffers used for future messages to gain space,
4182 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004183 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4184 offset >= 0; offset-- )
4185 {
4186 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4187 offset ) );
4188
Hanno Beckerb309b922018-08-23 13:18:05 +01004189 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004190
4191 /* Check if we have enough space available now. */
4192 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4193 hs->buffering.total_bytes_buffered ) )
4194 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004196 return( 0 );
4197 }
4198 }
4199
4200 return( -1 );
4201}
4202
Hanno Becker40f50842018-08-15 14:48:01 +01004203static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4204{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004205 int ret = 0;
4206 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4207
4208 if( hs == NULL )
4209 return( 0 );
4210
4211 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4212
4213 switch( ssl->in_msgtype )
4214 {
4215 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4216 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004217
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004218 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004219 break;
4220
4221 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004222 {
4223 unsigned recv_msg_seq_offset;
4224 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4225 mbedtls_ssl_hs_buffer *hs_buf;
4226 size_t msg_len = ssl->in_hslen - 12;
4227
4228 /* We should never receive an old handshake
4229 * message - double-check nonetheless. */
4230 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4231 {
4232 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4233 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4234 }
4235
4236 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4237 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4238 {
4239 /* Silently ignore -- message too far in the future */
4240 MBEDTLS_SSL_DEBUG_MSG( 2,
4241 ( "Ignore future HS message with sequence number %u, "
4242 "buffering window %u - %u",
4243 recv_msg_seq, ssl->handshake->in_msg_seq,
4244 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4245
4246 goto exit;
4247 }
4248
4249 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4250 recv_msg_seq, recv_msg_seq_offset ) );
4251
4252 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4253
4254 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004255 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004256 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004257 size_t reassembly_buf_sz;
4258
Hanno Becker37f95322018-08-16 13:55:32 +01004259 hs_buf->is_fragmented =
4260 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4261
4262 /* We copy the message back into the input buffer
4263 * after reassembly, so check that it's not too large.
4264 * This is an implementation-specific limitation
4265 * and not one from the standard, hence it is not
4266 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004267 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004268 {
4269 /* Ignore message */
4270 goto exit;
4271 }
4272
Hanno Beckere0b150f2018-08-21 15:51:03 +01004273 /* Check if we have enough space to buffer the message. */
4274 if( hs->buffering.total_bytes_buffered >
4275 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4276 {
4277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4278 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4279 }
4280
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004281 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4282 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004283
4284 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4285 hs->buffering.total_bytes_buffered ) )
4286 {
4287 if( recv_msg_seq_offset > 0 )
4288 {
4289 /* If we can't buffer a future message because
4290 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004291 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4292 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4293 " (already %" MBEDTLS_PRINTF_SIZET
4294 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004295 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004296 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004297 goto exit;
4298 }
Hanno Beckere1801392018-08-21 16:51:05 +01004299 else
4300 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004301 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4302 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4303 " (already %" MBEDTLS_PRINTF_SIZET
4304 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004305 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004306 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004307 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004308
Hanno Beckera02b0b42018-08-21 17:20:27 +01004309 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004310 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004311 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4312 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4313 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4314 " (already %" MBEDTLS_PRINTF_SIZET
4315 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004316 msg_len,
4317 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004318 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004319 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004320 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4321 goto exit;
4322 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004323 }
4324
Paul Elliottd48d5c62021-01-07 14:47:05 +00004325 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004326 msg_len ) );
4327
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004328 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4329 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004330 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004331 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004332 goto exit;
4333 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004334 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004335
4336 /* Prepare final header: copy msg_type, length and message_seq,
4337 * then add standardised fragment_offset and fragment_length */
4338 memcpy( hs_buf->data, ssl->in_msg, 6 );
4339 memset( hs_buf->data + 6, 0, 3 );
4340 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4341
4342 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004343
4344 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004345 }
4346 else
4347 {
4348 /* Make sure msg_type and length are consistent */
4349 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4350 {
4351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4352 /* Ignore */
4353 goto exit;
4354 }
4355 }
4356
Hanno Becker4422bbb2018-08-20 09:40:19 +01004357 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004358 {
4359 size_t frag_len, frag_off;
4360 unsigned char * const msg = hs_buf->data + 12;
4361
4362 /*
4363 * Check and copy current fragment
4364 */
4365
4366 /* Validation of header fields already done in
4367 * mbedtls_ssl_prepare_handshake_record(). */
4368 frag_off = ssl_get_hs_frag_off( ssl );
4369 frag_len = ssl_get_hs_frag_len( ssl );
4370
Paul Elliottd48d5c62021-01-07 14:47:05 +00004371 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4372 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004373 frag_off, frag_len ) );
4374 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4375
4376 if( hs_buf->is_fragmented )
4377 {
4378 unsigned char * const bitmask = msg + msg_len;
4379 ssl_bitmask_set( bitmask, frag_off, frag_len );
4380 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4381 msg_len ) == 0 );
4382 }
4383 else
4384 {
4385 hs_buf->is_complete = 1;
4386 }
4387
4388 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4389 hs_buf->is_complete ? "" : "not yet " ) );
4390 }
4391
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004392 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004393 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004394
4395 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004396 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004397 break;
4398 }
4399
4400exit:
4401
4402 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4403 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004404}
4405#endif /* MBEDTLS_SSL_PROTO_DTLS */
4406
Hanno Becker1097b342018-08-15 14:09:41 +01004407static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004408{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004409 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004410 * Consume last content-layer message and potentially
4411 * update in_msglen which keeps track of the contents'
4412 * consumption state.
4413 *
4414 * (1) Handshake messages:
4415 * Remove last handshake message, move content
4416 * and adapt in_msglen.
4417 *
4418 * (2) Alert messages:
4419 * Consume whole record content, in_msglen = 0.
4420 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004421 * (3) Change cipher spec:
4422 * Consume whole record content, in_msglen = 0.
4423 *
4424 * (4) Application data:
4425 * Don't do anything - the record layer provides
4426 * the application data as a stream transport
4427 * and consumes through mbedtls_ssl_read only.
4428 *
4429 */
4430
4431 /* Case (1): Handshake messages */
4432 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004433 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004434 /* Hard assertion to be sure that no application data
4435 * is in flight, as corrupting ssl->in_msglen during
4436 * ssl->in_offt != NULL is fatal. */
4437 if( ssl->in_offt != NULL )
4438 {
4439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4440 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4441 }
4442
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004443 /*
4444 * Get next Handshake message in the current record
4445 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004446
Hanno Becker4a810fb2017-05-24 16:27:30 +01004447 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004448 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004449 * current handshake content: If DTLS handshake
4450 * fragmentation is used, that's the fragment
4451 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004452 * size here is faulty and should be changed at
4453 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004454 * (2) While it doesn't seem to cause problems, one
4455 * has to be very careful not to assume that in_hslen
4456 * is always <= in_msglen in a sensible communication.
4457 * Again, it's wrong for DTLS handshake fragmentation.
4458 * The following check is therefore mandatory, and
4459 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004460 * Additionally, ssl->in_hslen might be arbitrarily out of
4461 * bounds after handling a DTLS message with an unexpected
4462 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004463 */
4464 if( ssl->in_hslen < ssl->in_msglen )
4465 {
4466 ssl->in_msglen -= ssl->in_hslen;
4467 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4468 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004469
Hanno Becker4a810fb2017-05-24 16:27:30 +01004470 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4471 ssl->in_msg, ssl->in_msglen );
4472 }
4473 else
4474 {
4475 ssl->in_msglen = 0;
4476 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004477
Hanno Becker4a810fb2017-05-24 16:27:30 +01004478 ssl->in_hslen = 0;
4479 }
4480 /* Case (4): Application data */
4481 else if( ssl->in_offt != NULL )
4482 {
4483 return( 0 );
4484 }
4485 /* Everything else (CCS & Alerts) */
4486 else
4487 {
4488 ssl->in_msglen = 0;
4489 }
4490
Hanno Becker1097b342018-08-15 14:09:41 +01004491 return( 0 );
4492}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004493
Hanno Beckere74d5562018-08-15 14:26:08 +01004494static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4495{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004496 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004497 return( 1 );
4498
4499 return( 0 );
4500}
4501
Hanno Becker5f066e72018-08-16 14:56:31 +01004502#if defined(MBEDTLS_SSL_PROTO_DTLS)
4503
4504static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4505{
4506 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4507 if( hs == NULL )
4508 return;
4509
Hanno Becker01315ea2018-08-21 17:22:17 +01004510 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004511 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004512 hs->buffering.total_bytes_buffered -=
4513 hs->buffering.future_record.len;
4514
4515 mbedtls_free( hs->buffering.future_record.data );
4516 hs->buffering.future_record.data = NULL;
4517 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004518}
4519
4520static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4521{
4522 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4523 unsigned char * rec;
4524 size_t rec_len;
4525 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004526#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4527 size_t in_buf_len = ssl->in_buf_len;
4528#else
4529 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4530#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004531 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4532 return( 0 );
4533
4534 if( hs == NULL )
4535 return( 0 );
4536
Hanno Becker5f066e72018-08-16 14:56:31 +01004537 rec = hs->buffering.future_record.data;
4538 rec_len = hs->buffering.future_record.len;
4539 rec_epoch = hs->buffering.future_record.epoch;
4540
4541 if( rec == NULL )
4542 return( 0 );
4543
Hanno Becker4cb782d2018-08-20 11:19:05 +01004544 /* Only consider loading future records if the
4545 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004546 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004547 return( 0 );
4548
Hanno Becker5f066e72018-08-16 14:56:31 +01004549 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4550
4551 if( rec_epoch != ssl->in_epoch )
4552 {
4553 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4554 goto exit;
4555 }
4556
4557 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4558
4559 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004560 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004561 {
4562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4563 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4564 }
4565
4566 memcpy( ssl->in_hdr, rec, rec_len );
4567 ssl->in_left = rec_len;
4568 ssl->next_record_offset = 0;
4569
4570 ssl_free_buffered_record( ssl );
4571
4572exit:
4573 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4574 return( 0 );
4575}
4576
Hanno Becker519f15d2019-07-11 12:43:20 +01004577static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4578 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004579{
4580 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004581
4582 /* Don't buffer future records outside handshakes. */
4583 if( hs == NULL )
4584 return( 0 );
4585
4586 /* Only buffer handshake records (we are only interested
4587 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004588 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004589 return( 0 );
4590
4591 /* Don't buffer more than one future epoch record. */
4592 if( hs->buffering.future_record.data != NULL )
4593 return( 0 );
4594
Hanno Becker01315ea2018-08-21 17:22:17 +01004595 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004596 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004597 hs->buffering.total_bytes_buffered ) )
4598 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004599 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4600 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4601 " (already %" MBEDTLS_PRINTF_SIZET
4602 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004603 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004604 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004605 return( 0 );
4606 }
4607
Hanno Becker5f066e72018-08-16 14:56:31 +01004608 /* Buffer record */
4609 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004610 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004611 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004612
4613 /* ssl_parse_record_header() only considers records
4614 * of the next epoch as candidates for buffering. */
4615 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004616 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004617
4618 hs->buffering.future_record.data =
4619 mbedtls_calloc( 1, hs->buffering.future_record.len );
4620 if( hs->buffering.future_record.data == NULL )
4621 {
4622 /* If we run out of RAM trying to buffer a
4623 * record from the next epoch, just ignore. */
4624 return( 0 );
4625 }
4626
Hanno Becker519f15d2019-07-11 12:43:20 +01004627 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004628
Hanno Becker519f15d2019-07-11 12:43:20 +01004629 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004630 return( 0 );
4631}
4632
4633#endif /* MBEDTLS_SSL_PROTO_DTLS */
4634
Hanno Beckere74d5562018-08-15 14:26:08 +01004635static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004636{
Janos Follath865b3eb2019-12-16 11:46:15 +00004637 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004638 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004639
Hanno Becker5f066e72018-08-16 14:56:31 +01004640#if defined(MBEDTLS_SSL_PROTO_DTLS)
4641 /* We might have buffered a future record; if so,
4642 * and if the epoch matches now, load it.
4643 * On success, this call will set ssl->in_left to
4644 * the length of the buffered record, so that
4645 * the calls to ssl_fetch_input() below will
4646 * essentially be no-ops. */
4647 ret = ssl_load_buffered_record( ssl );
4648 if( ret != 0 )
4649 return( ret );
4650#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004651
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004652 /* Ensure that we have enough space available for the default form
4653 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4654 * with no space for CIDs counted in). */
4655 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4656 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004657 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004658 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004659 return( ret );
4660 }
4661
Hanno Beckere5e7e782019-07-11 12:29:35 +01004662 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4663 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004664 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004666 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004667 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004668 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4669 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004670 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004671 if( ret != 0 )
4672 return( ret );
4673
4674 /* Fall through to handling of unexpected records */
4675 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4676 }
4677
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004678 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4679 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004680#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004681 /* Reset in pointers to default state for TLS/DTLS records,
4682 * assuming no CID and no offset between record content and
4683 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004684 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004685
Hanno Becker7ae20e02019-07-12 08:33:49 +01004686 /* Setup internal message pointers from record structure. */
4687 ssl->in_msgtype = rec.type;
4688#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4689 ssl->in_len = ssl->in_cid + rec.cid_len;
4690#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4691 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4692 ssl->in_msglen = rec.data_len;
4693
Hanno Becker2fddd372019-07-10 14:37:41 +01004694 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004695 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004696 if( ret != 0 )
4697 return( ret );
4698#endif
4699
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004700 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004701 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004702
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004703 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4704 "(header)" ) );
4705 }
4706 else
4707 {
4708 /* Skip invalid record and the rest of the datagram */
4709 ssl->next_record_offset = 0;
4710 ssl->in_left = 0;
4711
4712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4713 "(header)" ) );
4714 }
4715
4716 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004717 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004718 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004719 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004720#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004721 {
4722 return( ret );
4723 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004724 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004726#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004727 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004728 {
Hanno Beckera8814792019-07-10 15:01:45 +01004729 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004730 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004731 if( ssl->next_record_offset < ssl->in_left )
4732 {
4733 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4734 }
4735 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004736 else
4737#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004738 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004739 /*
4740 * Fetch record contents from underlying transport.
4741 */
Hanno Beckera3175662019-07-11 12:50:29 +01004742 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004743 if( ret != 0 )
4744 {
4745 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4746 return( ret );
4747 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004748
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004749 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004750 }
4751
4752 /*
4753 * Decrypt record contents.
4754 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004755
Hanno Beckerfdf66042019-07-11 13:07:45 +01004756 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004759 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004760 {
4761 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004762 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004763 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004764 /* Except when waiting for Finished as a bad mac here
4765 * probably means something went wrong in the handshake
4766 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4767 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4768 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4769 {
4770#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4771 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4772 {
4773 mbedtls_ssl_send_alert_message( ssl,
4774 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4775 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4776 }
4777#endif
4778 return( ret );
4779 }
4780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004782 if( ssl->conf->badmac_limit != 0 &&
4783 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004784 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004785 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4786 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004787 }
4788#endif
4789
Hanno Becker4a810fb2017-05-24 16:27:30 +01004790 /* As above, invalid records cause
4791 * dismissal of the whole datagram. */
4792
4793 ssl->next_record_offset = 0;
4794 ssl->in_left = 0;
4795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004797 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004798 }
4799
4800 return( ret );
4801 }
4802 else
4803#endif
4804 {
4805 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004806#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4807 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004808 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004809 mbedtls_ssl_send_alert_message( ssl,
4810 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4811 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004812 }
4813#endif
4814 return( ret );
4815 }
4816 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004817
Hanno Becker44d89b22019-07-12 09:40:44 +01004818
4819 /* Reset in pointers to default state for TLS/DTLS records,
4820 * assuming no CID and no offset between record content and
4821 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004822 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004823#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4824 ssl->in_len = ssl->in_cid + rec.cid_len;
4825#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004826 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004827
Hanno Becker8685c822019-07-12 09:37:30 +01004828 /* The record content type may change during decryption,
4829 * so re-read it. */
4830 ssl->in_msgtype = rec.type;
4831 /* Also update the input buffer, because unfortunately
4832 * the server-side ssl_parse_client_hello() reparses the
4833 * record header when receiving a ClientHello initiating
4834 * a renegotiation. */
4835 ssl->in_hdr[0] = rec.type;
4836 ssl->in_msg = rec.buf + rec.data_offset;
4837 ssl->in_msglen = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01004838 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004839
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004840#if defined(MBEDTLS_ZLIB_SUPPORT)
4841 if( ssl->transform_in != NULL &&
4842 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4843 {
4844 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4845 {
4846 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4847 return( ret );
4848 }
4849
4850 /* Check actual (decompress) record content length against
4851 * configured maximum. */
4852 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4853 {
4854 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4855 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4856 }
4857 }
4858#endif /* MBEDTLS_ZLIB_SUPPORT */
4859
Simon Butcher99000142016-10-13 17:21:01 +01004860 return( 0 );
4861}
4862
4863int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4864{
Janos Follath865b3eb2019-12-16 11:46:15 +00004865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004866
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004867 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004868 * Handle particular types of records
4869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004870 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004871 {
Simon Butcher99000142016-10-13 17:21:01 +01004872 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4873 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004874 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004875 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004876 }
4877
Hanno Beckere678eaa2018-08-21 14:57:46 +01004878 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004879 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004880 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004881 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004883 ssl->in_msglen ) );
4884 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004885 }
4886
Hanno Beckere678eaa2018-08-21 14:57:46 +01004887 if( ssl->in_msg[0] != 1 )
4888 {
4889 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4890 ssl->in_msg[0] ) );
4891 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4892 }
4893
4894#if defined(MBEDTLS_SSL_PROTO_DTLS)
4895 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4896 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4897 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4898 {
4899 if( ssl->handshake == NULL )
4900 {
4901 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4902 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4903 }
4904
4905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4906 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4907 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004908#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004909 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004912 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004913 if( ssl->in_msglen != 2 )
4914 {
4915 /* Note: Standard allows for more than one 2 byte alert
4916 to be packed in a single message, but Mbed TLS doesn't
4917 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004919 ssl->in_msglen ) );
4920 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4921 }
4922
Paul Elliott9f352112020-12-09 14:55:45 +00004923 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004924 ssl->in_msg[0], ssl->in_msg[1] ) );
4925
4926 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004927 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004929 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004930 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004932 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004933 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004934 }
4935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004936 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4937 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004938 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004939 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4940 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004941 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004942
4943#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4944 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4945 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4946 {
Hanno Becker90333da2017-10-10 11:27:13 +01004947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004948 /* Will be handled when trying to parse ServerHello */
4949 return( 0 );
4950 }
4951#endif
4952
4953#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4954 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4955 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4956 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4957 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4958 {
4959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4960 /* Will be handled in mbedtls_ssl_parse_certificate() */
4961 return( 0 );
4962 }
4963#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4964
4965 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004966 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004967 }
4968
Hanno Beckerc76c6192017-06-06 10:03:17 +01004969#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004970 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004971 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004972 /* Drop unexpected ApplicationData records,
4973 * except at the beginning of renegotiations */
4974 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4975 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4976#if defined(MBEDTLS_SSL_RENEGOTIATION)
4977 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4978 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004979#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004980 )
4981 {
4982 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4983 return( MBEDTLS_ERR_SSL_NON_FATAL );
4984 }
4985
4986 if( ssl->handshake != NULL &&
4987 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4988 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004989 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004990 }
4991 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004992#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004993
Paul Bakker5121ce52009-01-03 21:22:43 +00004994 return( 0 );
4995}
4996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004997int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004998{
irwir6c0da642019-09-26 21:07:41 +03004999 return( mbedtls_ssl_send_alert_message( ssl,
5000 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5001 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005002}
5003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005004int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00005005 unsigned char level,
5006 unsigned char message )
5007{
Janos Follath865b3eb2019-12-16 11:46:15 +00005008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005009
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005010 if( ssl == NULL || ssl->conf == NULL )
5011 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005014 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00005015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005016 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005017 ssl->out_msglen = 2;
5018 ssl->out_msg[0] = level;
5019 ssl->out_msg[1] = message;
5020
Hanno Becker67bc7c32018-08-06 11:33:50 +01005021 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00005022 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005023 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00005024 return( ret );
5025 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005026 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00005027
5028 return( 0 );
5029}
5030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005031int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005032{
Janos Follath865b3eb2019-12-16 11:46:15 +00005033 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005035 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005037 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005038 ssl->out_msglen = 1;
5039 ssl->out_msg[0] = 1;
5040
Paul Bakker5121ce52009-01-03 21:22:43 +00005041 ssl->state++;
5042
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005043 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005044 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005045 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005046 return( ret );
5047 }
5048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005049 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005050
5051 return( 0 );
5052}
5053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005054int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005055{
Janos Follath865b3eb2019-12-16 11:46:15 +00005056 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005058 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005059
Hanno Becker327c93b2018-08-15 13:56:18 +01005060 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005061 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005062 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005063 return( ret );
5064 }
5065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005066 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005067 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005068 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005069 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5070 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005072 }
5073
Hanno Beckere678eaa2018-08-21 14:57:46 +01005074 /* CCS records are only accepted if they have length 1 and content '1',
5075 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005076
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005077 /*
5078 * Switch to our negotiated transform and session parameters for inbound
5079 * data.
5080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005081 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005082 ssl->transform_in = ssl->transform_negotiate;
5083 ssl->session_in = ssl->session_negotiate;
5084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005086 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005087 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005089 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005090#endif
5091
5092 /* Increment epoch */
5093 if( ++ssl->in_epoch == 0 )
5094 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005096 /* This is highly unlikely to happen for legitimate reasons, so
5097 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005098 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005099 }
5100 }
5101 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005102#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005103 memset( ssl->in_ctr, 0, 8 );
5104
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005105 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005107#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5108 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005109 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005111 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005112 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005113 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5114 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005115 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005116 }
5117 }
5118#endif
5119
Paul Bakker5121ce52009-01-03 21:22:43 +00005120 ssl->state++;
5121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005123
5124 return( 0 );
5125}
5126
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005127/* Once ssl->out_hdr as the address of the beginning of the
5128 * next outgoing record is set, deduce the other pointers.
5129 *
5130 * Note: For TLS, we save the implicit record sequence number
5131 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5132 * and the caller has to make sure there's space for this.
5133 */
5134
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005135static size_t ssl_transform_get_explicit_iv_len(
5136 mbedtls_ssl_transform const *transform )
5137{
5138 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5139 return( 0 );
5140
5141 return( transform->ivlen - transform->fixed_ivlen );
5142}
5143
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005144void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5145 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005146{
5147#if defined(MBEDTLS_SSL_PROTO_DTLS)
5148 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5149 {
5150 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005151#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005152 ssl->out_cid = ssl->out_ctr + 8;
5153 ssl->out_len = ssl->out_cid;
5154 if( transform != NULL )
5155 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005156#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005157 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005158#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005159 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005160 }
5161 else
5162#endif
5163 {
5164 ssl->out_ctr = ssl->out_hdr - 8;
5165 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005166#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005167 ssl->out_cid = ssl->out_len;
5168#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005169 ssl->out_iv = ssl->out_hdr + 5;
5170 }
5171
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005172 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005173 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005174 if( transform != NULL )
5175 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005176}
5177
5178/* Once ssl->in_hdr as the address of the beginning of the
5179 * next incoming record is set, deduce the other pointers.
5180 *
5181 * Note: For TLS, we save the implicit record sequence number
5182 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5183 * and the caller has to make sure there's space for this.
5184 */
5185
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005186void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005187{
Hanno Becker79594fd2019-05-08 09:38:41 +01005188 /* This function sets the pointers to match the case
5189 * of unprotected TLS/DTLS records, with both ssl->in_iv
5190 * and ssl->in_msg pointing to the beginning of the record
5191 * content.
5192 *
5193 * When decrypting a protected record, ssl->in_msg
5194 * will be shifted to point to the beginning of the
5195 * record plaintext.
5196 */
5197
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005198#if defined(MBEDTLS_SSL_PROTO_DTLS)
5199 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5200 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005201 /* This sets the header pointers to match records
5202 * without CID. When we receive a record containing
5203 * a CID, the fields are shifted accordingly in
5204 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005205 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005206#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005207 ssl->in_cid = ssl->in_ctr + 8;
5208 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005209#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005210 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005211#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005212 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005213 }
5214 else
5215#endif
5216 {
5217 ssl->in_ctr = ssl->in_hdr - 8;
5218 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005219#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005220 ssl->in_cid = ssl->in_len;
5221#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005222 ssl->in_iv = ssl->in_hdr + 5;
5223 }
5224
Hanno Becker79594fd2019-05-08 09:38:41 +01005225 /* This will be adjusted at record decryption time. */
5226 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005227}
5228
Paul Bakker5121ce52009-01-03 21:22:43 +00005229/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005230 * Setup an SSL context
5231 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005232
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005233void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005234{
5235 /* Set the incoming and outgoing record pointers. */
5236#if defined(MBEDTLS_SSL_PROTO_DTLS)
5237 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5238 {
5239 ssl->out_hdr = ssl->out_buf;
5240 ssl->in_hdr = ssl->in_buf;
5241 }
5242 else
5243#endif /* MBEDTLS_SSL_PROTO_DTLS */
5244 {
5245 ssl->out_hdr = ssl->out_buf + 8;
5246 ssl->in_hdr = ssl->in_buf + 8;
5247 }
5248
5249 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005250 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5251 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005252}
5253
Paul Bakker5121ce52009-01-03 21:22:43 +00005254/*
5255 * SSL get accessors
5256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005257size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005258{
5259 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5260}
5261
Hanno Becker8b170a02017-10-10 11:51:19 +01005262int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5263{
5264 /*
5265 * Case A: We're currently holding back
5266 * a message for further processing.
5267 */
5268
5269 if( ssl->keep_current_message == 1 )
5270 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005271 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005272 return( 1 );
5273 }
5274
5275 /*
5276 * Case B: Further records are pending in the current datagram.
5277 */
5278
5279#if defined(MBEDTLS_SSL_PROTO_DTLS)
5280 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5281 ssl->in_left > ssl->next_record_offset )
5282 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005283 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005284 return( 1 );
5285 }
5286#endif /* MBEDTLS_SSL_PROTO_DTLS */
5287
5288 /*
5289 * Case C: A handshake message is being processed.
5290 */
5291
Hanno Becker8b170a02017-10-10 11:51:19 +01005292 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5293 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005294 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005295 return( 1 );
5296 }
5297
5298 /*
5299 * Case D: An application data message is being processed
5300 */
5301 if( ssl->in_offt != NULL )
5302 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005303 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005304 return( 1 );
5305 }
5306
5307 /*
5308 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005309 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005310 * we implement support for multiple alerts in single records.
5311 */
5312
5313 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5314 return( 0 );
5315}
5316
Paul Bakker43ca69c2011-01-15 17:35:19 +00005317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005318int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005319{
Hanno Becker3136ede2018-08-17 15:28:19 +01005320 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005321 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005322 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005323
Hanno Becker5903de42019-05-03 14:46:38 +01005324 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5325
Hanno Becker78640902018-08-13 16:35:15 +01005326 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005327 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329#if defined(MBEDTLS_ZLIB_SUPPORT)
5330 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5331 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005332#endif
5333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005334 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005335 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005336 case MBEDTLS_MODE_GCM:
5337 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005338 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005340 transform_expansion = transform->minlen;
5341 break;
5342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005344
5345 block_size = mbedtls_cipher_get_block_size(
5346 &transform->cipher_ctx_enc );
5347
Hanno Becker3136ede2018-08-17 15:28:19 +01005348 /* Expansion due to the addition of the MAC. */
5349 transform_expansion += transform->maclen;
5350
5351 /* Expansion due to the addition of CBC padding;
5352 * Theoretically up to 256 bytes, but we never use
5353 * more than the block size of the underlying cipher. */
5354 transform_expansion += block_size;
5355
5356 /* For TLS 1.1 or higher, an explicit IV is added
5357 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005358#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5359 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005360 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005361#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005362
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005363 break;
5364
5365 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005366 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005367 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005368 }
5369
Hanno Beckera0e20d02019-05-15 14:03:01 +01005370#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005371 if( transform->out_cid_len != 0 )
5372 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005373#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005374
Hanno Becker5903de42019-05-03 14:46:38 +01005375 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005376}
5377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005378#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005379/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005380 * Check record counters and renegotiate if they're above the limit.
5381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005382static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005383{
Hanno Beckerdd772292020-02-05 10:38:31 +00005384 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005385 int in_ctr_cmp;
5386 int out_ctr_cmp;
5387
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005388 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5389 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005390 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005391 {
5392 return( 0 );
5393 }
5394
Andres AG2196c7f2016-12-15 17:01:16 +00005395 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5396 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005397 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005398 ssl->conf->renego_period + ep_len, 8 - ep_len );
5399
5400 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005401 {
5402 return( 0 );
5403 }
5404
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005405 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005406 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005407}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005408#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005409
5410/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005411 * Receive application data decrypted from the SSL layer
5412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005414{
Janos Follath865b3eb2019-12-16 11:46:15 +00005415 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005416 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005417
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005418 if( ssl == NULL || ssl->conf == NULL )
5419 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005421 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005424 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005425 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005426 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005427 return( ret );
5428
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005429 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005431 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005432 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005433 return( ret );
5434 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005435 }
5436#endif
5437
Hanno Becker4a810fb2017-05-24 16:27:30 +01005438 /*
5439 * Check if renegotiation is necessary and/or handshake is
5440 * in process. If yes, perform/continue, and fall through
5441 * if an unexpected packet is received while the client
5442 * is waiting for the ServerHello.
5443 *
5444 * (There is no equivalent to the last condition on
5445 * the server-side as it is not treated as within
5446 * a handshake while waiting for the ClientHello
5447 * after a renegotiation request.)
5448 */
5449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005451 ret = ssl_check_ctr_renegotiate( ssl );
5452 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5453 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005454 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005456 return( ret );
5457 }
5458#endif
5459
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005460 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005461 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005463 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5464 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005465 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005467 return( ret );
5468 }
5469 }
5470
Hanno Beckere41158b2017-10-23 13:30:32 +01005471 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005472 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005473 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005474 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005475 if( ssl->f_get_timer != NULL &&
5476 ssl->f_get_timer( ssl->p_timer ) == -1 )
5477 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005478 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005479 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005480
Hanno Becker327c93b2018-08-15 13:56:18 +01005481 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005482 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005483 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5484 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005485
Hanno Becker4a810fb2017-05-24 16:27:30 +01005486 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5487 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005488 }
5489
5490 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005492 {
5493 /*
5494 * OpenSSL sends empty messages to randomize the IV
5495 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005496 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005499 return( 0 );
5500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005501 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005502 return( ret );
5503 }
5504 }
5505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005507 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005509
Hanno Becker4a810fb2017-05-24 16:27:30 +01005510 /*
5511 * - For client-side, expect SERVER_HELLO_REQUEST.
5512 * - For server-side, expect CLIENT_HELLO.
5513 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5514 */
5515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005517 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005518 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005519 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005520 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005522
5523 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005524#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005525 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005526 {
5527 continue;
5528 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005529#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005530 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005531 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005532#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005533
Hanno Becker4a810fb2017-05-24 16:27:30 +01005534#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005535 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005536 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005537 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005539
5540 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005541#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005542 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005543 {
5544 continue;
5545 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005546#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005548 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005549#endif /* MBEDTLS_SSL_SRV_C */
5550
Hanno Becker21df7f92017-10-17 11:03:26 +01005551#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005552 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005553 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5554 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5555 ssl->conf->allow_legacy_renegotiation ==
5556 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5557 {
5558 /*
5559 * Accept renegotiation request
5560 */
Paul Bakker48916f92012-09-16 19:57:18 +00005561
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005562 /* DTLS clients need to know renego is server-initiated */
5563#if defined(MBEDTLS_SSL_PROTO_DTLS)
5564 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5565 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5566 {
5567 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5568 }
5569#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005570 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005571 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5572 ret != 0 )
5573 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005574 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5575 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005576 return( ret );
5577 }
5578 }
5579 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005580#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005581 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005582 /*
5583 * Refuse renegotiation
5584 */
5585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005586 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005588#if defined(MBEDTLS_SSL_PROTO_SSL3)
5589 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005590 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005591 /* SSLv3 does not have a "no_renegotiation" warning, so
5592 we send a fatal alert and abort the connection. */
5593 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5594 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5595 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005596 }
5597 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005598#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5599#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5600 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5601 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005602 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005603 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5604 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5605 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005606 {
5607 return( ret );
5608 }
Paul Bakker48916f92012-09-16 19:57:18 +00005609 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005610 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005611#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5612 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5615 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005616 }
Paul Bakker48916f92012-09-16 19:57:18 +00005617 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005618
Hanno Becker90333da2017-10-10 11:27:13 +01005619 /* At this point, we don't know whether the renegotiation has been
5620 * completed or not. The cases to consider are the following:
5621 * 1) The renegotiation is complete. In this case, no new record
5622 * has been read yet.
5623 * 2) The renegotiation is incomplete because the client received
5624 * an application data record while awaiting the ServerHello.
5625 * 3) The renegotiation is incomplete because the client received
5626 * a non-handshake, non-application data message while awaiting
5627 * the ServerHello.
5628 * In each of these case, looping will be the proper action:
5629 * - For 1), the next iteration will read a new record and check
5630 * if it's application data.
5631 * - For 2), the loop condition isn't satisfied as application data
5632 * is present, hence continue is the same as break
5633 * - For 3), the loop condition is satisfied and read_record
5634 * will re-deliver the message that was held back by the client
5635 * when expecting the ServerHello.
5636 */
5637 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005638 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005639#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005641 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005642 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005643 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005644 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005645 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005646 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005647 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005648 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005649 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005650 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005651 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005652#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005654 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5655 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005656 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005657 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005658 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005659 }
5660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005661 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005662 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5664 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005665 }
5666
5667 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005668
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005669 /* We're going to return something now, cancel timer,
5670 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005671 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005672 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005673
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005674#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005675 /* If we requested renego but received AppData, resend HelloRequest.
5676 * Do it now, after setting in_offt, to avoid taking this branch
5677 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005678#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005679 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005680 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005681 {
Hanno Becker786300f2020-02-05 10:46:40 +00005682 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005683 {
Hanno Becker786300f2020-02-05 10:46:40 +00005684 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5685 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005686 return( ret );
5687 }
5688 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005690#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005691 }
5692
5693 n = ( len < ssl->in_msglen )
5694 ? len : ssl->in_msglen;
5695
5696 memcpy( buf, ssl->in_offt, n );
5697 ssl->in_msglen -= n;
5698
gabor-mezei-arma3214132020-07-15 10:55:00 +02005699 /* Zeroising the plaintext buffer to erase unused application data
5700 from the memory. */
5701 mbedtls_platform_zeroize( ssl->in_offt, n );
5702
Paul Bakker5121ce52009-01-03 21:22:43 +00005703 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005704 {
5705 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005706 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005707 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005708 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005709 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005710 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005711 /* more data available */
5712 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005713 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005716
Paul Bakker23986e52011-04-24 08:57:21 +00005717 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005718}
5719
5720/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005721 * Send application data to be encrypted by the SSL layer, taking care of max
5722 * fragment length and buffer size.
5723 *
5724 * According to RFC 5246 Section 6.2.1:
5725 *
5726 * Zero-length fragments of Application data MAY be sent as they are
5727 * potentially useful as a traffic analysis countermeasure.
5728 *
5729 * Therefore, it is possible that the input message length is 0 and the
5730 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005731 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005732static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005733 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005734{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005735 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5736 const size_t max_len = (size_t) ret;
5737
5738 if( ret < 0 )
5739 {
5740 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5741 return( ret );
5742 }
5743
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005744 if( len > max_len )
5745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005747 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005748 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005749 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005750 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5751 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005752 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005753 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005754 }
5755 else
5756#endif
5757 len = max_len;
5758 }
Paul Bakker887bd502011-06-08 13:10:54 +00005759
Paul Bakker5121ce52009-01-03 21:22:43 +00005760 if( ssl->out_left != 0 )
5761 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005762 /*
5763 * The user has previously tried to send the data and
5764 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5765 * written. In this case, we expect the high-level write function
5766 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005768 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005769 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005770 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005771 return( ret );
5772 }
5773 }
Paul Bakker887bd502011-06-08 13:10:54 +00005774 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005775 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005776 /*
5777 * The user is trying to send a message the first time, so we need to
5778 * copy the data into the internal buffers and setup the data structure
5779 * to keep track of partial writes
5780 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005781 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005782 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005783 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005784
Hanno Becker67bc7c32018-08-06 11:33:50 +01005785 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005786 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005787 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005788 return( ret );
5789 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005790 }
5791
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005792 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005793}
5794
5795/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005796 * Write application data, doing 1/n-1 splitting if necessary.
5797 *
5798 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005799 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005800 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005802#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005803static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005804 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005805{
Janos Follath865b3eb2019-12-16 11:46:15 +00005806 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005807
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005808 if( ssl->conf->cbc_record_splitting ==
5809 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005810 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005811 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5812 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5813 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005814 {
5815 return( ssl_write_real( ssl, buf, len ) );
5816 }
5817
5818 if( ssl->split_done == 0 )
5819 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005820 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005821 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005822 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005823 }
5824
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005825 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5826 return( ret );
5827 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005828
5829 return( ret + 1 );
5830}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005831#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005832
5833/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005834 * Write application data (public-facing wrapper)
5835 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005836int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005837{
Janos Follath865b3eb2019-12-16 11:46:15 +00005838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005839
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005841
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005842 if( ssl == NULL || ssl->conf == NULL )
5843 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5844
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005845#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005846 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5847 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005848 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005849 return( ret );
5850 }
5851#endif
5852
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005853 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005854 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005855 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005856 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005857 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005858 return( ret );
5859 }
5860 }
5861
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005862#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005863 ret = ssl_write_split( ssl, buf, len );
5864#else
5865 ret = ssl_write_real( ssl, buf, len );
5866#endif
5867
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005869
5870 return( ret );
5871}
5872
5873/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005874 * Notify the peer that the connection is being closed
5875 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005876int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005877{
Janos Follath865b3eb2019-12-16 11:46:15 +00005878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005879
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005880 if( ssl == NULL || ssl->conf == NULL )
5881 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005884
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005885 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005886 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005888 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005890 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5891 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5892 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005893 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005894 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005895 return( ret );
5896 }
5897 }
5898
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005900
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005901 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005902}
5903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005904void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005905{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005906 if( transform == NULL )
5907 return;
5908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005909#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005910 deflateEnd( &transform->ctx_deflate );
5911 inflateEnd( &transform->ctx_inflate );
5912#endif
5913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005914 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5915 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005916
Hanno Beckerd56ed242018-01-03 15:32:51 +00005917#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005918 mbedtls_md_free( &transform->md_ctx_enc );
5919 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005920#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005921
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005922 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005923}
5924
Hanno Becker0271f962018-08-16 13:23:47 +01005925#if defined(MBEDTLS_SSL_PROTO_DTLS)
5926
Hanno Becker533ab5f2020-02-05 10:49:13 +00005927void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005928{
5929 unsigned offset;
5930 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5931
5932 if( hs == NULL )
5933 return;
5934
Hanno Becker283f5ef2018-08-24 09:34:47 +01005935 ssl_free_buffered_record( ssl );
5936
Hanno Becker0271f962018-08-16 13:23:47 +01005937 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005938 ssl_buffering_free_slot( ssl, offset );
5939}
5940
5941static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5942 uint8_t slot )
5943{
5944 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5945 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005946
5947 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5948 return;
5949
Hanno Beckere605b192018-08-21 15:59:07 +01005950 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005951 {
Hanno Beckere605b192018-08-21 15:59:07 +01005952 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005953 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005954 mbedtls_free( hs_buf->data );
5955 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005956 }
5957}
5958
5959#endif /* MBEDTLS_SSL_PROTO_DTLS */
5960
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005961/*
5962 * Convert version numbers to/from wire format
5963 * and, for DTLS, to/from TLS equivalent.
5964 *
5965 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005966 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005967 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5968 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005970void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005971 unsigned char ver[2] )
5972{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005973#if defined(MBEDTLS_SSL_PROTO_DTLS)
5974 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005975 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005976 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005977 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5978
5979 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5980 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5981 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005982 else
5983#else
5984 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005985#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005986 {
5987 ver[0] = (unsigned char) major;
5988 ver[1] = (unsigned char) minor;
5989 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005990}
5991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005992void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005993 const unsigned char ver[2] )
5994{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005995#if defined(MBEDTLS_SSL_PROTO_DTLS)
5996 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005997 {
5998 *major = 255 - ver[0] + 2;
5999 *minor = 255 - ver[1] + 1;
6000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006001 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006002 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
6003 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006004 else
6005#else
6006 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006007#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006008 {
6009 *major = ver[0];
6010 *minor = ver[1];
6011 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006012}
6013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006014#endif /* MBEDTLS_SSL_TLS_C */