blob: 58e6af2a563e0f60c109e5612f1e0ba52986e35b [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#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010030
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000031#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000032#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000033#include "mbedtls/debug.h"
34#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050035#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010036#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020037#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020038#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020039
Rich Evans00ab4702015-02-06 13:43:58 +000040#include <string.h>
41
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
43#include "mbedtls/psa_util.h"
44#include "psa/crypto.h"
45#endif
46
Janos Follath23bdca02016-10-07 14:47:14 +010047#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020049#endif
50
Hanno Beckercd9dcda2018-08-28 17:18:56 +010051static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010052
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020053/*
54 * Start a timer.
55 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020056 */
Hanno Becker0f57a652020-02-05 10:37:26 +000057void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020058{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020059 if( ssl->f_set_timer == NULL )
60 return;
61
62 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
63 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064}
65
66/*
67 * Return -1 is timer is expired, 0 if it isn't.
68 */
Hanno Becker7876d122020-02-05 10:39:31 +000069int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020071 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020072 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020073
74 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020075 {
76 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020077 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020079
80 return( 0 );
81}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020082
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020083MBEDTLS_CHECK_RETURN_CRITICAL
TRodziewicz4ca18aa2021-05-20 14:46:20 +020084static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
85 unsigned char *buf,
86 size_t len,
87 mbedtls_record *rec );
88
89int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t buflen )
92{
93 int ret = 0;
94 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
95 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
96
97 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +020098 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +020099 */
100 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
101 {
102 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
103 goto exit;
104 }
105#if defined(MBEDTLS_SSL_PROTO_DTLS)
106 else
107 {
108 mbedtls_record rec;
109
110 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
111 if( ret != 0 )
112 {
113 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
114 goto exit;
115 }
116
117 if( ssl->transform_in != NULL )
118 {
119 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
120 if( ret != 0 )
121 {
122 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
123 goto exit;
124 }
125 }
126 }
127#endif /* MBEDTLS_SSL_PROTO_DTLS */
128
129exit:
130 /* On success, we have decrypted the buffer in-place, so make
131 * sure we don't leak any plaintext data. */
132 mbedtls_platform_zeroize( buf, buflen );
133
134 /* For the purpose of this API, treat messages with unexpected CID
135 * as well as such from future epochs as unexpected. */
136 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
137 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
138 {
139 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
140 }
141
142 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
143 return( ret );
144}
145
Hanno Becker67bc7c32018-08-06 11:33:50 +0100146#define SSL_DONT_FORCE_FLUSH 0
147#define SSL_FORCE_FLUSH 1
148
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200149#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100150
Hanno Beckerd5847772018-08-28 10:09:23 +0100151/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100152static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
153 uint8_t slot );
154static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200155MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100156static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200157MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100158static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200159MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100160static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200161MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker519f15d2019-07-11 12:43:20 +0100162static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
163 mbedtls_record const *rec );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200164MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200182MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker67bc7c32018-08-06 11:33:50 +0100183static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
184{
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 size_t const bytes_written = ssl->out_left;
186 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100187
188 /* Double-check that the write-index hasn't gone
189 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100190 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100191 {
192 /* Should never happen... */
193 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
194 }
195
196 return( (int) ( mtu - bytes_written ) );
197}
198
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200199MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker67bc7c32018-08-06 11:33:50 +0100200static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
201{
Janos Follath865b3eb2019-12-16 11:46:15 +0000202 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400204 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100205
206#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400207 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100208
209 if( max_len > mfl )
210 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100211
212 /* By the standard (RFC 6066 Sect. 4), the MFL extension
213 * only limits the maximum record payload size, so in theory
214 * we would be allowed to pack multiple records of payload size
215 * MFL into a single datagram. However, this would mean that there's
216 * no way to explicitly communicate MTU restrictions to the peer.
217 *
218 * The following reduction of max_len makes sure that we never
219 * write datagrams larger than MFL + Record Expansion Overhead.
220 */
221 if( max_len <= ssl->out_left )
222 return( 0 );
223
224 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100225#endif
226
227 ret = ssl_get_remaining_space_in_datagram( ssl );
228 if( ret < 0 )
229 return( ret );
230 remaining = (size_t) ret;
231
232 ret = mbedtls_ssl_get_record_expansion( ssl );
233 if( ret < 0 )
234 return( ret );
235 expansion = (size_t) ret;
236
237 if( remaining <= expansion )
238 return( 0 );
239
240 remaining -= expansion;
241 if( remaining >= max_len )
242 remaining = max_len;
243
244 return( (int) remaining );
245}
246
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200247/*
248 * Double the retransmit timeout value, within the allowed range,
249 * returning -1 if the maximum value has already been reached.
250 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200251MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200253{
254 uint32_t new_timeout;
255
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200256 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200257 return( -1 );
258
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200259 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
260 * in the following way: after the initial transmission and a first
261 * retransmission, back off to a temporary estimated MTU of 508 bytes.
262 * This value is guaranteed to be deliverable (if not guaranteed to be
263 * delivered) of any compliant IPv4 (and IPv6) network, and should work
264 * on most non-IP stacks too. */
265 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400266 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400268 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
269 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200270
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200271 new_timeout = 2 * ssl->handshake->retransmit_timeout;
272
273 /* Avoid arithmetic overflow and range overflow */
274 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200275 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200277 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200278 }
279
280 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000281 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
282 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200283
284 return( 0 );
285}
286
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200288{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200289 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000290 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
291 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200292}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200294
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100295/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000296 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200297 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000298
Ronald Cron6f135e12021-12-08 16:57:54 +0100299#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100300
301static size_t ssl_compute_padding_length( size_t len,
302 size_t granularity )
303{
304 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
305}
306
Hanno Becker581bc1b2020-05-04 12:20:03 +0100307/* This functions transforms a (D)TLS plaintext fragment and a record content
308 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
309 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
310 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100311 *
312 * struct {
313 * opaque content[DTLSPlaintext.length];
314 * ContentType real_type;
315 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100316 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100317 *
318 * Input:
319 * - `content`: The beginning of the buffer holding the
320 * plaintext to be wrapped.
321 * - `*content_size`: The length of the plaintext in Bytes.
322 * - `max_len`: The number of Bytes available starting from
323 * `content`. This must be `>= *content_size`.
324 * - `rec_type`: The desired record content type.
325 *
326 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100327 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
328 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100329 *
330 * Returns:
331 * - `0` on success.
332 * - A negative error code if `max_len` didn't offer enough space
333 * for the expansion.
334 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200335MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker581bc1b2020-05-04 12:20:03 +0100336static int ssl_build_inner_plaintext( unsigned char *content,
337 size_t *content_size,
338 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100339 uint8_t rec_type,
340 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100341{
342 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100343
344 /* Write real content type */
345 if( remaining == 0 )
346 return( -1 );
347 content[ len ] = rec_type;
348 len++;
349 remaining--;
350
351 if( remaining < pad )
352 return( -1 );
353 memset( content + len, 0, pad );
354 len += pad;
355 remaining -= pad;
356
357 *content_size = len;
358 return( 0 );
359}
360
Hanno Becker581bc1b2020-05-04 12:20:03 +0100361/* This function parses a (D)TLSInnerPlaintext structure.
362 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200363MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker581bc1b2020-05-04 12:20:03 +0100364static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100365 size_t *content_size,
366 uint8_t *rec_type )
367{
368 size_t remaining = *content_size;
369
370 /* Determine length of padding by skipping zeroes from the back. */
371 do
372 {
373 if( remaining == 0 )
374 return( -1 );
375 remaining--;
376 } while( content[ remaining ] == 0 );
377
378 *content_size = remaining;
379 *rec_type = content[ remaining ];
380
381 return( 0 );
382}
Ronald Cron6f135e12021-12-08 16:57:54 +0100383#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100384
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200385/* The size of the `add_data` structure depends on various
386 * factors, namely
387 *
388 * 1) CID functionality disabled
389 *
390 * additional_data =
391 * 8: seq_num +
392 * 1: type +
393 * 2: version +
394 * 2: length of inner plaintext +
395 *
396 * size = 13 bytes
397 *
398 * 2) CID functionality based on RFC 9146 enabled
399 *
400 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
401 * = 23 + CID-length
402 *
403 * 3) CID functionality based on legacy CID version
404 according to draft-ietf-tls-dtls-connection-id-05
405 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
406 *
407 * size = 13 + 1 + CID-length
408 *
409 * More information about the CID usage:
410 *
411 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
412 * size of the additional data structure is calculated as:
413 *
414 * additional_data =
415 * 8: seq_num +
416 * 1: tls12_cid +
417 * 2: DTLSCipherText.version +
418 * n: cid +
419 * 1: cid_length +
420 * 2: length_of_DTLSInnerPlaintext
421 *
422 * Per RFC 9146 the size of the add_data structure is calculated as:
423 *
424 * additional_data =
425 * 8: seq_num_placeholder +
426 * 1: tls12_cid +
427 * 1: cid_length +
428 * 1: tls12_cid +
429 * 2: DTLSCiphertext.version +
430 * 2: epoch +
431 * 6: sequence_number +
432 * n: cid +
433 * 2: length_of_DTLSInnerPlaintext
434 *
435 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000436static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100437 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100438 mbedtls_record *rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400439 mbedtls_ssl_protocol_version
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200440 tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000441 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000442{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200443 /* Several types of ciphers have been defined for use with TLS and DTLS,
444 * and the MAC calculations for those ciphers differ slightly. Further
445 * variants were added when the CID functionality was added with RFC 9146.
446 * This implementations also considers the use of a legacy version of the
447 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
448 * which is used in deployments.
449 *
450 * We will distinguish between the non-CID and the CID cases below.
451 *
452 * --- Non-CID cases ---
453 *
454 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100455 *
456 * additional_data = seq_num + TLSCompressed.type +
457 * TLSCompressed.version + TLSCompressed.length;
458 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100459 * For TLS 1.3, the record sequence number is dropped from the AAD
460 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000461 * Moreover, the additional data involves the length of the TLS
462 * ciphertext, not the TLS plaintext as in earlier versions.
463 * Quoting RFC 8446 (TLS 1.3):
464 *
465 * additional_data = TLSCiphertext.opaque_type ||
466 * TLSCiphertext.legacy_record_version ||
467 * TLSCiphertext.length
468 *
469 * We pass the tag length to this function in order to compute the
470 * ciphertext length from the inner plaintext length rec->data_len via
471 *
472 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
473 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200474 * --- CID cases ---
475 *
476 * RFC 9146 uses a common pattern when constructing the data
477 * passed into a MAC / AEAD cipher.
478 *
479 * Data concatenation for MACs used with block ciphers with
480 * Encrypt-then-MAC Processing (with CID):
481 *
482 * data = seq_num_placeholder +
483 * tls12_cid +
484 * cid_length +
485 * tls12_cid +
486 * DTLSCiphertext.version +
487 * epoch +
488 * sequence_number +
489 * cid +
490 * DTLSCiphertext.length +
491 * IV +
492 * ENC(content + padding + padding_length)
493 *
494 * Data concatenation for MACs used with block ciphers (with CID):
495 *
496 * data = seq_num_placeholder +
497 * tls12_cid +
498 * cid_length +
499 * tls12_cid +
500 * DTLSCiphertext.version +
501 * epoch +
502 * sequence_number +
503 * cid +
504 * length_of_DTLSInnerPlaintext +
505 * DTLSInnerPlaintext.content +
506 * DTLSInnerPlaintext.real_type +
507 * DTLSInnerPlaintext.zeros
508 *
509 * AEAD ciphers use the following additional data calculation (with CIDs):
510 *
511 * additional_data = seq_num_placeholder +
512 * tls12_cid +
513 * cid_length +
514 * tls12_cid +
515 * DTLSCiphertext.version +
516 * epoch +
517 * sequence_number +
518 * cid +
519 * length_of_DTLSInnerPlaintext
520 *
521 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
522 * defines the additional data calculation as follows:
523 *
524 * additional_data = seq_num +
525 * tls12_cid +
526 * DTLSCipherText.version +
527 * cid +
528 * cid_length +
529 * length_of_DTLSInnerPlaintext
530 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100531
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100532 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000533 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100534
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200535#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
536 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
537 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
538#endif
539
Ronald Cron6f135e12021-12-08 16:57:54 +0100540#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400541 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000542 {
543 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
544 * which differs from the length of the TLSInnerPlaintext
545 * by the length of the authentication tag. */
546 ad_len_field += taglen;
547 }
548 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100549#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100550 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400551 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000552 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200553
554#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
555
556#if MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
557 if( rec->cid_len != 0 )
558 {
559 // seq_num_placeholder
560 memcpy( cur, seq_num_placeholder, sizeof(seq_num_placeholder) );
561 cur += sizeof( seq_num_placeholder );
562
563 // tls12_cid type
564 *cur = rec->type;
565 cur++;
566
567 // cid_length
568 *cur = rec->cid_len;
569 cur++;
570 }
571 else
572 {
573 // epoch + sequence number
574 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
575 cur += sizeof( rec->ctr );
576 }
577#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0 */
578#else
579 // epoch + sequence number
580 memcpy(cur, rec->ctr, sizeof(rec->ctr));
581 cur += sizeof(rec->ctr);
582#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100583 }
584
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200585 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100586 *cur = rec->type;
587 cur++;
588
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200589 // version
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100590 memcpy( cur, rec->ver, sizeof( rec->ver ) );
591 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100592
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200593#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
594 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
595
596 if (rec->cid_len != 0)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100597 {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200598 // CID
599 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100600 cur += rec->cid_len;
601
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200602 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100603 *cur = rec->cid_len;
604 cur++;
605
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200606 // length of inner plaintext
607 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
608 cur += 2;
609 }
610 else
611#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
612 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
613
614 if( rec->cid_len != 0 )
615 {
616 // epoch + sequence number
617 memcpy(cur, rec->ctr, sizeof(rec->ctr));
618 cur += sizeof(rec->ctr);
619
620 // CID
621 memcpy( cur, rec->cid, rec->cid_len );
622 cur += rec->cid_len;
623
624 // length of inner plaintext
Joe Subbiani6dd73642021-07-19 11:56:54 +0100625 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100626 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100627 }
628 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100629#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100630 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100631 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100632 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100633 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100634
635 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000636}
637
Hanno Becker67a37db2020-05-28 16:27:07 +0100638#if defined(MBEDTLS_GCM_C) || \
639 defined(MBEDTLS_CCM_C) || \
640 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200641MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100642static int ssl_transform_aead_dynamic_iv_is_explicit(
643 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100644{
Hanno Becker17263802020-05-28 07:05:48 +0100645 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100646}
647
Hanno Becker17263802020-05-28 07:05:48 +0100648/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
649 *
650 * Concretely, this occurs in two variants:
651 *
652 * a) Fixed and dynamic IV lengths add up to total IV length, giving
653 * IV = fixed_iv || dynamic_iv
654 *
Hanno Becker15952812020-06-04 13:31:46 +0100655 * This variant is used in TLS 1.2 when used with GCM or CCM.
656 *
Hanno Becker17263802020-05-28 07:05:48 +0100657 * b) Fixed IV lengths matches total IV length, giving
658 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100659 *
660 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
661 *
662 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100663 *
664 * This function has the precondition that
665 *
666 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
667 *
668 * which has to be ensured by the caller. If this precondition
669 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100670 */
671static void ssl_build_record_nonce( unsigned char *dst_iv,
672 size_t dst_iv_len,
673 unsigned char const *fixed_iv,
674 size_t fixed_iv_len,
675 unsigned char const *dynamic_iv,
676 size_t dynamic_iv_len )
677{
678 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100679
680 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100681 memset( dst_iv, 0, dst_iv_len );
682 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100683
Hanno Becker17263802020-05-28 07:05:48 +0100684 dst_iv += dst_iv_len - dynamic_iv_len;
685 for( i = 0; i < dynamic_iv_len; i++ )
686 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100687}
Hanno Becker67a37db2020-05-28 16:27:07 +0100688#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100689
Hanno Beckera18d1322018-01-03 14:27:32 +0000690int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
691 mbedtls_ssl_transform *transform,
692 mbedtls_record *rec,
693 int (*f_rng)(void *, unsigned char *, size_t),
694 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000695{
Neil Armstrong136f8402022-03-30 10:58:01 +0200696 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100697 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 unsigned char * data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200699 /* For an explanation of the additional data length see
700 * the descrpition of ssl_extract_add_data_from_record().
701 */
702#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
703 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
704#else
705 unsigned char add_data[13];
706#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100707 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000708 size_t post_avail;
709
710 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000711#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200712 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000713 ((void) ssl);
714#endif
715
716 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200717 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200718#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200719 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000720 ((void) f_rng);
721 ((void) p_rng);
722#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000725
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100727 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
729 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
730 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100731 if( rec == NULL
732 || rec->buf == NULL
733 || rec->buf_len < rec->data_offset
734 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100735#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100736 || rec->cid_len != 0
737#endif
738 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000739 {
740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100742 }
743
Neil Armstrongab555e02022-04-04 11:07:59 +0200744 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Neil Armstrong136f8402022-03-30 10:58:01 +0200745
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000746 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100747 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749 data, rec->data_len );
750
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000751 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
752 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
754 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000755 rec->data_len,
756 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000757 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
758 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100759
Hanno Becker92313402020-05-20 13:58:58 +0100760 /* The following two code paths implement the (D)TLSInnerPlaintext
761 * structure present in TLS 1.3 and DTLS 1.2 + CID.
762 *
763 * See ssl_build_inner_plaintext() for more information.
764 *
765 * Note that this changes `rec->data_len`, and hence
766 * `post_avail` needs to be recalculated afterwards.
767 *
768 * Note also that the two code paths cannot occur simultaneously
769 * since they apply to different versions of the protocol. There
770 * is hence no risk of double-addition of the inner plaintext.
771 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100772#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400773 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100774 {
Hanno Becker13996922020-05-28 16:15:19 +0100775 size_t padding =
776 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200777 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100778 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100779 &rec->data_len,
780 post_avail,
781 rec->type,
782 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100783 {
784 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
785 }
786
787 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
788 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100789#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100790
Hanno Beckera0e20d02019-05-15 14:03:01 +0100791#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100792 /*
793 * Add CID information
794 */
795 rec->cid_len = transform->out_cid_len;
796 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
797 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100798
799 if( rec->cid_len != 0 )
800 {
Hanno Becker13996922020-05-28 16:15:19 +0100801 size_t padding =
802 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200803 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100804 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100805 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100806 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100807 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100808 * Note that this changes `rec->data_len`, and hence
809 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100810 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100811 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100812 &rec->data_len,
813 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100814 rec->type,
815 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100816 {
817 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
818 }
819
820 rec->type = MBEDTLS_SSL_MSG_CID;
821 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100822#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100823
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100824 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
825
Paul Bakker5121ce52009-01-03 21:22:43 +0000826 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100827 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000828 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000829#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +0200830 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
831 ssl_mode == MBEDTLS_SSL_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000832 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000833 if( post_avail < transform->maclen )
834 {
835 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
836 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
837 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200838#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200839 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100841#if defined(MBEDTLS_USE_PSA_CRYPTO)
842 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
843 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
844 size_t sign_mac_length = 0;
845#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +0000846
TRodziewicz345165c2021-07-06 13:42:11 +0200847 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400848 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000849 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000850
Neil Armstrong26e6d672022-02-23 09:30:33 +0100851#if defined(MBEDTLS_USE_PSA_CRYPTO)
852 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
853 transform->psa_mac_alg );
854 if( status != PSA_SUCCESS )
855 goto hmac_failed_etm_disabled;
856
857 status = psa_mac_update( &operation, add_data, add_data_len );
858 if( status != PSA_SUCCESS )
859 goto hmac_failed_etm_disabled;
860
861 status = psa_mac_update( &operation, data, rec->data_len );
862 if( status != PSA_SUCCESS )
863 goto hmac_failed_etm_disabled;
864
865 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
866 &sign_mac_length );
867 if( status != PSA_SUCCESS )
868 goto hmac_failed_etm_disabled;
869#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100870 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
871 add_data_len );
872 if( ret != 0 )
873 goto hmac_failed_etm_disabled;
874 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
875 if( ret != 0 )
876 goto hmac_failed_etm_disabled;
877 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
878 if( ret != 0 )
879 goto hmac_failed_etm_disabled;
880 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
881 if( ret != 0 )
882 goto hmac_failed_etm_disabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100883#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000884
TRodziewicz345165c2021-07-06 13:42:11 +0200885 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200886#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200887
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000888 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
889 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200890
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000891 rec->data_len += transform->maclen;
892 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100893 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100894
895 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100896 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +0100897#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +0100898 ret = psa_ssl_status_to_mbedtls( status );
899 status = psa_mac_abort( &operation );
900 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +0100901 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +0100902#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100903 if( ret != 0 )
904 {
905 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
906 return( ret );
907 }
Paul Bakker577e0062013-08-28 11:57:20 +0200908 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000909#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000910
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200911 /*
912 * Encrypt
913 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000914#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +0200915 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000916 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000917 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000918 "including %d bytes of padding",
919 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000920
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100921 /* The only supported stream cipher is "NULL",
922 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000923 }
Paul Bakker68884e32013-01-07 18:20:04 +0100924 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000925#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000926
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200927#if defined(MBEDTLS_GCM_C) || \
928 defined(MBEDTLS_CCM_C) || \
929 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +0200930 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000931 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200932 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100933 unsigned char *dynamic_iv;
934 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100935 int dynamic_iv_is_explicit =
936 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100937#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100938 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100939#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000941
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100942 /* Check that there's space for the authentication tag. */
943 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000944 {
945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
946 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
947 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000948
Paul Bakker68884e32013-01-07 18:20:04 +0100949 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100950 * Build nonce for AEAD encryption.
951 *
952 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
953 * part of the IV is prepended to the ciphertext and
954 * can be chosen freely - in particular, it need not
955 * agree with the record sequence number.
956 * However, since ChaChaPoly as well as all AEAD modes
957 * in TLS 1.3 use the record sequence number as the
958 * dynamic part of the nonce, we uniformly use the
959 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100960 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100961 dynamic_iv = rec->ctr;
962 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200963
Hanno Becker17263802020-05-28 07:05:48 +0100964 ssl_build_record_nonce( iv, sizeof( iv ),
965 transform->iv_enc,
966 transform->fixed_ivlen,
967 dynamic_iv,
968 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100969
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100970 /*
971 * Build additional data for AEAD encryption.
972 * This depends on the TLS version.
973 */
974 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400975 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000976 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100977
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200978 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100979 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200980 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100981 dynamic_iv,
982 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000983 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100984 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000985 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200986 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000987 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000988
Paul Bakker68884e32013-01-07 18:20:04 +0100989 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200990 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200991 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100992#if defined(MBEDTLS_USE_PSA_CRYPTO)
993 status = psa_aead_encrypt( transform->psa_key_enc,
994 transform->psa_alg,
995 iv, transform->ivlen,
996 add_data, add_data_len,
997 data, rec->data_len,
998 data, rec->buf_len - (data - rec->buf),
999 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001000
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001001 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001002 {
1003 ret = psa_ssl_status_to_mbedtls( status );
1004 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
1005 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001006 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001007#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001008 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001009 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001010 add_data, add_data_len,
1011 data, rec->data_len, /* src */
1012 data, rec->buf_len - (data - rec->buf), /* dst */
1013 &rec->data_len,
1014 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001015 {
TRodziewicz18efb732021-04-29 23:12:19 +02001016 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001017 return( ret );
1018 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001019#endif /* MBEDTLS_USE_PSA_CRYPTO */
1020
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001021 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001022 data + rec->data_len - transform->taglen,
1023 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +01001024 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001025 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001026
1027 /*
1028 * Prefix record content with dynamic IV in case it is explicit.
1029 */
Hanno Becker1cda2662020-06-04 13:28:28 +01001030 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001031 {
1032 if( rec->data_offset < dynamic_iv_len )
1033 {
1034 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1035 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1036 }
1037
1038 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
1039 rec->data_offset -= dynamic_iv_len;
1040 rec->data_len += dynamic_iv_len;
1041 }
1042
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001043 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001044 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001045 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +01001046#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001048 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1049 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001050 {
Janos Follath865b3eb2019-12-16 11:46:15 +00001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001052 size_t padlen, i;
1053 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001054#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001055 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001056 size_t part_len;
1057 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1058#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001059
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001060 /* Currently we're always using minimal padding
1061 * (up to 255 bytes would be allowed). */
1062 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
1063 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001064 padlen = 0;
1065
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001066 /* Check there's enough space in the buffer for the padding. */
1067 if( post_avail < padlen + 1 )
1068 {
1069 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1070 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1071 }
1072
Paul Bakker5121ce52009-01-03 21:22:43 +00001073 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001074 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001075
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001076 rec->data_len += padlen + 1;
1077 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001078
TRodziewicz0f82ec62021-05-12 17:49:18 +02001079#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001080 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001081 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001082 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001083 */
TRodziewicz345165c2021-07-06 13:42:11 +02001084 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001085 {
TRodziewicz345165c2021-07-06 13:42:11 +02001086 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
1087 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001088 }
TRodziewicz345165c2021-07-06 13:42:11 +02001089
1090 if( rec->data_offset < transform->ivlen )
1091 {
1092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1093 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1094 }
1095
1096 /*
1097 * Generate IV
1098 */
1099 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
1100 if( ret != 0 )
1101 return( ret );
1102
1103 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001104#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001105
Paul Elliottd48d5c62021-01-07 14:47:05 +00001106 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1107 "including %" MBEDTLS_PRINTF_SIZET
1108 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001109 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001110 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001111
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001112#if defined(MBEDTLS_USE_PSA_CRYPTO)
1113 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001114 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001115
1116 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001117 {
1118 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001119 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_encrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001120 return( ret );
1121 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001122
1123 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
1124
1125 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001126 {
1127 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001128 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001129 return( ret );
1130
1131 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001132
1133 status = psa_cipher_update( &cipher_op,
1134 data, rec->data_len,
1135 data, rec->data_len, &olen );
1136
1137 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001138 {
1139 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001140 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001141 return( ret );
1142
1143 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001144
1145 status = psa_cipher_finish( &cipher_op,
1146 data + olen, rec->data_len - olen,
1147 &part_len );
1148
1149 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001150 {
1151 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001152 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001153 return( ret );
1154
1155 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001156
1157 olen += part_len;
1158#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001159 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
1160 transform->iv_enc,
1161 transform->ivlen,
1162 data, rec->data_len,
1163 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001164 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001166 return( ret );
1167 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001168#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001169
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001170 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001171 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1173 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001174 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001175
TRodziewicz0f82ec62021-05-12 17:49:18 +02001176 data -= transform->ivlen;
1177 rec->data_offset -= transform->ivlen;
1178 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001181 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001182 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001183 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001184#if defined(MBEDTLS_USE_PSA_CRYPTO)
1185 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1186 size_t sign_mac_length = 0;
1187#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001188
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001189 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001190 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001191
1192 if( post_avail < transform->maclen)
1193 {
1194 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1195 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1196 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001197
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001198 ssl_extract_add_data_from_record( add_data, &add_data_len,
Glenn Strauss07c64162022-03-14 12:34:51 -04001199 rec, transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001200 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001203 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001204 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001205#if defined(MBEDTLS_USE_PSA_CRYPTO)
1206 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
1207 transform->psa_mac_alg );
1208 if( status != PSA_SUCCESS )
1209 goto hmac_failed_etm_enabled;
1210
1211 status = psa_mac_update( &operation, add_data, add_data_len );
1212 if( status != PSA_SUCCESS )
1213 goto hmac_failed_etm_enabled;
1214
1215 status = psa_mac_update( &operation, data, rec->data_len );
1216 if( status != PSA_SUCCESS )
1217 goto hmac_failed_etm_enabled;
1218
1219 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
1220 &sign_mac_length );
1221 if( status != PSA_SUCCESS )
1222 goto hmac_failed_etm_enabled;
1223#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001224
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001225 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1226 add_data_len );
1227 if( ret != 0 )
1228 goto hmac_failed_etm_enabled;
1229 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1230 data, rec->data_len );
1231 if( ret != 0 )
1232 goto hmac_failed_etm_enabled;
1233 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1234 if( ret != 0 )
1235 goto hmac_failed_etm_enabled;
1236 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1237 if( ret != 0 )
1238 goto hmac_failed_etm_enabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001239#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001240
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001241 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001242
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001243 rec->data_len += transform->maclen;
1244 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001245 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001246
1247 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001248 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001249#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001250 ret = psa_ssl_status_to_mbedtls( status );
1251 status = psa_mac_abort( &operation );
1252 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001253 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +01001254#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001255 if( ret != 0 )
1256 {
1257 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1258 return( ret );
1259 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001260 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001261#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001262 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001263 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001264#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001265 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1267 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001268 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001269
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001270 /* Make extra sure authentication was performed, exactly once */
1271 if( auth_done != 1 )
1272 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1274 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001275 }
1276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001278
1279 return( 0 );
1280}
1281
Hanno Becker605949f2019-07-12 08:23:59 +01001282int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001283 mbedtls_ssl_transform *transform,
1284 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001285{
Przemek Stekiel4c499272022-09-27 13:55:37 +02001286#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001287 size_t olen;
Przemek Stekiel4c499272022-09-27 13:55:37 +02001288#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001289 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001290 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001291
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001292 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001293#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001294 size_t padlen = 0, correct = 1;
1295#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001296 unsigned char* data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001297 /* For an explanation of the additional data length see
1298 * the descrpition of ssl_extract_add_data_from_record().
1299 */
1300#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1301 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1302#else
1303 unsigned char add_data[13];
1304#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001305 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001306
Hanno Beckera18d1322018-01-03 14:27:32 +00001307#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001308 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001309 ((void) ssl);
1310#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001313 if( rec == NULL ||
1314 rec->buf == NULL ||
1315 rec->buf_len < rec->data_offset ||
1316 rec->buf_len - rec->data_offset < rec->data_len )
1317 {
1318 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001320 }
1321
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001322 data = rec->buf + rec->data_offset;
Neil Armstrongab555e02022-04-04 11:07:59 +02001323 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Paul Bakker5121ce52009-01-03 21:22:43 +00001324
Hanno Beckera0e20d02019-05-15 14:03:01 +01001325#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001326 /*
1327 * Match record's CID with incoming CID.
1328 */
Hanno Becker938489a2019-05-08 13:02:22 +01001329 if( rec->cid_len != transform->in_cid_len ||
1330 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1331 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001332 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001333 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001334#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001335
Hanno Beckerd086bf02021-03-22 13:01:27 +00001336#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +02001337 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001338 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001339 /* The only supported stream cipher is "NULL",
1340 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001341 }
Paul Bakker68884e32013-01-07 18:20:04 +01001342 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001343#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001344#if defined(MBEDTLS_GCM_C) || \
1345 defined(MBEDTLS_CCM_C) || \
1346 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +02001347 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001348 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001349 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001350 unsigned char *dynamic_iv;
1351 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001352#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001353 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001354#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001355
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001356 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001357 * Extract dynamic part of nonce for AEAD decryption.
1358 *
1359 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1360 * part of the IV is prepended to the ciphertext and
1361 * can be chosen freely - in particular, it need not
1362 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001363 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001364 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001365 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001366 {
1367 if( rec->data_len < dynamic_iv_len )
1368 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1370 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001371 rec->data_len,
1372 dynamic_iv_len ) );
1373 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1374 }
1375 dynamic_iv = data;
1376
1377 data += dynamic_iv_len;
1378 rec->data_offset += dynamic_iv_len;
1379 rec->data_len -= dynamic_iv_len;
1380 }
Hanno Becker17263802020-05-28 07:05:48 +01001381 else
1382 {
1383 dynamic_iv = rec->ctr;
1384 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001385
1386 /* Check that there's space for the authentication tag. */
1387 if( rec->data_len < transform->taglen )
1388 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1390 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001391 rec->data_len,
1392 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001393 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001394 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001395 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001396
Hanno Beckerdf8be222020-05-21 15:30:57 +01001397 /*
1398 * Prepare nonce from dynamic and static parts.
1399 */
Hanno Becker17263802020-05-28 07:05:48 +01001400 ssl_build_record_nonce( iv, sizeof( iv ),
1401 transform->iv_dec,
1402 transform->fixed_ivlen,
1403 dynamic_iv,
1404 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001405
Hanno Beckerdf8be222020-05-21 15:30:57 +01001406 /*
1407 * Build additional data for AEAD encryption.
1408 * This depends on the TLS version.
1409 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001410 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001411 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001412 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001413 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001414 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001415
Hanno Beckerd96a6522019-07-10 13:55:25 +01001416 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001417 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001418 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001419 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001420 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001421
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001422 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001423 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001424 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001425
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001426 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001427 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001428 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001429#if defined(MBEDTLS_USE_PSA_CRYPTO)
1430 status = psa_aead_decrypt( transform->psa_key_dec,
1431 transform->psa_alg,
1432 iv, transform->ivlen,
1433 add_data, add_data_len,
1434 data, rec->data_len + transform->taglen,
1435 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001436 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001437
1438 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001439 {
1440 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001441 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001442 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001443 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001444#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001445 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001446 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001447 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001448 data, rec->data_len + transform->taglen, /* src */
1449 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001450 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001451 {
TRodziewicz18efb732021-04-29 23:12:19 +02001452 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1455 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001456
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001457 return( ret );
1458 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001459#endif /* MBEDTLS_USE_PSA_CRYPTO */
1460
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001461 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001462
Hanno Beckerd96a6522019-07-10 13:55:25 +01001463 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001464 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001465 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1467 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001468 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001469 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001470 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001472#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001473 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1474 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001475 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001476 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001477#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001478 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001479 size_t part_len;
1480 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1481#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001482
Paul Bakker5121ce52009-01-03 21:22:43 +00001483 /*
Paul Bakker45829992013-01-03 14:52:21 +01001484 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001485 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001486#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001487 /* The ciphertext is prefixed with the CBC IV. */
1488 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001489#endif
Paul Bakker45829992013-01-03 14:52:21 +01001490
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001491 /* Size considerations:
1492 *
1493 * - The CBC cipher text must not be empty and hence
1494 * at least of size transform->ivlen.
1495 *
1496 * Together with the potential IV-prefix, this explains
1497 * the first of the two checks below.
1498 *
1499 * - The record must contain a MAC, either in plain or
1500 * encrypted, depending on whether Encrypt-then-MAC
1501 * is used or not.
1502 * - If it is, the message contains the IV-prefix,
1503 * the CBC ciphertext, and the MAC.
1504 * - If it is not, the padded plaintext, and hence
1505 * the CBC ciphertext, has at least length maclen + 1
1506 * because there is at least the padding length byte.
1507 *
1508 * As the CBC ciphertext is not empty, both cases give the
1509 * lower bound minlen + maclen + 1 on the record size, which
1510 * we test for in the second check below.
1511 */
1512 if( rec->data_len < minlen + transform->ivlen ||
1513 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001514 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1516 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1517 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001518 "+ 1 ) ( + expl IV )", rec->data_len,
1519 transform->ivlen,
1520 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001522 }
1523
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001524 /*
1525 * Authenticate before decrypt if enabled
1526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001528 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001529 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001530#if defined(MBEDTLS_USE_PSA_CRYPTO)
1531 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1532#else
Hanno Becker992b6872017-11-09 18:57:39 +00001533 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001534#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001537
Hanno Beckerd96a6522019-07-10 13:55:25 +01001538 /* Update data_len in tandem with add_data.
1539 *
1540 * The subtraction is safe because of the previous check
1541 * data_len >= minlen + maclen + 1.
1542 *
1543 * Afterwards, we know that data + data_len is followed by at
1544 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001545 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001546 *
1547 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001548 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001549 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001550 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001551 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001552
Hanno Beckerd96a6522019-07-10 13:55:25 +01001553 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001554 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1555 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001556#if defined(MBEDTLS_USE_PSA_CRYPTO)
1557 status = psa_mac_verify_setup( &operation, transform->psa_mac_dec,
1558 transform->psa_mac_alg );
1559 if( status != PSA_SUCCESS )
1560 goto hmac_failed_etm_enabled;
1561
1562 status = psa_mac_update( &operation, add_data, add_data_len );
1563 if( status != PSA_SUCCESS )
1564 goto hmac_failed_etm_enabled;
1565
1566 status = psa_mac_update( &operation, data, rec->data_len );
1567 if( status != PSA_SUCCESS )
1568 goto hmac_failed_etm_enabled;
1569
1570 /* Compare expected MAC with MAC at the end of the record. */
1571 status = psa_mac_verify_finish( &operation, data + rec->data_len,
1572 transform->maclen );
1573 if( status != PSA_SUCCESS )
1574 goto hmac_failed_etm_enabled;
1575#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001576 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1577 add_data_len );
1578 if( ret != 0 )
1579 goto hmac_failed_etm_enabled;
1580 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001581 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001582 if( ret != 0 )
1583 goto hmac_failed_etm_enabled;
1584 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1585 if( ret != 0 )
1586 goto hmac_failed_etm_enabled;
1587 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1588 if( ret != 0 )
1589 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001590
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001591 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1592 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001593 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001594 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001595
Hanno Beckerd96a6522019-07-10 13:55:25 +01001596 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001597 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001598 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001599 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001601 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1602 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001603 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001604#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001605 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001606
1607 hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001608#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001609 ret = psa_ssl_status_to_mbedtls( status );
1610 status = psa_mac_abort( &operation );
1611 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001612 ret = psa_ssl_status_to_mbedtls( status );
1613#else
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001614 mbedtls_platform_zeroize( mac_expect, transform->maclen );
Neil Armstrong4313f552022-03-02 15:14:07 +01001615#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001616 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001617 {
1618 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1619 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001620 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001621 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001622 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001624
1625 /*
1626 * Check length sanity
1627 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001628
1629 /* We know from above that data_len > minlen >= 0,
1630 * so the following check in particular implies that
1631 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001632 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001633 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001634 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1635 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001636 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001638 }
1639
TRodziewicz0f82ec62021-05-12 17:49:18 +02001640#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001641 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001642 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001643 */
TRodziewicz345165c2021-07-06 13:42:11 +02001644 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1645 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001646
TRodziewicz345165c2021-07-06 13:42:11 +02001647 data += transform->ivlen;
1648 rec->data_offset += transform->ivlen;
1649 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001650#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001651
Hanno Beckerd96a6522019-07-10 13:55:25 +01001652 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1653
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001654#if defined(MBEDTLS_USE_PSA_CRYPTO)
1655 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001656 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001657
1658 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001659 {
1660 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001661 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001662 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001663 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001664
1665 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1666
1667 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001668 {
1669 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001670 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001671 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001672 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001673
1674 status = psa_cipher_update( &cipher_op,
1675 data, rec->data_len,
1676 data, rec->data_len, &olen );
1677
1678 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001679 {
1680 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001681 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001682 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001683 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001684
1685 status = psa_cipher_finish( &cipher_op,
1686 data + olen, rec->data_len - olen,
1687 &part_len );
1688
1689 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001690 {
1691 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001692 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001693 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001694 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001695
1696 olen += part_len;
1697#else
1698
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001699 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1700 transform->iv_dec, transform->ivlen,
1701 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001702 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001704 return( ret );
1705 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001706#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001707
Hanno Beckerd96a6522019-07-10 13:55:25 +01001708 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001709 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001710 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1712 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001713 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001714
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001715 /* Safe since data_len >= minlen + maclen + 1, so after having
1716 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001717 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1718 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001719 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001720
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001721 if( auth_done == 1 )
1722 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001723 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001724 rec->data_len,
1725 padlen + 1 );
1726 correct &= mask;
1727 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001728 }
1729 else
Paul Bakker45829992013-01-03 14:52:21 +01001730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001732 if( rec->data_len < transform->maclen + padlen + 1 )
1733 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1735 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1736 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001737 rec->data_len,
1738 transform->maclen,
1739 padlen + 1 ) );
1740 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001741#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001742
Gabor Mezei90437e32021-10-20 11:59:27 +02001743 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001744 rec->data_len,
1745 transform->maclen + padlen + 1 );
1746 correct &= mask;
1747 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001748 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001749
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001750 padlen++;
1751
1752 /* Regardless of the validity of the padding,
1753 * we have data_len >= padlen here. */
1754
TRodziewicz0f82ec62021-05-12 17:49:18 +02001755#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001756 /* The padding check involves a series of up to 256
1757 * consecutive memory reads at the end of the record
1758 * plaintext buffer. In order to hide the length and
1759 * validity of the padding, always perform exactly
1760 * `min(256,plaintext_len)` reads (but take into account
1761 * only the last `padlen` bytes for the padding check). */
1762 size_t pad_count = 0;
1763 volatile unsigned char* const check = data;
1764
1765 /* Index of first padding byte; it has been ensured above
1766 * that the subtraction is safe. */
1767 size_t const padding_idx = rec->data_len - padlen;
1768 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1769 size_t const start_idx = rec->data_len - num_checks;
1770 size_t idx;
1771
1772 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001773 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001774 /* pad_count += (idx >= padding_idx) &&
1775 * (check[idx] == padlen - 1);
1776 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001777 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1778 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001779 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001780 pad_count += mask & equal;
1781 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001782 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001783
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001784#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001785 if( padlen > 0 && correct == 0 )
1786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001787#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001788 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001789
TRodziewicz0f82ec62021-05-12 17:49:18 +02001790#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001791
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001792 /* If the padding was found to be invalid, padlen == 0
1793 * and the subtraction is safe. If the padding was found valid,
1794 * padlen hasn't been changed and the previous assertion
1795 * data_len >= padlen still holds. */
1796 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001797 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001798 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001799#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001800 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1802 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001803 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001804
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001805#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001807 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001808#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001809
1810 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001811 * Authenticate if not done yet.
1812 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001813 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001814#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001815 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001816 {
Paul Elliott5260ce22022-05-09 18:15:54 +01001817 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1818 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001819
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001820 /* If the initial value of padlen was such that
1821 * data_len < maclen + padlen + 1, then padlen
1822 * got reset to 1, and the initial check
1823 * data_len >= minlen + maclen + 1
1824 * guarantees that at this point we still
1825 * have at least data_len >= maclen.
1826 *
1827 * If the initial value of padlen was such that
1828 * data_len >= maclen + padlen + 1, then we have
1829 * subtracted either padlen + 1 (if the padding was correct)
1830 * or 0 (if the padding was incorrect) since then,
1831 * hence data_len >= maclen in any case.
1832 */
1833 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001834 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001835 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001836 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001837
TRodziewicz0f82ec62021-05-12 17:49:18 +02001838#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001839 /*
Andrzej Kurek46a98732022-10-17 08:11:11 -04001840 * The next two sizes are the minimum and maximum values of
1841 * data_len over all padlen values.
1842 *
1843 * They're independent of padlen, since we previously did
1844 * data_len -= padlen.
1845 *
1846 * Note that max_len + maclen is never more than the buffer
1847 * length, as we previously did in_msglen -= maclen too.
1848 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001849 const size_t max_len = rec->data_len + padlen;
1850 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1851
Neil Armstronge8589962022-02-25 15:14:29 +01001852#if defined(MBEDTLS_USE_PSA_CRYPTO)
1853 ret = mbedtls_ct_hmac( transform->psa_mac_dec,
1854 transform->psa_mac_alg,
1855 add_data, add_data_len,
1856 data, rec->data_len, min_len, max_len,
1857 mac_expect );
1858#else
Gabor Mezei90437e32021-10-20 11:59:27 +02001859 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001860 add_data, add_data_len,
1861 data, rec->data_len, min_len, max_len,
1862 mac_expect );
Neil Armstronge8589962022-02-25 15:14:29 +01001863#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001864 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001865 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001866 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001867 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001868 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001869
Gabor Mezei90437e32021-10-20 11:59:27 +02001870 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001871 rec->data_len,
1872 min_len, max_len,
1873 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001874#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001875
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001876#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001877 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001878 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001879#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001880
Gabor Mezei90437e32021-10-20 11:59:27 +02001881 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001882 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001883 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884#if defined(MBEDTLS_SSL_DEBUG_ALL)
1885 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001886#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001887 correct = 0;
1888 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001889 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001890
1891 hmac_failed_etm_disabled:
1892 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1893 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1894 if( ret != 0 )
1895 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001896 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001897
1898 /*
1899 * Finally check the correct flag
1900 */
1901 if( correct == 0 )
1902 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001903#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001904
1905 /* Make extra sure authentication was performed, exactly once */
1906 if( auth_done != 1 )
1907 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1909 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001910 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001911
Ronald Cron6f135e12021-12-08 16:57:54 +01001912#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04001913 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +01001914 {
1915 /* Remove inner padding and infer true content type. */
1916 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1917 &rec->type );
1918
1919 if( ret != 0 )
1920 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1921 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001922#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001923
Hanno Beckera0e20d02019-05-15 14:03:01 +01001924#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001925 if( rec->cid_len != 0 )
1926 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001927 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1928 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001929 if( ret != 0 )
1930 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1931 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001932#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001935
1936 return( 0 );
1937}
1938
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001939#undef MAC_NONE
1940#undef MAC_PLAINTEXT
1941#undef MAC_CIPHERTEXT
1942
Paul Bakker5121ce52009-01-03 21:22:43 +00001943/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001944 * Fill the input message buffer by appending data to it.
1945 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001946 *
1947 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1948 * available (from this read and/or a previous one). Otherwise, an error code
1949 * is returned (possibly EOF or WANT_READ).
1950 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001951 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1952 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1953 * since we always read a whole datagram at once.
1954 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001955 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001956 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001959{
Janos Follath865b3eb2019-12-16 11:46:15 +00001960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001961 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001962#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1963 size_t in_buf_len = ssl->in_buf_len;
1964#else
1965 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1966#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001969
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001970 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1971 {
Jan Brucknerf869bfd2022-11-07 15:28:49 +01001972 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001974 }
1975
Darryl Greenb33cc762019-11-28 14:29:44 +00001976 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001977 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1979 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001980 }
1981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001983 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001984 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001985 uint32_t timeout;
1986
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001987 /*
1988 * The point is, we need to always read a full datagram at once, so we
1989 * sometimes read more then requested, and handle the additional data.
1990 * It could be the rest of the current record (while fetching the
1991 * header) and/or some other records in the same datagram.
1992 */
1993
1994 /*
1995 * Move to the next record in the already read datagram if applicable
1996 */
1997 if( ssl->next_record_offset != 0 )
1998 {
1999 if( ssl->in_left < ssl->next_record_offset )
2000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2002 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002003 }
2004
2005 ssl->in_left -= ssl->next_record_offset;
2006
2007 if( ssl->in_left != 0 )
2008 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002009 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
2010 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002011 ssl->next_record_offset ) );
2012 memmove( ssl->in_hdr,
2013 ssl->in_hdr + ssl->next_record_offset,
2014 ssl->in_left );
2015 }
2016
2017 ssl->next_record_offset = 0;
2018 }
2019
Paul Elliottd48d5c62021-01-07 14:47:05 +00002020 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2021 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00002022 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002023
2024 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002025 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002026 */
2027 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002028 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002030 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002031 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002032
2033 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002034 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002035 * are not at the beginning of a new record, the caller did something
2036 * wrong.
2037 */
2038 if( ssl->in_left != 0 )
2039 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2041 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002042 }
2043
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002044 /*
2045 * Don't even try to read if time's out already.
2046 * This avoids by-passing the timer when repeatedly receiving messages
2047 * that will end up being dropped.
2048 */
Hanno Becker7876d122020-02-05 10:39:31 +00002049 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01002050 {
2051 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002052 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01002053 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002054 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002055 {
Darryl Greenb33cc762019-11-28 14:29:44 +00002056 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002057
Paul Elliott27b0d942022-03-18 21:55:32 +00002058 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002059 timeout = ssl->handshake->retransmit_timeout;
2060 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002061 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002062
Paul Elliott9f352112020-12-09 14:55:45 +00002063 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002064
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002065 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002066 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2067 timeout );
2068 else
2069 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002072
2073 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002075 }
2076
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002077 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002078 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002080 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002081
Paul Elliott27b0d942022-03-18 21:55:32 +00002082 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002083 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002084 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2085 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002087 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002088 }
2089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002091 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002093 return( ret );
2094 }
2095
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002096 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002097 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002099 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002100 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002101 {
Hanno Becker786300f2020-02-05 10:46:40 +00002102 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002103 {
Hanno Becker786300f2020-02-05 10:46:40 +00002104 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2105 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002106 return( ret );
2107 }
2108
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002109 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002110 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002112 }
2113
Paul Bakker5121ce52009-01-03 21:22:43 +00002114 if( ret < 0 )
2115 return( ret );
2116
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002117 ssl->in_left = ret;
2118 }
2119 else
2120#endif
2121 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2123 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002124 ssl->in_left, nb_want ) );
2125
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002126 while( ssl->in_left < nb_want )
2127 {
2128 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002129
Hanno Becker7876d122020-02-05 10:39:31 +00002130 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002131 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2132 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002133 {
2134 if( ssl->f_recv_timeout != NULL )
2135 {
2136 ret = ssl->f_recv_timeout( ssl->p_bio,
2137 ssl->in_hdr + ssl->in_left, len,
2138 ssl->conf->read_timeout );
2139 }
2140 else
2141 {
2142 ret = ssl->f_recv( ssl->p_bio,
2143 ssl->in_hdr + ssl->in_left, len );
2144 }
2145 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002146
Paul Elliottd48d5c62021-01-07 14:47:05 +00002147 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2148 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002149 ssl->in_left, nb_want ) );
2150 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002151
2152 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002154
2155 if( ret < 0 )
2156 return( ret );
2157
makise-homuraaf9513b2020-08-24 18:26:27 +03002158 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002159 {
Darryl Green11999bb2018-03-13 15:22:58 +00002160 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002161 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002162 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002163 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2164 }
2165
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002166 ssl->in_left += ret;
2167 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002168 }
2169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002171
2172 return( 0 );
2173}
2174
2175/*
2176 * Flush any data not yet written
2177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002179{
Janos Follath865b3eb2019-12-16 11:46:15 +00002180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002181 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002184
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002185 if( ssl->f_send == NULL )
2186 {
Jan Brucknerf869bfd2022-11-07 15:28:49 +01002187 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002189 }
2190
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002191 /* Avoid incrementing counter if data is flushed */
2192 if( ssl->out_left == 0 )
2193 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002195 return( 0 );
2196 }
2197
Paul Bakker5121ce52009-01-03 21:22:43 +00002198 while( ssl->out_left > 0 )
2199 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002200 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2201 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002202 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002203
Hanno Becker2b1e3542018-08-06 11:19:13 +01002204 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002205 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002207 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002208
2209 if( ret <= 0 )
2210 return( ret );
2211
makise-homuraaf9513b2020-08-24 18:26:27 +03002212 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002213 {
Darryl Green11999bb2018-03-13 15:22:58 +00002214 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002215 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002216 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002217 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2218 }
2219
Paul Bakker5121ce52009-01-03 21:22:43 +00002220 ssl->out_left -= ret;
2221 }
2222
Hanno Becker2b1e3542018-08-06 11:19:13 +01002223#if defined(MBEDTLS_SSL_PROTO_DTLS)
2224 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002225 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002226 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002227 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002228 else
2229#endif
2230 {
2231 ssl->out_hdr = ssl->out_buf + 8;
2232 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002233 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002234
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002235 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002236
2237 return( 0 );
2238}
2239
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002240/*
2241 * Functions to handle the DTLS retransmission state machine
2242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002243#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002244/*
2245 * Append current handshake message to current outgoing flight
2246 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002247MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002249{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002251 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2252 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2253 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254
2255 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002256 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002257 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002258 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002260 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002261 }
2262
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002263 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002264 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002265 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2266 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002269 }
2270
2271 /* Copy current handshake message with headers */
2272 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2273 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002274 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002275 msg->next = NULL;
2276
2277 /* Append to the current flight */
2278 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002279 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002280 else
2281 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002282 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002283 while( cur->next != NULL )
2284 cur = cur->next;
2285 cur->next = msg;
2286 }
2287
Hanno Becker3b235902018-08-06 09:54:53 +01002288 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002289 return( 0 );
2290}
2291
2292/*
2293 * Free the current flight of handshake messages
2294 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002295void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002296{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297 mbedtls_ssl_flight_item *cur = flight;
2298 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002299
2300 while( cur != NULL )
2301 {
2302 next = cur->next;
2303
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304 mbedtls_free( cur->p );
2305 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002306
2307 cur = next;
2308 }
2309}
2310
2311/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002312 * Swap transform_out and out_ctr with the alternative ones
2313 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002314MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002315static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002316{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002318 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002319
2320 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2321 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002323 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002324 }
2325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002327
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002328 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002329 tmp_transform = ssl->transform_out;
2330 ssl->transform_out = ssl->handshake->alt_transform_out;
2331 ssl->handshake->alt_transform_out = tmp_transform;
2332
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002333 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002334 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2335 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2336 sizeof( ssl->cur_out_ctr ) );
2337 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2338 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002339
2340 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002341 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002342
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002343 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002344}
2345
2346/*
2347 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002348 */
2349int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2350{
2351 int ret = 0;
2352
2353 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2354
2355 ret = mbedtls_ssl_flight_transmit( ssl );
2356
2357 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2358
2359 return( ret );
2360}
2361
2362/*
2363 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002364 *
2365 * Need to remember the current message in case flush_output returns
2366 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002367 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002368 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002369int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002370{
Janos Follath865b3eb2019-12-16 11:46:15 +00002371 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002372 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002375 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002376 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002377
2378 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002379 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002380 ret = ssl_swap_epochs( ssl );
2381 if( ret != 0 )
2382 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002383
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002385 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002386
2387 while( ssl->handshake->cur_msg != NULL )
2388 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002389 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002390 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002391
Hanno Beckere1dcb032018-08-17 16:47:58 +01002392 int const is_finished =
2393 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2394 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2395
Ronald Cron00d012f22022-03-08 15:57:12 +01002396 int const force_flush = ssl->disable_datagram_packing == 1 ?
Hanno Becker04da1892018-08-14 13:22:10 +01002397 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2398
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002399 /* Swap epochs before sending Finished: we can't do it after
2400 * sending ChangeCipherSpec, in case write returns WANT_READ.
2401 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002402 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002403 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002404 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002405 ret = ssl_swap_epochs( ssl );
2406 if( ret != 0 )
2407 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002408 }
2409
Hanno Becker67bc7c32018-08-06 11:33:50 +01002410 ret = ssl_get_remaining_payload_in_datagram( ssl );
2411 if( ret < 0 )
2412 return( ret );
2413 max_frag_len = (size_t) ret;
2414
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002415 /* CCS is copied as is, while HS messages may need fragmentation */
2416 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2417 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002418 if( max_frag_len == 0 )
2419 {
2420 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2421 return( ret );
2422
2423 continue;
2424 }
2425
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002426 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002427 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002428 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002429
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002430 /* Update position inside current message */
2431 ssl->handshake->cur_msg_p += cur->len;
2432 }
2433 else
2434 {
2435 const unsigned char * const p = ssl->handshake->cur_msg_p;
2436 const size_t hs_len = cur->len - 12;
2437 const size_t frag_off = p - ( cur->p + 12 );
2438 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002439 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002440
Hanno Beckere1dcb032018-08-17 16:47:58 +01002441 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002442 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002443 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002444 {
2445 ret = ssl_swap_epochs( ssl );
2446 if( ret != 0 )
2447 return( ret );
2448 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002449
Hanno Becker67bc7c32018-08-06 11:33:50 +01002450 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2451 return( ret );
2452
2453 continue;
2454 }
2455 max_hs_frag_len = max_frag_len - 12;
2456
2457 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2458 max_hs_frag_len : rem_len;
2459
2460 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002461 {
2462 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002463 (unsigned) cur_hs_frag_len,
2464 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002465 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002466
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002467 /* Messages are stored with handshake headers as if not fragmented,
2468 * copy beginning of headers then fill fragmentation fields.
2469 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2470 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002471
Joe Subbiani5ecac212021-06-24 13:00:03 +01002472 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2473 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2474 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002475
Joe Subbiani5ecac212021-06-24 13:00:03 +01002476 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2477 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2478 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002479
2480 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2481
Hanno Becker3f7b9732018-08-28 09:53:25 +01002482 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002483 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2484 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002485 ssl->out_msgtype = cur->type;
2486
2487 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002488 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002489 }
2490
2491 /* If done with the current message move to the next one if any */
2492 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2493 {
2494 if( cur->next != NULL )
2495 {
2496 ssl->handshake->cur_msg = cur->next;
2497 ssl->handshake->cur_msg_p = cur->next->p + 12;
2498 }
2499 else
2500 {
2501 ssl->handshake->cur_msg = NULL;
2502 ssl->handshake->cur_msg_p = NULL;
2503 }
2504 }
2505
2506 /* Actually send the message out */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002507 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002508 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002510 return( ret );
2511 }
2512 }
2513
Hanno Becker67bc7c32018-08-06 11:33:50 +01002514 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2515 return( ret );
2516
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002517 /* Update state and set timer */
Paul Elliott27b0d942022-03-18 21:55:32 +00002518 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002520 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002521 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002523 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002524 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002525
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002526 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002527
2528 return( 0 );
2529}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002530
2531/*
2532 * To be called when the last message of an incoming flight is received.
2533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002535{
2536 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002537 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002538 ssl->handshake->flight = NULL;
2539 ssl->handshake->cur_msg = NULL;
2540
2541 /* The next incoming flight will start with this msg_seq */
2542 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2543
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002544 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002545 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002546
Hanno Becker0271f962018-08-16 13:23:47 +01002547 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002548 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002549
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002550 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002551 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2554 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002555 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002557 }
2558 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002560}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002561
2562/*
2563 * To be called when the last message of an outgoing flight is send.
2564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002566{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002567 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002568 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2571 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002572 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002574 }
2575 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002577}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002579
Paul Bakker5121ce52009-01-03 21:22:43 +00002580/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002581 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002582 */
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002583int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
2584 unsigned char **buf, size_t *buf_len )
2585{
2586 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002587 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002588 * ...
2589 * HandshakeType msg_type;
2590 * uint24 length;
2591 * ...
2592 */
2593 *buf = ssl->out_msg + 4;
2594 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2595
2596 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2597 ssl->out_msg[0] = hs_type;
2598
2599 return( 0 );
2600}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002601
2602/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002603 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002604 *
2605 * - fill in handshake headers
2606 * - update handshake checksum
2607 * - DTLS: save message for resending
2608 * - then pass to the record layer
2609 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002610 * DTLS: except for HelloRequest, messages are only queued, and will only be
2611 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002612 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002613 * Inputs:
2614 * - ssl->out_msglen: 4 + actual handshake message len
2615 * (4 is the size of handshake headers for TLS)
2616 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2617 * - ssl->out_msg + 4: the handshake message body
2618 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002619 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002620 * - ssl->out_msglen: the length of the record contents
2621 * (including handshake headers but excluding record headers)
2622 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002623 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002624int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01002625 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01002626 int force_flush )
Paul Bakker5121ce52009-01-03 21:22:43 +00002627{
Janos Follath865b3eb2019-12-16 11:46:15 +00002628 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002629 const size_t hs_len = ssl->out_msglen - 4;
2630 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002631
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2633
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002634 /*
2635 * Sanity checks
2636 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002637 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002638 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2639 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002640 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2641 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002642 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002643
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002644 /* Whenever we send anything different from a
2645 * HelloRequest we should be in a handshake - double check. */
2646 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2647 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002648 ssl->handshake == NULL )
2649 {
2650 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2651 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2652 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002655 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002656 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002658 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2660 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002661 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002662#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002663
Hanno Beckerb50a2532018-08-06 11:52:54 +01002664 /* Double-check that we did not exceed the bounds
2665 * of the outgoing record buffer.
2666 * This should never fail as the various message
2667 * writing functions must obey the bounds of the
2668 * outgoing record buffer, but better be safe.
2669 *
2670 * Note: We deliberately do not check for the MTU or MFL here.
2671 */
2672 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2673 {
2674 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002675 "size %" MBEDTLS_PRINTF_SIZET
2676 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002677 ssl->out_msglen,
2678 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002679 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2680 }
2681
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002682 /*
2683 * Fill handshake headers
2684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002686 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002687 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2688 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2689 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002690
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002691 /*
2692 * DTLS has additional fields in the Handshake layer,
2693 * between the length field and the actual payload:
2694 * uint16 message_seq;
2695 * uint24 fragment_offset;
2696 * uint24 fragment_length;
2697 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002699 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002700 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002701 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002702 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002703 {
2704 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002705 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002706 hs_len,
2707 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002708 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2709 }
2710
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002711 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002712 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002713
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002714 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002715 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002716 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002717 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002718 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002719 }
2720 else
2721 {
2722 ssl->out_msg[4] = 0;
2723 ssl->out_msg[5] = 0;
2724 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002725
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002726 /* Handshake hashes are computed without fragmentation,
2727 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002728 memset( ssl->out_msg + 6, 0x00, 3 );
2729 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002730 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002732
Hanno Becker0207e532018-08-28 10:28:28 +01002733 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002734 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002735 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002736 }
2737
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002738 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002740 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002741 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2742 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002743 {
2744 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002747 return( ret );
2748 }
2749 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002750 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002751#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002752 {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002753 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002754 {
2755 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2756 return( ret );
2757 }
2758 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002759
2760 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2761
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002762 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002763}
2764
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002765int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
2766 size_t buf_len, size_t msg_len )
2767{
2768 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2769 size_t msg_with_header_len;
2770 ((void) buf_len);
2771
2772 /* Add reserved 4 bytes for handshake header */
2773 msg_with_header_len = msg_len + 4;
2774 ssl->out_msglen = msg_with_header_len;
2775 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_write_handshake_msg_ext( ssl, 0, 0 ) );
2776
2777cleanup:
2778 return( ret );
2779}
2780
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002781/*
2782 * Record layer functions
2783 */
2784
2785/*
2786 * Write current record.
2787 *
2788 * Uses:
2789 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2790 * - ssl->out_msglen: length of the record content (excl headers)
2791 * - ssl->out_msg: record content
2792 */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002793int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002794{
2795 int ret, done = 0;
2796 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002797 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002798
2799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002800
Paul Bakker05ef8352012-05-08 09:17:57 +00002801 if( !done )
2802 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002803 unsigned i;
2804 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002805#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2806 size_t out_buf_len = ssl->out_buf_len;
2807#else
2808 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2809#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002810 /* Skip writing the record content type to after the encryption,
2811 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002812 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002813#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002814 /* TLS 1.3 still uses the TLS 1.2 version identifier
2815 * for backwards compatibility. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002816 if( tls_ver == MBEDTLS_SSL_VERSION_TLS1_3 )
2817 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron6f135e12021-12-08 16:57:54 +01002818#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002819 mbedtls_ssl_write_version( ssl->out_hdr + 1, ssl->conf->transport,
2820 tls_ver );
Hanno Becker6430faf2019-05-08 11:57:13 +01002821
Jerry Yuae0b2e22021-10-08 15:21:19 +08002822 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002823 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002824
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002825 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002826 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002827 mbedtls_record rec;
2828
2829 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002830 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002831 rec.data_len = ssl->out_msglen;
2832 rec.data_offset = ssl->out_msg - rec.buf;
2833
Jerry Yud96a5c22021-09-29 17:46:51 +08002834 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002835 mbedtls_ssl_write_version( rec.ver, ssl->conf->transport, tls_ver );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002836 rec.type = ssl->out_msgtype;
2837
Hanno Beckera0e20d02019-05-15 14:03:01 +01002838#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002839 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002840 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002841#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002842
Hanno Beckera18d1322018-01-03 14:27:32 +00002843 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002844 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002845 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002847 return( ret );
2848 }
2849
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002850 if( rec.data_offset != 0 )
2851 {
2852 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2853 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2854 }
2855
Hanno Becker6430faf2019-05-08 11:57:13 +01002856 /* Update the record content type and CID. */
2857 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002858#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002859 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002860#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002861 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002862 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002863 }
2864
Hanno Becker5903de42019-05-03 14:46:38 +01002865 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002866
2867#if defined(MBEDTLS_SSL_PROTO_DTLS)
2868 /* In case of DTLS, double-check that we don't exceed
2869 * the remaining space in the datagram. */
2870 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2871 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002872 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002873 if( ret < 0 )
2874 return( ret );
2875
2876 if( protected_record_size > (size_t) ret )
2877 {
2878 /* Should never happen */
2879 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2880 }
2881 }
2882#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002883
Hanno Becker6430faf2019-05-08 11:57:13 +01002884 /* Now write the potentially updated record content type. */
2885 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2886
Paul Elliott9f352112020-12-09 14:55:45 +00002887 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002888 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002889 ssl->out_hdr[0], ssl->out_hdr[1],
2890 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002891
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002893 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002894
2895 ssl->out_left += protected_record_size;
2896 ssl->out_hdr += protected_record_size;
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002897 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002898
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002899 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
2900 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2901 break;
2902
Gabor Mezei96ae9262022-06-28 11:45:18 +02002903 /* The loop goes to its end if the counter is wrapping */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002904 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002905 {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2907 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Hanno Becker04484622018-08-06 09:49:38 +01002908 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002909 }
2910
Hanno Becker67bc7c32018-08-06 11:33:50 +01002911#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002912 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2913 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002914 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002915 size_t remaining;
2916 ret = ssl_get_remaining_payload_in_datagram( ssl );
2917 if( ret < 0 )
2918 {
2919 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2920 ret );
2921 return( ret );
2922 }
2923
2924 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002925 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002926 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002927 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002928 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002929 else
2930 {
Hanno Becker513815a2018-08-20 11:56:09 +01002931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002932 }
2933 }
2934#endif /* MBEDTLS_SSL_PROTO_DTLS */
2935
2936 if( ( flush == SSL_FORCE_FLUSH ) &&
2937 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002938 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002940 return( ret );
2941 }
2942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002944
2945 return( 0 );
2946}
2947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002949
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002950MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere25e3b72018-08-16 09:30:53 +01002951static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2952{
2953 if( ssl->in_msglen < ssl->in_hslen ||
2954 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2955 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2956 {
2957 return( 1 );
2958 }
2959 return( 0 );
2960}
Hanno Becker44650b72018-08-16 12:51:11 +01002961
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002962static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002963{
2964 return( ( ssl->in_msg[9] << 16 ) |
2965 ( ssl->in_msg[10] << 8 ) |
2966 ssl->in_msg[11] );
2967}
2968
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002969static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002970{
2971 return( ( ssl->in_msg[6] << 16 ) |
2972 ( ssl->in_msg[7] << 8 ) |
2973 ssl->in_msg[8] );
2974}
2975
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002976MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002977static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002978{
2979 uint32_t msg_len, frag_off, frag_len;
2980
2981 msg_len = ssl_get_hs_total_len( ssl );
2982 frag_off = ssl_get_hs_frag_off( ssl );
2983 frag_len = ssl_get_hs_frag_len( ssl );
2984
2985 if( frag_off > msg_len )
2986 return( -1 );
2987
2988 if( frag_len > msg_len - frag_off )
2989 return( -1 );
2990
2991 if( frag_len + 12 > ssl->in_msglen )
2992 return( -1 );
2993
2994 return( 0 );
2995}
2996
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002997/*
2998 * Mark bits in bitmask (used for DTLS HS reassembly)
2999 */
3000static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
3001{
3002 unsigned int start_bits, end_bits;
3003
3004 start_bits = 8 - ( offset % 8 );
3005 if( start_bits != 8 )
3006 {
3007 size_t first_byte_idx = offset / 8;
3008
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003009 /* Special case */
3010 if( len <= start_bits )
3011 {
3012 for( ; len != 0; len-- )
3013 mask[first_byte_idx] |= 1 << ( start_bits - len );
3014
3015 /* Avoid potential issues with offset or len becoming invalid */
3016 return;
3017 }
3018
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003019 offset += start_bits; /* Now offset % 8 == 0 */
3020 len -= start_bits;
3021
3022 for( ; start_bits != 0; start_bits-- )
3023 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
3024 }
3025
3026 end_bits = len % 8;
3027 if( end_bits != 0 )
3028 {
3029 size_t last_byte_idx = ( offset + len ) / 8;
3030
3031 len -= end_bits; /* Now len % 8 == 0 */
3032
3033 for( ; end_bits != 0; end_bits-- )
3034 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
3035 }
3036
3037 memset( mask + offset / 8, 0xFF, len / 8 );
3038}
3039
3040/*
3041 * Check that bitmask is full
3042 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003043MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003044static int ssl_bitmask_check( unsigned char *mask, size_t len )
3045{
3046 size_t i;
3047
3048 for( i = 0; i < len / 8; i++ )
3049 if( mask[i] != 0xFF )
3050 return( -1 );
3051
3052 for( i = 0; i < len % 8; i++ )
3053 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
3054 return( -1 );
3055
3056 return( 0 );
3057}
3058
Hanno Becker56e205e2018-08-16 09:06:12 +01003059/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003060static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003061 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003062{
Hanno Becker56e205e2018-08-16 09:06:12 +01003063 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003064
Hanno Becker56e205e2018-08-16 09:06:12 +01003065 alloc_len = 12; /* Handshake header */
3066 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003067
Hanno Beckerd07df862018-08-16 09:14:58 +01003068 if( add_bitmap )
3069 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003070
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003071 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003072}
Hanno Becker56e205e2018-08-16 09:06:12 +01003073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003075
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003076static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003077{
3078 return( ( ssl->in_msg[1] << 16 ) |
3079 ( ssl->in_msg[2] << 8 ) |
3080 ssl->in_msg[3] );
3081}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003082
Simon Butcher99000142016-10-13 17:21:01 +01003083int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003084{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003086 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003087 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003088 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003090 }
3091
Hanno Becker12555c62018-08-16 12:47:53 +01003092 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003093
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00003095 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003096 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003099 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003100 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003102 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003103
Hanno Becker44650b72018-08-16 12:51:11 +01003104 if( ssl_check_hs_header( ssl ) != 0 )
3105 {
3106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3107 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3108 }
3109
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003110 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00003111 ( ( mbedtls_ssl_is_handshake_over( ssl ) == 0 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003112 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003113 ( mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003114 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003115 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003116 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3117 {
3118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3119 recv_msg_seq,
3120 ssl->handshake->in_msg_seq ) );
3121 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3122 }
3123
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003124 /* Retransmit only on last message from previous flight, to avoid
3125 * too many retransmissions.
3126 * Besides, No sane server ever retransmits HelloVerifyRequest */
3127 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003129 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003131 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003132 recv_msg_seq,
3133 ssl->handshake->in_flight_start_seq ) );
3134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003136 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003138 return( ret );
3139 }
3140 }
3141 else
3142 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003144 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003145 recv_msg_seq,
3146 ssl->handshake->in_msg_seq ) );
3147 }
3148
Hanno Becker90333da2017-10-10 11:27:13 +01003149 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003150 }
3151 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003152
Hanno Becker6d97ef52018-08-16 13:09:04 +01003153 /* Message reassembly is handled alongside buffering of future
3154 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003155 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003156 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003157 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003158 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003160 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003161 }
3162 }
3163 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003165 /* With TLS we don't handle fragmentation (for now) */
3166 if( ssl->in_msglen < ssl->in_hslen )
3167 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3169 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003170 }
3171
Simon Butcher99000142016-10-13 17:21:01 +01003172 return( 0 );
3173}
3174
3175void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3176{
Hanno Becker0271f962018-08-16 13:23:47 +01003177 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003178
Paul Elliott27b0d942022-03-18 21:55:32 +00003179 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003180 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003181 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003182 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003183
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003184 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003186 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003187 ssl->handshake != NULL )
3188 {
Hanno Becker0271f962018-08-16 13:23:47 +01003189 unsigned offset;
3190 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003191
Hanno Becker0271f962018-08-16 13:23:47 +01003192 /* Increment handshake sequence number */
3193 hs->in_msg_seq++;
3194
3195 /*
3196 * Clear up handshake buffering and reassembly structure.
3197 */
3198
3199 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003200 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003201
3202 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003203 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3204 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003205 offset++, hs_buf++ )
3206 {
3207 *hs_buf = *(hs_buf + 1);
3208 }
3209
3210 /* Create a fresh last entry */
3211 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003212 }
3213#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003214}
3215
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003216/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003217 * DTLS anti-replay: RFC 6347 4.1.2.6
3218 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003219 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3220 * Bit n is set iff record number in_window_top - n has been seen.
3221 *
3222 * Usually, in_window_top is the last record number seen and the lsb of
3223 * in_window is set. The only exception is the initial state (record number 0
3224 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003227void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003228{
3229 ssl->in_window_top = 0;
3230 ssl->in_window = 0;
3231}
3232
3233static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3234{
3235 return( ( (uint64_t) buf[0] << 40 ) |
3236 ( (uint64_t) buf[1] << 32 ) |
3237 ( (uint64_t) buf[2] << 24 ) |
3238 ( (uint64_t) buf[3] << 16 ) |
3239 ( (uint64_t) buf[4] << 8 ) |
3240 ( (uint64_t) buf[5] ) );
3241}
3242
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003243MBEDTLS_CHECK_RETURN_CRITICAL
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003244static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3245{
Janos Follath865b3eb2019-12-16 11:46:15 +00003246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003247 unsigned char *original_in_ctr;
3248
3249 // save original in_ctr
3250 original_in_ctr = ssl->in_ctr;
3251
3252 // use counter from record
3253 ssl->in_ctr = record_in_ctr;
3254
3255 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3256
3257 // restore the counter
3258 ssl->in_ctr = original_in_ctr;
3259
3260 return ret;
3261}
3262
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003263/*
3264 * Return 0 if sequence number is acceptable, -1 otherwise
3265 */
Hanno Becker0183d692019-07-12 08:50:37 +01003266int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003267{
3268 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3269 uint64_t bit;
3270
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003271 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003272 return( 0 );
3273
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003274 if( rec_seqnum > ssl->in_window_top )
3275 return( 0 );
3276
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003277 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003278
3279 if( bit >= 64 )
3280 return( -1 );
3281
3282 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3283 return( -1 );
3284
3285 return( 0 );
3286}
3287
3288/*
3289 * Update replay window on new validated record
3290 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003291void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003292{
3293 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3294
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003295 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003296 return;
3297
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003298 if( rec_seqnum > ssl->in_window_top )
3299 {
3300 /* Update window_top and the contents of the window */
3301 uint64_t shift = rec_seqnum - ssl->in_window_top;
3302
3303 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003304 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003305 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003306 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003307 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003308 ssl->in_window |= 1;
3309 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003310
3311 ssl->in_window_top = rec_seqnum;
3312 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003313 else
3314 {
3315 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003316 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003317
3318 if( bit < 64 ) /* Always true, but be extra sure */
3319 ssl->in_window |= (uint64_t) 1 << bit;
3320 }
3321}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003323
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003324#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003325/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003326 * Check if a datagram looks like a ClientHello with a valid cookie,
3327 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003328 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003329 *
3330 * - if cookie is valid, return 0
3331 * - if ClientHello looks superficially valid but cookie is not,
3332 * fill obuf and set olen, then
3333 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3334 * - otherwise return a specific error code
3335 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003336MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003337MBEDTLS_STATIC_TESTABLE
3338int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003339 mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003340 const unsigned char *cli_id, size_t cli_id_len,
3341 const unsigned char *in, size_t in_len,
3342 unsigned char *obuf, size_t buf_len, size_t *olen )
3343{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003344 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003345 unsigned char *p;
3346
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003347 /*
3348 * Structure of ClientHello with record and handshake headers,
3349 * and expected values. We don't need to check a lot, more checks will be
3350 * done when actually parsing the ClientHello - skipping those checks
3351 * avoids code duplication and does not make cookie forging any easier.
3352 *
3353 * 0-0 ContentType type; copied, must be handshake
3354 * 1-2 ProtocolVersion version; copied
3355 * 3-4 uint16 epoch; copied, must be 0
3356 * 5-10 uint48 sequence_number; copied
3357 * 11-12 uint16 length; (ignored)
3358 *
3359 * 13-13 HandshakeType msg_type; (ignored)
3360 * 14-16 uint24 length; (ignored)
3361 * 17-18 uint16 message_seq; copied
3362 * 19-21 uint24 fragment_offset; copied, must be 0
3363 * 22-24 uint24 fragment_length; (ignored)
3364 *
3365 * 25-26 ProtocolVersion client_version; (ignored)
3366 * 27-58 Random random; (ignored)
3367 * 59-xx SessionID session_id; 1 byte len + sid_len content
3368 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3369 * ...
3370 *
3371 * Minimum length is 61 bytes.
3372 */
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003373 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: in_len=%u",
3374 (unsigned) in_len ) );
3375 MBEDTLS_SSL_DEBUG_BUF( 4, "cli_id", cli_id, cli_id_len );
3376 if( in_len < 61 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003377 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003378 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: record too short" ) );
3379 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
3380 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003381
3382 epoch = MBEDTLS_GET_UINT16_BE( in, 3 );
3383 fragment_offset = MBEDTLS_GET_UINT24_BE( in, 19 );
3384
3385 if( in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3386 fragment_offset != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003387 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003388 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: not a good ClientHello" ) );
3389 MBEDTLS_SSL_DEBUG_MSG( 4, ( " type=%u epoch=%u fragment_offset=%u",
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003390 in[0], (unsigned) epoch,
3391 (unsigned) fragment_offset ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003392 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003393 }
3394
3395 sid_len = in[59];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003396 if( 59 + 1 + sid_len + 1 > in_len )
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003397 {
3398 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: sid_len=%u > %u",
3399 (unsigned) sid_len,
3400 (unsigned) in_len - 61 ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003401 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003402 }
3403 MBEDTLS_SSL_DEBUG_BUF( 4, "sid received from network",
3404 in + 60, sid_len );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003405
3406 cookie_len = in[60 + sid_len];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003407 if( 59 + 1 + sid_len + 1 + cookie_len > in_len )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003408 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003409 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: cookie_len=%u > %u",
3410 (unsigned) cookie_len,
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003411 (unsigned) ( in_len - sid_len - 61 ) ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003412 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003413 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003414
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003415 MBEDTLS_SSL_DEBUG_BUF( 4, "cookie received from network",
3416 in + sid_len + 61, cookie_len );
3417 if( ssl->conf->f_cookie_check( ssl->conf->p_cookie,
3418 in + sid_len + 61, cookie_len,
3419 cli_id, cli_id_len ) == 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003420 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003421 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: valid" ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003422 return( 0 );
3423 }
3424
3425 /*
3426 * If we get here, we've got an invalid cookie, let's prepare HVR.
3427 *
3428 * 0-0 ContentType type; copied
3429 * 1-2 ProtocolVersion version; copied
3430 * 3-4 uint16 epoch; copied
3431 * 5-10 uint48 sequence_number; copied
3432 * 11-12 uint16 length; olen - 13
3433 *
3434 * 13-13 HandshakeType msg_type; hello_verify_request
3435 * 14-16 uint24 length; olen - 25
3436 * 17-18 uint16 message_seq; copied
3437 * 19-21 uint24 fragment_offset; copied
3438 * 22-24 uint24 fragment_length; olen - 25
3439 *
3440 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3441 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3442 *
3443 * Minimum length is 28.
3444 */
3445 if( buf_len < 28 )
3446 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3447
3448 /* Copy most fields and adapt others */
3449 memcpy( obuf, in, 25 );
3450 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3451 obuf[25] = 0xfe;
3452 obuf[26] = 0xff;
3453
3454 /* Generate and write actual cookie */
3455 p = obuf + 28;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003456 if( ssl->conf->f_cookie_write( ssl->conf->p_cookie,
3457 &p, obuf + buf_len,
3458 cli_id, cli_id_len ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003459 {
3460 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3461 }
3462
3463 *olen = p - obuf;
3464
3465 /* Go back and fill length fields */
3466 obuf[27] = (unsigned char)( *olen - 28 );
3467
Joe Subbianifbeb6922021-07-16 14:27:50 +01003468 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3469 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3470 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003471
Joe Subbiani6dd73642021-07-19 11:56:54 +01003472 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003473
3474 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3475}
3476
3477/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003478 * Handle possible client reconnect with the same UDP quadruplet
3479 * (RFC 6347 Section 4.2.8).
3480 *
3481 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3482 * that looks like a ClientHello.
3483 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003484 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003485 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003486 * - if the input looks like a ClientHello with a valid cookie,
3487 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003488 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003489 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003490 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003491 * This function is called (through ssl_check_client_reconnect()) when an
3492 * unexpected record is found in ssl_get_next_record(), which will discard the
3493 * record if we return 0, and bubble up the return value otherwise (this
3494 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3495 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003496 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003497MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003498static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3499{
Janos Follath865b3eb2019-12-16 11:46:15 +00003500 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003501 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003502
Hanno Becker2fddd372019-07-10 14:37:41 +01003503 if( ssl->conf->f_cookie_write == NULL ||
3504 ssl->conf->f_cookie_check == NULL )
3505 {
3506 /* If we can't use cookies to verify reachability of the peer,
3507 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3509 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003510 return( 0 );
3511 }
3512
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003513 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003514 ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003515 ssl->cli_id, ssl->cli_id_len,
3516 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003517 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003518
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003519 MBEDTLS_SSL_DEBUG_RET( 2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003520
3521 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003522 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003523 int send_ret;
3524 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3525 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3526 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003527 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003528 * If the error is permanent we'll catch it later,
3529 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003530 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3531 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3532 (void) send_ret;
3533
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003534 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003535 }
3536
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003537 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003538 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003540 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003541 {
3542 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3543 return( ret );
3544 }
3545
3546 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003547 }
3548
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003549 return( ret );
3550}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003551#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003552
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003553MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003554static int ssl_check_record_type( uint8_t record_type )
3555{
3556 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3557 record_type != MBEDTLS_SSL_MSG_ALERT &&
3558 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3559 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3560 {
3561 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3562 }
3563
3564 return( 0 );
3565}
3566
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003567/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003568 * ContentType type;
3569 * ProtocolVersion version;
3570 * uint16 epoch; // DTLS only
3571 * uint48 sequence_number; // DTLS only
3572 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003573 *
3574 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003575 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003576 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3577 *
3578 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003579 * 1. proceed with the record if this function returns 0
3580 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3581 * 3. return CLIENT_RECONNECT if this function return that value
3582 * 4. drop the whole datagram if this function returns anything else.
3583 * Point 2 is needed when the peer is resending, and we have already received
3584 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003585 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003586MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker331de3d2019-07-12 11:10:16 +01003587static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003588 unsigned char *buf,
3589 size_t len,
3590 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003591{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003592 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003593
Hanno Beckere5e7e782019-07-11 12:29:35 +01003594 size_t const rec_hdr_type_offset = 0;
3595 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003596
Hanno Beckere5e7e782019-07-11 12:29:35 +01003597 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3598 rec_hdr_type_len;
3599 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003600
Hanno Beckere5e7e782019-07-11 12:29:35 +01003601 size_t const rec_hdr_ctr_len = 8;
3602#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003603 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003604 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3605 rec_hdr_version_len;
3606
Hanno Beckera0e20d02019-05-15 14:03:01 +01003607#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003608 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3609 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003610 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003611#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3612#endif /* MBEDTLS_SSL_PROTO_DTLS */
3613
3614 size_t rec_hdr_len_offset; /* To be determined */
3615 size_t const rec_hdr_len_len = 2;
3616
3617 /*
3618 * Check minimum lengths for record header.
3619 */
3620
3621#if defined(MBEDTLS_SSL_PROTO_DTLS)
3622 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3623 {
3624 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3625 }
3626 else
3627#endif /* MBEDTLS_SSL_PROTO_DTLS */
3628 {
3629 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3630 }
3631
3632 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3633 {
3634 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3635 (unsigned) len,
3636 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3637 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3638 }
3639
3640 /*
3641 * Parse and validate record content type
3642 */
3643
3644 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003645
3646 /* Check record content type */
3647#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3648 rec->cid_len = 0;
3649
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003650 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003651 ssl->conf->cid_len != 0 &&
3652 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003653 {
3654 /* Shift pointers to account for record header including CID
3655 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003656 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003657 * ProtocolVersion version;
3658 * uint16 epoch;
3659 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003660 * opaque cid[cid_length]; // Additional field compared to
3661 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003662 * uint16 length;
3663 * opaque enc_content[DTLSCiphertext.length];
3664 * } DTLSCiphertext;
3665 */
3666
3667 /* So far, we only support static CID lengths
3668 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003669 rec_hdr_cid_len = ssl->conf->cid_len;
3670 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003671
Hanno Beckere5e7e782019-07-11 12:29:35 +01003672 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003673 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003674 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3675 (unsigned) len,
3676 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003677 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003678 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003679
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003680 /* configured CID len is guaranteed at most 255, see
3681 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3682 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003683 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003684 }
3685 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003686#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003687 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003688 if( ssl_check_record_type( rec->type ) )
3689 {
Hanno Becker54229812019-07-12 14:40:00 +01003690 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3691 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003692 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3693 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003694 }
3695
Hanno Beckere5e7e782019-07-11 12:29:35 +01003696 /*
3697 * Parse and validate record version
3698 */
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003699 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3700 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003701 tls_version = mbedtls_ssl_read_version( buf + rec_hdr_version_offset,
3702 ssl->conf->transport );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003703
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003704 if( tls_version > ssl->conf->max_tls_version )
Paul Bakker5121ce52009-01-03 21:22:43 +00003705 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003706 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS version mismatch: got %u, expected max %u",
3707 (unsigned) tls_version,
3708 (unsigned) ssl->conf->max_tls_version) );
3709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003710 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003711 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003712 /*
3713 * Parse/Copy record sequence number.
3714 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003715
Hanno Beckere5e7e782019-07-11 12:29:35 +01003716#if defined(MBEDTLS_SSL_PROTO_DTLS)
3717 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003718 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003719 /* Copy explicit record sequence number from input buffer. */
3720 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3721 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003722 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003723 else
3724#endif /* MBEDTLS_SSL_PROTO_DTLS */
3725 {
3726 /* Copy implicit record sequence number from SSL context structure. */
3727 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3728 }
Paul Bakker40e46942009-01-03 21:51:57 +00003729
Hanno Beckere5e7e782019-07-11 12:29:35 +01003730 /*
3731 * Parse record length.
3732 */
3733
Hanno Beckere5e7e782019-07-11 12:29:35 +01003734 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003735 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3736 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003737 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003738
Paul Elliott9f352112020-12-09 14:55:45 +00003739 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003740 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3741 rec->type, (unsigned)tls_version, rec->data_len ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003742
3743 rec->buf = buf;
3744 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003745
Hanno Beckerd417cc92019-07-26 08:20:27 +01003746 if( rec->data_len == 0 )
3747 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003748
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003749 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003750 * DTLS-related tests.
3751 * Check epoch before checking length constraint because
3752 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3753 * message gets duplicated before the corresponding Finished message,
3754 * the second ChangeCipherSpec should be discarded because it belongs
3755 * to an old epoch, but not because its length is shorter than
3756 * the minimum record length for packets using the new record transform.
3757 * Note that these two kinds of failures are handled differently,
3758 * as an unexpected record is silently skipped but an invalid
3759 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003760 */
3761#if defined(MBEDTLS_SSL_PROTO_DTLS)
3762 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3763 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003764 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003765
Hanno Becker955a5c92019-07-10 17:12:07 +01003766 /* Check that the datagram is large enough to contain a record
3767 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003768 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003769 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003770 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3771 (unsigned) len,
3772 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003773 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3774 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003775
Hanno Becker37cfe732019-07-10 17:20:01 +01003776 /* Records from other, non-matching epochs are silently discarded.
3777 * (The case of same-port Client reconnects must be considered in
3778 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003779 if( rec_epoch != ssl->in_epoch )
3780 {
3781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003782 "expected %u, received %lu",
3783 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003784
Hanno Becker552f7472019-07-19 10:59:12 +01003785 /* Records from the next epoch are considered for buffering
3786 * (concretely: early Finished messages). */
3787 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003788 {
Hanno Becker552f7472019-07-19 10:59:12 +01003789 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3790 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003791 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003792
Hanno Becker2fddd372019-07-10 14:37:41 +01003793 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003794 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003795#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003796 /* For records from the correct epoch, check whether their
3797 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003798 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3799 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003800 {
3801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3802 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3803 }
3804#endif
3805 }
3806#endif /* MBEDTLS_SSL_PROTO_DTLS */
3807
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003808 return( 0 );
3809}
Paul Bakker5121ce52009-01-03 21:22:43 +00003810
Paul Bakker5121ce52009-01-03 21:22:43 +00003811
Hanno Becker2fddd372019-07-10 14:37:41 +01003812#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003813MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2fddd372019-07-10 14:37:41 +01003814static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3815{
3816 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3817
3818 /*
3819 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3820 * access the first byte of record content (handshake type), as we
3821 * have an active transform (possibly iv_len != 0), so use the
3822 * fact that the record header len is 13 instead.
3823 */
3824 if( rec_epoch == 0 &&
3825 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Paul Elliott27b0d942022-03-18 21:55:32 +00003826 mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003827 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3828 ssl->in_left > 13 &&
3829 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3830 {
3831 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3832 "from the same port" ) );
3833 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003834 }
3835
3836 return( 0 );
3837}
Hanno Becker2fddd372019-07-10 14:37:41 +01003838#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003839
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003840/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003841 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003842 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003843MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfdf66042019-07-11 13:07:45 +01003844static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3845 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003846{
3847 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003849 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003850 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003851
Ronald Cron7e38cba2021-11-24 12:43:39 +01003852 /*
3853 * In TLS 1.3, always treat ChangeCipherSpec records
3854 * as unencrypted. The only thing we do with them is
3855 * check the length and content and ignore them.
3856 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003857#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003858 if( ssl->transform_in != NULL &&
Glenn Strauss07c64162022-03-14 12:34:51 -04003859 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01003860 {
3861 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3862 done = 1;
3863 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003864#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003865
Paul Bakker48916f92012-09-16 19:57:18 +00003866 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003867 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003868 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003869
Hanno Beckera18d1322018-01-03 14:27:32 +00003870 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003871 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003872 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003873 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003874
Hanno Beckera0e20d02019-05-15 14:03:01 +01003875#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003876 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3877 ssl->conf->ignore_unexpected_cid
3878 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3879 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003880 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003881 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003882 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003883#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003884
Paul Bakker5121ce52009-01-03 21:22:43 +00003885 return( ret );
3886 }
3887
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003888 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003889 {
3890 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003891 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003892 }
3893
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003894 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003895 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003896
Hanno Beckera0e20d02019-05-15 14:03:01 +01003897#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003898 /* We have already checked the record content type
3899 * in ssl_parse_record_header(), failing or silently
3900 * dropping the record in the case of an unknown type.
3901 *
3902 * Since with the use of CIDs, the record content type
3903 * might change during decryption, re-check the record
3904 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003905 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003906 {
3907 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3908 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3909 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003910#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003911
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003912 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003913 {
3914#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003915 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003916 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003917 {
3918 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3919 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3920 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3921 }
3922#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3923
3924 ssl->nb_zero++;
3925
3926 /*
3927 * Three or more empty messages may be a DoS attack
3928 * (excessive CPU consumption).
3929 */
3930 if( ssl->nb_zero > 3 )
3931 {
3932 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003933 "messages, possible DoS attack" ) );
3934 /* Treat the records as if they were not properly authenticated,
3935 * thereby failing the connection if we see more than allowed
3936 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003937 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3938 }
3939 }
3940 else
3941 ssl->nb_zero = 0;
3942
3943#if defined(MBEDTLS_SSL_PROTO_DTLS)
3944 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3945 {
3946 ; /* in_ctr read from peer, not maintained internally */
3947 }
3948 else
3949#endif
3950 {
3951 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003952 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3953 i > mbedtls_ssl_ep_len( ssl ); i-- )
3954 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003955 if( ++ssl->in_ctr[i - 1] != 0 )
3956 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003957 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003958
3959 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003960 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003961 {
3962 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3963 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3964 }
3965 }
3966
Paul Bakker5121ce52009-01-03 21:22:43 +00003967 }
3968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003969#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003970 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003971 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003972 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003973 }
3974#endif
3975
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003976 /* Check actual (decrypted) record content length against
3977 * configured maximum. */
Paul Elliott668b31f2022-06-10 14:11:31 +01003978 if( rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003979 {
3980 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3981 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3982 }
3983
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003984 return( 0 );
3985}
3986
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003987/*
3988 * Read a record.
3989 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003990 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3991 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3992 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003993 */
Hanno Becker1097b342018-08-15 14:09:41 +01003994
3995/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003996MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01003997static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003998MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01003999static int ssl_get_next_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004000MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004001static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01004002
Hanno Becker327c93b2018-08-15 13:56:18 +01004003int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01004004 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004005{
Janos Follath865b3eb2019-12-16 11:46:15 +00004006 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004009
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004010 if( ssl->keep_current_message == 0 )
4011 {
4012 do {
Simon Butcher99000142016-10-13 17:21:01 +01004013
Hanno Becker26994592018-08-15 14:14:59 +01004014 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01004015 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004016 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01004017
Hanno Beckere74d5562018-08-15 14:26:08 +01004018 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004019 {
David Horstmann10be1342022-10-06 18:31:25 +01004020 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004021#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004022
Hanno Becker40f50842018-08-15 14:48:01 +01004023 /* We only check for buffered messages if the
4024 * current datagram is fully consumed. */
4025 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004026 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004027 {
Hanno Becker40f50842018-08-15 14:48:01 +01004028 if( ssl_load_buffered_message( ssl ) == 0 )
David Horstmann10be1342022-10-06 18:31:25 +01004029 dtls_have_buffered = 1;
Hanno Becker40f50842018-08-15 14:48:01 +01004030 }
4031
Hanno Becker40f50842018-08-15 14:48:01 +01004032#endif /* MBEDTLS_SSL_PROTO_DTLS */
David Horstmann10be1342022-10-06 18:31:25 +01004033 if( dtls_have_buffered == 0 )
Hanno Becker40f50842018-08-15 14:48:01 +01004034 {
4035 ret = ssl_get_next_record( ssl );
4036 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
4037 continue;
4038
4039 if( ret != 0 )
4040 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01004041 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004042 return( ret );
4043 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004044 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004045 }
4046
4047 ret = mbedtls_ssl_handle_message_type( ssl );
4048
Hanno Becker40f50842018-08-15 14:48:01 +01004049#if defined(MBEDTLS_SSL_PROTO_DTLS)
4050 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4051 {
4052 /* Buffer future message */
4053 ret = ssl_buffer_message( ssl );
4054 if( ret != 0 )
4055 return( ret );
4056
4057 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4058 }
4059#endif /* MBEDTLS_SSL_PROTO_DTLS */
4060
Hanno Becker90333da2017-10-10 11:27:13 +01004061 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4062 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004063
4064 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01004065 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00004066 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01004067 return( ret );
4068 }
4069
Hanno Becker327c93b2018-08-15 13:56:18 +01004070 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01004071 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004072 {
4073 mbedtls_ssl_update_handshake_status( ssl );
4074 }
Simon Butcher99000142016-10-13 17:21:01 +01004075 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004076 else
Simon Butcher99000142016-10-13 17:21:01 +01004077 {
Hanno Becker02f59072018-08-15 14:00:24 +01004078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004079 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004080 }
4081
4082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4083
4084 return( 0 );
4085}
4086
Hanno Becker40f50842018-08-15 14:48:01 +01004087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004088MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004089static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004090{
Hanno Becker40f50842018-08-15 14:48:01 +01004091 if( ssl->in_left > ssl->next_record_offset )
4092 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004093
Hanno Becker40f50842018-08-15 14:48:01 +01004094 return( 0 );
4095}
4096
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004097MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01004098static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4099{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004100 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004101 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004102 int ret = 0;
4103
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004104 if( hs == NULL )
4105 return( -1 );
4106
Hanno Beckere00ae372018-08-20 09:39:42 +01004107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4108
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004109 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4110 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4111 {
4112 /* Check if we have seen a ChangeCipherSpec before.
4113 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004114 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004115 {
4116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4117 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004118 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004119 }
4120
Hanno Becker39b8bc92018-08-28 17:17:13 +01004121 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004122 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4123 ssl->in_msglen = 1;
4124 ssl->in_msg[0] = 1;
4125
4126 /* As long as they are equal, the exact value doesn't matter. */
4127 ssl->in_left = 0;
4128 ssl->next_record_offset = 0;
4129
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004130 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004131 goto exit;
4132 }
Hanno Becker37f95322018-08-16 13:55:32 +01004133
Hanno Beckerb8f50142018-08-28 10:01:34 +01004134#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004135 /* Debug only */
4136 {
4137 unsigned offset;
4138 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4139 {
4140 hs_buf = &hs->buffering.hs[offset];
4141 if( hs_buf->is_valid == 1 )
4142 {
4143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4144 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004145 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004146 }
4147 }
4148 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004149#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004150
4151 /* Check if we have buffered and/or fully reassembled the
4152 * next handshake message. */
4153 hs_buf = &hs->buffering.hs[0];
4154 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4155 {
4156 /* Synthesize a record containing the buffered HS message. */
4157 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4158 ( hs_buf->data[2] << 8 ) |
4159 hs_buf->data[3];
4160
4161 /* Double-check that we haven't accidentally buffered
4162 * a message that doesn't fit into the input buffer. */
4163 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4164 {
4165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4166 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4167 }
4168
4169 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4170 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4171 hs_buf->data, msg_len + 12 );
4172
4173 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4174 ssl->in_hslen = msg_len + 12;
4175 ssl->in_msglen = msg_len + 12;
4176 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4177
4178 ret = 0;
4179 goto exit;
4180 }
4181 else
4182 {
4183 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4184 hs->in_msg_seq ) );
4185 }
4186
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004187 ret = -1;
4188
4189exit:
4190
4191 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4192 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004193}
4194
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004195MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckera02b0b42018-08-21 17:20:27 +01004196static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4197 size_t desired )
4198{
4199 int offset;
4200 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4202 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004203
Hanno Becker01315ea2018-08-21 17:22:17 +01004204 /* Get rid of future records epoch first, if such exist. */
4205 ssl_free_buffered_record( ssl );
4206
4207 /* Check if we have enough space available now. */
4208 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4209 hs->buffering.total_bytes_buffered ) )
4210 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004211 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004212 return( 0 );
4213 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004214
Hanno Becker4f432ad2018-08-28 10:02:32 +01004215 /* We don't have enough space to buffer the next expected handshake
4216 * message. Remove buffers used for future messages to gain space,
4217 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004218 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4219 offset >= 0; offset-- )
4220 {
4221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4222 offset ) );
4223
Hanno Beckerb309b922018-08-23 13:18:05 +01004224 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004225
4226 /* Check if we have enough space available now. */
4227 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4228 hs->buffering.total_bytes_buffered ) )
4229 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004230 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004231 return( 0 );
4232 }
4233 }
4234
4235 return( -1 );
4236}
4237
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004238MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01004239static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4240{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004241 int ret = 0;
4242 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4243
4244 if( hs == NULL )
4245 return( 0 );
4246
4247 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4248
4249 switch( ssl->in_msgtype )
4250 {
4251 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4252 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004253
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004254 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004255 break;
4256
4257 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004258 {
4259 unsigned recv_msg_seq_offset;
4260 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4261 mbedtls_ssl_hs_buffer *hs_buf;
4262 size_t msg_len = ssl->in_hslen - 12;
4263
4264 /* We should never receive an old handshake
4265 * message - double-check nonetheless. */
4266 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4267 {
4268 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4269 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4270 }
4271
4272 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4273 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4274 {
4275 /* Silently ignore -- message too far in the future */
4276 MBEDTLS_SSL_DEBUG_MSG( 2,
4277 ( "Ignore future HS message with sequence number %u, "
4278 "buffering window %u - %u",
4279 recv_msg_seq, ssl->handshake->in_msg_seq,
4280 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4281
4282 goto exit;
4283 }
4284
4285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4286 recv_msg_seq, recv_msg_seq_offset ) );
4287
4288 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4289
4290 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004291 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004292 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004293 size_t reassembly_buf_sz;
4294
Hanno Becker37f95322018-08-16 13:55:32 +01004295 hs_buf->is_fragmented =
4296 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4297
4298 /* We copy the message back into the input buffer
4299 * after reassembly, so check that it's not too large.
4300 * This is an implementation-specific limitation
4301 * and not one from the standard, hence it is not
4302 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004303 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004304 {
4305 /* Ignore message */
4306 goto exit;
4307 }
4308
Hanno Beckere0b150f2018-08-21 15:51:03 +01004309 /* Check if we have enough space to buffer the message. */
4310 if( hs->buffering.total_bytes_buffered >
4311 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4312 {
4313 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4314 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4315 }
4316
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004317 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4318 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004319
4320 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4321 hs->buffering.total_bytes_buffered ) )
4322 {
4323 if( recv_msg_seq_offset > 0 )
4324 {
4325 /* If we can't buffer a future message because
4326 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004327 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4328 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4329 " (already %" MBEDTLS_PRINTF_SIZET
4330 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004331 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004332 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004333 goto exit;
4334 }
Hanno Beckere1801392018-08-21 16:51:05 +01004335 else
4336 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004337 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4338 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4339 " (already %" MBEDTLS_PRINTF_SIZET
4340 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004341 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004342 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004343 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004344
Hanno Beckera02b0b42018-08-21 17:20:27 +01004345 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004346 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004347 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4348 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4349 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4350 " (already %" MBEDTLS_PRINTF_SIZET
4351 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004352 msg_len,
4353 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004354 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004355 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004356 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4357 goto exit;
4358 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004359 }
4360
Paul Elliottd48d5c62021-01-07 14:47:05 +00004361 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004362 msg_len ) );
4363
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004364 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4365 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004366 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004367 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004368 goto exit;
4369 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004370 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004371
4372 /* Prepare final header: copy msg_type, length and message_seq,
4373 * then add standardised fragment_offset and fragment_length */
4374 memcpy( hs_buf->data, ssl->in_msg, 6 );
4375 memset( hs_buf->data + 6, 0, 3 );
4376 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4377
4378 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004379
4380 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004381 }
4382 else
4383 {
4384 /* Make sure msg_type and length are consistent */
4385 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4386 {
4387 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4388 /* Ignore */
4389 goto exit;
4390 }
4391 }
4392
Hanno Becker4422bbb2018-08-20 09:40:19 +01004393 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004394 {
4395 size_t frag_len, frag_off;
4396 unsigned char * const msg = hs_buf->data + 12;
4397
4398 /*
4399 * Check and copy current fragment
4400 */
4401
4402 /* Validation of header fields already done in
4403 * mbedtls_ssl_prepare_handshake_record(). */
4404 frag_off = ssl_get_hs_frag_off( ssl );
4405 frag_len = ssl_get_hs_frag_len( ssl );
4406
Paul Elliottd48d5c62021-01-07 14:47:05 +00004407 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4408 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004409 frag_off, frag_len ) );
4410 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4411
4412 if( hs_buf->is_fragmented )
4413 {
4414 unsigned char * const bitmask = msg + msg_len;
4415 ssl_bitmask_set( bitmask, frag_off, frag_len );
4416 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4417 msg_len ) == 0 );
4418 }
4419 else
4420 {
4421 hs_buf->is_complete = 1;
4422 }
4423
4424 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4425 hs_buf->is_complete ? "" : "not yet " ) );
4426 }
4427
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004428 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004429 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004430
4431 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004432 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004433 break;
4434 }
4435
4436exit:
4437
4438 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4439 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004440}
4441#endif /* MBEDTLS_SSL_PROTO_DTLS */
4442
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004443MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01004444static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004445{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004446 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004447 * Consume last content-layer message and potentially
4448 * update in_msglen which keeps track of the contents'
4449 * consumption state.
4450 *
4451 * (1) Handshake messages:
4452 * Remove last handshake message, move content
4453 * and adapt in_msglen.
4454 *
4455 * (2) Alert messages:
4456 * Consume whole record content, in_msglen = 0.
4457 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004458 * (3) Change cipher spec:
4459 * Consume whole record content, in_msglen = 0.
4460 *
4461 * (4) Application data:
4462 * Don't do anything - the record layer provides
4463 * the application data as a stream transport
4464 * and consumes through mbedtls_ssl_read only.
4465 *
4466 */
4467
4468 /* Case (1): Handshake messages */
4469 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004470 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004471 /* Hard assertion to be sure that no application data
4472 * is in flight, as corrupting ssl->in_msglen during
4473 * ssl->in_offt != NULL is fatal. */
4474 if( ssl->in_offt != NULL )
4475 {
4476 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4477 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4478 }
4479
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004480 /*
4481 * Get next Handshake message in the current record
4482 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004483
Hanno Becker4a810fb2017-05-24 16:27:30 +01004484 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004485 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004486 * current handshake content: If DTLS handshake
4487 * fragmentation is used, that's the fragment
4488 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004489 * size here is faulty and should be changed at
4490 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004491 * (2) While it doesn't seem to cause problems, one
4492 * has to be very careful not to assume that in_hslen
4493 * is always <= in_msglen in a sensible communication.
4494 * Again, it's wrong for DTLS handshake fragmentation.
4495 * The following check is therefore mandatory, and
4496 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004497 * Additionally, ssl->in_hslen might be arbitrarily out of
4498 * bounds after handling a DTLS message with an unexpected
4499 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004500 */
4501 if( ssl->in_hslen < ssl->in_msglen )
4502 {
4503 ssl->in_msglen -= ssl->in_hslen;
4504 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4505 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004506
Hanno Becker4a810fb2017-05-24 16:27:30 +01004507 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4508 ssl->in_msg, ssl->in_msglen );
4509 }
4510 else
4511 {
4512 ssl->in_msglen = 0;
4513 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004514
Hanno Becker4a810fb2017-05-24 16:27:30 +01004515 ssl->in_hslen = 0;
4516 }
4517 /* Case (4): Application data */
4518 else if( ssl->in_offt != NULL )
4519 {
4520 return( 0 );
4521 }
4522 /* Everything else (CCS & Alerts) */
4523 else
4524 {
4525 ssl->in_msglen = 0;
4526 }
4527
Hanno Becker1097b342018-08-15 14:09:41 +01004528 return( 0 );
4529}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004530
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004531MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004532static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4533{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004534 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004535 return( 1 );
4536
4537 return( 0 );
4538}
4539
Hanno Becker5f066e72018-08-16 14:56:31 +01004540#if defined(MBEDTLS_SSL_PROTO_DTLS)
4541
4542static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4543{
4544 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4545 if( hs == NULL )
4546 return;
4547
Hanno Becker01315ea2018-08-21 17:22:17 +01004548 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004549 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004550 hs->buffering.total_bytes_buffered -=
4551 hs->buffering.future_record.len;
4552
4553 mbedtls_free( hs->buffering.future_record.data );
4554 hs->buffering.future_record.data = NULL;
4555 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004556}
4557
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004558MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker5f066e72018-08-16 14:56:31 +01004559static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4560{
4561 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4562 unsigned char * rec;
4563 size_t rec_len;
4564 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004565#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4566 size_t in_buf_len = ssl->in_buf_len;
4567#else
4568 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4569#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004570 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4571 return( 0 );
4572
4573 if( hs == NULL )
4574 return( 0 );
4575
Hanno Becker5f066e72018-08-16 14:56:31 +01004576 rec = hs->buffering.future_record.data;
4577 rec_len = hs->buffering.future_record.len;
4578 rec_epoch = hs->buffering.future_record.epoch;
4579
4580 if( rec == NULL )
4581 return( 0 );
4582
Hanno Becker4cb782d2018-08-20 11:19:05 +01004583 /* Only consider loading future records if the
4584 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004585 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004586 return( 0 );
4587
Hanno Becker5f066e72018-08-16 14:56:31 +01004588 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4589
4590 if( rec_epoch != ssl->in_epoch )
4591 {
4592 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4593 goto exit;
4594 }
4595
4596 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4597
4598 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004599 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004600 {
4601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4603 }
4604
4605 memcpy( ssl->in_hdr, rec, rec_len );
4606 ssl->in_left = rec_len;
4607 ssl->next_record_offset = 0;
4608
4609 ssl_free_buffered_record( ssl );
4610
4611exit:
4612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4613 return( 0 );
4614}
4615
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004616MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker519f15d2019-07-11 12:43:20 +01004617static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4618 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004619{
4620 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004621
4622 /* Don't buffer future records outside handshakes. */
4623 if( hs == NULL )
4624 return( 0 );
4625
4626 /* Only buffer handshake records (we are only interested
4627 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004628 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004629 return( 0 );
4630
4631 /* Don't buffer more than one future epoch record. */
4632 if( hs->buffering.future_record.data != NULL )
4633 return( 0 );
4634
Hanno Becker01315ea2018-08-21 17:22:17 +01004635 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004636 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004637 hs->buffering.total_bytes_buffered ) )
4638 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004639 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4640 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4641 " (already %" MBEDTLS_PRINTF_SIZET
4642 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004643 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004644 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004645 return( 0 );
4646 }
4647
Hanno Becker5f066e72018-08-16 14:56:31 +01004648 /* Buffer record */
4649 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004650 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004651 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004652
4653 /* ssl_parse_record_header() only considers records
4654 * of the next epoch as candidates for buffering. */
4655 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004656 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004657
4658 hs->buffering.future_record.data =
4659 mbedtls_calloc( 1, hs->buffering.future_record.len );
4660 if( hs->buffering.future_record.data == NULL )
4661 {
4662 /* If we run out of RAM trying to buffer a
4663 * record from the next epoch, just ignore. */
4664 return( 0 );
4665 }
4666
Hanno Becker519f15d2019-07-11 12:43:20 +01004667 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004668
Hanno Becker519f15d2019-07-11 12:43:20 +01004669 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004670 return( 0 );
4671}
4672
4673#endif /* MBEDTLS_SSL_PROTO_DTLS */
4674
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004675MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004676static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004677{
Janos Follath865b3eb2019-12-16 11:46:15 +00004678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004679 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004680
Hanno Becker5f066e72018-08-16 14:56:31 +01004681#if defined(MBEDTLS_SSL_PROTO_DTLS)
4682 /* We might have buffered a future record; if so,
4683 * and if the epoch matches now, load it.
4684 * On success, this call will set ssl->in_left to
4685 * the length of the buffered record, so that
4686 * the calls to ssl_fetch_input() below will
4687 * essentially be no-ops. */
4688 ret = ssl_load_buffered_record( ssl );
4689 if( ret != 0 )
4690 return( ret );
4691#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004692
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004693 /* Ensure that we have enough space available for the default form
4694 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4695 * with no space for CIDs counted in). */
4696 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4697 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004698 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004700 return( ret );
4701 }
4702
Hanno Beckere5e7e782019-07-11 12:29:35 +01004703 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4704 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004705 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004707 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004708 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004709 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4710 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004711 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004712 if( ret != 0 )
4713 return( ret );
4714
4715 /* Fall through to handling of unexpected records */
4716 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4717 }
4718
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004719 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4720 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004721#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004722 /* Reset in pointers to default state for TLS/DTLS records,
4723 * assuming no CID and no offset between record content and
4724 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004725 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004726
Hanno Becker7ae20e02019-07-12 08:33:49 +01004727 /* Setup internal message pointers from record structure. */
4728 ssl->in_msgtype = rec.type;
4729#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4730 ssl->in_len = ssl->in_cid + rec.cid_len;
4731#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4732 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4733 ssl->in_msglen = rec.data_len;
4734
Hanno Becker2fddd372019-07-10 14:37:41 +01004735 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004736 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004737 if( ret != 0 )
4738 return( ret );
4739#endif
4740
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004741 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004742 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004743
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004744 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4745 "(header)" ) );
4746 }
4747 else
4748 {
4749 /* Skip invalid record and the rest of the datagram */
4750 ssl->next_record_offset = 0;
4751 ssl->in_left = 0;
4752
4753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4754 "(header)" ) );
4755 }
4756
4757 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004758 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004759 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004760 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004761#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004762 {
4763 return( ret );
4764 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004765 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004768 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004769 {
Hanno Beckera8814792019-07-10 15:01:45 +01004770 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004771 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004772 if( ssl->next_record_offset < ssl->in_left )
4773 {
4774 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4775 }
4776 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004777 else
4778#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004779 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004780 /*
4781 * Fetch record contents from underlying transport.
4782 */
Hanno Beckera3175662019-07-11 12:50:29 +01004783 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004784 if( ret != 0 )
4785 {
4786 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4787 return( ret );
4788 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004789
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004790 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004791 }
4792
4793 /*
4794 * Decrypt record contents.
4795 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004796
Hanno Beckerfdf66042019-07-11 13:07:45 +01004797 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004799#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004800 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004801 {
4802 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004803 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004804 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004805 /* Except when waiting for Finished as a bad mac here
4806 * probably means something went wrong in the handshake
4807 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4808 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4809 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4810 {
4811#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4812 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4813 {
4814 mbedtls_ssl_send_alert_message( ssl,
4815 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4816 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4817 }
4818#endif
4819 return( ret );
4820 }
4821
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004822 if( ssl->conf->badmac_limit != 0 &&
4823 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004824 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004825 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4826 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004827 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004828
Hanno Becker4a810fb2017-05-24 16:27:30 +01004829 /* As above, invalid records cause
4830 * dismissal of the whole datagram. */
4831
4832 ssl->next_record_offset = 0;
4833 ssl->in_left = 0;
4834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004836 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004837 }
4838
4839 return( ret );
4840 }
4841 else
4842#endif
4843 {
4844 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004845#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4846 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004847 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004848 mbedtls_ssl_send_alert_message( ssl,
4849 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4850 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004851 }
4852#endif
4853 return( ret );
4854 }
4855 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004856
Hanno Becker44d89b22019-07-12 09:40:44 +01004857
4858 /* Reset in pointers to default state for TLS/DTLS records,
4859 * assuming no CID and no offset between record content and
4860 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004861 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004862#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4863 ssl->in_len = ssl->in_cid + rec.cid_len;
4864#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004865 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004866
Hanno Becker8685c822019-07-12 09:37:30 +01004867 /* The record content type may change during decryption,
4868 * so re-read it. */
4869 ssl->in_msgtype = rec.type;
4870 /* Also update the input buffer, because unfortunately
4871 * the server-side ssl_parse_client_hello() reparses the
4872 * record header when receiving a ClientHello initiating
4873 * a renegotiation. */
4874 ssl->in_hdr[0] = rec.type;
4875 ssl->in_msg = rec.buf + rec.data_offset;
4876 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004877 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004878
Simon Butcher99000142016-10-13 17:21:01 +01004879 return( 0 );
4880}
4881
4882int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4883{
Janos Follath865b3eb2019-12-16 11:46:15 +00004884 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004885
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004886 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004887 * Handle particular types of records
4888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004889 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004890 {
Simon Butcher99000142016-10-13 17:21:01 +01004891 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4892 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004893 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004894 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004895 }
4896
Hanno Beckere678eaa2018-08-21 14:57:46 +01004897 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004898 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004899 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004900 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004901 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004902 ssl->in_msglen ) );
4903 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004904 }
4905
Hanno Beckere678eaa2018-08-21 14:57:46 +01004906 if( ssl->in_msg[0] != 1 )
4907 {
4908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4909 ssl->in_msg[0] ) );
4910 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4911 }
4912
4913#if defined(MBEDTLS_SSL_PROTO_DTLS)
4914 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4915 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4916 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4917 {
4918 if( ssl->handshake == NULL )
4919 {
4920 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4921 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4922 }
4923
4924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4925 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4926 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004927#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004928
Ronald Cron6f135e12021-12-08 16:57:54 +01004929#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004930 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01004931 {
4932#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4933 MBEDTLS_SSL_DEBUG_MSG( 1,
4934 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4935 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4936#else
4937 MBEDTLS_SSL_DEBUG_MSG( 1,
4938 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4939 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4940#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4941 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004942#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004943 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004944
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004945 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004946 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004947 if( ssl->in_msglen != 2 )
4948 {
4949 /* Note: Standard allows for more than one 2 byte alert
4950 to be packed in a single message, but Mbed TLS doesn't
4951 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004953 ssl->in_msglen ) );
4954 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4955 }
4956
Paul Elliott9f352112020-12-09 14:55:45 +00004957 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004958 ssl->in_msg[0], ssl->in_msg[1] ) );
4959
4960 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004961 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004962 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004963 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004966 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004968 }
4969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004970 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4971 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004972 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4974 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004975 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004976
4977#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4978 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4979 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4980 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004981 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004982 /* Will be handled when trying to parse ServerHello */
4983 return( 0 );
4984 }
4985#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004986 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004987 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004988 }
4989
Hanno Beckerc76c6192017-06-06 10:03:17 +01004990#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004991 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004992 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004993 /* Drop unexpected ApplicationData records,
4994 * except at the beginning of renegotiations */
4995 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004996 mbedtls_ssl_is_handshake_over( ssl ) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004997#if defined(MBEDTLS_SSL_RENEGOTIATION)
4998 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4999 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01005000#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01005001 )
5002 {
5003 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
5004 return( MBEDTLS_ERR_SSL_NON_FATAL );
5005 }
5006
5007 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00005008 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker37ae9522019-05-03 16:54:26 +01005009 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005010 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01005011 }
5012 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005013#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005014
Paul Bakker5121ce52009-01-03 21:22:43 +00005015 return( 0 );
5016}
5017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005018int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005019{
irwir6c0da642019-09-26 21:07:41 +03005020 return( mbedtls_ssl_send_alert_message( ssl,
5021 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5022 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005023}
5024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005025int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00005026 unsigned char level,
5027 unsigned char message )
5028{
Janos Follath865b3eb2019-12-16 11:46:15 +00005029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005030
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005031 if( ssl == NULL || ssl->conf == NULL )
5032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5033
Hanno Becker5e18f742018-08-06 11:35:16 +01005034 if( ssl->out_left != 0 )
5035 return( mbedtls_ssl_flush_output( ssl ) );
5036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005038 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00005039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005040 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005041 ssl->out_msglen = 2;
5042 ssl->out_msg[0] = level;
5043 ssl->out_msg[1] = message;
5044
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02005045 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00005046 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005047 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00005048 return( ret );
5049 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00005051
5052 return( 0 );
5053}
5054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005055int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005056{
Janos Follath865b3eb2019-12-16 11:46:15 +00005057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005061 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005062 ssl->out_msglen = 1;
5063 ssl->out_msg[0] = 1;
5064
Paul Bakker5121ce52009-01-03 21:22:43 +00005065 ssl->state++;
5066
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005067 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005068 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005069 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005070 return( ret );
5071 }
5072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005073 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005074
5075 return( 0 );
5076}
5077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005078int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005079{
Janos Follath865b3eb2019-12-16 11:46:15 +00005080 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005083
Hanno Becker327c93b2018-08-15 13:56:18 +01005084 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005085 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005086 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005087 return( ret );
5088 }
5089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005090 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005091 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005093 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5094 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005096 }
5097
Hanno Beckere678eaa2018-08-21 14:57:46 +01005098 /* CCS records are only accepted if they have length 1 and content '1',
5099 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005100
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005101 /*
5102 * Switch to our negotiated transform and session parameters for inbound
5103 * data.
5104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005106 ssl->transform_in = ssl->transform_negotiate;
5107 ssl->session_in = ssl->session_negotiate;
5108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005109#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005110 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005111 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005112#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005113 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005114#endif
5115
5116 /* Increment epoch */
5117 if( ++ssl->in_epoch == 0 )
5118 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005119 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005120 /* This is highly unlikely to happen for legitimate reasons, so
5121 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005122 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005123 }
5124 }
5125 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005126#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08005127 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005128
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005129 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005130
Paul Bakker5121ce52009-01-03 21:22:43 +00005131 ssl->state++;
5132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005134
5135 return( 0 );
5136}
5137
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005138/* Once ssl->out_hdr as the address of the beginning of the
5139 * next outgoing record is set, deduce the other pointers.
5140 *
5141 * Note: For TLS, we save the implicit record sequence number
5142 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5143 * and the caller has to make sure there's space for this.
5144 */
5145
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005146static size_t ssl_transform_get_explicit_iv_len(
5147 mbedtls_ssl_transform const *transform )
5148{
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005149 return( transform->ivlen - transform->fixed_ivlen );
5150}
5151
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005152void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5153 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005154{
5155#if defined(MBEDTLS_SSL_PROTO_DTLS)
5156 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5157 {
5158 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005159#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005160 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005161 ssl->out_len = ssl->out_cid;
5162 if( transform != NULL )
5163 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005164#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005165 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005166#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005167 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005168 }
5169 else
5170#endif
5171 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005172 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005173#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005174 ssl->out_cid = ssl->out_len;
5175#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005176 ssl->out_iv = ssl->out_hdr + 5;
5177 }
5178
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005179 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005180 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005181 if( transform != NULL )
5182 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005183}
5184
5185/* Once ssl->in_hdr as the address of the beginning of the
5186 * next incoming record is set, deduce the other pointers.
5187 *
5188 * Note: For TLS, we save the implicit record sequence number
5189 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5190 * and the caller has to make sure there's space for this.
5191 */
5192
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005193void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005194{
Hanno Becker79594fd2019-05-08 09:38:41 +01005195 /* This function sets the pointers to match the case
5196 * of unprotected TLS/DTLS records, with both ssl->in_iv
5197 * and ssl->in_msg pointing to the beginning of the record
5198 * content.
5199 *
5200 * When decrypting a protected record, ssl->in_msg
5201 * will be shifted to point to the beginning of the
5202 * record plaintext.
5203 */
5204
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005205#if defined(MBEDTLS_SSL_PROTO_DTLS)
5206 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5207 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005208 /* This sets the header pointers to match records
5209 * without CID. When we receive a record containing
5210 * a CID, the fields are shifted accordingly in
5211 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005212 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005213#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005214 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005215 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005216#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005217 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005218#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005219 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005220 }
5221 else
5222#endif
5223 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005224 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005225 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005226#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005227 ssl->in_cid = ssl->in_len;
5228#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005229 ssl->in_iv = ssl->in_hdr + 5;
5230 }
5231
Hanno Becker79594fd2019-05-08 09:38:41 +01005232 /* This will be adjusted at record decryption time. */
5233 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005234}
5235
Paul Bakker5121ce52009-01-03 21:22:43 +00005236/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005237 * Setup an SSL context
5238 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005239
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005240void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005241{
5242 /* Set the incoming and outgoing record pointers. */
5243#if defined(MBEDTLS_SSL_PROTO_DTLS)
5244 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5245 {
5246 ssl->out_hdr = ssl->out_buf;
5247 ssl->in_hdr = ssl->in_buf;
5248 }
5249 else
5250#endif /* MBEDTLS_SSL_PROTO_DTLS */
5251 {
Hanno Becker12078f42021-03-02 15:28:41 +00005252 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005253 ssl->out_hdr = ssl->out_buf + 8;
5254 ssl->in_hdr = ssl->in_buf + 8;
5255 }
5256
5257 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005258 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5259 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005260}
5261
Paul Bakker5121ce52009-01-03 21:22:43 +00005262/*
5263 * SSL get accessors
5264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005265size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005266{
5267 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5268}
5269
Hanno Becker8b170a02017-10-10 11:51:19 +01005270int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5271{
5272 /*
5273 * Case A: We're currently holding back
5274 * a message for further processing.
5275 */
5276
5277 if( ssl->keep_current_message == 1 )
5278 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005279 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005280 return( 1 );
5281 }
5282
5283 /*
5284 * Case B: Further records are pending in the current datagram.
5285 */
5286
5287#if defined(MBEDTLS_SSL_PROTO_DTLS)
5288 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5289 ssl->in_left > ssl->next_record_offset )
5290 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005291 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005292 return( 1 );
5293 }
5294#endif /* MBEDTLS_SSL_PROTO_DTLS */
5295
5296 /*
5297 * Case C: A handshake message is being processed.
5298 */
5299
Hanno Becker8b170a02017-10-10 11:51:19 +01005300 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5301 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005302 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005303 return( 1 );
5304 }
5305
5306 /*
5307 * Case D: An application data message is being processed
5308 */
5309 if( ssl->in_offt != NULL )
5310 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005311 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005312 return( 1 );
5313 }
5314
5315 /*
5316 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005317 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005318 * we implement support for multiple alerts in single records.
5319 */
5320
5321 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5322 return( 0 );
5323}
5324
Paul Bakker43ca69c2011-01-15 17:35:19 +00005325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005326int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005327{
Hanno Becker3136ede2018-08-17 15:28:19 +01005328 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005330 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005331#if defined(MBEDTLS_USE_PSA_CRYPTO)
5332 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5333 psa_key_type_t key_type;
5334#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005335
Hanno Becker5903de42019-05-03 14:46:38 +01005336 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5337
Hanno Becker78640902018-08-13 16:35:15 +01005338 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005339 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005340
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005341
5342#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005343 if ( transform->psa_alg == PSA_ALG_GCM ||
5344 transform->psa_alg == PSA_ALG_CCM ||
5345 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5346 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005347 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005348 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005349 transform_expansion = transform->minlen;
5350 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005351 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005352 {
5353 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5354 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005355
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005356 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005357
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005358 /* Expansion due to the addition of the MAC. */
5359 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005360
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005361 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005362 * Theoretically up to 256 bytes, but we never use
5363 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005364 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005365
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005366 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005367 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005368#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005369 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005370#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005371 }
5372 else
5373 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005374 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005375 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005376 }
5377#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005378 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005379 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005380 case MBEDTLS_MODE_GCM:
5381 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005382 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005384 transform_expansion = transform->minlen;
5385 break;
5386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005387 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005388
5389 block_size = mbedtls_cipher_get_block_size(
5390 &transform->cipher_ctx_enc );
5391
Hanno Becker3136ede2018-08-17 15:28:19 +01005392 /* Expansion due to the addition of the MAC. */
5393 transform_expansion += transform->maclen;
5394
5395 /* Expansion due to the addition of CBC padding;
5396 * Theoretically up to 256 bytes, but we never use
5397 * more than the block size of the underlying cipher. */
5398 transform_expansion += block_size;
5399
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005400 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005401 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005402#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005403 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005404#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005405
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005406 break;
5407
5408 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005409 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005411 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005412#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005413
Hanno Beckera0e20d02019-05-15 14:03:01 +01005414#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005415 if( transform->out_cid_len != 0 )
5416 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005417#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005418
Hanno Becker5903de42019-05-03 14:46:38 +01005419 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005420}
5421
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005423/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005424 * Check record counters and renegotiate if they're above the limit.
5425 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005426MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005427static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005428{
Hanno Beckerdd772292020-02-05 10:38:31 +00005429 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005430 int in_ctr_cmp;
5431 int out_ctr_cmp;
5432
Paul Elliott27b0d942022-03-18 21:55:32 +00005433 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005435 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005436 {
5437 return( 0 );
5438 }
5439
Andres AG2196c7f2016-12-15 17:01:16 +00005440 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005441 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005442 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005443 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5444 &ssl->conf->renego_period[ep_len],
5445 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005446
5447 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005448 {
5449 return( 0 );
5450 }
5451
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005452 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005453 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005454}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005456
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005457#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5458
5459#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005460MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005461static int ssl_tls13_check_new_session_ticket( mbedtls_ssl_context *ssl )
5462{
5463
5464 if( ( ssl->in_hslen == mbedtls_ssl_hs_hdr_len( ssl ) ) ||
5465 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET ) )
5466 {
5467 return( 0 );
5468 }
5469
5470 ssl->keep_current_message = 1;
5471
5472 MBEDTLS_SSL_DEBUG_MSG( 3, ( "NewSessionTicket received" ) );
5473 mbedtls_ssl_handshake_set_state( ssl,
Jerry Yua357cf42022-07-12 05:36:45 +00005474 MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005475
5476 return( MBEDTLS_ERR_SSL_WANT_READ );
5477}
5478#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5479
Jerry Yua0446a02022-07-13 11:22:55 +08005480MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005481static int ssl_tls13_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
5482{
5483
5484 MBEDTLS_SSL_DEBUG_MSG( 3, ( "received post-handshake message" ) );
5485
5486#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
5487 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5488 {
5489 int ret = ssl_tls13_check_new_session_ticket( ssl );
5490 if( ret != 0 )
5491 return( ret );
5492 }
5493#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5494
5495 /* Fail in all other cases. */
5496 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5497}
5498#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5499
5500#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005501/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005502 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005503 * may only be sent for the purpose of initiating renegotiations.
5504 *
5505 * This function is introduced as a separate helper since the handling
5506 * of post-handshake handshake messages changes significantly in TLS 1.3,
5507 * and having a helper function allows to distinguish between TLS <= 1.2 and
5508 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5509 */
Jerry Yua0446a02022-07-13 11:22:55 +08005510MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005511static int ssl_tls12_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005512{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005514
5515 /*
5516 * - For client-side, expect SERVER_HELLO_REQUEST.
5517 * - For server-side, expect CLIENT_HELLO.
5518 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5519 */
5520
5521#if defined(MBEDTLS_SSL_CLI_C)
5522 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5523 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5524 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5525 {
5526 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5527
5528 /* With DTLS, drop the packet (probably from last handshake) */
5529#if defined(MBEDTLS_SSL_PROTO_DTLS)
5530 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5531 {
5532 return( 0 );
5533 }
5534#endif
5535 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5536 }
5537#endif /* MBEDTLS_SSL_CLI_C */
5538
5539#if defined(MBEDTLS_SSL_SRV_C)
5540 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5541 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5542 {
5543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5544
5545 /* With DTLS, drop the packet (probably from last handshake) */
5546#if defined(MBEDTLS_SSL_PROTO_DTLS)
5547 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5548 {
5549 return( 0 );
5550 }
5551#endif
5552 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5553 }
5554#endif /* MBEDTLS_SSL_SRV_C */
5555
5556#if defined(MBEDTLS_SSL_RENEGOTIATION)
5557 /* Determine whether renegotiation attempt should be accepted */
5558 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5559 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5560 ssl->conf->allow_legacy_renegotiation ==
5561 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5562 {
5563 /*
5564 * Accept renegotiation request
5565 */
5566
5567 /* DTLS clients need to know renego is server-initiated */
5568#if defined(MBEDTLS_SSL_PROTO_DTLS)
5569 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5570 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5571 {
5572 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5573 }
5574#endif
5575 ret = mbedtls_ssl_start_renegotiation( ssl );
5576 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5577 ret != 0 )
5578 {
5579 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5580 ret );
5581 return( ret );
5582 }
5583 }
5584 else
5585#endif /* MBEDTLS_SSL_RENEGOTIATION */
5586 {
5587 /*
5588 * Refuse renegotiation
5589 */
5590
5591 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5592
TRodziewicz345165c2021-07-06 13:42:11 +02005593 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5594 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5595 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005596 {
TRodziewicz345165c2021-07-06 13:42:11 +02005597 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005598 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005599 }
5600
5601 return( 0 );
5602}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005603#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5604
5605MBEDTLS_CHECK_RETURN_CRITICAL
5606static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
5607{
5608 /* Check protocol version and dispatch accordingly. */
5609#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5610 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
5611 {
5612 return( ssl_tls13_handle_hs_message_post_handshake( ssl ) );
5613 }
5614#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5615
5616#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5617 if( ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 )
5618 {
5619 return( ssl_tls12_handle_hs_message_post_handshake( ssl ) );
5620 }
5621#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5622
5623 /* Should never happen */
5624 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5625}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005626
Paul Bakker48916f92012-09-16 19:57:18 +00005627/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005628 * Receive application data decrypted from the SSL layer
5629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005630int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005631{
Janos Follath865b3eb2019-12-16 11:46:15 +00005632 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005633 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005634
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005635 if( ssl == NULL || ssl->conf == NULL )
5636 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5637
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005638 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005641 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005642 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005643 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005644 return( ret );
5645
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005646 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005647 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005648 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005649 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005650 return( ret );
5651 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005652 }
5653#endif
5654
Hanno Becker4a810fb2017-05-24 16:27:30 +01005655 /*
5656 * Check if renegotiation is necessary and/or handshake is
5657 * in process. If yes, perform/continue, and fall through
5658 * if an unexpected packet is received while the client
5659 * is waiting for the ServerHello.
5660 *
5661 * (There is no equivalent to the last condition on
5662 * the server-side as it is not treated as within
5663 * a handshake while waiting for the ClientHello
5664 * after a renegotiation request.)
5665 */
5666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005667#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005668 ret = ssl_check_ctr_renegotiate( ssl );
5669 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5670 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005671 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005673 return( ret );
5674 }
5675#endif
5676
Paul Elliott27b0d942022-03-18 21:55:32 +00005677 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005680 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5681 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005682 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005683 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005684 return( ret );
5685 }
5686 }
5687
Hanno Beckere41158b2017-10-23 13:30:32 +01005688 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005689 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005690 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005691 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005692 if( ssl->f_get_timer != NULL &&
5693 ssl->f_get_timer( ssl->p_timer ) == -1 )
5694 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005695 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005696 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005697
Hanno Becker327c93b2018-08-15 13:56:18 +01005698 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005699 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005700 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5701 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005702
Hanno Becker4a810fb2017-05-24 16:27:30 +01005703 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5704 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005705 }
5706
5707 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005708 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005709 {
5710 /*
5711 * OpenSSL sends empty messages to randomize the IV
5712 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005713 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005714 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005715 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005716 return( 0 );
5717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005718 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005719 return( ret );
5720 }
5721 }
5722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005724 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005725 ret = ssl_handle_hs_message_post_handshake( ssl );
5726 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005727 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005728 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5729 ret );
5730 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005731 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005732
Hanno Beckerf26cc722021-04-21 07:30:13 +01005733 /* At this point, we don't know whether the renegotiation triggered
5734 * by the post-handshake message has been completed or not. The cases
5735 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005736 * 1) The renegotiation is complete. In this case, no new record
5737 * has been read yet.
5738 * 2) The renegotiation is incomplete because the client received
5739 * an application data record while awaiting the ServerHello.
5740 * 3) The renegotiation is incomplete because the client received
5741 * a non-handshake, non-application data message while awaiting
5742 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005743 *
5744 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005745 * - For 1), the next iteration will read a new record and check
5746 * if it's application data.
5747 * - For 2), the loop condition isn't satisfied as application data
5748 * is present, hence continue is the same as break
5749 * - For 3), the loop condition is satisfied and read_record
5750 * will re-deliver the message that was held back by the client
5751 * when expecting the ServerHello.
5752 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005753
Hanno Becker90333da2017-10-10 11:27:13 +01005754 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005755 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005756#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005757 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005758 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005759 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005760 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005761 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005762 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005763 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005764 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005765 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005766 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005767 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005768 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005769#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005771 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5772 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005773 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005774 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005775 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005776 }
5777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005778 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005779 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5781 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005782 }
5783
5784 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005785
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005786 /* We're going to return something now, cancel timer,
5787 * except if handshake (renegotiation) is in progress */
Paul Elliott27b0d942022-03-18 21:55:32 +00005788 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker0f57a652020-02-05 10:37:26 +00005789 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005790
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005791#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005792 /* If we requested renego but received AppData, resend HelloRequest.
5793 * Do it now, after setting in_offt, to avoid taking this branch
5794 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005795#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005796 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005797 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005798 {
Hanno Becker786300f2020-02-05 10:46:40 +00005799 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005800 {
Hanno Becker786300f2020-02-05 10:46:40 +00005801 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5802 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005803 return( ret );
5804 }
5805 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005806#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005807#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005808 }
5809
5810 n = ( len < ssl->in_msglen )
5811 ? len : ssl->in_msglen;
5812
5813 memcpy( buf, ssl->in_offt, n );
5814 ssl->in_msglen -= n;
5815
gabor-mezei-arma3214132020-07-15 10:55:00 +02005816 /* Zeroising the plaintext buffer to erase unused application data
5817 from the memory. */
5818 mbedtls_platform_zeroize( ssl->in_offt, n );
5819
Paul Bakker5121ce52009-01-03 21:22:43 +00005820 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005821 {
5822 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005823 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005824 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005825 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005826 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005827 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005828 /* more data available */
5829 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005830 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005831
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005832 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005833
Paul Bakker23986e52011-04-24 08:57:21 +00005834 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005835}
5836
5837/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005838 * Send application data to be encrypted by the SSL layer, taking care of max
5839 * fragment length and buffer size.
5840 *
5841 * According to RFC 5246 Section 6.2.1:
5842 *
5843 * Zero-length fragments of Application data MAY be sent as they are
5844 * potentially useful as a traffic analysis countermeasure.
5845 *
5846 * Therefore, it is possible that the input message length is 0 and the
5847 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005848 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005849MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005850static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005851 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005852{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005853 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5854 const size_t max_len = (size_t) ret;
5855
5856 if( ret < 0 )
5857 {
5858 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5859 return( ret );
5860 }
5861
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005862 if( len > max_len )
5863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005864#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005865 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005866 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005868 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5869 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005870 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005871 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005872 }
5873 else
5874#endif
5875 len = max_len;
5876 }
Paul Bakker887bd502011-06-08 13:10:54 +00005877
Paul Bakker5121ce52009-01-03 21:22:43 +00005878 if( ssl->out_left != 0 )
5879 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005880 /*
5881 * The user has previously tried to send the data and
5882 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5883 * written. In this case, we expect the high-level write function
5884 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005886 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005888 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005889 return( ret );
5890 }
5891 }
Paul Bakker887bd502011-06-08 13:10:54 +00005892 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005893 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005894 /*
5895 * The user is trying to send a message the first time, so we need to
5896 * copy the data into the internal buffers and setup the data structure
5897 * to keep track of partial writes
5898 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005899 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005900 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005901 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005902
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02005903 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005904 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005905 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005906 return( ret );
5907 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005908 }
5909
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005910 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005911}
5912
5913/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005914 * Write application data (public-facing wrapper)
5915 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005916int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005917{
Janos Follath865b3eb2019-12-16 11:46:15 +00005918 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005919
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005920 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005921
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005922 if( ssl == NULL || ssl->conf == NULL )
5923 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5924
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005925#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005926 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5927 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005928 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005929 return( ret );
5930 }
5931#endif
5932
Paul Elliott27b0d942022-03-18 21:55:32 +00005933 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005934 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005935 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005936 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005937 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005938 return( ret );
5939 }
5940 }
5941
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005942 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005943
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005944 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005945
5946 return( ret );
5947}
5948
5949/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005950 * Notify the peer that the connection is being closed
5951 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005952int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005953{
Janos Follath865b3eb2019-12-16 11:46:15 +00005954 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005955
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005956 if( ssl == NULL || ssl->conf == NULL )
5957 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005960
Paul Elliott27b0d942022-03-18 21:55:32 +00005961 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005962 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005963 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5964 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5965 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005967 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005968 return( ret );
5969 }
5970 }
5971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005972 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005973
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005974 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005975}
5976
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005977void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005978{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005979 if( transform == NULL )
5980 return;
5981
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005982#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005983 psa_destroy_key( transform->psa_key_enc );
5984 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005985#else
5986 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5987 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5988#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005989
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005990#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005991#if defined(MBEDTLS_USE_PSA_CRYPTO)
5992 psa_destroy_key( transform->psa_mac_enc );
5993 psa_destroy_key( transform->psa_mac_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005994#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005995 mbedtls_md_free( &transform->md_ctx_enc );
5996 mbedtls_md_free( &transform->md_ctx_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005997#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005998#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005999
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05006000 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00006001}
6002
Jerry Yuc7875b52021-09-05 21:05:50 +08006003void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
6004 mbedtls_ssl_transform *transform )
6005{
Jerry Yuc7875b52021-09-05 21:05:50 +08006006 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08006007 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08006008}
6009
6010void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
6011 mbedtls_ssl_transform *transform )
6012{
6013 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08006014 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08006015}
6016
Hanno Becker0271f962018-08-16 13:23:47 +01006017#if defined(MBEDTLS_SSL_PROTO_DTLS)
6018
Hanno Becker533ab5f2020-02-05 10:49:13 +00006019void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01006020{
6021 unsigned offset;
6022 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6023
6024 if( hs == NULL )
6025 return;
6026
Hanno Becker283f5ef2018-08-24 09:34:47 +01006027 ssl_free_buffered_record( ssl );
6028
Hanno Becker0271f962018-08-16 13:23:47 +01006029 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01006030 ssl_buffering_free_slot( ssl, offset );
6031}
6032
6033static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
6034 uint8_t slot )
6035{
6036 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6037 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006038
6039 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
6040 return;
6041
Hanno Beckere605b192018-08-21 15:59:07 +01006042 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01006043 {
Hanno Beckere605b192018-08-21 15:59:07 +01006044 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01006045 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01006046 mbedtls_free( hs_buf->data );
6047 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01006048 }
6049}
6050
6051#endif /* MBEDTLS_SSL_PROTO_DTLS */
6052
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006053/*
6054 * Convert version numbers to/from wire format
6055 * and, for DTLS, to/from TLS equivalent.
6056 *
6057 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006058 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006059 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006060 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006061 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006062void mbedtls_ssl_write_version( unsigned char version[2], int transport,
6063 mbedtls_ssl_protocol_version tls_version )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006064{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006065#if defined(MBEDTLS_SSL_PROTO_DTLS)
6066 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006067 tls_version =
6068 ~( tls_version - ( tls_version == 0x0302 ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006069#else
6070 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006071#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006072 MBEDTLS_PUT_UINT16_BE( tls_version, version, 0 );
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006073}
6074
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006075uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
6076 int transport )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006077{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006078 uint16_t tls_version = MBEDTLS_GET_UINT16_BE( version, 0 );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006079#if defined(MBEDTLS_SSL_PROTO_DTLS)
6080 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006081 tls_version =
6082 ~( tls_version - ( tls_version == 0xfeff ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006083#else
6084 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006085#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006086 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006087}
6088
Jerry Yue7047812021-09-13 19:26:39 +08006089/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006090 * Send pending fatal alert.
6091 * 0, No alert message.
6092 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6093 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006094 */
6095int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
6096{
6097 int ret;
6098
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006099 /* No pending alert, return success*/
6100 if( ssl->send_alert == 0 )
6101 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08006102
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006103 ret = mbedtls_ssl_send_alert_message( ssl,
6104 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6105 ssl->alert_type );
6106
Jerry Yu3bf1f972021-09-22 21:37:18 +08006107 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6108 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006109 */
6110 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
6111 {
6112 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006113 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006114
6115 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006116 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006117
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006118 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08006119}
6120
Jerry Yu394ece62021-09-14 22:17:21 +08006121/*
6122 * Set pending fatal alert flag.
6123 */
6124void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
6125 unsigned char alert_type,
6126 int alert_reason )
6127{
6128 ssl->send_alert = 1;
6129 ssl->alert_type = alert_type;
6130 ssl->alert_reason = alert_reason;
6131}
6132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006133#endif /* MBEDTLS_SSL_TLS_C */