blob: c4756d929e532db08b389ea48d8ac1683d4cdcd6 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Gabor Mezei96ec8312022-06-22 13:17:28 +0200154#define SSL_DONT_ENCRYPT_RECORD 0
155#define SSL_ENCRYPT_RECORD 1
156
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200157#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100158
Hanno Beckerd5847772018-08-28 10:09:23 +0100159/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100160static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
161 uint8_t slot );
162static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
163static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
164static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
165static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100166static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
167 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100168static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100169
Hanno Becker11682cc2018-08-22 14:41:02 +0100170static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100171{
Hanno Becker89490712020-02-05 10:50:12 +0000172 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000173#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
174 size_t out_buf_len = ssl->out_buf_len;
175#else
176 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
177#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100180 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100181
Darryl Greenb33cc762019-11-28 14:29:44 +0000182 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100183}
184
Hanno Becker67bc7c32018-08-06 11:33:50 +0100185static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
186{
Hanno Becker11682cc2018-08-22 14:41:02 +0100187 size_t const bytes_written = ssl->out_left;
188 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100189
190 /* Double-check that the write-index hasn't gone
191 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100192 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100193 {
194 /* Should never happen... */
195 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
196 }
197
198 return( (int) ( mtu - bytes_written ) );
199}
200
201static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
202{
Janos Follath865b3eb2019-12-16 11:46:15 +0000203 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100204 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400205 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400208 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100209
210 if( max_len > mfl )
211 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100212
213 /* By the standard (RFC 6066 Sect. 4), the MFL extension
214 * only limits the maximum record payload size, so in theory
215 * we would be allowed to pack multiple records of payload size
216 * MFL into a single datagram. However, this would mean that there's
217 * no way to explicitly communicate MTU restrictions to the peer.
218 *
219 * The following reduction of max_len makes sure that we never
220 * write datagrams larger than MFL + Record Expansion Overhead.
221 */
222 if( max_len <= ssl->out_left )
223 return( 0 );
224
225 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100226#endif
227
228 ret = ssl_get_remaining_space_in_datagram( ssl );
229 if( ret < 0 )
230 return( ret );
231 remaining = (size_t) ret;
232
233 ret = mbedtls_ssl_get_record_expansion( ssl );
234 if( ret < 0 )
235 return( ret );
236 expansion = (size_t) ret;
237
238 if( remaining <= expansion )
239 return( 0 );
240
241 remaining -= expansion;
242 if( remaining >= max_len )
243 remaining = max_len;
244
245 return( (int) remaining );
246}
247
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200248/*
249 * Double the retransmit timeout value, within the allowed range,
250 * returning -1 if the maximum value has already been reached.
251 */
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 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100335static int ssl_build_inner_plaintext( unsigned char *content,
336 size_t *content_size,
337 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100338 uint8_t rec_type,
339 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100340{
341 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100342
343 /* Write real content type */
344 if( remaining == 0 )
345 return( -1 );
346 content[ len ] = rec_type;
347 len++;
348 remaining--;
349
350 if( remaining < pad )
351 return( -1 );
352 memset( content + len, 0, pad );
353 len += pad;
354 remaining -= pad;
355
356 *content_size = len;
357 return( 0 );
358}
359
Hanno Becker581bc1b2020-05-04 12:20:03 +0100360/* This function parses a (D)TLSInnerPlaintext structure.
361 * See ssl_build_inner_plaintext() for details. */
362static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100363 size_t *content_size,
364 uint8_t *rec_type )
365{
366 size_t remaining = *content_size;
367
368 /* Determine length of padding by skipping zeroes from the back. */
369 do
370 {
371 if( remaining == 0 )
372 return( -1 );
373 remaining--;
374 } while( content[ remaining ] == 0 );
375
376 *content_size = remaining;
377 *rec_type = content[ remaining ];
378
379 return( 0 );
380}
Ronald Cron6f135e12021-12-08 16:57:54 +0100381#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100382
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100383/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100384 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000385static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100386 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100387 mbedtls_record *rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400388 mbedtls_ssl_protocol_version
389 tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000390 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000391{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100392 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100393 *
394 * additional_data = seq_num + TLSCompressed.type +
395 * TLSCompressed.version + TLSCompressed.length;
396 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100397 * For the CID extension, this is extended as follows
398 * (quoting draft-ietf-tls-dtls-connection-id-05,
399 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100400 *
401 * additional_data = seq_num + DTLSPlaintext.type +
402 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100403 * cid +
404 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100405 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100406 *
407 * For TLS 1.3, the record sequence number is dropped from the AAD
408 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000409 * Moreover, the additional data involves the length of the TLS
410 * ciphertext, not the TLS plaintext as in earlier versions.
411 * Quoting RFC 8446 (TLS 1.3):
412 *
413 * additional_data = TLSCiphertext.opaque_type ||
414 * TLSCiphertext.legacy_record_version ||
415 * TLSCiphertext.length
416 *
417 * We pass the tag length to this function in order to compute the
418 * ciphertext length from the inner plaintext length rec->data_len via
419 *
420 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
421 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100422 */
423
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100424 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000425 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100426
Ronald Cron6f135e12021-12-08 16:57:54 +0100427#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400428 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000429 {
430 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
431 * which differs from the length of the TLSInnerPlaintext
432 * by the length of the authentication tag. */
433 ad_len_field += taglen;
434 }
435 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100436#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100437 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400438 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000439 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100440 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
441 cur += sizeof( rec->ctr );
442 }
443
444 *cur = rec->type;
445 cur++;
446
447 memcpy( cur, rec->ver, sizeof( rec->ver ) );
448 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100449
Hanno Beckera0e20d02019-05-15 14:03:01 +0100450#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100451 if( rec->cid_len != 0 )
452 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100453 memcpy( cur, rec->cid, rec->cid_len );
454 cur += rec->cid_len;
455
456 *cur = rec->cid_len;
457 cur++;
458
Joe Subbiani6dd73642021-07-19 11:56:54 +0100459 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100460 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100461 }
462 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100463#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100464 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100465 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100467 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100468
469 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000470}
471
Hanno Becker67a37db2020-05-28 16:27:07 +0100472#if defined(MBEDTLS_GCM_C) || \
473 defined(MBEDTLS_CCM_C) || \
474 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100475static int ssl_transform_aead_dynamic_iv_is_explicit(
476 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100477{
Hanno Becker17263802020-05-28 07:05:48 +0100478 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100479}
480
Hanno Becker17263802020-05-28 07:05:48 +0100481/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
482 *
483 * Concretely, this occurs in two variants:
484 *
485 * a) Fixed and dynamic IV lengths add up to total IV length, giving
486 * IV = fixed_iv || dynamic_iv
487 *
Hanno Becker15952812020-06-04 13:31:46 +0100488 * This variant is used in TLS 1.2 when used with GCM or CCM.
489 *
Hanno Becker17263802020-05-28 07:05:48 +0100490 * b) Fixed IV lengths matches total IV length, giving
491 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100492 *
493 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
494 *
495 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100496 *
497 * This function has the precondition that
498 *
499 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
500 *
501 * which has to be ensured by the caller. If this precondition
502 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100503 */
504static void ssl_build_record_nonce( unsigned char *dst_iv,
505 size_t dst_iv_len,
506 unsigned char const *fixed_iv,
507 size_t fixed_iv_len,
508 unsigned char const *dynamic_iv,
509 size_t dynamic_iv_len )
510{
511 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100512
513 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100514 memset( dst_iv, 0, dst_iv_len );
515 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100516
Hanno Becker17263802020-05-28 07:05:48 +0100517 dst_iv += dst_iv_len - dynamic_iv_len;
518 for( i = 0; i < dynamic_iv_len; i++ )
519 dst_iv[i] ^= dynamic_iv[i];
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{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001118 size_t olen;
Neil Armstrong136f8402022-03-30 10:58:01 +02001119 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001120 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001121
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001122 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001123#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001124 size_t padlen = 0, correct = 1;
1125#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001126 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001127 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001128 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001129
Hanno Beckera18d1322018-01-03 14:27:32 +00001130#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001131 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001132 ((void) ssl);
1133#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001136 if( rec == NULL ||
1137 rec->buf == NULL ||
1138 rec->buf_len < rec->data_offset ||
1139 rec->buf_len - rec->data_offset < rec->data_len )
1140 {
1141 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001143 }
1144
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001145 data = rec->buf + rec->data_offset;
Neil Armstrongab555e02022-04-04 11:07:59 +02001146 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Paul Bakker5121ce52009-01-03 21:22:43 +00001147
Hanno Beckera0e20d02019-05-15 14:03:01 +01001148#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001149 /*
1150 * Match record's CID with incoming CID.
1151 */
Hanno Becker938489a2019-05-08 13:02:22 +01001152 if( rec->cid_len != transform->in_cid_len ||
1153 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1154 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001155 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001156 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001157#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001158
Hanno Beckerd086bf02021-03-22 13:01:27 +00001159#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +02001160 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001161 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001162 /* The only supported stream cipher is "NULL",
1163 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001164 }
Paul Bakker68884e32013-01-07 18:20:04 +01001165 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001166#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001167#if defined(MBEDTLS_GCM_C) || \
1168 defined(MBEDTLS_CCM_C) || \
1169 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +02001170 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001171 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001172 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001173 unsigned char *dynamic_iv;
1174 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001175#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001176 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001177#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001178
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001179 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001180 * Extract dynamic part of nonce for AEAD decryption.
1181 *
1182 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1183 * part of the IV is prepended to the ciphertext and
1184 * can be chosen freely - in particular, it need not
1185 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001186 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001187 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001188 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001189 {
1190 if( rec->data_len < dynamic_iv_len )
1191 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001192 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1193 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001194 rec->data_len,
1195 dynamic_iv_len ) );
1196 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1197 }
1198 dynamic_iv = data;
1199
1200 data += dynamic_iv_len;
1201 rec->data_offset += dynamic_iv_len;
1202 rec->data_len -= dynamic_iv_len;
1203 }
Hanno Becker17263802020-05-28 07:05:48 +01001204 else
1205 {
1206 dynamic_iv = rec->ctr;
1207 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001208
1209 /* Check that there's space for the authentication tag. */
1210 if( rec->data_len < transform->taglen )
1211 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001212 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1213 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001214 rec->data_len,
1215 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001217 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001218 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001219
Hanno Beckerdf8be222020-05-21 15:30:57 +01001220 /*
1221 * Prepare nonce from dynamic and static parts.
1222 */
Hanno Becker17263802020-05-28 07:05:48 +01001223 ssl_build_record_nonce( iv, sizeof( iv ),
1224 transform->iv_dec,
1225 transform->fixed_ivlen,
1226 dynamic_iv,
1227 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001228
Hanno Beckerdf8be222020-05-21 15:30:57 +01001229 /*
1230 * Build additional data for AEAD encryption.
1231 * This depends on the TLS version.
1232 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001233 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001234 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001235 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001236 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001237 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001238
Hanno Beckerd96a6522019-07-10 13:55:25 +01001239 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001240 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001241 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001242 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001243 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001244
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001245 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001246 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001247 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001248
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001249 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001250 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001251 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001252#if defined(MBEDTLS_USE_PSA_CRYPTO)
1253 status = psa_aead_decrypt( transform->psa_key_dec,
1254 transform->psa_alg,
1255 iv, transform->ivlen,
1256 add_data, add_data_len,
1257 data, rec->data_len + transform->taglen,
1258 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001259 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001260
1261 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001262 {
1263 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001264 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001265 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001266 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001267#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001268 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001269 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001270 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001271 data, rec->data_len + transform->taglen, /* src */
1272 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001273 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001274 {
TRodziewicz18efb732021-04-29 23:12:19 +02001275 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1278 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001279
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001280 return( ret );
1281 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001282#endif /* MBEDTLS_USE_PSA_CRYPTO */
1283
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001284 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001285
Hanno Beckerd96a6522019-07-10 13:55:25 +01001286 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001287 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001288 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1290 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001291 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001292 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001293 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001295#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001296 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1297 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001298 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001299 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001300#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001302 size_t part_len;
1303 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1304#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001305
Paul Bakker5121ce52009-01-03 21:22:43 +00001306 /*
Paul Bakker45829992013-01-03 14:52:21 +01001307 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001308 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001309#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001310 /* The ciphertext is prefixed with the CBC IV. */
1311 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001312#endif
Paul Bakker45829992013-01-03 14:52:21 +01001313
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001314 /* Size considerations:
1315 *
1316 * - The CBC cipher text must not be empty and hence
1317 * at least of size transform->ivlen.
1318 *
1319 * Together with the potential IV-prefix, this explains
1320 * the first of the two checks below.
1321 *
1322 * - The record must contain a MAC, either in plain or
1323 * encrypted, depending on whether Encrypt-then-MAC
1324 * is used or not.
1325 * - If it is, the message contains the IV-prefix,
1326 * the CBC ciphertext, and the MAC.
1327 * - If it is not, the padded plaintext, and hence
1328 * the CBC ciphertext, has at least length maclen + 1
1329 * because there is at least the padding length byte.
1330 *
1331 * As the CBC ciphertext is not empty, both cases give the
1332 * lower bound minlen + maclen + 1 on the record size, which
1333 * we test for in the second check below.
1334 */
1335 if( rec->data_len < minlen + transform->ivlen ||
1336 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001337 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1339 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1340 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001341 "+ 1 ) ( + expl IV )", rec->data_len,
1342 transform->ivlen,
1343 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001345 }
1346
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001347 /*
1348 * Authenticate before decrypt if enabled
1349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001350#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001351 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001352 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001353#if defined(MBEDTLS_USE_PSA_CRYPTO)
1354 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1355#else
Hanno Becker992b6872017-11-09 18:57:39 +00001356 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001357#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001360
Hanno Beckerd96a6522019-07-10 13:55:25 +01001361 /* Update data_len in tandem with add_data.
1362 *
1363 * The subtraction is safe because of the previous check
1364 * data_len >= minlen + maclen + 1.
1365 *
1366 * Afterwards, we know that data + data_len is followed by at
1367 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001368 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001369 *
1370 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001371 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001372 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001373 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001374 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001375
Hanno Beckerd96a6522019-07-10 13:55:25 +01001376 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001377 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1378 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001379#if defined(MBEDTLS_USE_PSA_CRYPTO)
1380 status = psa_mac_verify_setup( &operation, transform->psa_mac_dec,
1381 transform->psa_mac_alg );
1382 if( status != PSA_SUCCESS )
1383 goto hmac_failed_etm_enabled;
1384
1385 status = psa_mac_update( &operation, add_data, add_data_len );
1386 if( status != PSA_SUCCESS )
1387 goto hmac_failed_etm_enabled;
1388
1389 status = psa_mac_update( &operation, data, rec->data_len );
1390 if( status != PSA_SUCCESS )
1391 goto hmac_failed_etm_enabled;
1392
1393 /* Compare expected MAC with MAC at the end of the record. */
1394 status = psa_mac_verify_finish( &operation, data + rec->data_len,
1395 transform->maclen );
1396 if( status != PSA_SUCCESS )
1397 goto hmac_failed_etm_enabled;
1398#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001399 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1400 add_data_len );
1401 if( ret != 0 )
1402 goto hmac_failed_etm_enabled;
1403 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001404 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001405 if( ret != 0 )
1406 goto hmac_failed_etm_enabled;
1407 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1408 if( ret != 0 )
1409 goto hmac_failed_etm_enabled;
1410 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1411 if( ret != 0 )
1412 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001413
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001414 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1415 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001416 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001417 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001418
Hanno Beckerd96a6522019-07-10 13:55:25 +01001419 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001420 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001421 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001422 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001424 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1425 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001426 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001427#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001428 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001429
1430 hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001431#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001432 ret = psa_ssl_status_to_mbedtls( status );
1433 status = psa_mac_abort( &operation );
1434 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001435 ret = psa_ssl_status_to_mbedtls( status );
1436#else
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001437 mbedtls_platform_zeroize( mac_expect, transform->maclen );
Neil Armstrong4313f552022-03-02 15:14:07 +01001438#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001439 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001440 {
1441 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1442 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001443 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001444 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001445 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001446#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001447
1448 /*
1449 * Check length sanity
1450 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001451
1452 /* We know from above that data_len > minlen >= 0,
1453 * so the following check in particular implies that
1454 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001455 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001456 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001457 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1458 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001459 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001461 }
1462
TRodziewicz0f82ec62021-05-12 17:49:18 +02001463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001464 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001465 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001466 */
TRodziewicz345165c2021-07-06 13:42:11 +02001467 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1468 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001469
TRodziewicz345165c2021-07-06 13:42:11 +02001470 data += transform->ivlen;
1471 rec->data_offset += transform->ivlen;
1472 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001473#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001474
Hanno Beckerd96a6522019-07-10 13:55:25 +01001475 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1476
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001477#if defined(MBEDTLS_USE_PSA_CRYPTO)
1478 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001479 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001480
1481 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001482 {
1483 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001484 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001485 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001486 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001487
1488 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1489
1490 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001491 {
1492 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001493 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001494 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001495 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001496
1497 status = psa_cipher_update( &cipher_op,
1498 data, rec->data_len,
1499 data, rec->data_len, &olen );
1500
1501 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001502 {
1503 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001504 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001505 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001506 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001507
1508 status = psa_cipher_finish( &cipher_op,
1509 data + olen, rec->data_len - olen,
1510 &part_len );
1511
1512 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001513 {
1514 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001515 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001516 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001517 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001518
1519 olen += part_len;
1520#else
1521
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001522 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1523 transform->iv_dec, transform->ivlen,
1524 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001525 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001527 return( ret );
1528 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001529#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001530
Hanno Beckerd96a6522019-07-10 13:55:25 +01001531 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001533 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1535 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001536 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001537
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001538 /* Safe since data_len >= minlen + maclen + 1, so after having
1539 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001540 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1541 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001542 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001543
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001544 if( auth_done == 1 )
1545 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001546 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001547 rec->data_len,
1548 padlen + 1 );
1549 correct &= mask;
1550 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001551 }
1552 else
Paul Bakker45829992013-01-03 14:52:21 +01001553 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001555 if( rec->data_len < transform->maclen + padlen + 1 )
1556 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1558 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1559 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001560 rec->data_len,
1561 transform->maclen,
1562 padlen + 1 ) );
1563 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001564#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001565
Gabor Mezei90437e32021-10-20 11:59:27 +02001566 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001567 rec->data_len,
1568 transform->maclen + padlen + 1 );
1569 correct &= mask;
1570 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001571 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001572
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001573 padlen++;
1574
1575 /* Regardless of the validity of the padding,
1576 * we have data_len >= padlen here. */
1577
TRodziewicz0f82ec62021-05-12 17:49:18 +02001578#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001579 /* The padding check involves a series of up to 256
1580 * consecutive memory reads at the end of the record
1581 * plaintext buffer. In order to hide the length and
1582 * validity of the padding, always perform exactly
1583 * `min(256,plaintext_len)` reads (but take into account
1584 * only the last `padlen` bytes for the padding check). */
1585 size_t pad_count = 0;
1586 volatile unsigned char* const check = data;
1587
1588 /* Index of first padding byte; it has been ensured above
1589 * that the subtraction is safe. */
1590 size_t const padding_idx = rec->data_len - padlen;
1591 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1592 size_t const start_idx = rec->data_len - num_checks;
1593 size_t idx;
1594
1595 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001596 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001597 /* pad_count += (idx >= padding_idx) &&
1598 * (check[idx] == padlen - 1);
1599 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001600 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1601 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001602 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001603 pad_count += mask & equal;
1604 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001605 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001607#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001608 if( padlen > 0 && correct == 0 )
1609 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001610#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001611 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001612
TRodziewicz0f82ec62021-05-12 17:49:18 +02001613#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001614
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001615 /* If the padding was found to be invalid, padlen == 0
1616 * and the subtraction is safe. If the padding was found valid,
1617 * padlen hasn't been changed and the previous assertion
1618 * data_len >= padlen still holds. */
1619 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001620 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001621 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001622#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001623 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1625 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001626 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001627
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001628#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001630 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001631#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001632
1633 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001634 * Authenticate if not done yet.
1635 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001636 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001637#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001638 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001639 {
Paul Elliott5260ce22022-05-09 18:15:54 +01001640 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1641 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001642
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001643 /* If the initial value of padlen was such that
1644 * data_len < maclen + padlen + 1, then padlen
1645 * got reset to 1, and the initial check
1646 * data_len >= minlen + maclen + 1
1647 * guarantees that at this point we still
1648 * have at least data_len >= maclen.
1649 *
1650 * If the initial value of padlen was such that
1651 * data_len >= maclen + padlen + 1, then we have
1652 * subtracted either padlen + 1 (if the padding was correct)
1653 * or 0 (if the padding was incorrect) since then,
1654 * hence data_len >= maclen in any case.
1655 */
1656 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001657 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001658 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001659 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001660
TRodziewicz0f82ec62021-05-12 17:49:18 +02001661#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001662 /*
1663 * The next two sizes are the minimum and maximum values of
1664 * data_len over all padlen values.
1665 *
1666 * They're independent of padlen, since we previously did
1667 * data_len -= padlen.
1668 *
1669 * Note that max_len + maclen is never more than the buffer
1670 * length, as we previously did in_msglen -= maclen too.
1671 */
1672 const size_t max_len = rec->data_len + padlen;
1673 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1674
Neil Armstronge8589962022-02-25 15:14:29 +01001675#if defined(MBEDTLS_USE_PSA_CRYPTO)
1676 ret = mbedtls_ct_hmac( transform->psa_mac_dec,
1677 transform->psa_mac_alg,
1678 add_data, add_data_len,
1679 data, rec->data_len, min_len, max_len,
1680 mac_expect );
1681#else
Gabor Mezei90437e32021-10-20 11:59:27 +02001682 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001683 add_data, add_data_len,
1684 data, rec->data_len, min_len, max_len,
1685 mac_expect );
Neil Armstronge8589962022-02-25 15:14:29 +01001686#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001687 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001688 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001689 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001690 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001691 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001692
Gabor Mezei90437e32021-10-20 11:59:27 +02001693 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001694 rec->data_len,
1695 min_len, max_len,
1696 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001697#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001698
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001699#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001700 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001701 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001702#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001703
Gabor Mezei90437e32021-10-20 11:59:27 +02001704 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001705 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001706 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707#if defined(MBEDTLS_SSL_DEBUG_ALL)
1708 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001709#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001710 correct = 0;
1711 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001712 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001713
1714 hmac_failed_etm_disabled:
1715 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1716 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1717 if( ret != 0 )
1718 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001719 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001720
1721 /*
1722 * Finally check the correct flag
1723 */
1724 if( correct == 0 )
1725 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001726#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001727
1728 /* Make extra sure authentication was performed, exactly once */
1729 if( auth_done != 1 )
1730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1732 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001733 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001734
Ronald Cron6f135e12021-12-08 16:57:54 +01001735#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04001736 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +01001737 {
1738 /* Remove inner padding and infer true content type. */
1739 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1740 &rec->type );
1741
1742 if( ret != 0 )
1743 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1744 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001745#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001746
Hanno Beckera0e20d02019-05-15 14:03:01 +01001747#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001748 if( rec->cid_len != 0 )
1749 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001750 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1751 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001752 if( ret != 0 )
1753 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1754 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001755#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
1759 return( 0 );
1760}
1761
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001762#undef MAC_NONE
1763#undef MAC_PLAINTEXT
1764#undef MAC_CIPHERTEXT
1765
Paul Bakker5121ce52009-01-03 21:22:43 +00001766/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001767 * Fill the input message buffer by appending data to it.
1768 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001769 *
1770 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1771 * available (from this read and/or a previous one). Otherwise, an error code
1772 * is returned (possibly EOF or WANT_READ).
1773 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001774 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1775 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1776 * since we always read a whole datagram at once.
1777 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001778 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001779 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001782{
Janos Follath865b3eb2019-12-16 11:46:15 +00001783 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001784 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001785#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1786 size_t in_buf_len = ssl->in_buf_len;
1787#else
1788 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1789#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001792
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001793 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1794 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001796 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001798 }
1799
Darryl Greenb33cc762019-11-28 14:29:44 +00001800 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001801 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1803 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001804 }
1805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001807 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001808 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001809 uint32_t timeout;
1810
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001811 /*
1812 * The point is, we need to always read a full datagram at once, so we
1813 * sometimes read more then requested, and handle the additional data.
1814 * It could be the rest of the current record (while fetching the
1815 * header) and/or some other records in the same datagram.
1816 */
1817
1818 /*
1819 * Move to the next record in the already read datagram if applicable
1820 */
1821 if( ssl->next_record_offset != 0 )
1822 {
1823 if( ssl->in_left < ssl->next_record_offset )
1824 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1826 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001827 }
1828
1829 ssl->in_left -= ssl->next_record_offset;
1830
1831 if( ssl->in_left != 0 )
1832 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1834 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001835 ssl->next_record_offset ) );
1836 memmove( ssl->in_hdr,
1837 ssl->in_hdr + ssl->next_record_offset,
1838 ssl->in_left );
1839 }
1840
1841 ssl->next_record_offset = 0;
1842 }
1843
Paul Elliottd48d5c62021-01-07 14:47:05 +00001844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1845 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001846 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001847
1848 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001849 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001850 */
1851 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001852 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001854 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001855 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001856
1857 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001858 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001859 * are not at the beginning of a new record, the caller did something
1860 * wrong.
1861 */
1862 if( ssl->in_left != 0 )
1863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1865 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001866 }
1867
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001868 /*
1869 * Don't even try to read if time's out already.
1870 * This avoids by-passing the timer when repeatedly receiving messages
1871 * that will end up being dropped.
1872 */
Hanno Becker7876d122020-02-05 10:39:31 +00001873 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001874 {
1875 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001876 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001877 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001878 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001879 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001880 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001881
Paul Elliott27b0d942022-03-18 21:55:32 +00001882 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001883 timeout = ssl->handshake->retransmit_timeout;
1884 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001885 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001886
Paul Elliott9f352112020-12-09 14:55:45 +00001887 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001888
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001889 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001890 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1891 timeout );
1892 else
1893 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001896
1897 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001899 }
1900
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001901 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001902 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001904 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001905
Paul Elliott27b0d942022-03-18 21:55:32 +00001906 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001907 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001908 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1909 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001911 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001912 }
1913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001915 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001917 return( ret );
1918 }
1919
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001920 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001921 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001923 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001925 {
Hanno Becker786300f2020-02-05 10:46:40 +00001926 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001927 {
Hanno Becker786300f2020-02-05 10:46:40 +00001928 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1929 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001930 return( ret );
1931 }
1932
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001933 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001934 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001936 }
1937
Paul Bakker5121ce52009-01-03 21:22:43 +00001938 if( ret < 0 )
1939 return( ret );
1940
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001941 ssl->in_left = ret;
1942 }
1943 else
1944#endif
1945 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001946 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1947 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001948 ssl->in_left, nb_want ) );
1949
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001950 while( ssl->in_left < nb_want )
1951 {
1952 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001953
Hanno Becker7876d122020-02-05 10:39:31 +00001954 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001955 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1956 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001957 {
1958 if( ssl->f_recv_timeout != NULL )
1959 {
1960 ret = ssl->f_recv_timeout( ssl->p_bio,
1961 ssl->in_hdr + ssl->in_left, len,
1962 ssl->conf->read_timeout );
1963 }
1964 else
1965 {
1966 ret = ssl->f_recv( ssl->p_bio,
1967 ssl->in_hdr + ssl->in_left, len );
1968 }
1969 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001970
Paul Elliottd48d5c62021-01-07 14:47:05 +00001971 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1972 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001973 ssl->in_left, nb_want ) );
1974 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001975
1976 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001978
1979 if( ret < 0 )
1980 return( ret );
1981
makise-homuraaf9513b2020-08-24 18:26:27 +03001982 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001983 {
Darryl Green11999bb2018-03-13 15:22:58 +00001984 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001985 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001986 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001987 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1988 }
1989
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001990 ssl->in_left += ret;
1991 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001992 }
1993
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001995
1996 return( 0 );
1997}
1998
1999/*
2000 * Flush any data not yet written
2001 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002003{
Janos Follath865b3eb2019-12-16 11:46:15 +00002004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002005 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002008
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002009 if( ssl->f_send == NULL )
2010 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002012 "or 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é-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002073{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2076 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2077 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078
2079 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002080 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002081 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002082 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002083 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002084 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002085 }
2086
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002087 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002088 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002089 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2090 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002092 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002093 }
2094
2095 /* Copy current handshake message with headers */
2096 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2097 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002098 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002099 msg->next = NULL;
2100
2101 /* Append to the current flight */
2102 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002103 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002104 else
2105 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002106 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002107 while( cur->next != NULL )
2108 cur = cur->next;
2109 cur->next = msg;
2110 }
2111
Hanno Becker3b235902018-08-06 09:54:53 +01002112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002113 return( 0 );
2114}
2115
2116/*
2117 * Free the current flight of handshake messages
2118 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002119void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002120{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 mbedtls_ssl_flight_item *cur = flight;
2122 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002123
2124 while( cur != NULL )
2125 {
2126 next = cur->next;
2127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128 mbedtls_free( cur->p );
2129 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002130
2131 cur = next;
2132 }
2133}
2134
2135/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002136 * Swap transform_out and out_ctr with the alternative ones
2137 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002138static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002139{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002141 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002142
2143 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2144 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002146 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002147 }
2148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002150
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002151 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002152 tmp_transform = ssl->transform_out;
2153 ssl->transform_out = ssl->handshake->alt_transform_out;
2154 ssl->handshake->alt_transform_out = tmp_transform;
2155
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002156 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002157 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2158 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2159 sizeof( ssl->cur_out_ctr ) );
2160 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2161 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002162
2163 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002164 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002165
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002166 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002167}
2168
2169/*
2170 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002171 */
2172int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2173{
2174 int ret = 0;
2175
2176 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2177
2178 ret = mbedtls_ssl_flight_transmit( ssl );
2179
2180 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2181
2182 return( ret );
2183}
2184
2185/*
2186 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002187 *
2188 * Need to remember the current message in case flush_output returns
2189 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002190 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002191 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002192int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193{
Janos Follath865b3eb2019-12-16 11:46:15 +00002194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002198 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002199 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002200
2201 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002202 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002203 ret = ssl_swap_epochs( ssl );
2204 if( ret != 0 )
2205 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002207 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002208 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002209
2210 while( ssl->handshake->cur_msg != NULL )
2211 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002212 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002213 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002214
Hanno Beckere1dcb032018-08-17 16:47:58 +01002215 int const is_finished =
2216 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2217 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2218
Ronald Cron00d012f22022-03-08 15:57:12 +01002219 int const force_flush = ssl->disable_datagram_packing == 1 ?
Hanno Becker04da1892018-08-14 13:22:10 +01002220 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2221
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002222 /* Swap epochs before sending Finished: we can't do it after
2223 * sending ChangeCipherSpec, in case write returns WANT_READ.
2224 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002225 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002226 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002227 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002228 ret = ssl_swap_epochs( ssl );
2229 if( ret != 0 )
2230 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002231 }
2232
Hanno Becker67bc7c32018-08-06 11:33:50 +01002233 ret = ssl_get_remaining_payload_in_datagram( ssl );
2234 if( ret < 0 )
2235 return( ret );
2236 max_frag_len = (size_t) ret;
2237
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002238 /* CCS is copied as is, while HS messages may need fragmentation */
2239 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2240 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002241 if( max_frag_len == 0 )
2242 {
2243 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2244 return( ret );
2245
2246 continue;
2247 }
2248
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002249 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002250 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002251 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002252
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002253 /* Update position inside current message */
2254 ssl->handshake->cur_msg_p += cur->len;
2255 }
2256 else
2257 {
2258 const unsigned char * const p = ssl->handshake->cur_msg_p;
2259 const size_t hs_len = cur->len - 12;
2260 const size_t frag_off = p - ( cur->p + 12 );
2261 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002262 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002263
Hanno Beckere1dcb032018-08-17 16:47:58 +01002264 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002265 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002266 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002267 {
2268 ret = ssl_swap_epochs( ssl );
2269 if( ret != 0 )
2270 return( ret );
2271 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002272
Hanno Becker67bc7c32018-08-06 11:33:50 +01002273 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2274 return( ret );
2275
2276 continue;
2277 }
2278 max_hs_frag_len = max_frag_len - 12;
2279
2280 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2281 max_hs_frag_len : rem_len;
2282
2283 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002284 {
2285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002286 (unsigned) cur_hs_frag_len,
2287 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002288 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002289
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002290 /* Messages are stored with handshake headers as if not fragmented,
2291 * copy beginning of headers then fill fragmentation fields.
2292 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2293 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002294
Joe Subbiani5ecac212021-06-24 13:00:03 +01002295 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2296 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2297 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002298
Joe Subbiani5ecac212021-06-24 13:00:03 +01002299 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2300 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2301 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002302
2303 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2304
Hanno Becker3f7b9732018-08-28 09:53:25 +01002305 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002306 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2307 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002308 ssl->out_msgtype = cur->type;
2309
2310 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002311 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002312 }
2313
2314 /* If done with the current message move to the next one if any */
2315 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2316 {
2317 if( cur->next != NULL )
2318 {
2319 ssl->handshake->cur_msg = cur->next;
2320 ssl->handshake->cur_msg_p = cur->next->p + 12;
2321 }
2322 else
2323 {
2324 ssl->handshake->cur_msg = NULL;
2325 ssl->handshake->cur_msg_p = NULL;
2326 }
2327 }
2328
2329 /* Actually send the message out */
Gabor Mezei96ec8312022-06-22 13:17:28 +02002330 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush,
2331 SSL_ENCRYPT_RECORD ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002332 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002333 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002334 return( ret );
2335 }
2336 }
2337
Hanno Becker67bc7c32018-08-06 11:33:50 +01002338 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2339 return( ret );
2340
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002341 /* Update state and set timer */
Paul Elliott27b0d942022-03-18 21:55:32 +00002342 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002344 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002345 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002347 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002348 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002349
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002350 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002351
2352 return( 0 );
2353}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002354
2355/*
2356 * To be called when the last message of an incoming flight is received.
2357 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002359{
2360 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002361 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002362 ssl->handshake->flight = NULL;
2363 ssl->handshake->cur_msg = NULL;
2364
2365 /* The next incoming flight will start with this msg_seq */
2366 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2367
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002368 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002369 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002370
Hanno Becker0271f962018-08-16 13:23:47 +01002371 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002372 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002373
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002374 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002375 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2378 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002379 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002380 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002381 }
2382 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002384}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002385
2386/*
2387 * To be called when the last message of an outgoing flight is send.
2388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002390{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002391 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002392 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002394 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2395 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002396 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002397 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002398 }
2399 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002400 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002401}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002403
Paul Bakker5121ce52009-01-03 21:22:43 +00002404/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002405 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002406 */
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002407int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
2408 unsigned char **buf, size_t *buf_len )
2409{
2410 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002411 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002412 * ...
2413 * HandshakeType msg_type;
2414 * uint24 length;
2415 * ...
2416 */
2417 *buf = ssl->out_msg + 4;
2418 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2419
2420 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2421 ssl->out_msg[0] = hs_type;
2422
2423 return( 0 );
2424}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425
2426/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002427 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002428 *
2429 * - fill in handshake headers
2430 * - update handshake checksum
2431 * - DTLS: save message for resending
2432 * - then pass to the record layer
2433 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002434 * DTLS: except for HelloRequest, messages are only queued, and will only be
2435 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002436 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002437 * Inputs:
2438 * - ssl->out_msglen: 4 + actual handshake message len
2439 * (4 is the size of handshake headers for TLS)
2440 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2441 * - ssl->out_msg + 4: the handshake message body
2442 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002443 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002444 * - ssl->out_msglen: the length of the record contents
2445 * (including handshake headers but excluding record headers)
2446 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002447 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002448int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01002449 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01002450 int force_flush )
Paul Bakker5121ce52009-01-03 21:22:43 +00002451{
Janos Follath865b3eb2019-12-16 11:46:15 +00002452 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002453 const size_t hs_len = ssl->out_msglen - 4;
2454 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002455
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002456 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2457
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002458 /*
2459 * Sanity checks
2460 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002461 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002462 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2463 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2465 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002466 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002467
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002468 /* Whenever we send anything different from a
2469 * HelloRequest we should be in a handshake - double check. */
2470 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2471 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002472 ssl->handshake == NULL )
2473 {
2474 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2475 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2476 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002479 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002480 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002482 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2484 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002485 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002486#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002487
Hanno Beckerb50a2532018-08-06 11:52:54 +01002488 /* Double-check that we did not exceed the bounds
2489 * of the outgoing record buffer.
2490 * This should never fail as the various message
2491 * writing functions must obey the bounds of the
2492 * outgoing record buffer, but better be safe.
2493 *
2494 * Note: We deliberately do not check for the MTU or MFL here.
2495 */
2496 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2497 {
2498 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002499 "size %" MBEDTLS_PRINTF_SIZET
2500 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002501 ssl->out_msglen,
2502 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002503 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2504 }
2505
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002506 /*
2507 * Fill handshake headers
2508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002510 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002511 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2512 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2513 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002514
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002515 /*
2516 * DTLS has additional fields in the Handshake layer,
2517 * between the length field and the actual payload:
2518 * uint16 message_seq;
2519 * uint24 fragment_offset;
2520 * uint24 fragment_length;
2521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002523 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002524 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002525 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002526 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002527 {
2528 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002529 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002530 hs_len,
2531 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002532 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2533 }
2534
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002535 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002536 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002537
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002538 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002539 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002540 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002541 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002542 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002543 }
2544 else
2545 {
2546 ssl->out_msg[4] = 0;
2547 ssl->out_msg[5] = 0;
2548 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002549
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002550 /* Handshake hashes are computed without fragmentation,
2551 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002552 memset( ssl->out_msg + 6, 0x00, 3 );
2553 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002554 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002556
Hanno Becker0207e532018-08-28 10:28:28 +01002557 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002558 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002559 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 }
2561
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002562 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002564 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002565 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2566 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002567 {
2568 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2569 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002571 return( ret );
2572 }
2573 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002574 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002575#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002576 {
Gabor Mezei96ec8312022-06-22 13:17:28 +02002577 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush,
2578 SSL_ENCRYPT_RECORD ) ) != 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 Mezei96ec8312022-06-22 13:17:28 +02002618int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush,
2619 int encrypt )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002620{
2621 int ret, done = 0;
2622 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002623 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002624
2625 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002626
Paul Bakker05ef8352012-05-08 09:17:57 +00002627 if( !done )
2628 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002629 unsigned i;
2630 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002631#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2632 size_t out_buf_len = ssl->out_buf_len;
2633#else
2634 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2635#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002636 /* Skip writing the record content type to after the encryption,
2637 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002638 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002640 /* TLS 1.3 still uses the TLS 1.2 version identifier
2641 * for backwards compatibility. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002642 if( tls_ver == MBEDTLS_SSL_VERSION_TLS1_3 )
2643 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron6f135e12021-12-08 16:57:54 +01002644#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002645 mbedtls_ssl_write_version( ssl->out_hdr + 1, ssl->conf->transport,
2646 tls_ver );
Hanno Becker6430faf2019-05-08 11:57:13 +01002647
Jerry Yuae0b2e22021-10-08 15:21:19 +08002648 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002649 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002650
Gabor Mezei96ec8312022-06-22 13:17:28 +02002651 if( ssl->transform_out != NULL && encrypt )
Paul Bakker05ef8352012-05-08 09:17:57 +00002652 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002653 mbedtls_record rec;
2654
2655 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002656 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002657 rec.data_len = ssl->out_msglen;
2658 rec.data_offset = ssl->out_msg - rec.buf;
2659
Jerry Yud96a5c22021-09-29 17:46:51 +08002660 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002661 mbedtls_ssl_write_version( rec.ver, ssl->conf->transport, tls_ver );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002662 rec.type = ssl->out_msgtype;
2663
Hanno Beckera0e20d02019-05-15 14:03:01 +01002664#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002665 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002666 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002667#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002668
Hanno Beckera18d1322018-01-03 14:27:32 +00002669 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002670 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002671 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002673 return( ret );
2674 }
2675
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002676 if( rec.data_offset != 0 )
2677 {
2678 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2679 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2680 }
2681
Hanno Becker6430faf2019-05-08 11:57:13 +01002682 /* Update the record content type and CID. */
2683 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002684#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002685 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002686#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002687 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002688 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002689 }
2690
Hanno Becker5903de42019-05-03 14:46:38 +01002691 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002692
2693#if defined(MBEDTLS_SSL_PROTO_DTLS)
2694 /* In case of DTLS, double-check that we don't exceed
2695 * the remaining space in the datagram. */
2696 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2697 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002698 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002699 if( ret < 0 )
2700 return( ret );
2701
2702 if( protected_record_size > (size_t) ret )
2703 {
2704 /* Should never happen */
2705 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2706 }
2707 }
2708#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002709
Hanno Becker6430faf2019-05-08 11:57:13 +01002710 /* Now write the potentially updated record content type. */
2711 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2712
Paul Elliott9f352112020-12-09 14:55:45 +00002713 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002714 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002715 ssl->out_hdr[0], ssl->out_hdr[1],
2716 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002718 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002719 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002720
2721 ssl->out_left += protected_record_size;
2722 ssl->out_hdr += protected_record_size;
Gabor Mezei96ec8312022-06-22 13:17:28 +02002723 mbedtls_ssl_update_out_pointers( ssl, encrypt ? ssl->transform_out : NULL );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002724
Gabor Mezei96ec8312022-06-22 13:17:28 +02002725 /* Do not increment the counter for CCS records. */
2726 if( encrypt )
Hanno Becker04484622018-08-06 09:49:38 +01002727 {
Gabor Mezei96ec8312022-06-22 13:17:28 +02002728 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
2729 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2730 break;
2731
2732 /* The loop goes to its end iff the counter is wrapping */
2733 if( i == mbedtls_ssl_ep_len( ssl ) )
2734 {
2735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2736 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2737 }
Hanno Becker04484622018-08-06 09:49:38 +01002738 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002739 }
2740
Hanno Becker67bc7c32018-08-06 11:33:50 +01002741#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002742 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2743 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002744 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002745 size_t remaining;
2746 ret = ssl_get_remaining_payload_in_datagram( ssl );
2747 if( ret < 0 )
2748 {
2749 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2750 ret );
2751 return( ret );
2752 }
2753
2754 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002755 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002756 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002757 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002758 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002759 else
2760 {
Hanno Becker513815a2018-08-20 11:56:09 +01002761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002762 }
2763 }
2764#endif /* MBEDTLS_SSL_PROTO_DTLS */
2765
2766 if( ( flush == SSL_FORCE_FLUSH ) &&
2767 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002768 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002770 return( ret );
2771 }
2772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002774
2775 return( 0 );
2776}
2777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002779
2780static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2781{
2782 if( ssl->in_msglen < ssl->in_hslen ||
2783 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2784 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2785 {
2786 return( 1 );
2787 }
2788 return( 0 );
2789}
Hanno Becker44650b72018-08-16 12:51:11 +01002790
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002791static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002792{
2793 return( ( ssl->in_msg[9] << 16 ) |
2794 ( ssl->in_msg[10] << 8 ) |
2795 ssl->in_msg[11] );
2796}
2797
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002798static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002799{
2800 return( ( ssl->in_msg[6] << 16 ) |
2801 ( ssl->in_msg[7] << 8 ) |
2802 ssl->in_msg[8] );
2803}
2804
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002805static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002806{
2807 uint32_t msg_len, frag_off, frag_len;
2808
2809 msg_len = ssl_get_hs_total_len( ssl );
2810 frag_off = ssl_get_hs_frag_off( ssl );
2811 frag_len = ssl_get_hs_frag_len( ssl );
2812
2813 if( frag_off > msg_len )
2814 return( -1 );
2815
2816 if( frag_len > msg_len - frag_off )
2817 return( -1 );
2818
2819 if( frag_len + 12 > ssl->in_msglen )
2820 return( -1 );
2821
2822 return( 0 );
2823}
2824
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002825/*
2826 * Mark bits in bitmask (used for DTLS HS reassembly)
2827 */
2828static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2829{
2830 unsigned int start_bits, end_bits;
2831
2832 start_bits = 8 - ( offset % 8 );
2833 if( start_bits != 8 )
2834 {
2835 size_t first_byte_idx = offset / 8;
2836
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002837 /* Special case */
2838 if( len <= start_bits )
2839 {
2840 for( ; len != 0; len-- )
2841 mask[first_byte_idx] |= 1 << ( start_bits - len );
2842
2843 /* Avoid potential issues with offset or len becoming invalid */
2844 return;
2845 }
2846
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002847 offset += start_bits; /* Now offset % 8 == 0 */
2848 len -= start_bits;
2849
2850 for( ; start_bits != 0; start_bits-- )
2851 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2852 }
2853
2854 end_bits = len % 8;
2855 if( end_bits != 0 )
2856 {
2857 size_t last_byte_idx = ( offset + len ) / 8;
2858
2859 len -= end_bits; /* Now len % 8 == 0 */
2860
2861 for( ; end_bits != 0; end_bits-- )
2862 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2863 }
2864
2865 memset( mask + offset / 8, 0xFF, len / 8 );
2866}
2867
2868/*
2869 * Check that bitmask is full
2870 */
2871static int ssl_bitmask_check( unsigned char *mask, size_t len )
2872{
2873 size_t i;
2874
2875 for( i = 0; i < len / 8; i++ )
2876 if( mask[i] != 0xFF )
2877 return( -1 );
2878
2879 for( i = 0; i < len % 8; i++ )
2880 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2881 return( -1 );
2882
2883 return( 0 );
2884}
2885
Hanno Becker56e205e2018-08-16 09:06:12 +01002886/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002887static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002888 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002889{
Hanno Becker56e205e2018-08-16 09:06:12 +01002890 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002891
Hanno Becker56e205e2018-08-16 09:06:12 +01002892 alloc_len = 12; /* Handshake header */
2893 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002894
Hanno Beckerd07df862018-08-16 09:14:58 +01002895 if( add_bitmap )
2896 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002897
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002898 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002899}
Hanno Becker56e205e2018-08-16 09:06:12 +01002900
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002902
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002903static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002904{
2905 return( ( ssl->in_msg[1] << 16 ) |
2906 ( ssl->in_msg[2] << 8 ) |
2907 ssl->in_msg[3] );
2908}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002909
Simon Butcher99000142016-10-13 17:21:01 +01002910int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002911{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002913 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002914 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002915 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002917 }
2918
Hanno Becker12555c62018-08-16 12:47:53 +01002919 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002922 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002923 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002924
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002926 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002927 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002928 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002929 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002930
Hanno Becker44650b72018-08-16 12:51:11 +01002931 if( ssl_check_hs_header( ssl ) != 0 )
2932 {
2933 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2934 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2935 }
2936
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002937 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00002938 ( ( mbedtls_ssl_is_handshake_over( ssl ) == 0 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002939 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002940 ( mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002941 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002942 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002943 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2944 {
2945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2946 recv_msg_seq,
2947 ssl->handshake->in_msg_seq ) );
2948 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2949 }
2950
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002951 /* Retransmit only on last message from previous flight, to avoid
2952 * too many retransmissions.
2953 * Besides, No sane server ever retransmits HelloVerifyRequest */
2954 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002956 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002958 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002959 recv_msg_seq,
2960 ssl->handshake->in_flight_start_seq ) );
2961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002965 return( ret );
2966 }
2967 }
2968 else
2969 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002971 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002972 recv_msg_seq,
2973 ssl->handshake->in_msg_seq ) );
2974 }
2975
Hanno Becker90333da2017-10-10 11:27:13 +01002976 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002977 }
2978 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002979
Hanno Becker6d97ef52018-08-16 13:09:04 +01002980 /* Message reassembly is handled alongside buffering of future
2981 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002982 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002983 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002984 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002985 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002987 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002988 }
2989 }
2990 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002992 /* With TLS we don't handle fragmentation (for now) */
2993 if( ssl->in_msglen < ssl->in_hslen )
2994 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2996 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002997 }
2998
Simon Butcher99000142016-10-13 17:21:01 +01002999 return( 0 );
3000}
3001
3002void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3003{
Hanno Becker0271f962018-08-16 13:23:47 +01003004 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003005
Paul Elliott27b0d942022-03-18 21:55:32 +00003006 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003007 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003008 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003009 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003010
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003011 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003013 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003014 ssl->handshake != NULL )
3015 {
Hanno Becker0271f962018-08-16 13:23:47 +01003016 unsigned offset;
3017 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003018
Hanno Becker0271f962018-08-16 13:23:47 +01003019 /* Increment handshake sequence number */
3020 hs->in_msg_seq++;
3021
3022 /*
3023 * Clear up handshake buffering and reassembly structure.
3024 */
3025
3026 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003027 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003028
3029 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003030 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3031 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003032 offset++, hs_buf++ )
3033 {
3034 *hs_buf = *(hs_buf + 1);
3035 }
3036
3037 /* Create a fresh last entry */
3038 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003039 }
3040#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003041}
3042
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003043/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003044 * DTLS anti-replay: RFC 6347 4.1.2.6
3045 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003046 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3047 * Bit n is set iff record number in_window_top - n has been seen.
3048 *
3049 * Usually, in_window_top is the last record number seen and the lsb of
3050 * in_window is set. The only exception is the initial state (record number 0
3051 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003054void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003055{
3056 ssl->in_window_top = 0;
3057 ssl->in_window = 0;
3058}
3059
3060static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3061{
3062 return( ( (uint64_t) buf[0] << 40 ) |
3063 ( (uint64_t) buf[1] << 32 ) |
3064 ( (uint64_t) buf[2] << 24 ) |
3065 ( (uint64_t) buf[3] << 16 ) |
3066 ( (uint64_t) buf[4] << 8 ) |
3067 ( (uint64_t) buf[5] ) );
3068}
3069
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003070static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3071{
Janos Follath865b3eb2019-12-16 11:46:15 +00003072 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003073 unsigned char *original_in_ctr;
3074
3075 // save original in_ctr
3076 original_in_ctr = ssl->in_ctr;
3077
3078 // use counter from record
3079 ssl->in_ctr = record_in_ctr;
3080
3081 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3082
3083 // restore the counter
3084 ssl->in_ctr = original_in_ctr;
3085
3086 return ret;
3087}
3088
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003089/*
3090 * Return 0 if sequence number is acceptable, -1 otherwise
3091 */
Hanno Becker0183d692019-07-12 08:50:37 +01003092int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003093{
3094 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3095 uint64_t bit;
3096
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003097 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003098 return( 0 );
3099
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003100 if( rec_seqnum > ssl->in_window_top )
3101 return( 0 );
3102
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003103 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003104
3105 if( bit >= 64 )
3106 return( -1 );
3107
3108 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3109 return( -1 );
3110
3111 return( 0 );
3112}
3113
3114/*
3115 * Update replay window on new validated record
3116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003118{
3119 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3120
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003121 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003122 return;
3123
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003124 if( rec_seqnum > ssl->in_window_top )
3125 {
3126 /* Update window_top and the contents of the window */
3127 uint64_t shift = rec_seqnum - ssl->in_window_top;
3128
3129 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003130 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003131 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003132 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003133 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003134 ssl->in_window |= 1;
3135 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003136
3137 ssl->in_window_top = rec_seqnum;
3138 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003139 else
3140 {
3141 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003142 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003143
3144 if( bit < 64 ) /* Always true, but be extra sure */
3145 ssl->in_window |= (uint64_t) 1 << bit;
3146 }
3147}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003149
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003150#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003151/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003152 * Without any SSL context, check if a datagram looks like a ClientHello with
3153 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003154 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003155 *
3156 * - if cookie is valid, return 0
3157 * - if ClientHello looks superficially valid but cookie is not,
3158 * fill obuf and set olen, then
3159 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3160 * - otherwise return a specific error code
3161 */
3162static int ssl_check_dtls_clihlo_cookie(
3163 mbedtls_ssl_cookie_write_t *f_cookie_write,
3164 mbedtls_ssl_cookie_check_t *f_cookie_check,
3165 void *p_cookie,
3166 const unsigned char *cli_id, size_t cli_id_len,
3167 const unsigned char *in, size_t in_len,
3168 unsigned char *obuf, size_t buf_len, size_t *olen )
3169{
3170 size_t sid_len, cookie_len;
3171 unsigned char *p;
3172
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003173 /*
3174 * Structure of ClientHello with record and handshake headers,
3175 * and expected values. We don't need to check a lot, more checks will be
3176 * done when actually parsing the ClientHello - skipping those checks
3177 * avoids code duplication and does not make cookie forging any easier.
3178 *
3179 * 0-0 ContentType type; copied, must be handshake
3180 * 1-2 ProtocolVersion version; copied
3181 * 3-4 uint16 epoch; copied, must be 0
3182 * 5-10 uint48 sequence_number; copied
3183 * 11-12 uint16 length; (ignored)
3184 *
3185 * 13-13 HandshakeType msg_type; (ignored)
3186 * 14-16 uint24 length; (ignored)
3187 * 17-18 uint16 message_seq; copied
3188 * 19-21 uint24 fragment_offset; copied, must be 0
3189 * 22-24 uint24 fragment_length; (ignored)
3190 *
3191 * 25-26 ProtocolVersion client_version; (ignored)
3192 * 27-58 Random random; (ignored)
3193 * 59-xx SessionID session_id; 1 byte len + sid_len content
3194 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3195 * ...
3196 *
3197 * Minimum length is 61 bytes.
3198 */
3199 if( in_len < 61 ||
3200 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3201 in[3] != 0 || in[4] != 0 ||
3202 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3203 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003204 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003205 }
3206
3207 sid_len = in[59];
3208 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003209 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003210
3211 cookie_len = in[60 + sid_len];
3212 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003213 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003214
3215 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3216 cli_id, cli_id_len ) == 0 )
3217 {
3218 /* Valid cookie */
3219 return( 0 );
3220 }
3221
3222 /*
3223 * If we get here, we've got an invalid cookie, let's prepare HVR.
3224 *
3225 * 0-0 ContentType type; copied
3226 * 1-2 ProtocolVersion version; copied
3227 * 3-4 uint16 epoch; copied
3228 * 5-10 uint48 sequence_number; copied
3229 * 11-12 uint16 length; olen - 13
3230 *
3231 * 13-13 HandshakeType msg_type; hello_verify_request
3232 * 14-16 uint24 length; olen - 25
3233 * 17-18 uint16 message_seq; copied
3234 * 19-21 uint24 fragment_offset; copied
3235 * 22-24 uint24 fragment_length; olen - 25
3236 *
3237 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3238 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3239 *
3240 * Minimum length is 28.
3241 */
3242 if( buf_len < 28 )
3243 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3244
3245 /* Copy most fields and adapt others */
3246 memcpy( obuf, in, 25 );
3247 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3248 obuf[25] = 0xfe;
3249 obuf[26] = 0xff;
3250
3251 /* Generate and write actual cookie */
3252 p = obuf + 28;
3253 if( f_cookie_write( p_cookie,
3254 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3255 {
3256 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3257 }
3258
3259 *olen = p - obuf;
3260
3261 /* Go back and fill length fields */
3262 obuf[27] = (unsigned char)( *olen - 28 );
3263
Joe Subbianifbeb6922021-07-16 14:27:50 +01003264 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3265 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3266 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003267
Joe Subbiani6dd73642021-07-19 11:56:54 +01003268 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003269
3270 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3271}
3272
3273/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003274 * Handle possible client reconnect with the same UDP quadruplet
3275 * (RFC 6347 Section 4.2.8).
3276 *
3277 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3278 * that looks like a ClientHello.
3279 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003280 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003281 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003282 * - if the input looks like a ClientHello with a valid cookie,
3283 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003284 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003285 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003286 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003287 * This function is called (through ssl_check_client_reconnect()) when an
3288 * unexpected record is found in ssl_get_next_record(), which will discard the
3289 * record if we return 0, and bubble up the return value otherwise (this
3290 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3291 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003292 */
3293static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3294{
Janos Follath865b3eb2019-12-16 11:46:15 +00003295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003296 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003297
Hanno Becker2fddd372019-07-10 14:37:41 +01003298 if( ssl->conf->f_cookie_write == NULL ||
3299 ssl->conf->f_cookie_check == NULL )
3300 {
3301 /* If we can't use cookies to verify reachability of the peer,
3302 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003303 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3304 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003305 return( 0 );
3306 }
3307
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003308 ret = ssl_check_dtls_clihlo_cookie(
3309 ssl->conf->f_cookie_write,
3310 ssl->conf->f_cookie_check,
3311 ssl->conf->p_cookie,
3312 ssl->cli_id, ssl->cli_id_len,
3313 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003314 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003315
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003316 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3317
3318 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003319 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003320 int send_ret;
3321 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3322 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3323 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003324 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003325 * If the error is permanent we'll catch it later,
3326 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003327 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3328 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3329 (void) send_ret;
3330
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003331 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003332 }
3333
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003334 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003335 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003336 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003337 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003338 {
3339 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3340 return( ret );
3341 }
3342
3343 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003344 }
3345
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003346 return( ret );
3347}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003348#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003349
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003350static int ssl_check_record_type( uint8_t record_type )
3351{
3352 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3353 record_type != MBEDTLS_SSL_MSG_ALERT &&
3354 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3355 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3356 {
3357 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3358 }
3359
3360 return( 0 );
3361}
3362
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003363/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003364 * ContentType type;
3365 * ProtocolVersion version;
3366 * uint16 epoch; // DTLS only
3367 * uint48 sequence_number; // DTLS only
3368 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003369 *
3370 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003371 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003372 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3373 *
3374 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003375 * 1. proceed with the record if this function returns 0
3376 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3377 * 3. return CLIENT_RECONNECT if this function return that value
3378 * 4. drop the whole datagram if this function returns anything else.
3379 * Point 2 is needed when the peer is resending, and we have already received
3380 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003381 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003382static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003383 unsigned char *buf,
3384 size_t len,
3385 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003386{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003387 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003388
Hanno Beckere5e7e782019-07-11 12:29:35 +01003389 size_t const rec_hdr_type_offset = 0;
3390 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003391
Hanno Beckere5e7e782019-07-11 12:29:35 +01003392 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3393 rec_hdr_type_len;
3394 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003395
Hanno Beckere5e7e782019-07-11 12:29:35 +01003396 size_t const rec_hdr_ctr_len = 8;
3397#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003398 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003399 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3400 rec_hdr_version_len;
3401
Hanno Beckera0e20d02019-05-15 14:03:01 +01003402#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003403 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3404 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003405 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003406#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3407#endif /* MBEDTLS_SSL_PROTO_DTLS */
3408
3409 size_t rec_hdr_len_offset; /* To be determined */
3410 size_t const rec_hdr_len_len = 2;
3411
3412 /*
3413 * Check minimum lengths for record header.
3414 */
3415
3416#if defined(MBEDTLS_SSL_PROTO_DTLS)
3417 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3418 {
3419 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3420 }
3421 else
3422#endif /* MBEDTLS_SSL_PROTO_DTLS */
3423 {
3424 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3425 }
3426
3427 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3428 {
3429 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3430 (unsigned) len,
3431 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3432 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3433 }
3434
3435 /*
3436 * Parse and validate record content type
3437 */
3438
3439 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003440
3441 /* Check record content type */
3442#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3443 rec->cid_len = 0;
3444
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003445 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003446 ssl->conf->cid_len != 0 &&
3447 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003448 {
3449 /* Shift pointers to account for record header including CID
3450 * struct {
3451 * ContentType special_type = tls12_cid;
3452 * ProtocolVersion version;
3453 * uint16 epoch;
3454 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003455 * opaque cid[cid_length]; // Additional field compared to
3456 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003457 * uint16 length;
3458 * opaque enc_content[DTLSCiphertext.length];
3459 * } DTLSCiphertext;
3460 */
3461
3462 /* So far, we only support static CID lengths
3463 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003464 rec_hdr_cid_len = ssl->conf->cid_len;
3465 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003466
Hanno Beckere5e7e782019-07-11 12:29:35 +01003467 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003468 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003469 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3470 (unsigned) len,
3471 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003472 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003473 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003474
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003475 /* configured CID len is guaranteed at most 255, see
3476 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3477 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003478 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003479 }
3480 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003481#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003482 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003483 if( ssl_check_record_type( rec->type ) )
3484 {
Hanno Becker54229812019-07-12 14:40:00 +01003485 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3486 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003487 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3488 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003489 }
3490
Hanno Beckere5e7e782019-07-11 12:29:35 +01003491 /*
3492 * Parse and validate record version
3493 */
3494
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003495 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3496 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003497 tls_version = mbedtls_ssl_read_version( buf + rec_hdr_version_offset,
3498 ssl->conf->transport );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003499
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003500 if( tls_version > ssl->conf->max_tls_version )
Paul Bakker5121ce52009-01-03 21:22:43 +00003501 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS version mismatch" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003504 }
3505
Hanno Beckere5e7e782019-07-11 12:29:35 +01003506 /*
3507 * Parse/Copy record sequence number.
3508 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003509
Hanno Beckere5e7e782019-07-11 12:29:35 +01003510#if defined(MBEDTLS_SSL_PROTO_DTLS)
3511 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003512 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003513 /* Copy explicit record sequence number from input buffer. */
3514 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3515 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003516 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003517 else
3518#endif /* MBEDTLS_SSL_PROTO_DTLS */
3519 {
3520 /* Copy implicit record sequence number from SSL context structure. */
3521 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3522 }
Paul Bakker40e46942009-01-03 21:51:57 +00003523
Hanno Beckere5e7e782019-07-11 12:29:35 +01003524 /*
3525 * Parse record length.
3526 */
3527
Hanno Beckere5e7e782019-07-11 12:29:35 +01003528 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003529 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3530 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003531 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003532
Paul Elliott9f352112020-12-09 14:55:45 +00003533 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003534 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3535 rec->type, (unsigned)tls_version, rec->data_len ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003536
3537 rec->buf = buf;
3538 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003539
Hanno Beckerd417cc92019-07-26 08:20:27 +01003540 if( rec->data_len == 0 )
3541 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003543 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003544 * DTLS-related tests.
3545 * Check epoch before checking length constraint because
3546 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3547 * message gets duplicated before the corresponding Finished message,
3548 * the second ChangeCipherSpec should be discarded because it belongs
3549 * to an old epoch, but not because its length is shorter than
3550 * the minimum record length for packets using the new record transform.
3551 * Note that these two kinds of failures are handled differently,
3552 * as an unexpected record is silently skipped but an invalid
3553 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003554 */
3555#if defined(MBEDTLS_SSL_PROTO_DTLS)
3556 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3557 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003558 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003559
Hanno Becker955a5c92019-07-10 17:12:07 +01003560 /* Check that the datagram is large enough to contain a record
3561 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003562 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003563 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3565 (unsigned) len,
3566 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003567 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3568 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003569
Hanno Becker37cfe732019-07-10 17:20:01 +01003570 /* Records from other, non-matching epochs are silently discarded.
3571 * (The case of same-port Client reconnects must be considered in
3572 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003573 if( rec_epoch != ssl->in_epoch )
3574 {
3575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003576 "expected %u, received %lu",
3577 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003578
Hanno Becker552f7472019-07-19 10:59:12 +01003579 /* Records from the next epoch are considered for buffering
3580 * (concretely: early Finished messages). */
3581 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003582 {
Hanno Becker552f7472019-07-19 10:59:12 +01003583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3584 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003585 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003586
Hanno Becker2fddd372019-07-10 14:37:41 +01003587 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003588 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003589#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003590 /* For records from the correct epoch, check whether their
3591 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003592 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3593 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003594 {
3595 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3596 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3597 }
3598#endif
3599 }
3600#endif /* MBEDTLS_SSL_PROTO_DTLS */
3601
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003602 return( 0 );
3603}
Paul Bakker5121ce52009-01-03 21:22:43 +00003604
Paul Bakker5121ce52009-01-03 21:22:43 +00003605
Hanno Becker2fddd372019-07-10 14:37:41 +01003606#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3607static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3608{
3609 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3610
3611 /*
3612 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3613 * access the first byte of record content (handshake type), as we
3614 * have an active transform (possibly iv_len != 0), so use the
3615 * fact that the record header len is 13 instead.
3616 */
3617 if( rec_epoch == 0 &&
3618 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Paul Elliott27b0d942022-03-18 21:55:32 +00003619 mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003620 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3621 ssl->in_left > 13 &&
3622 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3623 {
3624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3625 "from the same port" ) );
3626 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003627 }
3628
3629 return( 0 );
3630}
Hanno Becker2fddd372019-07-10 14:37:41 +01003631#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003632
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003633/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003634 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003635 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003636static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3637 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003638{
3639 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003642 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003643
Ronald Cron7e38cba2021-11-24 12:43:39 +01003644 /*
3645 * In TLS 1.3, always treat ChangeCipherSpec records
3646 * as unencrypted. The only thing we do with them is
3647 * check the length and content and ignore them.
3648 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003649#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003650 if( ssl->transform_in != NULL &&
Glenn Strauss07c64162022-03-14 12:34:51 -04003651 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01003652 {
3653 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3654 done = 1;
3655 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003656#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003657
Paul Bakker48916f92012-09-16 19:57:18 +00003658 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003659 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003660 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003661
Hanno Beckera18d1322018-01-03 14:27:32 +00003662 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003663 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003664 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003665 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003666
Hanno Beckera0e20d02019-05-15 14:03:01 +01003667#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003668 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3669 ssl->conf->ignore_unexpected_cid
3670 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3671 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003672 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003673 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003674 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003675#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003676
Paul Bakker5121ce52009-01-03 21:22:43 +00003677 return( ret );
3678 }
3679
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003680 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003681 {
3682 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003683 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003684 }
3685
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003686 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003687 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003688
Hanno Beckera0e20d02019-05-15 14:03:01 +01003689#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003690 /* We have already checked the record content type
3691 * in ssl_parse_record_header(), failing or silently
3692 * dropping the record in the case of an unknown type.
3693 *
3694 * Since with the use of CIDs, the record content type
3695 * might change during decryption, re-check the record
3696 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003697 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003698 {
3699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3700 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3701 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003702#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003703
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003704 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003705 {
3706#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003707 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003708 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003709 {
3710 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3712 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3713 }
3714#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3715
3716 ssl->nb_zero++;
3717
3718 /*
3719 * Three or more empty messages may be a DoS attack
3720 * (excessive CPU consumption).
3721 */
3722 if( ssl->nb_zero > 3 )
3723 {
3724 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003725 "messages, possible DoS attack" ) );
3726 /* Treat the records as if they were not properly authenticated,
3727 * thereby failing the connection if we see more than allowed
3728 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003729 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3730 }
3731 }
3732 else
3733 ssl->nb_zero = 0;
3734
3735#if defined(MBEDTLS_SSL_PROTO_DTLS)
3736 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3737 {
3738 ; /* in_ctr read from peer, not maintained internally */
3739 }
3740 else
3741#endif
3742 {
3743 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003744 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3745 i > mbedtls_ssl_ep_len( ssl ); i-- )
3746 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003747 if( ++ssl->in_ctr[i - 1] != 0 )
3748 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003749 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003750
3751 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003752 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003753 {
3754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3755 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3756 }
3757 }
3758
Paul Bakker5121ce52009-01-03 21:22:43 +00003759 }
3760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003761#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003762 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003764 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003765 }
3766#endif
3767
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003768 /* Check actual (decrypted) record content length against
3769 * configured maximum. */
3770 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3771 {
3772 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3773 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3774 }
3775
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003776 return( 0 );
3777}
3778
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003779/*
3780 * Read a record.
3781 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003782 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3783 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3784 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003785 */
Hanno Becker1097b342018-08-15 14:09:41 +01003786
3787/* Helper functions for mbedtls_ssl_read_record(). */
3788static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003789static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3790static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003791
Hanno Becker327c93b2018-08-15 13:56:18 +01003792int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003793 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003794{
Janos Follath865b3eb2019-12-16 11:46:15 +00003795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003798
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003799 if( ssl->keep_current_message == 0 )
3800 {
3801 do {
Simon Butcher99000142016-10-13 17:21:01 +01003802
Hanno Becker26994592018-08-15 14:14:59 +01003803 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003804 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003805 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003806
Hanno Beckere74d5562018-08-15 14:26:08 +01003807 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003808 {
Hanno Becker40f50842018-08-15 14:48:01 +01003809#if defined(MBEDTLS_SSL_PROTO_DTLS)
3810 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003811
Hanno Becker40f50842018-08-15 14:48:01 +01003812 /* We only check for buffered messages if the
3813 * current datagram is fully consumed. */
3814 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003815 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003816 {
Hanno Becker40f50842018-08-15 14:48:01 +01003817 if( ssl_load_buffered_message( ssl ) == 0 )
3818 have_buffered = 1;
3819 }
3820
3821 if( have_buffered == 0 )
3822#endif /* MBEDTLS_SSL_PROTO_DTLS */
3823 {
3824 ret = ssl_get_next_record( ssl );
3825 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3826 continue;
3827
3828 if( ret != 0 )
3829 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003830 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003831 return( ret );
3832 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003833 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003834 }
3835
3836 ret = mbedtls_ssl_handle_message_type( ssl );
3837
Hanno Becker40f50842018-08-15 14:48:01 +01003838#if defined(MBEDTLS_SSL_PROTO_DTLS)
3839 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3840 {
3841 /* Buffer future message */
3842 ret = ssl_buffer_message( ssl );
3843 if( ret != 0 )
3844 return( ret );
3845
3846 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3847 }
3848#endif /* MBEDTLS_SSL_PROTO_DTLS */
3849
Hanno Becker90333da2017-10-10 11:27:13 +01003850 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3851 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003852
3853 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003854 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003855 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003856 return( ret );
3857 }
3858
Hanno Becker327c93b2018-08-15 13:56:18 +01003859 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003860 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003861 {
3862 mbedtls_ssl_update_handshake_status( ssl );
3863 }
Simon Butcher99000142016-10-13 17:21:01 +01003864 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003865 else
Simon Butcher99000142016-10-13 17:21:01 +01003866 {
Hanno Becker02f59072018-08-15 14:00:24 +01003867 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003868 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003869 }
3870
3871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3872
3873 return( 0 );
3874}
3875
Hanno Becker40f50842018-08-15 14:48:01 +01003876#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003877static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003878{
Hanno Becker40f50842018-08-15 14:48:01 +01003879 if( ssl->in_left > ssl->next_record_offset )
3880 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003881
Hanno Becker40f50842018-08-15 14:48:01 +01003882 return( 0 );
3883}
3884
3885static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3886{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003887 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003888 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003889 int ret = 0;
3890
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003891 if( hs == NULL )
3892 return( -1 );
3893
Hanno Beckere00ae372018-08-20 09:39:42 +01003894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3895
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003896 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3897 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3898 {
3899 /* Check if we have seen a ChangeCipherSpec before.
3900 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003901 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003902 {
3903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3904 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003905 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003906 }
3907
Hanno Becker39b8bc92018-08-28 17:17:13 +01003908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003909 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3910 ssl->in_msglen = 1;
3911 ssl->in_msg[0] = 1;
3912
3913 /* As long as they are equal, the exact value doesn't matter. */
3914 ssl->in_left = 0;
3915 ssl->next_record_offset = 0;
3916
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003917 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003918 goto exit;
3919 }
Hanno Becker37f95322018-08-16 13:55:32 +01003920
Hanno Beckerb8f50142018-08-28 10:01:34 +01003921#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003922 /* Debug only */
3923 {
3924 unsigned offset;
3925 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3926 {
3927 hs_buf = &hs->buffering.hs[offset];
3928 if( hs_buf->is_valid == 1 )
3929 {
3930 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3931 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003932 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003933 }
3934 }
3935 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003936#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003937
3938 /* Check if we have buffered and/or fully reassembled the
3939 * next handshake message. */
3940 hs_buf = &hs->buffering.hs[0];
3941 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3942 {
3943 /* Synthesize a record containing the buffered HS message. */
3944 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3945 ( hs_buf->data[2] << 8 ) |
3946 hs_buf->data[3];
3947
3948 /* Double-check that we haven't accidentally buffered
3949 * a message that doesn't fit into the input buffer. */
3950 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3951 {
3952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3953 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3954 }
3955
3956 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3957 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3958 hs_buf->data, msg_len + 12 );
3959
3960 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3961 ssl->in_hslen = msg_len + 12;
3962 ssl->in_msglen = msg_len + 12;
3963 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3964
3965 ret = 0;
3966 goto exit;
3967 }
3968 else
3969 {
3970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3971 hs->in_msg_seq ) );
3972 }
3973
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003974 ret = -1;
3975
3976exit:
3977
3978 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3979 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003980}
3981
Hanno Beckera02b0b42018-08-21 17:20:27 +01003982static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3983 size_t desired )
3984{
3985 int offset;
3986 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003987 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3988 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003989
Hanno Becker01315ea2018-08-21 17:22:17 +01003990 /* Get rid of future records epoch first, if such exist. */
3991 ssl_free_buffered_record( ssl );
3992
3993 /* Check if we have enough space available now. */
3994 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3995 hs->buffering.total_bytes_buffered ) )
3996 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003997 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003998 return( 0 );
3999 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004000
Hanno Becker4f432ad2018-08-28 10:02:32 +01004001 /* We don't have enough space to buffer the next expected handshake
4002 * message. Remove buffers used for future messages to gain space,
4003 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004004 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4005 offset >= 0; offset-- )
4006 {
4007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4008 offset ) );
4009
Hanno Beckerb309b922018-08-23 13:18:05 +01004010 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004011
4012 /* Check if we have enough space available now. */
4013 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4014 hs->buffering.total_bytes_buffered ) )
4015 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004017 return( 0 );
4018 }
4019 }
4020
4021 return( -1 );
4022}
4023
Hanno Becker40f50842018-08-15 14:48:01 +01004024static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4025{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004026 int ret = 0;
4027 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4028
4029 if( hs == NULL )
4030 return( 0 );
4031
4032 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4033
4034 switch( ssl->in_msgtype )
4035 {
4036 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004038
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004039 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004040 break;
4041
4042 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004043 {
4044 unsigned recv_msg_seq_offset;
4045 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4046 mbedtls_ssl_hs_buffer *hs_buf;
4047 size_t msg_len = ssl->in_hslen - 12;
4048
4049 /* We should never receive an old handshake
4050 * message - double-check nonetheless. */
4051 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4052 {
4053 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4054 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4055 }
4056
4057 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4058 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4059 {
4060 /* Silently ignore -- message too far in the future */
4061 MBEDTLS_SSL_DEBUG_MSG( 2,
4062 ( "Ignore future HS message with sequence number %u, "
4063 "buffering window %u - %u",
4064 recv_msg_seq, ssl->handshake->in_msg_seq,
4065 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4066
4067 goto exit;
4068 }
4069
4070 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4071 recv_msg_seq, recv_msg_seq_offset ) );
4072
4073 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4074
4075 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004076 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004077 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004078 size_t reassembly_buf_sz;
4079
Hanno Becker37f95322018-08-16 13:55:32 +01004080 hs_buf->is_fragmented =
4081 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4082
4083 /* We copy the message back into the input buffer
4084 * after reassembly, so check that it's not too large.
4085 * This is an implementation-specific limitation
4086 * and not one from the standard, hence it is not
4087 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004088 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004089 {
4090 /* Ignore message */
4091 goto exit;
4092 }
4093
Hanno Beckere0b150f2018-08-21 15:51:03 +01004094 /* Check if we have enough space to buffer the message. */
4095 if( hs->buffering.total_bytes_buffered >
4096 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4097 {
4098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4099 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4100 }
4101
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004102 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4103 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004104
4105 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4106 hs->buffering.total_bytes_buffered ) )
4107 {
4108 if( recv_msg_seq_offset > 0 )
4109 {
4110 /* If we can't buffer a future message because
4111 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4113 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4114 " (already %" MBEDTLS_PRINTF_SIZET
4115 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004116 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004117 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004118 goto exit;
4119 }
Hanno Beckere1801392018-08-21 16:51:05 +01004120 else
4121 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4123 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4124 " (already %" MBEDTLS_PRINTF_SIZET
4125 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004126 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004127 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004128 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004129
Hanno Beckera02b0b42018-08-21 17:20:27 +01004130 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004131 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4133 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4134 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4135 " (already %" MBEDTLS_PRINTF_SIZET
4136 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004137 msg_len,
4138 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004139 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004140 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004141 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4142 goto exit;
4143 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004144 }
4145
Paul Elliottd48d5c62021-01-07 14:47:05 +00004146 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004147 msg_len ) );
4148
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004149 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4150 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004151 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004152 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004153 goto exit;
4154 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004155 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004156
4157 /* Prepare final header: copy msg_type, length and message_seq,
4158 * then add standardised fragment_offset and fragment_length */
4159 memcpy( hs_buf->data, ssl->in_msg, 6 );
4160 memset( hs_buf->data + 6, 0, 3 );
4161 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4162
4163 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004164
4165 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004166 }
4167 else
4168 {
4169 /* Make sure msg_type and length are consistent */
4170 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4171 {
4172 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4173 /* Ignore */
4174 goto exit;
4175 }
4176 }
4177
Hanno Becker4422bbb2018-08-20 09:40:19 +01004178 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004179 {
4180 size_t frag_len, frag_off;
4181 unsigned char * const msg = hs_buf->data + 12;
4182
4183 /*
4184 * Check and copy current fragment
4185 */
4186
4187 /* Validation of header fields already done in
4188 * mbedtls_ssl_prepare_handshake_record(). */
4189 frag_off = ssl_get_hs_frag_off( ssl );
4190 frag_len = ssl_get_hs_frag_len( ssl );
4191
Paul Elliottd48d5c62021-01-07 14:47:05 +00004192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4193 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004194 frag_off, frag_len ) );
4195 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4196
4197 if( hs_buf->is_fragmented )
4198 {
4199 unsigned char * const bitmask = msg + msg_len;
4200 ssl_bitmask_set( bitmask, frag_off, frag_len );
4201 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4202 msg_len ) == 0 );
4203 }
4204 else
4205 {
4206 hs_buf->is_complete = 1;
4207 }
4208
4209 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4210 hs_buf->is_complete ? "" : "not yet " ) );
4211 }
4212
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004213 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004214 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004215
4216 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004217 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004218 break;
4219 }
4220
4221exit:
4222
4223 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4224 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004225}
4226#endif /* MBEDTLS_SSL_PROTO_DTLS */
4227
Hanno Becker1097b342018-08-15 14:09:41 +01004228static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004229{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004230 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004231 * Consume last content-layer message and potentially
4232 * update in_msglen which keeps track of the contents'
4233 * consumption state.
4234 *
4235 * (1) Handshake messages:
4236 * Remove last handshake message, move content
4237 * and adapt in_msglen.
4238 *
4239 * (2) Alert messages:
4240 * Consume whole record content, in_msglen = 0.
4241 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004242 * (3) Change cipher spec:
4243 * Consume whole record content, in_msglen = 0.
4244 *
4245 * (4) Application data:
4246 * Don't do anything - the record layer provides
4247 * the application data as a stream transport
4248 * and consumes through mbedtls_ssl_read only.
4249 *
4250 */
4251
4252 /* Case (1): Handshake messages */
4253 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004254 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004255 /* Hard assertion to be sure that no application data
4256 * is in flight, as corrupting ssl->in_msglen during
4257 * ssl->in_offt != NULL is fatal. */
4258 if( ssl->in_offt != NULL )
4259 {
4260 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4261 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4262 }
4263
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004264 /*
4265 * Get next Handshake message in the current record
4266 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004267
Hanno Becker4a810fb2017-05-24 16:27:30 +01004268 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004269 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004270 * current handshake content: If DTLS handshake
4271 * fragmentation is used, that's the fragment
4272 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004273 * size here is faulty and should be changed at
4274 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004275 * (2) While it doesn't seem to cause problems, one
4276 * has to be very careful not to assume that in_hslen
4277 * is always <= in_msglen in a sensible communication.
4278 * Again, it's wrong for DTLS handshake fragmentation.
4279 * The following check is therefore mandatory, and
4280 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004281 * Additionally, ssl->in_hslen might be arbitrarily out of
4282 * bounds after handling a DTLS message with an unexpected
4283 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004284 */
4285 if( ssl->in_hslen < ssl->in_msglen )
4286 {
4287 ssl->in_msglen -= ssl->in_hslen;
4288 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4289 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004290
Hanno Becker4a810fb2017-05-24 16:27:30 +01004291 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4292 ssl->in_msg, ssl->in_msglen );
4293 }
4294 else
4295 {
4296 ssl->in_msglen = 0;
4297 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004298
Hanno Becker4a810fb2017-05-24 16:27:30 +01004299 ssl->in_hslen = 0;
4300 }
4301 /* Case (4): Application data */
4302 else if( ssl->in_offt != NULL )
4303 {
4304 return( 0 );
4305 }
4306 /* Everything else (CCS & Alerts) */
4307 else
4308 {
4309 ssl->in_msglen = 0;
4310 }
4311
Hanno Becker1097b342018-08-15 14:09:41 +01004312 return( 0 );
4313}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004314
Hanno Beckere74d5562018-08-15 14:26:08 +01004315static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4316{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004317 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004318 return( 1 );
4319
4320 return( 0 );
4321}
4322
Hanno Becker5f066e72018-08-16 14:56:31 +01004323#if defined(MBEDTLS_SSL_PROTO_DTLS)
4324
4325static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4326{
4327 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4328 if( hs == NULL )
4329 return;
4330
Hanno Becker01315ea2018-08-21 17:22:17 +01004331 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004332 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004333 hs->buffering.total_bytes_buffered -=
4334 hs->buffering.future_record.len;
4335
4336 mbedtls_free( hs->buffering.future_record.data );
4337 hs->buffering.future_record.data = NULL;
4338 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004339}
4340
4341static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4342{
4343 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4344 unsigned char * rec;
4345 size_t rec_len;
4346 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004347#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4348 size_t in_buf_len = ssl->in_buf_len;
4349#else
4350 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4351#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004352 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4353 return( 0 );
4354
4355 if( hs == NULL )
4356 return( 0 );
4357
Hanno Becker5f066e72018-08-16 14:56:31 +01004358 rec = hs->buffering.future_record.data;
4359 rec_len = hs->buffering.future_record.len;
4360 rec_epoch = hs->buffering.future_record.epoch;
4361
4362 if( rec == NULL )
4363 return( 0 );
4364
Hanno Becker4cb782d2018-08-20 11:19:05 +01004365 /* Only consider loading future records if the
4366 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004367 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004368 return( 0 );
4369
Hanno Becker5f066e72018-08-16 14:56:31 +01004370 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4371
4372 if( rec_epoch != ssl->in_epoch )
4373 {
4374 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4375 goto exit;
4376 }
4377
4378 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4379
4380 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004381 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004382 {
4383 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4384 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4385 }
4386
4387 memcpy( ssl->in_hdr, rec, rec_len );
4388 ssl->in_left = rec_len;
4389 ssl->next_record_offset = 0;
4390
4391 ssl_free_buffered_record( ssl );
4392
4393exit:
4394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4395 return( 0 );
4396}
4397
Hanno Becker519f15d2019-07-11 12:43:20 +01004398static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4399 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004400{
4401 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004402
4403 /* Don't buffer future records outside handshakes. */
4404 if( hs == NULL )
4405 return( 0 );
4406
4407 /* Only buffer handshake records (we are only interested
4408 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004409 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004410 return( 0 );
4411
4412 /* Don't buffer more than one future epoch record. */
4413 if( hs->buffering.future_record.data != NULL )
4414 return( 0 );
4415
Hanno Becker01315ea2018-08-21 17:22:17 +01004416 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004417 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004418 hs->buffering.total_bytes_buffered ) )
4419 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004420 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4421 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4422 " (already %" MBEDTLS_PRINTF_SIZET
4423 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004424 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004425 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004426 return( 0 );
4427 }
4428
Hanno Becker5f066e72018-08-16 14:56:31 +01004429 /* Buffer record */
4430 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004431 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004432 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004433
4434 /* ssl_parse_record_header() only considers records
4435 * of the next epoch as candidates for buffering. */
4436 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004437 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004438
4439 hs->buffering.future_record.data =
4440 mbedtls_calloc( 1, hs->buffering.future_record.len );
4441 if( hs->buffering.future_record.data == NULL )
4442 {
4443 /* If we run out of RAM trying to buffer a
4444 * record from the next epoch, just ignore. */
4445 return( 0 );
4446 }
4447
Hanno Becker519f15d2019-07-11 12:43:20 +01004448 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004449
Hanno Becker519f15d2019-07-11 12:43:20 +01004450 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004451 return( 0 );
4452}
4453
4454#endif /* MBEDTLS_SSL_PROTO_DTLS */
4455
Hanno Beckere74d5562018-08-15 14:26:08 +01004456static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004457{
Janos Follath865b3eb2019-12-16 11:46:15 +00004458 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004459 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004460
Hanno Becker5f066e72018-08-16 14:56:31 +01004461#if defined(MBEDTLS_SSL_PROTO_DTLS)
4462 /* We might have buffered a future record; if so,
4463 * and if the epoch matches now, load it.
4464 * On success, this call will set ssl->in_left to
4465 * the length of the buffered record, so that
4466 * the calls to ssl_fetch_input() below will
4467 * essentially be no-ops. */
4468 ret = ssl_load_buffered_record( ssl );
4469 if( ret != 0 )
4470 return( ret );
4471#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004472
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004473 /* Ensure that we have enough space available for the default form
4474 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4475 * with no space for CIDs counted in). */
4476 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4477 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004478 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004479 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004480 return( ret );
4481 }
4482
Hanno Beckere5e7e782019-07-11 12:29:35 +01004483 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4484 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004485 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004486#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004487 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004488 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004489 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4490 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004491 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004492 if( ret != 0 )
4493 return( ret );
4494
4495 /* Fall through to handling of unexpected records */
4496 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4497 }
4498
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004499 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4500 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004501#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004502 /* Reset in pointers to default state for TLS/DTLS records,
4503 * assuming no CID and no offset between record content and
4504 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004505 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004506
Hanno Becker7ae20e02019-07-12 08:33:49 +01004507 /* Setup internal message pointers from record structure. */
4508 ssl->in_msgtype = rec.type;
4509#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4510 ssl->in_len = ssl->in_cid + rec.cid_len;
4511#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4512 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4513 ssl->in_msglen = rec.data_len;
4514
Hanno Becker2fddd372019-07-10 14:37:41 +01004515 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004516 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004517 if( ret != 0 )
4518 return( ret );
4519#endif
4520
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004521 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004522 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004523
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004524 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4525 "(header)" ) );
4526 }
4527 else
4528 {
4529 /* Skip invalid record and the rest of the datagram */
4530 ssl->next_record_offset = 0;
4531 ssl->in_left = 0;
4532
4533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4534 "(header)" ) );
4535 }
4536
4537 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004538 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004539 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004540 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004541#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004542 {
4543 return( ret );
4544 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004545 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004548 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004549 {
Hanno Beckera8814792019-07-10 15:01:45 +01004550 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004551 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004552 if( ssl->next_record_offset < ssl->in_left )
4553 {
4554 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4555 }
4556 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004557 else
4558#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004559 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004560 /*
4561 * Fetch record contents from underlying transport.
4562 */
Hanno Beckera3175662019-07-11 12:50:29 +01004563 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004564 if( ret != 0 )
4565 {
4566 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4567 return( ret );
4568 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004569
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004570 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004571 }
4572
4573 /*
4574 * Decrypt record contents.
4575 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004576
Hanno Beckerfdf66042019-07-11 13:07:45 +01004577 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004578 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004580 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004581 {
4582 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004583 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004584 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004585 /* Except when waiting for Finished as a bad mac here
4586 * probably means something went wrong in the handshake
4587 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4588 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4589 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4590 {
4591#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4592 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4593 {
4594 mbedtls_ssl_send_alert_message( ssl,
4595 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4596 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4597 }
4598#endif
4599 return( ret );
4600 }
4601
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004602 if( ssl->conf->badmac_limit != 0 &&
4603 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004604 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4606 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004607 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004608
Hanno Becker4a810fb2017-05-24 16:27:30 +01004609 /* As above, invalid records cause
4610 * dismissal of the whole datagram. */
4611
4612 ssl->next_record_offset = 0;
4613 ssl->in_left = 0;
4614
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004616 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004617 }
4618
4619 return( ret );
4620 }
4621 else
4622#endif
4623 {
4624 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004625#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4626 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004627 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004628 mbedtls_ssl_send_alert_message( ssl,
4629 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4630 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004631 }
4632#endif
4633 return( ret );
4634 }
4635 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004636
Hanno Becker44d89b22019-07-12 09:40:44 +01004637
4638 /* Reset in pointers to default state for TLS/DTLS records,
4639 * assuming no CID and no offset between record content and
4640 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004641 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004642#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4643 ssl->in_len = ssl->in_cid + rec.cid_len;
4644#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004645 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004646
Hanno Becker8685c822019-07-12 09:37:30 +01004647 /* The record content type may change during decryption,
4648 * so re-read it. */
4649 ssl->in_msgtype = rec.type;
4650 /* Also update the input buffer, because unfortunately
4651 * the server-side ssl_parse_client_hello() reparses the
4652 * record header when receiving a ClientHello initiating
4653 * a renegotiation. */
4654 ssl->in_hdr[0] = rec.type;
4655 ssl->in_msg = rec.buf + rec.data_offset;
4656 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004657 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004658
Simon Butcher99000142016-10-13 17:21:01 +01004659 return( 0 );
4660}
4661
4662int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4663{
Janos Follath865b3eb2019-12-16 11:46:15 +00004664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004665
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004666 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004667 * Handle particular types of records
4668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004669 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004670 {
Simon Butcher99000142016-10-13 17:21:01 +01004671 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4672 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004673 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004674 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004675 }
4676
Hanno Beckere678eaa2018-08-21 14:57:46 +01004677 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004678 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004679 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004680 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004681 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004682 ssl->in_msglen ) );
4683 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004684 }
4685
Hanno Beckere678eaa2018-08-21 14:57:46 +01004686 if( ssl->in_msg[0] != 1 )
4687 {
4688 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4689 ssl->in_msg[0] ) );
4690 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4691 }
4692
4693#if defined(MBEDTLS_SSL_PROTO_DTLS)
4694 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4695 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4696 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4697 {
4698 if( ssl->handshake == NULL )
4699 {
4700 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4701 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4702 }
4703
4704 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4705 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4706 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004707#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004708
Ronald Cron6f135e12021-12-08 16:57:54 +01004709#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004710 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01004711 {
4712#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4713 MBEDTLS_SSL_DEBUG_MSG( 1,
4714 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4715 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4716#else
4717 MBEDTLS_SSL_DEBUG_MSG( 1,
4718 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4719 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4720#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4721 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004722#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004723 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004726 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004727 if( ssl->in_msglen != 2 )
4728 {
4729 /* Note: Standard allows for more than one 2 byte alert
4730 to be packed in a single message, but Mbed TLS doesn't
4731 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004732 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004733 ssl->in_msglen ) );
4734 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4735 }
4736
Paul Elliott9f352112020-12-09 14:55:45 +00004737 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004738 ssl->in_msg[0], ssl->in_msg[1] ) );
4739
4740 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004741 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004742 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004743 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004744 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004746 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004748 }
4749
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4751 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4754 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004755 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004756
4757#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4758 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4759 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4760 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004762 /* Will be handled when trying to parse ServerHello */
4763 return( 0 );
4764 }
4765#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004766 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004767 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004768 }
4769
Hanno Beckerc76c6192017-06-06 10:03:17 +01004770#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004771 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004772 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004773 /* Drop unexpected ApplicationData records,
4774 * except at the beginning of renegotiations */
4775 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004776 mbedtls_ssl_is_handshake_over( ssl ) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004777#if defined(MBEDTLS_SSL_RENEGOTIATION)
4778 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4779 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004780#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004781 )
4782 {
4783 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4784 return( MBEDTLS_ERR_SSL_NON_FATAL );
4785 }
4786
4787 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004788 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker37ae9522019-05-03 16:54:26 +01004789 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004790 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004791 }
4792 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004793#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004794
Paul Bakker5121ce52009-01-03 21:22:43 +00004795 return( 0 );
4796}
4797
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004799{
irwir6c0da642019-09-26 21:07:41 +03004800 return( mbedtls_ssl_send_alert_message( ssl,
4801 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4802 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004803}
4804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004805int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004806 unsigned char level,
4807 unsigned char message )
4808{
Janos Follath865b3eb2019-12-16 11:46:15 +00004809 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004810
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004811 if( ssl == NULL || ssl->conf == NULL )
4812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4813
Hanno Becker5e18f742018-08-06 11:35:16 +01004814 if( ssl->out_left != 0 )
4815 return( mbedtls_ssl_flush_output( ssl ) );
4816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004818 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004820 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004821 ssl->out_msglen = 2;
4822 ssl->out_msg[0] = level;
4823 ssl->out_msg[1] = message;
4824
Gabor Mezei96ec8312022-06-22 13:17:28 +02004825 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH,
4826 SSL_ENCRYPT_RECORD ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004827 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004828 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004829 return( ret );
4830 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004832
4833 return( 0 );
4834}
4835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004837{
Janos Follath865b3eb2019-12-16 11:46:15 +00004838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004842 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004843 ssl->out_msglen = 1;
4844 ssl->out_msg[0] = 1;
4845
Paul Bakker5121ce52009-01-03 21:22:43 +00004846 ssl->state++;
4847
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004848 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004849 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004850 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004851 return( ret );
4852 }
4853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004854 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004855
4856 return( 0 );
4857}
4858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004859int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004860{
Janos Follath865b3eb2019-12-16 11:46:15 +00004861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004862
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004864
Hanno Becker327c93b2018-08-15 13:56:18 +01004865 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004866 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004867 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004868 return( ret );
4869 }
4870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004871 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004872 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004874 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4875 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004876 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004877 }
4878
Hanno Beckere678eaa2018-08-21 14:57:46 +01004879 /* CCS records are only accepted if they have length 1 and content '1',
4880 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004881
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004882 /*
4883 * Switch to our negotiated transform and session parameters for inbound
4884 * data.
4885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004886 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004887 ssl->transform_in = ssl->transform_negotiate;
4888 ssl->session_in = ssl->session_negotiate;
4889
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004890#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004891 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004892 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004893#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004894 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004895#endif
4896
4897 /* Increment epoch */
4898 if( ++ssl->in_epoch == 0 )
4899 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004900 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004901 /* This is highly unlikely to happen for legitimate reasons, so
4902 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004903 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004904 }
4905 }
4906 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004907#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004908 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004909
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004910 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004911
Paul Bakker5121ce52009-01-03 21:22:43 +00004912 ssl->state++;
4913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004915
4916 return( 0 );
4917}
4918
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004919/* Once ssl->out_hdr as the address of the beginning of the
4920 * next outgoing record is set, deduce the other pointers.
4921 *
4922 * Note: For TLS, we save the implicit record sequence number
4923 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4924 * and the caller has to make sure there's space for this.
4925 */
4926
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004927static size_t ssl_transform_get_explicit_iv_len(
4928 mbedtls_ssl_transform const *transform )
4929{
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004930 return( transform->ivlen - transform->fixed_ivlen );
4931}
4932
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004933void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4934 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004935{
4936#if defined(MBEDTLS_SSL_PROTO_DTLS)
4937 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4938 {
4939 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004940#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004941 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004942 ssl->out_len = ssl->out_cid;
4943 if( transform != NULL )
4944 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004945#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004946 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004947#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004948 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004949 }
4950 else
4951#endif
4952 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004953 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004954#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004955 ssl->out_cid = ssl->out_len;
4956#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004957 ssl->out_iv = ssl->out_hdr + 5;
4958 }
4959
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004960 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004961 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004962 if( transform != NULL )
4963 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004964}
4965
4966/* Once ssl->in_hdr as the address of the beginning of the
4967 * next incoming record is set, deduce the other pointers.
4968 *
4969 * Note: For TLS, we save the implicit record sequence number
4970 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4971 * and the caller has to make sure there's space for this.
4972 */
4973
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004974void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004975{
Hanno Becker79594fd2019-05-08 09:38:41 +01004976 /* This function sets the pointers to match the case
4977 * of unprotected TLS/DTLS records, with both ssl->in_iv
4978 * and ssl->in_msg pointing to the beginning of the record
4979 * content.
4980 *
4981 * When decrypting a protected record, ssl->in_msg
4982 * will be shifted to point to the beginning of the
4983 * record plaintext.
4984 */
4985
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004986#if defined(MBEDTLS_SSL_PROTO_DTLS)
4987 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4988 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004989 /* This sets the header pointers to match records
4990 * without CID. When we receive a record containing
4991 * a CID, the fields are shifted accordingly in
4992 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004993 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004994#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004995 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004996 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004997#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004998 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004999#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005000 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005001 }
5002 else
5003#endif
5004 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005005 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005006 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005007#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005008 ssl->in_cid = ssl->in_len;
5009#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005010 ssl->in_iv = ssl->in_hdr + 5;
5011 }
5012
Hanno Becker79594fd2019-05-08 09:38:41 +01005013 /* This will be adjusted at record decryption time. */
5014 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005015}
5016
Paul Bakker5121ce52009-01-03 21:22:43 +00005017/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005018 * Setup an SSL context
5019 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005020
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005021void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005022{
5023 /* Set the incoming and outgoing record pointers. */
5024#if defined(MBEDTLS_SSL_PROTO_DTLS)
5025 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5026 {
5027 ssl->out_hdr = ssl->out_buf;
5028 ssl->in_hdr = ssl->in_buf;
5029 }
5030 else
5031#endif /* MBEDTLS_SSL_PROTO_DTLS */
5032 {
Hanno Becker12078f42021-03-02 15:28:41 +00005033 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005034 ssl->out_hdr = ssl->out_buf + 8;
5035 ssl->in_hdr = ssl->in_buf + 8;
5036 }
5037
5038 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005039 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5040 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005041}
5042
Paul Bakker5121ce52009-01-03 21:22:43 +00005043/*
5044 * SSL get accessors
5045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005046size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005047{
5048 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5049}
5050
Hanno Becker8b170a02017-10-10 11:51:19 +01005051int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5052{
5053 /*
5054 * Case A: We're currently holding back
5055 * a message for further processing.
5056 */
5057
5058 if( ssl->keep_current_message == 1 )
5059 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005060 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005061 return( 1 );
5062 }
5063
5064 /*
5065 * Case B: Further records are pending in the current datagram.
5066 */
5067
5068#if defined(MBEDTLS_SSL_PROTO_DTLS)
5069 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5070 ssl->in_left > ssl->next_record_offset )
5071 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005072 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005073 return( 1 );
5074 }
5075#endif /* MBEDTLS_SSL_PROTO_DTLS */
5076
5077 /*
5078 * Case C: A handshake message is being processed.
5079 */
5080
Hanno Becker8b170a02017-10-10 11:51:19 +01005081 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5082 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005083 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005084 return( 1 );
5085 }
5086
5087 /*
5088 * Case D: An application data message is being processed
5089 */
5090 if( ssl->in_offt != NULL )
5091 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005092 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005093 return( 1 );
5094 }
5095
5096 /*
5097 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005098 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005099 * we implement support for multiple alerts in single records.
5100 */
5101
5102 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5103 return( 0 );
5104}
5105
Paul Bakker43ca69c2011-01-15 17:35:19 +00005106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005107int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005108{
Hanno Becker3136ede2018-08-17 15:28:19 +01005109 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005111 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005112#if defined(MBEDTLS_USE_PSA_CRYPTO)
5113 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5114 psa_key_type_t key_type;
5115#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005116
Hanno Becker5903de42019-05-03 14:46:38 +01005117 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5118
Hanno Becker78640902018-08-13 16:35:15 +01005119 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005120 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005121
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005122
5123#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005124 if ( transform->psa_alg == PSA_ALG_GCM ||
5125 transform->psa_alg == PSA_ALG_CCM ||
5126 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5127 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005128 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005129 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005130 transform_expansion = transform->minlen;
5131 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005132 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005133 {
5134 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5135 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005136
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005137 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005138
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005139 /* Expansion due to the addition of the MAC. */
5140 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005141
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005142 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005143 * Theoretically up to 256 bytes, but we never use
5144 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005145 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005146
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005147 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005148 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005149#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005150 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005151#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005152 }
5153 else
5154 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005156 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005157 }
5158#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005159 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005160 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005161 case MBEDTLS_MODE_GCM:
5162 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005163 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005164 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005165 transform_expansion = transform->minlen;
5166 break;
5167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005168 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005169
5170 block_size = mbedtls_cipher_get_block_size(
5171 &transform->cipher_ctx_enc );
5172
Hanno Becker3136ede2018-08-17 15:28:19 +01005173 /* Expansion due to the addition of the MAC. */
5174 transform_expansion += transform->maclen;
5175
5176 /* Expansion due to the addition of CBC padding;
5177 * Theoretically up to 256 bytes, but we never use
5178 * more than the block size of the underlying cipher. */
5179 transform_expansion += block_size;
5180
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005181 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005182 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005183#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005184 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005185#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005186
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005187 break;
5188
5189 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005191 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005192 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005193#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005194
Hanno Beckera0e20d02019-05-15 14:03:01 +01005195#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005196 if( transform->out_cid_len != 0 )
5197 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005198#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005199
Hanno Becker5903de42019-05-03 14:46:38 +01005200 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005201}
5202
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005203#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005204/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005205 * Check record counters and renegotiate if they're above the limit.
5206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005207static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005208{
Hanno Beckerdd772292020-02-05 10:38:31 +00005209 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005210 int in_ctr_cmp;
5211 int out_ctr_cmp;
5212
Paul Elliott27b0d942022-03-18 21:55:32 +00005213 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005214 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005215 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005216 {
5217 return( 0 );
5218 }
5219
Andres AG2196c7f2016-12-15 17:01:16 +00005220 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005221 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005222 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005223 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5224 &ssl->conf->renego_period[ep_len],
5225 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005226
5227 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005228 {
5229 return( 0 );
5230 }
5231
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005232 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005233 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005234}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005235#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005236
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005237/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005238 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005239 * may only be sent for the purpose of initiating renegotiations.
5240 *
5241 * This function is introduced as a separate helper since the handling
5242 * of post-handshake handshake messages changes significantly in TLS 1.3,
5243 * and having a helper function allows to distinguish between TLS <= 1.2 and
5244 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5245 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005246static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005247{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005249
5250 /*
5251 * - For client-side, expect SERVER_HELLO_REQUEST.
5252 * - For server-side, expect CLIENT_HELLO.
5253 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5254 */
5255
5256#if defined(MBEDTLS_SSL_CLI_C)
5257 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5258 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5259 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5260 {
5261 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5262
5263 /* With DTLS, drop the packet (probably from last handshake) */
5264#if defined(MBEDTLS_SSL_PROTO_DTLS)
5265 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5266 {
5267 return( 0 );
5268 }
5269#endif
5270 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5271 }
5272#endif /* MBEDTLS_SSL_CLI_C */
5273
5274#if defined(MBEDTLS_SSL_SRV_C)
5275 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5276 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5277 {
5278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5279
5280 /* With DTLS, drop the packet (probably from last handshake) */
5281#if defined(MBEDTLS_SSL_PROTO_DTLS)
5282 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5283 {
5284 return( 0 );
5285 }
5286#endif
5287 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5288 }
5289#endif /* MBEDTLS_SSL_SRV_C */
5290
5291#if defined(MBEDTLS_SSL_RENEGOTIATION)
5292 /* Determine whether renegotiation attempt should be accepted */
5293 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5294 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5295 ssl->conf->allow_legacy_renegotiation ==
5296 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5297 {
5298 /*
5299 * Accept renegotiation request
5300 */
5301
5302 /* DTLS clients need to know renego is server-initiated */
5303#if defined(MBEDTLS_SSL_PROTO_DTLS)
5304 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5305 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5306 {
5307 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5308 }
5309#endif
5310 ret = mbedtls_ssl_start_renegotiation( ssl );
5311 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5312 ret != 0 )
5313 {
5314 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5315 ret );
5316 return( ret );
5317 }
5318 }
5319 else
5320#endif /* MBEDTLS_SSL_RENEGOTIATION */
5321 {
5322 /*
5323 * Refuse renegotiation
5324 */
5325
5326 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5327
TRodziewicz0f82ec62021-05-12 17:49:18 +02005328#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005329 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5330 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5331 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005332 {
TRodziewicz345165c2021-07-06 13:42:11 +02005333 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005334 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005335#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005336 }
5337
5338 return( 0 );
5339}
5340
Paul Bakker48916f92012-09-16 19:57:18 +00005341/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005342 * Receive application data decrypted from the SSL layer
5343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005345{
Janos Follath865b3eb2019-12-16 11:46:15 +00005346 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005347 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005348
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005349 if( ssl == NULL || ssl->conf == NULL )
5350 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005352 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005355 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005356 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005358 return( ret );
5359
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005360 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005362 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005363 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005364 return( ret );
5365 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005366 }
5367#endif
5368
Hanno Becker4a810fb2017-05-24 16:27:30 +01005369 /*
5370 * Check if renegotiation is necessary and/or handshake is
5371 * in process. If yes, perform/continue, and fall through
5372 * if an unexpected packet is received while the client
5373 * is waiting for the ServerHello.
5374 *
5375 * (There is no equivalent to the last condition on
5376 * the server-side as it is not treated as within
5377 * a handshake while waiting for the ClientHello
5378 * after a renegotiation request.)
5379 */
5380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005381#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005382 ret = ssl_check_ctr_renegotiate( ssl );
5383 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5384 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005385 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005387 return( ret );
5388 }
5389#endif
5390
Paul Elliott27b0d942022-03-18 21:55:32 +00005391 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005392 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005394 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5395 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005396 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005397 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005398 return( ret );
5399 }
5400 }
5401
Hanno Beckere41158b2017-10-23 13:30:32 +01005402 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005403 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005404 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005405 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005406 if( ssl->f_get_timer != NULL &&
5407 ssl->f_get_timer( ssl->p_timer ) == -1 )
5408 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005409 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005410 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005411
Hanno Becker327c93b2018-08-15 13:56:18 +01005412 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005413 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005414 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5415 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005416
Hanno Becker4a810fb2017-05-24 16:27:30 +01005417 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5418 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005419 }
5420
5421 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005423 {
5424 /*
5425 * OpenSSL sends empty messages to randomize the IV
5426 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005427 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005428 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005429 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005430 return( 0 );
5431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005433 return( ret );
5434 }
5435 }
5436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005438 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005439 ret = ssl_handle_hs_message_post_handshake( ssl );
5440 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005441 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005442 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5443 ret );
5444 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005445 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005446
Hanno Beckerf26cc722021-04-21 07:30:13 +01005447 /* At this point, we don't know whether the renegotiation triggered
5448 * by the post-handshake message has been completed or not. The cases
5449 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005450 * 1) The renegotiation is complete. In this case, no new record
5451 * has been read yet.
5452 * 2) The renegotiation is incomplete because the client received
5453 * an application data record while awaiting the ServerHello.
5454 * 3) The renegotiation is incomplete because the client received
5455 * a non-handshake, non-application data message while awaiting
5456 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005457 *
5458 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005459 * - For 1), the next iteration will read a new record and check
5460 * if it's application data.
5461 * - For 2), the loop condition isn't satisfied as application data
5462 * is present, hence continue is the same as break
5463 * - For 3), the loop condition is satisfied and read_record
5464 * will re-deliver the message that was held back by the client
5465 * when expecting the ServerHello.
5466 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005467
Hanno Becker90333da2017-10-10 11:27:13 +01005468 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005469 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005470#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005472 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005473 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005474 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005475 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005476 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005478 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005480 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005481 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005482 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5486 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005487 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005489 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005490 }
5491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005492 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005493 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5495 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005496 }
5497
5498 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005499
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005500 /* We're going to return something now, cancel timer,
5501 * except if handshake (renegotiation) is in progress */
Paul Elliott27b0d942022-03-18 21:55:32 +00005502 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker0f57a652020-02-05 10:37:26 +00005503 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005504
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005505#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005506 /* If we requested renego but received AppData, resend HelloRequest.
5507 * Do it now, after setting in_offt, to avoid taking this branch
5508 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005509#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005510 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005512 {
Hanno Becker786300f2020-02-05 10:46:40 +00005513 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005514 {
Hanno Becker786300f2020-02-05 10:46:40 +00005515 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5516 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005517 return( ret );
5518 }
5519 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005520#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005521#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005522 }
5523
5524 n = ( len < ssl->in_msglen )
5525 ? len : ssl->in_msglen;
5526
5527 memcpy( buf, ssl->in_offt, n );
5528 ssl->in_msglen -= n;
5529
gabor-mezei-arma3214132020-07-15 10:55:00 +02005530 /* Zeroising the plaintext buffer to erase unused application data
5531 from the memory. */
5532 mbedtls_platform_zeroize( ssl->in_offt, n );
5533
Paul Bakker5121ce52009-01-03 21:22:43 +00005534 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005535 {
5536 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005537 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005538 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005539 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005540 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005541 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005542 /* more data available */
5543 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005544 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005547
Paul Bakker23986e52011-04-24 08:57:21 +00005548 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005549}
5550
5551/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005552 * Send application data to be encrypted by the SSL layer, taking care of max
5553 * fragment length and buffer size.
5554 *
5555 * According to RFC 5246 Section 6.2.1:
5556 *
5557 * Zero-length fragments of Application data MAY be sent as they are
5558 * potentially useful as a traffic analysis countermeasure.
5559 *
5560 * Therefore, it is possible that the input message length is 0 and the
5561 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005562 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005563static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005564 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005565{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005566 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5567 const size_t max_len = (size_t) ret;
5568
5569 if( ret < 0 )
5570 {
5571 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5572 return( ret );
5573 }
5574
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005575 if( len > max_len )
5576 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005577#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005578 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005579 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005580 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005581 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5582 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005583 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005584 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005585 }
5586 else
5587#endif
5588 len = max_len;
5589 }
Paul Bakker887bd502011-06-08 13:10:54 +00005590
Paul Bakker5121ce52009-01-03 21:22:43 +00005591 if( ssl->out_left != 0 )
5592 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005593 /*
5594 * The user has previously tried to send the data and
5595 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5596 * written. In this case, we expect the high-level write function
5597 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005599 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005600 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005601 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005602 return( ret );
5603 }
5604 }
Paul Bakker887bd502011-06-08 13:10:54 +00005605 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005606 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005607 /*
5608 * The user is trying to send a message the first time, so we need to
5609 * copy the data into the internal buffers and setup the data structure
5610 * to keep track of partial writes
5611 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005612 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005613 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005614 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005615
Gabor Mezei96ec8312022-06-22 13:17:28 +02005616 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH,
5617 SSL_ENCRYPT_RECORD ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005618 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005619 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005620 return( ret );
5621 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005622 }
5623
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005624 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005625}
5626
5627/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005628 * Write application data (public-facing wrapper)
5629 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005630int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005631{
Janos Follath865b3eb2019-12-16 11:46:15 +00005632 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005633
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005634 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005635
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005636 if( ssl == NULL || ssl->conf == NULL )
5637 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5638
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005639#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005640 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5641 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005642 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005643 return( ret );
5644 }
5645#endif
5646
Paul Elliott27b0d942022-03-18 21:55:32 +00005647 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005648 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005649 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005650 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005651 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005652 return( ret );
5653 }
5654 }
5655
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005656 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005657
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005659
5660 return( ret );
5661}
5662
5663/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005664 * Notify the peer that the connection is being closed
5665 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005666int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005667{
Janos Follath865b3eb2019-12-16 11:46:15 +00005668 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005669
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005670 if( ssl == NULL || ssl->conf == NULL )
5671 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005673 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005674
Paul Elliott27b0d942022-03-18 21:55:32 +00005675 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005677 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5678 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5679 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005681 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005682 return( ret );
5683 }
5684 }
5685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005686 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005687
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005688 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005689}
5690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005691void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005692{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005693 if( transform == NULL )
5694 return;
5695
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005696#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005697 psa_destroy_key( transform->psa_key_enc );
5698 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005699#else
5700 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5701 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5702#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005703
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005704#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005705#if defined(MBEDTLS_USE_PSA_CRYPTO)
5706 psa_destroy_key( transform->psa_mac_enc );
5707 psa_destroy_key( transform->psa_mac_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005708#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005709 mbedtls_md_free( &transform->md_ctx_enc );
5710 mbedtls_md_free( &transform->md_ctx_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005711#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005712#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005713
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005714 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005715}
5716
Jerry Yuc7875b52021-09-05 21:05:50 +08005717void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5718 mbedtls_ssl_transform *transform )
5719{
Jerry Yuc7875b52021-09-05 21:05:50 +08005720 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005721 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005722}
5723
5724void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5725 mbedtls_ssl_transform *transform )
5726{
5727 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005728 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005729}
5730
Hanno Becker0271f962018-08-16 13:23:47 +01005731#if defined(MBEDTLS_SSL_PROTO_DTLS)
5732
Hanno Becker533ab5f2020-02-05 10:49:13 +00005733void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005734{
5735 unsigned offset;
5736 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5737
5738 if( hs == NULL )
5739 return;
5740
Hanno Becker283f5ef2018-08-24 09:34:47 +01005741 ssl_free_buffered_record( ssl );
5742
Hanno Becker0271f962018-08-16 13:23:47 +01005743 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005744 ssl_buffering_free_slot( ssl, offset );
5745}
5746
5747static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5748 uint8_t slot )
5749{
5750 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5751 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005752
5753 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5754 return;
5755
Hanno Beckere605b192018-08-21 15:59:07 +01005756 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005757 {
Hanno Beckere605b192018-08-21 15:59:07 +01005758 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005759 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005760 mbedtls_free( hs_buf->data );
5761 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005762 }
5763}
5764
5765#endif /* MBEDTLS_SSL_PROTO_DTLS */
5766
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005767/*
5768 * Convert version numbers to/from wire format
5769 * and, for DTLS, to/from TLS equivalent.
5770 *
5771 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005772 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005773 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005774 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005775 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005776void mbedtls_ssl_write_version( unsigned char version[2], int transport,
5777 mbedtls_ssl_protocol_version tls_version )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005778{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005779#if defined(MBEDTLS_SSL_PROTO_DTLS)
5780 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005781 tls_version =
5782 ~( tls_version - ( tls_version == 0x0302 ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005783#else
5784 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005785#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005786 MBEDTLS_PUT_UINT16_BE( tls_version, version, 0 );
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005787}
5788
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005789uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
5790 int transport )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005791{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005792 uint16_t tls_version = MBEDTLS_GET_UINT16_BE( version, 0 );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793#if defined(MBEDTLS_SSL_PROTO_DTLS)
5794 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005795 tls_version =
5796 ~( tls_version - ( tls_version == 0xfeff ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005797#else
5798 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005799#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005800 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005801}
5802
Jerry Yue7047812021-09-13 19:26:39 +08005803/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005804 * Send pending fatal alert.
5805 * 0, No alert message.
5806 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5807 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005808 */
5809int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5810{
5811 int ret;
5812
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005813 /* No pending alert, return success*/
5814 if( ssl->send_alert == 0 )
5815 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005816
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005817 ret = mbedtls_ssl_send_alert_message( ssl,
5818 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5819 ssl->alert_type );
5820
Jerry Yu3bf1f972021-09-22 21:37:18 +08005821 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5822 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005823 */
5824 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5825 {
5826 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005827 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005828
5829 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005830 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005831
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005832 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005833}
5834
Jerry Yu394ece62021-09-14 22:17:21 +08005835/*
5836 * Set pending fatal alert flag.
5837 */
5838void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5839 unsigned char alert_type,
5840 int alert_reason )
5841{
5842 ssl->send_alert = 1;
5843 ssl->alert_type = alert_type;
5844 ssl->alert_reason = alert_reason;
5845}
5846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005847#endif /* MBEDTLS_SSL_TLS_C */