blob: dbef29b3f9673c78381211e7c5312a183002ebd6 [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/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020089MBEDTLS_CHECK_RETURN_CRITICAL
TRodziewicz4ca18aa2021-05-20 14:46:20 +020090static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
91 unsigned char *buf,
92 size_t len,
93 mbedtls_record *rec );
94
95int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t buflen )
98{
99 int ret = 0;
100 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
101 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
102
103 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200104 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200105 */
106 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
107 {
108 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
109 goto exit;
110 }
111#if defined(MBEDTLS_SSL_PROTO_DTLS)
112 else
113 {
114 mbedtls_record rec;
115
116 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
117 if( ret != 0 )
118 {
119 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
120 goto exit;
121 }
122
123 if( ssl->transform_in != NULL )
124 {
125 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
126 if( ret != 0 )
127 {
128 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
129 goto exit;
130 }
131 }
132 }
133#endif /* MBEDTLS_SSL_PROTO_DTLS */
134
135exit:
136 /* On success, we have decrypted the buffer in-place, so make
137 * sure we don't leak any plaintext data. */
138 mbedtls_platform_zeroize( buf, buflen );
139
140 /* For the purpose of this API, treat messages with unexpected CID
141 * as well as such from future epochs as unexpected. */
142 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
143 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
144 {
145 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
146 }
147
148 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
149 return( ret );
150}
151
Hanno Becker67bc7c32018-08-06 11:33:50 +0100152#define SSL_DONT_FORCE_FLUSH 0
153#define SSL_FORCE_FLUSH 1
154
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100156
Hanno Beckerd5847772018-08-28 10:09:23 +0100157/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100158static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
159 uint8_t slot );
160static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200161MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100162static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200163MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100164static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200165MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100166static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200167MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker519f15d2019-07-11 12:43:20 +0100168static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
169 mbedtls_record const *rec );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200170MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100171static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100172
Hanno Becker11682cc2018-08-22 14:41:02 +0100173static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100174{
Hanno Becker89490712020-02-05 10:50:12 +0000175 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000176#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
177 size_t out_buf_len = ssl->out_buf_len;
178#else
179 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
180#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100181
Darryl Greenb33cc762019-11-28 14:29:44 +0000182 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100183 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100184
Darryl Greenb33cc762019-11-28 14:29:44 +0000185 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100186}
187
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200188MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker67bc7c32018-08-06 11:33:50 +0100189static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
190{
Hanno Becker11682cc2018-08-22 14:41:02 +0100191 size_t const bytes_written = ssl->out_left;
192 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100193
194 /* Double-check that the write-index hasn't gone
195 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100196 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100197 {
198 /* Should never happen... */
199 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
200 }
201
202 return( (int) ( mtu - bytes_written ) );
203}
204
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200205MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
207{
Janos Follath865b3eb2019-12-16 11:46:15 +0000208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100209 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400210 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100211
212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400213 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100214
215 if( max_len > mfl )
216 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100217
218 /* By the standard (RFC 6066 Sect. 4), the MFL extension
219 * only limits the maximum record payload size, so in theory
220 * we would be allowed to pack multiple records of payload size
221 * MFL into a single datagram. However, this would mean that there's
222 * no way to explicitly communicate MTU restrictions to the peer.
223 *
224 * The following reduction of max_len makes sure that we never
225 * write datagrams larger than MFL + Record Expansion Overhead.
226 */
227 if( max_len <= ssl->out_left )
228 return( 0 );
229
230 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100231#endif
232
233 ret = ssl_get_remaining_space_in_datagram( ssl );
234 if( ret < 0 )
235 return( ret );
236 remaining = (size_t) ret;
237
238 ret = mbedtls_ssl_get_record_expansion( ssl );
239 if( ret < 0 )
240 return( ret );
241 expansion = (size_t) ret;
242
243 if( remaining <= expansion )
244 return( 0 );
245
246 remaining -= expansion;
247 if( remaining >= max_len )
248 remaining = max_len;
249
250 return( (int) remaining );
251}
252
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200253/*
254 * Double the retransmit timeout value, within the allowed range,
255 * returning -1 if the maximum value has already been reached.
256 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200257MBEDTLS_CHECK_RETURN_CRITICAL
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é-Gonnard0098e7d2014-10-28 13:08:59 +0100301/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000302 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200303 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000304
Ronald Cron6f135e12021-12-08 16:57:54 +0100305#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100306
307static size_t ssl_compute_padding_length( size_t len,
308 size_t granularity )
309{
310 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
311}
312
Hanno Becker581bc1b2020-05-04 12:20:03 +0100313/* This functions transforms a (D)TLS plaintext fragment and a record content
314 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
315 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
316 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100317 *
318 * struct {
319 * opaque content[DTLSPlaintext.length];
320 * ContentType real_type;
321 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100322 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100323 *
324 * Input:
325 * - `content`: The beginning of the buffer holding the
326 * plaintext to be wrapped.
327 * - `*content_size`: The length of the plaintext in Bytes.
328 * - `max_len`: The number of Bytes available starting from
329 * `content`. This must be `>= *content_size`.
330 * - `rec_type`: The desired record content type.
331 *
332 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100333 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
334 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100335 *
336 * Returns:
337 * - `0` on success.
338 * - A negative error code if `max_len` didn't offer enough space
339 * for the expansion.
340 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200341MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker581bc1b2020-05-04 12:20:03 +0100342static int ssl_build_inner_plaintext( unsigned char *content,
343 size_t *content_size,
344 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100345 uint8_t rec_type,
346 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100347{
348 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100349
350 /* Write real content type */
351 if( remaining == 0 )
352 return( -1 );
353 content[ len ] = rec_type;
354 len++;
355 remaining--;
356
357 if( remaining < pad )
358 return( -1 );
359 memset( content + len, 0, pad );
360 len += pad;
361 remaining -= pad;
362
363 *content_size = len;
364 return( 0 );
365}
366
Hanno Becker581bc1b2020-05-04 12:20:03 +0100367/* This function parses a (D)TLSInnerPlaintext structure.
368 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200369MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker581bc1b2020-05-04 12:20:03 +0100370static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100371 size_t *content_size,
372 uint8_t *rec_type )
373{
374 size_t remaining = *content_size;
375
376 /* Determine length of padding by skipping zeroes from the back. */
377 do
378 {
379 if( remaining == 0 )
380 return( -1 );
381 remaining--;
382 } while( content[ remaining ] == 0 );
383
384 *content_size = remaining;
385 *rec_type = content[ remaining ];
386
387 return( 0 );
388}
Ronald Cron6f135e12021-12-08 16:57:54 +0100389#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100390
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100391/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100392 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000393static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100394 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100395 mbedtls_record *rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400396 mbedtls_ssl_protocol_version
397 tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000398 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000399{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100400 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100401 *
402 * additional_data = seq_num + TLSCompressed.type +
403 * TLSCompressed.version + TLSCompressed.length;
404 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100405 * For the CID extension, this is extended as follows
406 * (quoting draft-ietf-tls-dtls-connection-id-05,
407 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100408 *
409 * additional_data = seq_num + DTLSPlaintext.type +
410 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100411 * cid +
412 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100413 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100414 *
415 * For TLS 1.3, the record sequence number is dropped from the AAD
416 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000417 * Moreover, the additional data involves the length of the TLS
418 * ciphertext, not the TLS plaintext as in earlier versions.
419 * Quoting RFC 8446 (TLS 1.3):
420 *
421 * additional_data = TLSCiphertext.opaque_type ||
422 * TLSCiphertext.legacy_record_version ||
423 * TLSCiphertext.length
424 *
425 * We pass the tag length to this function in order to compute the
426 * ciphertext length from the inner plaintext length rec->data_len via
427 *
428 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
429 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100430 */
431
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100432 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000433 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434
Ronald Cron6f135e12021-12-08 16:57:54 +0100435#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400436 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000437 {
438 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
439 * which differs from the length of the TLSInnerPlaintext
440 * by the length of the authentication tag. */
441 ad_len_field += taglen;
442 }
443 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100444#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100445 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400446 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000447 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100448 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
449 cur += sizeof( rec->ctr );
450 }
451
452 *cur = rec->type;
453 cur++;
454
455 memcpy( cur, rec->ver, sizeof( rec->ver ) );
456 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100457
Hanno Beckera0e20d02019-05-15 14:03:01 +0100458#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100459 if( rec->cid_len != 0 )
460 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100461 memcpy( cur, rec->cid, rec->cid_len );
462 cur += rec->cid_len;
463
464 *cur = rec->cid_len;
465 cur++;
466
Joe Subbiani6dd73642021-07-19 11:56:54 +0100467 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100468 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100469 }
470 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100471#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100472 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100473 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100474 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100475 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100476
477 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000478}
479
Hanno Becker67a37db2020-05-28 16:27:07 +0100480#if defined(MBEDTLS_GCM_C) || \
481 defined(MBEDTLS_CCM_C) || \
482 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200483MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100484static int ssl_transform_aead_dynamic_iv_is_explicit(
485 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100486{
Hanno Becker17263802020-05-28 07:05:48 +0100487 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100488}
489
Hanno Becker17263802020-05-28 07:05:48 +0100490/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
491 *
492 * Concretely, this occurs in two variants:
493 *
494 * a) Fixed and dynamic IV lengths add up to total IV length, giving
495 * IV = fixed_iv || dynamic_iv
496 *
Hanno Becker15952812020-06-04 13:31:46 +0100497 * This variant is used in TLS 1.2 when used with GCM or CCM.
498 *
Hanno Becker17263802020-05-28 07:05:48 +0100499 * b) Fixed IV lengths matches total IV length, giving
500 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100501 *
502 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
503 *
504 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100505 *
506 * This function has the precondition that
507 *
508 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
509 *
510 * which has to be ensured by the caller. If this precondition
511 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100512 */
513static void ssl_build_record_nonce( unsigned char *dst_iv,
514 size_t dst_iv_len,
515 unsigned char const *fixed_iv,
516 size_t fixed_iv_len,
517 unsigned char const *dynamic_iv,
518 size_t dynamic_iv_len )
519{
520 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100521
522 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100523 memset( dst_iv, 0, dst_iv_len );
524 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100525
Hanno Becker17263802020-05-28 07:05:48 +0100526 dst_iv += dst_iv_len - dynamic_iv_len;
527 for( i = 0; i < dynamic_iv_len; i++ )
528 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100529}
Hanno Becker67a37db2020-05-28 16:27:07 +0100530#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100531
Hanno Beckera18d1322018-01-03 14:27:32 +0000532int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
533 mbedtls_ssl_transform *transform,
534 mbedtls_record *rec,
535 int (*f_rng)(void *, unsigned char *, size_t),
536 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000537{
Neil Armstrong136f8402022-03-30 10:58:01 +0200538 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100539 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000540 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100541 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100542 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000543 size_t post_avail;
544
545 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000546#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200547 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000548 ((void) ssl);
549#endif
550
551 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200552 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200553#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200554 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000555 ((void) f_rng);
556 ((void) p_rng);
557#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000560
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000561 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100562 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
564 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
565 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100566 if( rec == NULL
567 || rec->buf == NULL
568 || rec->buf_len < rec->data_offset
569 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100570#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100571 || rec->cid_len != 0
572#endif
573 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000574 {
575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100577 }
578
Neil Armstrongab555e02022-04-04 11:07:59 +0200579 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Neil Armstrong136f8402022-03-30 10:58:01 +0200580
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100582 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000584 data, rec->data_len );
585
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000586 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
587 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
589 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000590 rec->data_len,
591 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000592 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
593 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100594
Hanno Becker92313402020-05-20 13:58:58 +0100595 /* The following two code paths implement the (D)TLSInnerPlaintext
596 * structure present in TLS 1.3 and DTLS 1.2 + CID.
597 *
598 * See ssl_build_inner_plaintext() for more information.
599 *
600 * Note that this changes `rec->data_len`, and hence
601 * `post_avail` needs to be recalculated afterwards.
602 *
603 * Note also that the two code paths cannot occur simultaneously
604 * since they apply to different versions of the protocol. There
605 * is hence no risk of double-addition of the inner plaintext.
606 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100607#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400608 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100609 {
Hanno Becker13996922020-05-28 16:15:19 +0100610 size_t padding =
611 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200612 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100613 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100614 &rec->data_len,
615 post_avail,
616 rec->type,
617 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100618 {
619 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
620 }
621
622 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
623 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100624#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100625
Hanno Beckera0e20d02019-05-15 14:03:01 +0100626#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100627 /*
628 * Add CID information
629 */
630 rec->cid_len = transform->out_cid_len;
631 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
632 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633
634 if( rec->cid_len != 0 )
635 {
Hanno Becker13996922020-05-28 16:15:19 +0100636 size_t padding =
637 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200638 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100639 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100640 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100641 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100642 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100643 * Note that this changes `rec->data_len`, and hence
644 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100645 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100646 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100647 &rec->data_len,
648 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100649 rec->type,
650 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100651 {
652 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
653 }
654
655 rec->type = MBEDTLS_SSL_MSG_CID;
656 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100657#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100658
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100659 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
660
Paul Bakker5121ce52009-01-03 21:22:43 +0000661 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100662 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000663 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +0200665 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
666 ssl_mode == MBEDTLS_SSL_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000667 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000668 if( post_avail < transform->maclen )
669 {
670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
671 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
672 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200674 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100676#if defined(MBEDTLS_USE_PSA_CRYPTO)
677 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
679 size_t sign_mac_length = 0;
680#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +0000681
TRodziewicz345165c2021-07-06 13:42:11 +0200682 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400683 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000684 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000685
Neil Armstrong26e6d672022-02-23 09:30:33 +0100686#if defined(MBEDTLS_USE_PSA_CRYPTO)
687 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
688 transform->psa_mac_alg );
689 if( status != PSA_SUCCESS )
690 goto hmac_failed_etm_disabled;
691
692 status = psa_mac_update( &operation, add_data, add_data_len );
693 if( status != PSA_SUCCESS )
694 goto hmac_failed_etm_disabled;
695
696 status = psa_mac_update( &operation, data, rec->data_len );
697 if( status != PSA_SUCCESS )
698 goto hmac_failed_etm_disabled;
699
700 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
701 &sign_mac_length );
702 if( status != PSA_SUCCESS )
703 goto hmac_failed_etm_disabled;
704#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100705 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
706 add_data_len );
707 if( ret != 0 )
708 goto hmac_failed_etm_disabled;
709 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
710 if( ret != 0 )
711 goto hmac_failed_etm_disabled;
712 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
713 if( ret != 0 )
714 goto hmac_failed_etm_disabled;
715 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
716 if( ret != 0 )
717 goto hmac_failed_etm_disabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100718#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000719
TRodziewicz345165c2021-07-06 13:42:11 +0200720 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200721#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200722
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000723 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
724 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200725
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 rec->data_len += transform->maclen;
727 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100728 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100729
730 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100731 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +0100732#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +0100733 ret = psa_ssl_status_to_mbedtls( status );
734 status = psa_mac_abort( &operation );
735 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +0100736 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +0100737#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100738 if( ret != 0 )
739 {
740 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
741 return( ret );
742 }
Paul Bakker577e0062013-08-28 11:57:20 +0200743 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000744#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000745
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200746 /*
747 * Encrypt
748 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000749#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +0200750 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000751 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000752 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753 "including %d bytes of padding",
754 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000755
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100756 /* The only supported stream cipher is "NULL",
757 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000758 }
Paul Bakker68884e32013-01-07 18:20:04 +0100759 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000760#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000761
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200762#if defined(MBEDTLS_GCM_C) || \
763 defined(MBEDTLS_CCM_C) || \
764 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +0200765 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000766 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200767 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100768 unsigned char *dynamic_iv;
769 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100770 int dynamic_iv_is_explicit =
771 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100772#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100774#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000776
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100777 /* Check that there's space for the authentication tag. */
778 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 {
780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
781 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
782 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000783
Paul Bakker68884e32013-01-07 18:20:04 +0100784 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100785 * Build nonce for AEAD encryption.
786 *
787 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
788 * part of the IV is prepended to the ciphertext and
789 * can be chosen freely - in particular, it need not
790 * agree with the record sequence number.
791 * However, since ChaChaPoly as well as all AEAD modes
792 * in TLS 1.3 use the record sequence number as the
793 * dynamic part of the nonce, we uniformly use the
794 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100795 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100796 dynamic_iv = rec->ctr;
797 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200798
Hanno Becker17263802020-05-28 07:05:48 +0100799 ssl_build_record_nonce( iv, sizeof( iv ),
800 transform->iv_enc,
801 transform->fixed_ivlen,
802 dynamic_iv,
803 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100804
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100805 /*
806 * Build additional data for AEAD encryption.
807 * This depends on the TLS version.
808 */
809 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400810 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000811 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100812
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200813 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100814 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200815 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100816 dynamic_iv,
817 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000818 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100819 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000820 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200821 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000822 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000823
Paul Bakker68884e32013-01-07 18:20:04 +0100824 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200825 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200826 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100827#if defined(MBEDTLS_USE_PSA_CRYPTO)
828 status = psa_aead_encrypt( transform->psa_key_enc,
829 transform->psa_alg,
830 iv, transform->ivlen,
831 add_data, add_data_len,
832 data, rec->data_len,
833 data, rec->buf_len - (data - rec->buf),
834 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000835
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100836 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100837 {
838 ret = psa_ssl_status_to_mbedtls( status );
839 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
840 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100841 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100842#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100843 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100845 add_data, add_data_len,
846 data, rec->data_len, /* src */
847 data, rec->buf_len - (data - rec->buf), /* dst */
848 &rec->data_len,
849 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200850 {
TRodziewicz18efb732021-04-29 23:12:19 +0200851 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200852 return( ret );
853 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100854#endif /* MBEDTLS_USE_PSA_CRYPTO */
855
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000856 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100857 data + rec->data_len - transform->taglen,
858 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100859 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000860 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100861
862 /*
863 * Prefix record content with dynamic IV in case it is explicit.
864 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100865 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100866 {
867 if( rec->data_offset < dynamic_iv_len )
868 {
869 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
870 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
871 }
872
873 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
874 rec->data_offset -= dynamic_iv_len;
875 rec->data_len += dynamic_iv_len;
876 }
877
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100878 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000879 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000880 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100881#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200882#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +0200883 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
884 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000885 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000886 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000887 size_t padlen, i;
888 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100889#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100890 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100891 size_t part_len;
892 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
893#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000894
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000895 /* Currently we're always using minimal padding
896 * (up to 255 bytes would be allowed). */
897 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
898 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000899 padlen = 0;
900
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000901 /* Check there's enough space in the buffer for the padding. */
902 if( post_avail < padlen + 1 )
903 {
904 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
905 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
906 }
907
Paul Bakker5121ce52009-01-03 21:22:43 +0000908 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000910
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000911 rec->data_len += padlen + 1;
912 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000913
TRodziewicz0f82ec62021-05-12 17:49:18 +0200914#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000915 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200916 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000917 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000918 */
TRodziewicz345165c2021-07-06 13:42:11 +0200919 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000920 {
TRodziewicz345165c2021-07-06 13:42:11 +0200921 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
922 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000923 }
TRodziewicz345165c2021-07-06 13:42:11 +0200924
925 if( rec->data_offset < transform->ivlen )
926 {
927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
928 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
929 }
930
931 /*
932 * Generate IV
933 */
934 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
935 if( ret != 0 )
936 return( ret );
937
938 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200939#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000940
Paul Elliottd48d5c62021-01-07 14:47:05 +0000941 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
942 "including %" MBEDTLS_PRINTF_SIZET
943 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000944 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200945 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000946
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100947#if defined(MBEDTLS_USE_PSA_CRYPTO)
948 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100949 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100950
951 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100952 {
953 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100954 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_encrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100955 return( ret );
956 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100957
958 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
959
960 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100961 {
962 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100963 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100964 return( ret );
965
966 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100967
968 status = psa_cipher_update( &cipher_op,
969 data, rec->data_len,
970 data, rec->data_len, &olen );
971
972 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100973 {
974 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100975 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100976 return( ret );
977
978 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100979
980 status = psa_cipher_finish( &cipher_op,
981 data + olen, rec->data_len - olen,
982 &part_len );
983
984 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100985 {
986 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100987 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100988 return( ret );
989
990 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100991
992 olen += part_len;
993#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000994 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
995 transform->iv_enc,
996 transform->ivlen,
997 data, rec->data_len,
998 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200999 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001001 return( ret );
1002 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001003#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001004
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001005 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1008 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001009 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001010
TRodziewicz0f82ec62021-05-12 17:49:18 +02001011 data -= transform->ivlen;
1012 rec->data_offset -= transform->ivlen;
1013 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001016 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001017 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001018 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001019#if defined(MBEDTLS_USE_PSA_CRYPTO)
1020 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1021 size_t sign_mac_length = 0;
1022#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001023
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001024 /*
1025 * MAC(MAC_write_key, seq_num +
1026 * TLSCipherText.type +
1027 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001028 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001029 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001030 * ENC(content + padding + padding_length));
1031 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001032
1033 if( post_avail < transform->maclen)
1034 {
1035 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1036 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1037 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001038
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001039 ssl_extract_add_data_from_record( add_data, &add_data_len,
Glenn Strauss07c64162022-03-14 12:34:51 -04001040 rec, transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001041 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001044 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001045 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001046#if defined(MBEDTLS_USE_PSA_CRYPTO)
1047 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
1048 transform->psa_mac_alg );
1049 if( status != PSA_SUCCESS )
1050 goto hmac_failed_etm_enabled;
1051
1052 status = psa_mac_update( &operation, add_data, add_data_len );
1053 if( status != PSA_SUCCESS )
1054 goto hmac_failed_etm_enabled;
1055
1056 status = psa_mac_update( &operation, data, rec->data_len );
1057 if( status != PSA_SUCCESS )
1058 goto hmac_failed_etm_enabled;
1059
1060 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
1061 &sign_mac_length );
1062 if( status != PSA_SUCCESS )
1063 goto hmac_failed_etm_enabled;
1064#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001065
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001066 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1067 add_data_len );
1068 if( ret != 0 )
1069 goto hmac_failed_etm_enabled;
1070 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1071 data, rec->data_len );
1072 if( ret != 0 )
1073 goto hmac_failed_etm_enabled;
1074 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1075 if( ret != 0 )
1076 goto hmac_failed_etm_enabled;
1077 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1078 if( ret != 0 )
1079 goto hmac_failed_etm_enabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001080#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001081
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001082 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001083
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001084 rec->data_len += transform->maclen;
1085 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001086 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001087
1088 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001089 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001090#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001091 ret = psa_ssl_status_to_mbedtls( status );
1092 status = psa_mac_abort( &operation );
1093 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001094 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +01001095#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001096 if( ret != 0 )
1097 {
1098 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1099 return( ret );
1100 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001101 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001103 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001104 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001105#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001106 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001109 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001110
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001111 /* Make extra sure authentication was performed, exactly once */
1112 if( auth_done != 1 )
1113 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1115 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001116 }
1117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001119
1120 return( 0 );
1121}
1122
Hanno Becker605949f2019-07-12 08:23:59 +01001123int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001124 mbedtls_ssl_transform *transform,
1125 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001126{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001127 size_t olen;
Neil Armstrong136f8402022-03-30 10:58:01 +02001128 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001129 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001130
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001131 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001132#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001133 size_t padlen = 0, correct = 1;
1134#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001135 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001136 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001137 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001138
Hanno Beckera18d1322018-01-03 14:27:32 +00001139#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001140 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001141 ((void) ssl);
1142#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001145 if( rec == NULL ||
1146 rec->buf == NULL ||
1147 rec->buf_len < rec->data_offset ||
1148 rec->buf_len - rec->data_offset < rec->data_len )
1149 {
1150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001152 }
1153
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001154 data = rec->buf + rec->data_offset;
Neil Armstrongab555e02022-04-04 11:07:59 +02001155 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Paul Bakker5121ce52009-01-03 21:22:43 +00001156
Hanno Beckera0e20d02019-05-15 14:03:01 +01001157#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001158 /*
1159 * Match record's CID with incoming CID.
1160 */
Hanno Becker938489a2019-05-08 13:02:22 +01001161 if( rec->cid_len != transform->in_cid_len ||
1162 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1163 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001164 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001165 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001166#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001167
Hanno Beckerd086bf02021-03-22 13:01:27 +00001168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +02001169 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001170 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001171 /* The only supported stream cipher is "NULL",
1172 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001173 }
Paul Bakker68884e32013-01-07 18:20:04 +01001174 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001175#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001176#if defined(MBEDTLS_GCM_C) || \
1177 defined(MBEDTLS_CCM_C) || \
1178 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +02001179 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001180 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001181 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001182 unsigned char *dynamic_iv;
1183 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001184#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001186#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001187
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001188 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001189 * Extract dynamic part of nonce for AEAD decryption.
1190 *
1191 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1192 * part of the IV is prepended to the ciphertext and
1193 * can be chosen freely - in particular, it need not
1194 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001195 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001196 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001197 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001198 {
1199 if( rec->data_len < dynamic_iv_len )
1200 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001201 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1202 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001203 rec->data_len,
1204 dynamic_iv_len ) );
1205 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1206 }
1207 dynamic_iv = data;
1208
1209 data += dynamic_iv_len;
1210 rec->data_offset += dynamic_iv_len;
1211 rec->data_len -= dynamic_iv_len;
1212 }
Hanno Becker17263802020-05-28 07:05:48 +01001213 else
1214 {
1215 dynamic_iv = rec->ctr;
1216 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001217
1218 /* Check that there's space for the authentication tag. */
1219 if( rec->data_len < transform->taglen )
1220 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001221 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1222 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001223 rec->data_len,
1224 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001226 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001227 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001228
Hanno Beckerdf8be222020-05-21 15:30:57 +01001229 /*
1230 * Prepare nonce from dynamic and static parts.
1231 */
Hanno Becker17263802020-05-28 07:05:48 +01001232 ssl_build_record_nonce( iv, sizeof( iv ),
1233 transform->iv_dec,
1234 transform->fixed_ivlen,
1235 dynamic_iv,
1236 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001237
Hanno Beckerdf8be222020-05-21 15:30:57 +01001238 /*
1239 * Build additional data for AEAD encryption.
1240 * This depends on the TLS version.
1241 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001242 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001243 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001244 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001245 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001246 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001247
Hanno Beckerd96a6522019-07-10 13:55:25 +01001248 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001249 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001250 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001251 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001252 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001253
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001254 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001255 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001256 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001257
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001258 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001259 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001260 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001261#if defined(MBEDTLS_USE_PSA_CRYPTO)
1262 status = psa_aead_decrypt( transform->psa_key_dec,
1263 transform->psa_alg,
1264 iv, transform->ivlen,
1265 add_data, add_data_len,
1266 data, rec->data_len + transform->taglen,
1267 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001268 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001269
1270 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001271 {
1272 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001273 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001274 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001275 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001276#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001277 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001278 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001279 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001280 data, rec->data_len + transform->taglen, /* src */
1281 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001282 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001283 {
TRodziewicz18efb732021-04-29 23:12:19 +02001284 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001285
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1287 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001288
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001289 return( ret );
1290 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001291#endif /* MBEDTLS_USE_PSA_CRYPTO */
1292
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001293 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001294
Hanno Beckerd96a6522019-07-10 13:55:25 +01001295 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001296 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001297 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001298 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1299 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001300 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001301 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001302 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001304#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001305 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1306 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001308 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001309#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001311 size_t part_len;
1312 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1313#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001314
Paul Bakker5121ce52009-01-03 21:22:43 +00001315 /*
Paul Bakker45829992013-01-03 14:52:21 +01001316 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001317 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001318#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001319 /* The ciphertext is prefixed with the CBC IV. */
1320 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001321#endif
Paul Bakker45829992013-01-03 14:52:21 +01001322
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001323 /* Size considerations:
1324 *
1325 * - The CBC cipher text must not be empty and hence
1326 * at least of size transform->ivlen.
1327 *
1328 * Together with the potential IV-prefix, this explains
1329 * the first of the two checks below.
1330 *
1331 * - The record must contain a MAC, either in plain or
1332 * encrypted, depending on whether Encrypt-then-MAC
1333 * is used or not.
1334 * - If it is, the message contains the IV-prefix,
1335 * the CBC ciphertext, and the MAC.
1336 * - If it is not, the padded plaintext, and hence
1337 * the CBC ciphertext, has at least length maclen + 1
1338 * because there is at least the padding length byte.
1339 *
1340 * As the CBC ciphertext is not empty, both cases give the
1341 * lower bound minlen + maclen + 1 on the record size, which
1342 * we test for in the second check below.
1343 */
1344 if( rec->data_len < minlen + transform->ivlen ||
1345 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001346 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001347 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1348 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1349 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001350 "+ 1 ) ( + expl IV )", rec->data_len,
1351 transform->ivlen,
1352 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001353 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001354 }
1355
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001356 /*
1357 * Authenticate before decrypt if enabled
1358 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001360 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001361 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001362#if defined(MBEDTLS_USE_PSA_CRYPTO)
1363 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1364#else
Hanno Becker992b6872017-11-09 18:57:39 +00001365 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001366#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001369
Hanno Beckerd96a6522019-07-10 13:55:25 +01001370 /* Update data_len in tandem with add_data.
1371 *
1372 * The subtraction is safe because of the previous check
1373 * data_len >= minlen + maclen + 1.
1374 *
1375 * Afterwards, we know that data + data_len is followed by at
1376 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001377 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001378 *
1379 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001380 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001381 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001382 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001383 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001384
Hanno Beckerd96a6522019-07-10 13:55:25 +01001385 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001386 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1387 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001388#if defined(MBEDTLS_USE_PSA_CRYPTO)
1389 status = psa_mac_verify_setup( &operation, transform->psa_mac_dec,
1390 transform->psa_mac_alg );
1391 if( status != PSA_SUCCESS )
1392 goto hmac_failed_etm_enabled;
1393
1394 status = psa_mac_update( &operation, add_data, add_data_len );
1395 if( status != PSA_SUCCESS )
1396 goto hmac_failed_etm_enabled;
1397
1398 status = psa_mac_update( &operation, data, rec->data_len );
1399 if( status != PSA_SUCCESS )
1400 goto hmac_failed_etm_enabled;
1401
1402 /* Compare expected MAC with MAC at the end of the record. */
1403 status = psa_mac_verify_finish( &operation, data + rec->data_len,
1404 transform->maclen );
1405 if( status != PSA_SUCCESS )
1406 goto hmac_failed_etm_enabled;
1407#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001408 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1409 add_data_len );
1410 if( ret != 0 )
1411 goto hmac_failed_etm_enabled;
1412 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001413 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001414 if( ret != 0 )
1415 goto hmac_failed_etm_enabled;
1416 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1417 if( ret != 0 )
1418 goto hmac_failed_etm_enabled;
1419 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1420 if( ret != 0 )
1421 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001422
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001423 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1424 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001425 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001427
Hanno Beckerd96a6522019-07-10 13:55:25 +01001428 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001429 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001430 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001433 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1434 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001435 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001436#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001437 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001438
1439 hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001440#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001441 ret = psa_ssl_status_to_mbedtls( status );
1442 status = psa_mac_abort( &operation );
1443 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001444 ret = psa_ssl_status_to_mbedtls( status );
1445#else
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001446 mbedtls_platform_zeroize( mac_expect, transform->maclen );
Neil Armstrong4313f552022-03-02 15:14:07 +01001447#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001448 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001449 {
1450 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1451 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001452 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001453 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001454 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001456
1457 /*
1458 * Check length sanity
1459 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001460
1461 /* We know from above that data_len > minlen >= 0,
1462 * so the following check in particular implies that
1463 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001464 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001465 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001466 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1467 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001468 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001470 }
1471
TRodziewicz0f82ec62021-05-12 17:49:18 +02001472#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001473 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001474 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001475 */
TRodziewicz345165c2021-07-06 13:42:11 +02001476 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1477 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001478
TRodziewicz345165c2021-07-06 13:42:11 +02001479 data += transform->ivlen;
1480 rec->data_offset += transform->ivlen;
1481 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001482#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001483
Hanno Beckerd96a6522019-07-10 13:55:25 +01001484 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1485
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001486#if defined(MBEDTLS_USE_PSA_CRYPTO)
1487 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001488 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001489
1490 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001491 {
1492 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001493 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001494 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001495 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001496
1497 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1498
1499 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001500 {
1501 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001502 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001503 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001504 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001505
1506 status = psa_cipher_update( &cipher_op,
1507 data, rec->data_len,
1508 data, rec->data_len, &olen );
1509
1510 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001511 {
1512 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001513 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001514 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001515 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001516
1517 status = psa_cipher_finish( &cipher_op,
1518 data + olen, rec->data_len - olen,
1519 &part_len );
1520
1521 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001522 {
1523 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001524 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001525 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001526 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001527
1528 olen += part_len;
1529#else
1530
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001531 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1532 transform->iv_dec, transform->ivlen,
1533 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001534 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001536 return( ret );
1537 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001538#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001539
Hanno Beckerd96a6522019-07-10 13:55:25 +01001540 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001541 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001542 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1544 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001545 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001546
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001547 /* Safe since data_len >= minlen + maclen + 1, so after having
1548 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001549 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1550 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001551 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001552
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001553 if( auth_done == 1 )
1554 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001555 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001556 rec->data_len,
1557 padlen + 1 );
1558 correct &= mask;
1559 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001560 }
1561 else
Paul Bakker45829992013-01-03 14:52:21 +01001562 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001564 if( rec->data_len < transform->maclen + padlen + 1 )
1565 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1567 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1568 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001569 rec->data_len,
1570 transform->maclen,
1571 padlen + 1 ) );
1572 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001573#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001574
Gabor Mezei90437e32021-10-20 11:59:27 +02001575 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001576 rec->data_len,
1577 transform->maclen + padlen + 1 );
1578 correct &= mask;
1579 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001580 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001581
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001582 padlen++;
1583
1584 /* Regardless of the validity of the padding,
1585 * we have data_len >= padlen here. */
1586
TRodziewicz0f82ec62021-05-12 17:49:18 +02001587#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001588 /* The padding check involves a series of up to 256
1589 * consecutive memory reads at the end of the record
1590 * plaintext buffer. In order to hide the length and
1591 * validity of the padding, always perform exactly
1592 * `min(256,plaintext_len)` reads (but take into account
1593 * only the last `padlen` bytes for the padding check). */
1594 size_t pad_count = 0;
1595 volatile unsigned char* const check = data;
1596
1597 /* Index of first padding byte; it has been ensured above
1598 * that the subtraction is safe. */
1599 size_t const padding_idx = rec->data_len - padlen;
1600 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1601 size_t const start_idx = rec->data_len - num_checks;
1602 size_t idx;
1603
1604 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001605 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001606 /* pad_count += (idx >= padding_idx) &&
1607 * (check[idx] == padlen - 1);
1608 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001609 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1610 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001611 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001612 pad_count += mask & equal;
1613 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001614 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001615
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001617 if( padlen > 0 && correct == 0 )
1618 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001619#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001620 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001621
TRodziewicz0f82ec62021-05-12 17:49:18 +02001622#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001623
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001624 /* If the padding was found to be invalid, padlen == 0
1625 * and the subtraction is safe. If the padding was found valid,
1626 * padlen hasn't been changed and the previous assertion
1627 * data_len >= padlen still holds. */
1628 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001629 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001630 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001631#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001632 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1634 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001635 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001636
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001637#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001638 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001639 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001640#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001641
1642 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001643 * Authenticate if not done yet.
1644 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001645 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001646#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001647 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001648 {
Paul Elliott5260ce22022-05-09 18:15:54 +01001649 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1650 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001651
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001652 /* If the initial value of padlen was such that
1653 * data_len < maclen + padlen + 1, then padlen
1654 * got reset to 1, and the initial check
1655 * data_len >= minlen + maclen + 1
1656 * guarantees that at this point we still
1657 * have at least data_len >= maclen.
1658 *
1659 * If the initial value of padlen was such that
1660 * data_len >= maclen + padlen + 1, then we have
1661 * subtracted either padlen + 1 (if the padding was correct)
1662 * or 0 (if the padding was incorrect) since then,
1663 * hence data_len >= maclen in any case.
1664 */
1665 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001666 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001667 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001668 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001669
TRodziewicz0f82ec62021-05-12 17:49:18 +02001670#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001671 /*
1672 * The next two sizes are the minimum and maximum values of
1673 * data_len over all padlen values.
1674 *
1675 * They're independent of padlen, since we previously did
1676 * data_len -= padlen.
1677 *
1678 * Note that max_len + maclen is never more than the buffer
1679 * length, as we previously did in_msglen -= maclen too.
1680 */
1681 const size_t max_len = rec->data_len + padlen;
1682 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1683
Neil Armstronge8589962022-02-25 15:14:29 +01001684#if defined(MBEDTLS_USE_PSA_CRYPTO)
1685 ret = mbedtls_ct_hmac( transform->psa_mac_dec,
1686 transform->psa_mac_alg,
1687 add_data, add_data_len,
1688 data, rec->data_len, min_len, max_len,
1689 mac_expect );
1690#else
Gabor Mezei90437e32021-10-20 11:59:27 +02001691 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001692 add_data, add_data_len,
1693 data, rec->data_len, min_len, max_len,
1694 mac_expect );
Neil Armstronge8589962022-02-25 15:14:29 +01001695#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001696 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001697 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001698 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001699 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001700 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001701
Gabor Mezei90437e32021-10-20 11:59:27 +02001702 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001703 rec->data_len,
1704 min_len, max_len,
1705 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001706#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001707
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001708#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001709 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001710 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001711#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001712
Gabor Mezei90437e32021-10-20 11:59:27 +02001713 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001714 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001715 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#if defined(MBEDTLS_SSL_DEBUG_ALL)
1717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001718#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001719 correct = 0;
1720 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001721 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001722
1723 hmac_failed_etm_disabled:
1724 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1725 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1726 if( ret != 0 )
1727 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001728 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001729
1730 /*
1731 * Finally check the correct flag
1732 */
1733 if( correct == 0 )
1734 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001735#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001736
1737 /* Make extra sure authentication was performed, exactly once */
1738 if( auth_done != 1 )
1739 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1741 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001742 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001743
Ronald Cron6f135e12021-12-08 16:57:54 +01001744#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04001745 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +01001746 {
1747 /* Remove inner padding and infer true content type. */
1748 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1749 &rec->type );
1750
1751 if( ret != 0 )
1752 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1753 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001754#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001755
Hanno Beckera0e20d02019-05-15 14:03:01 +01001756#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001757 if( rec->cid_len != 0 )
1758 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001759 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1760 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001761 if( ret != 0 )
1762 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1763 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001764#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001767
1768 return( 0 );
1769}
1770
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001771#undef MAC_NONE
1772#undef MAC_PLAINTEXT
1773#undef MAC_CIPHERTEXT
1774
Paul Bakker5121ce52009-01-03 21:22:43 +00001775/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001776 * Fill the input message buffer by appending data to it.
1777 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001778 *
1779 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1780 * available (from this read and/or a previous one). Otherwise, an error code
1781 * is returned (possibly EOF or WANT_READ).
1782 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001783 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1784 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1785 * since we always read a whole datagram at once.
1786 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001787 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001788 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001791{
Janos Follath865b3eb2019-12-16 11:46:15 +00001792 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001793 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001794#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1795 size_t in_buf_len = ssl->in_buf_len;
1796#else
1797 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1798#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001799
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001801
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001802 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001805 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001807 }
1808
Darryl Greenb33cc762019-11-28 14:29:44 +00001809 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001810 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001813 }
1814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001816 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001817 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001818 uint32_t timeout;
1819
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001820 /*
1821 * The point is, we need to always read a full datagram at once, so we
1822 * sometimes read more then requested, and handle the additional data.
1823 * It could be the rest of the current record (while fetching the
1824 * header) and/or some other records in the same datagram.
1825 */
1826
1827 /*
1828 * Move to the next record in the already read datagram if applicable
1829 */
1830 if( ssl->next_record_offset != 0 )
1831 {
1832 if( ssl->in_left < ssl->next_record_offset )
1833 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001836 }
1837
1838 ssl->in_left -= ssl->next_record_offset;
1839
1840 if( ssl->in_left != 0 )
1841 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1843 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001844 ssl->next_record_offset ) );
1845 memmove( ssl->in_hdr,
1846 ssl->in_hdr + ssl->next_record_offset,
1847 ssl->in_left );
1848 }
1849
1850 ssl->next_record_offset = 0;
1851 }
1852
Paul Elliottd48d5c62021-01-07 14:47:05 +00001853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1854 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001855 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001856
1857 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001858 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001859 */
1860 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001861 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001863 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001864 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001865
1866 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001867 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001868 * are not at the beginning of a new record, the caller did something
1869 * wrong.
1870 */
1871 if( ssl->in_left != 0 )
1872 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1874 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001875 }
1876
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001877 /*
1878 * Don't even try to read if time's out already.
1879 * This avoids by-passing the timer when repeatedly receiving messages
1880 * that will end up being dropped.
1881 */
Hanno Becker7876d122020-02-05 10:39:31 +00001882 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001883 {
1884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001885 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001886 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001887 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001888 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001889 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001890
Paul Elliott27b0d942022-03-18 21:55:32 +00001891 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001892 timeout = ssl->handshake->retransmit_timeout;
1893 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001894 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001895
Paul Elliott9f352112020-12-09 14:55:45 +00001896 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001897
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001898 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001899 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1900 timeout );
1901 else
1902 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001905
1906 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001908 }
1909
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001910 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001911 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001913 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001914
Paul Elliott27b0d942022-03-18 21:55:32 +00001915 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001916 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001917 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1918 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001920 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001921 }
1922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001924 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001926 return( ret );
1927 }
1928
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001929 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001930 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001932 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001934 {
Hanno Becker786300f2020-02-05 10:46:40 +00001935 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001936 {
Hanno Becker786300f2020-02-05 10:46:40 +00001937 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1938 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001939 return( ret );
1940 }
1941
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001942 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001943 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001945 }
1946
Paul Bakker5121ce52009-01-03 21:22:43 +00001947 if( ret < 0 )
1948 return( ret );
1949
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001950 ssl->in_left = ret;
1951 }
1952 else
1953#endif
1954 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1956 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001957 ssl->in_left, nb_want ) );
1958
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001959 while( ssl->in_left < nb_want )
1960 {
1961 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001962
Hanno Becker7876d122020-02-05 10:39:31 +00001963 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001964 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1965 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001966 {
1967 if( ssl->f_recv_timeout != NULL )
1968 {
1969 ret = ssl->f_recv_timeout( ssl->p_bio,
1970 ssl->in_hdr + ssl->in_left, len,
1971 ssl->conf->read_timeout );
1972 }
1973 else
1974 {
1975 ret = ssl->f_recv( ssl->p_bio,
1976 ssl->in_hdr + ssl->in_left, len );
1977 }
1978 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001979
Paul Elliottd48d5c62021-01-07 14:47:05 +00001980 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1981 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001982 ssl->in_left, nb_want ) );
1983 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001984
1985 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001987
1988 if( ret < 0 )
1989 return( ret );
1990
makise-homuraaf9513b2020-08-24 18:26:27 +03001991 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001992 {
Darryl Green11999bb2018-03-13 15:22:58 +00001993 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001994 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001995 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001996 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1997 }
1998
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001999 ssl->in_left += ret;
2000 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002001 }
2002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002004
2005 return( 0 );
2006}
2007
2008/*
2009 * Flush any data not yet written
2010 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002012{
Janos Follath865b3eb2019-12-16 11:46:15 +00002013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002014 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002017
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002018 if( ssl->f_send == NULL )
2019 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002021 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002023 }
2024
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002025 /* Avoid incrementing counter if data is flushed */
2026 if( ssl->out_left == 0 )
2027 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002028 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002029 return( 0 );
2030 }
2031
Paul Bakker5121ce52009-01-03 21:22:43 +00002032 while( ssl->out_left > 0 )
2033 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002034 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2035 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002036 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002037
Hanno Becker2b1e3542018-08-06 11:19:13 +01002038 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002039 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002042
2043 if( ret <= 0 )
2044 return( ret );
2045
makise-homuraaf9513b2020-08-24 18:26:27 +03002046 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002047 {
Darryl Green11999bb2018-03-13 15:22:58 +00002048 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002049 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002050 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002051 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2052 }
2053
Paul Bakker5121ce52009-01-03 21:22:43 +00002054 ssl->out_left -= ret;
2055 }
2056
Hanno Becker2b1e3542018-08-06 11:19:13 +01002057#if defined(MBEDTLS_SSL_PROTO_DTLS)
2058 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002059 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002060 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002061 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002062 else
2063#endif
2064 {
2065 ssl->out_hdr = ssl->out_buf + 8;
2066 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002067 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002070
2071 return( 0 );
2072}
2073
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002074/*
2075 * Functions to handle the DTLS retransmission state machine
2076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078/*
2079 * Append current handshake message to current outgoing flight
2080 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002081MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002083{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2086 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2087 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002088
2089 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002090 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002091 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002094 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002095 }
2096
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002097 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002098 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002099 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2100 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002102 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002103 }
2104
2105 /* Copy current handshake message with headers */
2106 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2107 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002108 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002109 msg->next = NULL;
2110
2111 /* Append to the current flight */
2112 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002113 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002114 else
2115 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002117 while( cur->next != NULL )
2118 cur = cur->next;
2119 cur->next = msg;
2120 }
2121
Hanno Becker3b235902018-08-06 09:54:53 +01002122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002123 return( 0 );
2124}
2125
2126/*
2127 * Free the current flight of handshake messages
2128 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002129void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002130{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002131 mbedtls_ssl_flight_item *cur = flight;
2132 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002133
2134 while( cur != NULL )
2135 {
2136 next = cur->next;
2137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002138 mbedtls_free( cur->p );
2139 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002140
2141 cur = next;
2142 }
2143}
2144
2145/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002146 * Swap transform_out and out_ctr with the alternative ones
2147 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002148MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002149static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002150{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002152 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002153
2154 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2155 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002157 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002158 }
2159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002161
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002162 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002163 tmp_transform = ssl->transform_out;
2164 ssl->transform_out = ssl->handshake->alt_transform_out;
2165 ssl->handshake->alt_transform_out = tmp_transform;
2166
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002167 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002168 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2169 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2170 sizeof( ssl->cur_out_ctr ) );
2171 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2172 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002173
2174 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002175 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002176
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002177 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002178}
2179
2180/*
2181 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002182 */
2183int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2184{
2185 int ret = 0;
2186
2187 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2188
2189 ret = mbedtls_ssl_flight_transmit( ssl );
2190
2191 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2192
2193 return( ret );
2194}
2195
2196/*
2197 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002198 *
2199 * Need to remember the current message in case flush_output returns
2200 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002201 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002202 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002203int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002204{
Janos Follath865b3eb2019-12-16 11:46:15 +00002205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002206 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002209 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002210 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002211
2212 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002213 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002214 ret = ssl_swap_epochs( ssl );
2215 if( ret != 0 )
2216 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002218 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002219 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002220
2221 while( ssl->handshake->cur_msg != NULL )
2222 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002223 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002224 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002225
Hanno Beckere1dcb032018-08-17 16:47:58 +01002226 int const is_finished =
2227 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2228 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2229
Ronald Cron00d012f22022-03-08 15:57:12 +01002230 int const force_flush = ssl->disable_datagram_packing == 1 ?
Hanno Becker04da1892018-08-14 13:22:10 +01002231 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2232
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002233 /* Swap epochs before sending Finished: we can't do it after
2234 * sending ChangeCipherSpec, in case write returns WANT_READ.
2235 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002236 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002237 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002238 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002239 ret = ssl_swap_epochs( ssl );
2240 if( ret != 0 )
2241 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002242 }
2243
Hanno Becker67bc7c32018-08-06 11:33:50 +01002244 ret = ssl_get_remaining_payload_in_datagram( ssl );
2245 if( ret < 0 )
2246 return( ret );
2247 max_frag_len = (size_t) ret;
2248
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002249 /* CCS is copied as is, while HS messages may need fragmentation */
2250 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2251 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002252 if( max_frag_len == 0 )
2253 {
2254 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2255 return( ret );
2256
2257 continue;
2258 }
2259
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002260 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002261 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002262 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002263
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002264 /* Update position inside current message */
2265 ssl->handshake->cur_msg_p += cur->len;
2266 }
2267 else
2268 {
2269 const unsigned char * const p = ssl->handshake->cur_msg_p;
2270 const size_t hs_len = cur->len - 12;
2271 const size_t frag_off = p - ( cur->p + 12 );
2272 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002273 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002274
Hanno Beckere1dcb032018-08-17 16:47:58 +01002275 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002276 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002277 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002278 {
2279 ret = ssl_swap_epochs( ssl );
2280 if( ret != 0 )
2281 return( ret );
2282 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002283
Hanno Becker67bc7c32018-08-06 11:33:50 +01002284 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2285 return( ret );
2286
2287 continue;
2288 }
2289 max_hs_frag_len = max_frag_len - 12;
2290
2291 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2292 max_hs_frag_len : rem_len;
2293
2294 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002295 {
2296 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002297 (unsigned) cur_hs_frag_len,
2298 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002299 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002300
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002301 /* Messages are stored with handshake headers as if not fragmented,
2302 * copy beginning of headers then fill fragmentation fields.
2303 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2304 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002305
Joe Subbiani5ecac212021-06-24 13:00:03 +01002306 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2307 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2308 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002309
Joe Subbiani5ecac212021-06-24 13:00:03 +01002310 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2311 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2312 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002313
2314 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2315
Hanno Becker3f7b9732018-08-28 09:53:25 +01002316 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002317 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2318 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002319 ssl->out_msgtype = cur->type;
2320
2321 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002322 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002323 }
2324
2325 /* If done with the current message move to the next one if any */
2326 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2327 {
2328 if( cur->next != NULL )
2329 {
2330 ssl->handshake->cur_msg = cur->next;
2331 ssl->handshake->cur_msg_p = cur->next->p + 12;
2332 }
2333 else
2334 {
2335 ssl->handshake->cur_msg = NULL;
2336 ssl->handshake->cur_msg_p = NULL;
2337 }
2338 }
2339
2340 /* Actually send the message out */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002341 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002342 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002344 return( ret );
2345 }
2346 }
2347
Hanno Becker67bc7c32018-08-06 11:33:50 +01002348 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2349 return( ret );
2350
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002351 /* Update state and set timer */
Paul Elliott27b0d942022-03-18 21:55:32 +00002352 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002354 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002357 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002358 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002359
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002360 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002361
2362 return( 0 );
2363}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002364
2365/*
2366 * To be called when the last message of an incoming flight is received.
2367 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002369{
2370 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002371 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002372 ssl->handshake->flight = NULL;
2373 ssl->handshake->cur_msg = NULL;
2374
2375 /* The next incoming flight will start with this msg_seq */
2376 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2377
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002378 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002379 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002380
Hanno Becker0271f962018-08-16 13:23:47 +01002381 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002382 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002383
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002384 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002385 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2388 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002389 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002391 }
2392 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002394}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002395
2396/*
2397 * To be called when the last message of an outgoing flight is send.
2398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002400{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002401 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002402 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2405 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002406 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002408 }
2409 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002411}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002413
Paul Bakker5121ce52009-01-03 21:22:43 +00002414/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002415 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002416 */
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002417int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
2418 unsigned char **buf, size_t *buf_len )
2419{
2420 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002421 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002422 * ...
2423 * HandshakeType msg_type;
2424 * uint24 length;
2425 * ...
2426 */
2427 *buf = ssl->out_msg + 4;
2428 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2429
2430 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2431 ssl->out_msg[0] = hs_type;
2432
2433 return( 0 );
2434}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002435
2436/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002437 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002438 *
2439 * - fill in handshake headers
2440 * - update handshake checksum
2441 * - DTLS: save message for resending
2442 * - then pass to the record layer
2443 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002444 * DTLS: except for HelloRequest, messages are only queued, and will only be
2445 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002446 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002447 * Inputs:
2448 * - ssl->out_msglen: 4 + actual handshake message len
2449 * (4 is the size of handshake headers for TLS)
2450 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2451 * - ssl->out_msg + 4: the handshake message body
2452 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002453 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002454 * - ssl->out_msglen: the length of the record contents
2455 * (including handshake headers but excluding record headers)
2456 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002457 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002458int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01002459 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01002460 int force_flush )
Paul Bakker5121ce52009-01-03 21:22:43 +00002461{
Janos Follath865b3eb2019-12-16 11:46:15 +00002462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002463 const size_t hs_len = ssl->out_msglen - 4;
2464 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002465
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002466 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2467
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002468 /*
2469 * Sanity checks
2470 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002471 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002472 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2473 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002474 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2475 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002476 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002477
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002478 /* Whenever we send anything different from a
2479 * HelloRequest we should be in a handshake - double check. */
2480 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2481 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002482 ssl->handshake == NULL )
2483 {
2484 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2485 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2486 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002487
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002489 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002490 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002492 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2494 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002495 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002496#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002497
Hanno Beckerb50a2532018-08-06 11:52:54 +01002498 /* Double-check that we did not exceed the bounds
2499 * of the outgoing record buffer.
2500 * This should never fail as the various message
2501 * writing functions must obey the bounds of the
2502 * outgoing record buffer, but better be safe.
2503 *
2504 * Note: We deliberately do not check for the MTU or MFL here.
2505 */
2506 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2507 {
2508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002509 "size %" MBEDTLS_PRINTF_SIZET
2510 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002511 ssl->out_msglen,
2512 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002513 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2514 }
2515
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002516 /*
2517 * Fill handshake headers
2518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002520 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002521 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2522 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2523 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002525 /*
2526 * DTLS has additional fields in the Handshake layer,
2527 * between the length field and the actual payload:
2528 * uint16 message_seq;
2529 * uint24 fragment_offset;
2530 * uint24 fragment_length;
2531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002533 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002534 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002535 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002536 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002537 {
2538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002539 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002540 hs_len,
2541 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002542 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2543 }
2544
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002545 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002546 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002547
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002548 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002549 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002550 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002551 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002552 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002553 }
2554 else
2555 {
2556 ssl->out_msg[4] = 0;
2557 ssl->out_msg[5] = 0;
2558 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002559
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002560 /* Handshake hashes are computed without fragmentation,
2561 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002562 memset( ssl->out_msg + 6, 0x00, 3 );
2563 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002564 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002566
Hanno Becker0207e532018-08-28 10:28:28 +01002567 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002568 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002569 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002570 }
2571
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002572 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002574 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002575 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2576 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002577 {
2578 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2579 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002581 return( ret );
2582 }
2583 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002584 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002585#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002586 {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002587 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002588 {
2589 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2590 return( ret );
2591 }
2592 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002593
2594 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2595
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002596 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002597}
2598
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002599int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
2600 size_t buf_len, size_t msg_len )
2601{
2602 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2603 size_t msg_with_header_len;
2604 ((void) buf_len);
2605
2606 /* Add reserved 4 bytes for handshake header */
2607 msg_with_header_len = msg_len + 4;
2608 ssl->out_msglen = msg_with_header_len;
2609 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_write_handshake_msg_ext( ssl, 0, 0 ) );
2610
2611cleanup:
2612 return( ret );
2613}
2614
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002615/*
2616 * Record layer functions
2617 */
2618
2619/*
2620 * Write current record.
2621 *
2622 * Uses:
2623 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2624 * - ssl->out_msglen: length of the record content (excl headers)
2625 * - ssl->out_msg: record content
2626 */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002627int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002628{
2629 int ret, done = 0;
2630 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002631 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002632
2633 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002634
Paul Bakker05ef8352012-05-08 09:17:57 +00002635 if( !done )
2636 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002637 unsigned i;
2638 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002639#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2640 size_t out_buf_len = ssl->out_buf_len;
2641#else
2642 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2643#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002644 /* Skip writing the record content type to after the encryption,
2645 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002646 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002647#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002648 /* TLS 1.3 still uses the TLS 1.2 version identifier
2649 * for backwards compatibility. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002650 if( tls_ver == MBEDTLS_SSL_VERSION_TLS1_3 )
2651 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron6f135e12021-12-08 16:57:54 +01002652#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002653 mbedtls_ssl_write_version( ssl->out_hdr + 1, ssl->conf->transport,
2654 tls_ver );
Hanno Becker6430faf2019-05-08 11:57:13 +01002655
Jerry Yuae0b2e22021-10-08 15:21:19 +08002656 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002657 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002658
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002659 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002660 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002661 mbedtls_record rec;
2662
2663 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002664 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002665 rec.data_len = ssl->out_msglen;
2666 rec.data_offset = ssl->out_msg - rec.buf;
2667
Jerry Yud96a5c22021-09-29 17:46:51 +08002668 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002669 mbedtls_ssl_write_version( rec.ver, ssl->conf->transport, tls_ver );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002670 rec.type = ssl->out_msgtype;
2671
Hanno Beckera0e20d02019-05-15 14:03:01 +01002672#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002673 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002674 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002675#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002676
Hanno Beckera18d1322018-01-03 14:27:32 +00002677 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002678 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002679 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002681 return( ret );
2682 }
2683
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002684 if( rec.data_offset != 0 )
2685 {
2686 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2688 }
2689
Hanno Becker6430faf2019-05-08 11:57:13 +01002690 /* Update the record content type and CID. */
2691 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002692#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002693 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002694#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002695 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002696 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002697 }
2698
Hanno Becker5903de42019-05-03 14:46:38 +01002699 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002700
2701#if defined(MBEDTLS_SSL_PROTO_DTLS)
2702 /* In case of DTLS, double-check that we don't exceed
2703 * the remaining space in the datagram. */
2704 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2705 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002706 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002707 if( ret < 0 )
2708 return( ret );
2709
2710 if( protected_record_size > (size_t) ret )
2711 {
2712 /* Should never happen */
2713 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2714 }
2715 }
2716#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002717
Hanno Becker6430faf2019-05-08 11:57:13 +01002718 /* Now write the potentially updated record content type. */
2719 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2720
Paul Elliott9f352112020-12-09 14:55:45 +00002721 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002722 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002723 ssl->out_hdr[0], ssl->out_hdr[1],
2724 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002727 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002728
2729 ssl->out_left += protected_record_size;
2730 ssl->out_hdr += protected_record_size;
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002731 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002732
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002733 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
2734 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2735 break;
2736
Gabor Mezei96ae9262022-06-28 11:45:18 +02002737 /* The loop goes to its end if the counter is wrapping */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002738 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002739 {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2741 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Hanno Becker04484622018-08-06 09:49:38 +01002742 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002743 }
2744
Hanno Becker67bc7c32018-08-06 11:33:50 +01002745#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002746 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2747 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002748 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002749 size_t remaining;
2750 ret = ssl_get_remaining_payload_in_datagram( ssl );
2751 if( ret < 0 )
2752 {
2753 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2754 ret );
2755 return( ret );
2756 }
2757
2758 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002759 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002760 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002761 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002762 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002763 else
2764 {
Hanno Becker513815a2018-08-20 11:56:09 +01002765 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002766 }
2767 }
2768#endif /* MBEDTLS_SSL_PROTO_DTLS */
2769
2770 if( ( flush == SSL_FORCE_FLUSH ) &&
2771 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002772 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002774 return( ret );
2775 }
2776
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002778
2779 return( 0 );
2780}
2781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002783
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002784MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere25e3b72018-08-16 09:30:53 +01002785static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2786{
2787 if( ssl->in_msglen < ssl->in_hslen ||
2788 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2789 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2790 {
2791 return( 1 );
2792 }
2793 return( 0 );
2794}
Hanno Becker44650b72018-08-16 12:51:11 +01002795
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002796static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002797{
2798 return( ( ssl->in_msg[9] << 16 ) |
2799 ( ssl->in_msg[10] << 8 ) |
2800 ssl->in_msg[11] );
2801}
2802
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002803static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002804{
2805 return( ( ssl->in_msg[6] << 16 ) |
2806 ( ssl->in_msg[7] << 8 ) |
2807 ssl->in_msg[8] );
2808}
2809
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002810MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002811static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002812{
2813 uint32_t msg_len, frag_off, frag_len;
2814
2815 msg_len = ssl_get_hs_total_len( ssl );
2816 frag_off = ssl_get_hs_frag_off( ssl );
2817 frag_len = ssl_get_hs_frag_len( ssl );
2818
2819 if( frag_off > msg_len )
2820 return( -1 );
2821
2822 if( frag_len > msg_len - frag_off )
2823 return( -1 );
2824
2825 if( frag_len + 12 > ssl->in_msglen )
2826 return( -1 );
2827
2828 return( 0 );
2829}
2830
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002831/*
2832 * Mark bits in bitmask (used for DTLS HS reassembly)
2833 */
2834static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2835{
2836 unsigned int start_bits, end_bits;
2837
2838 start_bits = 8 - ( offset % 8 );
2839 if( start_bits != 8 )
2840 {
2841 size_t first_byte_idx = offset / 8;
2842
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002843 /* Special case */
2844 if( len <= start_bits )
2845 {
2846 for( ; len != 0; len-- )
2847 mask[first_byte_idx] |= 1 << ( start_bits - len );
2848
2849 /* Avoid potential issues with offset or len becoming invalid */
2850 return;
2851 }
2852
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002853 offset += start_bits; /* Now offset % 8 == 0 */
2854 len -= start_bits;
2855
2856 for( ; start_bits != 0; start_bits-- )
2857 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2858 }
2859
2860 end_bits = len % 8;
2861 if( end_bits != 0 )
2862 {
2863 size_t last_byte_idx = ( offset + len ) / 8;
2864
2865 len -= end_bits; /* Now len % 8 == 0 */
2866
2867 for( ; end_bits != 0; end_bits-- )
2868 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2869 }
2870
2871 memset( mask + offset / 8, 0xFF, len / 8 );
2872}
2873
2874/*
2875 * Check that bitmask is full
2876 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002877MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002878static int ssl_bitmask_check( unsigned char *mask, size_t len )
2879{
2880 size_t i;
2881
2882 for( i = 0; i < len / 8; i++ )
2883 if( mask[i] != 0xFF )
2884 return( -1 );
2885
2886 for( i = 0; i < len % 8; i++ )
2887 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2888 return( -1 );
2889
2890 return( 0 );
2891}
2892
Hanno Becker56e205e2018-08-16 09:06:12 +01002893/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002894static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002895 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002896{
Hanno Becker56e205e2018-08-16 09:06:12 +01002897 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002898
Hanno Becker56e205e2018-08-16 09:06:12 +01002899 alloc_len = 12; /* Handshake header */
2900 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002901
Hanno Beckerd07df862018-08-16 09:14:58 +01002902 if( add_bitmap )
2903 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002904
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002905 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002906}
Hanno Becker56e205e2018-08-16 09:06:12 +01002907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002909
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002910static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002911{
2912 return( ( ssl->in_msg[1] << 16 ) |
2913 ( ssl->in_msg[2] << 8 ) |
2914 ssl->in_msg[3] );
2915}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002916
Simon Butcher99000142016-10-13 17:21:01 +01002917int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002918{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002920 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002921 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002922 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002924 }
2925
Hanno Becker12555c62018-08-16 12:47:53 +01002926 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002929 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002930 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002933 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002934 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002935 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002936 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002937
Hanno Becker44650b72018-08-16 12:51:11 +01002938 if( ssl_check_hs_header( ssl ) != 0 )
2939 {
2940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2941 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2942 }
2943
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002944 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00002945 ( ( mbedtls_ssl_is_handshake_over( ssl ) == 0 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002946 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002947 ( mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002948 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002949 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002950 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2951 {
2952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2953 recv_msg_seq,
2954 ssl->handshake->in_msg_seq ) );
2955 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2956 }
2957
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002958 /* Retransmit only on last message from previous flight, to avoid
2959 * too many retransmissions.
2960 * Besides, No sane server ever retransmits HelloVerifyRequest */
2961 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002965 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002966 recv_msg_seq,
2967 ssl->handshake->in_flight_start_seq ) );
2968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002970 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002972 return( ret );
2973 }
2974 }
2975 else
2976 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002978 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002979 recv_msg_seq,
2980 ssl->handshake->in_msg_seq ) );
2981 }
2982
Hanno Becker90333da2017-10-10 11:27:13 +01002983 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002984 }
2985 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002986
Hanno Becker6d97ef52018-08-16 13:09:04 +01002987 /* Message reassembly is handled alongside buffering of future
2988 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002989 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002990 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002991 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002994 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002995 }
2996 }
2997 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002999 /* With TLS we don't handle fragmentation (for now) */
3000 if( ssl->in_msglen < ssl->in_hslen )
3001 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3003 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003004 }
3005
Simon Butcher99000142016-10-13 17:21:01 +01003006 return( 0 );
3007}
3008
3009void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3010{
Hanno Becker0271f962018-08-16 13:23:47 +01003011 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003012
Paul Elliott27b0d942022-03-18 21:55:32 +00003013 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003014 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003015 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003016 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003017
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003018 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003020 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003021 ssl->handshake != NULL )
3022 {
Hanno Becker0271f962018-08-16 13:23:47 +01003023 unsigned offset;
3024 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003025
Hanno Becker0271f962018-08-16 13:23:47 +01003026 /* Increment handshake sequence number */
3027 hs->in_msg_seq++;
3028
3029 /*
3030 * Clear up handshake buffering and reassembly structure.
3031 */
3032
3033 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003034 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003035
3036 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003037 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3038 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003039 offset++, hs_buf++ )
3040 {
3041 *hs_buf = *(hs_buf + 1);
3042 }
3043
3044 /* Create a fresh last entry */
3045 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003046 }
3047#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003048}
3049
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003050/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003051 * DTLS anti-replay: RFC 6347 4.1.2.6
3052 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003053 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3054 * Bit n is set iff record number in_window_top - n has been seen.
3055 *
3056 * Usually, in_window_top is the last record number seen and the lsb of
3057 * in_window is set. The only exception is the initial state (record number 0
3058 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003061void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003062{
3063 ssl->in_window_top = 0;
3064 ssl->in_window = 0;
3065}
3066
3067static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3068{
3069 return( ( (uint64_t) buf[0] << 40 ) |
3070 ( (uint64_t) buf[1] << 32 ) |
3071 ( (uint64_t) buf[2] << 24 ) |
3072 ( (uint64_t) buf[3] << 16 ) |
3073 ( (uint64_t) buf[4] << 8 ) |
3074 ( (uint64_t) buf[5] ) );
3075}
3076
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003077MBEDTLS_CHECK_RETURN_CRITICAL
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003078static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3079{
Janos Follath865b3eb2019-12-16 11:46:15 +00003080 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003081 unsigned char *original_in_ctr;
3082
3083 // save original in_ctr
3084 original_in_ctr = ssl->in_ctr;
3085
3086 // use counter from record
3087 ssl->in_ctr = record_in_ctr;
3088
3089 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3090
3091 // restore the counter
3092 ssl->in_ctr = original_in_ctr;
3093
3094 return ret;
3095}
3096
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003097/*
3098 * Return 0 if sequence number is acceptable, -1 otherwise
3099 */
Hanno Becker0183d692019-07-12 08:50:37 +01003100int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003101{
3102 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3103 uint64_t bit;
3104
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003105 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003106 return( 0 );
3107
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003108 if( rec_seqnum > ssl->in_window_top )
3109 return( 0 );
3110
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003111 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003112
3113 if( bit >= 64 )
3114 return( -1 );
3115
3116 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3117 return( -1 );
3118
3119 return( 0 );
3120}
3121
3122/*
3123 * Update replay window on new validated record
3124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003126{
3127 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3128
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003129 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003130 return;
3131
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003132 if( rec_seqnum > ssl->in_window_top )
3133 {
3134 /* Update window_top and the contents of the window */
3135 uint64_t shift = rec_seqnum - ssl->in_window_top;
3136
3137 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003138 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003139 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003140 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003141 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003142 ssl->in_window |= 1;
3143 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003144
3145 ssl->in_window_top = rec_seqnum;
3146 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003147 else
3148 {
3149 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003150 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003151
3152 if( bit < 64 ) /* Always true, but be extra sure */
3153 ssl->in_window |= (uint64_t) 1 << bit;
3154 }
3155}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003157
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003158#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003159/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003160 * Check if a datagram looks like a ClientHello with a valid cookie,
3161 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003162 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003163 *
3164 * - if cookie is valid, return 0
3165 * - if ClientHello looks superficially valid but cookie is not,
3166 * fill obuf and set olen, then
3167 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3168 * - otherwise return a specific error code
3169 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003170MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003171MBEDTLS_STATIC_TESTABLE
3172int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003173 mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003174 const unsigned char *cli_id, size_t cli_id_len,
3175 const unsigned char *in, size_t in_len,
3176 unsigned char *obuf, size_t buf_len, size_t *olen )
3177{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003178 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003179 unsigned char *p;
3180
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003181 /*
3182 * Structure of ClientHello with record and handshake headers,
3183 * and expected values. We don't need to check a lot, more checks will be
3184 * done when actually parsing the ClientHello - skipping those checks
3185 * avoids code duplication and does not make cookie forging any easier.
3186 *
3187 * 0-0 ContentType type; copied, must be handshake
3188 * 1-2 ProtocolVersion version; copied
3189 * 3-4 uint16 epoch; copied, must be 0
3190 * 5-10 uint48 sequence_number; copied
3191 * 11-12 uint16 length; (ignored)
3192 *
3193 * 13-13 HandshakeType msg_type; (ignored)
3194 * 14-16 uint24 length; (ignored)
3195 * 17-18 uint16 message_seq; copied
3196 * 19-21 uint24 fragment_offset; copied, must be 0
3197 * 22-24 uint24 fragment_length; (ignored)
3198 *
3199 * 25-26 ProtocolVersion client_version; (ignored)
3200 * 27-58 Random random; (ignored)
3201 * 59-xx SessionID session_id; 1 byte len + sid_len content
3202 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3203 * ...
3204 *
3205 * Minimum length is 61 bytes.
3206 */
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003207 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: in_len=%u",
3208 (unsigned) in_len ) );
3209 MBEDTLS_SSL_DEBUG_BUF( 4, "cli_id", cli_id, cli_id_len );
3210 if( in_len < 61 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003211 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003212 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: record too short" ) );
3213 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
3214 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003215
3216 epoch = MBEDTLS_GET_UINT16_BE( in, 3 );
3217 fragment_offset = MBEDTLS_GET_UINT24_BE( in, 19 );
3218
3219 if( in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3220 fragment_offset != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003221 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003222 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: not a good ClientHello" ) );
3223 MBEDTLS_SSL_DEBUG_MSG( 4, ( " type=%u epoch=%u fragment_offset=%u",
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003224 in[0], (unsigned) epoch,
3225 (unsigned) fragment_offset ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003226 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003227 }
3228
3229 sid_len = in[59];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003230 if( 59 + 1 + sid_len + 1 > in_len )
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003231 {
3232 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: sid_len=%u > %u",
3233 (unsigned) sid_len,
3234 (unsigned) in_len - 61 ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003235 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003236 }
3237 MBEDTLS_SSL_DEBUG_BUF( 4, "sid received from network",
3238 in + 60, sid_len );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003239
3240 cookie_len = in[60 + sid_len];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003241 if( 59 + 1 + sid_len + 1 + cookie_len > in_len )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003242 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003243 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: cookie_len=%u > %u",
3244 (unsigned) cookie_len,
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003245 (unsigned) ( in_len - sid_len - 61 ) ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003246 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003247 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003248
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003249 MBEDTLS_SSL_DEBUG_BUF( 4, "cookie received from network",
3250 in + sid_len + 61, cookie_len );
3251 if( ssl->conf->f_cookie_check( ssl->conf->p_cookie,
3252 in + sid_len + 61, cookie_len,
3253 cli_id, cli_id_len ) == 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003254 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003255 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: valid" ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003256 return( 0 );
3257 }
3258
3259 /*
3260 * If we get here, we've got an invalid cookie, let's prepare HVR.
3261 *
3262 * 0-0 ContentType type; copied
3263 * 1-2 ProtocolVersion version; copied
3264 * 3-4 uint16 epoch; copied
3265 * 5-10 uint48 sequence_number; copied
3266 * 11-12 uint16 length; olen - 13
3267 *
3268 * 13-13 HandshakeType msg_type; hello_verify_request
3269 * 14-16 uint24 length; olen - 25
3270 * 17-18 uint16 message_seq; copied
3271 * 19-21 uint24 fragment_offset; copied
3272 * 22-24 uint24 fragment_length; olen - 25
3273 *
3274 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3275 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3276 *
3277 * Minimum length is 28.
3278 */
3279 if( buf_len < 28 )
3280 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3281
3282 /* Copy most fields and adapt others */
3283 memcpy( obuf, in, 25 );
3284 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3285 obuf[25] = 0xfe;
3286 obuf[26] = 0xff;
3287
3288 /* Generate and write actual cookie */
3289 p = obuf + 28;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003290 if( ssl->conf->f_cookie_write( ssl->conf->p_cookie,
3291 &p, obuf + buf_len,
3292 cli_id, cli_id_len ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003293 {
3294 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3295 }
3296
3297 *olen = p - obuf;
3298
3299 /* Go back and fill length fields */
3300 obuf[27] = (unsigned char)( *olen - 28 );
3301
Joe Subbianifbeb6922021-07-16 14:27:50 +01003302 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3303 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3304 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003305
Joe Subbiani6dd73642021-07-19 11:56:54 +01003306 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003307
3308 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3309}
3310
3311/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003312 * Handle possible client reconnect with the same UDP quadruplet
3313 * (RFC 6347 Section 4.2.8).
3314 *
3315 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3316 * that looks like a ClientHello.
3317 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003318 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003319 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003320 * - if the input looks like a ClientHello with a valid cookie,
3321 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003322 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003323 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003324 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003325 * This function is called (through ssl_check_client_reconnect()) when an
3326 * unexpected record is found in ssl_get_next_record(), which will discard the
3327 * record if we return 0, and bubble up the return value otherwise (this
3328 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3329 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003330 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003331MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003332static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3333{
Janos Follath865b3eb2019-12-16 11:46:15 +00003334 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003335 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003336
Hanno Becker2fddd372019-07-10 14:37:41 +01003337 if( ssl->conf->f_cookie_write == NULL ||
3338 ssl->conf->f_cookie_check == NULL )
3339 {
3340 /* If we can't use cookies to verify reachability of the peer,
3341 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3343 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003344 return( 0 );
3345 }
3346
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003347 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003348 ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003349 ssl->cli_id, ssl->cli_id_len,
3350 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003351 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003352
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003353 MBEDTLS_SSL_DEBUG_RET( 2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003354
3355 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003356 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003357 int send_ret;
3358 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3359 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3360 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003361 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003362 * If the error is permanent we'll catch it later,
3363 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003364 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3365 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3366 (void) send_ret;
3367
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003368 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003369 }
3370
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003371 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003372 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003374 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003375 {
3376 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3377 return( ret );
3378 }
3379
3380 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003381 }
3382
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003383 return( ret );
3384}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003385#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003386
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003387MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003388static int ssl_check_record_type( uint8_t record_type )
3389{
3390 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3391 record_type != MBEDTLS_SSL_MSG_ALERT &&
3392 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3393 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3394 {
3395 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3396 }
3397
3398 return( 0 );
3399}
3400
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003401/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003402 * ContentType type;
3403 * ProtocolVersion version;
3404 * uint16 epoch; // DTLS only
3405 * uint48 sequence_number; // DTLS only
3406 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003407 *
3408 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003409 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003410 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3411 *
3412 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003413 * 1. proceed with the record if this function returns 0
3414 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3415 * 3. return CLIENT_RECONNECT if this function return that value
3416 * 4. drop the whole datagram if this function returns anything else.
3417 * Point 2 is needed when the peer is resending, and we have already received
3418 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003419 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003420MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker331de3d2019-07-12 11:10:16 +01003421static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003422 unsigned char *buf,
3423 size_t len,
3424 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003425{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003426 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003427
Hanno Beckere5e7e782019-07-11 12:29:35 +01003428 size_t const rec_hdr_type_offset = 0;
3429 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003430
Hanno Beckere5e7e782019-07-11 12:29:35 +01003431 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3432 rec_hdr_type_len;
3433 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003434
Hanno Beckere5e7e782019-07-11 12:29:35 +01003435 size_t const rec_hdr_ctr_len = 8;
3436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003437 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003438 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3439 rec_hdr_version_len;
3440
Hanno Beckera0e20d02019-05-15 14:03:01 +01003441#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003442 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3443 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003444 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003445#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3446#endif /* MBEDTLS_SSL_PROTO_DTLS */
3447
3448 size_t rec_hdr_len_offset; /* To be determined */
3449 size_t const rec_hdr_len_len = 2;
3450
3451 /*
3452 * Check minimum lengths for record header.
3453 */
3454
3455#if defined(MBEDTLS_SSL_PROTO_DTLS)
3456 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3457 {
3458 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3459 }
3460 else
3461#endif /* MBEDTLS_SSL_PROTO_DTLS */
3462 {
3463 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3464 }
3465
3466 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3467 {
3468 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3469 (unsigned) len,
3470 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3471 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3472 }
3473
3474 /*
3475 * Parse and validate record content type
3476 */
3477
3478 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003479
3480 /* Check record content type */
3481#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3482 rec->cid_len = 0;
3483
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003484 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003485 ssl->conf->cid_len != 0 &&
3486 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003487 {
3488 /* Shift pointers to account for record header including CID
3489 * struct {
3490 * ContentType special_type = tls12_cid;
3491 * ProtocolVersion version;
3492 * uint16 epoch;
3493 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003494 * opaque cid[cid_length]; // Additional field compared to
3495 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003496 * uint16 length;
3497 * opaque enc_content[DTLSCiphertext.length];
3498 * } DTLSCiphertext;
3499 */
3500
3501 /* So far, we only support static CID lengths
3502 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003503 rec_hdr_cid_len = ssl->conf->cid_len;
3504 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003505
Hanno Beckere5e7e782019-07-11 12:29:35 +01003506 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003507 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3509 (unsigned) len,
3510 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003511 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003512 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003513
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003514 /* configured CID len is guaranteed at most 255, see
3515 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3516 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003517 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003518 }
3519 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003520#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003521 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003522 if( ssl_check_record_type( rec->type ) )
3523 {
Hanno Becker54229812019-07-12 14:40:00 +01003524 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3525 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003526 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3527 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003528 }
3529
Hanno Beckere5e7e782019-07-11 12:29:35 +01003530 /*
3531 * Parse and validate record version
3532 */
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003533 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3534 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003535 tls_version = mbedtls_ssl_read_version( buf + rec_hdr_version_offset,
3536 ssl->conf->transport );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003537
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003538 if( tls_version > ssl->conf->max_tls_version )
Paul Bakker5121ce52009-01-03 21:22:43 +00003539 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003540 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS version mismatch: got %u, expected max %u",
3541 (unsigned) tls_version,
3542 (unsigned) ssl->conf->max_tls_version) );
3543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003545 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003546 /*
3547 * Parse/Copy record sequence number.
3548 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003549
Hanno Beckere5e7e782019-07-11 12:29:35 +01003550#if defined(MBEDTLS_SSL_PROTO_DTLS)
3551 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003552 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003553 /* Copy explicit record sequence number from input buffer. */
3554 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3555 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003556 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003557 else
3558#endif /* MBEDTLS_SSL_PROTO_DTLS */
3559 {
3560 /* Copy implicit record sequence number from SSL context structure. */
3561 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3562 }
Paul Bakker40e46942009-01-03 21:51:57 +00003563
Hanno Beckere5e7e782019-07-11 12:29:35 +01003564 /*
3565 * Parse record length.
3566 */
3567
Hanno Beckere5e7e782019-07-11 12:29:35 +01003568 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003569 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3570 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003571 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003572
Paul Elliott9f352112020-12-09 14:55:45 +00003573 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003574 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3575 rec->type, (unsigned)tls_version, rec->data_len ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003576
3577 rec->buf = buf;
3578 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003579
Hanno Beckerd417cc92019-07-26 08:20:27 +01003580 if( rec->data_len == 0 )
3581 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003582
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003583 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003584 * DTLS-related tests.
3585 * Check epoch before checking length constraint because
3586 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3587 * message gets duplicated before the corresponding Finished message,
3588 * the second ChangeCipherSpec should be discarded because it belongs
3589 * to an old epoch, but not because its length is shorter than
3590 * the minimum record length for packets using the new record transform.
3591 * Note that these two kinds of failures are handled differently,
3592 * as an unexpected record is silently skipped but an invalid
3593 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003594 */
3595#if defined(MBEDTLS_SSL_PROTO_DTLS)
3596 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3597 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003598 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003599
Hanno Becker955a5c92019-07-10 17:12:07 +01003600 /* Check that the datagram is large enough to contain a record
3601 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003602 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003603 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003604 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3605 (unsigned) len,
3606 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003607 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3608 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003609
Hanno Becker37cfe732019-07-10 17:20:01 +01003610 /* Records from other, non-matching epochs are silently discarded.
3611 * (The case of same-port Client reconnects must be considered in
3612 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003613 if( rec_epoch != ssl->in_epoch )
3614 {
3615 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003616 "expected %u, received %lu",
3617 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003618
Hanno Becker552f7472019-07-19 10:59:12 +01003619 /* Records from the next epoch are considered for buffering
3620 * (concretely: early Finished messages). */
3621 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003622 {
Hanno Becker552f7472019-07-19 10:59:12 +01003623 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3624 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003625 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003626
Hanno Becker2fddd372019-07-10 14:37:41 +01003627 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003628 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003629#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003630 /* For records from the correct epoch, check whether their
3631 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003632 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3633 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003634 {
3635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3636 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3637 }
3638#endif
3639 }
3640#endif /* MBEDTLS_SSL_PROTO_DTLS */
3641
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003642 return( 0 );
3643}
Paul Bakker5121ce52009-01-03 21:22:43 +00003644
Paul Bakker5121ce52009-01-03 21:22:43 +00003645
Hanno Becker2fddd372019-07-10 14:37:41 +01003646#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003647MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2fddd372019-07-10 14:37:41 +01003648static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3649{
3650 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3651
3652 /*
3653 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3654 * access the first byte of record content (handshake type), as we
3655 * have an active transform (possibly iv_len != 0), so use the
3656 * fact that the record header len is 13 instead.
3657 */
3658 if( rec_epoch == 0 &&
3659 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Paul Elliott27b0d942022-03-18 21:55:32 +00003660 mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003661 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3662 ssl->in_left > 13 &&
3663 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3664 {
3665 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3666 "from the same port" ) );
3667 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003668 }
3669
3670 return( 0 );
3671}
Hanno Becker2fddd372019-07-10 14:37:41 +01003672#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003673
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003674/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003675 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003676 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003677MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfdf66042019-07-11 13:07:45 +01003678static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3679 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003680{
3681 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003683 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003684 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003685
Ronald Cron7e38cba2021-11-24 12:43:39 +01003686 /*
3687 * In TLS 1.3, always treat ChangeCipherSpec records
3688 * as unencrypted. The only thing we do with them is
3689 * check the length and content and ignore them.
3690 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003691#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003692 if( ssl->transform_in != NULL &&
Glenn Strauss07c64162022-03-14 12:34:51 -04003693 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01003694 {
3695 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3696 done = 1;
3697 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003698#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003699
Paul Bakker48916f92012-09-16 19:57:18 +00003700 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003701 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003702 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003703
Hanno Beckera18d1322018-01-03 14:27:32 +00003704 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003705 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003706 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003707 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003708
Hanno Beckera0e20d02019-05-15 14:03:01 +01003709#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003710 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3711 ssl->conf->ignore_unexpected_cid
3712 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3713 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003714 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003715 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003716 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003717#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003718
Paul Bakker5121ce52009-01-03 21:22:43 +00003719 return( ret );
3720 }
3721
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003722 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003723 {
3724 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003725 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003726 }
3727
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003728 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003729 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003730
Hanno Beckera0e20d02019-05-15 14:03:01 +01003731#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003732 /* We have already checked the record content type
3733 * in ssl_parse_record_header(), failing or silently
3734 * dropping the record in the case of an unknown type.
3735 *
3736 * Since with the use of CIDs, the record content type
3737 * might change during decryption, re-check the record
3738 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003739 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003740 {
3741 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3742 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3743 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003744#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003745
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003746 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003747 {
3748#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003749 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003750 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003751 {
3752 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3754 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3755 }
3756#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3757
3758 ssl->nb_zero++;
3759
3760 /*
3761 * Three or more empty messages may be a DoS attack
3762 * (excessive CPU consumption).
3763 */
3764 if( ssl->nb_zero > 3 )
3765 {
3766 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003767 "messages, possible DoS attack" ) );
3768 /* Treat the records as if they were not properly authenticated,
3769 * thereby failing the connection if we see more than allowed
3770 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003771 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3772 }
3773 }
3774 else
3775 ssl->nb_zero = 0;
3776
3777#if defined(MBEDTLS_SSL_PROTO_DTLS)
3778 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3779 {
3780 ; /* in_ctr read from peer, not maintained internally */
3781 }
3782 else
3783#endif
3784 {
3785 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003786 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3787 i > mbedtls_ssl_ep_len( ssl ); i-- )
3788 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003789 if( ++ssl->in_ctr[i - 1] != 0 )
3790 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003791 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003792
3793 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003794 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003795 {
3796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3797 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3798 }
3799 }
3800
Paul Bakker5121ce52009-01-03 21:22:43 +00003801 }
3802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003803#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003804 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003805 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003806 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003807 }
3808#endif
3809
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003810 /* Check actual (decrypted) record content length against
3811 * configured maximum. */
Paul Elliott668b31f2022-06-10 14:11:31 +01003812 if( rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003813 {
3814 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3815 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3816 }
3817
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003818 return( 0 );
3819}
3820
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003821/*
3822 * Read a record.
3823 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003824 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3825 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3826 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003827 */
Hanno Becker1097b342018-08-15 14:09:41 +01003828
3829/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003830MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01003831static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003832MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01003833static int ssl_get_next_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003834MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01003835static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003836
Hanno Becker327c93b2018-08-15 13:56:18 +01003837int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003838 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003839{
Janos Follath865b3eb2019-12-16 11:46:15 +00003840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003843
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003844 if( ssl->keep_current_message == 0 )
3845 {
3846 do {
Simon Butcher99000142016-10-13 17:21:01 +01003847
Hanno Becker26994592018-08-15 14:14:59 +01003848 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003849 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003850 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003851
Hanno Beckere74d5562018-08-15 14:26:08 +01003852 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003853 {
Hanno Becker40f50842018-08-15 14:48:01 +01003854#if defined(MBEDTLS_SSL_PROTO_DTLS)
3855 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003856
Hanno Becker40f50842018-08-15 14:48:01 +01003857 /* We only check for buffered messages if the
3858 * current datagram is fully consumed. */
3859 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003860 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003861 {
Hanno Becker40f50842018-08-15 14:48:01 +01003862 if( ssl_load_buffered_message( ssl ) == 0 )
3863 have_buffered = 1;
3864 }
3865
3866 if( have_buffered == 0 )
3867#endif /* MBEDTLS_SSL_PROTO_DTLS */
3868 {
3869 ret = ssl_get_next_record( ssl );
3870 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3871 continue;
3872
3873 if( ret != 0 )
3874 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003875 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003876 return( ret );
3877 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003878 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003879 }
3880
3881 ret = mbedtls_ssl_handle_message_type( ssl );
3882
Hanno Becker40f50842018-08-15 14:48:01 +01003883#if defined(MBEDTLS_SSL_PROTO_DTLS)
3884 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3885 {
3886 /* Buffer future message */
3887 ret = ssl_buffer_message( ssl );
3888 if( ret != 0 )
3889 return( ret );
3890
3891 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3892 }
3893#endif /* MBEDTLS_SSL_PROTO_DTLS */
3894
Hanno Becker90333da2017-10-10 11:27:13 +01003895 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3896 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003897
3898 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003899 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003900 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003901 return( ret );
3902 }
3903
Hanno Becker327c93b2018-08-15 13:56:18 +01003904 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003905 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003906 {
3907 mbedtls_ssl_update_handshake_status( ssl );
3908 }
Simon Butcher99000142016-10-13 17:21:01 +01003909 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003910 else
Simon Butcher99000142016-10-13 17:21:01 +01003911 {
Hanno Becker02f59072018-08-15 14:00:24 +01003912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003913 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003914 }
3915
3916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3917
3918 return( 0 );
3919}
3920
Hanno Becker40f50842018-08-15 14:48:01 +01003921#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003922MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003923static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003924{
Hanno Becker40f50842018-08-15 14:48:01 +01003925 if( ssl->in_left > ssl->next_record_offset )
3926 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003927
Hanno Becker40f50842018-08-15 14:48:01 +01003928 return( 0 );
3929}
3930
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003931MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01003932static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3933{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003934 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003935 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003936 int ret = 0;
3937
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003938 if( hs == NULL )
3939 return( -1 );
3940
Hanno Beckere00ae372018-08-20 09:39:42 +01003941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3942
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003943 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3944 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3945 {
3946 /* Check if we have seen a ChangeCipherSpec before.
3947 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003948 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003949 {
3950 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3951 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003952 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003953 }
3954
Hanno Becker39b8bc92018-08-28 17:17:13 +01003955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003956 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3957 ssl->in_msglen = 1;
3958 ssl->in_msg[0] = 1;
3959
3960 /* As long as they are equal, the exact value doesn't matter. */
3961 ssl->in_left = 0;
3962 ssl->next_record_offset = 0;
3963
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003964 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003965 goto exit;
3966 }
Hanno Becker37f95322018-08-16 13:55:32 +01003967
Hanno Beckerb8f50142018-08-28 10:01:34 +01003968#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003969 /* Debug only */
3970 {
3971 unsigned offset;
3972 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3973 {
3974 hs_buf = &hs->buffering.hs[offset];
3975 if( hs_buf->is_valid == 1 )
3976 {
3977 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3978 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003979 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003980 }
3981 }
3982 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003983#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003984
3985 /* Check if we have buffered and/or fully reassembled the
3986 * next handshake message. */
3987 hs_buf = &hs->buffering.hs[0];
3988 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3989 {
3990 /* Synthesize a record containing the buffered HS message. */
3991 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3992 ( hs_buf->data[2] << 8 ) |
3993 hs_buf->data[3];
3994
3995 /* Double-check that we haven't accidentally buffered
3996 * a message that doesn't fit into the input buffer. */
3997 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3998 {
3999 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4000 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4001 }
4002
4003 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4004 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4005 hs_buf->data, msg_len + 12 );
4006
4007 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4008 ssl->in_hslen = msg_len + 12;
4009 ssl->in_msglen = msg_len + 12;
4010 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4011
4012 ret = 0;
4013 goto exit;
4014 }
4015 else
4016 {
4017 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4018 hs->in_msg_seq ) );
4019 }
4020
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004021 ret = -1;
4022
4023exit:
4024
4025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4026 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004027}
4028
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004029MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckera02b0b42018-08-21 17:20:27 +01004030static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4031 size_t desired )
4032{
4033 int offset;
4034 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004035 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4036 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004037
Hanno Becker01315ea2018-08-21 17:22:17 +01004038 /* Get rid of future records epoch first, if such exist. */
4039 ssl_free_buffered_record( ssl );
4040
4041 /* Check if we have enough space available now. */
4042 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4043 hs->buffering.total_bytes_buffered ) )
4044 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004045 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004046 return( 0 );
4047 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004048
Hanno Becker4f432ad2018-08-28 10:02:32 +01004049 /* We don't have enough space to buffer the next expected handshake
4050 * message. Remove buffers used for future messages to gain space,
4051 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004052 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4053 offset >= 0; offset-- )
4054 {
4055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4056 offset ) );
4057
Hanno Beckerb309b922018-08-23 13:18:05 +01004058 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004059
4060 /* Check if we have enough space available now. */
4061 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4062 hs->buffering.total_bytes_buffered ) )
4063 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004064 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004065 return( 0 );
4066 }
4067 }
4068
4069 return( -1 );
4070}
4071
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004072MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01004073static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4074{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004075 int ret = 0;
4076 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4077
4078 if( hs == NULL )
4079 return( 0 );
4080
4081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4082
4083 switch( ssl->in_msgtype )
4084 {
4085 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004087
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004088 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004089 break;
4090
4091 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004092 {
4093 unsigned recv_msg_seq_offset;
4094 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4095 mbedtls_ssl_hs_buffer *hs_buf;
4096 size_t msg_len = ssl->in_hslen - 12;
4097
4098 /* We should never receive an old handshake
4099 * message - double-check nonetheless. */
4100 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4101 {
4102 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4103 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4104 }
4105
4106 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4107 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4108 {
4109 /* Silently ignore -- message too far in the future */
4110 MBEDTLS_SSL_DEBUG_MSG( 2,
4111 ( "Ignore future HS message with sequence number %u, "
4112 "buffering window %u - %u",
4113 recv_msg_seq, ssl->handshake->in_msg_seq,
4114 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4115
4116 goto exit;
4117 }
4118
4119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4120 recv_msg_seq, recv_msg_seq_offset ) );
4121
4122 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4123
4124 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004125 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004126 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004127 size_t reassembly_buf_sz;
4128
Hanno Becker37f95322018-08-16 13:55:32 +01004129 hs_buf->is_fragmented =
4130 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4131
4132 /* We copy the message back into the input buffer
4133 * after reassembly, so check that it's not too large.
4134 * This is an implementation-specific limitation
4135 * and not one from the standard, hence it is not
4136 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004137 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004138 {
4139 /* Ignore message */
4140 goto exit;
4141 }
4142
Hanno Beckere0b150f2018-08-21 15:51:03 +01004143 /* Check if we have enough space to buffer the message. */
4144 if( hs->buffering.total_bytes_buffered >
4145 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4146 {
4147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4148 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4149 }
4150
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004151 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4152 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004153
4154 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4155 hs->buffering.total_bytes_buffered ) )
4156 {
4157 if( recv_msg_seq_offset > 0 )
4158 {
4159 /* If we can't buffer a future message because
4160 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004161 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4162 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4163 " (already %" MBEDTLS_PRINTF_SIZET
4164 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004165 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004166 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004167 goto exit;
4168 }
Hanno Beckere1801392018-08-21 16:51:05 +01004169 else
4170 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004171 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4172 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4173 " (already %" MBEDTLS_PRINTF_SIZET
4174 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004175 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004176 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004177 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004178
Hanno Beckera02b0b42018-08-21 17:20:27 +01004179 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004180 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004181 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4182 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4183 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4184 " (already %" MBEDTLS_PRINTF_SIZET
4185 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004186 msg_len,
4187 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004188 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004189 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004190 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4191 goto exit;
4192 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004193 }
4194
Paul Elliottd48d5c62021-01-07 14:47:05 +00004195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004196 msg_len ) );
4197
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004198 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4199 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004200 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004201 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004202 goto exit;
4203 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004204 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004205
4206 /* Prepare final header: copy msg_type, length and message_seq,
4207 * then add standardised fragment_offset and fragment_length */
4208 memcpy( hs_buf->data, ssl->in_msg, 6 );
4209 memset( hs_buf->data + 6, 0, 3 );
4210 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4211
4212 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004213
4214 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004215 }
4216 else
4217 {
4218 /* Make sure msg_type and length are consistent */
4219 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4220 {
4221 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4222 /* Ignore */
4223 goto exit;
4224 }
4225 }
4226
Hanno Becker4422bbb2018-08-20 09:40:19 +01004227 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004228 {
4229 size_t frag_len, frag_off;
4230 unsigned char * const msg = hs_buf->data + 12;
4231
4232 /*
4233 * Check and copy current fragment
4234 */
4235
4236 /* Validation of header fields already done in
4237 * mbedtls_ssl_prepare_handshake_record(). */
4238 frag_off = ssl_get_hs_frag_off( ssl );
4239 frag_len = ssl_get_hs_frag_len( ssl );
4240
Paul Elliottd48d5c62021-01-07 14:47:05 +00004241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4242 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004243 frag_off, frag_len ) );
4244 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4245
4246 if( hs_buf->is_fragmented )
4247 {
4248 unsigned char * const bitmask = msg + msg_len;
4249 ssl_bitmask_set( bitmask, frag_off, frag_len );
4250 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4251 msg_len ) == 0 );
4252 }
4253 else
4254 {
4255 hs_buf->is_complete = 1;
4256 }
4257
4258 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4259 hs_buf->is_complete ? "" : "not yet " ) );
4260 }
4261
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004262 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004263 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004264
4265 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004266 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004267 break;
4268 }
4269
4270exit:
4271
4272 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4273 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004274}
4275#endif /* MBEDTLS_SSL_PROTO_DTLS */
4276
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004277MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01004278static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004279{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004280 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004281 * Consume last content-layer message and potentially
4282 * update in_msglen which keeps track of the contents'
4283 * consumption state.
4284 *
4285 * (1) Handshake messages:
4286 * Remove last handshake message, move content
4287 * and adapt in_msglen.
4288 *
4289 * (2) Alert messages:
4290 * Consume whole record content, in_msglen = 0.
4291 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004292 * (3) Change cipher spec:
4293 * Consume whole record content, in_msglen = 0.
4294 *
4295 * (4) Application data:
4296 * Don't do anything - the record layer provides
4297 * the application data as a stream transport
4298 * and consumes through mbedtls_ssl_read only.
4299 *
4300 */
4301
4302 /* Case (1): Handshake messages */
4303 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004304 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004305 /* Hard assertion to be sure that no application data
4306 * is in flight, as corrupting ssl->in_msglen during
4307 * ssl->in_offt != NULL is fatal. */
4308 if( ssl->in_offt != NULL )
4309 {
4310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4311 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4312 }
4313
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004314 /*
4315 * Get next Handshake message in the current record
4316 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004317
Hanno Becker4a810fb2017-05-24 16:27:30 +01004318 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004319 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004320 * current handshake content: If DTLS handshake
4321 * fragmentation is used, that's the fragment
4322 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004323 * size here is faulty and should be changed at
4324 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004325 * (2) While it doesn't seem to cause problems, one
4326 * has to be very careful not to assume that in_hslen
4327 * is always <= in_msglen in a sensible communication.
4328 * Again, it's wrong for DTLS handshake fragmentation.
4329 * The following check is therefore mandatory, and
4330 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004331 * Additionally, ssl->in_hslen might be arbitrarily out of
4332 * bounds after handling a DTLS message with an unexpected
4333 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004334 */
4335 if( ssl->in_hslen < ssl->in_msglen )
4336 {
4337 ssl->in_msglen -= ssl->in_hslen;
4338 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4339 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004340
Hanno Becker4a810fb2017-05-24 16:27:30 +01004341 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4342 ssl->in_msg, ssl->in_msglen );
4343 }
4344 else
4345 {
4346 ssl->in_msglen = 0;
4347 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004348
Hanno Becker4a810fb2017-05-24 16:27:30 +01004349 ssl->in_hslen = 0;
4350 }
4351 /* Case (4): Application data */
4352 else if( ssl->in_offt != NULL )
4353 {
4354 return( 0 );
4355 }
4356 /* Everything else (CCS & Alerts) */
4357 else
4358 {
4359 ssl->in_msglen = 0;
4360 }
4361
Hanno Becker1097b342018-08-15 14:09:41 +01004362 return( 0 );
4363}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004364
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004365MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004366static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4367{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004368 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004369 return( 1 );
4370
4371 return( 0 );
4372}
4373
Hanno Becker5f066e72018-08-16 14:56:31 +01004374#if defined(MBEDTLS_SSL_PROTO_DTLS)
4375
4376static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4377{
4378 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4379 if( hs == NULL )
4380 return;
4381
Hanno Becker01315ea2018-08-21 17:22:17 +01004382 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004383 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004384 hs->buffering.total_bytes_buffered -=
4385 hs->buffering.future_record.len;
4386
4387 mbedtls_free( hs->buffering.future_record.data );
4388 hs->buffering.future_record.data = NULL;
4389 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004390}
4391
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004392MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker5f066e72018-08-16 14:56:31 +01004393static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4394{
4395 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4396 unsigned char * rec;
4397 size_t rec_len;
4398 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004399#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4400 size_t in_buf_len = ssl->in_buf_len;
4401#else
4402 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4403#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004404 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4405 return( 0 );
4406
4407 if( hs == NULL )
4408 return( 0 );
4409
Hanno Becker5f066e72018-08-16 14:56:31 +01004410 rec = hs->buffering.future_record.data;
4411 rec_len = hs->buffering.future_record.len;
4412 rec_epoch = hs->buffering.future_record.epoch;
4413
4414 if( rec == NULL )
4415 return( 0 );
4416
Hanno Becker4cb782d2018-08-20 11:19:05 +01004417 /* Only consider loading future records if the
4418 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004419 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004420 return( 0 );
4421
Hanno Becker5f066e72018-08-16 14:56:31 +01004422 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4423
4424 if( rec_epoch != ssl->in_epoch )
4425 {
4426 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4427 goto exit;
4428 }
4429
4430 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4431
4432 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004433 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004434 {
4435 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4436 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4437 }
4438
4439 memcpy( ssl->in_hdr, rec, rec_len );
4440 ssl->in_left = rec_len;
4441 ssl->next_record_offset = 0;
4442
4443 ssl_free_buffered_record( ssl );
4444
4445exit:
4446 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4447 return( 0 );
4448}
4449
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004450MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker519f15d2019-07-11 12:43:20 +01004451static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4452 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004453{
4454 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004455
4456 /* Don't buffer future records outside handshakes. */
4457 if( hs == NULL )
4458 return( 0 );
4459
4460 /* Only buffer handshake records (we are only interested
4461 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004462 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004463 return( 0 );
4464
4465 /* Don't buffer more than one future epoch record. */
4466 if( hs->buffering.future_record.data != NULL )
4467 return( 0 );
4468
Hanno Becker01315ea2018-08-21 17:22:17 +01004469 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004470 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004471 hs->buffering.total_bytes_buffered ) )
4472 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004473 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4474 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4475 " (already %" MBEDTLS_PRINTF_SIZET
4476 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004477 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004478 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004479 return( 0 );
4480 }
4481
Hanno Becker5f066e72018-08-16 14:56:31 +01004482 /* Buffer record */
4483 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004484 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004485 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004486
4487 /* ssl_parse_record_header() only considers records
4488 * of the next epoch as candidates for buffering. */
4489 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004490 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004491
4492 hs->buffering.future_record.data =
4493 mbedtls_calloc( 1, hs->buffering.future_record.len );
4494 if( hs->buffering.future_record.data == NULL )
4495 {
4496 /* If we run out of RAM trying to buffer a
4497 * record from the next epoch, just ignore. */
4498 return( 0 );
4499 }
4500
Hanno Becker519f15d2019-07-11 12:43:20 +01004501 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004502
Hanno Becker519f15d2019-07-11 12:43:20 +01004503 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004504 return( 0 );
4505}
4506
4507#endif /* MBEDTLS_SSL_PROTO_DTLS */
4508
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004509MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004510static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004511{
Janos Follath865b3eb2019-12-16 11:46:15 +00004512 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004513 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004514
Hanno Becker5f066e72018-08-16 14:56:31 +01004515#if defined(MBEDTLS_SSL_PROTO_DTLS)
4516 /* We might have buffered a future record; if so,
4517 * and if the epoch matches now, load it.
4518 * On success, this call will set ssl->in_left to
4519 * the length of the buffered record, so that
4520 * the calls to ssl_fetch_input() below will
4521 * essentially be no-ops. */
4522 ret = ssl_load_buffered_record( ssl );
4523 if( ret != 0 )
4524 return( ret );
4525#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004526
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004527 /* Ensure that we have enough space available for the default form
4528 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4529 * with no space for CIDs counted in). */
4530 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4531 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004532 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004534 return( ret );
4535 }
4536
Hanno Beckere5e7e782019-07-11 12:29:35 +01004537 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4538 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004539 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004541 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004542 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004543 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4544 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004545 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004546 if( ret != 0 )
4547 return( ret );
4548
4549 /* Fall through to handling of unexpected records */
4550 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4551 }
4552
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004553 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4554 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004555#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004556 /* Reset in pointers to default state for TLS/DTLS records,
4557 * assuming no CID and no offset between record content and
4558 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004559 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004560
Hanno Becker7ae20e02019-07-12 08:33:49 +01004561 /* Setup internal message pointers from record structure. */
4562 ssl->in_msgtype = rec.type;
4563#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4564 ssl->in_len = ssl->in_cid + rec.cid_len;
4565#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4566 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4567 ssl->in_msglen = rec.data_len;
4568
Hanno Becker2fddd372019-07-10 14:37:41 +01004569 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004570 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004571 if( ret != 0 )
4572 return( ret );
4573#endif
4574
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004575 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004576 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004577
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004578 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4579 "(header)" ) );
4580 }
4581 else
4582 {
4583 /* Skip invalid record and the rest of the datagram */
4584 ssl->next_record_offset = 0;
4585 ssl->in_left = 0;
4586
4587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4588 "(header)" ) );
4589 }
4590
4591 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004592 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004593 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004594 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004595#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004596 {
4597 return( ret );
4598 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004599 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004600
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004601#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004602 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004603 {
Hanno Beckera8814792019-07-10 15:01:45 +01004604 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004605 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004606 if( ssl->next_record_offset < ssl->in_left )
4607 {
4608 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4609 }
4610 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004611 else
4612#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004613 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004614 /*
4615 * Fetch record contents from underlying transport.
4616 */
Hanno Beckera3175662019-07-11 12:50:29 +01004617 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004618 if( ret != 0 )
4619 {
4620 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4621 return( ret );
4622 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004623
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004624 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004625 }
4626
4627 /*
4628 * Decrypt record contents.
4629 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004630
Hanno Beckerfdf66042019-07-11 13:07:45 +01004631 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004632 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004634 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004635 {
4636 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004637 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004638 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004639 /* Except when waiting for Finished as a bad mac here
4640 * probably means something went wrong in the handshake
4641 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4642 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4643 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4644 {
4645#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4646 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4647 {
4648 mbedtls_ssl_send_alert_message( ssl,
4649 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4650 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4651 }
4652#endif
4653 return( ret );
4654 }
4655
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004656 if( ssl->conf->badmac_limit != 0 &&
4657 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004658 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4660 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004661 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004662
Hanno Becker4a810fb2017-05-24 16:27:30 +01004663 /* As above, invalid records cause
4664 * dismissal of the whole datagram. */
4665
4666 ssl->next_record_offset = 0;
4667 ssl->in_left = 0;
4668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004670 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004671 }
4672
4673 return( ret );
4674 }
4675 else
4676#endif
4677 {
4678 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004679#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4680 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004682 mbedtls_ssl_send_alert_message( ssl,
4683 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4684 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004685 }
4686#endif
4687 return( ret );
4688 }
4689 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004690
Hanno Becker44d89b22019-07-12 09:40:44 +01004691
4692 /* Reset in pointers to default state for TLS/DTLS records,
4693 * assuming no CID and no offset between record content and
4694 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004695 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004696#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4697 ssl->in_len = ssl->in_cid + rec.cid_len;
4698#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004699 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004700
Hanno Becker8685c822019-07-12 09:37:30 +01004701 /* The record content type may change during decryption,
4702 * so re-read it. */
4703 ssl->in_msgtype = rec.type;
4704 /* Also update the input buffer, because unfortunately
4705 * the server-side ssl_parse_client_hello() reparses the
4706 * record header when receiving a ClientHello initiating
4707 * a renegotiation. */
4708 ssl->in_hdr[0] = rec.type;
4709 ssl->in_msg = rec.buf + rec.data_offset;
4710 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004711 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004712
Simon Butcher99000142016-10-13 17:21:01 +01004713 return( 0 );
4714}
4715
4716int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4717{
Janos Follath865b3eb2019-12-16 11:46:15 +00004718 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004719
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004720 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004721 * Handle particular types of records
4722 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004724 {
Simon Butcher99000142016-10-13 17:21:01 +01004725 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4726 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004727 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004728 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004729 }
4730
Hanno Beckere678eaa2018-08-21 14:57:46 +01004731 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004732 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004733 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004734 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004736 ssl->in_msglen ) );
4737 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004738 }
4739
Hanno Beckere678eaa2018-08-21 14:57:46 +01004740 if( ssl->in_msg[0] != 1 )
4741 {
4742 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4743 ssl->in_msg[0] ) );
4744 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4745 }
4746
4747#if defined(MBEDTLS_SSL_PROTO_DTLS)
4748 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4749 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4750 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4751 {
4752 if( ssl->handshake == NULL )
4753 {
4754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4755 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4756 }
4757
4758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4759 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4760 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004761#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004762
Ronald Cron6f135e12021-12-08 16:57:54 +01004763#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004764 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01004765 {
4766#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4767 MBEDTLS_SSL_DEBUG_MSG( 1,
4768 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4769 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4770#else
4771 MBEDTLS_SSL_DEBUG_MSG( 1,
4772 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4773 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4774#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4775 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004776#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004777 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004779 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004780 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004781 if( ssl->in_msglen != 2 )
4782 {
4783 /* Note: Standard allows for more than one 2 byte alert
4784 to be packed in a single message, but Mbed TLS doesn't
4785 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004787 ssl->in_msglen ) );
4788 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4789 }
4790
Paul Elliott9f352112020-12-09 14:55:45 +00004791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004792 ssl->in_msg[0], ssl->in_msg[1] ) );
4793
4794 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004795 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004799 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004800 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004801 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004802 }
4803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004804 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4805 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004806 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004807 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4808 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004809 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004810
4811#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4812 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4813 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4814 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004815 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004816 /* Will be handled when trying to parse ServerHello */
4817 return( 0 );
4818 }
4819#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004820 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004821 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004822 }
4823
Hanno Beckerc76c6192017-06-06 10:03:17 +01004824#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004825 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004826 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004827 /* Drop unexpected ApplicationData records,
4828 * except at the beginning of renegotiations */
4829 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004830 mbedtls_ssl_is_handshake_over( ssl ) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004831#if defined(MBEDTLS_SSL_RENEGOTIATION)
4832 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4833 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004834#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004835 )
4836 {
4837 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4838 return( MBEDTLS_ERR_SSL_NON_FATAL );
4839 }
4840
4841 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004842 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker37ae9522019-05-03 16:54:26 +01004843 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004844 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004845 }
4846 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004847#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004848
Paul Bakker5121ce52009-01-03 21:22:43 +00004849 return( 0 );
4850}
4851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004852int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004853{
irwir6c0da642019-09-26 21:07:41 +03004854 return( mbedtls_ssl_send_alert_message( ssl,
4855 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4856 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004857}
4858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004859int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004860 unsigned char level,
4861 unsigned char message )
4862{
Janos Follath865b3eb2019-12-16 11:46:15 +00004863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004864
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004865 if( ssl == NULL || ssl->conf == NULL )
4866 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4867
Hanno Becker5e18f742018-08-06 11:35:16 +01004868 if( ssl->out_left != 0 )
4869 return( mbedtls_ssl_flush_output( ssl ) );
4870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004872 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004873
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004874 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004875 ssl->out_msglen = 2;
4876 ssl->out_msg[0] = level;
4877 ssl->out_msg[1] = message;
4878
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02004879 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004881 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004882 return( ret );
4883 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004885
4886 return( 0 );
4887}
4888
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004889int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004890{
Janos Follath865b3eb2019-12-16 11:46:15 +00004891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004892
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004895 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004896 ssl->out_msglen = 1;
4897 ssl->out_msg[0] = 1;
4898
Paul Bakker5121ce52009-01-03 21:22:43 +00004899 ssl->state++;
4900
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004901 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004902 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004903 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004904 return( ret );
4905 }
4906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004908
4909 return( 0 );
4910}
4911
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004912int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004913{
Janos Follath865b3eb2019-12-16 11:46:15 +00004914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004917
Hanno Becker327c93b2018-08-15 13:56:18 +01004918 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004919 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004920 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004921 return( ret );
4922 }
4923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004925 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004926 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004927 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4928 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004929 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004930 }
4931
Hanno Beckere678eaa2018-08-21 14:57:46 +01004932 /* CCS records are only accepted if they have length 1 and content '1',
4933 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004934
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004935 /*
4936 * Switch to our negotiated transform and session parameters for inbound
4937 * data.
4938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004939 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004940 ssl->transform_in = ssl->transform_negotiate;
4941 ssl->session_in = ssl->session_negotiate;
4942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004943#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004944 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004945 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004946#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004947 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004948#endif
4949
4950 /* Increment epoch */
4951 if( ++ssl->in_epoch == 0 )
4952 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004954 /* This is highly unlikely to happen for legitimate reasons, so
4955 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004956 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004957 }
4958 }
4959 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004961 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004962
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004963 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004964
Paul Bakker5121ce52009-01-03 21:22:43 +00004965 ssl->state++;
4966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004968
4969 return( 0 );
4970}
4971
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004972/* Once ssl->out_hdr as the address of the beginning of the
4973 * next outgoing record is set, deduce the other pointers.
4974 *
4975 * Note: For TLS, we save the implicit record sequence number
4976 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4977 * and the caller has to make sure there's space for this.
4978 */
4979
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004980static size_t ssl_transform_get_explicit_iv_len(
4981 mbedtls_ssl_transform const *transform )
4982{
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004983 return( transform->ivlen - transform->fixed_ivlen );
4984}
4985
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004986void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4987 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004988{
4989#if defined(MBEDTLS_SSL_PROTO_DTLS)
4990 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4991 {
4992 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004993#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004994 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004995 ssl->out_len = ssl->out_cid;
4996 if( transform != NULL )
4997 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004998#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004999 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005000#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005001 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005002 }
5003 else
5004#endif
5005 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005006 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005007#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005008 ssl->out_cid = ssl->out_len;
5009#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005010 ssl->out_iv = ssl->out_hdr + 5;
5011 }
5012
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005013 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005014 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005015 if( transform != NULL )
5016 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005017}
5018
5019/* Once ssl->in_hdr as the address of the beginning of the
5020 * next incoming record is set, deduce the other pointers.
5021 *
5022 * Note: For TLS, we save the implicit record sequence number
5023 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5024 * and the caller has to make sure there's space for this.
5025 */
5026
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005027void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005028{
Hanno Becker79594fd2019-05-08 09:38:41 +01005029 /* This function sets the pointers to match the case
5030 * of unprotected TLS/DTLS records, with both ssl->in_iv
5031 * and ssl->in_msg pointing to the beginning of the record
5032 * content.
5033 *
5034 * When decrypting a protected record, ssl->in_msg
5035 * will be shifted to point to the beginning of the
5036 * record plaintext.
5037 */
5038
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005039#if defined(MBEDTLS_SSL_PROTO_DTLS)
5040 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5041 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005042 /* This sets the header pointers to match records
5043 * without CID. When we receive a record containing
5044 * a CID, the fields are shifted accordingly in
5045 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005046 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005047#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005048 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005049 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005050#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005051 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005052#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005053 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005054 }
5055 else
5056#endif
5057 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005058 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005059 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005060#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005061 ssl->in_cid = ssl->in_len;
5062#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005063 ssl->in_iv = ssl->in_hdr + 5;
5064 }
5065
Hanno Becker79594fd2019-05-08 09:38:41 +01005066 /* This will be adjusted at record decryption time. */
5067 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005068}
5069
Paul Bakker5121ce52009-01-03 21:22:43 +00005070/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005071 * Setup an SSL context
5072 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005073
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005074void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005075{
5076 /* Set the incoming and outgoing record pointers. */
5077#if defined(MBEDTLS_SSL_PROTO_DTLS)
5078 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5079 {
5080 ssl->out_hdr = ssl->out_buf;
5081 ssl->in_hdr = ssl->in_buf;
5082 }
5083 else
5084#endif /* MBEDTLS_SSL_PROTO_DTLS */
5085 {
Hanno Becker12078f42021-03-02 15:28:41 +00005086 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005087 ssl->out_hdr = ssl->out_buf + 8;
5088 ssl->in_hdr = ssl->in_buf + 8;
5089 }
5090
5091 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005092 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5093 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005094}
5095
Paul Bakker5121ce52009-01-03 21:22:43 +00005096/*
5097 * SSL get accessors
5098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005099size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005100{
5101 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5102}
5103
Hanno Becker8b170a02017-10-10 11:51:19 +01005104int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5105{
5106 /*
5107 * Case A: We're currently holding back
5108 * a message for further processing.
5109 */
5110
5111 if( ssl->keep_current_message == 1 )
5112 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005113 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005114 return( 1 );
5115 }
5116
5117 /*
5118 * Case B: Further records are pending in the current datagram.
5119 */
5120
5121#if defined(MBEDTLS_SSL_PROTO_DTLS)
5122 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5123 ssl->in_left > ssl->next_record_offset )
5124 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005125 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005126 return( 1 );
5127 }
5128#endif /* MBEDTLS_SSL_PROTO_DTLS */
5129
5130 /*
5131 * Case C: A handshake message is being processed.
5132 */
5133
Hanno Becker8b170a02017-10-10 11:51:19 +01005134 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5135 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005136 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005137 return( 1 );
5138 }
5139
5140 /*
5141 * Case D: An application data message is being processed
5142 */
5143 if( ssl->in_offt != NULL )
5144 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005145 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005146 return( 1 );
5147 }
5148
5149 /*
5150 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005151 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005152 * we implement support for multiple alerts in single records.
5153 */
5154
5155 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5156 return( 0 );
5157}
5158
Paul Bakker43ca69c2011-01-15 17:35:19 +00005159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005160int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005161{
Hanno Becker3136ede2018-08-17 15:28:19 +01005162 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005163 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005164 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005165#if defined(MBEDTLS_USE_PSA_CRYPTO)
5166 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5167 psa_key_type_t key_type;
5168#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005169
Hanno Becker5903de42019-05-03 14:46:38 +01005170 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5171
Hanno Becker78640902018-08-13 16:35:15 +01005172 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005173 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005174
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005175
5176#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005177 if ( transform->psa_alg == PSA_ALG_GCM ||
5178 transform->psa_alg == PSA_ALG_CCM ||
5179 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5180 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005181 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005182 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005183 transform_expansion = transform->minlen;
5184 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005185 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005186 {
5187 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5188 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005189
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005190 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005191
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005192 /* Expansion due to the addition of the MAC. */
5193 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005194
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005195 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005196 * Theoretically up to 256 bytes, but we never use
5197 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005198 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005199
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005200 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005201 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005202#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005203 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005204#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005205 }
5206 else
5207 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005208 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005209 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005210 }
5211#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005212 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005213 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005214 case MBEDTLS_MODE_GCM:
5215 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005216 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005217 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005218 transform_expansion = transform->minlen;
5219 break;
5220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005221 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005222
5223 block_size = mbedtls_cipher_get_block_size(
5224 &transform->cipher_ctx_enc );
5225
Hanno Becker3136ede2018-08-17 15:28:19 +01005226 /* Expansion due to the addition of the MAC. */
5227 transform_expansion += transform->maclen;
5228
5229 /* Expansion due to the addition of CBC padding;
5230 * Theoretically up to 256 bytes, but we never use
5231 * more than the block size of the underlying cipher. */
5232 transform_expansion += block_size;
5233
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005234 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005235 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005236#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005237 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005238#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005239
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005240 break;
5241
5242 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005243 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005244 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005245 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005246#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005247
Hanno Beckera0e20d02019-05-15 14:03:01 +01005248#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005249 if( transform->out_cid_len != 0 )
5250 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005251#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005252
Hanno Becker5903de42019-05-03 14:46:38 +01005253 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005254}
5255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005256#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005257/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005258 * Check record counters and renegotiate if they're above the limit.
5259 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005260MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005261static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005262{
Hanno Beckerdd772292020-02-05 10:38:31 +00005263 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005264 int in_ctr_cmp;
5265 int out_ctr_cmp;
5266
Paul Elliott27b0d942022-03-18 21:55:32 +00005267 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005269 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005270 {
5271 return( 0 );
5272 }
5273
Andres AG2196c7f2016-12-15 17:01:16 +00005274 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005275 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005276 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005277 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5278 &ssl->conf->renego_period[ep_len],
5279 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005280
5281 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005282 {
5283 return( 0 );
5284 }
5285
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005287 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005288}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005289#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005290
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5292
5293#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005294MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005295static int ssl_tls13_check_new_session_ticket( mbedtls_ssl_context *ssl )
5296{
5297
5298 if( ( ssl->in_hslen == mbedtls_ssl_hs_hdr_len( ssl ) ) ||
5299 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET ) )
5300 {
5301 return( 0 );
5302 }
5303
5304 ssl->keep_current_message = 1;
5305
5306 MBEDTLS_SSL_DEBUG_MSG( 3, ( "NewSessionTicket received" ) );
5307 mbedtls_ssl_handshake_set_state( ssl,
Jerry Yua357cf42022-07-12 05:36:45 +00005308 MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005309
5310 return( MBEDTLS_ERR_SSL_WANT_READ );
5311}
5312#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5313
Jerry Yua0446a02022-07-13 11:22:55 +08005314MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005315static int ssl_tls13_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
5316{
5317
5318 MBEDTLS_SSL_DEBUG_MSG( 3, ( "received post-handshake message" ) );
5319
5320#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
5321 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5322 {
5323 int ret = ssl_tls13_check_new_session_ticket( ssl );
5324 if( ret != 0 )
5325 return( ret );
5326 }
5327#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5328
5329 /* Fail in all other cases. */
5330 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5331}
5332#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5333
5334#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005335/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005336 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005337 * may only be sent for the purpose of initiating renegotiations.
5338 *
5339 * This function is introduced as a separate helper since the handling
5340 * of post-handshake handshake messages changes significantly in TLS 1.3,
5341 * and having a helper function allows to distinguish between TLS <= 1.2 and
5342 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5343 */
Jerry Yua0446a02022-07-13 11:22:55 +08005344MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005345static int ssl_tls12_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005346{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005347 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005348
5349 /*
5350 * - For client-side, expect SERVER_HELLO_REQUEST.
5351 * - For server-side, expect CLIENT_HELLO.
5352 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5353 */
5354
5355#if defined(MBEDTLS_SSL_CLI_C)
5356 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5357 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5358 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5359 {
5360 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5361
5362 /* With DTLS, drop the packet (probably from last handshake) */
5363#if defined(MBEDTLS_SSL_PROTO_DTLS)
5364 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5365 {
5366 return( 0 );
5367 }
5368#endif
5369 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5370 }
5371#endif /* MBEDTLS_SSL_CLI_C */
5372
5373#if defined(MBEDTLS_SSL_SRV_C)
5374 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5375 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5376 {
5377 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5378
5379 /* With DTLS, drop the packet (probably from last handshake) */
5380#if defined(MBEDTLS_SSL_PROTO_DTLS)
5381 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5382 {
5383 return( 0 );
5384 }
5385#endif
5386 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5387 }
5388#endif /* MBEDTLS_SSL_SRV_C */
5389
5390#if defined(MBEDTLS_SSL_RENEGOTIATION)
5391 /* Determine whether renegotiation attempt should be accepted */
5392 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5393 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5394 ssl->conf->allow_legacy_renegotiation ==
5395 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5396 {
5397 /*
5398 * Accept renegotiation request
5399 */
5400
5401 /* DTLS clients need to know renego is server-initiated */
5402#if defined(MBEDTLS_SSL_PROTO_DTLS)
5403 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5404 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5405 {
5406 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5407 }
5408#endif
5409 ret = mbedtls_ssl_start_renegotiation( ssl );
5410 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5411 ret != 0 )
5412 {
5413 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5414 ret );
5415 return( ret );
5416 }
5417 }
5418 else
5419#endif /* MBEDTLS_SSL_RENEGOTIATION */
5420 {
5421 /*
5422 * Refuse renegotiation
5423 */
5424
5425 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5426
TRodziewicz345165c2021-07-06 13:42:11 +02005427 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5428 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5429 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005430 {
TRodziewicz345165c2021-07-06 13:42:11 +02005431 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005432 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005433 }
5434
5435 return( 0 );
5436}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005437#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5438
5439MBEDTLS_CHECK_RETURN_CRITICAL
5440static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
5441{
5442 /* Check protocol version and dispatch accordingly. */
5443#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5444 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
5445 {
5446 return( ssl_tls13_handle_hs_message_post_handshake( ssl ) );
5447 }
5448#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5449
5450#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5451 if( ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 )
5452 {
5453 return( ssl_tls12_handle_hs_message_post_handshake( ssl ) );
5454 }
5455#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5456
5457 /* Should never happen */
5458 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5459}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005460
Paul Bakker48916f92012-09-16 19:57:18 +00005461/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005462 * Receive application data decrypted from the SSL layer
5463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005465{
Janos Follath865b3eb2019-12-16 11:46:15 +00005466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005467 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005468
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005469 if( ssl == NULL || ssl->conf == NULL )
5470 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5471
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005475 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005476 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005478 return( ret );
5479
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005480 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005482 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005483 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005484 return( ret );
5485 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005486 }
5487#endif
5488
Hanno Becker4a810fb2017-05-24 16:27:30 +01005489 /*
5490 * Check if renegotiation is necessary and/or handshake is
5491 * in process. If yes, perform/continue, and fall through
5492 * if an unexpected packet is received while the client
5493 * is waiting for the ServerHello.
5494 *
5495 * (There is no equivalent to the last condition on
5496 * the server-side as it is not treated as within
5497 * a handshake while waiting for the ClientHello
5498 * after a renegotiation request.)
5499 */
5500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005501#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005502 ret = ssl_check_ctr_renegotiate( ssl );
5503 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5504 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005507 return( ret );
5508 }
5509#endif
5510
Paul Elliott27b0d942022-03-18 21:55:32 +00005511 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005513 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005514 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5515 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005516 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005518 return( ret );
5519 }
5520 }
5521
Hanno Beckere41158b2017-10-23 13:30:32 +01005522 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005523 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005524 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005525 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005526 if( ssl->f_get_timer != NULL &&
5527 ssl->f_get_timer( ssl->p_timer ) == -1 )
5528 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005529 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005530 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005531
Hanno Becker327c93b2018-08-15 13:56:18 +01005532 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005533 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005534 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5535 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005536
Hanno Becker4a810fb2017-05-24 16:27:30 +01005537 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5538 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005539 }
5540
5541 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005542 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005543 {
5544 /*
5545 * OpenSSL sends empty messages to randomize the IV
5546 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005547 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005548 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005549 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005550 return( 0 );
5551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005552 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005553 return( ret );
5554 }
5555 }
5556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005557 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005558 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005559 ret = ssl_handle_hs_message_post_handshake( ssl );
5560 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005561 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005562 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5563 ret );
5564 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005565 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005566
Hanno Beckerf26cc722021-04-21 07:30:13 +01005567 /* At this point, we don't know whether the renegotiation triggered
5568 * by the post-handshake message has been completed or not. The cases
5569 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005570 * 1) The renegotiation is complete. In this case, no new record
5571 * has been read yet.
5572 * 2) The renegotiation is incomplete because the client received
5573 * an application data record while awaiting the ServerHello.
5574 * 3) The renegotiation is incomplete because the client received
5575 * a non-handshake, non-application data message while awaiting
5576 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005577 *
5578 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005579 * - For 1), the next iteration will read a new record and check
5580 * if it's application data.
5581 * - For 2), the loop condition isn't satisfied as application data
5582 * is present, hence continue is the same as break
5583 * - For 3), the loop condition is satisfied and read_record
5584 * will re-deliver the message that was held back by the client
5585 * when expecting the ServerHello.
5586 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005587
Hanno Becker90333da2017-10-10 11:27:13 +01005588 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005589 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005590#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005591 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005592 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005593 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005594 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005595 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005596 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005598 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005599 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005600 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005601 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005602 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005603#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005605 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5606 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005607 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005608 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005609 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005610 }
5611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005612 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5615 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005616 }
5617
5618 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005619
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005620 /* We're going to return something now, cancel timer,
5621 * except if handshake (renegotiation) is in progress */
Paul Elliott27b0d942022-03-18 21:55:32 +00005622 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker0f57a652020-02-05 10:37:26 +00005623 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005624
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005625#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005626 /* If we requested renego but received AppData, resend HelloRequest.
5627 * Do it now, after setting in_offt, to avoid taking this branch
5628 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005629#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005630 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005631 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005632 {
Hanno Becker786300f2020-02-05 10:46:40 +00005633 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005634 {
Hanno Becker786300f2020-02-05 10:46:40 +00005635 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5636 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005637 return( ret );
5638 }
5639 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005641#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005642 }
5643
5644 n = ( len < ssl->in_msglen )
5645 ? len : ssl->in_msglen;
5646
5647 memcpy( buf, ssl->in_offt, n );
5648 ssl->in_msglen -= n;
5649
gabor-mezei-arma3214132020-07-15 10:55:00 +02005650 /* Zeroising the plaintext buffer to erase unused application data
5651 from the memory. */
5652 mbedtls_platform_zeroize( ssl->in_offt, n );
5653
Paul Bakker5121ce52009-01-03 21:22:43 +00005654 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005655 {
5656 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005657 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005658 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005659 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005660 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005661 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005662 /* more data available */
5663 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005664 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005666 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005667
Paul Bakker23986e52011-04-24 08:57:21 +00005668 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005669}
5670
5671/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005672 * Send application data to be encrypted by the SSL layer, taking care of max
5673 * fragment length and buffer size.
5674 *
5675 * According to RFC 5246 Section 6.2.1:
5676 *
5677 * Zero-length fragments of Application data MAY be sent as they are
5678 * potentially useful as a traffic analysis countermeasure.
5679 *
5680 * Therefore, it is possible that the input message length is 0 and the
5681 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005682 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005683MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005684static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005685 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005686{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005687 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5688 const size_t max_len = (size_t) ret;
5689
5690 if( ret < 0 )
5691 {
5692 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5693 return( ret );
5694 }
5695
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005696 if( len > max_len )
5697 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005699 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005700 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005702 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5703 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005704 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005705 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005706 }
5707 else
5708#endif
5709 len = max_len;
5710 }
Paul Bakker887bd502011-06-08 13:10:54 +00005711
Paul Bakker5121ce52009-01-03 21:22:43 +00005712 if( ssl->out_left != 0 )
5713 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005714 /*
5715 * The user has previously tried to send the data and
5716 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5717 * written. In this case, we expect the high-level write function
5718 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005721 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005722 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005723 return( ret );
5724 }
5725 }
Paul Bakker887bd502011-06-08 13:10:54 +00005726 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005727 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005728 /*
5729 * The user is trying to send a message the first time, so we need to
5730 * copy the data into the internal buffers and setup the data structure
5731 * to keep track of partial writes
5732 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005733 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005734 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005735 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005736
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02005737 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005738 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005739 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005740 return( ret );
5741 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005742 }
5743
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005744 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005745}
5746
5747/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005748 * Write application data (public-facing wrapper)
5749 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005750int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005751{
Janos Follath865b3eb2019-12-16 11:46:15 +00005752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005753
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005755
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005756 if( ssl == NULL || ssl->conf == NULL )
5757 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5758
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005759#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005760 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5761 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005762 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005763 return( ret );
5764 }
5765#endif
5766
Paul Elliott27b0d942022-03-18 21:55:32 +00005767 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005768 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005769 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005770 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005771 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005772 return( ret );
5773 }
5774 }
5775
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005776 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005777
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005779
5780 return( ret );
5781}
5782
5783/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005784 * Notify the peer that the connection is being closed
5785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005786int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005787{
Janos Follath865b3eb2019-12-16 11:46:15 +00005788 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005789
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005790 if( ssl == NULL || ssl->conf == NULL )
5791 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005794
Paul Elliott27b0d942022-03-18 21:55:32 +00005795 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005797 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5798 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5799 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005800 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005801 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005802 return( ret );
5803 }
5804 }
5805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005807
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005808 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005809}
5810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005811void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005812{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005813 if( transform == NULL )
5814 return;
5815
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005816#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005817 psa_destroy_key( transform->psa_key_enc );
5818 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005819#else
5820 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5821 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5822#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005823
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005824#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005825#if defined(MBEDTLS_USE_PSA_CRYPTO)
5826 psa_destroy_key( transform->psa_mac_enc );
5827 psa_destroy_key( transform->psa_mac_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005828#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005829 mbedtls_md_free( &transform->md_ctx_enc );
5830 mbedtls_md_free( &transform->md_ctx_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005831#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005832#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005833
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005834 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005835}
5836
Jerry Yuc7875b52021-09-05 21:05:50 +08005837void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5838 mbedtls_ssl_transform *transform )
5839{
Jerry Yuc7875b52021-09-05 21:05:50 +08005840 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005841 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005842}
5843
5844void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5845 mbedtls_ssl_transform *transform )
5846{
5847 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005848 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005849}
5850
Hanno Becker0271f962018-08-16 13:23:47 +01005851#if defined(MBEDTLS_SSL_PROTO_DTLS)
5852
Hanno Becker533ab5f2020-02-05 10:49:13 +00005853void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005854{
5855 unsigned offset;
5856 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5857
5858 if( hs == NULL )
5859 return;
5860
Hanno Becker283f5ef2018-08-24 09:34:47 +01005861 ssl_free_buffered_record( ssl );
5862
Hanno Becker0271f962018-08-16 13:23:47 +01005863 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005864 ssl_buffering_free_slot( ssl, offset );
5865}
5866
5867static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5868 uint8_t slot )
5869{
5870 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5871 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005872
5873 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5874 return;
5875
Hanno Beckere605b192018-08-21 15:59:07 +01005876 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005877 {
Hanno Beckere605b192018-08-21 15:59:07 +01005878 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005879 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005880 mbedtls_free( hs_buf->data );
5881 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005882 }
5883}
5884
5885#endif /* MBEDTLS_SSL_PROTO_DTLS */
5886
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005887/*
5888 * Convert version numbers to/from wire format
5889 * and, for DTLS, to/from TLS equivalent.
5890 *
5891 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005892 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005893 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005894 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005895 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005896void mbedtls_ssl_write_version( unsigned char version[2], int transport,
5897 mbedtls_ssl_protocol_version tls_version )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005898{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005899#if defined(MBEDTLS_SSL_PROTO_DTLS)
5900 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005901 tls_version =
5902 ~( tls_version - ( tls_version == 0x0302 ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005903#else
5904 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005905#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005906 MBEDTLS_PUT_UINT16_BE( tls_version, version, 0 );
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005907}
5908
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005909uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
5910 int transport )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005911{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005912 uint16_t tls_version = MBEDTLS_GET_UINT16_BE( version, 0 );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005913#if defined(MBEDTLS_SSL_PROTO_DTLS)
5914 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005915 tls_version =
5916 ~( tls_version - ( tls_version == 0xfeff ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005917#else
5918 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005919#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005920 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005921}
5922
Jerry Yue7047812021-09-13 19:26:39 +08005923/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005924 * Send pending fatal alert.
5925 * 0, No alert message.
5926 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5927 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005928 */
5929int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5930{
5931 int ret;
5932
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005933 /* No pending alert, return success*/
5934 if( ssl->send_alert == 0 )
5935 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005936
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005937 ret = mbedtls_ssl_send_alert_message( ssl,
5938 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5939 ssl->alert_type );
5940
Jerry Yu3bf1f972021-09-22 21:37:18 +08005941 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5942 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005943 */
5944 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5945 {
5946 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005947 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005948
5949 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005950 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005951
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005952 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005953}
5954
Jerry Yu394ece62021-09-14 22:17:21 +08005955/*
5956 * Set pending fatal alert flag.
5957 */
5958void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5959 unsigned char alert_type,
5960 int alert_reason )
5961{
5962 ssl->send_alert = 1;
5963 ssl->alert_type = alert_type;
5964 ssl->alert_reason = alert_reason;
5965}
5966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005967#endif /* MBEDTLS_SSL_TLS_C */