blob: 085233c151ccba133d455dab8885932405115d8d [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
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100385/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100386 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000387static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100388 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100389 mbedtls_record *rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400390 mbedtls_ssl_protocol_version
391 tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000392 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000393{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100394 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100395 *
396 * additional_data = seq_num + TLSCompressed.type +
397 * TLSCompressed.version + TLSCompressed.length;
398 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100399 * For the CID extension, this is extended as follows
400 * (quoting draft-ietf-tls-dtls-connection-id-05,
401 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100402 *
403 * additional_data = seq_num + DTLSPlaintext.type +
404 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100405 * cid +
406 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100407 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100408 *
409 * For TLS 1.3, the record sequence number is dropped from the AAD
410 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000411 * Moreover, the additional data involves the length of the TLS
412 * ciphertext, not the TLS plaintext as in earlier versions.
413 * Quoting RFC 8446 (TLS 1.3):
414 *
415 * additional_data = TLSCiphertext.opaque_type ||
416 * TLSCiphertext.legacy_record_version ||
417 * TLSCiphertext.length
418 *
419 * We pass the tag length to this function in order to compute the
420 * ciphertext length from the inner plaintext length rec->data_len via
421 *
422 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
423 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100424 */
425
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100426 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000427 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100428
Ronald Cron6f135e12021-12-08 16:57:54 +0100429#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400430 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000431 {
432 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
433 * which differs from the length of the TLSInnerPlaintext
434 * by the length of the authentication tag. */
435 ad_len_field += taglen;
436 }
437 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100438#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100439 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400440 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000441 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100442 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
443 cur += sizeof( rec->ctr );
444 }
445
446 *cur = rec->type;
447 cur++;
448
449 memcpy( cur, rec->ver, sizeof( rec->ver ) );
450 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100451
Hanno Beckera0e20d02019-05-15 14:03:01 +0100452#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100453 if( rec->cid_len != 0 )
454 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100455 memcpy( cur, rec->cid, rec->cid_len );
456 cur += rec->cid_len;
457
458 *cur = rec->cid_len;
459 cur++;
460
Joe Subbiani6dd73642021-07-19 11:56:54 +0100461 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100462 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 }
464 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100465#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100466 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100467 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100468 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100469 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100470
471 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000472}
473
Hanno Becker67a37db2020-05-28 16:27:07 +0100474#if defined(MBEDTLS_GCM_C) || \
475 defined(MBEDTLS_CCM_C) || \
476 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200477MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100478static int ssl_transform_aead_dynamic_iv_is_explicit(
479 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100480{
Hanno Becker17263802020-05-28 07:05:48 +0100481 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100482}
483
Hanno Becker17263802020-05-28 07:05:48 +0100484/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
485 *
486 * Concretely, this occurs in two variants:
487 *
488 * a) Fixed and dynamic IV lengths add up to total IV length, giving
489 * IV = fixed_iv || dynamic_iv
490 *
Hanno Becker15952812020-06-04 13:31:46 +0100491 * This variant is used in TLS 1.2 when used with GCM or CCM.
492 *
Hanno Becker17263802020-05-28 07:05:48 +0100493 * b) Fixed IV lengths matches total IV length, giving
494 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100495 *
496 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
497 *
498 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100499 *
500 * This function has the precondition that
501 *
502 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
503 *
504 * which has to be ensured by the caller. If this precondition
505 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100506 */
507static void ssl_build_record_nonce( unsigned char *dst_iv,
508 size_t dst_iv_len,
509 unsigned char const *fixed_iv,
510 size_t fixed_iv_len,
511 unsigned char const *dynamic_iv,
512 size_t dynamic_iv_len )
513{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100514 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100515 memset( dst_iv, 0, dst_iv_len );
516 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100517
Hanno Becker17263802020-05-28 07:05:48 +0100518 dst_iv += dst_iv_len - dynamic_iv_len;
Dave Rodgmanc36a56e2022-11-22 17:00:26 +0000519 mbedtls_xor( dst_iv, dst_iv, dynamic_iv, dynamic_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100520}
Hanno Becker67a37db2020-05-28 16:27:07 +0100521#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100522
Hanno Beckera18d1322018-01-03 14:27:32 +0000523int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
524 mbedtls_ssl_transform *transform,
525 mbedtls_record *rec,
526 int (*f_rng)(void *, unsigned char *, size_t),
527 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000528{
Neil Armstrong136f8402022-03-30 10:58:01 +0200529 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100530 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000531 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100532 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100533 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000534 size_t post_avail;
535
536 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000537#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200538 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000539 ((void) ssl);
540#endif
541
542 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200544#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200545 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000546 ((void) f_rng);
547 ((void) p_rng);
548#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000551
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100553 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000554 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
555 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
556 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100557 if( rec == NULL
558 || rec->buf == NULL
559 || rec->buf_len < rec->data_offset
560 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100561#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100562 || rec->cid_len != 0
563#endif
564 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000565 {
566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100568 }
569
Neil Armstrongab555e02022-04-04 11:07:59 +0200570 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Neil Armstrong136f8402022-03-30 10:58:01 +0200571
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000572 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100573 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000575 data, rec->data_len );
576
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000577 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
578 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
580 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000581 rec->data_len,
582 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000583 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
584 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100585
Hanno Becker92313402020-05-20 13:58:58 +0100586 /* The following two code paths implement the (D)TLSInnerPlaintext
587 * structure present in TLS 1.3 and DTLS 1.2 + CID.
588 *
589 * See ssl_build_inner_plaintext() for more information.
590 *
591 * Note that this changes `rec->data_len`, and hence
592 * `post_avail` needs to be recalculated afterwards.
593 *
594 * Note also that the two code paths cannot occur simultaneously
595 * since they apply to different versions of the protocol. There
596 * is hence no risk of double-addition of the inner plaintext.
597 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100598#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400599 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100600 {
Hanno Becker13996922020-05-28 16:15:19 +0100601 size_t padding =
602 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200603 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100604 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100605 &rec->data_len,
606 post_avail,
607 rec->type,
608 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100609 {
610 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
611 }
612
613 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
614 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100615#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100616
Hanno Beckera0e20d02019-05-15 14:03:01 +0100617#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100618 /*
619 * Add CID information
620 */
621 rec->cid_len = transform->out_cid_len;
622 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
623 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624
625 if( rec->cid_len != 0 )
626 {
Hanno Becker13996922020-05-28 16:15:19 +0100627 size_t padding =
628 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200629 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100630 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100631 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100632 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100634 * Note that this changes `rec->data_len`, and hence
635 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100637 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100638 &rec->data_len,
639 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100640 rec->type,
641 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100642 {
643 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
644 }
645
646 rec->type = MBEDTLS_SSL_MSG_CID;
647 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100648#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100649
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100650 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
651
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100653 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000654 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000655#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +0200656 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
657 ssl_mode == MBEDTLS_SSL_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000658 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000659 if( post_avail < transform->maclen )
660 {
661 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
662 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
663 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200664#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200665 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100666 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100667#if defined(MBEDTLS_USE_PSA_CRYPTO)
668 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
670 size_t sign_mac_length = 0;
671#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +0000672
TRodziewicz345165c2021-07-06 13:42:11 +0200673 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400674 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000675 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000676
Neil Armstrong26e6d672022-02-23 09:30:33 +0100677#if defined(MBEDTLS_USE_PSA_CRYPTO)
678 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
679 transform->psa_mac_alg );
680 if( status != PSA_SUCCESS )
681 goto hmac_failed_etm_disabled;
682
683 status = psa_mac_update( &operation, add_data, add_data_len );
684 if( status != PSA_SUCCESS )
685 goto hmac_failed_etm_disabled;
686
687 status = psa_mac_update( &operation, data, rec->data_len );
688 if( status != PSA_SUCCESS )
689 goto hmac_failed_etm_disabled;
690
691 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
692 &sign_mac_length );
693 if( status != PSA_SUCCESS )
694 goto hmac_failed_etm_disabled;
695#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100696 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
697 add_data_len );
698 if( ret != 0 )
699 goto hmac_failed_etm_disabled;
700 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
701 if( ret != 0 )
702 goto hmac_failed_etm_disabled;
703 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
704 if( ret != 0 )
705 goto hmac_failed_etm_disabled;
706 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
707 if( ret != 0 )
708 goto hmac_failed_etm_disabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100709#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000710
TRodziewicz345165c2021-07-06 13:42:11 +0200711 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200712#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200713
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000714 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
715 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200716
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000717 rec->data_len += transform->maclen;
718 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100719 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100720
721 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100722 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +0100723#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +0100724 ret = psa_ssl_status_to_mbedtls( status );
725 status = psa_mac_abort( &operation );
726 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +0100727 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +0100728#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100729 if( ret != 0 )
730 {
731 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
732 return( ret );
733 }
Paul Bakker577e0062013-08-28 11:57:20 +0200734 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000735#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000736
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200737 /*
738 * Encrypt
739 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000740#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +0200741 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000742 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000743 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000744 "including %d bytes of padding",
745 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000746
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100747 /* The only supported stream cipher is "NULL",
748 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000749 }
Paul Bakker68884e32013-01-07 18:20:04 +0100750 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000751#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000752
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200753#if defined(MBEDTLS_GCM_C) || \
754 defined(MBEDTLS_CCM_C) || \
755 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +0200756 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000757 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200758 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100759 unsigned char *dynamic_iv;
760 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100761 int dynamic_iv_is_explicit =
762 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100763#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100764 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100765#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100766 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000767
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100768 /* Check that there's space for the authentication tag. */
769 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000770 {
771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
772 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
773 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000774
Paul Bakker68884e32013-01-07 18:20:04 +0100775 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100776 * Build nonce for AEAD encryption.
777 *
778 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
779 * part of the IV is prepended to the ciphertext and
780 * can be chosen freely - in particular, it need not
781 * agree with the record sequence number.
782 * However, since ChaChaPoly as well as all AEAD modes
783 * in TLS 1.3 use the record sequence number as the
784 * dynamic part of the nonce, we uniformly use the
785 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100786 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100787 dynamic_iv = rec->ctr;
788 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200789
Hanno Becker17263802020-05-28 07:05:48 +0100790 ssl_build_record_nonce( iv, sizeof( iv ),
791 transform->iv_enc,
792 transform->fixed_ivlen,
793 dynamic_iv,
794 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100795
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100796 /*
797 * Build additional data for AEAD encryption.
798 * This depends on the TLS version.
799 */
800 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400801 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000802 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100803
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200804 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100805 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200806 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100807 dynamic_iv,
808 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000809 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100810 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000811 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200812 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000813 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000814
Paul Bakker68884e32013-01-07 18:20:04 +0100815 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200816 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200817 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100818#if defined(MBEDTLS_USE_PSA_CRYPTO)
819 status = psa_aead_encrypt( transform->psa_key_enc,
820 transform->psa_alg,
821 iv, transform->ivlen,
822 add_data, add_data_len,
823 data, rec->data_len,
824 data, rec->buf_len - (data - rec->buf),
825 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000826
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100827 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100828 {
829 ret = psa_ssl_status_to_mbedtls( status );
830 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
831 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100832 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100833#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100834 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000835 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100836 add_data, add_data_len,
837 data, rec->data_len, /* src */
838 data, rec->buf_len - (data - rec->buf), /* dst */
839 &rec->data_len,
840 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200841 {
TRodziewicz18efb732021-04-29 23:12:19 +0200842 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200843 return( ret );
844 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100845#endif /* MBEDTLS_USE_PSA_CRYPTO */
846
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000847 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100848 data + rec->data_len - transform->taglen,
849 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100850 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000851 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100852
853 /*
854 * Prefix record content with dynamic IV in case it is explicit.
855 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100856 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100857 {
858 if( rec->data_offset < dynamic_iv_len )
859 {
860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
861 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
862 }
863
864 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
865 rec->data_offset -= dynamic_iv_len;
866 rec->data_len += dynamic_iv_len;
867 }
868
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100869 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000870 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000871 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100872#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200873#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +0200874 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
875 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000876 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000877 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000878 size_t padlen, i;
879 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100880#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100881 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100882 size_t part_len;
883 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
884#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000885
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000886 /* Currently we're always using minimal padding
887 * (up to 255 bytes would be allowed). */
888 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
889 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000890 padlen = 0;
891
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000892 /* Check there's enough space in the buffer for the padding. */
893 if( post_avail < padlen + 1 )
894 {
895 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
896 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
897 }
898
Paul Bakker5121ce52009-01-03 21:22:43 +0000899 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000900 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000901
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 rec->data_len += padlen + 1;
903 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000904
TRodziewicz0f82ec62021-05-12 17:49:18 +0200905#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000906 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200907 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000908 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000909 */
TRodziewicz345165c2021-07-06 13:42:11 +0200910 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000911 {
TRodziewicz345165c2021-07-06 13:42:11 +0200912 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
913 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000914 }
TRodziewicz345165c2021-07-06 13:42:11 +0200915
916 if( rec->data_offset < transform->ivlen )
917 {
918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
919 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
920 }
921
922 /*
923 * Generate IV
924 */
925 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
926 if( ret != 0 )
927 return( ret );
928
929 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200930#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000931
Paul Elliottd48d5c62021-01-07 14:47:05 +0000932 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
933 "including %" MBEDTLS_PRINTF_SIZET
934 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000935 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200936 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000937
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100938#if defined(MBEDTLS_USE_PSA_CRYPTO)
939 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100940 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100941
942 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100943 {
944 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100945 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_encrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100946 return( ret );
947 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100948
949 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
950
951 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100952 {
953 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100954 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100955 return( ret );
956
957 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100958
959 status = psa_cipher_update( &cipher_op,
960 data, rec->data_len,
961 data, rec->data_len, &olen );
962
963 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100964 {
965 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100966 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100967 return( ret );
968
969 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100970
971 status = psa_cipher_finish( &cipher_op,
972 data + olen, rec->data_len - olen,
973 &part_len );
974
975 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100976 {
977 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100978 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100979 return( ret );
980
981 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100982
983 olen += part_len;
984#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000985 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
986 transform->iv_enc,
987 transform->ivlen,
988 data, rec->data_len,
989 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200990 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200992 return( ret );
993 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100994#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200995
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000996 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200997 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
999 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001000 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001001
TRodziewicz0f82ec62021-05-12 17:49:18 +02001002 data -= transform->ivlen;
1003 rec->data_offset -= transform->ivlen;
1004 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001007 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001008 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001009 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001010#if defined(MBEDTLS_USE_PSA_CRYPTO)
1011 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1012 size_t sign_mac_length = 0;
1013#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001014
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001015 /*
1016 * MAC(MAC_write_key, seq_num +
1017 * TLSCipherText.type +
1018 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001019 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001020 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001021 * ENC(content + padding + padding_length));
1022 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001023
1024 if( post_avail < transform->maclen)
1025 {
1026 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1027 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1028 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001029
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001030 ssl_extract_add_data_from_record( add_data, &add_data_len,
Glenn Strauss07c64162022-03-14 12:34:51 -04001031 rec, transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001032 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001035 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001036 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001037#if defined(MBEDTLS_USE_PSA_CRYPTO)
1038 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
1039 transform->psa_mac_alg );
1040 if( status != PSA_SUCCESS )
1041 goto hmac_failed_etm_enabled;
1042
1043 status = psa_mac_update( &operation, add_data, add_data_len );
1044 if( status != PSA_SUCCESS )
1045 goto hmac_failed_etm_enabled;
1046
1047 status = psa_mac_update( &operation, data, rec->data_len );
1048 if( status != PSA_SUCCESS )
1049 goto hmac_failed_etm_enabled;
1050
1051 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
1052 &sign_mac_length );
1053 if( status != PSA_SUCCESS )
1054 goto hmac_failed_etm_enabled;
1055#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001056
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001057 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1058 add_data_len );
1059 if( ret != 0 )
1060 goto hmac_failed_etm_enabled;
1061 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1062 data, rec->data_len );
1063 if( ret != 0 )
1064 goto hmac_failed_etm_enabled;
1065 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1066 if( ret != 0 )
1067 goto hmac_failed_etm_enabled;
1068 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1069 if( ret != 0 )
1070 goto hmac_failed_etm_enabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001071#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001072
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001073 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001074
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001075 rec->data_len += transform->maclen;
1076 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001077 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001078
1079 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001080 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001081#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001082 ret = psa_ssl_status_to_mbedtls( status );
1083 status = psa_mac_abort( &operation );
1084 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001085 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +01001086#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001087 if( ret != 0 )
1088 {
1089 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1090 return( ret );
1091 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001092 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001094 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001095 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001096#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001097 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1099 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001100 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001101
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001102 /* Make extra sure authentication was performed, exactly once */
1103 if( auth_done != 1 )
1104 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1106 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001107 }
1108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001110
1111 return( 0 );
1112}
1113
Hanno Becker605949f2019-07-12 08:23:59 +01001114int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001115 mbedtls_ssl_transform *transform,
1116 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001117{
Przemek Stekiel4c499272022-09-27 13:55:37 +02001118#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001119 size_t olen;
Przemek Stekiel4c499272022-09-27 13:55:37 +02001120#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001121 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001122 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001123
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001124 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001125#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001126 size_t padlen = 0, correct = 1;
1127#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001128 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001129 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001130 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001131
Hanno Beckera18d1322018-01-03 14:27:32 +00001132#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001133 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001134 ((void) ssl);
1135#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001138 if( rec == NULL ||
1139 rec->buf == NULL ||
1140 rec->buf_len < rec->data_offset ||
1141 rec->buf_len - rec->data_offset < rec->data_len )
1142 {
1143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001145 }
1146
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001147 data = rec->buf + rec->data_offset;
Neil Armstrongab555e02022-04-04 11:07:59 +02001148 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Paul Bakker5121ce52009-01-03 21:22:43 +00001149
Hanno Beckera0e20d02019-05-15 14:03:01 +01001150#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001151 /*
1152 * Match record's CID with incoming CID.
1153 */
Hanno Becker938489a2019-05-08 13:02:22 +01001154 if( rec->cid_len != transform->in_cid_len ||
1155 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1156 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001157 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001158 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001159#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001160
Hanno Beckerd086bf02021-03-22 13:01:27 +00001161#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +02001162 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001163 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001164 /* The only supported stream cipher is "NULL",
1165 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001166 }
Paul Bakker68884e32013-01-07 18:20:04 +01001167 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001168#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001169#if defined(MBEDTLS_GCM_C) || \
1170 defined(MBEDTLS_CCM_C) || \
1171 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +02001172 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001173 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001174 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001175 unsigned char *dynamic_iv;
1176 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001177#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001178 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001179#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001180
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001181 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001182 * Extract dynamic part of nonce for AEAD decryption.
1183 *
1184 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1185 * part of the IV is prepended to the ciphertext and
1186 * can be chosen freely - in particular, it need not
1187 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001188 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001189 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001190 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001191 {
1192 if( rec->data_len < dynamic_iv_len )
1193 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001194 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1195 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001196 rec->data_len,
1197 dynamic_iv_len ) );
1198 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1199 }
1200 dynamic_iv = data;
1201
1202 data += dynamic_iv_len;
1203 rec->data_offset += dynamic_iv_len;
1204 rec->data_len -= dynamic_iv_len;
1205 }
Hanno Becker17263802020-05-28 07:05:48 +01001206 else
1207 {
1208 dynamic_iv = rec->ctr;
1209 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001210
1211 /* Check that there's space for the authentication tag. */
1212 if( rec->data_len < transform->taglen )
1213 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001214 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1215 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001216 rec->data_len,
1217 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001219 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001220 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001221
Hanno Beckerdf8be222020-05-21 15:30:57 +01001222 /*
1223 * Prepare nonce from dynamic and static parts.
1224 */
Hanno Becker17263802020-05-28 07:05:48 +01001225 ssl_build_record_nonce( iv, sizeof( iv ),
1226 transform->iv_dec,
1227 transform->fixed_ivlen,
1228 dynamic_iv,
1229 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001230
Hanno Beckerdf8be222020-05-21 15:30:57 +01001231 /*
1232 * Build additional data for AEAD encryption.
1233 * This depends on the TLS version.
1234 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001235 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001236 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001237 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001238 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001239 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001240
Hanno Beckerd96a6522019-07-10 13:55:25 +01001241 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001242 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001243 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001244 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001245 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001246
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001247 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001248 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001249 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001250
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001251 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001252 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001253 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001254#if defined(MBEDTLS_USE_PSA_CRYPTO)
1255 status = psa_aead_decrypt( transform->psa_key_dec,
1256 transform->psa_alg,
1257 iv, transform->ivlen,
1258 add_data, add_data_len,
1259 data, rec->data_len + transform->taglen,
1260 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001261 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001262
1263 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001264 {
1265 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001266 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001267 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001268 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001269#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001270 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001271 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001272 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001273 data, rec->data_len + transform->taglen, /* src */
1274 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001275 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001276 {
TRodziewicz18efb732021-04-29 23:12:19 +02001277 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1280 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001281
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001282 return( ret );
1283 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001284#endif /* MBEDTLS_USE_PSA_CRYPTO */
1285
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001286 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001287
Hanno Beckerd96a6522019-07-10 13:55:25 +01001288 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001289 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001290 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1292 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001293 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001294 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001295 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001297#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001298 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1299 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001300 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001301 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001302#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001304 size_t part_len;
1305 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1306#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001307
Paul Bakker5121ce52009-01-03 21:22:43 +00001308 /*
Paul Bakker45829992013-01-03 14:52:21 +01001309 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001310 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001311#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001312 /* The ciphertext is prefixed with the CBC IV. */
1313 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001314#endif
Paul Bakker45829992013-01-03 14:52:21 +01001315
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001316 /* Size considerations:
1317 *
1318 * - The CBC cipher text must not be empty and hence
1319 * at least of size transform->ivlen.
1320 *
1321 * Together with the potential IV-prefix, this explains
1322 * the first of the two checks below.
1323 *
1324 * - The record must contain a MAC, either in plain or
1325 * encrypted, depending on whether Encrypt-then-MAC
1326 * is used or not.
1327 * - If it is, the message contains the IV-prefix,
1328 * the CBC ciphertext, and the MAC.
1329 * - If it is not, the padded plaintext, and hence
1330 * the CBC ciphertext, has at least length maclen + 1
1331 * because there is at least the padding length byte.
1332 *
1333 * As the CBC ciphertext is not empty, both cases give the
1334 * lower bound minlen + maclen + 1 on the record size, which
1335 * we test for in the second check below.
1336 */
1337 if( rec->data_len < minlen + transform->ivlen ||
1338 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001339 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001340 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1341 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1342 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001343 "+ 1 ) ( + expl IV )", rec->data_len,
1344 transform->ivlen,
1345 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001347 }
1348
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001349 /*
1350 * Authenticate before decrypt if enabled
1351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001353 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001354 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001355#if defined(MBEDTLS_USE_PSA_CRYPTO)
1356 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1357#else
Hanno Becker992b6872017-11-09 18:57:39 +00001358 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001359#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001362
Hanno Beckerd96a6522019-07-10 13:55:25 +01001363 /* Update data_len in tandem with add_data.
1364 *
1365 * The subtraction is safe because of the previous check
1366 * data_len >= minlen + maclen + 1.
1367 *
1368 * Afterwards, we know that data + data_len is followed by at
1369 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001370 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001371 *
1372 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001373 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001374 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001375 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001376 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001377
Hanno Beckerd96a6522019-07-10 13:55:25 +01001378 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001379 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1380 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001381#if defined(MBEDTLS_USE_PSA_CRYPTO)
1382 status = psa_mac_verify_setup( &operation, transform->psa_mac_dec,
1383 transform->psa_mac_alg );
1384 if( status != PSA_SUCCESS )
1385 goto hmac_failed_etm_enabled;
1386
1387 status = psa_mac_update( &operation, add_data, add_data_len );
1388 if( status != PSA_SUCCESS )
1389 goto hmac_failed_etm_enabled;
1390
1391 status = psa_mac_update( &operation, data, rec->data_len );
1392 if( status != PSA_SUCCESS )
1393 goto hmac_failed_etm_enabled;
1394
1395 /* Compare expected MAC with MAC at the end of the record. */
1396 status = psa_mac_verify_finish( &operation, data + rec->data_len,
1397 transform->maclen );
1398 if( status != PSA_SUCCESS )
1399 goto hmac_failed_etm_enabled;
1400#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001401 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1402 add_data_len );
1403 if( ret != 0 )
1404 goto hmac_failed_etm_enabled;
1405 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001406 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001407 if( ret != 0 )
1408 goto hmac_failed_etm_enabled;
1409 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1410 if( ret != 0 )
1411 goto hmac_failed_etm_enabled;
1412 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1413 if( ret != 0 )
1414 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001415
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001416 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1417 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001418 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001419 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001420
Hanno Beckerd96a6522019-07-10 13:55:25 +01001421 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001422 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001423 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001424 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001426 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1427 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001428 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001429#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001430 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001431
1432 hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001433#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001434 ret = psa_ssl_status_to_mbedtls( status );
1435 status = psa_mac_abort( &operation );
1436 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001437 ret = psa_ssl_status_to_mbedtls( status );
1438#else
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001439 mbedtls_platform_zeroize( mac_expect, transform->maclen );
Neil Armstrong4313f552022-03-02 15:14:07 +01001440#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001441 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001442 {
1443 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1444 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001445 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001446 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001447 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001449
1450 /*
1451 * Check length sanity
1452 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001453
1454 /* We know from above that data_len > minlen >= 0,
1455 * so the following check in particular implies that
1456 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001457 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001458 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1460 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001463 }
1464
TRodziewicz0f82ec62021-05-12 17:49:18 +02001465#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001466 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001467 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001468 */
TRodziewicz345165c2021-07-06 13:42:11 +02001469 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1470 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001471
TRodziewicz345165c2021-07-06 13:42:11 +02001472 data += transform->ivlen;
1473 rec->data_offset += transform->ivlen;
1474 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001475#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001476
Hanno Beckerd96a6522019-07-10 13:55:25 +01001477 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1478
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001479#if defined(MBEDTLS_USE_PSA_CRYPTO)
1480 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001481 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001482
1483 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001484 {
1485 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001486 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001487 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001488 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001489
1490 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1491
1492 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001493 {
1494 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001495 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001496 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001497 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001498
1499 status = psa_cipher_update( &cipher_op,
1500 data, rec->data_len,
1501 data, rec->data_len, &olen );
1502
1503 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001504 {
1505 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001506 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001507 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001508 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001509
1510 status = psa_cipher_finish( &cipher_op,
1511 data + olen, rec->data_len - olen,
1512 &part_len );
1513
1514 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001515 {
1516 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001517 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001518 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001519 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001520
1521 olen += part_len;
1522#else
1523
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001524 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1525 transform->iv_dec, transform->ivlen,
1526 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001527 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001529 return( ret );
1530 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001531#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001532
Hanno Beckerd96a6522019-07-10 13:55:25 +01001533 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001534 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001535 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1537 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001538 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001539
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001540 /* Safe since data_len >= minlen + maclen + 1, so after having
1541 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001542 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1543 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001544 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001545
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001546 if( auth_done == 1 )
1547 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001548 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001549 rec->data_len,
1550 padlen + 1 );
1551 correct &= mask;
1552 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001553 }
1554 else
Paul Bakker45829992013-01-03 14:52:21 +01001555 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001557 if( rec->data_len < transform->maclen + padlen + 1 )
1558 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001559 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1560 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1561 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001562 rec->data_len,
1563 transform->maclen,
1564 padlen + 1 ) );
1565 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001566#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001567
Gabor Mezei90437e32021-10-20 11:59:27 +02001568 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001569 rec->data_len,
1570 transform->maclen + padlen + 1 );
1571 correct &= mask;
1572 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001573 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001574
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001575 padlen++;
1576
1577 /* Regardless of the validity of the padding,
1578 * we have data_len >= padlen here. */
1579
TRodziewicz0f82ec62021-05-12 17:49:18 +02001580#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001581 /* The padding check involves a series of up to 256
1582 * consecutive memory reads at the end of the record
1583 * plaintext buffer. In order to hide the length and
1584 * validity of the padding, always perform exactly
1585 * `min(256,plaintext_len)` reads (but take into account
1586 * only the last `padlen` bytes for the padding check). */
1587 size_t pad_count = 0;
1588 volatile unsigned char* const check = data;
1589
1590 /* Index of first padding byte; it has been ensured above
1591 * that the subtraction is safe. */
1592 size_t const padding_idx = rec->data_len - padlen;
1593 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1594 size_t const start_idx = rec->data_len - num_checks;
1595 size_t idx;
1596
1597 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001598 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001599 /* pad_count += (idx >= padding_idx) &&
1600 * (check[idx] == padlen - 1);
1601 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001602 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1603 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001604 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001605 pad_count += mask & equal;
1606 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001607 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001610 if( padlen > 0 && correct == 0 )
1611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001612#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001613 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001614
TRodziewicz0f82ec62021-05-12 17:49:18 +02001615#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001616
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001617 /* If the padding was found to be invalid, padlen == 0
1618 * and the subtraction is safe. If the padding was found valid,
1619 * padlen hasn't been changed and the previous assertion
1620 * data_len >= padlen still holds. */
1621 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001622 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001623 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001624#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001625 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1627 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001628 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001629
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001630#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001632 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001633#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001634
1635 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001636 * Authenticate if not done yet.
1637 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001638 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001639#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001640 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001641 {
Paul Elliott5260ce22022-05-09 18:15:54 +01001642 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1643 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001644
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001645 /* If the initial value of padlen was such that
1646 * data_len < maclen + padlen + 1, then padlen
1647 * got reset to 1, and the initial check
1648 * data_len >= minlen + maclen + 1
1649 * guarantees that at this point we still
1650 * have at least data_len >= maclen.
1651 *
1652 * If the initial value of padlen was such that
1653 * data_len >= maclen + padlen + 1, then we have
1654 * subtracted either padlen + 1 (if the padding was correct)
1655 * or 0 (if the padding was incorrect) since then,
1656 * hence data_len >= maclen in any case.
1657 */
1658 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001659 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001660 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001661 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001662
TRodziewicz0f82ec62021-05-12 17:49:18 +02001663#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001664 /*
Andrzej Kurek46a98732022-10-17 08:11:11 -04001665 * The next two sizes are the minimum and maximum values of
1666 * data_len over all padlen values.
1667 *
1668 * They're independent of padlen, since we previously did
1669 * data_len -= padlen.
1670 *
1671 * Note that max_len + maclen is never more than the buffer
1672 * length, as we previously did in_msglen -= maclen too.
1673 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001674 const size_t max_len = rec->data_len + padlen;
1675 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1676
Neil Armstronge8589962022-02-25 15:14:29 +01001677#if defined(MBEDTLS_USE_PSA_CRYPTO)
1678 ret = mbedtls_ct_hmac( transform->psa_mac_dec,
1679 transform->psa_mac_alg,
1680 add_data, add_data_len,
1681 data, rec->data_len, min_len, max_len,
1682 mac_expect );
1683#else
Gabor Mezei90437e32021-10-20 11:59:27 +02001684 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001685 add_data, add_data_len,
1686 data, rec->data_len, min_len, max_len,
1687 mac_expect );
Neil Armstronge8589962022-02-25 15:14:29 +01001688#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001689 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001690 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001691 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001692 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001693 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001694
Gabor Mezei90437e32021-10-20 11:59:27 +02001695 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001696 rec->data_len,
1697 min_len, max_len,
1698 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001699#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001700
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001701#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001702 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001703 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001704#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001705
Gabor Mezei90437e32021-10-20 11:59:27 +02001706 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001707 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001708 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709#if defined(MBEDTLS_SSL_DEBUG_ALL)
1710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001711#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001712 correct = 0;
1713 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001714 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001715
1716 hmac_failed_etm_disabled:
1717 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1718 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1719 if( ret != 0 )
1720 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001721 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001722
1723 /*
1724 * Finally check the correct flag
1725 */
1726 if( correct == 0 )
1727 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001728#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001729
1730 /* Make extra sure authentication was performed, exactly once */
1731 if( auth_done != 1 )
1732 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1734 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001735 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001736
Ronald Cron6f135e12021-12-08 16:57:54 +01001737#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04001738 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +01001739 {
1740 /* Remove inner padding and infer true content type. */
1741 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1742 &rec->type );
1743
1744 if( ret != 0 )
1745 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1746 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001747#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001748
Hanno Beckera0e20d02019-05-15 14:03:01 +01001749#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001750 if( rec->cid_len != 0 )
1751 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001752 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1753 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001754 if( ret != 0 )
1755 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1756 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001757#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001758
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001760
1761 return( 0 );
1762}
1763
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001764#undef MAC_NONE
1765#undef MAC_PLAINTEXT
1766#undef MAC_CIPHERTEXT
1767
Paul Bakker5121ce52009-01-03 21:22:43 +00001768/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001769 * Fill the input message buffer by appending data to it.
1770 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001771 *
1772 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1773 * available (from this read and/or a previous one). Otherwise, an error code
1774 * is returned (possibly EOF or WANT_READ).
1775 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001776 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1777 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1778 * since we always read a whole datagram at once.
1779 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001780 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001781 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001784{
Janos Follath865b3eb2019-12-16 11:46:15 +00001785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001786 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001787#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1788 size_t in_buf_len = ssl->in_buf_len;
1789#else
1790 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1791#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001794
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001795 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1796 {
Jan Brucknerf869bfd2022-11-07 15:28:49 +01001797 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001799 }
1800
Darryl Greenb33cc762019-11-28 14:29:44 +00001801 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001802 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1804 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001805 }
1806
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001808 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001809 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001810 uint32_t timeout;
1811
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001812 /*
1813 * The point is, we need to always read a full datagram at once, so we
1814 * sometimes read more then requested, and handle the additional data.
1815 * It could be the rest of the current record (while fetching the
1816 * header) and/or some other records in the same datagram.
1817 */
1818
1819 /*
1820 * Move to the next record in the already read datagram if applicable
1821 */
1822 if( ssl->next_record_offset != 0 )
1823 {
1824 if( ssl->in_left < ssl->next_record_offset )
1825 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1827 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001828 }
1829
1830 ssl->in_left -= ssl->next_record_offset;
1831
1832 if( ssl->in_left != 0 )
1833 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001834 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1835 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001836 ssl->next_record_offset ) );
1837 memmove( ssl->in_hdr,
1838 ssl->in_hdr + ssl->next_record_offset,
1839 ssl->in_left );
1840 }
1841
1842 ssl->next_record_offset = 0;
1843 }
1844
Paul Elliottd48d5c62021-01-07 14:47:05 +00001845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1846 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001847 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001848
1849 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001850 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001851 */
1852 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001853 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001854 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001855 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001856 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001857
1858 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001859 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001860 * are not at the beginning of a new record, the caller did something
1861 * wrong.
1862 */
1863 if( ssl->in_left != 0 )
1864 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1866 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001867 }
1868
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001869 /*
1870 * Don't even try to read if time's out already.
1871 * This avoids by-passing the timer when repeatedly receiving messages
1872 * that will end up being dropped.
1873 */
Hanno Becker7876d122020-02-05 10:39:31 +00001874 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001875 {
1876 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001877 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001878 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001879 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001880 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001881 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001882
Paul Elliott27b0d942022-03-18 21:55:32 +00001883 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001884 timeout = ssl->handshake->retransmit_timeout;
1885 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001886 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001887
Paul Elliott9f352112020-12-09 14:55:45 +00001888 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001889
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001890 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001891 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1892 timeout );
1893 else
1894 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001897
1898 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001900 }
1901
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001902 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001903 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001905 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001906
Paul Elliott27b0d942022-03-18 21:55:32 +00001907 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001908 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001909 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1910 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001912 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001913 }
1914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001916 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001918 return( ret );
1919 }
1920
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001921 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001922 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001924 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001926 {
Hanno Becker786300f2020-02-05 10:46:40 +00001927 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001928 {
Hanno Becker786300f2020-02-05 10:46:40 +00001929 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1930 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001931 return( ret );
1932 }
1933
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001934 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001935 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001936#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001937 }
1938
Paul Bakker5121ce52009-01-03 21:22:43 +00001939 if( ret < 0 )
1940 return( ret );
1941
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001942 ssl->in_left = ret;
1943 }
1944 else
1945#endif
1946 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1948 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001949 ssl->in_left, nb_want ) );
1950
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001951 while( ssl->in_left < nb_want )
1952 {
1953 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001954
Hanno Becker7876d122020-02-05 10:39:31 +00001955 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001956 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1957 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001958 {
1959 if( ssl->f_recv_timeout != NULL )
1960 {
1961 ret = ssl->f_recv_timeout( ssl->p_bio,
1962 ssl->in_hdr + ssl->in_left, len,
1963 ssl->conf->read_timeout );
1964 }
1965 else
1966 {
1967 ret = ssl->f_recv( ssl->p_bio,
1968 ssl->in_hdr + ssl->in_left, len );
1969 }
1970 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001971
Paul Elliottd48d5c62021-01-07 14:47:05 +00001972 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1973 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001974 ssl->in_left, nb_want ) );
1975 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001976
1977 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001979
1980 if( ret < 0 )
1981 return( ret );
1982
makise-homuraaf9513b2020-08-24 18:26:27 +03001983 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001984 {
Darryl Green11999bb2018-03-13 15:22:58 +00001985 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001986 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001987 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001988 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1989 }
1990
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001991 ssl->in_left += ret;
1992 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001993 }
1994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001996
1997 return( 0 );
1998}
1999
2000/*
2001 * Flush any data not yet written
2002 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002004{
Janos Follath865b3eb2019-12-16 11:46:15 +00002005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002006 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002009
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002010 if( ssl->f_send == NULL )
2011 {
Jan Brucknerf869bfd2022-11-07 15:28:49 +01002012 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002014 }
2015
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002016 /* Avoid incrementing counter if data is flushed */
2017 if( ssl->out_left == 0 )
2018 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002020 return( 0 );
2021 }
2022
Paul Bakker5121ce52009-01-03 21:22:43 +00002023 while( ssl->out_left > 0 )
2024 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2026 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002027 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002028
Hanno Becker2b1e3542018-08-06 11:19:13 +01002029 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002030 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002033
2034 if( ret <= 0 )
2035 return( ret );
2036
makise-homuraaf9513b2020-08-24 18:26:27 +03002037 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002038 {
Darryl Green11999bb2018-03-13 15:22:58 +00002039 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002040 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002041 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002042 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2043 }
2044
Paul Bakker5121ce52009-01-03 21:22:43 +00002045 ssl->out_left -= ret;
2046 }
2047
Hanno Becker2b1e3542018-08-06 11:19:13 +01002048#if defined(MBEDTLS_SSL_PROTO_DTLS)
2049 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002050 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002051 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002052 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002053 else
2054#endif
2055 {
2056 ssl->out_hdr = ssl->out_buf + 8;
2057 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002058 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002061
2062 return( 0 );
2063}
2064
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002065/*
2066 * Functions to handle the DTLS retransmission state machine
2067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002069/*
2070 * Append current handshake message to current outgoing flight
2071 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002072MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002073static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002074{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002076 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2077 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2078 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002079
2080 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002081 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002082 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002083 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002085 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002086 }
2087
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002088 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002089 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2091 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002093 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002094 }
2095
2096 /* Copy current handshake message with headers */
2097 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2098 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002099 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002100 msg->next = NULL;
2101
2102 /* Append to the current flight */
2103 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002104 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002105 else
2106 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002108 while( cur->next != NULL )
2109 cur = cur->next;
2110 cur->next = msg;
2111 }
2112
Hanno Becker3b235902018-08-06 09:54:53 +01002113 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002114 return( 0 );
2115}
2116
2117/*
2118 * Free the current flight of handshake messages
2119 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002120void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002121{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 mbedtls_ssl_flight_item *cur = flight;
2123 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002124
2125 while( cur != NULL )
2126 {
2127 next = cur->next;
2128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129 mbedtls_free( cur->p );
2130 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002131
2132 cur = next;
2133 }
2134}
2135
2136/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002137 * Swap transform_out and out_ctr with the alternative ones
2138 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002139MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002140static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002141{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002143 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002144
2145 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2146 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002147 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002148 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002149 }
2150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002152
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002153 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002154 tmp_transform = ssl->transform_out;
2155 ssl->transform_out = ssl->handshake->alt_transform_out;
2156 ssl->handshake->alt_transform_out = tmp_transform;
2157
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002158 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002159 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2160 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2161 sizeof( ssl->cur_out_ctr ) );
2162 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2163 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002164
2165 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002166 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002167
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002168 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002169}
2170
2171/*
2172 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002173 */
2174int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2175{
2176 int ret = 0;
2177
2178 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2179
2180 ret = mbedtls_ssl_flight_transmit( ssl );
2181
2182 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2183
2184 return( ret );
2185}
2186
2187/*
2188 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002189 *
2190 * Need to remember the current message in case flush_output returns
2191 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002192 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002194int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002195{
Janos Follath865b3eb2019-12-16 11:46:15 +00002196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002197 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002200 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002202
2203 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002204 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002205 ret = ssl_swap_epochs( ssl );
2206 if( ret != 0 )
2207 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002208
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002209 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002210 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002211
2212 while( ssl->handshake->cur_msg != NULL )
2213 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002214 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002215 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002216
Hanno Beckere1dcb032018-08-17 16:47:58 +01002217 int const is_finished =
2218 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2219 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2220
Ronald Cron00d012f22022-03-08 15:57:12 +01002221 int const force_flush = ssl->disable_datagram_packing == 1 ?
Hanno Becker04da1892018-08-14 13:22:10 +01002222 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2223
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002224 /* Swap epochs before sending Finished: we can't do it after
2225 * sending ChangeCipherSpec, in case write returns WANT_READ.
2226 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002227 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002228 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002229 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002230 ret = ssl_swap_epochs( ssl );
2231 if( ret != 0 )
2232 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002233 }
2234
Hanno Becker67bc7c32018-08-06 11:33:50 +01002235 ret = ssl_get_remaining_payload_in_datagram( ssl );
2236 if( ret < 0 )
2237 return( ret );
2238 max_frag_len = (size_t) ret;
2239
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002240 /* CCS is copied as is, while HS messages may need fragmentation */
2241 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2242 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002243 if( max_frag_len == 0 )
2244 {
2245 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2246 return( ret );
2247
2248 continue;
2249 }
2250
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002251 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002252 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002253 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002255 /* Update position inside current message */
2256 ssl->handshake->cur_msg_p += cur->len;
2257 }
2258 else
2259 {
2260 const unsigned char * const p = ssl->handshake->cur_msg_p;
2261 const size_t hs_len = cur->len - 12;
2262 const size_t frag_off = p - ( cur->p + 12 );
2263 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002264 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002265
Hanno Beckere1dcb032018-08-17 16:47:58 +01002266 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002267 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002268 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002269 {
2270 ret = ssl_swap_epochs( ssl );
2271 if( ret != 0 )
2272 return( ret );
2273 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002274
Hanno Becker67bc7c32018-08-06 11:33:50 +01002275 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2276 return( ret );
2277
2278 continue;
2279 }
2280 max_hs_frag_len = max_frag_len - 12;
2281
2282 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2283 max_hs_frag_len : rem_len;
2284
2285 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002286 {
2287 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002288 (unsigned) cur_hs_frag_len,
2289 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002290 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002291
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002292 /* Messages are stored with handshake headers as if not fragmented,
2293 * copy beginning of headers then fill fragmentation fields.
2294 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2295 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002296
Joe Subbiani5ecac212021-06-24 13:00:03 +01002297 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2298 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2299 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002300
Joe Subbiani5ecac212021-06-24 13:00:03 +01002301 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2302 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2303 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002304
2305 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2306
Hanno Becker3f7b9732018-08-28 09:53:25 +01002307 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002308 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2309 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002310 ssl->out_msgtype = cur->type;
2311
2312 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002313 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002314 }
2315
2316 /* If done with the current message move to the next one if any */
2317 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2318 {
2319 if( cur->next != NULL )
2320 {
2321 ssl->handshake->cur_msg = cur->next;
2322 ssl->handshake->cur_msg_p = cur->next->p + 12;
2323 }
2324 else
2325 {
2326 ssl->handshake->cur_msg = NULL;
2327 ssl->handshake->cur_msg_p = NULL;
2328 }
2329 }
2330
2331 /* Actually send the message out */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002332 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002335 return( ret );
2336 }
2337 }
2338
Hanno Becker67bc7c32018-08-06 11:33:50 +01002339 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2340 return( ret );
2341
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002342 /* Update state and set timer */
Paul Elliott27b0d942022-03-18 21:55:32 +00002343 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002345 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002346 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002348 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002349 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002350
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002351 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002352
2353 return( 0 );
2354}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002355
2356/*
2357 * To be called when the last message of an incoming flight is received.
2358 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002360{
2361 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002362 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002363 ssl->handshake->flight = NULL;
2364 ssl->handshake->cur_msg = NULL;
2365
2366 /* The next incoming flight will start with this msg_seq */
2367 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2368
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002369 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002370 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002371
Hanno Becker0271f962018-08-16 13:23:47 +01002372 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002373 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002374
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002375 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002376 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2379 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002380 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002382 }
2383 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002385}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002386
2387/*
2388 * To be called when the last message of an outgoing flight is send.
2389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002391{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002392 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002393 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2396 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002397 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002398 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002399 }
2400 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002402}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002404
Paul Bakker5121ce52009-01-03 21:22:43 +00002405/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002406 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002407 */
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002408int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
2409 unsigned char **buf, size_t *buf_len )
2410{
2411 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002412 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002413 * ...
2414 * HandshakeType msg_type;
2415 * uint24 length;
2416 * ...
2417 */
2418 *buf = ssl->out_msg + 4;
2419 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2420
2421 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2422 ssl->out_msg[0] = hs_type;
2423
2424 return( 0 );
2425}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002426
2427/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002428 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002429 *
2430 * - fill in handshake headers
2431 * - update handshake checksum
2432 * - DTLS: save message for resending
2433 * - then pass to the record layer
2434 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002435 * DTLS: except for HelloRequest, messages are only queued, and will only be
2436 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002437 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002438 * Inputs:
2439 * - ssl->out_msglen: 4 + actual handshake message len
2440 * (4 is the size of handshake headers for TLS)
2441 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2442 * - ssl->out_msg + 4: the handshake message body
2443 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002444 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002445 * - ssl->out_msglen: the length of the record contents
2446 * (including handshake headers but excluding record headers)
2447 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002448 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002449int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01002450 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01002451 int force_flush )
Paul Bakker5121ce52009-01-03 21:22:43 +00002452{
Janos Follath865b3eb2019-12-16 11:46:15 +00002453 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002454 const size_t hs_len = ssl->out_msglen - 4;
2455 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002456
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002457 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2458
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002459 /*
2460 * Sanity checks
2461 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002462 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002463 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2464 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2466 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002467 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002468
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002469 /* Whenever we send anything different from a
2470 * HelloRequest we should be in a handshake - double check. */
2471 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2472 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002473 ssl->handshake == NULL )
2474 {
2475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2476 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2477 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002480 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002481 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002483 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002484 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2485 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002486 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002487#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002488
Hanno Beckerb50a2532018-08-06 11:52:54 +01002489 /* Double-check that we did not exceed the bounds
2490 * of the outgoing record buffer.
2491 * This should never fail as the various message
2492 * writing functions must obey the bounds of the
2493 * outgoing record buffer, but better be safe.
2494 *
2495 * Note: We deliberately do not check for the MTU or MFL here.
2496 */
2497 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2498 {
2499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002500 "size %" MBEDTLS_PRINTF_SIZET
2501 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002502 ssl->out_msglen,
2503 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002504 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2505 }
2506
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002507 /*
2508 * Fill handshake headers
2509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002511 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002512 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2513 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2514 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002515
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002516 /*
2517 * DTLS has additional fields in the Handshake layer,
2518 * between the length field and the actual payload:
2519 * uint16 message_seq;
2520 * uint24 fragment_offset;
2521 * uint24 fragment_length;
2522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002524 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002525 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002526 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002527 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002528 {
2529 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002530 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002531 hs_len,
2532 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002533 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2534 }
2535
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002536 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002537 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002538
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002539 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002540 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002541 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002542 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002543 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002544 }
2545 else
2546 {
2547 ssl->out_msg[4] = 0;
2548 ssl->out_msg[5] = 0;
2549 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002550
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002551 /* Handshake hashes are computed without fragmentation,
2552 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002553 memset( ssl->out_msg + 6, 0x00, 3 );
2554 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002555 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002557
Hanno Becker0207e532018-08-28 10:28:28 +01002558 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002559 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002560 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 }
2562
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002563 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002565 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002566 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2567 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002568 {
2569 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2570 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002572 return( ret );
2573 }
2574 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002575 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002576#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002577 {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002578 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002579 {
2580 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2581 return( ret );
2582 }
2583 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002584
2585 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2586
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002587 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002588}
2589
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002590int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
2591 size_t buf_len, size_t msg_len )
2592{
2593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2594 size_t msg_with_header_len;
2595 ((void) buf_len);
2596
2597 /* Add reserved 4 bytes for handshake header */
2598 msg_with_header_len = msg_len + 4;
2599 ssl->out_msglen = msg_with_header_len;
2600 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_write_handshake_msg_ext( ssl, 0, 0 ) );
2601
2602cleanup:
2603 return( ret );
2604}
2605
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002606/*
2607 * Record layer functions
2608 */
2609
2610/*
2611 * Write current record.
2612 *
2613 * Uses:
2614 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2615 * - ssl->out_msglen: length of the record content (excl headers)
2616 * - ssl->out_msg: record content
2617 */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002618int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002619{
2620 int ret, done = 0;
2621 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002622 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002623
2624 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002625
Paul Bakker05ef8352012-05-08 09:17:57 +00002626 if( !done )
2627 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002628 unsigned i;
2629 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002630#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2631 size_t out_buf_len = ssl->out_buf_len;
2632#else
2633 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2634#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002635 /* Skip writing the record content type to after the encryption,
2636 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002637 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002638#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002639 /* TLS 1.3 still uses the TLS 1.2 version identifier
2640 * for backwards compatibility. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002641 if( tls_ver == MBEDTLS_SSL_VERSION_TLS1_3 )
2642 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron6f135e12021-12-08 16:57:54 +01002643#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002644 mbedtls_ssl_write_version( ssl->out_hdr + 1, ssl->conf->transport,
2645 tls_ver );
Hanno Becker6430faf2019-05-08 11:57:13 +01002646
Jerry Yuae0b2e22021-10-08 15:21:19 +08002647 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002648 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002649
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002650 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002651 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002652 mbedtls_record rec;
2653
2654 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002655 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002656 rec.data_len = ssl->out_msglen;
2657 rec.data_offset = ssl->out_msg - rec.buf;
2658
Jerry Yud96a5c22021-09-29 17:46:51 +08002659 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002660 mbedtls_ssl_write_version( rec.ver, ssl->conf->transport, tls_ver );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002661 rec.type = ssl->out_msgtype;
2662
Hanno Beckera0e20d02019-05-15 14:03:01 +01002663#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002664 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002665 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002666#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002667
Hanno Beckera18d1322018-01-03 14:27:32 +00002668 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002669 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002670 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002672 return( ret );
2673 }
2674
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002675 if( rec.data_offset != 0 )
2676 {
2677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2678 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2679 }
2680
Hanno Becker6430faf2019-05-08 11:57:13 +01002681 /* Update the record content type and CID. */
2682 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002683#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002684 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002685#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002686 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002687 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002688 }
2689
Hanno Becker5903de42019-05-03 14:46:38 +01002690 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002691
2692#if defined(MBEDTLS_SSL_PROTO_DTLS)
2693 /* In case of DTLS, double-check that we don't exceed
2694 * the remaining space in the datagram. */
2695 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2696 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002697 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002698 if( ret < 0 )
2699 return( ret );
2700
2701 if( protected_record_size > (size_t) ret )
2702 {
2703 /* Should never happen */
2704 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2705 }
2706 }
2707#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002708
Hanno Becker6430faf2019-05-08 11:57:13 +01002709 /* Now write the potentially updated record content type. */
2710 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2711
Paul Elliott9f352112020-12-09 14:55:45 +00002712 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002713 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002714 ssl->out_hdr[0], ssl->out_hdr[1],
2715 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002718 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002719
2720 ssl->out_left += protected_record_size;
2721 ssl->out_hdr += protected_record_size;
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002722 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002723
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002724 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
2725 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2726 break;
2727
Gabor Mezei96ae9262022-06-28 11:45:18 +02002728 /* The loop goes to its end if the counter is wrapping */
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002729 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002730 {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002731 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2732 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Hanno Becker04484622018-08-06 09:49:38 +01002733 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002734 }
2735
Hanno Becker67bc7c32018-08-06 11:33:50 +01002736#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002737 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2738 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002739 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002740 size_t remaining;
2741 ret = ssl_get_remaining_payload_in_datagram( ssl );
2742 if( ret < 0 )
2743 {
2744 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2745 ret );
2746 return( ret );
2747 }
2748
2749 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002750 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002751 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002752 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002753 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002754 else
2755 {
Hanno Becker513815a2018-08-20 11:56:09 +01002756 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002757 }
2758 }
2759#endif /* MBEDTLS_SSL_PROTO_DTLS */
2760
2761 if( ( flush == SSL_FORCE_FLUSH ) &&
2762 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002765 return( ret );
2766 }
2767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002769
2770 return( 0 );
2771}
2772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002774
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002775MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere25e3b72018-08-16 09:30:53 +01002776static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2777{
2778 if( ssl->in_msglen < ssl->in_hslen ||
2779 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2780 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2781 {
2782 return( 1 );
2783 }
2784 return( 0 );
2785}
Hanno Becker44650b72018-08-16 12:51:11 +01002786
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002787static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002788{
2789 return( ( ssl->in_msg[9] << 16 ) |
2790 ( ssl->in_msg[10] << 8 ) |
2791 ssl->in_msg[11] );
2792}
2793
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002794static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002795{
2796 return( ( ssl->in_msg[6] << 16 ) |
2797 ( ssl->in_msg[7] << 8 ) |
2798 ssl->in_msg[8] );
2799}
2800
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002801MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002802static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002803{
2804 uint32_t msg_len, frag_off, frag_len;
2805
2806 msg_len = ssl_get_hs_total_len( ssl );
2807 frag_off = ssl_get_hs_frag_off( ssl );
2808 frag_len = ssl_get_hs_frag_len( ssl );
2809
2810 if( frag_off > msg_len )
2811 return( -1 );
2812
2813 if( frag_len > msg_len - frag_off )
2814 return( -1 );
2815
2816 if( frag_len + 12 > ssl->in_msglen )
2817 return( -1 );
2818
2819 return( 0 );
2820}
2821
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002822/*
2823 * Mark bits in bitmask (used for DTLS HS reassembly)
2824 */
2825static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2826{
2827 unsigned int start_bits, end_bits;
2828
2829 start_bits = 8 - ( offset % 8 );
2830 if( start_bits != 8 )
2831 {
2832 size_t first_byte_idx = offset / 8;
2833
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002834 /* Special case */
2835 if( len <= start_bits )
2836 {
2837 for( ; len != 0; len-- )
2838 mask[first_byte_idx] |= 1 << ( start_bits - len );
2839
2840 /* Avoid potential issues with offset or len becoming invalid */
2841 return;
2842 }
2843
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002844 offset += start_bits; /* Now offset % 8 == 0 */
2845 len -= start_bits;
2846
2847 for( ; start_bits != 0; start_bits-- )
2848 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2849 }
2850
2851 end_bits = len % 8;
2852 if( end_bits != 0 )
2853 {
2854 size_t last_byte_idx = ( offset + len ) / 8;
2855
2856 len -= end_bits; /* Now len % 8 == 0 */
2857
2858 for( ; end_bits != 0; end_bits-- )
2859 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2860 }
2861
2862 memset( mask + offset / 8, 0xFF, len / 8 );
2863}
2864
2865/*
2866 * Check that bitmask is full
2867 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002868MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002869static int ssl_bitmask_check( unsigned char *mask, size_t len )
2870{
2871 size_t i;
2872
2873 for( i = 0; i < len / 8; i++ )
2874 if( mask[i] != 0xFF )
2875 return( -1 );
2876
2877 for( i = 0; i < len % 8; i++ )
2878 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2879 return( -1 );
2880
2881 return( 0 );
2882}
2883
Hanno Becker56e205e2018-08-16 09:06:12 +01002884/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002885static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002886 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002887{
Hanno Becker56e205e2018-08-16 09:06:12 +01002888 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002889
Hanno Becker56e205e2018-08-16 09:06:12 +01002890 alloc_len = 12; /* Handshake header */
2891 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002892
Hanno Beckerd07df862018-08-16 09:14:58 +01002893 if( add_bitmap )
2894 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002895
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002896 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002897}
Hanno Becker56e205e2018-08-16 09:06:12 +01002898
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002900
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002901static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002902{
2903 return( ( ssl->in_msg[1] << 16 ) |
2904 ( ssl->in_msg[2] << 8 ) |
2905 ssl->in_msg[3] );
2906}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002907
Simon Butcher99000142016-10-13 17:21:01 +01002908int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002909{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002911 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002912 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002913 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002915 }
2916
Hanno Becker12555c62018-08-16 12:47:53 +01002917 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002920 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002921 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002924 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002925 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002926 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002927 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002928
Hanno Becker44650b72018-08-16 12:51:11 +01002929 if( ssl_check_hs_header( ssl ) != 0 )
2930 {
2931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2932 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2933 }
2934
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002935 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00002936 ( ( mbedtls_ssl_is_handshake_over( ssl ) == 0 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002937 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002938 ( mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002939 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002940 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002941 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2942 {
2943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2944 recv_msg_seq,
2945 ssl->handshake->in_msg_seq ) );
2946 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2947 }
2948
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002949 /* Retransmit only on last message from previous flight, to avoid
2950 * too many retransmissions.
2951 * Besides, No sane server ever retransmits HelloVerifyRequest */
2952 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002956 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002957 recv_msg_seq,
2958 ssl->handshake->in_flight_start_seq ) );
2959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002961 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002963 return( ret );
2964 }
2965 }
2966 else
2967 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002969 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002970 recv_msg_seq,
2971 ssl->handshake->in_msg_seq ) );
2972 }
2973
Hanno Becker90333da2017-10-10 11:27:13 +01002974 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002975 }
2976 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002977
Hanno Becker6d97ef52018-08-16 13:09:04 +01002978 /* Message reassembly is handled alongside buffering of future
2979 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002980 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002981 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002982 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002983 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002985 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002986 }
2987 }
2988 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002990 /* With TLS we don't handle fragmentation (for now) */
2991 if( ssl->in_msglen < ssl->in_hslen )
2992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2994 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002995 }
2996
Simon Butcher99000142016-10-13 17:21:01 +01002997 return( 0 );
2998}
2999
3000void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3001{
Hanno Becker0271f962018-08-16 13:23:47 +01003002 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003003
Paul Elliott27b0d942022-03-18 21:55:32 +00003004 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003005 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003006 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003007 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003008
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003009 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003011 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003012 ssl->handshake != NULL )
3013 {
Hanno Becker0271f962018-08-16 13:23:47 +01003014 unsigned offset;
3015 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003016
Hanno Becker0271f962018-08-16 13:23:47 +01003017 /* Increment handshake sequence number */
3018 hs->in_msg_seq++;
3019
3020 /*
3021 * Clear up handshake buffering and reassembly structure.
3022 */
3023
3024 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003025 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003026
3027 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003028 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3029 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003030 offset++, hs_buf++ )
3031 {
3032 *hs_buf = *(hs_buf + 1);
3033 }
3034
3035 /* Create a fresh last entry */
3036 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003037 }
3038#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003039}
3040
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003041/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003042 * DTLS anti-replay: RFC 6347 4.1.2.6
3043 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003044 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3045 * Bit n is set iff record number in_window_top - n has been seen.
3046 *
3047 * Usually, in_window_top is the last record number seen and the lsb of
3048 * in_window is set. The only exception is the initial state (record number 0
3049 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003052void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003053{
3054 ssl->in_window_top = 0;
3055 ssl->in_window = 0;
3056}
3057
3058static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3059{
3060 return( ( (uint64_t) buf[0] << 40 ) |
3061 ( (uint64_t) buf[1] << 32 ) |
3062 ( (uint64_t) buf[2] << 24 ) |
3063 ( (uint64_t) buf[3] << 16 ) |
3064 ( (uint64_t) buf[4] << 8 ) |
3065 ( (uint64_t) buf[5] ) );
3066}
3067
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003068MBEDTLS_CHECK_RETURN_CRITICAL
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003069static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3070{
Janos Follath865b3eb2019-12-16 11:46:15 +00003071 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003072 unsigned char *original_in_ctr;
3073
3074 // save original in_ctr
3075 original_in_ctr = ssl->in_ctr;
3076
3077 // use counter from record
3078 ssl->in_ctr = record_in_ctr;
3079
3080 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3081
3082 // restore the counter
3083 ssl->in_ctr = original_in_ctr;
3084
3085 return ret;
3086}
3087
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003088/*
3089 * Return 0 if sequence number is acceptable, -1 otherwise
3090 */
Hanno Becker0183d692019-07-12 08:50:37 +01003091int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003092{
3093 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3094 uint64_t bit;
3095
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003096 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003097 return( 0 );
3098
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003099 if( rec_seqnum > ssl->in_window_top )
3100 return( 0 );
3101
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003102 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003103
3104 if( bit >= 64 )
3105 return( -1 );
3106
3107 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3108 return( -1 );
3109
3110 return( 0 );
3111}
3112
3113/*
3114 * Update replay window on new validated record
3115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003117{
3118 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3119
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003120 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003121 return;
3122
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003123 if( rec_seqnum > ssl->in_window_top )
3124 {
3125 /* Update window_top and the contents of the window */
3126 uint64_t shift = rec_seqnum - ssl->in_window_top;
3127
3128 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003129 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003130 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003131 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003132 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003133 ssl->in_window |= 1;
3134 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003135
3136 ssl->in_window_top = rec_seqnum;
3137 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003138 else
3139 {
3140 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003141 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003142
3143 if( bit < 64 ) /* Always true, but be extra sure */
3144 ssl->in_window |= (uint64_t) 1 << bit;
3145 }
3146}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003148
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003149#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003150/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003151 * Check if a datagram looks like a ClientHello with a valid cookie,
3152 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003153 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003154 *
3155 * - if cookie is valid, return 0
3156 * - if ClientHello looks superficially valid but cookie is not,
3157 * fill obuf and set olen, then
3158 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3159 * - otherwise return a specific error code
3160 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003161MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003162MBEDTLS_STATIC_TESTABLE
3163int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003164 mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003165 const unsigned char *cli_id, size_t cli_id_len,
3166 const unsigned char *in, size_t in_len,
3167 unsigned char *obuf, size_t buf_len, size_t *olen )
3168{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003169 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003170 unsigned char *p;
3171
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003172 /*
3173 * Structure of ClientHello with record and handshake headers,
3174 * and expected values. We don't need to check a lot, more checks will be
3175 * done when actually parsing the ClientHello - skipping those checks
3176 * avoids code duplication and does not make cookie forging any easier.
3177 *
3178 * 0-0 ContentType type; copied, must be handshake
3179 * 1-2 ProtocolVersion version; copied
3180 * 3-4 uint16 epoch; copied, must be 0
3181 * 5-10 uint48 sequence_number; copied
3182 * 11-12 uint16 length; (ignored)
3183 *
3184 * 13-13 HandshakeType msg_type; (ignored)
3185 * 14-16 uint24 length; (ignored)
3186 * 17-18 uint16 message_seq; copied
3187 * 19-21 uint24 fragment_offset; copied, must be 0
3188 * 22-24 uint24 fragment_length; (ignored)
3189 *
3190 * 25-26 ProtocolVersion client_version; (ignored)
3191 * 27-58 Random random; (ignored)
3192 * 59-xx SessionID session_id; 1 byte len + sid_len content
3193 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3194 * ...
3195 *
3196 * Minimum length is 61 bytes.
3197 */
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003198 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: in_len=%u",
3199 (unsigned) in_len ) );
3200 MBEDTLS_SSL_DEBUG_BUF( 4, "cli_id", cli_id, cli_id_len );
3201 if( in_len < 61 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003202 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003203 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: record too short" ) );
3204 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
3205 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003206
3207 epoch = MBEDTLS_GET_UINT16_BE( in, 3 );
3208 fragment_offset = MBEDTLS_GET_UINT24_BE( in, 19 );
3209
3210 if( in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3211 fragment_offset != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003212 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003213 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: not a good ClientHello" ) );
3214 MBEDTLS_SSL_DEBUG_MSG( 4, ( " type=%u epoch=%u fragment_offset=%u",
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003215 in[0], (unsigned) epoch,
3216 (unsigned) fragment_offset ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003217 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003218 }
3219
3220 sid_len = in[59];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003221 if( 59 + 1 + sid_len + 1 > in_len )
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003222 {
3223 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: sid_len=%u > %u",
3224 (unsigned) sid_len,
3225 (unsigned) in_len - 61 ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003226 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003227 }
3228 MBEDTLS_SSL_DEBUG_BUF( 4, "sid received from network",
3229 in + 60, sid_len );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003230
3231 cookie_len = in[60 + sid_len];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003232 if( 59 + 1 + sid_len + 1 + cookie_len > in_len )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003233 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003234 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: cookie_len=%u > %u",
3235 (unsigned) cookie_len,
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003236 (unsigned) ( in_len - sid_len - 61 ) ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003237 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003238 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003239
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003240 MBEDTLS_SSL_DEBUG_BUF( 4, "cookie received from network",
3241 in + sid_len + 61, cookie_len );
3242 if( ssl->conf->f_cookie_check( ssl->conf->p_cookie,
3243 in + sid_len + 61, cookie_len,
3244 cli_id, cli_id_len ) == 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003245 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003246 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: valid" ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003247 return( 0 );
3248 }
3249
3250 /*
3251 * If we get here, we've got an invalid cookie, let's prepare HVR.
3252 *
3253 * 0-0 ContentType type; copied
3254 * 1-2 ProtocolVersion version; copied
3255 * 3-4 uint16 epoch; copied
3256 * 5-10 uint48 sequence_number; copied
3257 * 11-12 uint16 length; olen - 13
3258 *
3259 * 13-13 HandshakeType msg_type; hello_verify_request
3260 * 14-16 uint24 length; olen - 25
3261 * 17-18 uint16 message_seq; copied
3262 * 19-21 uint24 fragment_offset; copied
3263 * 22-24 uint24 fragment_length; olen - 25
3264 *
3265 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3266 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3267 *
3268 * Minimum length is 28.
3269 */
3270 if( buf_len < 28 )
3271 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3272
3273 /* Copy most fields and adapt others */
3274 memcpy( obuf, in, 25 );
3275 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3276 obuf[25] = 0xfe;
3277 obuf[26] = 0xff;
3278
3279 /* Generate and write actual cookie */
3280 p = obuf + 28;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003281 if( ssl->conf->f_cookie_write( ssl->conf->p_cookie,
3282 &p, obuf + buf_len,
3283 cli_id, cli_id_len ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003284 {
3285 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3286 }
3287
3288 *olen = p - obuf;
3289
3290 /* Go back and fill length fields */
3291 obuf[27] = (unsigned char)( *olen - 28 );
3292
Joe Subbianifbeb6922021-07-16 14:27:50 +01003293 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3294 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3295 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003296
Joe Subbiani6dd73642021-07-19 11:56:54 +01003297 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003298
3299 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3300}
3301
3302/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003303 * Handle possible client reconnect with the same UDP quadruplet
3304 * (RFC 6347 Section 4.2.8).
3305 *
3306 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3307 * that looks like a ClientHello.
3308 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003309 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003310 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003311 * - if the input looks like a ClientHello with a valid cookie,
3312 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003313 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003314 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003315 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003316 * This function is called (through ssl_check_client_reconnect()) when an
3317 * unexpected record is found in ssl_get_next_record(), which will discard the
3318 * record if we return 0, and bubble up the return value otherwise (this
3319 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3320 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003321 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003322MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003323static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3324{
Janos Follath865b3eb2019-12-16 11:46:15 +00003325 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003326 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003327
Hanno Becker2fddd372019-07-10 14:37:41 +01003328 if( ssl->conf->f_cookie_write == NULL ||
3329 ssl->conf->f_cookie_check == NULL )
3330 {
3331 /* If we can't use cookies to verify reachability of the peer,
3332 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003333 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3334 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003335 return( 0 );
3336 }
3337
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003338 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003339 ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003340 ssl->cli_id, ssl->cli_id_len,
3341 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003342 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003343
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003344 MBEDTLS_SSL_DEBUG_RET( 2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003345
3346 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003347 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003348 int send_ret;
3349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3350 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3351 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003352 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003353 * If the error is permanent we'll catch it later,
3354 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003355 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3356 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3357 (void) send_ret;
3358
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003359 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003360 }
3361
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003362 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003363 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003365 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003366 {
3367 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3368 return( ret );
3369 }
3370
3371 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003372 }
3373
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003374 return( ret );
3375}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003376#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003377
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003378MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003379static int ssl_check_record_type( uint8_t record_type )
3380{
3381 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3382 record_type != MBEDTLS_SSL_MSG_ALERT &&
3383 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3384 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3385 {
3386 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3387 }
3388
3389 return( 0 );
3390}
3391
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003392/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003393 * ContentType type;
3394 * ProtocolVersion version;
3395 * uint16 epoch; // DTLS only
3396 * uint48 sequence_number; // DTLS only
3397 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003398 *
3399 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003400 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003401 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3402 *
3403 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003404 * 1. proceed with the record if this function returns 0
3405 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3406 * 3. return CLIENT_RECONNECT if this function return that value
3407 * 4. drop the whole datagram if this function returns anything else.
3408 * Point 2 is needed when the peer is resending, and we have already received
3409 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003410 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003411MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker331de3d2019-07-12 11:10:16 +01003412static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003413 unsigned char *buf,
3414 size_t len,
3415 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003416{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003417 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003418
Hanno Beckere5e7e782019-07-11 12:29:35 +01003419 size_t const rec_hdr_type_offset = 0;
3420 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003421
Hanno Beckere5e7e782019-07-11 12:29:35 +01003422 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3423 rec_hdr_type_len;
3424 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003425
Hanno Beckere5e7e782019-07-11 12:29:35 +01003426 size_t const rec_hdr_ctr_len = 8;
3427#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003428 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003429 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3430 rec_hdr_version_len;
3431
Hanno Beckera0e20d02019-05-15 14:03:01 +01003432#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003433 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3434 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003435 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003436#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3437#endif /* MBEDTLS_SSL_PROTO_DTLS */
3438
3439 size_t rec_hdr_len_offset; /* To be determined */
3440 size_t const rec_hdr_len_len = 2;
3441
3442 /*
3443 * Check minimum lengths for record header.
3444 */
3445
3446#if defined(MBEDTLS_SSL_PROTO_DTLS)
3447 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3448 {
3449 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3450 }
3451 else
3452#endif /* MBEDTLS_SSL_PROTO_DTLS */
3453 {
3454 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3455 }
3456
3457 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3458 {
3459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3460 (unsigned) len,
3461 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3462 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3463 }
3464
3465 /*
3466 * Parse and validate record content type
3467 */
3468
3469 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003470
3471 /* Check record content type */
3472#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3473 rec->cid_len = 0;
3474
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003475 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003476 ssl->conf->cid_len != 0 &&
3477 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003478 {
3479 /* Shift pointers to account for record header including CID
3480 * struct {
3481 * ContentType special_type = tls12_cid;
3482 * ProtocolVersion version;
3483 * uint16 epoch;
3484 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003485 * opaque cid[cid_length]; // Additional field compared to
3486 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003487 * uint16 length;
3488 * opaque enc_content[DTLSCiphertext.length];
3489 * } DTLSCiphertext;
3490 */
3491
3492 /* So far, we only support static CID lengths
3493 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003494 rec_hdr_cid_len = ssl->conf->cid_len;
3495 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003496
Hanno Beckere5e7e782019-07-11 12:29:35 +01003497 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003498 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3500 (unsigned) len,
3501 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003502 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003503 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003504
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003505 /* configured CID len is guaranteed at most 255, see
3506 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3507 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003508 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003509 }
3510 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003511#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003512 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003513 if( ssl_check_record_type( rec->type ) )
3514 {
Hanno Becker54229812019-07-12 14:40:00 +01003515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3516 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003517 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3518 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003519 }
3520
Hanno Beckere5e7e782019-07-11 12:29:35 +01003521 /*
3522 * Parse and validate record version
3523 */
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003524 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3525 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003526 tls_version = mbedtls_ssl_read_version( buf + rec_hdr_version_offset,
3527 ssl->conf->transport );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003528
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003529 if( tls_version > ssl->conf->max_tls_version )
Paul Bakker5121ce52009-01-03 21:22:43 +00003530 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS version mismatch: got %u, expected max %u",
3532 (unsigned) tls_version,
3533 (unsigned) ssl->conf->max_tls_version) );
3534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003535 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003536 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003537 /*
3538 * Parse/Copy record sequence number.
3539 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003540
Hanno Beckere5e7e782019-07-11 12:29:35 +01003541#if defined(MBEDTLS_SSL_PROTO_DTLS)
3542 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003543 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003544 /* Copy explicit record sequence number from input buffer. */
3545 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3546 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003547 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003548 else
3549#endif /* MBEDTLS_SSL_PROTO_DTLS */
3550 {
3551 /* Copy implicit record sequence number from SSL context structure. */
3552 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3553 }
Paul Bakker40e46942009-01-03 21:51:57 +00003554
Hanno Beckere5e7e782019-07-11 12:29:35 +01003555 /*
3556 * Parse record length.
3557 */
3558
Hanno Beckere5e7e782019-07-11 12:29:35 +01003559 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003560 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3561 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003562 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003563
Paul Elliott9f352112020-12-09 14:55:45 +00003564 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003565 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3566 rec->type, (unsigned)tls_version, rec->data_len ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003567
3568 rec->buf = buf;
3569 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003570
Hanno Beckerd417cc92019-07-26 08:20:27 +01003571 if( rec->data_len == 0 )
3572 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003573
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003574 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003575 * DTLS-related tests.
3576 * Check epoch before checking length constraint because
3577 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3578 * message gets duplicated before the corresponding Finished message,
3579 * the second ChangeCipherSpec should be discarded because it belongs
3580 * to an old epoch, but not because its length is shorter than
3581 * the minimum record length for packets using the new record transform.
3582 * Note that these two kinds of failures are handled differently,
3583 * as an unexpected record is silently skipped but an invalid
3584 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003585 */
3586#if defined(MBEDTLS_SSL_PROTO_DTLS)
3587 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3588 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003589 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003590
Hanno Becker955a5c92019-07-10 17:12:07 +01003591 /* Check that the datagram is large enough to contain a record
3592 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003593 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003594 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003595 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3596 (unsigned) len,
3597 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003598 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3599 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003600
Hanno Becker37cfe732019-07-10 17:20:01 +01003601 /* Records from other, non-matching epochs are silently discarded.
3602 * (The case of same-port Client reconnects must be considered in
3603 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003604 if( rec_epoch != ssl->in_epoch )
3605 {
3606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003607 "expected %u, received %lu",
3608 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003609
Hanno Becker552f7472019-07-19 10:59:12 +01003610 /* Records from the next epoch are considered for buffering
3611 * (concretely: early Finished messages). */
3612 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003613 {
Hanno Becker552f7472019-07-19 10:59:12 +01003614 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3615 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003616 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003617
Hanno Becker2fddd372019-07-10 14:37:41 +01003618 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003619 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003620#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003621 /* For records from the correct epoch, check whether their
3622 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003623 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3624 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003625 {
3626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3627 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3628 }
3629#endif
3630 }
3631#endif /* MBEDTLS_SSL_PROTO_DTLS */
3632
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003633 return( 0 );
3634}
Paul Bakker5121ce52009-01-03 21:22:43 +00003635
Paul Bakker5121ce52009-01-03 21:22:43 +00003636
Hanno Becker2fddd372019-07-10 14:37:41 +01003637#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003638MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2fddd372019-07-10 14:37:41 +01003639static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3640{
3641 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3642
3643 /*
3644 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3645 * access the first byte of record content (handshake type), as we
3646 * have an active transform (possibly iv_len != 0), so use the
3647 * fact that the record header len is 13 instead.
3648 */
3649 if( rec_epoch == 0 &&
3650 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Paul Elliott27b0d942022-03-18 21:55:32 +00003651 mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003652 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3653 ssl->in_left > 13 &&
3654 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3655 {
3656 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3657 "from the same port" ) );
3658 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003659 }
3660
3661 return( 0 );
3662}
Hanno Becker2fddd372019-07-10 14:37:41 +01003663#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003664
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003665/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003666 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003667 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003668MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfdf66042019-07-11 13:07:45 +01003669static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3670 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003671{
3672 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003675 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003676
Ronald Cron7e38cba2021-11-24 12:43:39 +01003677 /*
3678 * In TLS 1.3, always treat ChangeCipherSpec records
3679 * as unencrypted. The only thing we do with them is
3680 * check the length and content and ignore them.
3681 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003682#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003683 if( ssl->transform_in != NULL &&
Glenn Strauss07c64162022-03-14 12:34:51 -04003684 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01003685 {
3686 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3687 done = 1;
3688 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003689#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003690
Paul Bakker48916f92012-09-16 19:57:18 +00003691 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003692 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003693 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003694
Hanno Beckera18d1322018-01-03 14:27:32 +00003695 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003696 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003697 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003698 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003699
Hanno Beckera0e20d02019-05-15 14:03:01 +01003700#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003701 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3702 ssl->conf->ignore_unexpected_cid
3703 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3704 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003705 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003706 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003707 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003708#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003709
Paul Bakker5121ce52009-01-03 21:22:43 +00003710 return( ret );
3711 }
3712
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003713 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003714 {
3715 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003716 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003717 }
3718
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003719 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003720 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003721
Hanno Beckera0e20d02019-05-15 14:03:01 +01003722#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003723 /* We have already checked the record content type
3724 * in ssl_parse_record_header(), failing or silently
3725 * dropping the record in the case of an unknown type.
3726 *
3727 * Since with the use of CIDs, the record content type
3728 * might change during decryption, re-check the record
3729 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003730 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003731 {
3732 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3733 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3734 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003735#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003736
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003737 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003738 {
3739#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003740 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003741 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003742 {
3743 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3744 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3745 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3746 }
3747#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3748
3749 ssl->nb_zero++;
3750
3751 /*
3752 * Three or more empty messages may be a DoS attack
3753 * (excessive CPU consumption).
3754 */
3755 if( ssl->nb_zero > 3 )
3756 {
3757 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003758 "messages, possible DoS attack" ) );
3759 /* Treat the records as if they were not properly authenticated,
3760 * thereby failing the connection if we see more than allowed
3761 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003762 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3763 }
3764 }
3765 else
3766 ssl->nb_zero = 0;
3767
3768#if defined(MBEDTLS_SSL_PROTO_DTLS)
3769 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3770 {
3771 ; /* in_ctr read from peer, not maintained internally */
3772 }
3773 else
3774#endif
3775 {
3776 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003777 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3778 i > mbedtls_ssl_ep_len( ssl ); i-- )
3779 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003780 if( ++ssl->in_ctr[i - 1] != 0 )
3781 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003782 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003783
3784 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003785 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003786 {
3787 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3788 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3789 }
3790 }
3791
Paul Bakker5121ce52009-01-03 21:22:43 +00003792 }
3793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003794#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003795 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003797 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003798 }
3799#endif
3800
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003801 /* Check actual (decrypted) record content length against
3802 * configured maximum. */
Paul Elliott668b31f2022-06-10 14:11:31 +01003803 if( rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003804 {
3805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3806 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3807 }
3808
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003809 return( 0 );
3810}
3811
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003812/*
3813 * Read a record.
3814 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003815 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3816 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3817 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003818 */
Hanno Becker1097b342018-08-15 14:09:41 +01003819
3820/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003821MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01003822static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003823MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01003824static int ssl_get_next_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003825MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01003826static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003827
Hanno Becker327c93b2018-08-15 13:56:18 +01003828int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003829 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003830{
Janos Follath865b3eb2019-12-16 11:46:15 +00003831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003832
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003834
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003835 if( ssl->keep_current_message == 0 )
3836 {
3837 do {
Simon Butcher99000142016-10-13 17:21:01 +01003838
Hanno Becker26994592018-08-15 14:14:59 +01003839 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003840 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003841 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003842
Hanno Beckere74d5562018-08-15 14:26:08 +01003843 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003844 {
David Horstmann10be1342022-10-06 18:31:25 +01003845 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01003846#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01003847
Hanno Becker40f50842018-08-15 14:48:01 +01003848 /* We only check for buffered messages if the
3849 * current datagram is fully consumed. */
3850 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003851 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003852 {
Hanno Becker40f50842018-08-15 14:48:01 +01003853 if( ssl_load_buffered_message( ssl ) == 0 )
David Horstmann10be1342022-10-06 18:31:25 +01003854 dtls_have_buffered = 1;
Hanno Becker40f50842018-08-15 14:48:01 +01003855 }
3856
Hanno Becker40f50842018-08-15 14:48:01 +01003857#endif /* MBEDTLS_SSL_PROTO_DTLS */
David Horstmann10be1342022-10-06 18:31:25 +01003858 if( dtls_have_buffered == 0 )
Hanno Becker40f50842018-08-15 14:48:01 +01003859 {
3860 ret = ssl_get_next_record( ssl );
3861 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3862 continue;
3863
3864 if( ret != 0 )
3865 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003866 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003867 return( ret );
3868 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003869 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003870 }
3871
3872 ret = mbedtls_ssl_handle_message_type( ssl );
3873
Hanno Becker40f50842018-08-15 14:48:01 +01003874#if defined(MBEDTLS_SSL_PROTO_DTLS)
3875 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3876 {
3877 /* Buffer future message */
3878 ret = ssl_buffer_message( ssl );
3879 if( ret != 0 )
3880 return( ret );
3881
3882 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3883 }
3884#endif /* MBEDTLS_SSL_PROTO_DTLS */
3885
Hanno Becker90333da2017-10-10 11:27:13 +01003886 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3887 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003888
3889 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003890 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003891 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003892 return( ret );
3893 }
3894
Hanno Becker327c93b2018-08-15 13:56:18 +01003895 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003896 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003897 {
3898 mbedtls_ssl_update_handshake_status( ssl );
3899 }
Simon Butcher99000142016-10-13 17:21:01 +01003900 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003901 else
Simon Butcher99000142016-10-13 17:21:01 +01003902 {
Hanno Becker02f59072018-08-15 14:00:24 +01003903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003904 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003905 }
3906
3907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3908
3909 return( 0 );
3910}
3911
Hanno Becker40f50842018-08-15 14:48:01 +01003912#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003913MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003914static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003915{
Hanno Becker40f50842018-08-15 14:48:01 +01003916 if( ssl->in_left > ssl->next_record_offset )
3917 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003918
Hanno Becker40f50842018-08-15 14:48:01 +01003919 return( 0 );
3920}
3921
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003922MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01003923static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3924{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003925 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003926 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003927 int ret = 0;
3928
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003929 if( hs == NULL )
3930 return( -1 );
3931
Hanno Beckere00ae372018-08-20 09:39:42 +01003932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3933
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003934 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3935 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3936 {
3937 /* Check if we have seen a ChangeCipherSpec before.
3938 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003939 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003940 {
3941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3942 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003943 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003944 }
3945
Hanno Becker39b8bc92018-08-28 17:17:13 +01003946 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003947 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3948 ssl->in_msglen = 1;
3949 ssl->in_msg[0] = 1;
3950
3951 /* As long as they are equal, the exact value doesn't matter. */
3952 ssl->in_left = 0;
3953 ssl->next_record_offset = 0;
3954
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003955 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003956 goto exit;
3957 }
Hanno Becker37f95322018-08-16 13:55:32 +01003958
Hanno Beckerb8f50142018-08-28 10:01:34 +01003959#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003960 /* Debug only */
3961 {
3962 unsigned offset;
3963 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3964 {
3965 hs_buf = &hs->buffering.hs[offset];
3966 if( hs_buf->is_valid == 1 )
3967 {
3968 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3969 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003970 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003971 }
3972 }
3973 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003974#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003975
3976 /* Check if we have buffered and/or fully reassembled the
3977 * next handshake message. */
3978 hs_buf = &hs->buffering.hs[0];
3979 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3980 {
3981 /* Synthesize a record containing the buffered HS message. */
3982 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3983 ( hs_buf->data[2] << 8 ) |
3984 hs_buf->data[3];
3985
3986 /* Double-check that we haven't accidentally buffered
3987 * a message that doesn't fit into the input buffer. */
3988 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3989 {
3990 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3991 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3992 }
3993
3994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3995 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3996 hs_buf->data, msg_len + 12 );
3997
3998 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3999 ssl->in_hslen = msg_len + 12;
4000 ssl->in_msglen = msg_len + 12;
4001 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4002
4003 ret = 0;
4004 goto exit;
4005 }
4006 else
4007 {
4008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4009 hs->in_msg_seq ) );
4010 }
4011
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004012 ret = -1;
4013
4014exit:
4015
4016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4017 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004018}
4019
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004020MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckera02b0b42018-08-21 17:20:27 +01004021static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4022 size_t desired )
4023{
4024 int offset;
4025 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004026 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4027 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004028
Hanno Becker01315ea2018-08-21 17:22:17 +01004029 /* Get rid of future records epoch first, if such exist. */
4030 ssl_free_buffered_record( ssl );
4031
4032 /* Check if we have enough space available now. */
4033 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4034 hs->buffering.total_bytes_buffered ) )
4035 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004036 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004037 return( 0 );
4038 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004039
Hanno Becker4f432ad2018-08-28 10:02:32 +01004040 /* We don't have enough space to buffer the next expected handshake
4041 * message. Remove buffers used for future messages to gain space,
4042 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004043 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4044 offset >= 0; offset-- )
4045 {
4046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4047 offset ) );
4048
Hanno Beckerb309b922018-08-23 13:18:05 +01004049 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004050
4051 /* Check if we have enough space available now. */
4052 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4053 hs->buffering.total_bytes_buffered ) )
4054 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004056 return( 0 );
4057 }
4058 }
4059
4060 return( -1 );
4061}
4062
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004063MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01004064static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4065{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004066 int ret = 0;
4067 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4068
4069 if( hs == NULL )
4070 return( 0 );
4071
4072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4073
4074 switch( ssl->in_msgtype )
4075 {
4076 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4077 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004078
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004079 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004080 break;
4081
4082 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004083 {
4084 unsigned recv_msg_seq_offset;
4085 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4086 mbedtls_ssl_hs_buffer *hs_buf;
4087 size_t msg_len = ssl->in_hslen - 12;
4088
4089 /* We should never receive an old handshake
4090 * message - double-check nonetheless. */
4091 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4092 {
4093 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4094 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4095 }
4096
4097 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4098 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4099 {
4100 /* Silently ignore -- message too far in the future */
4101 MBEDTLS_SSL_DEBUG_MSG( 2,
4102 ( "Ignore future HS message with sequence number %u, "
4103 "buffering window %u - %u",
4104 recv_msg_seq, ssl->handshake->in_msg_seq,
4105 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4106
4107 goto exit;
4108 }
4109
4110 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4111 recv_msg_seq, recv_msg_seq_offset ) );
4112
4113 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4114
4115 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004116 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004117 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004118 size_t reassembly_buf_sz;
4119
Hanno Becker37f95322018-08-16 13:55:32 +01004120 hs_buf->is_fragmented =
4121 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4122
4123 /* We copy the message back into the input buffer
4124 * after reassembly, so check that it's not too large.
4125 * This is an implementation-specific limitation
4126 * and not one from the standard, hence it is not
4127 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004128 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004129 {
4130 /* Ignore message */
4131 goto exit;
4132 }
4133
Hanno Beckere0b150f2018-08-21 15:51:03 +01004134 /* Check if we have enough space to buffer the message. */
4135 if( hs->buffering.total_bytes_buffered >
4136 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4137 {
4138 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4139 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4140 }
4141
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004142 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4143 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004144
4145 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4146 hs->buffering.total_bytes_buffered ) )
4147 {
4148 if( recv_msg_seq_offset > 0 )
4149 {
4150 /* If we can't buffer a future message because
4151 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004152 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4153 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4154 " (already %" MBEDTLS_PRINTF_SIZET
4155 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004156 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004157 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004158 goto exit;
4159 }
Hanno Beckere1801392018-08-21 16:51:05 +01004160 else
4161 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4163 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4164 " (already %" MBEDTLS_PRINTF_SIZET
4165 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004166 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004167 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004168 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004169
Hanno Beckera02b0b42018-08-21 17:20:27 +01004170 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004171 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004172 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4173 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4174 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4175 " (already %" MBEDTLS_PRINTF_SIZET
4176 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004177 msg_len,
4178 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004179 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004180 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004181 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4182 goto exit;
4183 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004184 }
4185
Paul Elliottd48d5c62021-01-07 14:47:05 +00004186 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004187 msg_len ) );
4188
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004189 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4190 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004191 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004192 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004193 goto exit;
4194 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004195 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004196
4197 /* Prepare final header: copy msg_type, length and message_seq,
4198 * then add standardised fragment_offset and fragment_length */
4199 memcpy( hs_buf->data, ssl->in_msg, 6 );
4200 memset( hs_buf->data + 6, 0, 3 );
4201 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4202
4203 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004204
4205 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004206 }
4207 else
4208 {
4209 /* Make sure msg_type and length are consistent */
4210 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4211 {
4212 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4213 /* Ignore */
4214 goto exit;
4215 }
4216 }
4217
Hanno Becker4422bbb2018-08-20 09:40:19 +01004218 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004219 {
4220 size_t frag_len, frag_off;
4221 unsigned char * const msg = hs_buf->data + 12;
4222
4223 /*
4224 * Check and copy current fragment
4225 */
4226
4227 /* Validation of header fields already done in
4228 * mbedtls_ssl_prepare_handshake_record(). */
4229 frag_off = ssl_get_hs_frag_off( ssl );
4230 frag_len = ssl_get_hs_frag_len( ssl );
4231
Paul Elliottd48d5c62021-01-07 14:47:05 +00004232 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4233 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004234 frag_off, frag_len ) );
4235 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4236
4237 if( hs_buf->is_fragmented )
4238 {
4239 unsigned char * const bitmask = msg + msg_len;
4240 ssl_bitmask_set( bitmask, frag_off, frag_len );
4241 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4242 msg_len ) == 0 );
4243 }
4244 else
4245 {
4246 hs_buf->is_complete = 1;
4247 }
4248
4249 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4250 hs_buf->is_complete ? "" : "not yet " ) );
4251 }
4252
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004253 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004254 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004255
4256 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004257 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004258 break;
4259 }
4260
4261exit:
4262
4263 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4264 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004265}
4266#endif /* MBEDTLS_SSL_PROTO_DTLS */
4267
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004268MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01004269static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004270{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004271 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004272 * Consume last content-layer message and potentially
4273 * update in_msglen which keeps track of the contents'
4274 * consumption state.
4275 *
4276 * (1) Handshake messages:
4277 * Remove last handshake message, move content
4278 * and adapt in_msglen.
4279 *
4280 * (2) Alert messages:
4281 * Consume whole record content, in_msglen = 0.
4282 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004283 * (3) Change cipher spec:
4284 * Consume whole record content, in_msglen = 0.
4285 *
4286 * (4) Application data:
4287 * Don't do anything - the record layer provides
4288 * the application data as a stream transport
4289 * and consumes through mbedtls_ssl_read only.
4290 *
4291 */
4292
4293 /* Case (1): Handshake messages */
4294 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004295 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004296 /* Hard assertion to be sure that no application data
4297 * is in flight, as corrupting ssl->in_msglen during
4298 * ssl->in_offt != NULL is fatal. */
4299 if( ssl->in_offt != NULL )
4300 {
4301 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4302 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4303 }
4304
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004305 /*
4306 * Get next Handshake message in the current record
4307 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004308
Hanno Becker4a810fb2017-05-24 16:27:30 +01004309 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004310 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004311 * current handshake content: If DTLS handshake
4312 * fragmentation is used, that's the fragment
4313 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004314 * size here is faulty and should be changed at
4315 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004316 * (2) While it doesn't seem to cause problems, one
4317 * has to be very careful not to assume that in_hslen
4318 * is always <= in_msglen in a sensible communication.
4319 * Again, it's wrong for DTLS handshake fragmentation.
4320 * The following check is therefore mandatory, and
4321 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004322 * Additionally, ssl->in_hslen might be arbitrarily out of
4323 * bounds after handling a DTLS message with an unexpected
4324 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004325 */
4326 if( ssl->in_hslen < ssl->in_msglen )
4327 {
4328 ssl->in_msglen -= ssl->in_hslen;
4329 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4330 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004331
Hanno Becker4a810fb2017-05-24 16:27:30 +01004332 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4333 ssl->in_msg, ssl->in_msglen );
4334 }
4335 else
4336 {
4337 ssl->in_msglen = 0;
4338 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004339
Hanno Becker4a810fb2017-05-24 16:27:30 +01004340 ssl->in_hslen = 0;
4341 }
4342 /* Case (4): Application data */
4343 else if( ssl->in_offt != NULL )
4344 {
4345 return( 0 );
4346 }
4347 /* Everything else (CCS & Alerts) */
4348 else
4349 {
4350 ssl->in_msglen = 0;
4351 }
4352
Hanno Becker1097b342018-08-15 14:09:41 +01004353 return( 0 );
4354}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004355
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004356MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004357static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4358{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004359 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004360 return( 1 );
4361
4362 return( 0 );
4363}
4364
Hanno Becker5f066e72018-08-16 14:56:31 +01004365#if defined(MBEDTLS_SSL_PROTO_DTLS)
4366
4367static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4368{
4369 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4370 if( hs == NULL )
4371 return;
4372
Hanno Becker01315ea2018-08-21 17:22:17 +01004373 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004374 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004375 hs->buffering.total_bytes_buffered -=
4376 hs->buffering.future_record.len;
4377
4378 mbedtls_free( hs->buffering.future_record.data );
4379 hs->buffering.future_record.data = NULL;
4380 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004381}
4382
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004383MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker5f066e72018-08-16 14:56:31 +01004384static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4385{
4386 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4387 unsigned char * rec;
4388 size_t rec_len;
4389 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004390#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4391 size_t in_buf_len = ssl->in_buf_len;
4392#else
4393 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4394#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004395 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4396 return( 0 );
4397
4398 if( hs == NULL )
4399 return( 0 );
4400
Hanno Becker5f066e72018-08-16 14:56:31 +01004401 rec = hs->buffering.future_record.data;
4402 rec_len = hs->buffering.future_record.len;
4403 rec_epoch = hs->buffering.future_record.epoch;
4404
4405 if( rec == NULL )
4406 return( 0 );
4407
Hanno Becker4cb782d2018-08-20 11:19:05 +01004408 /* Only consider loading future records if the
4409 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004410 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004411 return( 0 );
4412
Hanno Becker5f066e72018-08-16 14:56:31 +01004413 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4414
4415 if( rec_epoch != ssl->in_epoch )
4416 {
4417 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4418 goto exit;
4419 }
4420
4421 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4422
4423 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004424 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004425 {
4426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4427 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4428 }
4429
4430 memcpy( ssl->in_hdr, rec, rec_len );
4431 ssl->in_left = rec_len;
4432 ssl->next_record_offset = 0;
4433
4434 ssl_free_buffered_record( ssl );
4435
4436exit:
4437 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4438 return( 0 );
4439}
4440
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004441MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker519f15d2019-07-11 12:43:20 +01004442static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4443 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004444{
4445 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004446
4447 /* Don't buffer future records outside handshakes. */
4448 if( hs == NULL )
4449 return( 0 );
4450
4451 /* Only buffer handshake records (we are only interested
4452 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004453 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004454 return( 0 );
4455
4456 /* Don't buffer more than one future epoch record. */
4457 if( hs->buffering.future_record.data != NULL )
4458 return( 0 );
4459
Hanno Becker01315ea2018-08-21 17:22:17 +01004460 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004461 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004462 hs->buffering.total_bytes_buffered ) )
4463 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004464 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4465 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4466 " (already %" MBEDTLS_PRINTF_SIZET
4467 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004468 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004469 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004470 return( 0 );
4471 }
4472
Hanno Becker5f066e72018-08-16 14:56:31 +01004473 /* Buffer record */
4474 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004475 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004476 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004477
4478 /* ssl_parse_record_header() only considers records
4479 * of the next epoch as candidates for buffering. */
4480 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004481 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004482
4483 hs->buffering.future_record.data =
4484 mbedtls_calloc( 1, hs->buffering.future_record.len );
4485 if( hs->buffering.future_record.data == NULL )
4486 {
4487 /* If we run out of RAM trying to buffer a
4488 * record from the next epoch, just ignore. */
4489 return( 0 );
4490 }
4491
Hanno Becker519f15d2019-07-11 12:43:20 +01004492 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004493
Hanno Becker519f15d2019-07-11 12:43:20 +01004494 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004495 return( 0 );
4496}
4497
4498#endif /* MBEDTLS_SSL_PROTO_DTLS */
4499
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004500MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004501static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004502{
Janos Follath865b3eb2019-12-16 11:46:15 +00004503 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004504 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004505
Hanno Becker5f066e72018-08-16 14:56:31 +01004506#if defined(MBEDTLS_SSL_PROTO_DTLS)
4507 /* We might have buffered a future record; if so,
4508 * and if the epoch matches now, load it.
4509 * On success, this call will set ssl->in_left to
4510 * the length of the buffered record, so that
4511 * the calls to ssl_fetch_input() below will
4512 * essentially be no-ops. */
4513 ret = ssl_load_buffered_record( ssl );
4514 if( ret != 0 )
4515 return( ret );
4516#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004517
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004518 /* Ensure that we have enough space available for the default form
4519 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4520 * with no space for CIDs counted in). */
4521 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4522 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004523 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004524 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004525 return( ret );
4526 }
4527
Hanno Beckere5e7e782019-07-11 12:29:35 +01004528 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4529 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004531#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004532 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004533 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004534 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4535 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004536 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004537 if( ret != 0 )
4538 return( ret );
4539
4540 /* Fall through to handling of unexpected records */
4541 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4542 }
4543
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004544 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4545 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004546#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004547 /* Reset in pointers to default state for TLS/DTLS records,
4548 * assuming no CID and no offset between record content and
4549 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004550 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004551
Hanno Becker7ae20e02019-07-12 08:33:49 +01004552 /* Setup internal message pointers from record structure. */
4553 ssl->in_msgtype = rec.type;
4554#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4555 ssl->in_len = ssl->in_cid + rec.cid_len;
4556#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4557 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4558 ssl->in_msglen = rec.data_len;
4559
Hanno Becker2fddd372019-07-10 14:37:41 +01004560 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004561 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004562 if( ret != 0 )
4563 return( ret );
4564#endif
4565
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004566 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004567 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004568
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4570 "(header)" ) );
4571 }
4572 else
4573 {
4574 /* Skip invalid record and the rest of the datagram */
4575 ssl->next_record_offset = 0;
4576 ssl->in_left = 0;
4577
4578 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4579 "(header)" ) );
4580 }
4581
4582 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004583 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004584 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004585 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004586#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004587 {
4588 return( ret );
4589 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004590 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004592#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004593 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004594 {
Hanno Beckera8814792019-07-10 15:01:45 +01004595 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004596 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004597 if( ssl->next_record_offset < ssl->in_left )
4598 {
4599 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4600 }
4601 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004602 else
4603#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004604 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004605 /*
4606 * Fetch record contents from underlying transport.
4607 */
Hanno Beckera3175662019-07-11 12:50:29 +01004608 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004609 if( ret != 0 )
4610 {
4611 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4612 return( ret );
4613 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004614
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004615 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004616 }
4617
4618 /*
4619 * Decrypt record contents.
4620 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004621
Hanno Beckerfdf66042019-07-11 13:07:45 +01004622 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004623 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004624#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004625 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004626 {
4627 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004628 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004629 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004630 /* Except when waiting for Finished as a bad mac here
4631 * probably means something went wrong in the handshake
4632 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4633 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4634 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4635 {
4636#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4637 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4638 {
4639 mbedtls_ssl_send_alert_message( ssl,
4640 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4641 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4642 }
4643#endif
4644 return( ret );
4645 }
4646
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004647 if( ssl->conf->badmac_limit != 0 &&
4648 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004649 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4651 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004652 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004653
Hanno Becker4a810fb2017-05-24 16:27:30 +01004654 /* As above, invalid records cause
4655 * dismissal of the whole datagram. */
4656
4657 ssl->next_record_offset = 0;
4658 ssl->in_left = 0;
4659
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004660 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004661 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004662 }
4663
4664 return( ret );
4665 }
4666 else
4667#endif
4668 {
4669 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4671 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004672 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004673 mbedtls_ssl_send_alert_message( ssl,
4674 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4675 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004676 }
4677#endif
4678 return( ret );
4679 }
4680 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004681
Hanno Becker44d89b22019-07-12 09:40:44 +01004682
4683 /* Reset in pointers to default state for TLS/DTLS records,
4684 * assuming no CID and no offset between record content and
4685 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004686 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004687#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4688 ssl->in_len = ssl->in_cid + rec.cid_len;
4689#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004690 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004691
Hanno Becker8685c822019-07-12 09:37:30 +01004692 /* The record content type may change during decryption,
4693 * so re-read it. */
4694 ssl->in_msgtype = rec.type;
4695 /* Also update the input buffer, because unfortunately
4696 * the server-side ssl_parse_client_hello() reparses the
4697 * record header when receiving a ClientHello initiating
4698 * a renegotiation. */
4699 ssl->in_hdr[0] = rec.type;
4700 ssl->in_msg = rec.buf + rec.data_offset;
4701 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004702 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004703
Simon Butcher99000142016-10-13 17:21:01 +01004704 return( 0 );
4705}
4706
4707int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4708{
Janos Follath865b3eb2019-12-16 11:46:15 +00004709 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004710
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004711 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004712 * Handle particular types of records
4713 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004715 {
Simon Butcher99000142016-10-13 17:21:01 +01004716 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4717 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004718 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004719 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004720 }
4721
Hanno Beckere678eaa2018-08-21 14:57:46 +01004722 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004723 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004724 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004725 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004726 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004727 ssl->in_msglen ) );
4728 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004729 }
4730
Hanno Beckere678eaa2018-08-21 14:57:46 +01004731 if( ssl->in_msg[0] != 1 )
4732 {
4733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4734 ssl->in_msg[0] ) );
4735 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4736 }
4737
4738#if defined(MBEDTLS_SSL_PROTO_DTLS)
4739 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4740 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4741 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4742 {
4743 if( ssl->handshake == NULL )
4744 {
4745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4746 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4747 }
4748
4749 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4750 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4751 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004752#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004753
Ronald Cron6f135e12021-12-08 16:57:54 +01004754#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004755 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01004756 {
4757#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4758 MBEDTLS_SSL_DEBUG_MSG( 1,
4759 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4760 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4761#else
4762 MBEDTLS_SSL_DEBUG_MSG( 1,
4763 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4764 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4765#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4766 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004767#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004768 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004770 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004771 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004772 if( ssl->in_msglen != 2 )
4773 {
4774 /* Note: Standard allows for more than one 2 byte alert
4775 to be packed in a single message, but Mbed TLS doesn't
4776 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004777 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004778 ssl->in_msglen ) );
4779 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4780 }
4781
Paul Elliott9f352112020-12-09 14:55:45 +00004782 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004783 ssl->in_msg[0], ssl->in_msg[1] ) );
4784
4785 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004786 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004787 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004788 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004789 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004791 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004793 }
4794
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004795 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4796 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004797 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4799 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004800 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004801
4802#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4803 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4804 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4805 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004807 /* Will be handled when trying to parse ServerHello */
4808 return( 0 );
4809 }
4810#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004811 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004812 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004813 }
4814
Hanno Beckerc76c6192017-06-06 10:03:17 +01004815#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004816 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004817 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004818 /* Drop unexpected ApplicationData records,
4819 * except at the beginning of renegotiations */
4820 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004821 mbedtls_ssl_is_handshake_over( ssl ) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004822#if defined(MBEDTLS_SSL_RENEGOTIATION)
4823 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4824 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004825#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004826 )
4827 {
4828 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4829 return( MBEDTLS_ERR_SSL_NON_FATAL );
4830 }
4831
4832 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004833 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker37ae9522019-05-03 16:54:26 +01004834 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004835 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004836 }
4837 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004838#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004839
Paul Bakker5121ce52009-01-03 21:22:43 +00004840 return( 0 );
4841}
4842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004843int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004844{
irwir6c0da642019-09-26 21:07:41 +03004845 return( mbedtls_ssl_send_alert_message( ssl,
4846 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4847 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004848}
4849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004850int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004851 unsigned char level,
4852 unsigned char message )
4853{
Janos Follath865b3eb2019-12-16 11:46:15 +00004854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004855
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004856 if( ssl == NULL || ssl->conf == NULL )
4857 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4858
Hanno Becker5e18f742018-08-06 11:35:16 +01004859 if( ssl->out_left != 0 )
4860 return( mbedtls_ssl_flush_output( ssl ) );
4861
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004863 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004864
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004865 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004866 ssl->out_msglen = 2;
4867 ssl->out_msg[0] = level;
4868 ssl->out_msg[1] = message;
4869
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02004870 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004872 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004873 return( ret );
4874 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004875 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004876
4877 return( 0 );
4878}
4879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004880int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004881{
Janos Follath865b3eb2019-12-16 11:46:15 +00004882 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004886 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004887 ssl->out_msglen = 1;
4888 ssl->out_msg[0] = 1;
4889
Paul Bakker5121ce52009-01-03 21:22:43 +00004890 ssl->state++;
4891
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004892 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004893 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004894 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004895 return( ret );
4896 }
4897
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004898 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004899
4900 return( 0 );
4901}
4902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004903int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004904{
Janos Follath865b3eb2019-12-16 11:46:15 +00004905 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004908
Hanno Becker327c93b2018-08-15 13:56:18 +01004909 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004910 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004912 return( ret );
4913 }
4914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004915 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004916 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004918 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4919 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004920 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004921 }
4922
Hanno Beckere678eaa2018-08-21 14:57:46 +01004923 /* CCS records are only accepted if they have length 1 and content '1',
4924 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004925
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004926 /*
4927 * Switch to our negotiated transform and session parameters for inbound
4928 * data.
4929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004930 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004931 ssl->transform_in = ssl->transform_negotiate;
4932 ssl->session_in = ssl->session_negotiate;
4933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004934#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004935 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004936 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004938 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004939#endif
4940
4941 /* Increment epoch */
4942 if( ++ssl->in_epoch == 0 )
4943 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004945 /* This is highly unlikely to happen for legitimate reasons, so
4946 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004947 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004948 }
4949 }
4950 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004951#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004952 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004953
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004954 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004955
Paul Bakker5121ce52009-01-03 21:22:43 +00004956 ssl->state++;
4957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004959
4960 return( 0 );
4961}
4962
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004963/* Once ssl->out_hdr as the address of the beginning of the
4964 * next outgoing record is set, deduce the other pointers.
4965 *
4966 * Note: For TLS, we save the implicit record sequence number
4967 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4968 * and the caller has to make sure there's space for this.
4969 */
4970
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004971static size_t ssl_transform_get_explicit_iv_len(
4972 mbedtls_ssl_transform const *transform )
4973{
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004974 return( transform->ivlen - transform->fixed_ivlen );
4975}
4976
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004977void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4978 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004979{
4980#if defined(MBEDTLS_SSL_PROTO_DTLS)
4981 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4982 {
4983 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004984#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004985 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004986 ssl->out_len = ssl->out_cid;
4987 if( transform != NULL )
4988 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004989#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004990 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004991#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004992 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004993 }
4994 else
4995#endif
4996 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004997 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004998#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004999 ssl->out_cid = ssl->out_len;
5000#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005001 ssl->out_iv = ssl->out_hdr + 5;
5002 }
5003
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005004 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005005 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005006 if( transform != NULL )
5007 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005008}
5009
5010/* Once ssl->in_hdr as the address of the beginning of the
5011 * next incoming record is set, deduce the other pointers.
5012 *
5013 * Note: For TLS, we save the implicit record sequence number
5014 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5015 * and the caller has to make sure there's space for this.
5016 */
5017
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005018void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005019{
Hanno Becker79594fd2019-05-08 09:38:41 +01005020 /* This function sets the pointers to match the case
5021 * of unprotected TLS/DTLS records, with both ssl->in_iv
5022 * and ssl->in_msg pointing to the beginning of the record
5023 * content.
5024 *
5025 * When decrypting a protected record, ssl->in_msg
5026 * will be shifted to point to the beginning of the
5027 * record plaintext.
5028 */
5029
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005030#if defined(MBEDTLS_SSL_PROTO_DTLS)
5031 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5032 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005033 /* This sets the header pointers to match records
5034 * without CID. When we receive a record containing
5035 * a CID, the fields are shifted accordingly in
5036 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005037 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005038#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005039 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005040 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005041#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005042 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005043#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005044 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005045 }
5046 else
5047#endif
5048 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005049 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005050 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005051#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005052 ssl->in_cid = ssl->in_len;
5053#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005054 ssl->in_iv = ssl->in_hdr + 5;
5055 }
5056
Hanno Becker79594fd2019-05-08 09:38:41 +01005057 /* This will be adjusted at record decryption time. */
5058 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005059}
5060
Paul Bakker5121ce52009-01-03 21:22:43 +00005061/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005062 * Setup an SSL context
5063 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005064
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005065void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005066{
5067 /* Set the incoming and outgoing record pointers. */
5068#if defined(MBEDTLS_SSL_PROTO_DTLS)
5069 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5070 {
5071 ssl->out_hdr = ssl->out_buf;
5072 ssl->in_hdr = ssl->in_buf;
5073 }
5074 else
5075#endif /* MBEDTLS_SSL_PROTO_DTLS */
5076 {
Hanno Becker12078f42021-03-02 15:28:41 +00005077 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005078 ssl->out_hdr = ssl->out_buf + 8;
5079 ssl->in_hdr = ssl->in_buf + 8;
5080 }
5081
5082 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005083 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5084 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005085}
5086
Paul Bakker5121ce52009-01-03 21:22:43 +00005087/*
5088 * SSL get accessors
5089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005090size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005091{
5092 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5093}
5094
Hanno Becker8b170a02017-10-10 11:51:19 +01005095int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5096{
5097 /*
5098 * Case A: We're currently holding back
5099 * a message for further processing.
5100 */
5101
5102 if( ssl->keep_current_message == 1 )
5103 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005104 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005105 return( 1 );
5106 }
5107
5108 /*
5109 * Case B: Further records are pending in the current datagram.
5110 */
5111
5112#if defined(MBEDTLS_SSL_PROTO_DTLS)
5113 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5114 ssl->in_left > ssl->next_record_offset )
5115 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005116 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005117 return( 1 );
5118 }
5119#endif /* MBEDTLS_SSL_PROTO_DTLS */
5120
5121 /*
5122 * Case C: A handshake message is being processed.
5123 */
5124
Hanno Becker8b170a02017-10-10 11:51:19 +01005125 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5126 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005127 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005128 return( 1 );
5129 }
5130
5131 /*
5132 * Case D: An application data message is being processed
5133 */
5134 if( ssl->in_offt != NULL )
5135 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005136 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005137 return( 1 );
5138 }
5139
5140 /*
5141 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005142 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005143 * we implement support for multiple alerts in single records.
5144 */
5145
5146 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5147 return( 0 );
5148}
5149
Paul Bakker43ca69c2011-01-15 17:35:19 +00005150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005151int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005152{
Hanno Becker3136ede2018-08-17 15:28:19 +01005153 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005155 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005156#if defined(MBEDTLS_USE_PSA_CRYPTO)
5157 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5158 psa_key_type_t key_type;
5159#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005160
Hanno Becker5903de42019-05-03 14:46:38 +01005161 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5162
Hanno Becker78640902018-08-13 16:35:15 +01005163 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005164 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005165
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005166
5167#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005168 if ( transform->psa_alg == PSA_ALG_GCM ||
5169 transform->psa_alg == PSA_ALG_CCM ||
5170 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5171 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005172 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005173 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005174 transform_expansion = transform->minlen;
5175 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005176 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005177 {
5178 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5179 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005180
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005181 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005182
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005183 /* Expansion due to the addition of the MAC. */
5184 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005185
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005186 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005187 * Theoretically up to 256 bytes, but we never use
5188 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005189 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005190
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005191 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005192 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005193#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005194 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005195#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005196 }
5197 else
5198 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005200 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005201 }
5202#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005203 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005204 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005205 case MBEDTLS_MODE_GCM:
5206 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005207 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005208 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005209 transform_expansion = transform->minlen;
5210 break;
5211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005212 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005213
5214 block_size = mbedtls_cipher_get_block_size(
5215 &transform->cipher_ctx_enc );
5216
Hanno Becker3136ede2018-08-17 15:28:19 +01005217 /* Expansion due to the addition of the MAC. */
5218 transform_expansion += transform->maclen;
5219
5220 /* Expansion due to the addition of CBC padding;
5221 * Theoretically up to 256 bytes, but we never use
5222 * more than the block size of the underlying cipher. */
5223 transform_expansion += block_size;
5224
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005225 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005226 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005227#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005228 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005229#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005230
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005231 break;
5232
5233 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005234 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005235 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005236 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005237#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005238
Hanno Beckera0e20d02019-05-15 14:03:01 +01005239#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005240 if( transform->out_cid_len != 0 )
5241 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005242#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005243
Hanno Becker5903de42019-05-03 14:46:38 +01005244 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005245}
5246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005247#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005248/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005249 * Check record counters and renegotiate if they're above the limit.
5250 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005251MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005252static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005253{
Hanno Beckerdd772292020-02-05 10:38:31 +00005254 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005255 int in_ctr_cmp;
5256 int out_ctr_cmp;
5257
Paul Elliott27b0d942022-03-18 21:55:32 +00005258 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005259 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005260 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005261 {
5262 return( 0 );
5263 }
5264
Andres AG2196c7f2016-12-15 17:01:16 +00005265 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005266 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005267 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005268 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5269 &ssl->conf->renego_period[ep_len],
5270 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005271
5272 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005273 {
5274 return( 0 );
5275 }
5276
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005278 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005279}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005280#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005281
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005282#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5283
5284#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005285MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005286static int ssl_tls13_check_new_session_ticket( mbedtls_ssl_context *ssl )
5287{
5288
5289 if( ( ssl->in_hslen == mbedtls_ssl_hs_hdr_len( ssl ) ) ||
5290 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET ) )
5291 {
5292 return( 0 );
5293 }
5294
5295 ssl->keep_current_message = 1;
5296
5297 MBEDTLS_SSL_DEBUG_MSG( 3, ( "NewSessionTicket received" ) );
5298 mbedtls_ssl_handshake_set_state( ssl,
Jerry Yua357cf42022-07-12 05:36:45 +00005299 MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005300
5301 return( MBEDTLS_ERR_SSL_WANT_READ );
5302}
5303#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5304
Jerry Yua0446a02022-07-13 11:22:55 +08005305MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005306static int ssl_tls13_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
5307{
5308
5309 MBEDTLS_SSL_DEBUG_MSG( 3, ( "received post-handshake message" ) );
5310
5311#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
5312 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5313 {
5314 int ret = ssl_tls13_check_new_session_ticket( ssl );
5315 if( ret != 0 )
5316 return( ret );
5317 }
5318#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5319
5320 /* Fail in all other cases. */
5321 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5322}
5323#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5324
5325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005326/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005327 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005328 * may only be sent for the purpose of initiating renegotiations.
5329 *
5330 * This function is introduced as a separate helper since the handling
5331 * of post-handshake handshake messages changes significantly in TLS 1.3,
5332 * and having a helper function allows to distinguish between TLS <= 1.2 and
5333 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5334 */
Jerry Yua0446a02022-07-13 11:22:55 +08005335MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005336static int ssl_tls12_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005337{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005338 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005339
5340 /*
5341 * - For client-side, expect SERVER_HELLO_REQUEST.
5342 * - For server-side, expect CLIENT_HELLO.
5343 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5344 */
5345
5346#if defined(MBEDTLS_SSL_CLI_C)
5347 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5348 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5349 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5350 {
5351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5352
5353 /* With DTLS, drop the packet (probably from last handshake) */
5354#if defined(MBEDTLS_SSL_PROTO_DTLS)
5355 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5356 {
5357 return( 0 );
5358 }
5359#endif
5360 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5361 }
5362#endif /* MBEDTLS_SSL_CLI_C */
5363
5364#if defined(MBEDTLS_SSL_SRV_C)
5365 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5366 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5367 {
5368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5369
5370 /* With DTLS, drop the packet (probably from last handshake) */
5371#if defined(MBEDTLS_SSL_PROTO_DTLS)
5372 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5373 {
5374 return( 0 );
5375 }
5376#endif
5377 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5378 }
5379#endif /* MBEDTLS_SSL_SRV_C */
5380
5381#if defined(MBEDTLS_SSL_RENEGOTIATION)
5382 /* Determine whether renegotiation attempt should be accepted */
5383 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5384 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5385 ssl->conf->allow_legacy_renegotiation ==
5386 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5387 {
5388 /*
5389 * Accept renegotiation request
5390 */
5391
5392 /* DTLS clients need to know renego is server-initiated */
5393#if defined(MBEDTLS_SSL_PROTO_DTLS)
5394 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5395 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5396 {
5397 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5398 }
5399#endif
5400 ret = mbedtls_ssl_start_renegotiation( ssl );
5401 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5402 ret != 0 )
5403 {
5404 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5405 ret );
5406 return( ret );
5407 }
5408 }
5409 else
5410#endif /* MBEDTLS_SSL_RENEGOTIATION */
5411 {
5412 /*
5413 * Refuse renegotiation
5414 */
5415
5416 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5417
TRodziewicz345165c2021-07-06 13:42:11 +02005418 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5419 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5420 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005421 {
TRodziewicz345165c2021-07-06 13:42:11 +02005422 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005423 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005424 }
5425
5426 return( 0 );
5427}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005428#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5429
5430MBEDTLS_CHECK_RETURN_CRITICAL
5431static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
5432{
5433 /* Check protocol version and dispatch accordingly. */
5434#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5435 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
5436 {
5437 return( ssl_tls13_handle_hs_message_post_handshake( ssl ) );
5438 }
5439#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5440
5441#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5442 if( ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 )
5443 {
5444 return( ssl_tls12_handle_hs_message_post_handshake( ssl ) );
5445 }
5446#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5447
5448 /* Should never happen */
5449 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5450}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005451
Paul Bakker48916f92012-09-16 19:57:18 +00005452/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005453 * Receive application data decrypted from the SSL layer
5454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005456{
Janos Follath865b3eb2019-12-16 11:46:15 +00005457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005458 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005459
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005460 if( ssl == NULL || ssl->conf == NULL )
5461 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005464
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005466 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005467 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005468 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005469 return( ret );
5470
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005471 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005473 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005474 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005475 return( ret );
5476 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005477 }
5478#endif
5479
Hanno Becker4a810fb2017-05-24 16:27:30 +01005480 /*
5481 * Check if renegotiation is necessary and/or handshake is
5482 * in process. If yes, perform/continue, and fall through
5483 * if an unexpected packet is received while the client
5484 * is waiting for the ServerHello.
5485 *
5486 * (There is no equivalent to the last condition on
5487 * the server-side as it is not treated as within
5488 * a handshake while waiting for the ClientHello
5489 * after a renegotiation request.)
5490 */
5491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005492#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005493 ret = ssl_check_ctr_renegotiate( ssl );
5494 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5495 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005496 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005498 return( ret );
5499 }
5500#endif
5501
Paul Elliott27b0d942022-03-18 21:55:32 +00005502 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005504 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005505 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5506 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005507 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005508 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005509 return( ret );
5510 }
5511 }
5512
Hanno Beckere41158b2017-10-23 13:30:32 +01005513 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005514 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005515 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005516 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005517 if( ssl->f_get_timer != NULL &&
5518 ssl->f_get_timer( ssl->p_timer ) == -1 )
5519 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005520 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005521 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005522
Hanno Becker327c93b2018-08-15 13:56:18 +01005523 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005524 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005525 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5526 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005527
Hanno Becker4a810fb2017-05-24 16:27:30 +01005528 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5529 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005530 }
5531
5532 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005533 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005534 {
5535 /*
5536 * OpenSSL sends empty messages to randomize the IV
5537 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005538 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005539 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005541 return( 0 );
5542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005543 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005544 return( ret );
5545 }
5546 }
5547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005548 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005549 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005550 ret = ssl_handle_hs_message_post_handshake( ssl );
5551 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005552 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005553 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5554 ret );
5555 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005556 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005557
Hanno Beckerf26cc722021-04-21 07:30:13 +01005558 /* At this point, we don't know whether the renegotiation triggered
5559 * by the post-handshake message has been completed or not. The cases
5560 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005561 * 1) The renegotiation is complete. In this case, no new record
5562 * has been read yet.
5563 * 2) The renegotiation is incomplete because the client received
5564 * an application data record while awaiting the ServerHello.
5565 * 3) The renegotiation is incomplete because the client received
5566 * a non-handshake, non-application data message while awaiting
5567 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005568 *
5569 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005570 * - For 1), the next iteration will read a new record and check
5571 * if it's application data.
5572 * - For 2), the loop condition isn't satisfied as application data
5573 * is present, hence continue is the same as break
5574 * - For 3), the loop condition is satisfied and read_record
5575 * will re-deliver the message that was held back by the client
5576 * when expecting the ServerHello.
5577 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005578
Hanno Becker90333da2017-10-10 11:27:13 +01005579 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005580 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005581#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005583 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005584 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005585 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005586 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005587 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005589 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005590 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005591 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005592 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005593 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005594#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005596 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5597 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005598 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005599 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005600 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005601 }
5602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005603 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005604 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5606 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005607 }
5608
5609 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005610
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005611 /* We're going to return something now, cancel timer,
5612 * except if handshake (renegotiation) is in progress */
Paul Elliott27b0d942022-03-18 21:55:32 +00005613 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker0f57a652020-02-05 10:37:26 +00005614 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005615
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005616#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005617 /* If we requested renego but received AppData, resend HelloRequest.
5618 * Do it now, after setting in_offt, to avoid taking this branch
5619 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005621 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005622 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005623 {
Hanno Becker786300f2020-02-05 10:46:40 +00005624 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005625 {
Hanno Becker786300f2020-02-05 10:46:40 +00005626 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5627 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005628 return( ret );
5629 }
5630 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005631#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005632#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005633 }
5634
5635 n = ( len < ssl->in_msglen )
5636 ? len : ssl->in_msglen;
5637
5638 memcpy( buf, ssl->in_offt, n );
5639 ssl->in_msglen -= n;
5640
gabor-mezei-arma3214132020-07-15 10:55:00 +02005641 /* Zeroising the plaintext buffer to erase unused application data
5642 from the memory. */
5643 mbedtls_platform_zeroize( ssl->in_offt, n );
5644
Paul Bakker5121ce52009-01-03 21:22:43 +00005645 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005646 {
5647 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005648 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005649 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005650 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005651 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005652 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005653 /* more data available */
5654 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005655 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005657 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005658
Paul Bakker23986e52011-04-24 08:57:21 +00005659 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005660}
5661
5662/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005663 * Send application data to be encrypted by the SSL layer, taking care of max
5664 * fragment length and buffer size.
5665 *
5666 * According to RFC 5246 Section 6.2.1:
5667 *
5668 * Zero-length fragments of Application data MAY be sent as they are
5669 * potentially useful as a traffic analysis countermeasure.
5670 *
5671 * Therefore, it is possible that the input message length is 0 and the
5672 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005673 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005674MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005675static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005676 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005677{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005678 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5679 const size_t max_len = (size_t) ret;
5680
5681 if( ret < 0 )
5682 {
5683 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5684 return( ret );
5685 }
5686
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005687 if( len > max_len )
5688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005690 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005693 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5694 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005695 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005696 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005697 }
5698 else
5699#endif
5700 len = max_len;
5701 }
Paul Bakker887bd502011-06-08 13:10:54 +00005702
Paul Bakker5121ce52009-01-03 21:22:43 +00005703 if( ssl->out_left != 0 )
5704 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005705 /*
5706 * The user has previously tried to send the data and
5707 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5708 * written. In this case, we expect the high-level write function
5709 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005711 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005712 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005713 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005714 return( ret );
5715 }
5716 }
Paul Bakker887bd502011-06-08 13:10:54 +00005717 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005718 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005719 /*
5720 * The user is trying to send a message the first time, so we need to
5721 * copy the data into the internal buffers and setup the data structure
5722 * to keep track of partial writes
5723 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005724 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005725 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005726 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005727
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02005728 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005729 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005730 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005731 return( ret );
5732 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005733 }
5734
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005735 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005736}
5737
5738/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005739 * Write application data (public-facing wrapper)
5740 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005741int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005742{
Janos Follath865b3eb2019-12-16 11:46:15 +00005743 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005744
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005745 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005746
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005747 if( ssl == NULL || ssl->conf == NULL )
5748 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5749
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005750#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005751 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5752 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005753 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005754 return( ret );
5755 }
5756#endif
5757
Paul Elliott27b0d942022-03-18 21:55:32 +00005758 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005759 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005760 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005761 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005762 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005763 return( ret );
5764 }
5765 }
5766
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005767 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005768
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005769 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005770
5771 return( ret );
5772}
5773
5774/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005775 * Notify the peer that the connection is being closed
5776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005777int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005778{
Janos Follath865b3eb2019-12-16 11:46:15 +00005779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005780
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005781 if( ssl == NULL || ssl->conf == NULL )
5782 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5783
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005784 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005785
Paul Elliott27b0d942022-03-18 21:55:32 +00005786 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005787 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5789 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5790 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005791 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005792 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005793 return( ret );
5794 }
5795 }
5796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005798
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005799 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005800}
5801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005802void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005803{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005804 if( transform == NULL )
5805 return;
5806
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005807#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005808 psa_destroy_key( transform->psa_key_enc );
5809 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005810#else
5811 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5812 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5813#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005814
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005815#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005816#if defined(MBEDTLS_USE_PSA_CRYPTO)
5817 psa_destroy_key( transform->psa_mac_enc );
5818 psa_destroy_key( transform->psa_mac_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005819#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005820 mbedtls_md_free( &transform->md_ctx_enc );
5821 mbedtls_md_free( &transform->md_ctx_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005822#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005823#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005824
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005825 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005826}
5827
Jerry Yuc7875b52021-09-05 21:05:50 +08005828void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5829 mbedtls_ssl_transform *transform )
5830{
Jerry Yuc7875b52021-09-05 21:05:50 +08005831 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005832 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005833}
5834
5835void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5836 mbedtls_ssl_transform *transform )
5837{
5838 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005839 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005840}
5841
Hanno Becker0271f962018-08-16 13:23:47 +01005842#if defined(MBEDTLS_SSL_PROTO_DTLS)
5843
Hanno Becker533ab5f2020-02-05 10:49:13 +00005844void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005845{
5846 unsigned offset;
5847 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5848
5849 if( hs == NULL )
5850 return;
5851
Hanno Becker283f5ef2018-08-24 09:34:47 +01005852 ssl_free_buffered_record( ssl );
5853
Hanno Becker0271f962018-08-16 13:23:47 +01005854 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005855 ssl_buffering_free_slot( ssl, offset );
5856}
5857
5858static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5859 uint8_t slot )
5860{
5861 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5862 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005863
5864 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5865 return;
5866
Hanno Beckere605b192018-08-21 15:59:07 +01005867 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005868 {
Hanno Beckere605b192018-08-21 15:59:07 +01005869 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005870 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005871 mbedtls_free( hs_buf->data );
5872 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005873 }
5874}
5875
5876#endif /* MBEDTLS_SSL_PROTO_DTLS */
5877
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005878/*
5879 * Convert version numbers to/from wire format
5880 * and, for DTLS, to/from TLS equivalent.
5881 *
5882 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005883 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005884 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005885 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005886 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005887void mbedtls_ssl_write_version( unsigned char version[2], int transport,
5888 mbedtls_ssl_protocol_version tls_version )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005889{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005890#if defined(MBEDTLS_SSL_PROTO_DTLS)
5891 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005892 tls_version =
5893 ~( tls_version - ( tls_version == 0x0302 ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005894#else
5895 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005896#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005897 MBEDTLS_PUT_UINT16_BE( tls_version, version, 0 );
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005898}
5899
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005900uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
5901 int transport )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005902{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005903 uint16_t tls_version = MBEDTLS_GET_UINT16_BE( version, 0 );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005904#if defined(MBEDTLS_SSL_PROTO_DTLS)
5905 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005906 tls_version =
5907 ~( tls_version - ( tls_version == 0xfeff ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005908#else
5909 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005910#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005911 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005912}
5913
Jerry Yue7047812021-09-13 19:26:39 +08005914/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005915 * Send pending fatal alert.
5916 * 0, No alert message.
5917 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5918 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005919 */
5920int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5921{
5922 int ret;
5923
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005924 /* No pending alert, return success*/
5925 if( ssl->send_alert == 0 )
5926 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005927
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005928 ret = mbedtls_ssl_send_alert_message( ssl,
5929 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5930 ssl->alert_type );
5931
Jerry Yu3bf1f972021-09-22 21:37:18 +08005932 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5933 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005934 */
5935 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5936 {
5937 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005938 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005939
5940 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005941 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005942
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005943 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005944}
5945
Jerry Yu394ece62021-09-14 22:17:21 +08005946/*
5947 * Set pending fatal alert flag.
5948 */
5949void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5950 unsigned char alert_type,
5951 int alert_reason )
5952{
5953 ssl->send_alert = 1;
5954 ssl->alert_type = alert_type;
5955 ssl->alert_reason = alert_reason;
5956}
5957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005958#endif /* MBEDTLS_SSL_TLS_C */