blob: f3bebf4b7d61f580d23530e6d2641ee39bb8dab0 [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
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Ronald Cron6f135e12021-12-08 16:57:54 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100297
298static size_t ssl_compute_padding_length( size_t len,
299 size_t granularity )
300{
301 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
302}
303
Hanno Becker581bc1b2020-05-04 12:20:03 +0100304/* This functions transforms a (D)TLS plaintext fragment and a record content
305 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
306 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
307 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100308 *
309 * struct {
310 * opaque content[DTLSPlaintext.length];
311 * ContentType real_type;
312 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100313 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100314 *
315 * Input:
316 * - `content`: The beginning of the buffer holding the
317 * plaintext to be wrapped.
318 * - `*content_size`: The length of the plaintext in Bytes.
319 * - `max_len`: The number of Bytes available starting from
320 * `content`. This must be `>= *content_size`.
321 * - `rec_type`: The desired record content type.
322 *
323 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100324 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
325 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100326 *
327 * Returns:
328 * - `0` on success.
329 * - A negative error code if `max_len` didn't offer enough space
330 * for the expansion.
331 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100332static int ssl_build_inner_plaintext( unsigned char *content,
333 size_t *content_size,
334 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100335 uint8_t rec_type,
336 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100337{
338 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339
340 /* Write real content type */
341 if( remaining == 0 )
342 return( -1 );
343 content[ len ] = rec_type;
344 len++;
345 remaining--;
346
347 if( remaining < pad )
348 return( -1 );
349 memset( content + len, 0, pad );
350 len += pad;
351 remaining -= pad;
352
353 *content_size = len;
354 return( 0 );
355}
356
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357/* This function parses a (D)TLSInnerPlaintext structure.
358 * See ssl_build_inner_plaintext() for details. */
359static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100360 size_t *content_size,
361 uint8_t *rec_type )
362{
363 size_t remaining = *content_size;
364
365 /* Determine length of padding by skipping zeroes from the back. */
366 do
367 {
368 if( remaining == 0 )
369 return( -1 );
370 remaining--;
371 } while( content[ remaining ] == 0 );
372
373 *content_size = remaining;
374 *rec_type = content[ remaining ];
375
376 return( 0 );
377}
Ronald Cron6f135e12021-12-08 16:57:54 +0100378#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100379
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100380/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100381 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000382static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100383 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100384 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000385 unsigned minor_ver,
386 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000387{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100388 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100389 *
390 * additional_data = seq_num + TLSCompressed.type +
391 * TLSCompressed.version + TLSCompressed.length;
392 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100393 * For the CID extension, this is extended as follows
394 * (quoting draft-ietf-tls-dtls-connection-id-05,
395 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100396 *
397 * additional_data = seq_num + DTLSPlaintext.type +
398 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100399 * cid +
400 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100401 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100402 *
403 * For TLS 1.3, the record sequence number is dropped from the AAD
404 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000405 * Moreover, the additional data involves the length of the TLS
406 * ciphertext, not the TLS plaintext as in earlier versions.
407 * Quoting RFC 8446 (TLS 1.3):
408 *
409 * additional_data = TLSCiphertext.opaque_type ||
410 * TLSCiphertext.legacy_record_version ||
411 * TLSCiphertext.length
412 *
413 * We pass the tag length to this function in order to compute the
414 * ciphertext length from the inner plaintext length rec->data_len via
415 *
416 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
417 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100418 */
419
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100420 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000421 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422
Ronald Cron6f135e12021-12-08 16:57:54 +0100423#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000424 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
425 {
426 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
427 * which differs from the length of the TLSInnerPlaintext
428 * by the length of the authentication tag. */
429 ad_len_field += taglen;
430 }
431 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100432#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100433 {
434 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000435 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100436 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
437 cur += sizeof( rec->ctr );
438 }
439
440 *cur = rec->type;
441 cur++;
442
443 memcpy( cur, rec->ver, sizeof( rec->ver ) );
444 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100445
Hanno Beckera0e20d02019-05-15 14:03:01 +0100446#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100447 if( rec->cid_len != 0 )
448 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100449 memcpy( cur, rec->cid, rec->cid_len );
450 cur += rec->cid_len;
451
452 *cur = rec->cid_len;
453 cur++;
454
Joe Subbiani6dd73642021-07-19 11:56:54 +0100455 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100456 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100457 }
458 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100461 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100462 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464
465 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000466}
467
Hanno Becker67a37db2020-05-28 16:27:07 +0100468#if defined(MBEDTLS_GCM_C) || \
469 defined(MBEDTLS_CCM_C) || \
470 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100471static int ssl_transform_aead_dynamic_iv_is_explicit(
472 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100473{
Hanno Becker17263802020-05-28 07:05:48 +0100474 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475}
476
Hanno Becker17263802020-05-28 07:05:48 +0100477/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
478 *
479 * Concretely, this occurs in two variants:
480 *
481 * a) Fixed and dynamic IV lengths add up to total IV length, giving
482 * IV = fixed_iv || dynamic_iv
483 *
Hanno Becker15952812020-06-04 13:31:46 +0100484 * This variant is used in TLS 1.2 when used with GCM or CCM.
485 *
Hanno Becker17263802020-05-28 07:05:48 +0100486 * b) Fixed IV lengths matches total IV length, giving
487 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100488 *
489 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
490 *
491 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100492 *
493 * This function has the precondition that
494 *
495 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
496 *
497 * which has to be ensured by the caller. If this precondition
498 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100499 */
500static void ssl_build_record_nonce( unsigned char *dst_iv,
501 size_t dst_iv_len,
502 unsigned char const *fixed_iv,
503 size_t fixed_iv_len,
504 unsigned char const *dynamic_iv,
505 size_t dynamic_iv_len )
506{
507 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100508
509 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100510 memset( dst_iv, 0, dst_iv_len );
511 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100512
Hanno Becker17263802020-05-28 07:05:48 +0100513 dst_iv += dst_iv_len - dynamic_iv_len;
514 for( i = 0; i < dynamic_iv_len; i++ )
515 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100516}
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518
Hanno Beckera18d1322018-01-03 14:27:32 +0000519int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
520 mbedtls_ssl_transform *transform,
521 mbedtls_record *rec,
522 int (*f_rng)(void *, unsigned char *, size_t),
523 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000524{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100525#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 mbedtls_cipher_mode_t mode;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100527#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100573#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000574 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100575#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000576
577 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)
Hanno Beckerccc13d02020-05-04 12:30:04 +0100599 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
600 {
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)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100656#if defined(MBEDTLS_USE_PSA_CRYPTO)
657 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ||
658 ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING
659#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660 if( mode == MBEDTLS_MODE_STREAM ||
661 ( mode == MBEDTLS_MODE_CBC
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100662#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100665#endif
666 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000667 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000668 if( post_avail < transform->maclen )
669 {
670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
671 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
672 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200674 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker992b6872017-11-09 18:57:39 +0000676
TRodziewicz345165c2021-07-06 13:42:11 +0200677 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000678 transform->minor_ver,
679 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000680
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100681 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
682 add_data_len );
683 if( ret != 0 )
684 goto hmac_failed_etm_disabled;
685 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
686 if( ret != 0 )
687 goto hmac_failed_etm_disabled;
688 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
689 if( ret != 0 )
690 goto hmac_failed_etm_disabled;
691 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
692 if( ret != 0 )
693 goto hmac_failed_etm_disabled;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000694
TRodziewicz345165c2021-07-06 13:42:11 +0200695 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200696#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200697
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
699 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200700
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000701 rec->data_len += transform->maclen;
702 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100703 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100704
705 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100706 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100707 if( ret != 0 )
708 {
709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
710 return( ret );
711 }
Paul Bakker577e0062013-08-28 11:57:20 +0200712 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000713#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000714
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200715 /*
716 * Encrypt
717 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000718#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100719#if defined(MBEDTLS_USE_PSA_CRYPTO)
720 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
721#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100723#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000724 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000725 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 "including %d bytes of padding",
727 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000728
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100729 /* The only supported stream cipher is "NULL",
730 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000731 }
Paul Bakker68884e32013-01-07 18:20:04 +0100732 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000733#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000734
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200735#if defined(MBEDTLS_GCM_C) || \
736 defined(MBEDTLS_CCM_C) || \
737 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100738#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +0100739 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100740#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200742 mode == MBEDTLS_MODE_CCM ||
743 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100744#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +0000745 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200746 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100747 unsigned char *dynamic_iv;
748 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100749 int dynamic_iv_is_explicit =
750 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100751#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100753#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100754 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000755
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100756 /* Check that there's space for the authentication tag. */
757 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000758 {
759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
760 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
761 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000762
Paul Bakker68884e32013-01-07 18:20:04 +0100763 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100764 * Build nonce for AEAD encryption.
765 *
766 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
767 * part of the IV is prepended to the ciphertext and
768 * can be chosen freely - in particular, it need not
769 * agree with the record sequence number.
770 * However, since ChaChaPoly as well as all AEAD modes
771 * in TLS 1.3 use the record sequence number as the
772 * dynamic part of the nonce, we uniformly use the
773 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100774 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100775 dynamic_iv = rec->ctr;
776 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200777
Hanno Becker17263802020-05-28 07:05:48 +0100778 ssl_build_record_nonce( iv, sizeof( iv ),
779 transform->iv_enc,
780 transform->fixed_ivlen,
781 dynamic_iv,
782 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100783
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100784 /*
785 * Build additional data for AEAD encryption.
786 * This depends on the TLS version.
787 */
788 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000789 transform->minor_ver,
790 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100791
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200792 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100793 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200794 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100795 dynamic_iv,
796 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000797 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100798 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000799 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200800 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000801 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000802
Paul Bakker68884e32013-01-07 18:20:04 +0100803 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200804 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200805 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100806#if defined(MBEDTLS_USE_PSA_CRYPTO)
807 status = psa_aead_encrypt( transform->psa_key_enc,
808 transform->psa_alg,
809 iv, transform->ivlen,
810 add_data, add_data_len,
811 data, rec->data_len,
812 data, rec->buf_len - (data - rec->buf),
813 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000814
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100815 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100816 {
817 ret = psa_ssl_status_to_mbedtls( status );
818 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
819 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100820 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100821#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100822 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000823 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100824 add_data, add_data_len,
825 data, rec->data_len, /* src */
826 data, rec->buf_len - (data - rec->buf), /* dst */
827 &rec->data_len,
828 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200829 {
TRodziewicz18efb732021-04-29 23:12:19 +0200830 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200831 return( ret );
832 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100833#endif /* MBEDTLS_USE_PSA_CRYPTO */
834
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000835 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100836 data + rec->data_len - transform->taglen,
837 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100838 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000839 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100840
841 /*
842 * Prefix record content with dynamic IV in case it is explicit.
843 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100844 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100845 {
846 if( rec->data_offset < dynamic_iv_len )
847 {
848 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
849 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
850 }
851
852 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
853 rec->data_offset -= dynamic_iv_len;
854 rec->data_len += dynamic_iv_len;
855 }
856
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100857 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000858 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000859 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100860#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200861#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100862#if defined(MBEDTLS_USE_PSA_CRYPTO)
863 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
864#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100866#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000867 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000869 size_t padlen, i;
870 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100871#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100872 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100873 size_t part_len;
874 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
875#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000876
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000877 /* Currently we're always using minimal padding
878 * (up to 255 bytes would be allowed). */
879 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
880 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000881 padlen = 0;
882
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000883 /* Check there's enough space in the buffer for the padding. */
884 if( post_avail < padlen + 1 )
885 {
886 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
887 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
888 }
889
Paul Bakker5121ce52009-01-03 21:22:43 +0000890 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000891 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000892
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 rec->data_len += padlen + 1;
894 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000895
TRodziewicz0f82ec62021-05-12 17:49:18 +0200896#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000897 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200898 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000899 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000900 */
TRodziewicz345165c2021-07-06 13:42:11 +0200901 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000902 {
TRodziewicz345165c2021-07-06 13:42:11 +0200903 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
904 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000905 }
TRodziewicz345165c2021-07-06 13:42:11 +0200906
907 if( rec->data_offset < transform->ivlen )
908 {
909 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
910 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
911 }
912
913 /*
914 * Generate IV
915 */
916 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
917 if( ret != 0 )
918 return( ret );
919
920 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200921#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000922
Paul Elliottd48d5c62021-01-07 14:47:05 +0000923 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
924 "including %" MBEDTLS_PRINTF_SIZET
925 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000926 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200927 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000928
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100929#if defined(MBEDTLS_USE_PSA_CRYPTO)
930 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100931 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100932
933 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100934 {
935 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100936 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_encrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100937 return( ret );
938 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100939
940 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
941
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_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100946 return( ret );
947
948 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100949
950 status = psa_cipher_update( &cipher_op,
951 data, rec->data_len,
952 data, rec->data_len, &olen );
953
954 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100955 {
956 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100957 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100958 return( ret );
959
960 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100961
962 status = psa_cipher_finish( &cipher_op,
963 data + olen, rec->data_len - olen,
964 &part_len );
965
966 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100967 {
968 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100969 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100970 return( ret );
971
972 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100973
974 olen += part_len;
975#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000976 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
977 transform->iv_enc,
978 transform->ivlen,
979 data, rec->data_len,
980 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200981 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200983 return( ret );
984 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100985#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200986
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000987 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200988 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
990 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200991 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200992
TRodziewicz0f82ec62021-05-12 17:49:18 +0200993 data -= transform->ivlen;
994 rec->data_offset -= transform->ivlen;
995 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100998 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100999 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001000 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1001
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001002 /*
1003 * MAC(MAC_write_key, seq_num +
1004 * TLSCipherText.type +
1005 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001006 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001007 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001008 * ENC(content + padding + padding_length));
1009 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001010
1011 if( post_avail < transform->maclen)
1012 {
1013 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1014 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1015 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001016
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001017 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001018 rec, transform->minor_ver,
1019 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001023 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001024
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001025 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1026 add_data_len );
1027 if( ret != 0 )
1028 goto hmac_failed_etm_enabled;
1029 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1030 data, rec->data_len );
1031 if( ret != 0 )
1032 goto hmac_failed_etm_enabled;
1033 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1034 if( ret != 0 )
1035 goto hmac_failed_etm_enabled;
1036 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1037 if( ret != 0 )
1038 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001039
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001040 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001041
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001042 rec->data_len += transform->maclen;
1043 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001044 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001045
1046 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001047 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001048 if( ret != 0 )
1049 {
1050 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1051 return( ret );
1052 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001053 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001055 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001056 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001057#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001058 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1060 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001061 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001062
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001063 /* Make extra sure authentication was performed, exactly once */
1064 if( auth_done != 1 )
1065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1067 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001068 }
1069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001071
1072 return( 0 );
1073}
1074
Hanno Becker605949f2019-07-12 08:23:59 +01001075int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001076 mbedtls_ssl_transform *transform,
1077 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001078{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001079 size_t olen;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001080#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001081 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001082
1083#else
1084 mbedtls_cipher_mode_t mode;
1085 int ret;
1086#endif /* MBEDTLS_USE_PSA_CRYPTO */
1087
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001088 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001089#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001090 size_t padlen = 0, correct = 1;
1091#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001092 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001093 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001094 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001095
Hanno Beckera18d1322018-01-03 14:27:32 +00001096#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001097 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001098 ((void) ssl);
1099#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001102 if( rec == NULL ||
1103 rec->buf == NULL ||
1104 rec->buf_len < rec->data_offset ||
1105 rec->buf_len - rec->data_offset < rec->data_len )
1106 {
1107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001109 }
1110
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001111 data = rec->buf + rec->data_offset;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001112#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001113 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001114#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001115
Hanno Beckera0e20d02019-05-15 14:03:01 +01001116#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001117 /*
1118 * Match record's CID with incoming CID.
1119 */
Hanno Becker938489a2019-05-08 13:02:22 +01001120 if( rec->cid_len != transform->in_cid_len ||
1121 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1122 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001123 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001124 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001125#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001126
Hanno Beckerd086bf02021-03-22 13:01:27 +00001127#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001128#if defined(MBEDTLS_USE_PSA_CRYPTO)
1129 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
1130#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001132#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker68884e32013-01-07 18:20:04 +01001133 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001134 /* The only supported stream cipher is "NULL",
1135 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001136 }
Paul Bakker68884e32013-01-07 18:20:04 +01001137 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001138#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001139#if defined(MBEDTLS_GCM_C) || \
1140 defined(MBEDTLS_CCM_C) || \
1141 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001142#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +01001143 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001144#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001146 mode == MBEDTLS_MODE_CCM ||
1147 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001148#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001149 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001150 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001151 unsigned char *dynamic_iv;
1152 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001153#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001155#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001156
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001157 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001158 * Extract dynamic part of nonce for AEAD decryption.
1159 *
1160 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1161 * part of the IV is prepended to the ciphertext and
1162 * can be chosen freely - in particular, it need not
1163 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001164 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001165 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001166 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001167 {
1168 if( rec->data_len < dynamic_iv_len )
1169 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001170 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1171 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001172 rec->data_len,
1173 dynamic_iv_len ) );
1174 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1175 }
1176 dynamic_iv = data;
1177
1178 data += dynamic_iv_len;
1179 rec->data_offset += dynamic_iv_len;
1180 rec->data_len -= dynamic_iv_len;
1181 }
Hanno Becker17263802020-05-28 07:05:48 +01001182 else
1183 {
1184 dynamic_iv = rec->ctr;
1185 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001186
1187 /* Check that there's space for the authentication tag. */
1188 if( rec->data_len < transform->taglen )
1189 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1191 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001192 rec->data_len,
1193 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001195 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001196 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001197
Hanno Beckerdf8be222020-05-21 15:30:57 +01001198 /*
1199 * Prepare nonce from dynamic and static parts.
1200 */
Hanno Becker17263802020-05-28 07:05:48 +01001201 ssl_build_record_nonce( iv, sizeof( iv ),
1202 transform->iv_dec,
1203 transform->fixed_ivlen,
1204 dynamic_iv,
1205 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001206
Hanno Beckerdf8be222020-05-21 15:30:57 +01001207 /*
1208 * Build additional data for AEAD encryption.
1209 * This depends on the TLS version.
1210 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001211 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001212 transform->minor_ver,
1213 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001214 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001215 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216
Hanno Beckerd96a6522019-07-10 13:55:25 +01001217 /* Because of the check above, we know that there are
1218 * explicit_iv_len Bytes preceeding data, and taglen
1219 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001220 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001221 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001222
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001223 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001224 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001225 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001226
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001227 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001228 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001229 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001230#if defined(MBEDTLS_USE_PSA_CRYPTO)
1231 status = psa_aead_decrypt( transform->psa_key_dec,
1232 transform->psa_alg,
1233 iv, transform->ivlen,
1234 add_data, add_data_len,
1235 data, rec->data_len + transform->taglen,
1236 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001237 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001238
1239 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001240 {
1241 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001242 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001243 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001244 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001245#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001246 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001247 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001248 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001249 data, rec->data_len + transform->taglen, /* src */
1250 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001251 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001252 {
TRodziewicz18efb732021-04-29 23:12:19 +02001253 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1256 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001257
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001258 return( ret );
1259 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001260#endif /* MBEDTLS_USE_PSA_CRYPTO */
1261
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001262 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001263
Hanno Beckerd96a6522019-07-10 13:55:25 +01001264 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001265 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001267 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1268 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001269 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001270 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001271 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001273#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001274#if defined(MBEDTLS_USE_PSA_CRYPTO)
1275 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
1276#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001278#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001279 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001280 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001281#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001282 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001283 size_t part_len;
1284 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1285#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001286
Paul Bakker5121ce52009-01-03 21:22:43 +00001287 /*
Paul Bakker45829992013-01-03 14:52:21 +01001288 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001289 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001290#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001291 /* The ciphertext is prefixed with the CBC IV. */
1292 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001293#endif
Paul Bakker45829992013-01-03 14:52:21 +01001294
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001295 /* Size considerations:
1296 *
1297 * - The CBC cipher text must not be empty and hence
1298 * at least of size transform->ivlen.
1299 *
1300 * Together with the potential IV-prefix, this explains
1301 * the first of the two checks below.
1302 *
1303 * - The record must contain a MAC, either in plain or
1304 * encrypted, depending on whether Encrypt-then-MAC
1305 * is used or not.
1306 * - If it is, the message contains the IV-prefix,
1307 * the CBC ciphertext, and the MAC.
1308 * - If it is not, the padded plaintext, and hence
1309 * the CBC ciphertext, has at least length maclen + 1
1310 * because there is at least the padding length byte.
1311 *
1312 * As the CBC ciphertext is not empty, both cases give the
1313 * lower bound minlen + maclen + 1 on the record size, which
1314 * we test for in the second check below.
1315 */
1316 if( rec->data_len < minlen + transform->ivlen ||
1317 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001318 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001319 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1320 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1321 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001322 "+ 1 ) ( + expl IV )", rec->data_len,
1323 transform->ivlen,
1324 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001326 }
1327
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001328 /*
1329 * Authenticate before decrypt if enabled
1330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001332 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001333 {
Hanno Becker992b6872017-11-09 18:57:39 +00001334 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001336 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001337
Hanno Beckerd96a6522019-07-10 13:55:25 +01001338 /* Update data_len in tandem with add_data.
1339 *
1340 * The subtraction is safe because of the previous check
1341 * data_len >= minlen + maclen + 1.
1342 *
1343 * Afterwards, we know that data + data_len is followed by at
1344 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001345 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001346 *
1347 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001348 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001349 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001350 transform->minor_ver,
1351 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001352
Hanno Beckerd96a6522019-07-10 13:55:25 +01001353 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001354 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1355 add_data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001356 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1357 add_data_len );
1358 if( ret != 0 )
1359 goto hmac_failed_etm_enabled;
1360 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001361 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001362 if( ret != 0 )
1363 goto hmac_failed_etm_enabled;
1364 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1365 if( ret != 0 )
1366 goto hmac_failed_etm_enabled;
1367 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1368 if( ret != 0 )
1369 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001370
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001371 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1372 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001373 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001374 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001375
Hanno Beckerd96a6522019-07-10 13:55:25 +01001376 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001377 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001378 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001379 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001381 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1382 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001383 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001384 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001385
1386 hmac_failed_etm_enabled:
1387 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1388 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001389 {
1390 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1391 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001392 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001393 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001394 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001396
1397 /*
1398 * Check length sanity
1399 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001400
1401 /* We know from above that data_len > minlen >= 0,
1402 * so the following check in particular implies that
1403 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001404 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001405 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1407 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001408 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001409 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001410 }
1411
TRodziewicz0f82ec62021-05-12 17:49:18 +02001412#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001413 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001414 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001415 */
TRodziewicz345165c2021-07-06 13:42:11 +02001416 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1417 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001418
TRodziewicz345165c2021-07-06 13:42:11 +02001419 data += transform->ivlen;
1420 rec->data_offset += transform->ivlen;
1421 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001422#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001423
Hanno Beckerd96a6522019-07-10 13:55:25 +01001424 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1425
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001426#if defined(MBEDTLS_USE_PSA_CRYPTO)
1427 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001428 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001429
1430 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001431 {
1432 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001433 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001434 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001435 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001436
1437 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1438
1439 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001440 {
1441 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001442 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001443 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001444 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001445
1446 status = psa_cipher_update( &cipher_op,
1447 data, rec->data_len,
1448 data, rec->data_len, &olen );
1449
1450 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001451 {
1452 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001453 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001454 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001455 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001456
1457 status = psa_cipher_finish( &cipher_op,
1458 data + olen, rec->data_len - olen,
1459 &part_len );
1460
1461 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001462 {
1463 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001464 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001465 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001466 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001467
1468 olen += part_len;
1469#else
1470
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001471 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1472 transform->iv_dec, transform->ivlen,
1473 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001474 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001476 return( ret );
1477 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001478#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001479
Hanno Beckerd96a6522019-07-10 13:55:25 +01001480 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001481 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001482 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1484 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001485 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001486
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001487 /* Safe since data_len >= minlen + maclen + 1, so after having
1488 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001489 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1490 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001491 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001492
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001493 if( auth_done == 1 )
1494 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001495 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001496 rec->data_len,
1497 padlen + 1 );
1498 correct &= mask;
1499 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 }
1501 else
Paul Bakker45829992013-01-03 14:52:21 +01001502 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001504 if( rec->data_len < transform->maclen + padlen + 1 )
1505 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1507 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1508 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001509 rec->data_len,
1510 transform->maclen,
1511 padlen + 1 ) );
1512 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001513#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001514
Gabor Mezei90437e32021-10-20 11:59:27 +02001515 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001516 rec->data_len,
1517 transform->maclen + padlen + 1 );
1518 correct &= mask;
1519 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001520 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001521
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001522 padlen++;
1523
1524 /* Regardless of the validity of the padding,
1525 * we have data_len >= padlen here. */
1526
TRodziewicz0f82ec62021-05-12 17:49:18 +02001527#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001528 /* The padding check involves a series of up to 256
1529 * consecutive memory reads at the end of the record
1530 * plaintext buffer. In order to hide the length and
1531 * validity of the padding, always perform exactly
1532 * `min(256,plaintext_len)` reads (but take into account
1533 * only the last `padlen` bytes for the padding check). */
1534 size_t pad_count = 0;
1535 volatile unsigned char* const check = data;
1536
1537 /* Index of first padding byte; it has been ensured above
1538 * that the subtraction is safe. */
1539 size_t const padding_idx = rec->data_len - padlen;
1540 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1541 size_t const start_idx = rec->data_len - num_checks;
1542 size_t idx;
1543
1544 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001545 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001546 /* pad_count += (idx >= padding_idx) &&
1547 * (check[idx] == padlen - 1);
1548 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001549 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1550 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001551 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001552 pad_count += mask & equal;
1553 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001554 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001557 if( padlen > 0 && correct == 0 )
1558 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001559#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001560 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001561
TRodziewicz0f82ec62021-05-12 17:49:18 +02001562#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001563
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001564 /* If the padding was found to be invalid, padlen == 0
1565 * and the subtraction is safe. If the padding was found valid,
1566 * padlen hasn't been changed and the previous assertion
1567 * data_len >= padlen still holds. */
1568 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001569 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001570 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001571#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001572 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1574 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001575 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001576
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001577#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001579 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001580#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001581
1582 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001583 * Authenticate if not done yet.
1584 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001585 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001586#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001587 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001588 {
Hanno Becker992b6872017-11-09 18:57:39 +00001589 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001590 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001591
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001592 /* If the initial value of padlen was such that
1593 * data_len < maclen + padlen + 1, then padlen
1594 * got reset to 1, and the initial check
1595 * data_len >= minlen + maclen + 1
1596 * guarantees that at this point we still
1597 * have at least data_len >= maclen.
1598 *
1599 * If the initial value of padlen was such that
1600 * data_len >= maclen + padlen + 1, then we have
1601 * subtracted either padlen + 1 (if the padding was correct)
1602 * or 0 (if the padding was incorrect) since then,
1603 * hence data_len >= maclen in any case.
1604 */
1605 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001606 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001607 transform->minor_ver,
1608 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001609
TRodziewicz0f82ec62021-05-12 17:49:18 +02001610#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001611 /*
1612 * The next two sizes are the minimum and maximum values of
1613 * data_len over all padlen values.
1614 *
1615 * They're independent of padlen, since we previously did
1616 * data_len -= padlen.
1617 *
1618 * Note that max_len + maclen is never more than the buffer
1619 * length, as we previously did in_msglen -= maclen too.
1620 */
1621 const size_t max_len = rec->data_len + padlen;
1622 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1623
Gabor Mezei90437e32021-10-20 11:59:27 +02001624 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001625 add_data, add_data_len,
1626 data, rec->data_len, min_len, max_len,
1627 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001628 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001629 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001630 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001631 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001632 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001633
Gabor Mezei90437e32021-10-20 11:59:27 +02001634 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001635 rec->data_len,
1636 min_len, max_len,
1637 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001638#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001639
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001640#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001641 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001642 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001643#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001644
Gabor Mezei90437e32021-10-20 11:59:27 +02001645 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001646 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001647 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648#if defined(MBEDTLS_SSL_DEBUG_ALL)
1649 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001650#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001651 correct = 0;
1652 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001653 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001654
1655 hmac_failed_etm_disabled:
1656 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1657 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1658 if( ret != 0 )
1659 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001660 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001661
1662 /*
1663 * Finally check the correct flag
1664 */
1665 if( correct == 0 )
1666 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001667#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001668
1669 /* Make extra sure authentication was performed, exactly once */
1670 if( auth_done != 1 )
1671 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1673 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001674 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001675
Ronald Cron6f135e12021-12-08 16:57:54 +01001676#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001677 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1678 {
1679 /* Remove inner padding and infer true content type. */
1680 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1681 &rec->type );
1682
1683 if( ret != 0 )
1684 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1685 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001686#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001687
Hanno Beckera0e20d02019-05-15 14:03:01 +01001688#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001689 if( rec->cid_len != 0 )
1690 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001691 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1692 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001693 if( ret != 0 )
1694 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1695 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001696#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001698 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001699
1700 return( 0 );
1701}
1702
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001703#undef MAC_NONE
1704#undef MAC_PLAINTEXT
1705#undef MAC_CIPHERTEXT
1706
Paul Bakker5121ce52009-01-03 21:22:43 +00001707/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001708 * Fill the input message buffer by appending data to it.
1709 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001710 *
1711 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1712 * available (from this read and/or a previous one). Otherwise, an error code
1713 * is returned (possibly EOF or WANT_READ).
1714 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001715 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1716 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1717 * since we always read a whole datagram at once.
1718 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001719 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001720 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001723{
Janos Follath865b3eb2019-12-16 11:46:15 +00001724 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001725 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001726#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1727 size_t in_buf_len = ssl->in_buf_len;
1728#else
1729 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1730#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001733
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001734 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1735 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001737 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001739 }
1740
Darryl Greenb33cc762019-11-28 14:29:44 +00001741 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001742 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1744 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001745 }
1746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001747#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001748 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001749 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001750 uint32_t timeout;
1751
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001752 /*
1753 * The point is, we need to always read a full datagram at once, so we
1754 * sometimes read more then requested, and handle the additional data.
1755 * It could be the rest of the current record (while fetching the
1756 * header) and/or some other records in the same datagram.
1757 */
1758
1759 /*
1760 * Move to the next record in the already read datagram if applicable
1761 */
1762 if( ssl->next_record_offset != 0 )
1763 {
1764 if( ssl->in_left < ssl->next_record_offset )
1765 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1767 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001768 }
1769
1770 ssl->in_left -= ssl->next_record_offset;
1771
1772 if( ssl->in_left != 0 )
1773 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001774 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1775 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001776 ssl->next_record_offset ) );
1777 memmove( ssl->in_hdr,
1778 ssl->in_hdr + ssl->next_record_offset,
1779 ssl->in_left );
1780 }
1781
1782 ssl->next_record_offset = 0;
1783 }
1784
Paul Elliottd48d5c62021-01-07 14:47:05 +00001785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1786 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001787 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001788
1789 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001790 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001791 */
1792 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001793 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001795 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001796 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001797
1798 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001799 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001800 * are not at the beginning of a new record, the caller did something
1801 * wrong.
1802 */
1803 if( ssl->in_left != 0 )
1804 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1806 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001807 }
1808
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001809 /*
1810 * Don't even try to read if time's out already.
1811 * This avoids by-passing the timer when repeatedly receiving messages
1812 * that will end up being dropped.
1813 */
Hanno Becker7876d122020-02-05 10:39:31 +00001814 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001815 {
1816 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001817 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001818 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001819 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001820 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001821 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001822
Paul Elliott27b0d942022-03-18 21:55:32 +00001823 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001824 timeout = ssl->handshake->retransmit_timeout;
1825 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001826 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001827
Paul Elliott9f352112020-12-09 14:55:45 +00001828 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001829
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001830 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001831 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1832 timeout );
1833 else
1834 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001837
1838 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001840 }
1841
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001842 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001843 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001845 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001846
Paul Elliott27b0d942022-03-18 21:55:32 +00001847 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001848 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001849 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1850 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001852 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001853 }
1854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001855 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001856 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001858 return( ret );
1859 }
1860
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001861 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001862 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001864 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001866 {
Hanno Becker786300f2020-02-05 10:46:40 +00001867 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001868 {
Hanno Becker786300f2020-02-05 10:46:40 +00001869 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1870 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001871 return( ret );
1872 }
1873
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001874 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001875 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001877 }
1878
Paul Bakker5121ce52009-01-03 21:22:43 +00001879 if( ret < 0 )
1880 return( ret );
1881
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001882 ssl->in_left = ret;
1883 }
1884 else
1885#endif
1886 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001887 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1888 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001889 ssl->in_left, nb_want ) );
1890
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001891 while( ssl->in_left < nb_want )
1892 {
1893 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001894
Hanno Becker7876d122020-02-05 10:39:31 +00001895 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001896 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1897 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001898 {
1899 if( ssl->f_recv_timeout != NULL )
1900 {
1901 ret = ssl->f_recv_timeout( ssl->p_bio,
1902 ssl->in_hdr + ssl->in_left, len,
1903 ssl->conf->read_timeout );
1904 }
1905 else
1906 {
1907 ret = ssl->f_recv( ssl->p_bio,
1908 ssl->in_hdr + ssl->in_left, len );
1909 }
1910 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001911
Paul Elliottd48d5c62021-01-07 14:47:05 +00001912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1913 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001914 ssl->in_left, nb_want ) );
1915 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001916
1917 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001919
1920 if( ret < 0 )
1921 return( ret );
1922
makise-homuraaf9513b2020-08-24 18:26:27 +03001923 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001924 {
Darryl Green11999bb2018-03-13 15:22:58 +00001925 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001926 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001927 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001928 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1929 }
1930
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001931 ssl->in_left += ret;
1932 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001933 }
1934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001936
1937 return( 0 );
1938}
1939
1940/*
1941 * Flush any data not yet written
1942 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001944{
Janos Follath865b3eb2019-12-16 11:46:15 +00001945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001946 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001949
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001950 if( ssl->f_send == NULL )
1951 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001953 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001955 }
1956
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001957 /* Avoid incrementing counter if data is flushed */
1958 if( ssl->out_left == 0 )
1959 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001961 return( 0 );
1962 }
1963
Paul Bakker5121ce52009-01-03 21:22:43 +00001964 while( ssl->out_left > 0 )
1965 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001966 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1967 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001968 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001969
Hanno Becker2b1e3542018-08-06 11:19:13 +01001970 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001971 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001974
1975 if( ret <= 0 )
1976 return( ret );
1977
makise-homuraaf9513b2020-08-24 18:26:27 +03001978 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001979 {
Darryl Green11999bb2018-03-13 15:22:58 +00001980 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001981 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001982 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001983 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1984 }
1985
Paul Bakker5121ce52009-01-03 21:22:43 +00001986 ssl->out_left -= ret;
1987 }
1988
Hanno Becker2b1e3542018-08-06 11:19:13 +01001989#if defined(MBEDTLS_SSL_PROTO_DTLS)
1990 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001991 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001992 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001993 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001994 else
1995#endif
1996 {
1997 ssl->out_hdr = ssl->out_buf + 8;
1998 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001999 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002002
2003 return( 0 );
2004}
2005
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002006/*
2007 * Functions to handle the DTLS retransmission state machine
2008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002010/*
2011 * Append current handshake message to current outgoing flight
2012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002014{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2017 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2018 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002019
2020 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002021 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002022 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002025 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002026 }
2027
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002028 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002029 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002030 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2031 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002033 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002034 }
2035
2036 /* Copy current handshake message with headers */
2037 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2038 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002039 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002040 msg->next = NULL;
2041
2042 /* Append to the current flight */
2043 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002044 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002045 else
2046 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002048 while( cur->next != NULL )
2049 cur = cur->next;
2050 cur->next = msg;
2051 }
2052
Hanno Becker3b235902018-08-06 09:54:53 +01002053 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002054 return( 0 );
2055}
2056
2057/*
2058 * Free the current flight of handshake messages
2059 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002060void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002061{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 mbedtls_ssl_flight_item *cur = flight;
2063 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002064
2065 while( cur != NULL )
2066 {
2067 next = cur->next;
2068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 mbedtls_free( cur->p );
2070 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002071
2072 cur = next;
2073 }
2074}
2075
2076/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002077 * Swap transform_out and out_ctr with the alternative ones
2078 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002079static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002080{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002081 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002082 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002083
2084 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2085 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002087 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002088 }
2089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002091
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002092 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002093 tmp_transform = ssl->transform_out;
2094 ssl->transform_out = ssl->handshake->alt_transform_out;
2095 ssl->handshake->alt_transform_out = tmp_transform;
2096
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002097 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002098 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2099 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2100 sizeof( ssl->cur_out_ctr ) );
2101 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2102 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002103
2104 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002105 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002106
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002107 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002108}
2109
2110/*
2111 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002112 */
2113int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2114{
2115 int ret = 0;
2116
2117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2118
2119 ret = mbedtls_ssl_flight_transmit( ssl );
2120
2121 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2122
2123 return( ret );
2124}
2125
2126/*
2127 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002128 *
2129 * Need to remember the current message in case flush_output returns
2130 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002131 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002132 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002133int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002134{
Janos Follath865b3eb2019-12-16 11:46:15 +00002135 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002136 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002138 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002139 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002140 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002141
2142 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002143 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002144 ret = ssl_swap_epochs( ssl );
2145 if( ret != 0 )
2146 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002149 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002150
2151 while( ssl->handshake->cur_msg != NULL )
2152 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002153 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002154 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002155
Hanno Beckere1dcb032018-08-17 16:47:58 +01002156 int const is_finished =
2157 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2158 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2159
Hanno Becker04da1892018-08-14 13:22:10 +01002160 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2161 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2162
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002163 /* Swap epochs before sending Finished: we can't do it after
2164 * sending ChangeCipherSpec, in case write returns WANT_READ.
2165 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002166 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002167 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002168 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002169 ret = ssl_swap_epochs( ssl );
2170 if( ret != 0 )
2171 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002172 }
2173
Hanno Becker67bc7c32018-08-06 11:33:50 +01002174 ret = ssl_get_remaining_payload_in_datagram( ssl );
2175 if( ret < 0 )
2176 return( ret );
2177 max_frag_len = (size_t) ret;
2178
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002179 /* CCS is copied as is, while HS messages may need fragmentation */
2180 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2181 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002182 if( max_frag_len == 0 )
2183 {
2184 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2185 return( ret );
2186
2187 continue;
2188 }
2189
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002190 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002191 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002192 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002194 /* Update position inside current message */
2195 ssl->handshake->cur_msg_p += cur->len;
2196 }
2197 else
2198 {
2199 const unsigned char * const p = ssl->handshake->cur_msg_p;
2200 const size_t hs_len = cur->len - 12;
2201 const size_t frag_off = p - ( cur->p + 12 );
2202 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002203 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002204
Hanno Beckere1dcb032018-08-17 16:47:58 +01002205 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002206 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002207 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002208 {
2209 ret = ssl_swap_epochs( ssl );
2210 if( ret != 0 )
2211 return( ret );
2212 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002213
Hanno Becker67bc7c32018-08-06 11:33:50 +01002214 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2215 return( ret );
2216
2217 continue;
2218 }
2219 max_hs_frag_len = max_frag_len - 12;
2220
2221 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2222 max_hs_frag_len : rem_len;
2223
2224 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002225 {
2226 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002227 (unsigned) cur_hs_frag_len,
2228 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002229 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002230
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002231 /* Messages are stored with handshake headers as if not fragmented,
2232 * copy beginning of headers then fill fragmentation fields.
2233 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2234 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235
Joe Subbiani5ecac212021-06-24 13:00:03 +01002236 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2237 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2238 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002239
Joe Subbiani5ecac212021-06-24 13:00:03 +01002240 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2241 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2242 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002243
2244 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2245
Hanno Becker3f7b9732018-08-28 09:53:25 +01002246 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002247 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2248 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002249 ssl->out_msgtype = cur->type;
2250
2251 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002252 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002253 }
2254
2255 /* If done with the current message move to the next one if any */
2256 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2257 {
2258 if( cur->next != NULL )
2259 {
2260 ssl->handshake->cur_msg = cur->next;
2261 ssl->handshake->cur_msg_p = cur->next->p + 12;
2262 }
2263 else
2264 {
2265 ssl->handshake->cur_msg = NULL;
2266 ssl->handshake->cur_msg_p = NULL;
2267 }
2268 }
2269
2270 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002271 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002272 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002274 return( ret );
2275 }
2276 }
2277
Hanno Becker67bc7c32018-08-06 11:33:50 +01002278 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2279 return( ret );
2280
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002281 /* Update state and set timer */
Paul Elliott27b0d942022-03-18 21:55:32 +00002282 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002284 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002285 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002287 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002288 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002289
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002290 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002291
2292 return( 0 );
2293}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002294
2295/*
2296 * To be called when the last message of an incoming flight is received.
2297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002299{
2300 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002301 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002302 ssl->handshake->flight = NULL;
2303 ssl->handshake->cur_msg = NULL;
2304
2305 /* The next incoming flight will start with this msg_seq */
2306 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2307
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002308 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002309 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002310
Hanno Becker0271f962018-08-16 13:23:47 +01002311 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002312 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002313
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002314 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002315 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2318 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002319 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002320 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002321 }
2322 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002324}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002325
2326/*
2327 * To be called when the last message of an outgoing flight is send.
2328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002330{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002331 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002332 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2335 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002336 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002338 }
2339 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002341}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002343
Paul Bakker5121ce52009-01-03 21:22:43 +00002344/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002345 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002346 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002347
2348/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002349 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002350 *
2351 * - fill in handshake headers
2352 * - update handshake checksum
2353 * - DTLS: save message for resending
2354 * - then pass to the record layer
2355 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002356 * DTLS: except for HelloRequest, messages are only queued, and will only be
2357 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002358 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002359 * Inputs:
2360 * - ssl->out_msglen: 4 + actual handshake message len
2361 * (4 is the size of handshake headers for TLS)
2362 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2363 * - ssl->out_msg + 4: the handshake message body
2364 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002365 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002366 * - ssl->out_msglen: the length of the record contents
2367 * (including handshake headers but excluding record headers)
2368 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002369 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002370int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2371 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002372{
Janos Follath865b3eb2019-12-16 11:46:15 +00002373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002374 const size_t hs_len = ssl->out_msglen - 4;
2375 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002376
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002377 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2378
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002379 /*
2380 * Sanity checks
2381 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002382 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002383 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2384 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2386 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002387 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002388
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002389 /* Whenever we send anything different from a
2390 * HelloRequest we should be in a handshake - double check. */
2391 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2392 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002393 ssl->handshake == NULL )
2394 {
2395 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2396 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2397 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002400 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002401 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002403 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2405 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002406 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002407#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002408
Hanno Beckerb50a2532018-08-06 11:52:54 +01002409 /* Double-check that we did not exceed the bounds
2410 * of the outgoing record buffer.
2411 * This should never fail as the various message
2412 * writing functions must obey the bounds of the
2413 * outgoing record buffer, but better be safe.
2414 *
2415 * Note: We deliberately do not check for the MTU or MFL here.
2416 */
2417 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2418 {
2419 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002420 "size %" MBEDTLS_PRINTF_SIZET
2421 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002422 ssl->out_msglen,
2423 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002424 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2425 }
2426
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002427 /*
2428 * Fill handshake headers
2429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002431 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002432 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2433 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2434 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002435
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002436 /*
2437 * DTLS has additional fields in the Handshake layer,
2438 * between the length field and the actual payload:
2439 * uint16 message_seq;
2440 * uint24 fragment_offset;
2441 * uint24 fragment_length;
2442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002444 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002445 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002446 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002447 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002448 {
2449 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002450 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002451 hs_len,
2452 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002453 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2454 }
2455
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002456 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002457 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002458
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002459 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002460 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002461 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002462 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002463 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002464 }
2465 else
2466 {
2467 ssl->out_msg[4] = 0;
2468 ssl->out_msg[5] = 0;
2469 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002470
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002471 /* Handshake hashes are computed without fragmentation,
2472 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002473 memset( ssl->out_msg + 6, 0x00, 3 );
2474 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002475 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002477
Hanno Becker0207e532018-08-28 10:28:28 +01002478 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002479 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002480 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002481 }
2482
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002483 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002485 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002486 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2487 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002488 {
2489 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2490 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002492 return( ret );
2493 }
2494 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002495 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002496#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002497 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002498 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002499 {
2500 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2501 return( ret );
2502 }
2503 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002504
2505 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2506
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002507 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002508}
2509
2510/*
2511 * Record layer functions
2512 */
2513
2514/*
2515 * Write current record.
2516 *
2517 * Uses:
2518 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2519 * - ssl->out_msglen: length of the record content (excl headers)
2520 * - ssl->out_msg: record content
2521 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002522int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002523{
2524 int ret, done = 0;
2525 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002526 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002527
2528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002529
Paul Bakker05ef8352012-05-08 09:17:57 +00002530 if( !done )
2531 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002532 unsigned i;
2533 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002534#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2535 size_t out_buf_len = ssl->out_buf_len;
2536#else
2537 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2538#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002539 /* Skip writing the record content type to after the encryption,
2540 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002541 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002542#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002543 /* TLS 1.3 still uses the TLS 1.2 version identifier
2544 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002545 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2546 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002547#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002548 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2549 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002550
Jerry Yuae0b2e22021-10-08 15:21:19 +08002551 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002552 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002553
Paul Bakker48916f92012-09-16 19:57:18 +00002554 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002555 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002556 mbedtls_record rec;
2557
2558 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002559 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002560 rec.data_len = ssl->out_msglen;
2561 rec.data_offset = ssl->out_msg - rec.buf;
2562
Jerry Yud96a5c22021-09-29 17:46:51 +08002563 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002564 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002565 ssl->conf->transport, rec.ver );
2566 rec.type = ssl->out_msgtype;
2567
Hanno Beckera0e20d02019-05-15 14:03:01 +01002568#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002569 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002570 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002571#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002572
Hanno Beckera18d1322018-01-03 14:27:32 +00002573 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002574 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002575 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002577 return( ret );
2578 }
2579
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002580 if( rec.data_offset != 0 )
2581 {
2582 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2583 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2584 }
2585
Hanno Becker6430faf2019-05-08 11:57:13 +01002586 /* Update the record content type and CID. */
2587 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002588#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002589 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002590#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002591 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002592 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002593 }
2594
Hanno Becker5903de42019-05-03 14:46:38 +01002595 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002596
2597#if defined(MBEDTLS_SSL_PROTO_DTLS)
2598 /* In case of DTLS, double-check that we don't exceed
2599 * the remaining space in the datagram. */
2600 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2601 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002602 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002603 if( ret < 0 )
2604 return( ret );
2605
2606 if( protected_record_size > (size_t) ret )
2607 {
2608 /* Should never happen */
2609 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2610 }
2611 }
2612#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002613
Hanno Becker6430faf2019-05-08 11:57:13 +01002614 /* Now write the potentially updated record content type. */
2615 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2616
Paul Elliott9f352112020-12-09 14:55:45 +00002617 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002618 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002619 ssl->out_hdr[0], ssl->out_hdr[1],
2620 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002623 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002624
2625 ssl->out_left += protected_record_size;
2626 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002627 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002628
Hanno Beckerdd772292020-02-05 10:38:31 +00002629 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002630 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2631 break;
2632
2633 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002634 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002635 {
2636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2637 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2638 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002639 }
2640
Hanno Becker67bc7c32018-08-06 11:33:50 +01002641#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002642 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2643 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002644 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002645 size_t remaining;
2646 ret = ssl_get_remaining_payload_in_datagram( ssl );
2647 if( ret < 0 )
2648 {
2649 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2650 ret );
2651 return( ret );
2652 }
2653
2654 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002655 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002656 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002657 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002658 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002659 else
2660 {
Hanno Becker513815a2018-08-20 11:56:09 +01002661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002662 }
2663 }
2664#endif /* MBEDTLS_SSL_PROTO_DTLS */
2665
2666 if( ( flush == SSL_FORCE_FLUSH ) &&
2667 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002668 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002670 return( ret );
2671 }
2672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002674
2675 return( 0 );
2676}
2677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002679
2680static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2681{
2682 if( ssl->in_msglen < ssl->in_hslen ||
2683 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2684 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2685 {
2686 return( 1 );
2687 }
2688 return( 0 );
2689}
Hanno Becker44650b72018-08-16 12:51:11 +01002690
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002691static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002692{
2693 return( ( ssl->in_msg[9] << 16 ) |
2694 ( ssl->in_msg[10] << 8 ) |
2695 ssl->in_msg[11] );
2696}
2697
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002698static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002699{
2700 return( ( ssl->in_msg[6] << 16 ) |
2701 ( ssl->in_msg[7] << 8 ) |
2702 ssl->in_msg[8] );
2703}
2704
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002705static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002706{
2707 uint32_t msg_len, frag_off, frag_len;
2708
2709 msg_len = ssl_get_hs_total_len( ssl );
2710 frag_off = ssl_get_hs_frag_off( ssl );
2711 frag_len = ssl_get_hs_frag_len( ssl );
2712
2713 if( frag_off > msg_len )
2714 return( -1 );
2715
2716 if( frag_len > msg_len - frag_off )
2717 return( -1 );
2718
2719 if( frag_len + 12 > ssl->in_msglen )
2720 return( -1 );
2721
2722 return( 0 );
2723}
2724
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002725/*
2726 * Mark bits in bitmask (used for DTLS HS reassembly)
2727 */
2728static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2729{
2730 unsigned int start_bits, end_bits;
2731
2732 start_bits = 8 - ( offset % 8 );
2733 if( start_bits != 8 )
2734 {
2735 size_t first_byte_idx = offset / 8;
2736
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002737 /* Special case */
2738 if( len <= start_bits )
2739 {
2740 for( ; len != 0; len-- )
2741 mask[first_byte_idx] |= 1 << ( start_bits - len );
2742
2743 /* Avoid potential issues with offset or len becoming invalid */
2744 return;
2745 }
2746
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002747 offset += start_bits; /* Now offset % 8 == 0 */
2748 len -= start_bits;
2749
2750 for( ; start_bits != 0; start_bits-- )
2751 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2752 }
2753
2754 end_bits = len % 8;
2755 if( end_bits != 0 )
2756 {
2757 size_t last_byte_idx = ( offset + len ) / 8;
2758
2759 len -= end_bits; /* Now len % 8 == 0 */
2760
2761 for( ; end_bits != 0; end_bits-- )
2762 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2763 }
2764
2765 memset( mask + offset / 8, 0xFF, len / 8 );
2766}
2767
2768/*
2769 * Check that bitmask is full
2770 */
2771static int ssl_bitmask_check( unsigned char *mask, size_t len )
2772{
2773 size_t i;
2774
2775 for( i = 0; i < len / 8; i++ )
2776 if( mask[i] != 0xFF )
2777 return( -1 );
2778
2779 for( i = 0; i < len % 8; i++ )
2780 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2781 return( -1 );
2782
2783 return( 0 );
2784}
2785
Hanno Becker56e205e2018-08-16 09:06:12 +01002786/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002787static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002788 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002789{
Hanno Becker56e205e2018-08-16 09:06:12 +01002790 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002791
Hanno Becker56e205e2018-08-16 09:06:12 +01002792 alloc_len = 12; /* Handshake header */
2793 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002794
Hanno Beckerd07df862018-08-16 09:14:58 +01002795 if( add_bitmap )
2796 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002797
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002798 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002799}
Hanno Becker56e205e2018-08-16 09:06:12 +01002800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002802
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002803static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002804{
2805 return( ( ssl->in_msg[1] << 16 ) |
2806 ( ssl->in_msg[2] << 8 ) |
2807 ssl->in_msg[3] );
2808}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002809
Simon Butcher99000142016-10-13 17:21:01 +01002810int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002811{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002813 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002814 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002815 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002817 }
2818
Hanno Becker12555c62018-08-16 12:47:53 +01002819 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002822 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002823 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002824
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002826 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002827 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002829 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002830
Hanno Becker44650b72018-08-16 12:51:11 +01002831 if( ssl_check_hs_header( ssl ) != 0 )
2832 {
2833 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2834 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2835 }
2836
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002837 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00002838 ( ( mbedtls_ssl_is_handshake_over( ssl ) == 0 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002839 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002840 ( mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002841 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002842 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002843 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2844 {
2845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2846 recv_msg_seq,
2847 ssl->handshake->in_msg_seq ) );
2848 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2849 }
2850
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002851 /* Retransmit only on last message from previous flight, to avoid
2852 * too many retransmissions.
2853 * Besides, No sane server ever retransmits HelloVerifyRequest */
2854 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002856 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002858 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002859 recv_msg_seq,
2860 ssl->handshake->in_flight_start_seq ) );
2861
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002865 return( ret );
2866 }
2867 }
2868 else
2869 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002871 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002872 recv_msg_seq,
2873 ssl->handshake->in_msg_seq ) );
2874 }
2875
Hanno Becker90333da2017-10-10 11:27:13 +01002876 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002877 }
2878 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002879
Hanno Becker6d97ef52018-08-16 13:09:04 +01002880 /* Message reassembly is handled alongside buffering of future
2881 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002882 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002883 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002884 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002885 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002887 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002888 }
2889 }
2890 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002892 /* With TLS we don't handle fragmentation (for now) */
2893 if( ssl->in_msglen < ssl->in_hslen )
2894 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2896 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002897 }
2898
Simon Butcher99000142016-10-13 17:21:01 +01002899 return( 0 );
2900}
2901
2902void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2903{
Hanno Becker0271f962018-08-16 13:23:47 +01002904 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002905
Paul Elliott27b0d942022-03-18 21:55:32 +00002906 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002907 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002908 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002909 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002910
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002911 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002913 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002914 ssl->handshake != NULL )
2915 {
Hanno Becker0271f962018-08-16 13:23:47 +01002916 unsigned offset;
2917 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002918
Hanno Becker0271f962018-08-16 13:23:47 +01002919 /* Increment handshake sequence number */
2920 hs->in_msg_seq++;
2921
2922 /*
2923 * Clear up handshake buffering and reassembly structure.
2924 */
2925
2926 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002927 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002928
2929 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002930 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2931 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002932 offset++, hs_buf++ )
2933 {
2934 *hs_buf = *(hs_buf + 1);
2935 }
2936
2937 /* Create a fresh last entry */
2938 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002939 }
2940#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002941}
2942
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002943/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002944 * DTLS anti-replay: RFC 6347 4.1.2.6
2945 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002946 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2947 * Bit n is set iff record number in_window_top - n has been seen.
2948 *
2949 * Usually, in_window_top is the last record number seen and the lsb of
2950 * in_window is set. The only exception is the initial state (record number 0
2951 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002954void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002955{
2956 ssl->in_window_top = 0;
2957 ssl->in_window = 0;
2958}
2959
2960static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2961{
2962 return( ( (uint64_t) buf[0] << 40 ) |
2963 ( (uint64_t) buf[1] << 32 ) |
2964 ( (uint64_t) buf[2] << 24 ) |
2965 ( (uint64_t) buf[3] << 16 ) |
2966 ( (uint64_t) buf[4] << 8 ) |
2967 ( (uint64_t) buf[5] ) );
2968}
2969
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002970static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2971{
Janos Follath865b3eb2019-12-16 11:46:15 +00002972 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002973 unsigned char *original_in_ctr;
2974
2975 // save original in_ctr
2976 original_in_ctr = ssl->in_ctr;
2977
2978 // use counter from record
2979 ssl->in_ctr = record_in_ctr;
2980
2981 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2982
2983 // restore the counter
2984 ssl->in_ctr = original_in_ctr;
2985
2986 return ret;
2987}
2988
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002989/*
2990 * Return 0 if sequence number is acceptable, -1 otherwise
2991 */
Hanno Becker0183d692019-07-12 08:50:37 +01002992int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002993{
2994 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2995 uint64_t bit;
2996
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002997 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002998 return( 0 );
2999
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003000 if( rec_seqnum > ssl->in_window_top )
3001 return( 0 );
3002
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003003 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003004
3005 if( bit >= 64 )
3006 return( -1 );
3007
3008 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3009 return( -1 );
3010
3011 return( 0 );
3012}
3013
3014/*
3015 * Update replay window on new validated record
3016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003018{
3019 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3020
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003021 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003022 return;
3023
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003024 if( rec_seqnum > ssl->in_window_top )
3025 {
3026 /* Update window_top and the contents of the window */
3027 uint64_t shift = rec_seqnum - ssl->in_window_top;
3028
3029 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003030 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003031 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003032 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003033 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003034 ssl->in_window |= 1;
3035 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003036
3037 ssl->in_window_top = rec_seqnum;
3038 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003039 else
3040 {
3041 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003042 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003043
3044 if( bit < 64 ) /* Always true, but be extra sure */
3045 ssl->in_window |= (uint64_t) 1 << bit;
3046 }
3047}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003049
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003050#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003051/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003052 * Without any SSL context, check if a datagram looks like a ClientHello with
3053 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003054 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003055 *
3056 * - if cookie is valid, return 0
3057 * - if ClientHello looks superficially valid but cookie is not,
3058 * fill obuf and set olen, then
3059 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3060 * - otherwise return a specific error code
3061 */
3062static int ssl_check_dtls_clihlo_cookie(
3063 mbedtls_ssl_cookie_write_t *f_cookie_write,
3064 mbedtls_ssl_cookie_check_t *f_cookie_check,
3065 void *p_cookie,
3066 const unsigned char *cli_id, size_t cli_id_len,
3067 const unsigned char *in, size_t in_len,
3068 unsigned char *obuf, size_t buf_len, size_t *olen )
3069{
3070 size_t sid_len, cookie_len;
3071 unsigned char *p;
3072
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003073 /*
3074 * Structure of ClientHello with record and handshake headers,
3075 * and expected values. We don't need to check a lot, more checks will be
3076 * done when actually parsing the ClientHello - skipping those checks
3077 * avoids code duplication and does not make cookie forging any easier.
3078 *
3079 * 0-0 ContentType type; copied, must be handshake
3080 * 1-2 ProtocolVersion version; copied
3081 * 3-4 uint16 epoch; copied, must be 0
3082 * 5-10 uint48 sequence_number; copied
3083 * 11-12 uint16 length; (ignored)
3084 *
3085 * 13-13 HandshakeType msg_type; (ignored)
3086 * 14-16 uint24 length; (ignored)
3087 * 17-18 uint16 message_seq; copied
3088 * 19-21 uint24 fragment_offset; copied, must be 0
3089 * 22-24 uint24 fragment_length; (ignored)
3090 *
3091 * 25-26 ProtocolVersion client_version; (ignored)
3092 * 27-58 Random random; (ignored)
3093 * 59-xx SessionID session_id; 1 byte len + sid_len content
3094 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3095 * ...
3096 *
3097 * Minimum length is 61 bytes.
3098 */
3099 if( in_len < 61 ||
3100 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3101 in[3] != 0 || in[4] != 0 ||
3102 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3103 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003104 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003105 }
3106
3107 sid_len = in[59];
3108 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003109 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003110
3111 cookie_len = in[60 + sid_len];
3112 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003113 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003114
3115 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3116 cli_id, cli_id_len ) == 0 )
3117 {
3118 /* Valid cookie */
3119 return( 0 );
3120 }
3121
3122 /*
3123 * If we get here, we've got an invalid cookie, let's prepare HVR.
3124 *
3125 * 0-0 ContentType type; copied
3126 * 1-2 ProtocolVersion version; copied
3127 * 3-4 uint16 epoch; copied
3128 * 5-10 uint48 sequence_number; copied
3129 * 11-12 uint16 length; olen - 13
3130 *
3131 * 13-13 HandshakeType msg_type; hello_verify_request
3132 * 14-16 uint24 length; olen - 25
3133 * 17-18 uint16 message_seq; copied
3134 * 19-21 uint24 fragment_offset; copied
3135 * 22-24 uint24 fragment_length; olen - 25
3136 *
3137 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3138 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3139 *
3140 * Minimum length is 28.
3141 */
3142 if( buf_len < 28 )
3143 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3144
3145 /* Copy most fields and adapt others */
3146 memcpy( obuf, in, 25 );
3147 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3148 obuf[25] = 0xfe;
3149 obuf[26] = 0xff;
3150
3151 /* Generate and write actual cookie */
3152 p = obuf + 28;
3153 if( f_cookie_write( p_cookie,
3154 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3155 {
3156 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3157 }
3158
3159 *olen = p - obuf;
3160
3161 /* Go back and fill length fields */
3162 obuf[27] = (unsigned char)( *olen - 28 );
3163
Joe Subbianifbeb6922021-07-16 14:27:50 +01003164 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3165 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3166 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003167
Joe Subbiani6dd73642021-07-19 11:56:54 +01003168 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003169
3170 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3171}
3172
3173/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003174 * Handle possible client reconnect with the same UDP quadruplet
3175 * (RFC 6347 Section 4.2.8).
3176 *
3177 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3178 * that looks like a ClientHello.
3179 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003180 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003181 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003182 * - if the input looks like a ClientHello with a valid cookie,
3183 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003184 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003185 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003186 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003187 * This function is called (through ssl_check_client_reconnect()) when an
3188 * unexpected record is found in ssl_get_next_record(), which will discard the
3189 * record if we return 0, and bubble up the return value otherwise (this
3190 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3191 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003192 */
3193static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3194{
Janos Follath865b3eb2019-12-16 11:46:15 +00003195 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003196 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003197
Hanno Becker2fddd372019-07-10 14:37:41 +01003198 if( ssl->conf->f_cookie_write == NULL ||
3199 ssl->conf->f_cookie_check == NULL )
3200 {
3201 /* If we can't use cookies to verify reachability of the peer,
3202 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003203 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3204 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003205 return( 0 );
3206 }
3207
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003208 ret = ssl_check_dtls_clihlo_cookie(
3209 ssl->conf->f_cookie_write,
3210 ssl->conf->f_cookie_check,
3211 ssl->conf->p_cookie,
3212 ssl->cli_id, ssl->cli_id_len,
3213 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003214 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003215
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003216 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3217
3218 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003219 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003220 int send_ret;
3221 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3222 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3223 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003224 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003225 * If the error is permanent we'll catch it later,
3226 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003227 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3228 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3229 (void) send_ret;
3230
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003231 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003232 }
3233
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003234 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003235 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003236 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003237 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003238 {
3239 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3240 return( ret );
3241 }
3242
3243 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003244 }
3245
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003246 return( ret );
3247}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003248#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003249
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003250static int ssl_check_record_type( uint8_t record_type )
3251{
3252 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3253 record_type != MBEDTLS_SSL_MSG_ALERT &&
3254 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3255 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3256 {
3257 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3258 }
3259
3260 return( 0 );
3261}
3262
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003263/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003264 * ContentType type;
3265 * ProtocolVersion version;
3266 * uint16 epoch; // DTLS only
3267 * uint48 sequence_number; // DTLS only
3268 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003269 *
3270 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003271 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003272 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3273 *
3274 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003275 * 1. proceed with the record if this function returns 0
3276 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3277 * 3. return CLIENT_RECONNECT if this function return that value
3278 * 4. drop the whole datagram if this function returns anything else.
3279 * Point 2 is needed when the peer is resending, and we have already received
3280 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003281 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003282static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003283 unsigned char *buf,
3284 size_t len,
3285 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003286{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003287 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003288
Hanno Beckere5e7e782019-07-11 12:29:35 +01003289 size_t const rec_hdr_type_offset = 0;
3290 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003291
Hanno Beckere5e7e782019-07-11 12:29:35 +01003292 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3293 rec_hdr_type_len;
3294 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003295
Hanno Beckere5e7e782019-07-11 12:29:35 +01003296 size_t const rec_hdr_ctr_len = 8;
3297#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003298 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003299 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3300 rec_hdr_version_len;
3301
Hanno Beckera0e20d02019-05-15 14:03:01 +01003302#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003303 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3304 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003305 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003306#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3307#endif /* MBEDTLS_SSL_PROTO_DTLS */
3308
3309 size_t rec_hdr_len_offset; /* To be determined */
3310 size_t const rec_hdr_len_len = 2;
3311
3312 /*
3313 * Check minimum lengths for record header.
3314 */
3315
3316#if defined(MBEDTLS_SSL_PROTO_DTLS)
3317 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3318 {
3319 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3320 }
3321 else
3322#endif /* MBEDTLS_SSL_PROTO_DTLS */
3323 {
3324 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3325 }
3326
3327 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3328 {
3329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3330 (unsigned) len,
3331 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3332 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3333 }
3334
3335 /*
3336 * Parse and validate record content type
3337 */
3338
3339 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003340
3341 /* Check record content type */
3342#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3343 rec->cid_len = 0;
3344
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003345 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003346 ssl->conf->cid_len != 0 &&
3347 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003348 {
3349 /* Shift pointers to account for record header including CID
3350 * struct {
3351 * ContentType special_type = tls12_cid;
3352 * ProtocolVersion version;
3353 * uint16 epoch;
3354 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003355 * opaque cid[cid_length]; // Additional field compared to
3356 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003357 * uint16 length;
3358 * opaque enc_content[DTLSCiphertext.length];
3359 * } DTLSCiphertext;
3360 */
3361
3362 /* So far, we only support static CID lengths
3363 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003364 rec_hdr_cid_len = ssl->conf->cid_len;
3365 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003366
Hanno Beckere5e7e782019-07-11 12:29:35 +01003367 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003368 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3370 (unsigned) len,
3371 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003372 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003373 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003374
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003375 /* configured CID len is guaranteed at most 255, see
3376 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3377 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003378 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003379 }
3380 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003381#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003382 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003383 if( ssl_check_record_type( rec->type ) )
3384 {
Hanno Becker54229812019-07-12 14:40:00 +01003385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3386 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003387 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3388 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003389 }
3390
Hanno Beckere5e7e782019-07-11 12:29:35 +01003391 /*
3392 * Parse and validate record version
3393 */
3394
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003395 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3396 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003397 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3398 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003399 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003400
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003401 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3404 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003405 }
3406
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003407 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003408 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003409 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3410 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003411 }
3412
Hanno Beckere5e7e782019-07-11 12:29:35 +01003413 /*
3414 * Parse/Copy record sequence number.
3415 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003416
Hanno Beckere5e7e782019-07-11 12:29:35 +01003417#if defined(MBEDTLS_SSL_PROTO_DTLS)
3418 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003419 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003420 /* Copy explicit record sequence number from input buffer. */
3421 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3422 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003423 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003424 else
3425#endif /* MBEDTLS_SSL_PROTO_DTLS */
3426 {
3427 /* Copy implicit record sequence number from SSL context structure. */
3428 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3429 }
Paul Bakker40e46942009-01-03 21:51:57 +00003430
Hanno Beckere5e7e782019-07-11 12:29:35 +01003431 /*
3432 * Parse record length.
3433 */
3434
Hanno Beckere5e7e782019-07-11 12:29:35 +01003435 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003436 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3437 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003438 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003439
Paul Elliott9f352112020-12-09 14:55:45 +00003440 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003441 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003442 rec->type,
3443 major_ver, minor_ver, rec->data_len ) );
3444
3445 rec->buf = buf;
3446 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003447
Hanno Beckerd417cc92019-07-26 08:20:27 +01003448 if( rec->data_len == 0 )
3449 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003450
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003451 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003452 * DTLS-related tests.
3453 * Check epoch before checking length constraint because
3454 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3455 * message gets duplicated before the corresponding Finished message,
3456 * the second ChangeCipherSpec should be discarded because it belongs
3457 * to an old epoch, but not because its length is shorter than
3458 * the minimum record length for packets using the new record transform.
3459 * Note that these two kinds of failures are handled differently,
3460 * as an unexpected record is silently skipped but an invalid
3461 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003462 */
3463#if defined(MBEDTLS_SSL_PROTO_DTLS)
3464 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3465 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003466 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003467
Hanno Becker955a5c92019-07-10 17:12:07 +01003468 /* Check that the datagram is large enough to contain a record
3469 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003470 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003471 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003472 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3473 (unsigned) len,
3474 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003475 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3476 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003477
Hanno Becker37cfe732019-07-10 17:20:01 +01003478 /* Records from other, non-matching epochs are silently discarded.
3479 * (The case of same-port Client reconnects must be considered in
3480 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003481 if( rec_epoch != ssl->in_epoch )
3482 {
3483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003484 "expected %u, received %lu",
3485 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003486
Hanno Becker552f7472019-07-19 10:59:12 +01003487 /* Records from the next epoch are considered for buffering
3488 * (concretely: early Finished messages). */
3489 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003490 {
Hanno Becker552f7472019-07-19 10:59:12 +01003491 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3492 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003493 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003494
Hanno Becker2fddd372019-07-10 14:37:41 +01003495 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003496 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003497#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003498 /* For records from the correct epoch, check whether their
3499 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003500 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3501 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003502 {
3503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3504 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3505 }
3506#endif
3507 }
3508#endif /* MBEDTLS_SSL_PROTO_DTLS */
3509
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003510 return( 0 );
3511}
Paul Bakker5121ce52009-01-03 21:22:43 +00003512
Paul Bakker5121ce52009-01-03 21:22:43 +00003513
Hanno Becker2fddd372019-07-10 14:37:41 +01003514#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3515static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3516{
3517 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3518
3519 /*
3520 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3521 * access the first byte of record content (handshake type), as we
3522 * have an active transform (possibly iv_len != 0), so use the
3523 * fact that the record header len is 13 instead.
3524 */
3525 if( rec_epoch == 0 &&
3526 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Paul Elliott27b0d942022-03-18 21:55:32 +00003527 mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003528 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3529 ssl->in_left > 13 &&
3530 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3531 {
3532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3533 "from the same port" ) );
3534 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003535 }
3536
3537 return( 0 );
3538}
Hanno Becker2fddd372019-07-10 14:37:41 +01003539#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003540
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003541/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003542 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003543 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003544static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3545 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003546{
3547 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003550 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003551
Ronald Cron7e38cba2021-11-24 12:43:39 +01003552 /*
3553 * In TLS 1.3, always treat ChangeCipherSpec records
3554 * as unencrypted. The only thing we do with them is
3555 * check the length and content and ignore them.
3556 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003557#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003558 if( ssl->transform_in != NULL &&
3559 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3560 {
3561 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3562 done = 1;
3563 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003564#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003565
Paul Bakker48916f92012-09-16 19:57:18 +00003566 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003567 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003568 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003569
Hanno Beckera18d1322018-01-03 14:27:32 +00003570 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003571 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003572 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003574
Hanno Beckera0e20d02019-05-15 14:03:01 +01003575#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003576 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3577 ssl->conf->ignore_unexpected_cid
3578 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3579 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003580 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003581 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003582 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003583#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003584
Paul Bakker5121ce52009-01-03 21:22:43 +00003585 return( ret );
3586 }
3587
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003588 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003589 {
3590 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003591 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003592 }
3593
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003594 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003595 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003596
Hanno Beckera0e20d02019-05-15 14:03:01 +01003597#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003598 /* We have already checked the record content type
3599 * in ssl_parse_record_header(), failing or silently
3600 * dropping the record in the case of an unknown type.
3601 *
3602 * Since with the use of CIDs, the record content type
3603 * might change during decryption, re-check the record
3604 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003605 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003606 {
3607 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3608 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3609 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003610#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003611
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003612 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003613 {
3614#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3615 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003616 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003617 {
3618 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3620 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3621 }
3622#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3623
3624 ssl->nb_zero++;
3625
3626 /*
3627 * Three or more empty messages may be a DoS attack
3628 * (excessive CPU consumption).
3629 */
3630 if( ssl->nb_zero > 3 )
3631 {
3632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003633 "messages, possible DoS attack" ) );
3634 /* Treat the records as if they were not properly authenticated,
3635 * thereby failing the connection if we see more than allowed
3636 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003637 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3638 }
3639 }
3640 else
3641 ssl->nb_zero = 0;
3642
3643#if defined(MBEDTLS_SSL_PROTO_DTLS)
3644 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3645 {
3646 ; /* in_ctr read from peer, not maintained internally */
3647 }
3648 else
3649#endif
3650 {
3651 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003652 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3653 i > mbedtls_ssl_ep_len( ssl ); i-- )
3654 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003655 if( ++ssl->in_ctr[i - 1] != 0 )
3656 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003657 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003658
3659 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003660 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003661 {
3662 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3663 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3664 }
3665 }
3666
Paul Bakker5121ce52009-01-03 21:22:43 +00003667 }
3668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003669#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003670 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003671 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003672 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003673 }
3674#endif
3675
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003676 /* Check actual (decrypted) record content length against
3677 * configured maximum. */
3678 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3679 {
3680 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3681 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3682 }
3683
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003684 return( 0 );
3685}
3686
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003687/*
3688 * Read a record.
3689 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003690 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3691 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3692 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003693 */
Hanno Becker1097b342018-08-15 14:09:41 +01003694
3695/* Helper functions for mbedtls_ssl_read_record(). */
3696static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003697static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3698static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003699
Hanno Becker327c93b2018-08-15 13:56:18 +01003700int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003701 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003702{
Janos Follath865b3eb2019-12-16 11:46:15 +00003703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003705 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003706
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003707 if( ssl->keep_current_message == 0 )
3708 {
3709 do {
Simon Butcher99000142016-10-13 17:21:01 +01003710
Hanno Becker26994592018-08-15 14:14:59 +01003711 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003712 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003713 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003714
Hanno Beckere74d5562018-08-15 14:26:08 +01003715 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003716 {
Hanno Becker40f50842018-08-15 14:48:01 +01003717#if defined(MBEDTLS_SSL_PROTO_DTLS)
3718 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003719
Hanno Becker40f50842018-08-15 14:48:01 +01003720 /* We only check for buffered messages if the
3721 * current datagram is fully consumed. */
3722 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003723 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003724 {
Hanno Becker40f50842018-08-15 14:48:01 +01003725 if( ssl_load_buffered_message( ssl ) == 0 )
3726 have_buffered = 1;
3727 }
3728
3729 if( have_buffered == 0 )
3730#endif /* MBEDTLS_SSL_PROTO_DTLS */
3731 {
3732 ret = ssl_get_next_record( ssl );
3733 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3734 continue;
3735
3736 if( ret != 0 )
3737 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003738 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003739 return( ret );
3740 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003741 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003742 }
3743
3744 ret = mbedtls_ssl_handle_message_type( ssl );
3745
Hanno Becker40f50842018-08-15 14:48:01 +01003746#if defined(MBEDTLS_SSL_PROTO_DTLS)
3747 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3748 {
3749 /* Buffer future message */
3750 ret = ssl_buffer_message( ssl );
3751 if( ret != 0 )
3752 return( ret );
3753
3754 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3755 }
3756#endif /* MBEDTLS_SSL_PROTO_DTLS */
3757
Hanno Becker90333da2017-10-10 11:27:13 +01003758 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3759 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003760
3761 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003762 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003763 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003764 return( ret );
3765 }
3766
Hanno Becker327c93b2018-08-15 13:56:18 +01003767 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003768 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003769 {
3770 mbedtls_ssl_update_handshake_status( ssl );
3771 }
Simon Butcher99000142016-10-13 17:21:01 +01003772 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003773 else
Simon Butcher99000142016-10-13 17:21:01 +01003774 {
Hanno Becker02f59072018-08-15 14:00:24 +01003775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003776 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003777 }
3778
3779 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3780
3781 return( 0 );
3782}
3783
Hanno Becker40f50842018-08-15 14:48:01 +01003784#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003785static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003786{
Hanno Becker40f50842018-08-15 14:48:01 +01003787 if( ssl->in_left > ssl->next_record_offset )
3788 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003789
Hanno Becker40f50842018-08-15 14:48:01 +01003790 return( 0 );
3791}
3792
3793static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3794{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003795 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003796 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003797 int ret = 0;
3798
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003799 if( hs == NULL )
3800 return( -1 );
3801
Hanno Beckere00ae372018-08-20 09:39:42 +01003802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3803
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003804 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3805 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3806 {
3807 /* Check if we have seen a ChangeCipherSpec before.
3808 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003809 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003810 {
3811 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3812 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003813 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003814 }
3815
Hanno Becker39b8bc92018-08-28 17:17:13 +01003816 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003817 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3818 ssl->in_msglen = 1;
3819 ssl->in_msg[0] = 1;
3820
3821 /* As long as they are equal, the exact value doesn't matter. */
3822 ssl->in_left = 0;
3823 ssl->next_record_offset = 0;
3824
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003825 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003826 goto exit;
3827 }
Hanno Becker37f95322018-08-16 13:55:32 +01003828
Hanno Beckerb8f50142018-08-28 10:01:34 +01003829#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003830 /* Debug only */
3831 {
3832 unsigned offset;
3833 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3834 {
3835 hs_buf = &hs->buffering.hs[offset];
3836 if( hs_buf->is_valid == 1 )
3837 {
3838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3839 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003840 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003841 }
3842 }
3843 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003844#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003845
3846 /* Check if we have buffered and/or fully reassembled the
3847 * next handshake message. */
3848 hs_buf = &hs->buffering.hs[0];
3849 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3850 {
3851 /* Synthesize a record containing the buffered HS message. */
3852 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3853 ( hs_buf->data[2] << 8 ) |
3854 hs_buf->data[3];
3855
3856 /* Double-check that we haven't accidentally buffered
3857 * a message that doesn't fit into the input buffer. */
3858 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3859 {
3860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3861 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3862 }
3863
3864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3865 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3866 hs_buf->data, msg_len + 12 );
3867
3868 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3869 ssl->in_hslen = msg_len + 12;
3870 ssl->in_msglen = msg_len + 12;
3871 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3872
3873 ret = 0;
3874 goto exit;
3875 }
3876 else
3877 {
3878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3879 hs->in_msg_seq ) );
3880 }
3881
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003882 ret = -1;
3883
3884exit:
3885
3886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3887 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003888}
3889
Hanno Beckera02b0b42018-08-21 17:20:27 +01003890static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3891 size_t desired )
3892{
3893 int offset;
3894 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003895 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3896 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003897
Hanno Becker01315ea2018-08-21 17:22:17 +01003898 /* Get rid of future records epoch first, if such exist. */
3899 ssl_free_buffered_record( ssl );
3900
3901 /* Check if we have enough space available now. */
3902 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3903 hs->buffering.total_bytes_buffered ) )
3904 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003905 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003906 return( 0 );
3907 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003908
Hanno Becker4f432ad2018-08-28 10:02:32 +01003909 /* We don't have enough space to buffer the next expected handshake
3910 * message. Remove buffers used for future messages to gain space,
3911 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003912 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3913 offset >= 0; offset-- )
3914 {
3915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3916 offset ) );
3917
Hanno Beckerb309b922018-08-23 13:18:05 +01003918 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003919
3920 /* Check if we have enough space available now. */
3921 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3922 hs->buffering.total_bytes_buffered ) )
3923 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003925 return( 0 );
3926 }
3927 }
3928
3929 return( -1 );
3930}
3931
Hanno Becker40f50842018-08-15 14:48:01 +01003932static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3933{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003934 int ret = 0;
3935 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3936
3937 if( hs == NULL )
3938 return( 0 );
3939
3940 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3941
3942 switch( ssl->in_msgtype )
3943 {
3944 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003946
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003947 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003948 break;
3949
3950 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003951 {
3952 unsigned recv_msg_seq_offset;
3953 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3954 mbedtls_ssl_hs_buffer *hs_buf;
3955 size_t msg_len = ssl->in_hslen - 12;
3956
3957 /* We should never receive an old handshake
3958 * message - double-check nonetheless. */
3959 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3960 {
3961 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3962 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3963 }
3964
3965 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3966 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3967 {
3968 /* Silently ignore -- message too far in the future */
3969 MBEDTLS_SSL_DEBUG_MSG( 2,
3970 ( "Ignore future HS message with sequence number %u, "
3971 "buffering window %u - %u",
3972 recv_msg_seq, ssl->handshake->in_msg_seq,
3973 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3974
3975 goto exit;
3976 }
3977
3978 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3979 recv_msg_seq, recv_msg_seq_offset ) );
3980
3981 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3982
3983 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003984 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003985 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003986 size_t reassembly_buf_sz;
3987
Hanno Becker37f95322018-08-16 13:55:32 +01003988 hs_buf->is_fragmented =
3989 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3990
3991 /* We copy the message back into the input buffer
3992 * after reassembly, so check that it's not too large.
3993 * This is an implementation-specific limitation
3994 * and not one from the standard, hence it is not
3995 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003996 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003997 {
3998 /* Ignore message */
3999 goto exit;
4000 }
4001
Hanno Beckere0b150f2018-08-21 15:51:03 +01004002 /* Check if we have enough space to buffer the message. */
4003 if( hs->buffering.total_bytes_buffered >
4004 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4005 {
4006 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4007 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4008 }
4009
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004010 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4011 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004012
4013 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4014 hs->buffering.total_bytes_buffered ) )
4015 {
4016 if( recv_msg_seq_offset > 0 )
4017 {
4018 /* If we can't buffer a future message because
4019 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004020 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4021 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4022 " (already %" MBEDTLS_PRINTF_SIZET
4023 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004024 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004025 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004026 goto exit;
4027 }
Hanno Beckere1801392018-08-21 16:51:05 +01004028 else
4029 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4031 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4032 " (already %" MBEDTLS_PRINTF_SIZET
4033 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004034 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004035 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004036 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004037
Hanno Beckera02b0b42018-08-21 17:20:27 +01004038 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004039 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004040 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4041 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4042 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4043 " (already %" MBEDTLS_PRINTF_SIZET
4044 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004045 msg_len,
4046 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004047 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004048 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004049 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4050 goto exit;
4051 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004052 }
4053
Paul Elliottd48d5c62021-01-07 14:47:05 +00004054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004055 msg_len ) );
4056
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004057 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4058 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004059 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004060 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004061 goto exit;
4062 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004063 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004064
4065 /* Prepare final header: copy msg_type, length and message_seq,
4066 * then add standardised fragment_offset and fragment_length */
4067 memcpy( hs_buf->data, ssl->in_msg, 6 );
4068 memset( hs_buf->data + 6, 0, 3 );
4069 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4070
4071 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004072
4073 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004074 }
4075 else
4076 {
4077 /* Make sure msg_type and length are consistent */
4078 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4079 {
4080 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4081 /* Ignore */
4082 goto exit;
4083 }
4084 }
4085
Hanno Becker4422bbb2018-08-20 09:40:19 +01004086 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004087 {
4088 size_t frag_len, frag_off;
4089 unsigned char * const msg = hs_buf->data + 12;
4090
4091 /*
4092 * Check and copy current fragment
4093 */
4094
4095 /* Validation of header fields already done in
4096 * mbedtls_ssl_prepare_handshake_record(). */
4097 frag_off = ssl_get_hs_frag_off( ssl );
4098 frag_len = ssl_get_hs_frag_len( ssl );
4099
Paul Elliottd48d5c62021-01-07 14:47:05 +00004100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4101 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004102 frag_off, frag_len ) );
4103 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4104
4105 if( hs_buf->is_fragmented )
4106 {
4107 unsigned char * const bitmask = msg + msg_len;
4108 ssl_bitmask_set( bitmask, frag_off, frag_len );
4109 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4110 msg_len ) == 0 );
4111 }
4112 else
4113 {
4114 hs_buf->is_complete = 1;
4115 }
4116
4117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4118 hs_buf->is_complete ? "" : "not yet " ) );
4119 }
4120
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004121 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004122 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004123
4124 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004125 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004126 break;
4127 }
4128
4129exit:
4130
4131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4132 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004133}
4134#endif /* MBEDTLS_SSL_PROTO_DTLS */
4135
Hanno Becker1097b342018-08-15 14:09:41 +01004136static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004137{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004138 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004139 * Consume last content-layer message and potentially
4140 * update in_msglen which keeps track of the contents'
4141 * consumption state.
4142 *
4143 * (1) Handshake messages:
4144 * Remove last handshake message, move content
4145 * and adapt in_msglen.
4146 *
4147 * (2) Alert messages:
4148 * Consume whole record content, in_msglen = 0.
4149 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004150 * (3) Change cipher spec:
4151 * Consume whole record content, in_msglen = 0.
4152 *
4153 * (4) Application data:
4154 * Don't do anything - the record layer provides
4155 * the application data as a stream transport
4156 * and consumes through mbedtls_ssl_read only.
4157 *
4158 */
4159
4160 /* Case (1): Handshake messages */
4161 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004162 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004163 /* Hard assertion to be sure that no application data
4164 * is in flight, as corrupting ssl->in_msglen during
4165 * ssl->in_offt != NULL is fatal. */
4166 if( ssl->in_offt != NULL )
4167 {
4168 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4169 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4170 }
4171
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004172 /*
4173 * Get next Handshake message in the current record
4174 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004175
Hanno Becker4a810fb2017-05-24 16:27:30 +01004176 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004177 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004178 * current handshake content: If DTLS handshake
4179 * fragmentation is used, that's the fragment
4180 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004181 * size here is faulty and should be changed at
4182 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004183 * (2) While it doesn't seem to cause problems, one
4184 * has to be very careful not to assume that in_hslen
4185 * is always <= in_msglen in a sensible communication.
4186 * Again, it's wrong for DTLS handshake fragmentation.
4187 * The following check is therefore mandatory, and
4188 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004189 * Additionally, ssl->in_hslen might be arbitrarily out of
4190 * bounds after handling a DTLS message with an unexpected
4191 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004192 */
4193 if( ssl->in_hslen < ssl->in_msglen )
4194 {
4195 ssl->in_msglen -= ssl->in_hslen;
4196 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4197 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004198
Hanno Becker4a810fb2017-05-24 16:27:30 +01004199 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4200 ssl->in_msg, ssl->in_msglen );
4201 }
4202 else
4203 {
4204 ssl->in_msglen = 0;
4205 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004206
Hanno Becker4a810fb2017-05-24 16:27:30 +01004207 ssl->in_hslen = 0;
4208 }
4209 /* Case (4): Application data */
4210 else if( ssl->in_offt != NULL )
4211 {
4212 return( 0 );
4213 }
4214 /* Everything else (CCS & Alerts) */
4215 else
4216 {
4217 ssl->in_msglen = 0;
4218 }
4219
Hanno Becker1097b342018-08-15 14:09:41 +01004220 return( 0 );
4221}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004222
Hanno Beckere74d5562018-08-15 14:26:08 +01004223static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4224{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004225 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004226 return( 1 );
4227
4228 return( 0 );
4229}
4230
Hanno Becker5f066e72018-08-16 14:56:31 +01004231#if defined(MBEDTLS_SSL_PROTO_DTLS)
4232
4233static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4234{
4235 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4236 if( hs == NULL )
4237 return;
4238
Hanno Becker01315ea2018-08-21 17:22:17 +01004239 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004240 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004241 hs->buffering.total_bytes_buffered -=
4242 hs->buffering.future_record.len;
4243
4244 mbedtls_free( hs->buffering.future_record.data );
4245 hs->buffering.future_record.data = NULL;
4246 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004247}
4248
4249static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4250{
4251 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4252 unsigned char * rec;
4253 size_t rec_len;
4254 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004255#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4256 size_t in_buf_len = ssl->in_buf_len;
4257#else
4258 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4259#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004260 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4261 return( 0 );
4262
4263 if( hs == NULL )
4264 return( 0 );
4265
Hanno Becker5f066e72018-08-16 14:56:31 +01004266 rec = hs->buffering.future_record.data;
4267 rec_len = hs->buffering.future_record.len;
4268 rec_epoch = hs->buffering.future_record.epoch;
4269
4270 if( rec == NULL )
4271 return( 0 );
4272
Hanno Becker4cb782d2018-08-20 11:19:05 +01004273 /* Only consider loading future records if the
4274 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004275 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004276 return( 0 );
4277
Hanno Becker5f066e72018-08-16 14:56:31 +01004278 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4279
4280 if( rec_epoch != ssl->in_epoch )
4281 {
4282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4283 goto exit;
4284 }
4285
4286 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4287
4288 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004289 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004290 {
4291 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4292 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4293 }
4294
4295 memcpy( ssl->in_hdr, rec, rec_len );
4296 ssl->in_left = rec_len;
4297 ssl->next_record_offset = 0;
4298
4299 ssl_free_buffered_record( ssl );
4300
4301exit:
4302 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4303 return( 0 );
4304}
4305
Hanno Becker519f15d2019-07-11 12:43:20 +01004306static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4307 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004308{
4309 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004310
4311 /* Don't buffer future records outside handshakes. */
4312 if( hs == NULL )
4313 return( 0 );
4314
4315 /* Only buffer handshake records (we are only interested
4316 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004317 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004318 return( 0 );
4319
4320 /* Don't buffer more than one future epoch record. */
4321 if( hs->buffering.future_record.data != NULL )
4322 return( 0 );
4323
Hanno Becker01315ea2018-08-21 17:22:17 +01004324 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004325 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004326 hs->buffering.total_bytes_buffered ) )
4327 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004328 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4329 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4330 " (already %" MBEDTLS_PRINTF_SIZET
4331 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004332 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004333 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004334 return( 0 );
4335 }
4336
Hanno Becker5f066e72018-08-16 14:56:31 +01004337 /* Buffer record */
4338 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004339 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004340 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004341
4342 /* ssl_parse_record_header() only considers records
4343 * of the next epoch as candidates for buffering. */
4344 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004345 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004346
4347 hs->buffering.future_record.data =
4348 mbedtls_calloc( 1, hs->buffering.future_record.len );
4349 if( hs->buffering.future_record.data == NULL )
4350 {
4351 /* If we run out of RAM trying to buffer a
4352 * record from the next epoch, just ignore. */
4353 return( 0 );
4354 }
4355
Hanno Becker519f15d2019-07-11 12:43:20 +01004356 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004357
Hanno Becker519f15d2019-07-11 12:43:20 +01004358 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004359 return( 0 );
4360}
4361
4362#endif /* MBEDTLS_SSL_PROTO_DTLS */
4363
Hanno Beckere74d5562018-08-15 14:26:08 +01004364static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004365{
Janos Follath865b3eb2019-12-16 11:46:15 +00004366 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004367 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004368
Hanno Becker5f066e72018-08-16 14:56:31 +01004369#if defined(MBEDTLS_SSL_PROTO_DTLS)
4370 /* We might have buffered a future record; if so,
4371 * and if the epoch matches now, load it.
4372 * On success, this call will set ssl->in_left to
4373 * the length of the buffered record, so that
4374 * the calls to ssl_fetch_input() below will
4375 * essentially be no-ops. */
4376 ret = ssl_load_buffered_record( ssl );
4377 if( ret != 0 )
4378 return( ret );
4379#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004380
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004381 /* Ensure that we have enough space available for the default form
4382 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4383 * with no space for CIDs counted in). */
4384 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4385 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004386 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004388 return( ret );
4389 }
4390
Hanno Beckere5e7e782019-07-11 12:29:35 +01004391 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4392 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004393 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004394#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004395 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004396 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004397 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4398 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004399 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004400 if( ret != 0 )
4401 return( ret );
4402
4403 /* Fall through to handling of unexpected records */
4404 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4405 }
4406
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004407 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4408 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004409#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004410 /* Reset in pointers to default state for TLS/DTLS records,
4411 * assuming no CID and no offset between record content and
4412 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004413 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004414
Hanno Becker7ae20e02019-07-12 08:33:49 +01004415 /* Setup internal message pointers from record structure. */
4416 ssl->in_msgtype = rec.type;
4417#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4418 ssl->in_len = ssl->in_cid + rec.cid_len;
4419#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4420 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4421 ssl->in_msglen = rec.data_len;
4422
Hanno Becker2fddd372019-07-10 14:37:41 +01004423 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004424 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004425 if( ret != 0 )
4426 return( ret );
4427#endif
4428
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004429 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004430 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004431
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4433 "(header)" ) );
4434 }
4435 else
4436 {
4437 /* Skip invalid record and the rest of the datagram */
4438 ssl->next_record_offset = 0;
4439 ssl->in_left = 0;
4440
4441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4442 "(header)" ) );
4443 }
4444
4445 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004446 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004447 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004448 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004449#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004450 {
4451 return( ret );
4452 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004453 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004455#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004456 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004457 {
Hanno Beckera8814792019-07-10 15:01:45 +01004458 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004459 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004460 if( ssl->next_record_offset < ssl->in_left )
4461 {
4462 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4463 }
4464 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004465 else
4466#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004467 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004468 /*
4469 * Fetch record contents from underlying transport.
4470 */
Hanno Beckera3175662019-07-11 12:50:29 +01004471 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004472 if( ret != 0 )
4473 {
4474 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4475 return( ret );
4476 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004477
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004478 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004479 }
4480
4481 /*
4482 * Decrypt record contents.
4483 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004484
Hanno Beckerfdf66042019-07-11 13:07:45 +01004485 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004487#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004488 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004489 {
4490 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004491 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004492 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004493 /* Except when waiting for Finished as a bad mac here
4494 * probably means something went wrong in the handshake
4495 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4496 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4497 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4498 {
4499#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4500 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4501 {
4502 mbedtls_ssl_send_alert_message( ssl,
4503 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4504 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4505 }
4506#endif
4507 return( ret );
4508 }
4509
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004510 if( ssl->conf->badmac_limit != 0 &&
4511 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4514 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004515 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004516
Hanno Becker4a810fb2017-05-24 16:27:30 +01004517 /* As above, invalid records cause
4518 * dismissal of the whole datagram. */
4519
4520 ssl->next_record_offset = 0;
4521 ssl->in_left = 0;
4522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004524 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004525 }
4526
4527 return( ret );
4528 }
4529 else
4530#endif
4531 {
4532 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4534 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004535 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004536 mbedtls_ssl_send_alert_message( ssl,
4537 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4538 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004539 }
4540#endif
4541 return( ret );
4542 }
4543 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004544
Hanno Becker44d89b22019-07-12 09:40:44 +01004545
4546 /* Reset in pointers to default state for TLS/DTLS records,
4547 * assuming no CID and no offset between record content and
4548 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004549 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004550#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4551 ssl->in_len = ssl->in_cid + rec.cid_len;
4552#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004553 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004554
Hanno Becker8685c822019-07-12 09:37:30 +01004555 /* The record content type may change during decryption,
4556 * so re-read it. */
4557 ssl->in_msgtype = rec.type;
4558 /* Also update the input buffer, because unfortunately
4559 * the server-side ssl_parse_client_hello() reparses the
4560 * record header when receiving a ClientHello initiating
4561 * a renegotiation. */
4562 ssl->in_hdr[0] = rec.type;
4563 ssl->in_msg = rec.buf + rec.data_offset;
4564 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004565 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004566
Simon Butcher99000142016-10-13 17:21:01 +01004567 return( 0 );
4568}
4569
4570int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4571{
Janos Follath865b3eb2019-12-16 11:46:15 +00004572 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004573
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004574 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004575 * Handle particular types of records
4576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004577 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004578 {
Simon Butcher99000142016-10-13 17:21:01 +01004579 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4580 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004581 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004582 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004583 }
4584
Hanno Beckere678eaa2018-08-21 14:57:46 +01004585 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004586 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004587 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004588 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004589 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004590 ssl->in_msglen ) );
4591 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004592 }
4593
Hanno Beckere678eaa2018-08-21 14:57:46 +01004594 if( ssl->in_msg[0] != 1 )
4595 {
4596 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4597 ssl->in_msg[0] ) );
4598 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4599 }
4600
4601#if defined(MBEDTLS_SSL_PROTO_DTLS)
4602 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4603 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4604 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4605 {
4606 if( ssl->handshake == NULL )
4607 {
4608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4609 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4610 }
4611
4612 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4613 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4614 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004615#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004616
Ronald Cron6f135e12021-12-08 16:57:54 +01004617#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004618 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4619 {
4620#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4621 MBEDTLS_SSL_DEBUG_MSG( 1,
4622 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4623 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4624#else
4625 MBEDTLS_SSL_DEBUG_MSG( 1,
4626 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4627 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4628#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4629 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004630#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004631 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004634 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004635 if( ssl->in_msglen != 2 )
4636 {
4637 /* Note: Standard allows for more than one 2 byte alert
4638 to be packed in a single message, but Mbed TLS doesn't
4639 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004640 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004641 ssl->in_msglen ) );
4642 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4643 }
4644
Paul Elliott9f352112020-12-09 14:55:45 +00004645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004646 ssl->in_msg[0], ssl->in_msg[1] ) );
4647
4648 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004649 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004650 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004651 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004652 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004653 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004654 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004655 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004656 }
4657
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004658 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4659 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004660 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4662 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004663 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004664
4665#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4666 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4667 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4668 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004669 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004670 /* Will be handled when trying to parse ServerHello */
4671 return( 0 );
4672 }
4673#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004674 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004675 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004676 }
4677
Hanno Beckerc76c6192017-06-06 10:03:17 +01004678#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004679 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004680 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004681 /* Drop unexpected ApplicationData records,
4682 * except at the beginning of renegotiations */
4683 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004684 mbedtls_ssl_is_handshake_over( ssl ) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004685#if defined(MBEDTLS_SSL_RENEGOTIATION)
4686 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4687 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004688#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004689 )
4690 {
4691 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4692 return( MBEDTLS_ERR_SSL_NON_FATAL );
4693 }
4694
4695 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004696 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker37ae9522019-05-03 16:54:26 +01004697 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004698 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004699 }
4700 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004701#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004702
Paul Bakker5121ce52009-01-03 21:22:43 +00004703 return( 0 );
4704}
4705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004707{
irwir6c0da642019-09-26 21:07:41 +03004708 return( mbedtls_ssl_send_alert_message( ssl,
4709 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4710 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004711}
4712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004714 unsigned char level,
4715 unsigned char message )
4716{
Janos Follath865b3eb2019-12-16 11:46:15 +00004717 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004718
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004719 if( ssl == NULL || ssl->conf == NULL )
4720 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004722 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004723 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004725 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004726 ssl->out_msglen = 2;
4727 ssl->out_msg[0] = level;
4728 ssl->out_msg[1] = message;
4729
Hanno Becker67bc7c32018-08-06 11:33:50 +01004730 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004731 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004733 return( ret );
4734 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004735 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004736
4737 return( 0 );
4738}
4739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004740int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004741{
Janos Follath865b3eb2019-12-16 11:46:15 +00004742 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004743
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004744 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004746 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004747 ssl->out_msglen = 1;
4748 ssl->out_msg[0] = 1;
4749
Paul Bakker5121ce52009-01-03 21:22:43 +00004750 ssl->state++;
4751
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004752 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004753 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004754 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004755 return( ret );
4756 }
4757
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004759
4760 return( 0 );
4761}
4762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004763int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004764{
Janos Follath865b3eb2019-12-16 11:46:15 +00004765 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004768
Hanno Becker327c93b2018-08-15 13:56:18 +01004769 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004770 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004771 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004772 return( ret );
4773 }
4774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004775 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004776 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004777 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004778 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4779 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004780 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004781 }
4782
Hanno Beckere678eaa2018-08-21 14:57:46 +01004783 /* CCS records are only accepted if they have length 1 and content '1',
4784 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004785
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004786 /*
4787 * Switch to our negotiated transform and session parameters for inbound
4788 * data.
4789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004791 ssl->transform_in = ssl->transform_negotiate;
4792 ssl->session_in = ssl->session_negotiate;
4793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004795 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004798 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004799#endif
4800
4801 /* Increment epoch */
4802 if( ++ssl->in_epoch == 0 )
4803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004805 /* This is highly unlikely to happen for legitimate reasons, so
4806 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004807 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004808 }
4809 }
4810 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004812 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004813
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004814 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004815
Paul Bakker5121ce52009-01-03 21:22:43 +00004816 ssl->state++;
4817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004819
4820 return( 0 );
4821}
4822
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004823/* Once ssl->out_hdr as the address of the beginning of the
4824 * next outgoing record is set, deduce the other pointers.
4825 *
4826 * Note: For TLS, we save the implicit record sequence number
4827 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4828 * and the caller has to make sure there's space for this.
4829 */
4830
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004831static size_t ssl_transform_get_explicit_iv_len(
4832 mbedtls_ssl_transform const *transform )
4833{
TRodziewiczef73f012021-05-13 14:53:36 +02004834 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004835 return( 0 );
4836
4837 return( transform->ivlen - transform->fixed_ivlen );
4838}
4839
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004840void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4841 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004842{
4843#if defined(MBEDTLS_SSL_PROTO_DTLS)
4844 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4845 {
4846 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004847#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004848 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004849 ssl->out_len = ssl->out_cid;
4850 if( transform != NULL )
4851 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004852#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004853 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004854#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004855 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004856 }
4857 else
4858#endif
4859 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004860 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004861#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004862 ssl->out_cid = ssl->out_len;
4863#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004864 ssl->out_iv = ssl->out_hdr + 5;
4865 }
4866
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004867 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004868 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004869 if( transform != NULL )
4870 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004871}
4872
4873/* Once ssl->in_hdr as the address of the beginning of the
4874 * next incoming record is set, deduce the other pointers.
4875 *
4876 * Note: For TLS, we save the implicit record sequence number
4877 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4878 * and the caller has to make sure there's space for this.
4879 */
4880
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004881void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004882{
Hanno Becker79594fd2019-05-08 09:38:41 +01004883 /* This function sets the pointers to match the case
4884 * of unprotected TLS/DTLS records, with both ssl->in_iv
4885 * and ssl->in_msg pointing to the beginning of the record
4886 * content.
4887 *
4888 * When decrypting a protected record, ssl->in_msg
4889 * will be shifted to point to the beginning of the
4890 * record plaintext.
4891 */
4892
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004893#if defined(MBEDTLS_SSL_PROTO_DTLS)
4894 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4895 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004896 /* This sets the header pointers to match records
4897 * without CID. When we receive a record containing
4898 * a CID, the fields are shifted accordingly in
4899 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004900 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004901#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004902 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004903 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004904#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004905 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004906#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004907 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004908 }
4909 else
4910#endif
4911 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004912 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004913 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004914#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004915 ssl->in_cid = ssl->in_len;
4916#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004917 ssl->in_iv = ssl->in_hdr + 5;
4918 }
4919
Hanno Becker79594fd2019-05-08 09:38:41 +01004920 /* This will be adjusted at record decryption time. */
4921 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004922}
4923
Paul Bakker5121ce52009-01-03 21:22:43 +00004924/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004925 * Setup an SSL context
4926 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004927
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004928void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004929{
4930 /* Set the incoming and outgoing record pointers. */
4931#if defined(MBEDTLS_SSL_PROTO_DTLS)
4932 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4933 {
4934 ssl->out_hdr = ssl->out_buf;
4935 ssl->in_hdr = ssl->in_buf;
4936 }
4937 else
4938#endif /* MBEDTLS_SSL_PROTO_DTLS */
4939 {
Hanno Becker12078f42021-03-02 15:28:41 +00004940 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004941 ssl->out_hdr = ssl->out_buf + 8;
4942 ssl->in_hdr = ssl->in_buf + 8;
4943 }
4944
4945 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004946 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4947 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004948}
4949
Paul Bakker5121ce52009-01-03 21:22:43 +00004950/*
4951 * SSL get accessors
4952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004953size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004954{
4955 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4956}
4957
Hanno Becker8b170a02017-10-10 11:51:19 +01004958int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4959{
4960 /*
4961 * Case A: We're currently holding back
4962 * a message for further processing.
4963 */
4964
4965 if( ssl->keep_current_message == 1 )
4966 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004967 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004968 return( 1 );
4969 }
4970
4971 /*
4972 * Case B: Further records are pending in the current datagram.
4973 */
4974
4975#if defined(MBEDTLS_SSL_PROTO_DTLS)
4976 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4977 ssl->in_left > ssl->next_record_offset )
4978 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004979 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004980 return( 1 );
4981 }
4982#endif /* MBEDTLS_SSL_PROTO_DTLS */
4983
4984 /*
4985 * Case C: A handshake message is being processed.
4986 */
4987
Hanno Becker8b170a02017-10-10 11:51:19 +01004988 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4989 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004990 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004991 return( 1 );
4992 }
4993
4994 /*
4995 * Case D: An application data message is being processed
4996 */
4997 if( ssl->in_offt != NULL )
4998 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004999 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005000 return( 1 );
5001 }
5002
5003 /*
5004 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005005 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005006 * we implement support for multiple alerts in single records.
5007 */
5008
5009 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5010 return( 0 );
5011}
5012
Paul Bakker43ca69c2011-01-15 17:35:19 +00005013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005015{
Hanno Becker3136ede2018-08-17 15:28:19 +01005016 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005017 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005018 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005019#if defined(MBEDTLS_USE_PSA_CRYPTO)
5020 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5021 psa_key_type_t key_type;
5022#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005023
Hanno Becker5903de42019-05-03 14:46:38 +01005024 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5025
Hanno Becker78640902018-08-13 16:35:15 +01005026 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005027 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005028
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005029
5030#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005031 if ( transform->psa_alg == PSA_ALG_GCM ||
5032 transform->psa_alg == PSA_ALG_CCM ||
5033 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5034 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005035 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005036 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005037 transform_expansion = transform->minlen;
5038 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005039 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005040 {
5041 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5042 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005043
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005044 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005045
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005046 /* Expansion due to the addition of the MAC. */
5047 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005048
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005049 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005050 * Theoretically up to 256 bytes, but we never use
5051 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005052 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005053
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005054 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005055 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005056#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005057 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005059 }
5060 else
5061 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005062 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005063 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005064 }
5065#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005066 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005067 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005068 case MBEDTLS_MODE_GCM:
5069 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005070 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005072 transform_expansion = transform->minlen;
5073 break;
5074
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005075 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005076
5077 block_size = mbedtls_cipher_get_block_size(
5078 &transform->cipher_ctx_enc );
5079
Hanno Becker3136ede2018-08-17 15:28:19 +01005080 /* Expansion due to the addition of the MAC. */
5081 transform_expansion += transform->maclen;
5082
5083 /* Expansion due to the addition of CBC padding;
5084 * Theoretically up to 256 bytes, but we never use
5085 * more than the block size of the underlying cipher. */
5086 transform_expansion += block_size;
5087
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005088 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005089 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005090#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005091 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005092#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005093
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005094 break;
5095
5096 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005097 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005098 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005099 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005100#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005101
Hanno Beckera0e20d02019-05-15 14:03:01 +01005102#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005103 if( transform->out_cid_len != 0 )
5104 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005105#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005106
Hanno Becker5903de42019-05-03 14:46:38 +01005107 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005108}
5109
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005111/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005112 * Check record counters and renegotiate if they're above the limit.
5113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005114static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005115{
Hanno Beckerdd772292020-02-05 10:38:31 +00005116 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005117 int in_ctr_cmp;
5118 int out_ctr_cmp;
5119
Paul Elliott27b0d942022-03-18 21:55:32 +00005120 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005121 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005122 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005123 {
5124 return( 0 );
5125 }
5126
Andres AG2196c7f2016-12-15 17:01:16 +00005127 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005128 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005129 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005130 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5131 &ssl->conf->renego_period[ep_len],
5132 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005133
5134 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005135 {
5136 return( 0 );
5137 }
5138
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005139 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005140 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005141}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005142#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005143
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005144/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005145 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005146 * may only be sent for the purpose of initiating renegotiations.
5147 *
5148 * This function is introduced as a separate helper since the handling
5149 * of post-handshake handshake messages changes significantly in TLS 1.3,
5150 * and having a helper function allows to distinguish between TLS <= 1.2 and
5151 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5152 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005153static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005154{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005156
5157 /*
5158 * - For client-side, expect SERVER_HELLO_REQUEST.
5159 * - For server-side, expect CLIENT_HELLO.
5160 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5161 */
5162
5163#if defined(MBEDTLS_SSL_CLI_C)
5164 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5165 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5166 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5167 {
5168 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5169
5170 /* With DTLS, drop the packet (probably from last handshake) */
5171#if defined(MBEDTLS_SSL_PROTO_DTLS)
5172 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5173 {
5174 return( 0 );
5175 }
5176#endif
5177 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5178 }
5179#endif /* MBEDTLS_SSL_CLI_C */
5180
5181#if defined(MBEDTLS_SSL_SRV_C)
5182 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5183 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5184 {
5185 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5186
5187 /* With DTLS, drop the packet (probably from last handshake) */
5188#if defined(MBEDTLS_SSL_PROTO_DTLS)
5189 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5190 {
5191 return( 0 );
5192 }
5193#endif
5194 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5195 }
5196#endif /* MBEDTLS_SSL_SRV_C */
5197
5198#if defined(MBEDTLS_SSL_RENEGOTIATION)
5199 /* Determine whether renegotiation attempt should be accepted */
5200 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5201 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5202 ssl->conf->allow_legacy_renegotiation ==
5203 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5204 {
5205 /*
5206 * Accept renegotiation request
5207 */
5208
5209 /* DTLS clients need to know renego is server-initiated */
5210#if defined(MBEDTLS_SSL_PROTO_DTLS)
5211 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5212 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5213 {
5214 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5215 }
5216#endif
5217 ret = mbedtls_ssl_start_renegotiation( ssl );
5218 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5219 ret != 0 )
5220 {
5221 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5222 ret );
5223 return( ret );
5224 }
5225 }
5226 else
5227#endif /* MBEDTLS_SSL_RENEGOTIATION */
5228 {
5229 /*
5230 * Refuse renegotiation
5231 */
5232
5233 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5234
TRodziewicz0f82ec62021-05-12 17:49:18 +02005235#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005236 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5237 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5238 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005239 {
TRodziewicz345165c2021-07-06 13:42:11 +02005240 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005241 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005242#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005243 }
5244
5245 return( 0 );
5246}
5247
Paul Bakker48916f92012-09-16 19:57:18 +00005248/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005249 * Receive application data decrypted from the SSL layer
5250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005251int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005252{
Janos Follath865b3eb2019-12-16 11:46:15 +00005253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005254 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005255
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005256 if( ssl == NULL || ssl->conf == NULL )
5257 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005259 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005261#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005262 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005263 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005264 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005265 return( ret );
5266
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005267 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005269 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005270 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005271 return( ret );
5272 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005273 }
5274#endif
5275
Hanno Becker4a810fb2017-05-24 16:27:30 +01005276 /*
5277 * Check if renegotiation is necessary and/or handshake is
5278 * in process. If yes, perform/continue, and fall through
5279 * if an unexpected packet is received while the client
5280 * is waiting for the ServerHello.
5281 *
5282 * (There is no equivalent to the last condition on
5283 * the server-side as it is not treated as within
5284 * a handshake while waiting for the ClientHello
5285 * after a renegotiation request.)
5286 */
5287
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005288#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005289 ret = ssl_check_ctr_renegotiate( ssl );
5290 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5291 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005292 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005293 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005294 return( ret );
5295 }
5296#endif
5297
Paul Elliott27b0d942022-03-18 21:55:32 +00005298 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005299 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005300 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005301 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5302 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005303 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005304 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005305 return( ret );
5306 }
5307 }
5308
Hanno Beckere41158b2017-10-23 13:30:32 +01005309 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005310 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005311 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005312 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005313 if( ssl->f_get_timer != NULL &&
5314 ssl->f_get_timer( ssl->p_timer ) == -1 )
5315 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005316 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005317 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005318
Hanno Becker327c93b2018-08-15 13:56:18 +01005319 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005320 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005321 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5322 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005323
Hanno Becker4a810fb2017-05-24 16:27:30 +01005324 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5325 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005326 }
5327
5328 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005330 {
5331 /*
5332 * OpenSSL sends empty messages to randomize the IV
5333 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005334 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005335 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005336 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005337 return( 0 );
5338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005340 return( ret );
5341 }
5342 }
5343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005345 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005346 ret = ssl_handle_hs_message_post_handshake( ssl );
5347 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005348 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005349 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5350 ret );
5351 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005352 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005353
Hanno Beckerf26cc722021-04-21 07:30:13 +01005354 /* At this point, we don't know whether the renegotiation triggered
5355 * by the post-handshake message has been completed or not. The cases
5356 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005357 * 1) The renegotiation is complete. In this case, no new record
5358 * has been read yet.
5359 * 2) The renegotiation is incomplete because the client received
5360 * an application data record while awaiting the ServerHello.
5361 * 3) The renegotiation is incomplete because the client received
5362 * a non-handshake, non-application data message while awaiting
5363 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005364 *
5365 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005366 * - For 1), the next iteration will read a new record and check
5367 * if it's application data.
5368 * - For 2), the loop condition isn't satisfied as application data
5369 * is present, hence continue is the same as break
5370 * - For 3), the loop condition is satisfied and read_record
5371 * will re-deliver the message that was held back by the client
5372 * when expecting the ServerHello.
5373 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005374
Hanno Becker90333da2017-10-10 11:27:13 +01005375 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005376 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005377#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005378 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005379 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005380 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005381 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005382 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005383 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005384 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005385 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005387 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005388 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005389 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005390#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005392 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5393 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005394 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005396 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005397 }
5398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005400 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005401 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5402 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005403 }
5404
5405 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005406
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005407 /* We're going to return something now, cancel timer,
5408 * except if handshake (renegotiation) is in progress */
Paul Elliott27b0d942022-03-18 21:55:32 +00005409 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker0f57a652020-02-05 10:37:26 +00005410 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005411
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005412#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005413 /* If we requested renego but received AppData, resend HelloRequest.
5414 * Do it now, after setting in_offt, to avoid taking this branch
5415 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005417 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005418 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005419 {
Hanno Becker786300f2020-02-05 10:46:40 +00005420 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005421 {
Hanno Becker786300f2020-02-05 10:46:40 +00005422 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5423 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005424 return( ret );
5425 }
5426 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005427#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005428#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005429 }
5430
5431 n = ( len < ssl->in_msglen )
5432 ? len : ssl->in_msglen;
5433
5434 memcpy( buf, ssl->in_offt, n );
5435 ssl->in_msglen -= n;
5436
gabor-mezei-arma3214132020-07-15 10:55:00 +02005437 /* Zeroising the plaintext buffer to erase unused application data
5438 from the memory. */
5439 mbedtls_platform_zeroize( ssl->in_offt, n );
5440
Paul Bakker5121ce52009-01-03 21:22:43 +00005441 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005442 {
5443 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005444 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005445 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005446 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005447 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005448 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005449 /* more data available */
5450 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005451 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005452
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005453 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005454
Paul Bakker23986e52011-04-24 08:57:21 +00005455 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005456}
5457
5458/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005459 * Send application data to be encrypted by the SSL layer, taking care of max
5460 * fragment length and buffer size.
5461 *
5462 * According to RFC 5246 Section 6.2.1:
5463 *
5464 * Zero-length fragments of Application data MAY be sent as they are
5465 * potentially useful as a traffic analysis countermeasure.
5466 *
5467 * Therefore, it is possible that the input message length is 0 and the
5468 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005469 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005470static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005471 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005472{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005473 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5474 const size_t max_len = (size_t) ret;
5475
5476 if( ret < 0 )
5477 {
5478 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5479 return( ret );
5480 }
5481
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005482 if( len > max_len )
5483 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005485 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005487 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005488 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5489 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005490 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005492 }
5493 else
5494#endif
5495 len = max_len;
5496 }
Paul Bakker887bd502011-06-08 13:10:54 +00005497
Paul Bakker5121ce52009-01-03 21:22:43 +00005498 if( ssl->out_left != 0 )
5499 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005500 /*
5501 * The user has previously tried to send the data and
5502 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5503 * written. In this case, we expect the high-level write function
5504 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005507 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005508 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005509 return( ret );
5510 }
5511 }
Paul Bakker887bd502011-06-08 13:10:54 +00005512 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005513 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005514 /*
5515 * The user is trying to send a message the first time, so we need to
5516 * copy the data into the internal buffers and setup the data structure
5517 * to keep track of partial writes
5518 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005519 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005520 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005521 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005522
Hanno Becker67bc7c32018-08-06 11:33:50 +01005523 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005524 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005525 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005526 return( ret );
5527 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005528 }
5529
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005530 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005531}
5532
5533/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005534 * Write application data (public-facing wrapper)
5535 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005536int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005537{
Janos Follath865b3eb2019-12-16 11:46:15 +00005538 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005539
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005541
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005542 if( ssl == NULL || ssl->conf == NULL )
5543 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5544
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005545#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005546 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5547 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005548 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005549 return( ret );
5550 }
5551#endif
5552
Paul Elliott27b0d942022-03-18 21:55:32 +00005553 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005554 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005555 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005556 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005557 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005558 return( ret );
5559 }
5560 }
5561
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005562 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005563
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005564 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005565
5566 return( ret );
5567}
5568
5569/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005570 * Notify the peer that the connection is being closed
5571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005572int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005573{
Janos Follath865b3eb2019-12-16 11:46:15 +00005574 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005575
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005576 if( ssl == NULL || ssl->conf == NULL )
5577 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005579 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005580
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005581 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005583
Paul Elliott27b0d942022-03-18 21:55:32 +00005584 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005585 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005586 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5587 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5588 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005590 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005591 return( ret );
5592 }
5593 }
5594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005595 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005596
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005597 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005598}
5599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005600void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005601{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005602 if( transform == NULL )
5603 return;
5604
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005605#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005606 psa_destroy_key( transform->psa_key_enc );
5607 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005608#else
5609 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5610 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5611#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005612
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005613#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005614 mbedtls_md_free( &transform->md_ctx_enc );
5615 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005616#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005617
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005618 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005619}
5620
Jerry Yuc7875b52021-09-05 21:05:50 +08005621void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5622 mbedtls_ssl_transform *transform )
5623{
Jerry Yuc7875b52021-09-05 21:05:50 +08005624 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005625 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005626}
5627
5628void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5629 mbedtls_ssl_transform *transform )
5630{
5631 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005632 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005633}
5634
Hanno Becker0271f962018-08-16 13:23:47 +01005635#if defined(MBEDTLS_SSL_PROTO_DTLS)
5636
Hanno Becker533ab5f2020-02-05 10:49:13 +00005637void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005638{
5639 unsigned offset;
5640 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5641
5642 if( hs == NULL )
5643 return;
5644
Hanno Becker283f5ef2018-08-24 09:34:47 +01005645 ssl_free_buffered_record( ssl );
5646
Hanno Becker0271f962018-08-16 13:23:47 +01005647 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005648 ssl_buffering_free_slot( ssl, offset );
5649}
5650
5651static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5652 uint8_t slot )
5653{
5654 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5655 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005656
5657 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5658 return;
5659
Hanno Beckere605b192018-08-21 15:59:07 +01005660 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005661 {
Hanno Beckere605b192018-08-21 15:59:07 +01005662 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005663 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005664 mbedtls_free( hs_buf->data );
5665 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005666 }
5667}
5668
5669#endif /* MBEDTLS_SSL_PROTO_DTLS */
5670
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005671/*
5672 * Convert version numbers to/from wire format
5673 * and, for DTLS, to/from TLS equivalent.
5674 *
5675 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005676 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005677 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005680 unsigned char ver[2] )
5681{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682#if defined(MBEDTLS_SSL_PROTO_DTLS)
5683 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005684 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005686 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5687
5688 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5689 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5690 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005691 else
5692#else
5693 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005694#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005695 {
5696 ver[0] = (unsigned char) major;
5697 ver[1] = (unsigned char) minor;
5698 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005699}
5700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005702 const unsigned char ver[2] )
5703{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005704#if defined(MBEDTLS_SSL_PROTO_DTLS)
5705 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005706 {
5707 *major = 255 - ver[0] + 2;
5708 *minor = 255 - ver[1] + 1;
5709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005710 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005711 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5712 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005713 else
5714#else
5715 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005716#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005717 {
5718 *major = ver[0];
5719 *minor = ver[1];
5720 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005721}
5722
Jerry Yue7047812021-09-13 19:26:39 +08005723/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005724 * Send pending fatal alert.
5725 * 0, No alert message.
5726 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5727 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005728 */
5729int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5730{
5731 int ret;
5732
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005733 /* No pending alert, return success*/
5734 if( ssl->send_alert == 0 )
5735 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005736
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005737 ret = mbedtls_ssl_send_alert_message( ssl,
5738 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5739 ssl->alert_type );
5740
Jerry Yu3bf1f972021-09-22 21:37:18 +08005741 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5742 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005743 */
5744 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5745 {
5746 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005747 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005748
5749 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005750 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005751
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005752 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005753}
5754
Jerry Yu394ece62021-09-14 22:17:21 +08005755/*
5756 * Set pending fatal alert flag.
5757 */
5758void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5759 unsigned char alert_type,
5760 int alert_reason )
5761{
5762 ssl->send_alert = 1;
5763 ssl->alert_type = alert_type;
5764 ssl->alert_reason = alert_reason;
5765}
5766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005767#endif /* MBEDTLS_SSL_TLS_C */