blob: ac79b2f03ca235faa9cf0fba151c8f366c50d881 [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,
Glenn Strauss07c64162022-03-14 12:34:51 -0400385 mbedtls_ssl_protocol_version
386 tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000387 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000388{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100389 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100390 *
391 * additional_data = seq_num + TLSCompressed.type +
392 * TLSCompressed.version + TLSCompressed.length;
393 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100394 * For the CID extension, this is extended as follows
395 * (quoting draft-ietf-tls-dtls-connection-id-05,
396 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100397 *
398 * additional_data = seq_num + DTLSPlaintext.type +
399 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100400 * cid +
401 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100402 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100403 *
404 * For TLS 1.3, the record sequence number is dropped from the AAD
405 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000406 * Moreover, the additional data involves the length of the TLS
407 * ciphertext, not the TLS plaintext as in earlier versions.
408 * Quoting RFC 8446 (TLS 1.3):
409 *
410 * additional_data = TLSCiphertext.opaque_type ||
411 * TLSCiphertext.legacy_record_version ||
412 * TLSCiphertext.length
413 *
414 * We pass the tag length to this function in order to compute the
415 * ciphertext length from the inner plaintext length rec->data_len via
416 *
417 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
418 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100419 */
420
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100421 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000422 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100423
Ronald Cron6f135e12021-12-08 16:57:54 +0100424#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400425 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000426 {
427 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
428 * which differs from the length of the TLSInnerPlaintext
429 * by the length of the authentication tag. */
430 ad_len_field += taglen;
431 }
432 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100433#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400435 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000436 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100437 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
438 cur += sizeof( rec->ctr );
439 }
440
441 *cur = rec->type;
442 cur++;
443
444 memcpy( cur, rec->ver, sizeof( rec->ver ) );
445 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100446
Hanno Beckera0e20d02019-05-15 14:03:01 +0100447#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100448 if( rec->cid_len != 0 )
449 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100450 memcpy( cur, rec->cid, rec->cid_len );
451 cur += rec->cid_len;
452
453 *cur = rec->cid_len;
454 cur++;
455
Joe Subbiani6dd73642021-07-19 11:56:54 +0100456 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100457 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100458 }
459 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100460#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100461 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100462 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100463 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100464 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100465
466 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000467}
468
Hanno Becker67a37db2020-05-28 16:27:07 +0100469#if defined(MBEDTLS_GCM_C) || \
470 defined(MBEDTLS_CCM_C) || \
471 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100472static int ssl_transform_aead_dynamic_iv_is_explicit(
473 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100474{
Hanno Becker17263802020-05-28 07:05:48 +0100475 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100476}
477
Hanno Becker17263802020-05-28 07:05:48 +0100478/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
479 *
480 * Concretely, this occurs in two variants:
481 *
482 * a) Fixed and dynamic IV lengths add up to total IV length, giving
483 * IV = fixed_iv || dynamic_iv
484 *
Hanno Becker15952812020-06-04 13:31:46 +0100485 * This variant is used in TLS 1.2 when used with GCM or CCM.
486 *
Hanno Becker17263802020-05-28 07:05:48 +0100487 * b) Fixed IV lengths matches total IV length, giving
488 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100489 *
490 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
491 *
492 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100493 *
494 * This function has the precondition that
495 *
496 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
497 *
498 * which has to be ensured by the caller. If this precondition
499 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100500 */
501static void ssl_build_record_nonce( unsigned char *dst_iv,
502 size_t dst_iv_len,
503 unsigned char const *fixed_iv,
504 size_t fixed_iv_len,
505 unsigned char const *dynamic_iv,
506 size_t dynamic_iv_len )
507{
508 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100509
510 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100511 memset( dst_iv, 0, dst_iv_len );
512 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100513
Hanno Becker17263802020-05-28 07:05:48 +0100514 dst_iv += dst_iv_len - dynamic_iv_len;
515 for( i = 0; i < dynamic_iv_len; i++ )
516 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100517}
Hanno Becker67a37db2020-05-28 16:27:07 +0100518#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100519
Hanno Beckera18d1322018-01-03 14:27:32 +0000520int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
521 mbedtls_ssl_transform *transform,
522 mbedtls_record *rec,
523 int (*f_rng)(void *, unsigned char *, size_t),
524 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000525{
Neil Armstrong136f8402022-03-30 10:58:01 +0200526 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100527 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000528 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100529 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100530 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000531 size_t post_avail;
532
533 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000534#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200535 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000536 ((void) ssl);
537#endif
538
539 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200540 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200541#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200542 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000543 ((void) f_rng);
544 ((void) p_rng);
545#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000548
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000549 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100550 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000551 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
552 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
553 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100554 if( rec == NULL
555 || rec->buf == NULL
556 || rec->buf_len < rec->data_offset
557 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100558#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100559 || rec->cid_len != 0
560#endif
561 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000562 {
563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100565 }
566
Neil Armstrongab555e02022-04-04 11:07:59 +0200567 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Neil Armstrong136f8402022-03-30 10:58:01 +0200568
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000569 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100570 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000572 data, rec->data_len );
573
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000574 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
575 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000576 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
577 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000578 rec->data_len,
579 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000580 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
581 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100582
Hanno Becker92313402020-05-20 13:58:58 +0100583 /* The following two code paths implement the (D)TLSInnerPlaintext
584 * structure present in TLS 1.3 and DTLS 1.2 + CID.
585 *
586 * See ssl_build_inner_plaintext() for more information.
587 *
588 * Note that this changes `rec->data_len`, and hence
589 * `post_avail` needs to be recalculated afterwards.
590 *
591 * Note also that the two code paths cannot occur simultaneously
592 * since they apply to different versions of the protocol. There
593 * is hence no risk of double-addition of the inner plaintext.
594 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100595#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -0400596 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100597 {
Hanno Becker13996922020-05-28 16:15:19 +0100598 size_t padding =
599 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200600 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100601 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100602 &rec->data_len,
603 post_avail,
604 rec->type,
605 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100606 {
607 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
608 }
609
610 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
611 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100612#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100613
Hanno Beckera0e20d02019-05-15 14:03:01 +0100614#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100615 /*
616 * Add CID information
617 */
618 rec->cid_len = transform->out_cid_len;
619 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
620 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100621
622 if( rec->cid_len != 0 )
623 {
Hanno Becker13996922020-05-28 16:15:19 +0100624 size_t padding =
625 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200626 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100627 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100628 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100629 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100630 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100631 * Note that this changes `rec->data_len`, and hence
632 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100634 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100635 &rec->data_len,
636 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100637 rec->type,
638 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100639 {
640 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
641 }
642
643 rec->type = MBEDTLS_SSL_MSG_CID;
644 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100645#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100646
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100647 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
648
Paul Bakker5121ce52009-01-03 21:22:43 +0000649 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100650 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000651 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000652#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +0200653 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
654 ssl_mode == MBEDTLS_SSL_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000655 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000656 if( post_avail < transform->maclen )
657 {
658 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
659 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
660 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200661#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200662 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100664#if defined(MBEDTLS_USE_PSA_CRYPTO)
665 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
667 size_t sign_mac_length = 0;
668#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +0000669
TRodziewicz345165c2021-07-06 13:42:11 +0200670 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400671 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000672 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000673
Neil Armstrong26e6d672022-02-23 09:30:33 +0100674#if defined(MBEDTLS_USE_PSA_CRYPTO)
675 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
676 transform->psa_mac_alg );
677 if( status != PSA_SUCCESS )
678 goto hmac_failed_etm_disabled;
679
680 status = psa_mac_update( &operation, add_data, add_data_len );
681 if( status != PSA_SUCCESS )
682 goto hmac_failed_etm_disabled;
683
684 status = psa_mac_update( &operation, data, rec->data_len );
685 if( status != PSA_SUCCESS )
686 goto hmac_failed_etm_disabled;
687
688 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
689 &sign_mac_length );
690 if( status != PSA_SUCCESS )
691 goto hmac_failed_etm_disabled;
692#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100693 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
694 add_data_len );
695 if( ret != 0 )
696 goto hmac_failed_etm_disabled;
697 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
698 if( ret != 0 )
699 goto hmac_failed_etm_disabled;
700 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
701 if( ret != 0 )
702 goto hmac_failed_etm_disabled;
703 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
704 if( ret != 0 )
705 goto hmac_failed_etm_disabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100706#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000707
TRodziewicz345165c2021-07-06 13:42:11 +0200708 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200709#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200710
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000711 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
712 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200713
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000714 rec->data_len += transform->maclen;
715 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100716 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100717
718 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100719 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +0100720#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +0100721 ret = psa_ssl_status_to_mbedtls( status );
722 status = psa_mac_abort( &operation );
723 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +0100724 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +0100725#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100726 if( ret != 0 )
727 {
728 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
729 return( ret );
730 }
Paul Bakker577e0062013-08-28 11:57:20 +0200731 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000732#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000733
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200734 /*
735 * Encrypt
736 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000737#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +0200738 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000739 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000740 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000741 "including %d bytes of padding",
742 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000743
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100744 /* The only supported stream cipher is "NULL",
745 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000746 }
Paul Bakker68884e32013-01-07 18:20:04 +0100747 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000748#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000749
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200750#if defined(MBEDTLS_GCM_C) || \
751 defined(MBEDTLS_CCM_C) || \
752 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +0200753 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000754 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200755 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100756 unsigned char *dynamic_iv;
757 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100758 int dynamic_iv_is_explicit =
759 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100760#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100761 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100762#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000764
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100765 /* Check that there's space for the authentication tag. */
766 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000767 {
768 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
769 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
770 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000771
Paul Bakker68884e32013-01-07 18:20:04 +0100772 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100773 * Build nonce for AEAD encryption.
774 *
775 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
776 * part of the IV is prepended to the ciphertext and
777 * can be chosen freely - in particular, it need not
778 * agree with the record sequence number.
779 * However, since ChaChaPoly as well as all AEAD modes
780 * in TLS 1.3 use the record sequence number as the
781 * dynamic part of the nonce, we uniformly use the
782 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100783 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100784 dynamic_iv = rec->ctr;
785 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200786
Hanno Becker17263802020-05-28 07:05:48 +0100787 ssl_build_record_nonce( iv, sizeof( iv ),
788 transform->iv_enc,
789 transform->fixed_ivlen,
790 dynamic_iv,
791 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100792
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100793 /*
794 * Build additional data for AEAD encryption.
795 * This depends on the TLS version.
796 */
797 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -0400798 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000799 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100800
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200801 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100802 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200803 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100804 dynamic_iv,
805 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000806 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100807 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000808 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200809 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000810 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000811
Paul Bakker68884e32013-01-07 18:20:04 +0100812 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200813 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200814 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100815#if defined(MBEDTLS_USE_PSA_CRYPTO)
816 status = psa_aead_encrypt( transform->psa_key_enc,
817 transform->psa_alg,
818 iv, transform->ivlen,
819 add_data, add_data_len,
820 data, rec->data_len,
821 data, rec->buf_len - (data - rec->buf),
822 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000823
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100824 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100825 {
826 ret = psa_ssl_status_to_mbedtls( status );
827 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
828 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100829 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100830#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100831 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000832 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100833 add_data, add_data_len,
834 data, rec->data_len, /* src */
835 data, rec->buf_len - (data - rec->buf), /* dst */
836 &rec->data_len,
837 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200838 {
TRodziewicz18efb732021-04-29 23:12:19 +0200839 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200840 return( ret );
841 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100842#endif /* MBEDTLS_USE_PSA_CRYPTO */
843
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100845 data + rec->data_len - transform->taglen,
846 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100847 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000848 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100849
850 /*
851 * Prefix record content with dynamic IV in case it is explicit.
852 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100853 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100854 {
855 if( rec->data_offset < dynamic_iv_len )
856 {
857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
858 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
859 }
860
861 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
862 rec->data_offset -= dynamic_iv_len;
863 rec->data_len += dynamic_iv_len;
864 }
865
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100866 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000867 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000868 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100869#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200870#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +0200871 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
872 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000873 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000874 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000875 size_t padlen, i;
876 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100877#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100878 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100879 size_t part_len;
880 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
881#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000882
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000883 /* Currently we're always using minimal padding
884 * (up to 255 bytes would be allowed). */
885 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
886 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000887 padlen = 0;
888
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000889 /* Check there's enough space in the buffer for the padding. */
890 if( post_avail < padlen + 1 )
891 {
892 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
893 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
894 }
895
Paul Bakker5121ce52009-01-03 21:22:43 +0000896 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000897 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000898
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000899 rec->data_len += padlen + 1;
900 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000901
TRodziewicz0f82ec62021-05-12 17:49:18 +0200902#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000903 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200904 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000905 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000906 */
TRodziewicz345165c2021-07-06 13:42:11 +0200907 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000908 {
TRodziewicz345165c2021-07-06 13:42:11 +0200909 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
910 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000911 }
TRodziewicz345165c2021-07-06 13:42:11 +0200912
913 if( rec->data_offset < transform->ivlen )
914 {
915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
916 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
917 }
918
919 /*
920 * Generate IV
921 */
922 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
923 if( ret != 0 )
924 return( ret );
925
926 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200927#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000928
Paul Elliottd48d5c62021-01-07 14:47:05 +0000929 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
930 "including %" MBEDTLS_PRINTF_SIZET
931 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200933 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000934
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100935#if defined(MBEDTLS_USE_PSA_CRYPTO)
936 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100937 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100938
939 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100940 {
941 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100942 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_encrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100943 return( ret );
944 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100945
946 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
947
948 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100949 {
950 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100951 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100952 return( ret );
953
954 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100955
956 status = psa_cipher_update( &cipher_op,
957 data, rec->data_len,
958 data, rec->data_len, &olen );
959
960 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100961 {
962 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100963 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100964 return( ret );
965
966 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100967
968 status = psa_cipher_finish( &cipher_op,
969 data + olen, rec->data_len - olen,
970 &part_len );
971
972 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100973 {
974 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100975 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100976 return( ret );
977
978 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100979
980 olen += part_len;
981#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000982 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
983 transform->iv_enc,
984 transform->ivlen,
985 data, rec->data_len,
986 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200987 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200989 return( ret );
990 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100991#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200992
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000993 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200994 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
996 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200997 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200998
TRodziewicz0f82ec62021-05-12 17:49:18 +0200999 data -= transform->ivlen;
1000 rec->data_offset -= transform->ivlen;
1001 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001004 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001005 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001006 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001007#if defined(MBEDTLS_USE_PSA_CRYPTO)
1008 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1009 size_t sign_mac_length = 0;
1010#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001011
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001012 /*
1013 * MAC(MAC_write_key, seq_num +
1014 * TLSCipherText.type +
1015 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001016 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001017 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001018 * ENC(content + padding + padding_length));
1019 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001020
1021 if( post_avail < transform->maclen)
1022 {
1023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1024 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1025 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001026
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001027 ssl_extract_add_data_from_record( add_data, &add_data_len,
Glenn Strauss07c64162022-03-14 12:34:51 -04001028 rec, transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001029 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001032 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001033 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001034#if defined(MBEDTLS_USE_PSA_CRYPTO)
1035 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
1036 transform->psa_mac_alg );
1037 if( status != PSA_SUCCESS )
1038 goto hmac_failed_etm_enabled;
1039
1040 status = psa_mac_update( &operation, add_data, add_data_len );
1041 if( status != PSA_SUCCESS )
1042 goto hmac_failed_etm_enabled;
1043
1044 status = psa_mac_update( &operation, data, rec->data_len );
1045 if( status != PSA_SUCCESS )
1046 goto hmac_failed_etm_enabled;
1047
1048 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
1049 &sign_mac_length );
1050 if( status != PSA_SUCCESS )
1051 goto hmac_failed_etm_enabled;
1052#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001053
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001054 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1055 add_data_len );
1056 if( ret != 0 )
1057 goto hmac_failed_etm_enabled;
1058 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1059 data, rec->data_len );
1060 if( ret != 0 )
1061 goto hmac_failed_etm_enabled;
1062 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1063 if( ret != 0 )
1064 goto hmac_failed_etm_enabled;
1065 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1066 if( ret != 0 )
1067 goto hmac_failed_etm_enabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001068#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001069
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001070 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001071
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001072 rec->data_len += transform->maclen;
1073 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001074 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001075
1076 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001077 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001078#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001079 ret = psa_ssl_status_to_mbedtls( status );
1080 status = psa_mac_abort( &operation );
1081 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001082 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +01001083#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001084 if( ret != 0 )
1085 {
1086 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1087 return( ret );
1088 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001089 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001091 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001092 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001093#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001094 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1096 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001097 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001098
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001099 /* Make extra sure authentication was performed, exactly once */
1100 if( auth_done != 1 )
1101 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1103 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001104 }
1105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001107
1108 return( 0 );
1109}
1110
Hanno Becker605949f2019-07-12 08:23:59 +01001111int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001112 mbedtls_ssl_transform *transform,
1113 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001114{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001115 size_t olen;
Neil Armstrong136f8402022-03-30 10:58:01 +02001116 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001117 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001118
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001119 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001120#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001121 size_t padlen = 0, correct = 1;
1122#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001123 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001124 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001125 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001126
Hanno Beckera18d1322018-01-03 14:27:32 +00001127#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001128 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001129 ((void) ssl);
1130#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001133 if( rec == NULL ||
1134 rec->buf == NULL ||
1135 rec->buf_len < rec->data_offset ||
1136 rec->buf_len - rec->data_offset < rec->data_len )
1137 {
1138 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001140 }
1141
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001142 data = rec->buf + rec->data_offset;
Neil Armstrongab555e02022-04-04 11:07:59 +02001143 ssl_mode = mbedtls_ssl_get_mode_from_transform( transform );
Paul Bakker5121ce52009-01-03 21:22:43 +00001144
Hanno Beckera0e20d02019-05-15 14:03:01 +01001145#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001146 /*
1147 * Match record's CID with incoming CID.
1148 */
Hanno Becker938489a2019-05-08 13:02:22 +01001149 if( rec->cid_len != transform->in_cid_len ||
1150 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1151 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001152 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001153 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001154#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001155
Hanno Beckerd086bf02021-03-22 13:01:27 +00001156#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Neil Armstrong136f8402022-03-30 10:58:01 +02001157 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001158 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001159 /* The only supported stream cipher is "NULL",
1160 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001161 }
Paul Bakker68884e32013-01-07 18:20:04 +01001162 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001163#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001164#if defined(MBEDTLS_GCM_C) || \
1165 defined(MBEDTLS_CCM_C) || \
1166 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong136f8402022-03-30 10:58:01 +02001167 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001168 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001169 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001170 unsigned char *dynamic_iv;
1171 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001172#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001173 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001174#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001175
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001176 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001177 * Extract dynamic part of nonce for AEAD decryption.
1178 *
1179 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1180 * part of the IV is prepended to the ciphertext and
1181 * can be chosen freely - in particular, it need not
1182 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001183 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001184 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001185 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001186 {
1187 if( rec->data_len < dynamic_iv_len )
1188 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001189 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1190 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001191 rec->data_len,
1192 dynamic_iv_len ) );
1193 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1194 }
1195 dynamic_iv = data;
1196
1197 data += dynamic_iv_len;
1198 rec->data_offset += dynamic_iv_len;
1199 rec->data_len -= dynamic_iv_len;
1200 }
Hanno Becker17263802020-05-28 07:05:48 +01001201 else
1202 {
1203 dynamic_iv = rec->ctr;
1204 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001205
1206 /* Check that there's space for the authentication tag. */
1207 if( rec->data_len < transform->taglen )
1208 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001209 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1210 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001211 rec->data_len,
1212 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001214 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001215 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001216
Hanno Beckerdf8be222020-05-21 15:30:57 +01001217 /*
1218 * Prepare nonce from dynamic and static parts.
1219 */
Hanno Becker17263802020-05-28 07:05:48 +01001220 ssl_build_record_nonce( iv, sizeof( iv ),
1221 transform->iv_dec,
1222 transform->fixed_ivlen,
1223 dynamic_iv,
1224 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001225
Hanno Beckerdf8be222020-05-21 15:30:57 +01001226 /*
1227 * Build additional data for AEAD encryption.
1228 * This depends on the TLS version.
1229 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001230 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001231 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001232 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001233 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001234 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001235
Hanno Beckerd96a6522019-07-10 13:55:25 +01001236 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001237 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001238 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001239 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001240 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001241
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001242 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001243 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001244 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001245
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001246 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001247 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001248 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001249#if defined(MBEDTLS_USE_PSA_CRYPTO)
1250 status = psa_aead_decrypt( transform->psa_key_dec,
1251 transform->psa_alg,
1252 iv, transform->ivlen,
1253 add_data, add_data_len,
1254 data, rec->data_len + transform->taglen,
1255 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001256 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001257
1258 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001259 {
1260 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001261 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001262 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001263 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001264#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001265 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001266 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001267 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001268 data, rec->data_len + transform->taglen, /* src */
1269 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001270 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001271 {
TRodziewicz18efb732021-04-29 23:12:19 +02001272 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001273
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1275 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001276
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001277 return( ret );
1278 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001279#endif /* MBEDTLS_USE_PSA_CRYPTO */
1280
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001281 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001282
Hanno Beckerd96a6522019-07-10 13:55:25 +01001283 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001284 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001285 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1287 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001288 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001290 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001292#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001293 if( ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1294 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001295 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001296 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001297#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001299 size_t part_len;
1300 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1301#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001302
Paul Bakker5121ce52009-01-03 21:22:43 +00001303 /*
Paul Bakker45829992013-01-03 14:52:21 +01001304 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001305 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001306#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001307 /* The ciphertext is prefixed with the CBC IV. */
1308 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001309#endif
Paul Bakker45829992013-01-03 14:52:21 +01001310
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001311 /* Size considerations:
1312 *
1313 * - The CBC cipher text must not be empty and hence
1314 * at least of size transform->ivlen.
1315 *
1316 * Together with the potential IV-prefix, this explains
1317 * the first of the two checks below.
1318 *
1319 * - The record must contain a MAC, either in plain or
1320 * encrypted, depending on whether Encrypt-then-MAC
1321 * is used or not.
1322 * - If it is, the message contains the IV-prefix,
1323 * the CBC ciphertext, and the MAC.
1324 * - If it is not, the padded plaintext, and hence
1325 * the CBC ciphertext, has at least length maclen + 1
1326 * because there is at least the padding length byte.
1327 *
1328 * As the CBC ciphertext is not empty, both cases give the
1329 * lower bound minlen + maclen + 1 on the record size, which
1330 * we test for in the second check below.
1331 */
1332 if( rec->data_len < minlen + transform->ivlen ||
1333 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001334 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001335 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1336 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1337 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001338 "+ 1 ) ( + expl IV )", rec->data_len,
1339 transform->ivlen,
1340 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001342 }
1343
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001344 /*
1345 * Authenticate before decrypt if enabled
1346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001347#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong136f8402022-03-30 10:58:01 +02001348 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001349 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001350#if defined(MBEDTLS_USE_PSA_CRYPTO)
1351 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1352#else
Hanno Becker992b6872017-11-09 18:57:39 +00001353 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001354#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001357
Hanno Beckerd96a6522019-07-10 13:55:25 +01001358 /* Update data_len in tandem with add_data.
1359 *
1360 * The subtraction is safe because of the previous check
1361 * data_len >= minlen + maclen + 1.
1362 *
1363 * Afterwards, we know that data + data_len is followed by at
1364 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001365 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001366 *
1367 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001368 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001369 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001370 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001371 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001372
Hanno Beckerd96a6522019-07-10 13:55:25 +01001373 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001374 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1375 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001376#if defined(MBEDTLS_USE_PSA_CRYPTO)
1377 status = psa_mac_verify_setup( &operation, transform->psa_mac_dec,
1378 transform->psa_mac_alg );
1379 if( status != PSA_SUCCESS )
1380 goto hmac_failed_etm_enabled;
1381
1382 status = psa_mac_update( &operation, add_data, add_data_len );
1383 if( status != PSA_SUCCESS )
1384 goto hmac_failed_etm_enabled;
1385
1386 status = psa_mac_update( &operation, data, rec->data_len );
1387 if( status != PSA_SUCCESS )
1388 goto hmac_failed_etm_enabled;
1389
1390 /* Compare expected MAC with MAC at the end of the record. */
1391 status = psa_mac_verify_finish( &operation, data + rec->data_len,
1392 transform->maclen );
1393 if( status != PSA_SUCCESS )
1394 goto hmac_failed_etm_enabled;
1395#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001396 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1397 add_data_len );
1398 if( ret != 0 )
1399 goto hmac_failed_etm_enabled;
1400 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001401 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001402 if( ret != 0 )
1403 goto hmac_failed_etm_enabled;
1404 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1405 if( ret != 0 )
1406 goto hmac_failed_etm_enabled;
1407 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1408 if( ret != 0 )
1409 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001410
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001411 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1412 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001413 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001414 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001415
Hanno Beckerd96a6522019-07-10 13:55:25 +01001416 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001417 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001418 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001419 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001421 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1422 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001423 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001424#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001425 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001426
1427 hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001428#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001429 ret = psa_ssl_status_to_mbedtls( status );
1430 status = psa_mac_abort( &operation );
1431 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001432 ret = psa_ssl_status_to_mbedtls( status );
1433#else
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001434 mbedtls_platform_zeroize( mac_expect, transform->maclen );
Neil Armstrong4313f552022-03-02 15:14:07 +01001435#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001436 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001437 {
1438 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1439 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001440 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001441 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001442 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001443#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001444
1445 /*
1446 * Check length sanity
1447 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001448
1449 /* We know from above that data_len > minlen >= 0,
1450 * so the following check in particular implies that
1451 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001452 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001453 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001454 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1455 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001456 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001458 }
1459
TRodziewicz0f82ec62021-05-12 17:49:18 +02001460#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001461 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001462 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001463 */
TRodziewicz345165c2021-07-06 13:42:11 +02001464 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1465 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001466
TRodziewicz345165c2021-07-06 13:42:11 +02001467 data += transform->ivlen;
1468 rec->data_offset += transform->ivlen;
1469 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001470#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001471
Hanno Beckerd96a6522019-07-10 13:55:25 +01001472 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1473
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001474#if defined(MBEDTLS_USE_PSA_CRYPTO)
1475 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001476 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001477
1478 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001479 {
1480 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001481 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001482 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001483 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001484
1485 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1486
1487 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001488 {
1489 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001490 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001491 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001492 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001493
1494 status = psa_cipher_update( &cipher_op,
1495 data, rec->data_len,
1496 data, rec->data_len, &olen );
1497
1498 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001499 {
1500 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001501 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001502 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001503 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001504
1505 status = psa_cipher_finish( &cipher_op,
1506 data + olen, rec->data_len - olen,
1507 &part_len );
1508
1509 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001510 {
1511 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001512 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001513 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001514 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001515
1516 olen += part_len;
1517#else
1518
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1520 transform->iv_dec, transform->ivlen,
1521 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001522 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001524 return( ret );
1525 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001526#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001527
Hanno Beckerd96a6522019-07-10 13:55:25 +01001528 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001529 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1532 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001533 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001534
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535 /* Safe since data_len >= minlen + maclen + 1, so after having
1536 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001537 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1538 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001539 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001540
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001541 if( auth_done == 1 )
1542 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001543 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001544 rec->data_len,
1545 padlen + 1 );
1546 correct &= mask;
1547 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001548 }
1549 else
Paul Bakker45829992013-01-03 14:52:21 +01001550 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001552 if( rec->data_len < transform->maclen + padlen + 1 )
1553 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001554 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1555 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1556 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001557 rec->data_len,
1558 transform->maclen,
1559 padlen + 1 ) );
1560 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001561#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001562
Gabor Mezei90437e32021-10-20 11:59:27 +02001563 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001564 rec->data_len,
1565 transform->maclen + padlen + 1 );
1566 correct &= mask;
1567 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001568 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001569
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001570 padlen++;
1571
1572 /* Regardless of the validity of the padding,
1573 * we have data_len >= padlen here. */
1574
TRodziewicz0f82ec62021-05-12 17:49:18 +02001575#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001576 /* The padding check involves a series of up to 256
1577 * consecutive memory reads at the end of the record
1578 * plaintext buffer. In order to hide the length and
1579 * validity of the padding, always perform exactly
1580 * `min(256,plaintext_len)` reads (but take into account
1581 * only the last `padlen` bytes for the padding check). */
1582 size_t pad_count = 0;
1583 volatile unsigned char* const check = data;
1584
1585 /* Index of first padding byte; it has been ensured above
1586 * that the subtraction is safe. */
1587 size_t const padding_idx = rec->data_len - padlen;
1588 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1589 size_t const start_idx = rec->data_len - num_checks;
1590 size_t idx;
1591
1592 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001593 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001594 /* pad_count += (idx >= padding_idx) &&
1595 * (check[idx] == padlen - 1);
1596 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001597 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1598 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001599 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001600 pad_count += mask & equal;
1601 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001602 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001603
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001605 if( padlen > 0 && correct == 0 )
1606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001607#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001608 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001609
TRodziewicz0f82ec62021-05-12 17:49:18 +02001610#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001611
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001612 /* If the padding was found to be invalid, padlen == 0
1613 * and the subtraction is safe. If the padding was found valid,
1614 * padlen hasn't been changed and the previous assertion
1615 * data_len >= padlen still holds. */
1616 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001617 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001618 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001619#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001620 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1622 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001623 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001624
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001625#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001627 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001628#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001629
1630 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001631 * Authenticate if not done yet.
1632 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001633 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001634#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001635 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001636 {
Paul Elliott5260ce22022-05-09 18:15:54 +01001637 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1638 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001639
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001640 /* If the initial value of padlen was such that
1641 * data_len < maclen + padlen + 1, then padlen
1642 * got reset to 1, and the initial check
1643 * data_len >= minlen + maclen + 1
1644 * guarantees that at this point we still
1645 * have at least data_len >= maclen.
1646 *
1647 * If the initial value of padlen was such that
1648 * data_len >= maclen + padlen + 1, then we have
1649 * subtracted either padlen + 1 (if the padding was correct)
1650 * or 0 (if the padding was incorrect) since then,
1651 * hence data_len >= maclen in any case.
1652 */
1653 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001654 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Glenn Strauss07c64162022-03-14 12:34:51 -04001655 transform->tls_version,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001656 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001657
TRodziewicz0f82ec62021-05-12 17:49:18 +02001658#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001659 /*
1660 * The next two sizes are the minimum and maximum values of
1661 * data_len over all padlen values.
1662 *
1663 * They're independent of padlen, since we previously did
1664 * data_len -= padlen.
1665 *
1666 * Note that max_len + maclen is never more than the buffer
1667 * length, as we previously did in_msglen -= maclen too.
1668 */
1669 const size_t max_len = rec->data_len + padlen;
1670 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1671
Neil Armstronge8589962022-02-25 15:14:29 +01001672#if defined(MBEDTLS_USE_PSA_CRYPTO)
1673 ret = mbedtls_ct_hmac( transform->psa_mac_dec,
1674 transform->psa_mac_alg,
1675 add_data, add_data_len,
1676 data, rec->data_len, min_len, max_len,
1677 mac_expect );
1678#else
Gabor Mezei90437e32021-10-20 11:59:27 +02001679 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001680 add_data, add_data_len,
1681 data, rec->data_len, min_len, max_len,
1682 mac_expect );
Neil Armstronge8589962022-02-25 15:14:29 +01001683#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001684 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001685 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001686 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001687 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001688 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001689
Gabor Mezei90437e32021-10-20 11:59:27 +02001690 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001691 rec->data_len,
1692 min_len, max_len,
1693 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001694#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001695
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001696#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001697 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001698 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001699#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001700
Gabor Mezei90437e32021-10-20 11:59:27 +02001701 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001702 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001703 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704#if defined(MBEDTLS_SSL_DEBUG_ALL)
1705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001706#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001707 correct = 0;
1708 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001709 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001710
1711 hmac_failed_etm_disabled:
1712 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1713 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1714 if( ret != 0 )
1715 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001716 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001717
1718 /*
1719 * Finally check the correct flag
1720 */
1721 if( correct == 0 )
1722 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001723#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001724
1725 /* Make extra sure authentication was performed, exactly once */
1726 if( auth_done != 1 )
1727 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1729 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001730 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001731
Ronald Cron6f135e12021-12-08 16:57:54 +01001732#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04001733 if( transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Hanno Beckerccc13d02020-05-04 12:30:04 +01001734 {
1735 /* Remove inner padding and infer true content type. */
1736 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1737 &rec->type );
1738
1739 if( ret != 0 )
1740 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1741 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001742#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001743
Hanno Beckera0e20d02019-05-15 14:03:01 +01001744#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001745 if( rec->cid_len != 0 )
1746 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001747 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1748 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001749 if( ret != 0 )
1750 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1751 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001752#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001755
1756 return( 0 );
1757}
1758
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001759#undef MAC_NONE
1760#undef MAC_PLAINTEXT
1761#undef MAC_CIPHERTEXT
1762
Paul Bakker5121ce52009-01-03 21:22:43 +00001763/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001764 * Fill the input message buffer by appending data to it.
1765 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001766 *
1767 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1768 * available (from this read and/or a previous one). Otherwise, an error code
1769 * is returned (possibly EOF or WANT_READ).
1770 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001771 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1772 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1773 * since we always read a whole datagram at once.
1774 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001775 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001776 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001779{
Janos Follath865b3eb2019-12-16 11:46:15 +00001780 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001781 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001782#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1783 size_t in_buf_len = ssl->in_buf_len;
1784#else
1785 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1786#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001789
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001790 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1791 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001793 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001795 }
1796
Darryl Greenb33cc762019-11-28 14:29:44 +00001797 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1800 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001801 }
1802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001804 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001805 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001806 uint32_t timeout;
1807
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001808 /*
1809 * The point is, we need to always read a full datagram at once, so we
1810 * sometimes read more then requested, and handle the additional data.
1811 * It could be the rest of the current record (while fetching the
1812 * header) and/or some other records in the same datagram.
1813 */
1814
1815 /*
1816 * Move to the next record in the already read datagram if applicable
1817 */
1818 if( ssl->next_record_offset != 0 )
1819 {
1820 if( ssl->in_left < ssl->next_record_offset )
1821 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1823 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001824 }
1825
1826 ssl->in_left -= ssl->next_record_offset;
1827
1828 if( ssl->in_left != 0 )
1829 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1831 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001832 ssl->next_record_offset ) );
1833 memmove( ssl->in_hdr,
1834 ssl->in_hdr + ssl->next_record_offset,
1835 ssl->in_left );
1836 }
1837
1838 ssl->next_record_offset = 0;
1839 }
1840
Paul Elliottd48d5c62021-01-07 14:47:05 +00001841 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1842 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001843 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001844
1845 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001846 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001847 */
1848 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001849 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001850 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001851 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001852 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001853
1854 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001855 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001856 * are not at the beginning of a new record, the caller did something
1857 * wrong.
1858 */
1859 if( ssl->in_left != 0 )
1860 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1862 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001863 }
1864
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001865 /*
1866 * Don't even try to read if time's out already.
1867 * This avoids by-passing the timer when repeatedly receiving messages
1868 * that will end up being dropped.
1869 */
Hanno Becker7876d122020-02-05 10:39:31 +00001870 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001871 {
1872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001873 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001874 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001875 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001876 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001877 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001878
Paul Elliott27b0d942022-03-18 21:55:32 +00001879 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001880 timeout = ssl->handshake->retransmit_timeout;
1881 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001882 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001883
Paul Elliott9f352112020-12-09 14:55:45 +00001884 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001885
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001886 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001887 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1888 timeout );
1889 else
1890 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1891
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001893
1894 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001896 }
1897
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001898 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001899 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001901 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001902
Paul Elliott27b0d942022-03-18 21:55:32 +00001903 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001904 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001905 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1906 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001908 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001909 }
1910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001912 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001914 return( ret );
1915 }
1916
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001917 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001918 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001920 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001922 {
Hanno Becker786300f2020-02-05 10:46:40 +00001923 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001924 {
Hanno Becker786300f2020-02-05 10:46:40 +00001925 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1926 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001927 return( ret );
1928 }
1929
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001930 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001931 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001933 }
1934
Paul Bakker5121ce52009-01-03 21:22:43 +00001935 if( ret < 0 )
1936 return( ret );
1937
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001938 ssl->in_left = ret;
1939 }
1940 else
1941#endif
1942 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1944 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001945 ssl->in_left, nb_want ) );
1946
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001947 while( ssl->in_left < nb_want )
1948 {
1949 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001950
Hanno Becker7876d122020-02-05 10:39:31 +00001951 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001952 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1953 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001954 {
1955 if( ssl->f_recv_timeout != NULL )
1956 {
1957 ret = ssl->f_recv_timeout( ssl->p_bio,
1958 ssl->in_hdr + ssl->in_left, len,
1959 ssl->conf->read_timeout );
1960 }
1961 else
1962 {
1963 ret = ssl->f_recv( ssl->p_bio,
1964 ssl->in_hdr + ssl->in_left, len );
1965 }
1966 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001967
Paul Elliottd48d5c62021-01-07 14:47:05 +00001968 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1969 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001970 ssl->in_left, nb_want ) );
1971 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001972
1973 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001975
1976 if( ret < 0 )
1977 return( ret );
1978
makise-homuraaf9513b2020-08-24 18:26:27 +03001979 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001980 {
Darryl Green11999bb2018-03-13 15:22:58 +00001981 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001982 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001983 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001984 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1985 }
1986
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001987 ssl->in_left += ret;
1988 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001989 }
1990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001992
1993 return( 0 );
1994}
1995
1996/*
1997 * Flush any data not yet written
1998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002000{
Janos Follath865b3eb2019-12-16 11:46:15 +00002001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002002 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002005
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002006 if( ssl->f_send == NULL )
2007 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002009 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002010 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002011 }
2012
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002013 /* Avoid incrementing counter if data is flushed */
2014 if( ssl->out_left == 0 )
2015 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002017 return( 0 );
2018 }
2019
Paul Bakker5121ce52009-01-03 21:22:43 +00002020 while( ssl->out_left > 0 )
2021 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2023 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002024 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002025
Hanno Becker2b1e3542018-08-06 11:19:13 +01002026 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002027 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002030
2031 if( ret <= 0 )
2032 return( ret );
2033
makise-homuraaf9513b2020-08-24 18:26:27 +03002034 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002035 {
Darryl Green11999bb2018-03-13 15:22:58 +00002036 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002037 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002038 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002039 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2040 }
2041
Paul Bakker5121ce52009-01-03 21:22:43 +00002042 ssl->out_left -= ret;
2043 }
2044
Hanno Becker2b1e3542018-08-06 11:19:13 +01002045#if defined(MBEDTLS_SSL_PROTO_DTLS)
2046 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002047 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002048 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002049 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002050 else
2051#endif
2052 {
2053 ssl->out_hdr = ssl->out_buf + 8;
2054 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002055 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002058
2059 return( 0 );
2060}
2061
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002062/*
2063 * Functions to handle the DTLS retransmission state machine
2064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002066/*
2067 * Append current handshake message to current outgoing flight
2068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002070{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2073 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2074 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002075
2076 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002077 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002079 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002081 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002082 }
2083
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002084 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002085 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002086 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2087 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002089 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002090 }
2091
2092 /* Copy current handshake message with headers */
2093 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2094 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002095 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002096 msg->next = NULL;
2097
2098 /* Append to the current flight */
2099 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002100 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002101 else
2102 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002104 while( cur->next != NULL )
2105 cur = cur->next;
2106 cur->next = msg;
2107 }
2108
Hanno Becker3b235902018-08-06 09:54:53 +01002109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002110 return( 0 );
2111}
2112
2113/*
2114 * Free the current flight of handshake messages
2115 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002116void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002117{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 mbedtls_ssl_flight_item *cur = flight;
2119 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002120
2121 while( cur != NULL )
2122 {
2123 next = cur->next;
2124
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 mbedtls_free( cur->p );
2126 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002127
2128 cur = next;
2129 }
2130}
2131
2132/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002133 * Swap transform_out and out_ctr with the alternative ones
2134 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002135static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002136{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002138 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002139
2140 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2141 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002143 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002144 }
2145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002146 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002147
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002148 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002149 tmp_transform = ssl->transform_out;
2150 ssl->transform_out = ssl->handshake->alt_transform_out;
2151 ssl->handshake->alt_transform_out = tmp_transform;
2152
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002153 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002154 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2155 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2156 sizeof( ssl->cur_out_ctr ) );
2157 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2158 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002159
2160 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002161 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002162
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002163 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002164}
2165
2166/*
2167 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002168 */
2169int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2170{
2171 int ret = 0;
2172
2173 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2174
2175 ret = mbedtls_ssl_flight_transmit( ssl );
2176
2177 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2178
2179 return( ret );
2180}
2181
2182/*
2183 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002184 *
2185 * Need to remember the current message in case flush_output returns
2186 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002187 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002188 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002189int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190{
Janos Follath865b3eb2019-12-16 11:46:15 +00002191 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002195 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002196 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002197
2198 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002199 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002200 ret = ssl_swap_epochs( ssl );
2201 if( ret != 0 )
2202 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002205 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002206
2207 while( ssl->handshake->cur_msg != NULL )
2208 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002209 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002210 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002211
Hanno Beckere1dcb032018-08-17 16:47:58 +01002212 int const is_finished =
2213 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2214 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2215
Ronald Cron00d012f22022-03-08 15:57:12 +01002216 int const force_flush = ssl->disable_datagram_packing == 1 ?
Hanno Becker04da1892018-08-14 13:22:10 +01002217 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2218
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002219 /* Swap epochs before sending Finished: we can't do it after
2220 * sending ChangeCipherSpec, in case write returns WANT_READ.
2221 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002222 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002223 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002224 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002225 ret = ssl_swap_epochs( ssl );
2226 if( ret != 0 )
2227 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002228 }
2229
Hanno Becker67bc7c32018-08-06 11:33:50 +01002230 ret = ssl_get_remaining_payload_in_datagram( ssl );
2231 if( ret < 0 )
2232 return( ret );
2233 max_frag_len = (size_t) ret;
2234
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002235 /* CCS is copied as is, while HS messages may need fragmentation */
2236 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2237 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002238 if( max_frag_len == 0 )
2239 {
2240 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2241 return( ret );
2242
2243 continue;
2244 }
2245
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002246 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002247 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002248 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002249
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002250 /* Update position inside current message */
2251 ssl->handshake->cur_msg_p += cur->len;
2252 }
2253 else
2254 {
2255 const unsigned char * const p = ssl->handshake->cur_msg_p;
2256 const size_t hs_len = cur->len - 12;
2257 const size_t frag_off = p - ( cur->p + 12 );
2258 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002259 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002260
Hanno Beckere1dcb032018-08-17 16:47:58 +01002261 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002262 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002263 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002264 {
2265 ret = ssl_swap_epochs( ssl );
2266 if( ret != 0 )
2267 return( ret );
2268 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002269
Hanno Becker67bc7c32018-08-06 11:33:50 +01002270 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2271 return( ret );
2272
2273 continue;
2274 }
2275 max_hs_frag_len = max_frag_len - 12;
2276
2277 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2278 max_hs_frag_len : rem_len;
2279
2280 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002281 {
2282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002283 (unsigned) cur_hs_frag_len,
2284 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002285 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002286
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002287 /* Messages are stored with handshake headers as if not fragmented,
2288 * copy beginning of headers then fill fragmentation fields.
2289 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2290 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002291
Joe Subbiani5ecac212021-06-24 13:00:03 +01002292 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2293 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2294 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002295
Joe Subbiani5ecac212021-06-24 13:00:03 +01002296 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2297 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2298 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002299
2300 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2301
Hanno Becker3f7b9732018-08-28 09:53:25 +01002302 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002303 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2304 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002305 ssl->out_msgtype = cur->type;
2306
2307 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002308 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002309 }
2310
2311 /* If done with the current message move to the next one if any */
2312 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2313 {
2314 if( cur->next != NULL )
2315 {
2316 ssl->handshake->cur_msg = cur->next;
2317 ssl->handshake->cur_msg_p = cur->next->p + 12;
2318 }
2319 else
2320 {
2321 ssl->handshake->cur_msg = NULL;
2322 ssl->handshake->cur_msg_p = NULL;
2323 }
2324 }
2325
2326 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002327 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002328 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002330 return( ret );
2331 }
2332 }
2333
Hanno Becker67bc7c32018-08-06 11:33:50 +01002334 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2335 return( ret );
2336
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002337 /* Update state and set timer */
Paul Elliott27b0d942022-03-18 21:55:32 +00002338 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002340 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002341 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002343 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002344 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002345
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002347
2348 return( 0 );
2349}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002350
2351/*
2352 * To be called when the last message of an incoming flight is received.
2353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002355{
2356 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002357 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002358 ssl->handshake->flight = NULL;
2359 ssl->handshake->cur_msg = NULL;
2360
2361 /* The next incoming flight will start with this msg_seq */
2362 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2363
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002364 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002365 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002366
Hanno Becker0271f962018-08-16 13:23:47 +01002367 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002368 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002369
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002370 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002371 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2374 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002375 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002377 }
2378 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002380}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002381
2382/*
2383 * To be called when the last message of an outgoing flight is send.
2384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002386{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002387 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002388 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2391 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002392 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002394 }
2395 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002397}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002398#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002399
Paul Bakker5121ce52009-01-03 21:22:43 +00002400/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002401 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002402 */
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002403int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
2404 unsigned char **buf, size_t *buf_len )
2405{
2406 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002407 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002408 * ...
2409 * HandshakeType msg_type;
2410 * uint24 length;
2411 * ...
2412 */
2413 *buf = ssl->out_msg + 4;
2414 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2415
2416 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2417 ssl->out_msg[0] = hs_type;
2418
2419 return( 0 );
2420}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002421
2422/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002423 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002424 *
2425 * - fill in handshake headers
2426 * - update handshake checksum
2427 * - DTLS: save message for resending
2428 * - then pass to the record layer
2429 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002430 * DTLS: except for HelloRequest, messages are only queued, and will only be
2431 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002432 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002433 * Inputs:
2434 * - ssl->out_msglen: 4 + actual handshake message len
2435 * (4 is the size of handshake headers for TLS)
2436 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2437 * - ssl->out_msg + 4: the handshake message body
2438 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002439 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002440 * - ssl->out_msglen: the length of the record contents
2441 * (including handshake headers but excluding record headers)
2442 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002443 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002444int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01002445 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01002446 int force_flush )
Paul Bakker5121ce52009-01-03 21:22:43 +00002447{
Janos Follath865b3eb2019-12-16 11:46:15 +00002448 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002449 const size_t hs_len = ssl->out_msglen - 4;
2450 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002451
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002452 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2453
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002454 /*
2455 * Sanity checks
2456 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002457 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002458 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2459 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2461 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002462 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002463
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002464 /* Whenever we send anything different from a
2465 * HelloRequest we should be in a handshake - double check. */
2466 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2467 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002468 ssl->handshake == NULL )
2469 {
2470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2471 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2472 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002475 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002476 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002478 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002479 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2480 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002481 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002482#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002483
Hanno Beckerb50a2532018-08-06 11:52:54 +01002484 /* Double-check that we did not exceed the bounds
2485 * of the outgoing record buffer.
2486 * This should never fail as the various message
2487 * writing functions must obey the bounds of the
2488 * outgoing record buffer, but better be safe.
2489 *
2490 * Note: We deliberately do not check for the MTU or MFL here.
2491 */
2492 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2493 {
2494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002495 "size %" MBEDTLS_PRINTF_SIZET
2496 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002497 ssl->out_msglen,
2498 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002499 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2500 }
2501
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002502 /*
2503 * Fill handshake headers
2504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002506 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002507 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2508 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2509 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002510
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002511 /*
2512 * DTLS has additional fields in the Handshake layer,
2513 * between the length field and the actual payload:
2514 * uint16 message_seq;
2515 * uint24 fragment_offset;
2516 * uint24 fragment_length;
2517 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002519 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002520 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002521 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002522 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002523 {
2524 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002525 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002526 hs_len,
2527 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002528 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2529 }
2530
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002531 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002532 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002533
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002534 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002535 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002536 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002537 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002538 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002539 }
2540 else
2541 {
2542 ssl->out_msg[4] = 0;
2543 ssl->out_msg[5] = 0;
2544 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002545
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002546 /* Handshake hashes are computed without fragmentation,
2547 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002548 memset( ssl->out_msg + 6, 0x00, 3 );
2549 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002550 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002552
Hanno Becker0207e532018-08-28 10:28:28 +01002553 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002554 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002555 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002556 }
2557
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002558 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002560 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002561 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2562 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002563 {
2564 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2565 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002567 return( ret );
2568 }
2569 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002570 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002571#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002572 {
Ronald Cron66dbf912022-02-02 15:33:46 +01002573 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002574 {
2575 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2576 return( ret );
2577 }
2578 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002579
2580 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2581
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002582 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002583}
2584
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002585int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
2586 size_t buf_len, size_t msg_len )
2587{
2588 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2589 size_t msg_with_header_len;
2590 ((void) buf_len);
2591
2592 /* Add reserved 4 bytes for handshake header */
2593 msg_with_header_len = msg_len + 4;
2594 ssl->out_msglen = msg_with_header_len;
2595 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_write_handshake_msg_ext( ssl, 0, 0 ) );
2596
2597cleanup:
2598 return( ret );
2599}
2600
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002601/*
2602 * Record layer functions
2603 */
2604
2605/*
2606 * Write current record.
2607 *
2608 * Uses:
2609 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2610 * - ssl->out_msglen: length of the record content (excl headers)
2611 * - ssl->out_msg: record content
2612 */
Ronald Cron00d012f22022-03-08 15:57:12 +01002613int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002614{
2615 int ret, done = 0;
2616 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002617 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002618
2619 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002620
Paul Bakker05ef8352012-05-08 09:17:57 +00002621 if( !done )
2622 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002623 unsigned i;
2624 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002625#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2626 size_t out_buf_len = ssl->out_buf_len;
2627#else
2628 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2629#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002630 /* Skip writing the record content type to after the encryption,
2631 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002632 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002633#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002634 /* TLS 1.3 still uses the TLS 1.2 version identifier
2635 * for backwards compatibility. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002636 if( tls_ver == MBEDTLS_SSL_VERSION_TLS1_3 )
2637 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron6f135e12021-12-08 16:57:54 +01002638#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002639 mbedtls_ssl_write_version( ssl->out_hdr + 1, ssl->conf->transport,
2640 tls_ver );
Hanno Becker6430faf2019-05-08 11:57:13 +01002641
Jerry Yuae0b2e22021-10-08 15:21:19 +08002642 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002643 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002644
Paul Bakker48916f92012-09-16 19:57:18 +00002645 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002646 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002647 mbedtls_record rec;
2648
2649 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002650 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002651 rec.data_len = ssl->out_msglen;
2652 rec.data_offset = ssl->out_msg - rec.buf;
2653
Jerry Yud96a5c22021-09-29 17:46:51 +08002654 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Glenn Strausse3af4cb2022-03-15 03:23:42 -04002655 mbedtls_ssl_write_version( rec.ver, ssl->conf->transport, tls_ver );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002656 rec.type = ssl->out_msgtype;
2657
Hanno Beckera0e20d02019-05-15 14:03:01 +01002658#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002659 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002660 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002661#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002662
Hanno Beckera18d1322018-01-03 14:27:32 +00002663 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002664 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002665 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002667 return( ret );
2668 }
2669
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002670 if( rec.data_offset != 0 )
2671 {
2672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2673 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2674 }
2675
Hanno Becker6430faf2019-05-08 11:57:13 +01002676 /* Update the record content type and CID. */
2677 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002678#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002679 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002680#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002681 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002682 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002683 }
2684
Hanno Becker5903de42019-05-03 14:46:38 +01002685 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002686
2687#if defined(MBEDTLS_SSL_PROTO_DTLS)
2688 /* In case of DTLS, double-check that we don't exceed
2689 * the remaining space in the datagram. */
2690 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2691 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002692 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002693 if( ret < 0 )
2694 return( ret );
2695
2696 if( protected_record_size > (size_t) ret )
2697 {
2698 /* Should never happen */
2699 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2700 }
2701 }
2702#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002703
Hanno Becker6430faf2019-05-08 11:57:13 +01002704 /* Now write the potentially updated record content type. */
2705 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2706
Paul Elliott9f352112020-12-09 14:55:45 +00002707 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002708 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002709 ssl->out_hdr[0], ssl->out_hdr[1],
2710 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002713 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002714
2715 ssl->out_left += protected_record_size;
2716 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002717 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002718
Hanno Beckerdd772292020-02-05 10:38:31 +00002719 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002720 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2721 break;
2722
2723 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002724 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002725 {
2726 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2727 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2728 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002729 }
2730
Hanno Becker67bc7c32018-08-06 11:33:50 +01002731#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002732 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2733 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002734 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002735 size_t remaining;
2736 ret = ssl_get_remaining_payload_in_datagram( ssl );
2737 if( ret < 0 )
2738 {
2739 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2740 ret );
2741 return( ret );
2742 }
2743
2744 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002745 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002746 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002747 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002748 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002749 else
2750 {
Hanno Becker513815a2018-08-20 11:56:09 +01002751 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002752 }
2753 }
2754#endif /* MBEDTLS_SSL_PROTO_DTLS */
2755
2756 if( ( flush == SSL_FORCE_FLUSH ) &&
2757 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002758 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002760 return( ret );
2761 }
2762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002763 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002764
2765 return( 0 );
2766}
2767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002769
2770static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2771{
2772 if( ssl->in_msglen < ssl->in_hslen ||
2773 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2774 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2775 {
2776 return( 1 );
2777 }
2778 return( 0 );
2779}
Hanno Becker44650b72018-08-16 12:51:11 +01002780
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002781static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002782{
2783 return( ( ssl->in_msg[9] << 16 ) |
2784 ( ssl->in_msg[10] << 8 ) |
2785 ssl->in_msg[11] );
2786}
2787
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002788static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002789{
2790 return( ( ssl->in_msg[6] << 16 ) |
2791 ( ssl->in_msg[7] << 8 ) |
2792 ssl->in_msg[8] );
2793}
2794
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002795static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002796{
2797 uint32_t msg_len, frag_off, frag_len;
2798
2799 msg_len = ssl_get_hs_total_len( ssl );
2800 frag_off = ssl_get_hs_frag_off( ssl );
2801 frag_len = ssl_get_hs_frag_len( ssl );
2802
2803 if( frag_off > msg_len )
2804 return( -1 );
2805
2806 if( frag_len > msg_len - frag_off )
2807 return( -1 );
2808
2809 if( frag_len + 12 > ssl->in_msglen )
2810 return( -1 );
2811
2812 return( 0 );
2813}
2814
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002815/*
2816 * Mark bits in bitmask (used for DTLS HS reassembly)
2817 */
2818static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2819{
2820 unsigned int start_bits, end_bits;
2821
2822 start_bits = 8 - ( offset % 8 );
2823 if( start_bits != 8 )
2824 {
2825 size_t first_byte_idx = offset / 8;
2826
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002827 /* Special case */
2828 if( len <= start_bits )
2829 {
2830 for( ; len != 0; len-- )
2831 mask[first_byte_idx] |= 1 << ( start_bits - len );
2832
2833 /* Avoid potential issues with offset or len becoming invalid */
2834 return;
2835 }
2836
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002837 offset += start_bits; /* Now offset % 8 == 0 */
2838 len -= start_bits;
2839
2840 for( ; start_bits != 0; start_bits-- )
2841 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2842 }
2843
2844 end_bits = len % 8;
2845 if( end_bits != 0 )
2846 {
2847 size_t last_byte_idx = ( offset + len ) / 8;
2848
2849 len -= end_bits; /* Now len % 8 == 0 */
2850
2851 for( ; end_bits != 0; end_bits-- )
2852 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2853 }
2854
2855 memset( mask + offset / 8, 0xFF, len / 8 );
2856}
2857
2858/*
2859 * Check that bitmask is full
2860 */
2861static int ssl_bitmask_check( unsigned char *mask, size_t len )
2862{
2863 size_t i;
2864
2865 for( i = 0; i < len / 8; i++ )
2866 if( mask[i] != 0xFF )
2867 return( -1 );
2868
2869 for( i = 0; i < len % 8; i++ )
2870 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2871 return( -1 );
2872
2873 return( 0 );
2874}
2875
Hanno Becker56e205e2018-08-16 09:06:12 +01002876/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002877static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002878 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002879{
Hanno Becker56e205e2018-08-16 09:06:12 +01002880 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002881
Hanno Becker56e205e2018-08-16 09:06:12 +01002882 alloc_len = 12; /* Handshake header */
2883 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002884
Hanno Beckerd07df862018-08-16 09:14:58 +01002885 if( add_bitmap )
2886 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002887
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002888 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002889}
Hanno Becker56e205e2018-08-16 09:06:12 +01002890
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
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002893static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002894{
2895 return( ( ssl->in_msg[1] << 16 ) |
2896 ( ssl->in_msg[2] << 8 ) |
2897 ssl->in_msg[3] );
2898}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002899
Simon Butcher99000142016-10-13 17:21:01 +01002900int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002901{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002903 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002904 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002905 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002907 }
2908
Hanno Becker12555c62018-08-16 12:47:53 +01002909 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002912 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002913 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002916 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002917 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002918 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002919 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002920
Hanno Becker44650b72018-08-16 12:51:11 +01002921 if( ssl_check_hs_header( ssl ) != 0 )
2922 {
2923 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2924 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2925 }
2926
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002927 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00002928 ( ( mbedtls_ssl_is_handshake_over( ssl ) == 0 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002929 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002930 ( mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002931 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002932 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002933 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2934 {
2935 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2936 recv_msg_seq,
2937 ssl->handshake->in_msg_seq ) );
2938 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2939 }
2940
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002941 /* Retransmit only on last message from previous flight, to avoid
2942 * too many retransmissions.
2943 * Besides, No sane server ever retransmits HelloVerifyRequest */
2944 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002945 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002946 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002948 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002949 recv_msg_seq,
2950 ssl->handshake->in_flight_start_seq ) );
2951
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002953 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002955 return( ret );
2956 }
2957 }
2958 else
2959 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002961 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002962 recv_msg_seq,
2963 ssl->handshake->in_msg_seq ) );
2964 }
2965
Hanno Becker90333da2017-10-10 11:27:13 +01002966 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002967 }
2968 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002969
Hanno Becker6d97ef52018-08-16 13:09:04 +01002970 /* Message reassembly is handled alongside buffering of future
2971 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002972 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002973 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002974 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002975 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002977 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002978 }
2979 }
2980 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002982 /* With TLS we don't handle fragmentation (for now) */
2983 if( ssl->in_msglen < ssl->in_hslen )
2984 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2986 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002987 }
2988
Simon Butcher99000142016-10-13 17:21:01 +01002989 return( 0 );
2990}
2991
2992void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2993{
Hanno Becker0271f962018-08-16 13:23:47 +01002994 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002995
Paul Elliott27b0d942022-03-18 21:55:32 +00002996 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002997 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002998 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002999 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003000
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003001 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003003 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003004 ssl->handshake != NULL )
3005 {
Hanno Becker0271f962018-08-16 13:23:47 +01003006 unsigned offset;
3007 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003008
Hanno Becker0271f962018-08-16 13:23:47 +01003009 /* Increment handshake sequence number */
3010 hs->in_msg_seq++;
3011
3012 /*
3013 * Clear up handshake buffering and reassembly structure.
3014 */
3015
3016 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003017 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003018
3019 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003020 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3021 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003022 offset++, hs_buf++ )
3023 {
3024 *hs_buf = *(hs_buf + 1);
3025 }
3026
3027 /* Create a fresh last entry */
3028 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003029 }
3030#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003031}
3032
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003033/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003034 * DTLS anti-replay: RFC 6347 4.1.2.6
3035 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003036 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3037 * Bit n is set iff record number in_window_top - n has been seen.
3038 *
3039 * Usually, in_window_top is the last record number seen and the lsb of
3040 * in_window is set. The only exception is the initial state (record number 0
3041 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003044void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003045{
3046 ssl->in_window_top = 0;
3047 ssl->in_window = 0;
3048}
3049
3050static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3051{
3052 return( ( (uint64_t) buf[0] << 40 ) |
3053 ( (uint64_t) buf[1] << 32 ) |
3054 ( (uint64_t) buf[2] << 24 ) |
3055 ( (uint64_t) buf[3] << 16 ) |
3056 ( (uint64_t) buf[4] << 8 ) |
3057 ( (uint64_t) buf[5] ) );
3058}
3059
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003060static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3061{
Janos Follath865b3eb2019-12-16 11:46:15 +00003062 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003063 unsigned char *original_in_ctr;
3064
3065 // save original in_ctr
3066 original_in_ctr = ssl->in_ctr;
3067
3068 // use counter from record
3069 ssl->in_ctr = record_in_ctr;
3070
3071 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3072
3073 // restore the counter
3074 ssl->in_ctr = original_in_ctr;
3075
3076 return ret;
3077}
3078
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003079/*
3080 * Return 0 if sequence number is acceptable, -1 otherwise
3081 */
Hanno Becker0183d692019-07-12 08:50:37 +01003082int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003083{
3084 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3085 uint64_t bit;
3086
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003087 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003088 return( 0 );
3089
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003090 if( rec_seqnum > ssl->in_window_top )
3091 return( 0 );
3092
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003093 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003094
3095 if( bit >= 64 )
3096 return( -1 );
3097
3098 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3099 return( -1 );
3100
3101 return( 0 );
3102}
3103
3104/*
3105 * Update replay window on new validated record
3106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003108{
3109 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3110
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003111 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003112 return;
3113
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003114 if( rec_seqnum > ssl->in_window_top )
3115 {
3116 /* Update window_top and the contents of the window */
3117 uint64_t shift = rec_seqnum - ssl->in_window_top;
3118
3119 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003120 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003121 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003122 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003123 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003124 ssl->in_window |= 1;
3125 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003126
3127 ssl->in_window_top = rec_seqnum;
3128 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003129 else
3130 {
3131 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003132 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003133
3134 if( bit < 64 ) /* Always true, but be extra sure */
3135 ssl->in_window |= (uint64_t) 1 << bit;
3136 }
3137}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003139
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003140#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003141/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003142 * Check if a datagram looks like a ClientHello with a valid cookie,
3143 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003144 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003145 *
3146 * - if cookie is valid, return 0
3147 * - if ClientHello looks superficially valid but cookie is not,
3148 * fill obuf and set olen, then
3149 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3150 * - otherwise return a specific error code
3151 */
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003152MBEDTLS_STATIC_TESTABLE
3153int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003154 mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003155 const unsigned char *cli_id, size_t cli_id_len,
3156 const unsigned char *in, size_t in_len,
3157 unsigned char *obuf, size_t buf_len, size_t *olen )
3158{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003159 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003160 unsigned char *p;
3161
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003162 /*
3163 * Structure of ClientHello with record and handshake headers,
3164 * and expected values. We don't need to check a lot, more checks will be
3165 * done when actually parsing the ClientHello - skipping those checks
3166 * avoids code duplication and does not make cookie forging any easier.
3167 *
3168 * 0-0 ContentType type; copied, must be handshake
3169 * 1-2 ProtocolVersion version; copied
3170 * 3-4 uint16 epoch; copied, must be 0
3171 * 5-10 uint48 sequence_number; copied
3172 * 11-12 uint16 length; (ignored)
3173 *
3174 * 13-13 HandshakeType msg_type; (ignored)
3175 * 14-16 uint24 length; (ignored)
3176 * 17-18 uint16 message_seq; copied
3177 * 19-21 uint24 fragment_offset; copied, must be 0
3178 * 22-24 uint24 fragment_length; (ignored)
3179 *
3180 * 25-26 ProtocolVersion client_version; (ignored)
3181 * 27-58 Random random; (ignored)
3182 * 59-xx SessionID session_id; 1 byte len + sid_len content
3183 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3184 * ...
3185 *
3186 * Minimum length is 61 bytes.
3187 */
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003188 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: in_len=%u",
3189 (unsigned) in_len ) );
3190 MBEDTLS_SSL_DEBUG_BUF( 4, "cli_id", cli_id, cli_id_len );
3191 if( in_len < 61 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003192 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003193 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: record too short" ) );
3194 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
3195 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003196
3197 epoch = MBEDTLS_GET_UINT16_BE( in, 3 );
3198 fragment_offset = MBEDTLS_GET_UINT24_BE( in, 19 );
3199
3200 if( in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3201 fragment_offset != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003202 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003203 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: not a good ClientHello" ) );
3204 MBEDTLS_SSL_DEBUG_MSG( 4, ( " type=%u epoch=%u fragment_offset=%u",
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003205 in[0], (unsigned) epoch,
3206 (unsigned) fragment_offset ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003207 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003208 }
3209
3210 sid_len = in[59];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003211 if( 59 + 1 + sid_len + 1 > in_len )
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003212 {
3213 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: sid_len=%u > %u",
3214 (unsigned) sid_len,
3215 (unsigned) in_len - 61 ) );
Hanno Becker90d59dd2021-06-24 11:17:13 +01003216 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003217 }
3218 MBEDTLS_SSL_DEBUG_BUF( 4, "sid received from network",
3219 in + 60, sid_len );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003220
3221 cookie_len = in[60 + sid_len];
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003222 if( 59 + 1 + sid_len + 1 + cookie_len > in_len )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003223 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003224 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: cookie_len=%u > %u",
3225 (unsigned) cookie_len,
Andrzej Kurekc8183cc2022-06-06 14:42:41 -04003226 (unsigned) ( in_len - sid_len - 61 ) ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003227 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003228 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003229
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003230 MBEDTLS_SSL_DEBUG_BUF( 4, "cookie received from network",
3231 in + sid_len + 61, cookie_len );
3232 if( ssl->conf->f_cookie_check( ssl->conf->p_cookie,
3233 in + sid_len + 61, cookie_len,
3234 cli_id, cli_id_len ) == 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003235 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003236 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: valid" ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003237 return( 0 );
3238 }
3239
3240 /*
3241 * If we get here, we've got an invalid cookie, let's prepare HVR.
3242 *
3243 * 0-0 ContentType type; copied
3244 * 1-2 ProtocolVersion version; copied
3245 * 3-4 uint16 epoch; copied
3246 * 5-10 uint48 sequence_number; copied
3247 * 11-12 uint16 length; olen - 13
3248 *
3249 * 13-13 HandshakeType msg_type; hello_verify_request
3250 * 14-16 uint24 length; olen - 25
3251 * 17-18 uint16 message_seq; copied
3252 * 19-21 uint24 fragment_offset; copied
3253 * 22-24 uint24 fragment_length; olen - 25
3254 *
3255 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3256 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3257 *
3258 * Minimum length is 28.
3259 */
3260 if( buf_len < 28 )
3261 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3262
3263 /* Copy most fields and adapt others */
3264 memcpy( obuf, in, 25 );
3265 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3266 obuf[25] = 0xfe;
3267 obuf[26] = 0xff;
3268
3269 /* Generate and write actual cookie */
3270 p = obuf + 28;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003271 if( ssl->conf->f_cookie_write( ssl->conf->p_cookie,
3272 &p, obuf + buf_len,
3273 cli_id, cli_id_len ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003274 {
3275 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3276 }
3277
3278 *olen = p - obuf;
3279
3280 /* Go back and fill length fields */
3281 obuf[27] = (unsigned char)( *olen - 28 );
3282
Joe Subbianifbeb6922021-07-16 14:27:50 +01003283 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3284 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3285 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003286
Joe Subbiani6dd73642021-07-19 11:56:54 +01003287 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003288
3289 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3290}
3291
3292/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003293 * Handle possible client reconnect with the same UDP quadruplet
3294 * (RFC 6347 Section 4.2.8).
3295 *
3296 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3297 * that looks like a ClientHello.
3298 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003299 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003300 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003301 * - if the input looks like a ClientHello with a valid cookie,
3302 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003303 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003304 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003305 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003306 * This function is called (through ssl_check_client_reconnect()) when an
3307 * unexpected record is found in ssl_get_next_record(), which will discard the
3308 * record if we return 0, and bubble up the return value otherwise (this
3309 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3310 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003311 */
3312static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3313{
Janos Follath865b3eb2019-12-16 11:46:15 +00003314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003315 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003316
Hanno Becker2fddd372019-07-10 14:37:41 +01003317 if( ssl->conf->f_cookie_write == NULL ||
3318 ssl->conf->f_cookie_check == NULL )
3319 {
3320 /* If we can't use cookies to verify reachability of the peer,
3321 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003322 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3323 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003324 return( 0 );
3325 }
3326
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003327 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003328 ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003329 ssl->cli_id, ssl->cli_id_len,
3330 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003331 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003332
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003333 MBEDTLS_SSL_DEBUG_RET( 2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003334
3335 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003336 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003337 int send_ret;
3338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3339 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3340 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003341 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003342 * If the error is permanent we'll catch it later,
3343 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003344 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3345 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3346 (void) send_ret;
3347
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003348 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003349 }
3350
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003351 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003352 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003353 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003354 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003355 {
3356 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3357 return( ret );
3358 }
3359
3360 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003361 }
3362
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003363 return( ret );
3364}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003365#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003366
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003367static int ssl_check_record_type( uint8_t record_type )
3368{
3369 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3370 record_type != MBEDTLS_SSL_MSG_ALERT &&
3371 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3372 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3373 {
3374 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3375 }
3376
3377 return( 0 );
3378}
3379
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003380/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003381 * ContentType type;
3382 * ProtocolVersion version;
3383 * uint16 epoch; // DTLS only
3384 * uint48 sequence_number; // DTLS only
3385 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003386 *
3387 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003388 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003389 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3390 *
3391 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003392 * 1. proceed with the record if this function returns 0
3393 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3394 * 3. return CLIENT_RECONNECT if this function return that value
3395 * 4. drop the whole datagram if this function returns anything else.
3396 * Point 2 is needed when the peer is resending, and we have already received
3397 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003398 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003399static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003400 unsigned char *buf,
3401 size_t len,
3402 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003403{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003404 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003405
Hanno Beckere5e7e782019-07-11 12:29:35 +01003406 size_t const rec_hdr_type_offset = 0;
3407 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003408
Hanno Beckere5e7e782019-07-11 12:29:35 +01003409 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3410 rec_hdr_type_len;
3411 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003412
Hanno Beckere5e7e782019-07-11 12:29:35 +01003413 size_t const rec_hdr_ctr_len = 8;
3414#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003415 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003416 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3417 rec_hdr_version_len;
3418
Hanno Beckera0e20d02019-05-15 14:03:01 +01003419#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003420 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3421 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003422 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003423#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3424#endif /* MBEDTLS_SSL_PROTO_DTLS */
3425
3426 size_t rec_hdr_len_offset; /* To be determined */
3427 size_t const rec_hdr_len_len = 2;
3428
3429 /*
3430 * Check minimum lengths for record header.
3431 */
3432
3433#if defined(MBEDTLS_SSL_PROTO_DTLS)
3434 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3435 {
3436 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3437 }
3438 else
3439#endif /* MBEDTLS_SSL_PROTO_DTLS */
3440 {
3441 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3442 }
3443
3444 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3445 {
3446 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3447 (unsigned) len,
3448 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3449 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3450 }
3451
3452 /*
3453 * Parse and validate record content type
3454 */
3455
3456 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003457
3458 /* Check record content type */
3459#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3460 rec->cid_len = 0;
3461
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003462 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003463 ssl->conf->cid_len != 0 &&
3464 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003465 {
3466 /* Shift pointers to account for record header including CID
3467 * struct {
3468 * ContentType special_type = tls12_cid;
3469 * ProtocolVersion version;
3470 * uint16 epoch;
3471 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003472 * opaque cid[cid_length]; // Additional field compared to
3473 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003474 * uint16 length;
3475 * opaque enc_content[DTLSCiphertext.length];
3476 * } DTLSCiphertext;
3477 */
3478
3479 /* So far, we only support static CID lengths
3480 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003481 rec_hdr_cid_len = ssl->conf->cid_len;
3482 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003483
Hanno Beckere5e7e782019-07-11 12:29:35 +01003484 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003485 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3487 (unsigned) len,
3488 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003489 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003490 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003491
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003492 /* configured CID len is guaranteed at most 255, see
3493 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3494 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003495 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003496 }
3497 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003498#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003499 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003500 if( ssl_check_record_type( rec->type ) )
3501 {
Hanno Becker54229812019-07-12 14:40:00 +01003502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3503 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003504 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3505 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003506 }
3507
Hanno Beckere5e7e782019-07-11 12:29:35 +01003508 /*
3509 * Parse and validate record version
3510 */
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003511 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3512 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003513 tls_version = mbedtls_ssl_read_version( buf + rec_hdr_version_offset,
3514 ssl->conf->transport );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003515
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003516 if( tls_version > ssl->conf->max_tls_version )
Paul Bakker5121ce52009-01-03 21:22:43 +00003517 {
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003518 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS version mismatch: got %u, expected max %u",
3519 (unsigned) tls_version,
3520 (unsigned) ssl->conf->max_tls_version) );
3521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003523 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003524 /*
3525 * Parse/Copy record sequence number.
3526 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003527
Hanno Beckere5e7e782019-07-11 12:29:35 +01003528#if defined(MBEDTLS_SSL_PROTO_DTLS)
3529 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003530 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003531 /* Copy explicit record sequence number from input buffer. */
3532 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3533 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003534 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003535 else
3536#endif /* MBEDTLS_SSL_PROTO_DTLS */
3537 {
3538 /* Copy implicit record sequence number from SSL context structure. */
3539 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3540 }
Paul Bakker40e46942009-01-03 21:51:57 +00003541
Hanno Beckere5e7e782019-07-11 12:29:35 +01003542 /*
3543 * Parse record length.
3544 */
3545
Hanno Beckere5e7e782019-07-11 12:29:35 +01003546 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003547 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3548 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003549 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003550
Paul Elliott9f352112020-12-09 14:55:45 +00003551 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003552 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3553 rec->type, (unsigned)tls_version, rec->data_len ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003554
3555 rec->buf = buf;
3556 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003557
Hanno Beckerd417cc92019-07-26 08:20:27 +01003558 if( rec->data_len == 0 )
3559 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003560
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003561 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003562 * DTLS-related tests.
3563 * Check epoch before checking length constraint because
3564 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3565 * message gets duplicated before the corresponding Finished message,
3566 * the second ChangeCipherSpec should be discarded because it belongs
3567 * to an old epoch, but not because its length is shorter than
3568 * the minimum record length for packets using the new record transform.
3569 * Note that these two kinds of failures are handled differently,
3570 * as an unexpected record is silently skipped but an invalid
3571 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003572 */
3573#if defined(MBEDTLS_SSL_PROTO_DTLS)
3574 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3575 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003576 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003577
Hanno Becker955a5c92019-07-10 17:12:07 +01003578 /* Check that the datagram is large enough to contain a record
3579 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003580 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003581 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003582 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3583 (unsigned) len,
3584 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003585 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3586 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003587
Hanno Becker37cfe732019-07-10 17:20:01 +01003588 /* Records from other, non-matching epochs are silently discarded.
3589 * (The case of same-port Client reconnects must be considered in
3590 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003591 if( rec_epoch != ssl->in_epoch )
3592 {
3593 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003594 "expected %u, received %lu",
3595 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003596
Hanno Becker552f7472019-07-19 10:59:12 +01003597 /* Records from the next epoch are considered for buffering
3598 * (concretely: early Finished messages). */
3599 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003600 {
Hanno Becker552f7472019-07-19 10:59:12 +01003601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3602 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003603 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003604
Hanno Becker2fddd372019-07-10 14:37:41 +01003605 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003606 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003607#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003608 /* For records from the correct epoch, check whether their
3609 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003610 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3611 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003612 {
3613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3614 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3615 }
3616#endif
3617 }
3618#endif /* MBEDTLS_SSL_PROTO_DTLS */
3619
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003620 return( 0 );
3621}
Paul Bakker5121ce52009-01-03 21:22:43 +00003622
Paul Bakker5121ce52009-01-03 21:22:43 +00003623
Hanno Becker2fddd372019-07-10 14:37:41 +01003624#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3625static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3626{
3627 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3628
3629 /*
3630 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3631 * access the first byte of record content (handshake type), as we
3632 * have an active transform (possibly iv_len != 0), so use the
3633 * fact that the record header len is 13 instead.
3634 */
3635 if( rec_epoch == 0 &&
3636 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Paul Elliott27b0d942022-03-18 21:55:32 +00003637 mbedtls_ssl_is_handshake_over( ssl ) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003638 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3639 ssl->in_left > 13 &&
3640 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3641 {
3642 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3643 "from the same port" ) );
3644 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003645 }
3646
3647 return( 0 );
3648}
Hanno Becker2fddd372019-07-10 14:37:41 +01003649#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003650
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003651/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003652 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003653 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003654static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3655 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003656{
3657 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003659 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003660 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003661
Ronald Cron7e38cba2021-11-24 12:43:39 +01003662 /*
3663 * In TLS 1.3, always treat ChangeCipherSpec records
3664 * as unencrypted. The only thing we do with them is
3665 * check the length and content and ignore them.
3666 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003667#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003668 if( ssl->transform_in != NULL &&
Glenn Strauss07c64162022-03-14 12:34:51 -04003669 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01003670 {
3671 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3672 done = 1;
3673 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003674#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003675
Paul Bakker48916f92012-09-16 19:57:18 +00003676 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003677 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003678 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003679
Hanno Beckera18d1322018-01-03 14:27:32 +00003680 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003681 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003682 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003683 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003684
Hanno Beckera0e20d02019-05-15 14:03:01 +01003685#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003686 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3687 ssl->conf->ignore_unexpected_cid
3688 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3689 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003690 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003691 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003692 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003694
Paul Bakker5121ce52009-01-03 21:22:43 +00003695 return( ret );
3696 }
3697
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003698 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003699 {
3700 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003701 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003702 }
3703
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003704 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003705 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003706
Hanno Beckera0e20d02019-05-15 14:03:01 +01003707#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003708 /* We have already checked the record content type
3709 * in ssl_parse_record_header(), failing or silently
3710 * dropping the record in the case of an unknown type.
3711 *
3712 * Since with the use of CIDs, the record content type
3713 * might change during decryption, re-check the record
3714 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003715 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003716 {
3717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3718 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3719 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003720#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003721
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003722 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003723 {
3724#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003725 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003726 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003727 {
3728 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3729 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3730 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3731 }
3732#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3733
3734 ssl->nb_zero++;
3735
3736 /*
3737 * Three or more empty messages may be a DoS attack
3738 * (excessive CPU consumption).
3739 */
3740 if( ssl->nb_zero > 3 )
3741 {
3742 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003743 "messages, possible DoS attack" ) );
3744 /* Treat the records as if they were not properly authenticated,
3745 * thereby failing the connection if we see more than allowed
3746 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003747 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3748 }
3749 }
3750 else
3751 ssl->nb_zero = 0;
3752
3753#if defined(MBEDTLS_SSL_PROTO_DTLS)
3754 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3755 {
3756 ; /* in_ctr read from peer, not maintained internally */
3757 }
3758 else
3759#endif
3760 {
3761 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003762 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3763 i > mbedtls_ssl_ep_len( ssl ); i-- )
3764 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003765 if( ++ssl->in_ctr[i - 1] != 0 )
3766 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003767 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003768
3769 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003770 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003771 {
3772 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3773 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3774 }
3775 }
3776
Paul Bakker5121ce52009-01-03 21:22:43 +00003777 }
3778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003779#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003780 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003781 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003782 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003783 }
3784#endif
3785
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003786 /* Check actual (decrypted) record content length against
3787 * configured maximum. */
3788 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3789 {
3790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3791 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3792 }
3793
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003794 return( 0 );
3795}
3796
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003797/*
3798 * Read a record.
3799 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003800 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3801 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3802 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003803 */
Hanno Becker1097b342018-08-15 14:09:41 +01003804
3805/* Helper functions for mbedtls_ssl_read_record(). */
3806static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003807static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3808static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003809
Hanno Becker327c93b2018-08-15 13:56:18 +01003810int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003811 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003812{
Janos Follath865b3eb2019-12-16 11:46:15 +00003813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003815 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003816
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003817 if( ssl->keep_current_message == 0 )
3818 {
3819 do {
Simon Butcher99000142016-10-13 17:21:01 +01003820
Hanno Becker26994592018-08-15 14:14:59 +01003821 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003822 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003823 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003824
Hanno Beckere74d5562018-08-15 14:26:08 +01003825 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003826 {
Hanno Becker40f50842018-08-15 14:48:01 +01003827#if defined(MBEDTLS_SSL_PROTO_DTLS)
3828 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003829
Hanno Becker40f50842018-08-15 14:48:01 +01003830 /* We only check for buffered messages if the
3831 * current datagram is fully consumed. */
3832 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003833 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003834 {
Hanno Becker40f50842018-08-15 14:48:01 +01003835 if( ssl_load_buffered_message( ssl ) == 0 )
3836 have_buffered = 1;
3837 }
3838
3839 if( have_buffered == 0 )
3840#endif /* MBEDTLS_SSL_PROTO_DTLS */
3841 {
3842 ret = ssl_get_next_record( ssl );
3843 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3844 continue;
3845
3846 if( ret != 0 )
3847 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003848 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003849 return( ret );
3850 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003851 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003852 }
3853
3854 ret = mbedtls_ssl_handle_message_type( ssl );
3855
Hanno Becker40f50842018-08-15 14:48:01 +01003856#if defined(MBEDTLS_SSL_PROTO_DTLS)
3857 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3858 {
3859 /* Buffer future message */
3860 ret = ssl_buffer_message( ssl );
3861 if( ret != 0 )
3862 return( ret );
3863
3864 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3865 }
3866#endif /* MBEDTLS_SSL_PROTO_DTLS */
3867
Hanno Becker90333da2017-10-10 11:27:13 +01003868 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3869 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003870
3871 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003872 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003873 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003874 return( ret );
3875 }
3876
Hanno Becker327c93b2018-08-15 13:56:18 +01003877 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003878 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003879 {
3880 mbedtls_ssl_update_handshake_status( ssl );
3881 }
Simon Butcher99000142016-10-13 17:21:01 +01003882 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003883 else
Simon Butcher99000142016-10-13 17:21:01 +01003884 {
Hanno Becker02f59072018-08-15 14:00:24 +01003885 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003886 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003887 }
3888
3889 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3890
3891 return( 0 );
3892}
3893
Hanno Becker40f50842018-08-15 14:48:01 +01003894#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003895static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003896{
Hanno Becker40f50842018-08-15 14:48:01 +01003897 if( ssl->in_left > ssl->next_record_offset )
3898 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003899
Hanno Becker40f50842018-08-15 14:48:01 +01003900 return( 0 );
3901}
3902
3903static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3904{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003905 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003906 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003907 int ret = 0;
3908
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003909 if( hs == NULL )
3910 return( -1 );
3911
Hanno Beckere00ae372018-08-20 09:39:42 +01003912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3913
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003914 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3915 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3916 {
3917 /* Check if we have seen a ChangeCipherSpec before.
3918 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003919 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003920 {
3921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3922 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003923 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003924 }
3925
Hanno Becker39b8bc92018-08-28 17:17:13 +01003926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003927 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3928 ssl->in_msglen = 1;
3929 ssl->in_msg[0] = 1;
3930
3931 /* As long as they are equal, the exact value doesn't matter. */
3932 ssl->in_left = 0;
3933 ssl->next_record_offset = 0;
3934
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003935 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003936 goto exit;
3937 }
Hanno Becker37f95322018-08-16 13:55:32 +01003938
Hanno Beckerb8f50142018-08-28 10:01:34 +01003939#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003940 /* Debug only */
3941 {
3942 unsigned offset;
3943 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3944 {
3945 hs_buf = &hs->buffering.hs[offset];
3946 if( hs_buf->is_valid == 1 )
3947 {
3948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3949 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003950 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003951 }
3952 }
3953 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003954#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003955
3956 /* Check if we have buffered and/or fully reassembled the
3957 * next handshake message. */
3958 hs_buf = &hs->buffering.hs[0];
3959 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3960 {
3961 /* Synthesize a record containing the buffered HS message. */
3962 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3963 ( hs_buf->data[2] << 8 ) |
3964 hs_buf->data[3];
3965
3966 /* Double-check that we haven't accidentally buffered
3967 * a message that doesn't fit into the input buffer. */
3968 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3969 {
3970 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3971 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3972 }
3973
3974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3975 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3976 hs_buf->data, msg_len + 12 );
3977
3978 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3979 ssl->in_hslen = msg_len + 12;
3980 ssl->in_msglen = msg_len + 12;
3981 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3982
3983 ret = 0;
3984 goto exit;
3985 }
3986 else
3987 {
3988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3989 hs->in_msg_seq ) );
3990 }
3991
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003992 ret = -1;
3993
3994exit:
3995
3996 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3997 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003998}
3999
Hanno Beckera02b0b42018-08-21 17:20:27 +01004000static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4001 size_t desired )
4002{
4003 int offset;
4004 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004005 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4006 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004007
Hanno Becker01315ea2018-08-21 17:22:17 +01004008 /* Get rid of future records epoch first, if such exist. */
4009 ssl_free_buffered_record( ssl );
4010
4011 /* Check if we have enough space available now. */
4012 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4013 hs->buffering.total_bytes_buffered ) )
4014 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004015 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004016 return( 0 );
4017 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004018
Hanno Becker4f432ad2018-08-28 10:02:32 +01004019 /* We don't have enough space to buffer the next expected handshake
4020 * message. Remove buffers used for future messages to gain space,
4021 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004022 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4023 offset >= 0; offset-- )
4024 {
4025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4026 offset ) );
4027
Hanno Beckerb309b922018-08-23 13:18:05 +01004028 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004029
4030 /* Check if we have enough space available now. */
4031 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4032 hs->buffering.total_bytes_buffered ) )
4033 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004034 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004035 return( 0 );
4036 }
4037 }
4038
4039 return( -1 );
4040}
4041
Hanno Becker40f50842018-08-15 14:48:01 +01004042static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4043{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004044 int ret = 0;
4045 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4046
4047 if( hs == NULL )
4048 return( 0 );
4049
4050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4051
4052 switch( ssl->in_msgtype )
4053 {
4054 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004056
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004057 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004058 break;
4059
4060 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004061 {
4062 unsigned recv_msg_seq_offset;
4063 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4064 mbedtls_ssl_hs_buffer *hs_buf;
4065 size_t msg_len = ssl->in_hslen - 12;
4066
4067 /* We should never receive an old handshake
4068 * message - double-check nonetheless. */
4069 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4070 {
4071 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4072 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4073 }
4074
4075 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4076 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4077 {
4078 /* Silently ignore -- message too far in the future */
4079 MBEDTLS_SSL_DEBUG_MSG( 2,
4080 ( "Ignore future HS message with sequence number %u, "
4081 "buffering window %u - %u",
4082 recv_msg_seq, ssl->handshake->in_msg_seq,
4083 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4084
4085 goto exit;
4086 }
4087
4088 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4089 recv_msg_seq, recv_msg_seq_offset ) );
4090
4091 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4092
4093 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004094 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004095 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004096 size_t reassembly_buf_sz;
4097
Hanno Becker37f95322018-08-16 13:55:32 +01004098 hs_buf->is_fragmented =
4099 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4100
4101 /* We copy the message back into the input buffer
4102 * after reassembly, so check that it's not too large.
4103 * This is an implementation-specific limitation
4104 * and not one from the standard, hence it is not
4105 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004106 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004107 {
4108 /* Ignore message */
4109 goto exit;
4110 }
4111
Hanno Beckere0b150f2018-08-21 15:51:03 +01004112 /* Check if we have enough space to buffer the message. */
4113 if( hs->buffering.total_bytes_buffered >
4114 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4115 {
4116 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4117 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4118 }
4119
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004120 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4121 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004122
4123 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4124 hs->buffering.total_bytes_buffered ) )
4125 {
4126 if( recv_msg_seq_offset > 0 )
4127 {
4128 /* If we can't buffer a future message because
4129 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004130 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4131 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4132 " (already %" MBEDTLS_PRINTF_SIZET
4133 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004134 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004135 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004136 goto exit;
4137 }
Hanno Beckere1801392018-08-21 16:51:05 +01004138 else
4139 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004140 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4141 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4142 " (already %" MBEDTLS_PRINTF_SIZET
4143 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004144 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004145 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004146 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004147
Hanno Beckera02b0b42018-08-21 17:20:27 +01004148 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004149 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004150 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4151 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4152 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4153 " (already %" MBEDTLS_PRINTF_SIZET
4154 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004155 msg_len,
4156 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004157 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004158 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004159 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4160 goto exit;
4161 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004162 }
4163
Paul Elliottd48d5c62021-01-07 14:47:05 +00004164 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004165 msg_len ) );
4166
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004167 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4168 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004169 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004170 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004171 goto exit;
4172 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004173 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004174
4175 /* Prepare final header: copy msg_type, length and message_seq,
4176 * then add standardised fragment_offset and fragment_length */
4177 memcpy( hs_buf->data, ssl->in_msg, 6 );
4178 memset( hs_buf->data + 6, 0, 3 );
4179 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4180
4181 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004182
4183 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004184 }
4185 else
4186 {
4187 /* Make sure msg_type and length are consistent */
4188 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4189 {
4190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4191 /* Ignore */
4192 goto exit;
4193 }
4194 }
4195
Hanno Becker4422bbb2018-08-20 09:40:19 +01004196 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004197 {
4198 size_t frag_len, frag_off;
4199 unsigned char * const msg = hs_buf->data + 12;
4200
4201 /*
4202 * Check and copy current fragment
4203 */
4204
4205 /* Validation of header fields already done in
4206 * mbedtls_ssl_prepare_handshake_record(). */
4207 frag_off = ssl_get_hs_frag_off( ssl );
4208 frag_len = ssl_get_hs_frag_len( ssl );
4209
Paul Elliottd48d5c62021-01-07 14:47:05 +00004210 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4211 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004212 frag_off, frag_len ) );
4213 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4214
4215 if( hs_buf->is_fragmented )
4216 {
4217 unsigned char * const bitmask = msg + msg_len;
4218 ssl_bitmask_set( bitmask, frag_off, frag_len );
4219 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4220 msg_len ) == 0 );
4221 }
4222 else
4223 {
4224 hs_buf->is_complete = 1;
4225 }
4226
4227 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4228 hs_buf->is_complete ? "" : "not yet " ) );
4229 }
4230
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004231 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004232 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004233
4234 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004235 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004236 break;
4237 }
4238
4239exit:
4240
4241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4242 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004243}
4244#endif /* MBEDTLS_SSL_PROTO_DTLS */
4245
Hanno Becker1097b342018-08-15 14:09:41 +01004246static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004247{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004248 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004249 * Consume last content-layer message and potentially
4250 * update in_msglen which keeps track of the contents'
4251 * consumption state.
4252 *
4253 * (1) Handshake messages:
4254 * Remove last handshake message, move content
4255 * and adapt in_msglen.
4256 *
4257 * (2) Alert messages:
4258 * Consume whole record content, in_msglen = 0.
4259 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004260 * (3) Change cipher spec:
4261 * Consume whole record content, in_msglen = 0.
4262 *
4263 * (4) Application data:
4264 * Don't do anything - the record layer provides
4265 * the application data as a stream transport
4266 * and consumes through mbedtls_ssl_read only.
4267 *
4268 */
4269
4270 /* Case (1): Handshake messages */
4271 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004272 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004273 /* Hard assertion to be sure that no application data
4274 * is in flight, as corrupting ssl->in_msglen during
4275 * ssl->in_offt != NULL is fatal. */
4276 if( ssl->in_offt != NULL )
4277 {
4278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4279 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4280 }
4281
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004282 /*
4283 * Get next Handshake message in the current record
4284 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004285
Hanno Becker4a810fb2017-05-24 16:27:30 +01004286 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004287 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004288 * current handshake content: If DTLS handshake
4289 * fragmentation is used, that's the fragment
4290 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004291 * size here is faulty and should be changed at
4292 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004293 * (2) While it doesn't seem to cause problems, one
4294 * has to be very careful not to assume that in_hslen
4295 * is always <= in_msglen in a sensible communication.
4296 * Again, it's wrong for DTLS handshake fragmentation.
4297 * The following check is therefore mandatory, and
4298 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004299 * Additionally, ssl->in_hslen might be arbitrarily out of
4300 * bounds after handling a DTLS message with an unexpected
4301 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004302 */
4303 if( ssl->in_hslen < ssl->in_msglen )
4304 {
4305 ssl->in_msglen -= ssl->in_hslen;
4306 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4307 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004308
Hanno Becker4a810fb2017-05-24 16:27:30 +01004309 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4310 ssl->in_msg, ssl->in_msglen );
4311 }
4312 else
4313 {
4314 ssl->in_msglen = 0;
4315 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004316
Hanno Becker4a810fb2017-05-24 16:27:30 +01004317 ssl->in_hslen = 0;
4318 }
4319 /* Case (4): Application data */
4320 else if( ssl->in_offt != NULL )
4321 {
4322 return( 0 );
4323 }
4324 /* Everything else (CCS & Alerts) */
4325 else
4326 {
4327 ssl->in_msglen = 0;
4328 }
4329
Hanno Becker1097b342018-08-15 14:09:41 +01004330 return( 0 );
4331}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004332
Hanno Beckere74d5562018-08-15 14:26:08 +01004333static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4334{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004335 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004336 return( 1 );
4337
4338 return( 0 );
4339}
4340
Hanno Becker5f066e72018-08-16 14:56:31 +01004341#if defined(MBEDTLS_SSL_PROTO_DTLS)
4342
4343static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4344{
4345 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4346 if( hs == NULL )
4347 return;
4348
Hanno Becker01315ea2018-08-21 17:22:17 +01004349 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004350 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004351 hs->buffering.total_bytes_buffered -=
4352 hs->buffering.future_record.len;
4353
4354 mbedtls_free( hs->buffering.future_record.data );
4355 hs->buffering.future_record.data = NULL;
4356 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004357}
4358
4359static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4360{
4361 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4362 unsigned char * rec;
4363 size_t rec_len;
4364 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004365#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4366 size_t in_buf_len = ssl->in_buf_len;
4367#else
4368 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4369#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004370 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4371 return( 0 );
4372
4373 if( hs == NULL )
4374 return( 0 );
4375
Hanno Becker5f066e72018-08-16 14:56:31 +01004376 rec = hs->buffering.future_record.data;
4377 rec_len = hs->buffering.future_record.len;
4378 rec_epoch = hs->buffering.future_record.epoch;
4379
4380 if( rec == NULL )
4381 return( 0 );
4382
Hanno Becker4cb782d2018-08-20 11:19:05 +01004383 /* Only consider loading future records if the
4384 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004385 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004386 return( 0 );
4387
Hanno Becker5f066e72018-08-16 14:56:31 +01004388 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4389
4390 if( rec_epoch != ssl->in_epoch )
4391 {
4392 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4393 goto exit;
4394 }
4395
4396 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4397
4398 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004399 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004400 {
4401 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4402 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4403 }
4404
4405 memcpy( ssl->in_hdr, rec, rec_len );
4406 ssl->in_left = rec_len;
4407 ssl->next_record_offset = 0;
4408
4409 ssl_free_buffered_record( ssl );
4410
4411exit:
4412 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4413 return( 0 );
4414}
4415
Hanno Becker519f15d2019-07-11 12:43:20 +01004416static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4417 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004418{
4419 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004420
4421 /* Don't buffer future records outside handshakes. */
4422 if( hs == NULL )
4423 return( 0 );
4424
4425 /* Only buffer handshake records (we are only interested
4426 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004427 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004428 return( 0 );
4429
4430 /* Don't buffer more than one future epoch record. */
4431 if( hs->buffering.future_record.data != NULL )
4432 return( 0 );
4433
Hanno Becker01315ea2018-08-21 17:22:17 +01004434 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004435 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004436 hs->buffering.total_bytes_buffered ) )
4437 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004438 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4439 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4440 " (already %" MBEDTLS_PRINTF_SIZET
4441 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004442 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004443 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004444 return( 0 );
4445 }
4446
Hanno Becker5f066e72018-08-16 14:56:31 +01004447 /* Buffer record */
4448 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004449 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004450 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004451
4452 /* ssl_parse_record_header() only considers records
4453 * of the next epoch as candidates for buffering. */
4454 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004455 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004456
4457 hs->buffering.future_record.data =
4458 mbedtls_calloc( 1, hs->buffering.future_record.len );
4459 if( hs->buffering.future_record.data == NULL )
4460 {
4461 /* If we run out of RAM trying to buffer a
4462 * record from the next epoch, just ignore. */
4463 return( 0 );
4464 }
4465
Hanno Becker519f15d2019-07-11 12:43:20 +01004466 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004467
Hanno Becker519f15d2019-07-11 12:43:20 +01004468 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004469 return( 0 );
4470}
4471
4472#endif /* MBEDTLS_SSL_PROTO_DTLS */
4473
Hanno Beckere74d5562018-08-15 14:26:08 +01004474static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004475{
Janos Follath865b3eb2019-12-16 11:46:15 +00004476 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004477 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004478
Hanno Becker5f066e72018-08-16 14:56:31 +01004479#if defined(MBEDTLS_SSL_PROTO_DTLS)
4480 /* We might have buffered a future record; if so,
4481 * and if the epoch matches now, load it.
4482 * On success, this call will set ssl->in_left to
4483 * the length of the buffered record, so that
4484 * the calls to ssl_fetch_input() below will
4485 * essentially be no-ops. */
4486 ret = ssl_load_buffered_record( ssl );
4487 if( ret != 0 )
4488 return( ret );
4489#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004490
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004491 /* Ensure that we have enough space available for the default form
4492 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4493 * with no space for CIDs counted in). */
4494 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4495 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004496 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004497 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004498 return( ret );
4499 }
4500
Hanno Beckere5e7e782019-07-11 12:29:35 +01004501 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4502 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004504#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004505 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004506 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004507 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4508 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004509 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004510 if( ret != 0 )
4511 return( ret );
4512
4513 /* Fall through to handling of unexpected records */
4514 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4515 }
4516
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004517 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4518 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004519#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004520 /* Reset in pointers to default state for TLS/DTLS records,
4521 * assuming no CID and no offset between record content and
4522 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004523 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004524
Hanno Becker7ae20e02019-07-12 08:33:49 +01004525 /* Setup internal message pointers from record structure. */
4526 ssl->in_msgtype = rec.type;
4527#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4528 ssl->in_len = ssl->in_cid + rec.cid_len;
4529#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4530 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4531 ssl->in_msglen = rec.data_len;
4532
Hanno Becker2fddd372019-07-10 14:37:41 +01004533 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004534 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004535 if( ret != 0 )
4536 return( ret );
4537#endif
4538
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004539 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004540 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004541
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004542 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4543 "(header)" ) );
4544 }
4545 else
4546 {
4547 /* Skip invalid record and the rest of the datagram */
4548 ssl->next_record_offset = 0;
4549 ssl->in_left = 0;
4550
4551 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4552 "(header)" ) );
4553 }
4554
4555 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004556 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004557 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004558 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004559#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004560 {
4561 return( ret );
4562 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004563 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004566 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004567 {
Hanno Beckera8814792019-07-10 15:01:45 +01004568 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004569 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004570 if( ssl->next_record_offset < ssl->in_left )
4571 {
4572 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4573 }
4574 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004575 else
4576#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004577 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004578 /*
4579 * Fetch record contents from underlying transport.
4580 */
Hanno Beckera3175662019-07-11 12:50:29 +01004581 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004582 if( ret != 0 )
4583 {
4584 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4585 return( ret );
4586 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004587
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004588 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004589 }
4590
4591 /*
4592 * Decrypt record contents.
4593 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004594
Hanno Beckerfdf66042019-07-11 13:07:45 +01004595 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004596 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004597#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004598 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004599 {
4600 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004601 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004602 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004603 /* Except when waiting for Finished as a bad mac here
4604 * probably means something went wrong in the handshake
4605 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4606 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4607 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4608 {
4609#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4610 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4611 {
4612 mbedtls_ssl_send_alert_message( ssl,
4613 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4614 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4615 }
4616#endif
4617 return( ret );
4618 }
4619
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004620 if( ssl->conf->badmac_limit != 0 &&
4621 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004622 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004623 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4624 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004625 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004626
Hanno Becker4a810fb2017-05-24 16:27:30 +01004627 /* As above, invalid records cause
4628 * dismissal of the whole datagram. */
4629
4630 ssl->next_record_offset = 0;
4631 ssl->in_left = 0;
4632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004634 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004635 }
4636
4637 return( ret );
4638 }
4639 else
4640#endif
4641 {
4642 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004643#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4644 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004645 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004646 mbedtls_ssl_send_alert_message( ssl,
4647 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4648 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004649 }
4650#endif
4651 return( ret );
4652 }
4653 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004654
Hanno Becker44d89b22019-07-12 09:40:44 +01004655
4656 /* Reset in pointers to default state for TLS/DTLS records,
4657 * assuming no CID and no offset between record content and
4658 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004659 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004660#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4661 ssl->in_len = ssl->in_cid + rec.cid_len;
4662#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004663 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004664
Hanno Becker8685c822019-07-12 09:37:30 +01004665 /* The record content type may change during decryption,
4666 * so re-read it. */
4667 ssl->in_msgtype = rec.type;
4668 /* Also update the input buffer, because unfortunately
4669 * the server-side ssl_parse_client_hello() reparses the
4670 * record header when receiving a ClientHello initiating
4671 * a renegotiation. */
4672 ssl->in_hdr[0] = rec.type;
4673 ssl->in_msg = rec.buf + rec.data_offset;
4674 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004675 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004676
Simon Butcher99000142016-10-13 17:21:01 +01004677 return( 0 );
4678}
4679
4680int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4681{
Janos Follath865b3eb2019-12-16 11:46:15 +00004682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004683
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004684 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004685 * Handle particular types of records
4686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004687 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004688 {
Simon Butcher99000142016-10-13 17:21:01 +01004689 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4690 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004691 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004692 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004693 }
4694
Hanno Beckere678eaa2018-08-21 14:57:46 +01004695 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004696 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004697 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004698 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004700 ssl->in_msglen ) );
4701 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004702 }
4703
Hanno Beckere678eaa2018-08-21 14:57:46 +01004704 if( ssl->in_msg[0] != 1 )
4705 {
4706 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4707 ssl->in_msg[0] ) );
4708 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4709 }
4710
4711#if defined(MBEDTLS_SSL_PROTO_DTLS)
4712 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4713 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4714 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4715 {
4716 if( ssl->handshake == NULL )
4717 {
4718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4719 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4720 }
4721
4722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4723 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4724 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004725#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004726
Ronald Cron6f135e12021-12-08 16:57:54 +01004727#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004728 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron7e38cba2021-11-24 12:43:39 +01004729 {
4730#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4731 MBEDTLS_SSL_DEBUG_MSG( 1,
4732 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4733 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4734#else
4735 MBEDTLS_SSL_DEBUG_MSG( 1,
4736 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4737 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4738#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4739 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004740#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004741 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004742
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004743 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004744 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004745 if( ssl->in_msglen != 2 )
4746 {
4747 /* Note: Standard allows for more than one 2 byte alert
4748 to be packed in a single message, but Mbed TLS doesn't
4749 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004751 ssl->in_msglen ) );
4752 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4753 }
4754
Paul Elliott9f352112020-12-09 14:55:45 +00004755 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004756 ssl->in_msg[0], ssl->in_msg[1] ) );
4757
4758 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004759 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004762 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004763 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004764 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004766 }
4767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004768 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4769 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004770 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004771 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4772 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004773 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004774
4775#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4776 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4777 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4778 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004779 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004780 /* Will be handled when trying to parse ServerHello */
4781 return( 0 );
4782 }
4783#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004784 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004785 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004786 }
4787
Hanno Beckerc76c6192017-06-06 10:03:17 +01004788#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004789 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004790 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004791 /* Drop unexpected ApplicationData records,
4792 * except at the beginning of renegotiations */
4793 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004794 mbedtls_ssl_is_handshake_over( ssl ) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004795#if defined(MBEDTLS_SSL_RENEGOTIATION)
4796 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4797 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004798#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004799 )
4800 {
4801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4802 return( MBEDTLS_ERR_SSL_NON_FATAL );
4803 }
4804
4805 if( ssl->handshake != NULL &&
Paul Elliott27b0d942022-03-18 21:55:32 +00004806 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker37ae9522019-05-03 16:54:26 +01004807 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004808 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004809 }
4810 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004811#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004812
Paul Bakker5121ce52009-01-03 21:22:43 +00004813 return( 0 );
4814}
4815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004816int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004817{
irwir6c0da642019-09-26 21:07:41 +03004818 return( mbedtls_ssl_send_alert_message( ssl,
4819 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4820 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004821}
4822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004823int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004824 unsigned char level,
4825 unsigned char message )
4826{
Janos Follath865b3eb2019-12-16 11:46:15 +00004827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004828
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004829 if( ssl == NULL || ssl->conf == NULL )
4830 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4831
Hanno Becker5e18f742018-08-06 11:35:16 +01004832 if( ssl->out_left != 0 )
4833 return( mbedtls_ssl_flush_output( ssl ) );
4834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004836 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004837
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004838 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004839 ssl->out_msglen = 2;
4840 ssl->out_msg[0] = level;
4841 ssl->out_msg[1] = message;
4842
Hanno Becker67bc7c32018-08-06 11:33:50 +01004843 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004844 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004845 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004846 return( ret );
4847 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004849
4850 return( 0 );
4851}
4852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004853int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004854{
Janos Follath865b3eb2019-12-16 11:46:15 +00004855 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004859 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004860 ssl->out_msglen = 1;
4861 ssl->out_msg[0] = 1;
4862
Paul Bakker5121ce52009-01-03 21:22:43 +00004863 ssl->state++;
4864
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004865 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004866 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004867 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004868 return( ret );
4869 }
4870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004872
4873 return( 0 );
4874}
4875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004876int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004877{
Janos Follath865b3eb2019-12-16 11:46:15 +00004878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004881
Hanno Becker327c93b2018-08-15 13:56:18 +01004882 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004883 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004884 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004885 return( ret );
4886 }
4887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004888 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004890 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004891 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4892 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004893 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 }
4895
Hanno Beckere678eaa2018-08-21 14:57:46 +01004896 /* CCS records are only accepted if they have length 1 and content '1',
4897 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004898
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004899 /*
4900 * Switch to our negotiated transform and session parameters for inbound
4901 * data.
4902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004903 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004904 ssl->transform_in = ssl->transform_negotiate;
4905 ssl->session_in = ssl->session_negotiate;
4906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004907#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004908 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004909 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004910#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004911 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004912#endif
4913
4914 /* Increment epoch */
4915 if( ++ssl->in_epoch == 0 )
4916 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004918 /* This is highly unlikely to happen for legitimate reasons, so
4919 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004920 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004921 }
4922 }
4923 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004925 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004926
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004927 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004928
Paul Bakker5121ce52009-01-03 21:22:43 +00004929 ssl->state++;
4930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004932
4933 return( 0 );
4934}
4935
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004936/* Once ssl->out_hdr as the address of the beginning of the
4937 * next outgoing record is set, deduce the other pointers.
4938 *
4939 * Note: For TLS, we save the implicit record sequence number
4940 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4941 * and the caller has to make sure there's space for this.
4942 */
4943
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004944static size_t ssl_transform_get_explicit_iv_len(
4945 mbedtls_ssl_transform const *transform )
4946{
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004947 return( transform->ivlen - transform->fixed_ivlen );
4948}
4949
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004950void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4951 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004952{
4953#if defined(MBEDTLS_SSL_PROTO_DTLS)
4954 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4955 {
4956 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004957#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004958 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004959 ssl->out_len = ssl->out_cid;
4960 if( transform != NULL )
4961 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004962#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004963 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004964#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004965 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004966 }
4967 else
4968#endif
4969 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004970 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004971#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004972 ssl->out_cid = ssl->out_len;
4973#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004974 ssl->out_iv = ssl->out_hdr + 5;
4975 }
4976
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004977 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004978 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004979 if( transform != NULL )
4980 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004981}
4982
4983/* Once ssl->in_hdr as the address of the beginning of the
4984 * next incoming record is set, deduce the other pointers.
4985 *
4986 * Note: For TLS, we save the implicit record sequence number
4987 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4988 * and the caller has to make sure there's space for this.
4989 */
4990
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004991void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004992{
Hanno Becker79594fd2019-05-08 09:38:41 +01004993 /* This function sets the pointers to match the case
4994 * of unprotected TLS/DTLS records, with both ssl->in_iv
4995 * and ssl->in_msg pointing to the beginning of the record
4996 * content.
4997 *
4998 * When decrypting a protected record, ssl->in_msg
4999 * will be shifted to point to the beginning of the
5000 * record plaintext.
5001 */
5002
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005003#if defined(MBEDTLS_SSL_PROTO_DTLS)
5004 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5005 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005006 /* This sets the header pointers to match records
5007 * without CID. When we receive a record containing
5008 * a CID, the fields are shifted accordingly in
5009 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005010 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005011#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005012 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005013 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005014#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005015 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005016#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005017 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005018 }
5019 else
5020#endif
5021 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005022 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005023 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005024#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005025 ssl->in_cid = ssl->in_len;
5026#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005027 ssl->in_iv = ssl->in_hdr + 5;
5028 }
5029
Hanno Becker79594fd2019-05-08 09:38:41 +01005030 /* This will be adjusted at record decryption time. */
5031 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005032}
5033
Paul Bakker5121ce52009-01-03 21:22:43 +00005034/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005035 * Setup an SSL context
5036 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005037
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005038void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005039{
5040 /* Set the incoming and outgoing record pointers. */
5041#if defined(MBEDTLS_SSL_PROTO_DTLS)
5042 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5043 {
5044 ssl->out_hdr = ssl->out_buf;
5045 ssl->in_hdr = ssl->in_buf;
5046 }
5047 else
5048#endif /* MBEDTLS_SSL_PROTO_DTLS */
5049 {
Hanno Becker12078f42021-03-02 15:28:41 +00005050 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005051 ssl->out_hdr = ssl->out_buf + 8;
5052 ssl->in_hdr = ssl->in_buf + 8;
5053 }
5054
5055 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005056 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5057 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005058}
5059
Paul Bakker5121ce52009-01-03 21:22:43 +00005060/*
5061 * SSL get accessors
5062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005063size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005064{
5065 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5066}
5067
Hanno Becker8b170a02017-10-10 11:51:19 +01005068int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5069{
5070 /*
5071 * Case A: We're currently holding back
5072 * a message for further processing.
5073 */
5074
5075 if( ssl->keep_current_message == 1 )
5076 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005077 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005078 return( 1 );
5079 }
5080
5081 /*
5082 * Case B: Further records are pending in the current datagram.
5083 */
5084
5085#if defined(MBEDTLS_SSL_PROTO_DTLS)
5086 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5087 ssl->in_left > ssl->next_record_offset )
5088 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005089 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005090 return( 1 );
5091 }
5092#endif /* MBEDTLS_SSL_PROTO_DTLS */
5093
5094 /*
5095 * Case C: A handshake message is being processed.
5096 */
5097
Hanno Becker8b170a02017-10-10 11:51:19 +01005098 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5099 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005100 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005101 return( 1 );
5102 }
5103
5104 /*
5105 * Case D: An application data message is being processed
5106 */
5107 if( ssl->in_offt != NULL )
5108 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005109 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005110 return( 1 );
5111 }
5112
5113 /*
5114 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005115 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005116 * we implement support for multiple alerts in single records.
5117 */
5118
5119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5120 return( 0 );
5121}
5122
Paul Bakker43ca69c2011-01-15 17:35:19 +00005123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005124int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005125{
Hanno Becker3136ede2018-08-17 15:28:19 +01005126 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005127 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005128 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005129#if defined(MBEDTLS_USE_PSA_CRYPTO)
5130 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5131 psa_key_type_t key_type;
5132#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005133
Hanno Becker5903de42019-05-03 14:46:38 +01005134 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5135
Hanno Becker78640902018-08-13 16:35:15 +01005136 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005137 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005138
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005139
5140#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005141 if ( transform->psa_alg == PSA_ALG_GCM ||
5142 transform->psa_alg == PSA_ALG_CCM ||
5143 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5144 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005145 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005146 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005147 transform_expansion = transform->minlen;
5148 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005149 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005150 {
5151 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5152 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005153
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005154 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005155
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005156 /* Expansion due to the addition of the MAC. */
5157 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005158
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005159 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005160 * Theoretically up to 256 bytes, but we never use
5161 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005162 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005163
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005164 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005165 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005166#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005167 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005168#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005169 }
5170 else
5171 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005172 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005173 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005174 }
5175#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005176 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005177 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005178 case MBEDTLS_MODE_GCM:
5179 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005180 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005181 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005182 transform_expansion = transform->minlen;
5183 break;
5184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005185 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005186
5187 block_size = mbedtls_cipher_get_block_size(
5188 &transform->cipher_ctx_enc );
5189
Hanno Becker3136ede2018-08-17 15:28:19 +01005190 /* Expansion due to the addition of the MAC. */
5191 transform_expansion += transform->maclen;
5192
5193 /* Expansion due to the addition of CBC padding;
5194 * Theoretically up to 256 bytes, but we never use
5195 * more than the block size of the underlying cipher. */
5196 transform_expansion += block_size;
5197
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005198 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005199 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005200#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005201 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005202#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005203
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005204 break;
5205
5206 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005207 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005208 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005209 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005211
Hanno Beckera0e20d02019-05-15 14:03:01 +01005212#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005213 if( transform->out_cid_len != 0 )
5214 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005215#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005216
Hanno Becker5903de42019-05-03 14:46:38 +01005217 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005218}
5219
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005220#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005221/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005222 * Check record counters and renegotiate if they're above the limit.
5223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005224static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005225{
Hanno Beckerdd772292020-02-05 10:38:31 +00005226 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005227 int in_ctr_cmp;
5228 int out_ctr_cmp;
5229
Paul Elliott27b0d942022-03-18 21:55:32 +00005230 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005231 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005232 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005233 {
5234 return( 0 );
5235 }
5236
Andres AG2196c7f2016-12-15 17:01:16 +00005237 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005238 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005239 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005240 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5241 &ssl->conf->renego_period[ep_len],
5242 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005243
5244 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005245 {
5246 return( 0 );
5247 }
5248
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005249 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005250 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005251}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005252#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005253
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005254/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005255 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005256 * may only be sent for the purpose of initiating renegotiations.
5257 *
5258 * This function is introduced as a separate helper since the handling
5259 * of post-handshake handshake messages changes significantly in TLS 1.3,
5260 * and having a helper function allows to distinguish between TLS <= 1.2 and
5261 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5262 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005263static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005264{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005265 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005266
5267 /*
5268 * - For client-side, expect SERVER_HELLO_REQUEST.
5269 * - For server-side, expect CLIENT_HELLO.
5270 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5271 */
5272
5273#if defined(MBEDTLS_SSL_CLI_C)
5274 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5275 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5276 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5277 {
5278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5279
5280 /* With DTLS, drop the packet (probably from last handshake) */
5281#if defined(MBEDTLS_SSL_PROTO_DTLS)
5282 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5283 {
5284 return( 0 );
5285 }
5286#endif
5287 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5288 }
5289#endif /* MBEDTLS_SSL_CLI_C */
5290
5291#if defined(MBEDTLS_SSL_SRV_C)
5292 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5293 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5294 {
5295 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5296
5297 /* With DTLS, drop the packet (probably from last handshake) */
5298#if defined(MBEDTLS_SSL_PROTO_DTLS)
5299 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5300 {
5301 return( 0 );
5302 }
5303#endif
5304 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5305 }
5306#endif /* MBEDTLS_SSL_SRV_C */
5307
5308#if defined(MBEDTLS_SSL_RENEGOTIATION)
5309 /* Determine whether renegotiation attempt should be accepted */
5310 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5311 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5312 ssl->conf->allow_legacy_renegotiation ==
5313 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5314 {
5315 /*
5316 * Accept renegotiation request
5317 */
5318
5319 /* DTLS clients need to know renego is server-initiated */
5320#if defined(MBEDTLS_SSL_PROTO_DTLS)
5321 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5322 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5323 {
5324 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5325 }
5326#endif
5327 ret = mbedtls_ssl_start_renegotiation( ssl );
5328 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5329 ret != 0 )
5330 {
5331 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5332 ret );
5333 return( ret );
5334 }
5335 }
5336 else
5337#endif /* MBEDTLS_SSL_RENEGOTIATION */
5338 {
5339 /*
5340 * Refuse renegotiation
5341 */
5342
5343 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5344
TRodziewicz0f82ec62021-05-12 17:49:18 +02005345#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005346 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5347 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5348 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005349 {
TRodziewicz345165c2021-07-06 13:42:11 +02005350 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005351 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005353 }
5354
5355 return( 0 );
5356}
5357
Paul Bakker48916f92012-09-16 19:57:18 +00005358/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005359 * Receive application data decrypted from the SSL layer
5360 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005362{
Janos Follath865b3eb2019-12-16 11:46:15 +00005363 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005364 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005365
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005366 if( ssl == NULL || ssl->conf == NULL )
5367 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005369 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005372 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005373 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005374 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005375 return( ret );
5376
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005377 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005378 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005379 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005380 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005381 return( ret );
5382 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005383 }
5384#endif
5385
Hanno Becker4a810fb2017-05-24 16:27:30 +01005386 /*
5387 * Check if renegotiation is necessary and/or handshake is
5388 * in process. If yes, perform/continue, and fall through
5389 * if an unexpected packet is received while the client
5390 * is waiting for the ServerHello.
5391 *
5392 * (There is no equivalent to the last condition on
5393 * the server-side as it is not treated as within
5394 * a handshake while waiting for the ClientHello
5395 * after a renegotiation request.)
5396 */
5397
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005398#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005399 ret = ssl_check_ctr_renegotiate( ssl );
5400 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5401 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005404 return( ret );
5405 }
5406#endif
5407
Paul Elliott27b0d942022-03-18 21:55:32 +00005408 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005411 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5412 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005413 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005414 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005415 return( ret );
5416 }
5417 }
5418
Hanno Beckere41158b2017-10-23 13:30:32 +01005419 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005420 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005421 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005422 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005423 if( ssl->f_get_timer != NULL &&
5424 ssl->f_get_timer( ssl->p_timer ) == -1 )
5425 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005426 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005427 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005428
Hanno Becker327c93b2018-08-15 13:56:18 +01005429 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005430 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005431 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5432 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005433
Hanno Becker4a810fb2017-05-24 16:27:30 +01005434 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5435 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 }
5437
5438 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005439 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005440 {
5441 /*
5442 * OpenSSL sends empty messages to randomize the IV
5443 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005444 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005445 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005447 return( 0 );
5448
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005449 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005450 return( ret );
5451 }
5452 }
5453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005455 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005456 ret = ssl_handle_hs_message_post_handshake( ssl );
5457 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005458 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005459 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5460 ret );
5461 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005462 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005463
Hanno Beckerf26cc722021-04-21 07:30:13 +01005464 /* At this point, we don't know whether the renegotiation triggered
5465 * by the post-handshake message has been completed or not. The cases
5466 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005467 * 1) The renegotiation is complete. In this case, no new record
5468 * has been read yet.
5469 * 2) The renegotiation is incomplete because the client received
5470 * an application data record while awaiting the ServerHello.
5471 * 3) The renegotiation is incomplete because the client received
5472 * a non-handshake, non-application data message while awaiting
5473 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005474 *
5475 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005476 * - For 1), the next iteration will read a new record and check
5477 * if it's application data.
5478 * - For 2), the loop condition isn't satisfied as application data
5479 * is present, hence continue is the same as break
5480 * - For 3), the loop condition is satisfied and read_record
5481 * will re-deliver the message that was held back by the client
5482 * when expecting the ServerHello.
5483 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005484
Hanno Becker90333da2017-10-10 11:27:13 +01005485 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005486 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005487#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005489 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005490 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005491 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005492 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005493 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005495 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005497 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005498 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005499 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5503 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005504 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005505 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005506 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005507 }
5508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005509 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5512 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005513 }
5514
5515 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005516
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005517 /* We're going to return something now, cancel timer,
5518 * except if handshake (renegotiation) is in progress */
Paul Elliott27b0d942022-03-18 21:55:32 +00005519 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker0f57a652020-02-05 10:37:26 +00005520 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005521
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005522#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005523 /* If we requested renego but received AppData, resend HelloRequest.
5524 * Do it now, after setting in_offt, to avoid taking this branch
5525 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005527 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005529 {
Hanno Becker786300f2020-02-05 10:46:40 +00005530 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005531 {
Hanno Becker786300f2020-02-05 10:46:40 +00005532 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5533 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005534 return( ret );
5535 }
5536 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005537#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005538#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005539 }
5540
5541 n = ( len < ssl->in_msglen )
5542 ? len : ssl->in_msglen;
5543
5544 memcpy( buf, ssl->in_offt, n );
5545 ssl->in_msglen -= n;
5546
gabor-mezei-arma3214132020-07-15 10:55:00 +02005547 /* Zeroising the plaintext buffer to erase unused application data
5548 from the memory. */
5549 mbedtls_platform_zeroize( ssl->in_offt, n );
5550
Paul Bakker5121ce52009-01-03 21:22:43 +00005551 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005552 {
5553 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005554 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005555 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005556 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005557 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005558 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005559 /* more data available */
5560 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005561 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005564
Paul Bakker23986e52011-04-24 08:57:21 +00005565 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005566}
5567
5568/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005569 * Send application data to be encrypted by the SSL layer, taking care of max
5570 * fragment length and buffer size.
5571 *
5572 * According to RFC 5246 Section 6.2.1:
5573 *
5574 * Zero-length fragments of Application data MAY be sent as they are
5575 * potentially useful as a traffic analysis countermeasure.
5576 *
5577 * Therefore, it is possible that the input message length is 0 and the
5578 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005579 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005580static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005581 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005582{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005583 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5584 const size_t max_len = (size_t) ret;
5585
5586 if( ret < 0 )
5587 {
5588 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5589 return( ret );
5590 }
5591
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005592 if( len > max_len )
5593 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005595 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005596 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005598 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5599 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005600 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005601 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005602 }
5603 else
5604#endif
5605 len = max_len;
5606 }
Paul Bakker887bd502011-06-08 13:10:54 +00005607
Paul Bakker5121ce52009-01-03 21:22:43 +00005608 if( ssl->out_left != 0 )
5609 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005610 /*
5611 * The user has previously tried to send the data and
5612 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5613 * written. In this case, we expect the high-level write function
5614 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005616 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005617 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005618 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005619 return( ret );
5620 }
5621 }
Paul Bakker887bd502011-06-08 13:10:54 +00005622 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005623 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005624 /*
5625 * The user is trying to send a message the first time, so we need to
5626 * copy the data into the internal buffers and setup the data structure
5627 * to keep track of partial writes
5628 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005629 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005630 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005631 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005632
Hanno Becker67bc7c32018-08-06 11:33:50 +01005633 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005634 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005635 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005636 return( ret );
5637 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005638 }
5639
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005640 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005641}
5642
5643/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005644 * Write application data (public-facing wrapper)
5645 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005646int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005647{
Janos Follath865b3eb2019-12-16 11:46:15 +00005648 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005649
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005650 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005651
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005652 if( ssl == NULL || ssl->conf == NULL )
5653 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5654
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005655#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005656 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5657 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005658 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005659 return( ret );
5660 }
5661#endif
5662
Paul Elliott27b0d942022-03-18 21:55:32 +00005663 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005664 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005665 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005666 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005667 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005668 return( ret );
5669 }
5670 }
5671
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005672 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005673
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005674 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005675
5676 return( ret );
5677}
5678
5679/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005680 * Notify the peer that the connection is being closed
5681 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005683{
Janos Follath865b3eb2019-12-16 11:46:15 +00005684 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005685
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005686 if( ssl == NULL || ssl->conf == NULL )
5687 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005690
Paul Elliott27b0d942022-03-18 21:55:32 +00005691 if( mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005693 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5694 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5695 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005696 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005697 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005698 return( ret );
5699 }
5700 }
5701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005703
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005704 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005705}
5706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005707void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005708{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005709 if( transform == NULL )
5710 return;
5711
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005712#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005713 psa_destroy_key( transform->psa_key_enc );
5714 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005715#else
5716 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5717 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5718#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005719
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005720#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005721#if defined(MBEDTLS_USE_PSA_CRYPTO)
5722 psa_destroy_key( transform->psa_mac_enc );
5723 psa_destroy_key( transform->psa_mac_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005724#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005725 mbedtls_md_free( &transform->md_ctx_enc );
5726 mbedtls_md_free( &transform->md_ctx_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005727#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005728#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005729
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005730 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005731}
5732
Jerry Yuc7875b52021-09-05 21:05:50 +08005733void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5734 mbedtls_ssl_transform *transform )
5735{
Jerry Yuc7875b52021-09-05 21:05:50 +08005736 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005737 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005738}
5739
5740void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5741 mbedtls_ssl_transform *transform )
5742{
5743 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005744 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005745}
5746
Hanno Becker0271f962018-08-16 13:23:47 +01005747#if defined(MBEDTLS_SSL_PROTO_DTLS)
5748
Hanno Becker533ab5f2020-02-05 10:49:13 +00005749void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005750{
5751 unsigned offset;
5752 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5753
5754 if( hs == NULL )
5755 return;
5756
Hanno Becker283f5ef2018-08-24 09:34:47 +01005757 ssl_free_buffered_record( ssl );
5758
Hanno Becker0271f962018-08-16 13:23:47 +01005759 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005760 ssl_buffering_free_slot( ssl, offset );
5761}
5762
5763static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5764 uint8_t slot )
5765{
5766 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5767 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005768
5769 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5770 return;
5771
Hanno Beckere605b192018-08-21 15:59:07 +01005772 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005773 {
Hanno Beckere605b192018-08-21 15:59:07 +01005774 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005775 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005776 mbedtls_free( hs_buf->data );
5777 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005778 }
5779}
5780
5781#endif /* MBEDTLS_SSL_PROTO_DTLS */
5782
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005783/*
5784 * Convert version numbers to/from wire format
5785 * and, for DTLS, to/from TLS equivalent.
5786 *
5787 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005788 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005789 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005790 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005791 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005792void mbedtls_ssl_write_version( unsigned char version[2], int transport,
5793 mbedtls_ssl_protocol_version tls_version )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005794{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005795#if defined(MBEDTLS_SSL_PROTO_DTLS)
5796 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005797 tls_version =
5798 ~( tls_version - ( tls_version == 0x0302 ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005799#else
5800 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005801#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005802 MBEDTLS_PUT_UINT16_BE( tls_version, version, 0 );
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005803}
5804
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005805uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
5806 int transport )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005807{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005808 uint16_t tls_version = MBEDTLS_GET_UINT16_BE( version, 0 );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809#if defined(MBEDTLS_SSL_PROTO_DTLS)
5810 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005811 tls_version =
5812 ~( tls_version - ( tls_version == 0xfeff ? 0x0202 : 0x0201 ) );
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005813#else
5814 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005815#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005816 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005817}
5818
Jerry Yue7047812021-09-13 19:26:39 +08005819/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005820 * Send pending fatal alert.
5821 * 0, No alert message.
5822 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5823 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005824 */
5825int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5826{
5827 int ret;
5828
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005829 /* No pending alert, return success*/
5830 if( ssl->send_alert == 0 )
5831 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005832
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005833 ret = mbedtls_ssl_send_alert_message( ssl,
5834 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5835 ssl->alert_type );
5836
Jerry Yu3bf1f972021-09-22 21:37:18 +08005837 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5838 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005839 */
5840 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5841 {
5842 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005843 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005844
5845 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005846 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005847
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005848 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005849}
5850
Jerry Yu394ece62021-09-14 22:17:21 +08005851/*
5852 * Set pending fatal alert flag.
5853 */
5854void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5855 unsigned char alert_type,
5856 int alert_reason )
5857{
5858 ssl->send_alert = 1;
5859 ssl->alert_type = alert_type;
5860 ssl->alert_reason = alert_reason;
5861}
5862
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005863#endif /* MBEDTLS_SSL_TLS_C */