blob: a7370997d0365f925f8123716119957d54a348b7 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Ronald Cron6f135e12021-12-08 16:57:54 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100297
298static size_t ssl_compute_padding_length( size_t len,
299 size_t granularity )
300{
301 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
302}
303
Hanno Becker581bc1b2020-05-04 12:20:03 +0100304/* This functions transforms a (D)TLS plaintext fragment and a record content
305 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
306 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
307 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100308 *
309 * struct {
310 * opaque content[DTLSPlaintext.length];
311 * ContentType real_type;
312 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100313 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100314 *
315 * Input:
316 * - `content`: The beginning of the buffer holding the
317 * plaintext to be wrapped.
318 * - `*content_size`: The length of the plaintext in Bytes.
319 * - `max_len`: The number of Bytes available starting from
320 * `content`. This must be `>= *content_size`.
321 * - `rec_type`: The desired record content type.
322 *
323 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100324 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
325 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100326 *
327 * Returns:
328 * - `0` on success.
329 * - A negative error code if `max_len` didn't offer enough space
330 * for the expansion.
331 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100332static int ssl_build_inner_plaintext( unsigned char *content,
333 size_t *content_size,
334 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100335 uint8_t rec_type,
336 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100337{
338 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339
340 /* Write real content type */
341 if( remaining == 0 )
342 return( -1 );
343 content[ len ] = rec_type;
344 len++;
345 remaining--;
346
347 if( remaining < pad )
348 return( -1 );
349 memset( content + len, 0, pad );
350 len += pad;
351 remaining -= pad;
352
353 *content_size = len;
354 return( 0 );
355}
356
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357/* This function parses a (D)TLSInnerPlaintext structure.
358 * See ssl_build_inner_plaintext() for details. */
359static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100360 size_t *content_size,
361 uint8_t *rec_type )
362{
363 size_t remaining = *content_size;
364
365 /* Determine length of padding by skipping zeroes from the back. */
366 do
367 {
368 if( remaining == 0 )
369 return( -1 );
370 remaining--;
371 } while( content[ remaining ] == 0 );
372
373 *content_size = remaining;
374 *rec_type = content[ remaining ];
375
376 return( 0 );
377}
Ronald Cron6f135e12021-12-08 16:57:54 +0100378#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100379
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100380/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100381 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000382static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100383 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100384 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000385 unsigned minor_ver,
386 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000387{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100388 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100389 *
390 * additional_data = seq_num + TLSCompressed.type +
391 * TLSCompressed.version + TLSCompressed.length;
392 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100393 * For the CID extension, this is extended as follows
394 * (quoting draft-ietf-tls-dtls-connection-id-05,
395 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100396 *
397 * additional_data = seq_num + DTLSPlaintext.type +
398 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100399 * cid +
400 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100401 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100402 *
403 * For TLS 1.3, the record sequence number is dropped from the AAD
404 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000405 * Moreover, the additional data involves the length of the TLS
406 * ciphertext, not the TLS plaintext as in earlier versions.
407 * Quoting RFC 8446 (TLS 1.3):
408 *
409 * additional_data = TLSCiphertext.opaque_type ||
410 * TLSCiphertext.legacy_record_version ||
411 * TLSCiphertext.length
412 *
413 * We pass the tag length to this function in order to compute the
414 * ciphertext length from the inner plaintext length rec->data_len via
415 *
416 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
417 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100418 */
419
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100420 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000421 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422
Ronald Cron6f135e12021-12-08 16:57:54 +0100423#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000424 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
425 {
426 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
427 * which differs from the length of the TLSInnerPlaintext
428 * by the length of the authentication tag. */
429 ad_len_field += taglen;
430 }
431 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100432#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100433 {
434 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000435 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100436 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
437 cur += sizeof( rec->ctr );
438 }
439
440 *cur = rec->type;
441 cur++;
442
443 memcpy( cur, rec->ver, sizeof( rec->ver ) );
444 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100445
Hanno Beckera0e20d02019-05-15 14:03:01 +0100446#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100447 if( rec->cid_len != 0 )
448 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100449 memcpy( cur, rec->cid, rec->cid_len );
450 cur += rec->cid_len;
451
452 *cur = rec->cid_len;
453 cur++;
454
Joe Subbiani6dd73642021-07-19 11:56:54 +0100455 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100456 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100457 }
458 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100461 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100462 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464
465 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000466}
467
Hanno Becker67a37db2020-05-28 16:27:07 +0100468#if defined(MBEDTLS_GCM_C) || \
469 defined(MBEDTLS_CCM_C) || \
470 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100471static int ssl_transform_aead_dynamic_iv_is_explicit(
472 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100473{
Hanno Becker17263802020-05-28 07:05:48 +0100474 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475}
476
Hanno Becker17263802020-05-28 07:05:48 +0100477/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
478 *
479 * Concretely, this occurs in two variants:
480 *
481 * a) Fixed and dynamic IV lengths add up to total IV length, giving
482 * IV = fixed_iv || dynamic_iv
483 *
Hanno Becker15952812020-06-04 13:31:46 +0100484 * This variant is used in TLS 1.2 when used with GCM or CCM.
485 *
Hanno Becker17263802020-05-28 07:05:48 +0100486 * b) Fixed IV lengths matches total IV length, giving
487 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100488 *
489 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
490 *
491 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100492 *
493 * This function has the precondition that
494 *
495 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
496 *
497 * which has to be ensured by the caller. If this precondition
498 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100499 */
500static void ssl_build_record_nonce( unsigned char *dst_iv,
501 size_t dst_iv_len,
502 unsigned char const *fixed_iv,
503 size_t fixed_iv_len,
504 unsigned char const *dynamic_iv,
505 size_t dynamic_iv_len )
506{
507 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100508
509 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100510 memset( dst_iv, 0, dst_iv_len );
511 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100512
Hanno Becker17263802020-05-28 07:05:48 +0100513 dst_iv += dst_iv_len - dynamic_iv_len;
514 for( i = 0; i < dynamic_iv_len; i++ )
515 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100516}
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518
Hanno Beckera18d1322018-01-03 14:27:32 +0000519int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
520 mbedtls_ssl_transform *transform,
521 mbedtls_record *rec,
522 int (*f_rng)(void *, unsigned char *, size_t),
523 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000524{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100525#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 mbedtls_cipher_mode_t mode;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100527#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100573#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000574 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100575#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000576
577 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
578 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
580 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000581 rec->data_len,
582 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000583 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
584 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100585
Hanno Becker92313402020-05-20 13:58:58 +0100586 /* The following two code paths implement the (D)TLSInnerPlaintext
587 * structure present in TLS 1.3 and DTLS 1.2 + CID.
588 *
589 * See ssl_build_inner_plaintext() for more information.
590 *
591 * Note that this changes `rec->data_len`, and hence
592 * `post_avail` needs to be recalculated afterwards.
593 *
594 * Note also that the two code paths cannot occur simultaneously
595 * since they apply to different versions of the protocol. There
596 * is hence no risk of double-addition of the inner plaintext.
597 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100598#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +0100599 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
600 {
Hanno Becker13996922020-05-28 16:15:19 +0100601 size_t padding =
602 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200603 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100604 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100605 &rec->data_len,
606 post_avail,
607 rec->type,
608 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100609 {
610 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
611 }
612
613 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
614 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100615#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100616
Hanno Beckera0e20d02019-05-15 14:03:01 +0100617#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100618 /*
619 * Add CID information
620 */
621 rec->cid_len = transform->out_cid_len;
622 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
623 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624
625 if( rec->cid_len != 0 )
626 {
Hanno Becker13996922020-05-28 16:15:19 +0100627 size_t padding =
628 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200629 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100630 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100631 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100632 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100634 * Note that this changes `rec->data_len`, and hence
635 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100637 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100638 &rec->data_len,
639 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100640 rec->type,
641 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100642 {
643 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
644 }
645
646 rec->type = MBEDTLS_SSL_MSG_CID;
647 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100648#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100649
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100650 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
651
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100653 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000654 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000655#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100656#if defined(MBEDTLS_USE_PSA_CRYPTO)
657 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ||
658 ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING
659#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660 if( mode == MBEDTLS_MODE_STREAM ||
661 ( mode == MBEDTLS_MODE_CBC
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100662#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100665#endif
666 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000667 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000668 if( post_avail < transform->maclen )
669 {
670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
671 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
672 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200674 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker992b6872017-11-09 18:57:39 +0000676
TRodziewicz345165c2021-07-06 13:42:11 +0200677 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000678 transform->minor_ver,
679 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000680
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100681 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
682 add_data_len );
683 if( ret != 0 )
684 goto hmac_failed_etm_disabled;
685 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
686 if( ret != 0 )
687 goto hmac_failed_etm_disabled;
688 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
689 if( ret != 0 )
690 goto hmac_failed_etm_disabled;
691 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
692 if( ret != 0 )
693 goto hmac_failed_etm_disabled;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000694
TRodziewicz345165c2021-07-06 13:42:11 +0200695 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200696#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200697
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
699 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200700
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000701 rec->data_len += transform->maclen;
702 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100703 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100704
705 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100706 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100707 if( ret != 0 )
708 {
709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
710 return( ret );
711 }
Paul Bakker577e0062013-08-28 11:57:20 +0200712 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000713#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000714
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200715 /*
716 * Encrypt
717 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000718#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100719#if defined(MBEDTLS_USE_PSA_CRYPTO)
720 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
721#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100723#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000724 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000725 size_t olen;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +0100726#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiel1fe065b2022-01-13 15:56:33 +0100727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +0100728#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100729
Paul Elliottd48d5c62021-01-07 14:47:05 +0000730 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000731 "including %d bytes of padding",
732 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000733
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100734#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +0100735 /* The only stream "cipher" we support is "NULL" */
736 if ( transform->psa_alg != MBEDTLS_SSL_NULL_CIPHER )
737 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100738
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +0100739 olen = rec->data_len;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100740#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000741 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
742 transform->iv_enc, transform->ivlen,
743 data, rec->data_len,
744 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200747 return( ret );
748 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100749#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200750
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000751 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
754 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200755 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000756 }
Paul Bakker68884e32013-01-07 18:20:04 +0100757 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000758#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000759
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200760#if defined(MBEDTLS_GCM_C) || \
761 defined(MBEDTLS_CCM_C) || \
762 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100763#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +0100764 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100765#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200767 mode == MBEDTLS_MODE_CCM ||
768 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100769#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +0000770 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200771 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100772 unsigned char *dynamic_iv;
773 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100774 int dynamic_iv_is_explicit =
775 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100776#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100777 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100778#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000780
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100781 /* Check that there's space for the authentication tag. */
782 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000783 {
784 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
785 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
786 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000787
Paul Bakker68884e32013-01-07 18:20:04 +0100788 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100789 * Build nonce for AEAD encryption.
790 *
791 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
792 * part of the IV is prepended to the ciphertext and
793 * can be chosen freely - in particular, it need not
794 * agree with the record sequence number.
795 * However, since ChaChaPoly as well as all AEAD modes
796 * in TLS 1.3 use the record sequence number as the
797 * dynamic part of the nonce, we uniformly use the
798 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100799 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100800 dynamic_iv = rec->ctr;
801 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200802
Hanno Becker17263802020-05-28 07:05:48 +0100803 ssl_build_record_nonce( iv, sizeof( iv ),
804 transform->iv_enc,
805 transform->fixed_ivlen,
806 dynamic_iv,
807 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100808
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100809 /*
810 * Build additional data for AEAD encryption.
811 * This depends on the TLS version.
812 */
813 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000814 transform->minor_ver,
815 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100816
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200817 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100818 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200819 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100820 dynamic_iv,
821 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000822 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100823 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000824 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200825 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000826 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000827
Paul Bakker68884e32013-01-07 18:20:04 +0100828 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200829 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200830 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100831#if defined(MBEDTLS_USE_PSA_CRYPTO)
832 status = psa_aead_encrypt( transform->psa_key_enc,
833 transform->psa_alg,
834 iv, transform->ivlen,
835 add_data, add_data_len,
836 data, rec->data_len,
837 data, rec->buf_len - (data - rec->buf),
838 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000839
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100840 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100841 {
842 ret = psa_ssl_status_to_mbedtls( status );
843 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
844 return( ret );
845
846 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100847#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100848 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000849 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100850 add_data, add_data_len,
851 data, rec->data_len, /* src */
852 data, rec->buf_len - (data - rec->buf), /* dst */
853 &rec->data_len,
854 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200855 {
TRodziewicz18efb732021-04-29 23:12:19 +0200856 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200857 return( ret );
858 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100859#endif /* MBEDTLS_USE_PSA_CRYPTO */
860
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000861 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100862 data + rec->data_len - transform->taglen,
863 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100864 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000865 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100866
867 /*
868 * Prefix record content with dynamic IV in case it is explicit.
869 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100870 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100871 {
872 if( rec->data_offset < dynamic_iv_len )
873 {
874 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
875 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
876 }
877
878 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
879 rec->data_offset -= dynamic_iv_len;
880 rec->data_len += dynamic_iv_len;
881 }
882
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100883 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000884 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000885 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100886#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200887#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
890#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100892#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000893 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000894 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000895 size_t padlen, i;
896 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100897#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100899 size_t part_len;
900 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
901#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000902
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000903 /* Currently we're always using minimal padding
904 * (up to 255 bytes would be allowed). */
905 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
906 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000907 padlen = 0;
908
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 /* Check there's enough space in the buffer for the padding. */
910 if( post_avail < padlen + 1 )
911 {
912 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
913 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
914 }
915
Paul Bakker5121ce52009-01-03 21:22:43 +0000916 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000917 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000918
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000919 rec->data_len += padlen + 1;
920 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000921
TRodziewicz0f82ec62021-05-12 17:49:18 +0200922#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000923 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200924 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000925 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000926 */
TRodziewicz345165c2021-07-06 13:42:11 +0200927 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000928 {
TRodziewicz345165c2021-07-06 13:42:11 +0200929 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
930 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000931 }
TRodziewicz345165c2021-07-06 13:42:11 +0200932
933 if( rec->data_offset < transform->ivlen )
934 {
935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
936 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
937 }
938
939 /*
940 * Generate IV
941 */
942 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
943 if( ret != 0 )
944 return( ret );
945
946 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200947#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000948
Paul Elliottd48d5c62021-01-07 14:47:05 +0000949 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
950 "including %" MBEDTLS_PRINTF_SIZET
951 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000952 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200953 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000954
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100955#if defined(MBEDTLS_USE_PSA_CRYPTO)
956 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100957 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100958
959 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100960 {
961 ret = psa_ssl_status_to_mbedtls( status );
962 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_encrypt", ret );
963 return( ret );
964 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100965
966 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
967
968 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100969 {
970 ret = psa_ssl_status_to_mbedtls( status );
971 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_encrypt", ret );
972 return( ret );
973
974 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100975
976 status = psa_cipher_update( &cipher_op,
977 data, rec->data_len,
978 data, rec->data_len, &olen );
979
980 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100981 {
982 ret = psa_ssl_status_to_mbedtls( status );
983 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_encrypt", ret );
984 return( ret );
985
986 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100987
988 status = psa_cipher_finish( &cipher_op,
989 data + olen, rec->data_len - olen,
990 &part_len );
991
992 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100993 {
994 ret = psa_ssl_status_to_mbedtls( status );
995 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_encrypt", ret );
996 return( ret );
997
998 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100999
1000 olen += part_len;
1001#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001002 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
1003 transform->iv_enc,
1004 transform->ivlen,
1005 data, rec->data_len,
1006 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001007 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001009 return( ret );
1010 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001011#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001012
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001013 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1016 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001017 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001018
TRodziewicz0f82ec62021-05-12 17:49:18 +02001019 data -= transform->ivlen;
1020 rec->data_offset -= transform->ivlen;
1021 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001024 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001025 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001026 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1027
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001028 /*
1029 * MAC(MAC_write_key, seq_num +
1030 * TLSCipherText.type +
1031 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001032 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001033 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001034 * ENC(content + padding + padding_length));
1035 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001036
1037 if( post_avail < transform->maclen)
1038 {
1039 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1040 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1041 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001042
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001043 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001044 rec, transform->minor_ver,
1045 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001046
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001048 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001049 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001050
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001051 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1052 add_data_len );
1053 if( ret != 0 )
1054 goto hmac_failed_etm_enabled;
1055 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1056 data, rec->data_len );
1057 if( ret != 0 )
1058 goto hmac_failed_etm_enabled;
1059 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1060 if( ret != 0 )
1061 goto hmac_failed_etm_enabled;
1062 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1063 if( ret != 0 )
1064 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001065
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001066 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001067
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001068 rec->data_len += transform->maclen;
1069 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001070 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001071
1072 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001073 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001074 if( ret != 0 )
1075 {
1076 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1077 return( ret );
1078 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001079 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001081 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001082 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001083#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001084 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1086 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001087 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001088
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001089 /* Make extra sure authentication was performed, exactly once */
1090 if( auth_done != 1 )
1091 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1093 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001094 }
1095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001097
1098 return( 0 );
1099}
1100
Hanno Becker605949f2019-07-12 08:23:59 +01001101int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001102 mbedtls_ssl_transform *transform,
1103 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001104{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001105 size_t olen;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001106#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001107 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001108
1109#else
1110 mbedtls_cipher_mode_t mode;
1111 int ret;
1112#endif /* MBEDTLS_USE_PSA_CRYPTO */
1113
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001114 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001115#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001116 size_t padlen = 0, correct = 1;
1117#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001118 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001119 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001120 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001121
Hanno Beckera18d1322018-01-03 14:27:32 +00001122#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001123 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001124 ((void) ssl);
1125#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001128 if( rec == NULL ||
1129 rec->buf == NULL ||
1130 rec->buf_len < rec->data_offset ||
1131 rec->buf_len - rec->data_offset < rec->data_len )
1132 {
1133 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001135 }
1136
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001137 data = rec->buf + rec->data_offset;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001138#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001139 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001140#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001141
Hanno Beckera0e20d02019-05-15 14:03:01 +01001142#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001143 /*
1144 * Match record's CID with incoming CID.
1145 */
Hanno Becker938489a2019-05-08 13:02:22 +01001146 if( rec->cid_len != transform->in_cid_len ||
1147 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1148 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001149 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001150 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001151#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001152
Hanno Beckerd086bf02021-03-22 13:01:27 +00001153#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001154#if defined(MBEDTLS_USE_PSA_CRYPTO)
1155 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
1156#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001158#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker68884e32013-01-07 18:20:04 +01001159 {
1160 padlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001161
1162#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001163 /* The only stream "cipher" we support is "NULL" */
1164 if ( transform->psa_alg != MBEDTLS_SSL_NULL_CIPHER )
1165 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001166
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001167 olen = rec->data_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001168#else
1169
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001170 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1171 transform->iv_dec,
1172 transform->ivlen,
1173 data, rec->data_len,
1174 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001175 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001177 return( ret );
1178 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001179#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001180
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001181 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001182 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1184 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001185 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001186
Paul Bakker5121ce52009-01-03 21:22:43 +00001187 }
Paul Bakker68884e32013-01-07 18:20:04 +01001188 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001189#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001190#if defined(MBEDTLS_GCM_C) || \
1191 defined(MBEDTLS_CCM_C) || \
1192 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001193#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +01001194 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001195#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001197 mode == MBEDTLS_MODE_CCM ||
1198 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001199#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001200 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001201 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001202 unsigned char *dynamic_iv;
1203 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001204#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001206#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001207
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001208 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001209 * Extract dynamic part of nonce for AEAD decryption.
1210 *
1211 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1212 * part of the IV is prepended to the ciphertext and
1213 * can be chosen freely - in particular, it need not
1214 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001215 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001216 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001217 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001218 {
1219 if( rec->data_len < dynamic_iv_len )
1220 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001221 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1222 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001223 rec->data_len,
1224 dynamic_iv_len ) );
1225 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1226 }
1227 dynamic_iv = data;
1228
1229 data += dynamic_iv_len;
1230 rec->data_offset += dynamic_iv_len;
1231 rec->data_len -= dynamic_iv_len;
1232 }
Hanno Becker17263802020-05-28 07:05:48 +01001233 else
1234 {
1235 dynamic_iv = rec->ctr;
1236 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001237
1238 /* Check that there's space for the authentication tag. */
1239 if( rec->data_len < transform->taglen )
1240 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1242 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001243 rec->data_len,
1244 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001246 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001247 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001248
Hanno Beckerdf8be222020-05-21 15:30:57 +01001249 /*
1250 * Prepare nonce from dynamic and static parts.
1251 */
Hanno Becker17263802020-05-28 07:05:48 +01001252 ssl_build_record_nonce( iv, sizeof( iv ),
1253 transform->iv_dec,
1254 transform->fixed_ivlen,
1255 dynamic_iv,
1256 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001257
Hanno Beckerdf8be222020-05-21 15:30:57 +01001258 /*
1259 * Build additional data for AEAD encryption.
1260 * This depends on the TLS version.
1261 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001262 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001263 transform->minor_ver,
1264 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001265 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001266 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001267
Hanno Beckerd96a6522019-07-10 13:55:25 +01001268 /* Because of the check above, we know that there are
1269 * explicit_iv_len Bytes preceeding data, and taglen
1270 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001271 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001272 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001273
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001274 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001275 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001276 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001277
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001278 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001279 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001280 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001281#if defined(MBEDTLS_USE_PSA_CRYPTO)
1282 status = psa_aead_decrypt( transform->psa_key_dec,
1283 transform->psa_alg,
1284 iv, transform->ivlen,
1285 add_data, add_data_len,
1286 data, rec->data_len + transform->taglen,
1287 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001288 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001289
1290 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001291 {
1292 ret = psa_ssl_status_to_mbedtls( status );
1293 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_decrypt_buf", ret );
1294 return( ret );
1295
1296 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001297#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001298 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001299 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001300 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001301 data, rec->data_len + transform->taglen, /* src */
1302 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001303 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001304 {
TRodziewicz18efb732021-04-29 23:12:19 +02001305 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1308 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001309
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001310 return( ret );
1311 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001312#endif /* MBEDTLS_USE_PSA_CRYPTO */
1313
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001314 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001315
Hanno Beckerd96a6522019-07-10 13:55:25 +01001316 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001317 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001318 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1320 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001321 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001322 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001323 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001325#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001326#if defined(MBEDTLS_USE_PSA_CRYPTO)
1327 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
1328#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001330#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001331 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001332 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001333#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001334 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001335 size_t part_len;
1336 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1337#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001338
Paul Bakker5121ce52009-01-03 21:22:43 +00001339 /*
Paul Bakker45829992013-01-03 14:52:21 +01001340 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001341 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001342#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001343 /* The ciphertext is prefixed with the CBC IV. */
1344 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001345#endif
Paul Bakker45829992013-01-03 14:52:21 +01001346
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001347 /* Size considerations:
1348 *
1349 * - The CBC cipher text must not be empty and hence
1350 * at least of size transform->ivlen.
1351 *
1352 * Together with the potential IV-prefix, this explains
1353 * the first of the two checks below.
1354 *
1355 * - The record must contain a MAC, either in plain or
1356 * encrypted, depending on whether Encrypt-then-MAC
1357 * is used or not.
1358 * - If it is, the message contains the IV-prefix,
1359 * the CBC ciphertext, and the MAC.
1360 * - If it is not, the padded plaintext, and hence
1361 * the CBC ciphertext, has at least length maclen + 1
1362 * because there is at least the padding length byte.
1363 *
1364 * As the CBC ciphertext is not empty, both cases give the
1365 * lower bound minlen + maclen + 1 on the record size, which
1366 * we test for in the second check below.
1367 */
1368 if( rec->data_len < minlen + transform->ivlen ||
1369 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001370 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001371 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1372 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1373 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001374 "+ 1 ) ( + expl IV )", rec->data_len,
1375 transform->ivlen,
1376 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001378 }
1379
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001380 /*
1381 * Authenticate before decrypt if enabled
1382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001384 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001385 {
Hanno Becker992b6872017-11-09 18:57:39 +00001386 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001387
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001389
Hanno Beckerd96a6522019-07-10 13:55:25 +01001390 /* Update data_len in tandem with add_data.
1391 *
1392 * The subtraction is safe because of the previous check
1393 * data_len >= minlen + maclen + 1.
1394 *
1395 * Afterwards, we know that data + data_len is followed by at
1396 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001397 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001398 *
1399 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001400 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001401 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001402 transform->minor_ver,
1403 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001404
Hanno Beckerd96a6522019-07-10 13:55:25 +01001405 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001406 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1407 add_data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001408 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1409 add_data_len );
1410 if( ret != 0 )
1411 goto hmac_failed_etm_enabled;
1412 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001413 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001414 if( ret != 0 )
1415 goto hmac_failed_etm_enabled;
1416 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1417 if( ret != 0 )
1418 goto hmac_failed_etm_enabled;
1419 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1420 if( ret != 0 )
1421 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001422
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001423 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1424 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001425 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001427
Hanno Beckerd96a6522019-07-10 13:55:25 +01001428 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001429 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001430 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001433 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1434 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001435 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001436 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001437
1438 hmac_failed_etm_enabled:
1439 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1440 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001441 {
1442 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1443 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001444 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001445 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001446 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001448
1449 /*
1450 * Check length sanity
1451 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001452
1453 /* We know from above that data_len > minlen >= 0,
1454 * so the following check in particular implies that
1455 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001456 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001457 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001458 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1459 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001460 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001462 }
1463
TRodziewicz0f82ec62021-05-12 17:49:18 +02001464#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001465 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001466 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001467 */
TRodziewicz345165c2021-07-06 13:42:11 +02001468 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1469 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001470
TRodziewicz345165c2021-07-06 13:42:11 +02001471 data += transform->ivlen;
1472 rec->data_offset += transform->ivlen;
1473 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001475
Hanno Beckerd96a6522019-07-10 13:55:25 +01001476 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1477
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001478#if defined(MBEDTLS_USE_PSA_CRYPTO)
1479 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001480 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001481
1482 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001483 {
1484 ret = psa_ssl_status_to_mbedtls( status );
1485 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_decrypt_buf", ret );
1486 return( ret );
1487
1488 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001489
1490 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1491
1492 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001493 {
1494 ret = psa_ssl_status_to_mbedtls( status );
1495 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_decrypt_buf", ret );
1496 return( ret );
1497
1498 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001499
1500 status = psa_cipher_update( &cipher_op,
1501 data, rec->data_len,
1502 data, rec->data_len, &olen );
1503
1504 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001505 {
1506 ret = psa_ssl_status_to_mbedtls( status );
1507 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_decrypt_buf", ret );
1508 return( ret );
1509
1510 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001511
1512 status = psa_cipher_finish( &cipher_op,
1513 data + olen, rec->data_len - olen,
1514 &part_len );
1515
1516 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001517 {
1518 ret = psa_ssl_status_to_mbedtls( status );
1519 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_decrypt_buf", ret );
1520 return( ret );
1521
1522 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001523
1524 olen += part_len;
1525#else
1526
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1528 transform->iv_dec, transform->ivlen,
1529 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001532 return( ret );
1533 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001534#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001535
Hanno Beckerd96a6522019-07-10 13:55:25 +01001536 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001538 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1540 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001541 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001542
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001543 /* Safe since data_len >= minlen + maclen + 1, so after having
1544 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001545 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1546 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001547 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001548
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001549 if( auth_done == 1 )
1550 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001551 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001552 rec->data_len,
1553 padlen + 1 );
1554 correct &= mask;
1555 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001556 }
1557 else
Paul Bakker45829992013-01-03 14:52:21 +01001558 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001560 if( rec->data_len < transform->maclen + padlen + 1 )
1561 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1563 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1564 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001565 rec->data_len,
1566 transform->maclen,
1567 padlen + 1 ) );
1568 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001569#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001570
Gabor Mezei90437e32021-10-20 11:59:27 +02001571 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001572 rec->data_len,
1573 transform->maclen + padlen + 1 );
1574 correct &= mask;
1575 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001576 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001577
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001578 padlen++;
1579
1580 /* Regardless of the validity of the padding,
1581 * we have data_len >= padlen here. */
1582
TRodziewicz0f82ec62021-05-12 17:49:18 +02001583#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001584 /* The padding check involves a series of up to 256
1585 * consecutive memory reads at the end of the record
1586 * plaintext buffer. In order to hide the length and
1587 * validity of the padding, always perform exactly
1588 * `min(256,plaintext_len)` reads (but take into account
1589 * only the last `padlen` bytes for the padding check). */
1590 size_t pad_count = 0;
1591 volatile unsigned char* const check = data;
1592
1593 /* Index of first padding byte; it has been ensured above
1594 * that the subtraction is safe. */
1595 size_t const padding_idx = rec->data_len - padlen;
1596 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1597 size_t const start_idx = rec->data_len - num_checks;
1598 size_t idx;
1599
1600 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001601 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001602 /* pad_count += (idx >= padding_idx) &&
1603 * (check[idx] == padlen - 1);
1604 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001605 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1606 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001607 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001608 pad_count += mask & equal;
1609 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001610 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001612#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001613 if( padlen > 0 && correct == 0 )
1614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001615#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001616 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001617
TRodziewicz0f82ec62021-05-12 17:49:18 +02001618#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001619
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001620 /* If the padding was found to be invalid, padlen == 0
1621 * and the subtraction is safe. If the padding was found valid,
1622 * padlen hasn't been changed and the previous assertion
1623 * data_len >= padlen still holds. */
1624 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001625 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001626 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001627#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001628 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1630 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001631 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001632
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001633#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001635 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001636#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001637
1638 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001639 * Authenticate if not done yet.
1640 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001641 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001642#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001643 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001644 {
Hanno Becker992b6872017-11-09 18:57:39 +00001645 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001646 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001647
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001648 /* If the initial value of padlen was such that
1649 * data_len < maclen + padlen + 1, then padlen
1650 * got reset to 1, and the initial check
1651 * data_len >= minlen + maclen + 1
1652 * guarantees that at this point we still
1653 * have at least data_len >= maclen.
1654 *
1655 * If the initial value of padlen was such that
1656 * data_len >= maclen + padlen + 1, then we have
1657 * subtracted either padlen + 1 (if the padding was correct)
1658 * or 0 (if the padding was incorrect) since then,
1659 * hence data_len >= maclen in any case.
1660 */
1661 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001662 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001663 transform->minor_ver,
1664 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001665
TRodziewicz0f82ec62021-05-12 17:49:18 +02001666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001667 /*
1668 * The next two sizes are the minimum and maximum values of
1669 * data_len over all padlen values.
1670 *
1671 * They're independent of padlen, since we previously did
1672 * data_len -= padlen.
1673 *
1674 * Note that max_len + maclen is never more than the buffer
1675 * length, as we previously did in_msglen -= maclen too.
1676 */
1677 const size_t max_len = rec->data_len + padlen;
1678 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1679
Gabor Mezei90437e32021-10-20 11:59:27 +02001680 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001681 add_data, add_data_len,
1682 data, rec->data_len, min_len, max_len,
1683 mac_expect );
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)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001733 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1734 {
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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
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
Hanno Becker04da1892018-08-14 13:22:10 +01002216 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2217 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 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002338 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2339 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 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002403
2404/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002405 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002406 *
2407 * - fill in handshake headers
2408 * - update handshake checksum
2409 * - DTLS: save message for resending
2410 * - then pass to the record layer
2411 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002412 * DTLS: except for HelloRequest, messages are only queued, and will only be
2413 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002414 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002415 * Inputs:
2416 * - ssl->out_msglen: 4 + actual handshake message len
2417 * (4 is the size of handshake headers for TLS)
2418 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2419 * - ssl->out_msg + 4: the handshake message body
2420 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002421 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002422 * - ssl->out_msglen: the length of the record contents
2423 * (including handshake headers but excluding record headers)
2424 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002426int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2427 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002428{
Janos Follath865b3eb2019-12-16 11:46:15 +00002429 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002430 const size_t hs_len = ssl->out_msglen - 4;
2431 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002432
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002433 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2434
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002435 /*
2436 * Sanity checks
2437 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002438 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002439 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2440 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2442 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002443 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002444
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002445 /* Whenever we send anything different from a
2446 * HelloRequest we should be in a handshake - double check. */
2447 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2448 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002449 ssl->handshake == NULL )
2450 {
2451 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2452 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2453 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002456 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002457 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002459 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2461 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002462 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002463#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002464
Hanno Beckerb50a2532018-08-06 11:52:54 +01002465 /* Double-check that we did not exceed the bounds
2466 * of the outgoing record buffer.
2467 * This should never fail as the various message
2468 * writing functions must obey the bounds of the
2469 * outgoing record buffer, but better be safe.
2470 *
2471 * Note: We deliberately do not check for the MTU or MFL here.
2472 */
2473 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2474 {
2475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002476 "size %" MBEDTLS_PRINTF_SIZET
2477 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002478 ssl->out_msglen,
2479 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002480 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2481 }
2482
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002483 /*
2484 * Fill handshake headers
2485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002487 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002488 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2489 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2490 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002491
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002492 /*
2493 * DTLS has additional fields in the Handshake layer,
2494 * between the length field and the actual payload:
2495 * uint16 message_seq;
2496 * uint24 fragment_offset;
2497 * uint24 fragment_length;
2498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002500 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002501 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002502 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002503 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002504 {
2505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002506 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002507 hs_len,
2508 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002509 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2510 }
2511
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002512 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002513 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002514
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002515 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002516 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002517 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002518 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002519 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002520 }
2521 else
2522 {
2523 ssl->out_msg[4] = 0;
2524 ssl->out_msg[5] = 0;
2525 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002526
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002527 /* Handshake hashes are computed without fragmentation,
2528 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002529 memset( ssl->out_msg + 6, 0x00, 3 );
2530 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002531 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002533
Hanno Becker0207e532018-08-28 10:28:28 +01002534 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002535 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002536 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002537 }
2538
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002539 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002541 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002542 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2543 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002544 {
2545 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2546 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002547 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002548 return( ret );
2549 }
2550 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002551 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002552#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002553 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002554 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002555 {
2556 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2557 return( ret );
2558 }
2559 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002560
2561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2562
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002563 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002564}
2565
2566/*
2567 * Record layer functions
2568 */
2569
2570/*
2571 * Write current record.
2572 *
2573 * Uses:
2574 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2575 * - ssl->out_msglen: length of the record content (excl headers)
2576 * - ssl->out_msg: record content
2577 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002578int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002579{
2580 int ret, done = 0;
2581 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002582 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002583
2584 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002585
Paul Bakker05ef8352012-05-08 09:17:57 +00002586 if( !done )
2587 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002588 unsigned i;
2589 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002590#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2591 size_t out_buf_len = ssl->out_buf_len;
2592#else
2593 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2594#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002595 /* Skip writing the record content type to after the encryption,
2596 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002597 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002598#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002599 /* TLS 1.3 still uses the TLS 1.2 version identifier
2600 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002601 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2602 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002603#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002604 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2605 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002606
Jerry Yuae0b2e22021-10-08 15:21:19 +08002607 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002608 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002609
Paul Bakker48916f92012-09-16 19:57:18 +00002610 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002611 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002612 mbedtls_record rec;
2613
2614 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002615 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002616 rec.data_len = ssl->out_msglen;
2617 rec.data_offset = ssl->out_msg - rec.buf;
2618
Jerry Yud96a5c22021-09-29 17:46:51 +08002619 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002620 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002621 ssl->conf->transport, rec.ver );
2622 rec.type = ssl->out_msgtype;
2623
Hanno Beckera0e20d02019-05-15 14:03:01 +01002624#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002625 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002626 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002627#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002628
Hanno Beckera18d1322018-01-03 14:27:32 +00002629 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002630 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002631 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002633 return( ret );
2634 }
2635
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002636 if( rec.data_offset != 0 )
2637 {
2638 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2639 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2640 }
2641
Hanno Becker6430faf2019-05-08 11:57:13 +01002642 /* Update the record content type and CID. */
2643 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002644#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002645 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002647 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002648 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002649 }
2650
Hanno Becker5903de42019-05-03 14:46:38 +01002651 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002652
2653#if defined(MBEDTLS_SSL_PROTO_DTLS)
2654 /* In case of DTLS, double-check that we don't exceed
2655 * the remaining space in the datagram. */
2656 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2657 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002658 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002659 if( ret < 0 )
2660 return( ret );
2661
2662 if( protected_record_size > (size_t) ret )
2663 {
2664 /* Should never happen */
2665 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2666 }
2667 }
2668#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002669
Hanno Becker6430faf2019-05-08 11:57:13 +01002670 /* Now write the potentially updated record content type. */
2671 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2672
Paul Elliott9f352112020-12-09 14:55:45 +00002673 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002674 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002675 ssl->out_hdr[0], ssl->out_hdr[1],
2676 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002679 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002680
2681 ssl->out_left += protected_record_size;
2682 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002683 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002684
Hanno Beckerdd772292020-02-05 10:38:31 +00002685 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002686 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2687 break;
2688
2689 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002690 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002691 {
2692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2693 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2694 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002695 }
2696
Hanno Becker67bc7c32018-08-06 11:33:50 +01002697#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002698 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2699 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002700 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002701 size_t remaining;
2702 ret = ssl_get_remaining_payload_in_datagram( ssl );
2703 if( ret < 0 )
2704 {
2705 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2706 ret );
2707 return( ret );
2708 }
2709
2710 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002711 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002712 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002713 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002714 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002715 else
2716 {
Hanno Becker513815a2018-08-20 11:56:09 +01002717 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002718 }
2719 }
2720#endif /* MBEDTLS_SSL_PROTO_DTLS */
2721
2722 if( ( flush == SSL_FORCE_FLUSH ) &&
2723 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002724 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002726 return( ret );
2727 }
2728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002730
2731 return( 0 );
2732}
2733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002735
2736static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2737{
2738 if( ssl->in_msglen < ssl->in_hslen ||
2739 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2740 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2741 {
2742 return( 1 );
2743 }
2744 return( 0 );
2745}
Hanno Becker44650b72018-08-16 12:51:11 +01002746
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002747static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002748{
2749 return( ( ssl->in_msg[9] << 16 ) |
2750 ( ssl->in_msg[10] << 8 ) |
2751 ssl->in_msg[11] );
2752}
2753
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002754static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002755{
2756 return( ( ssl->in_msg[6] << 16 ) |
2757 ( ssl->in_msg[7] << 8 ) |
2758 ssl->in_msg[8] );
2759}
2760
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002761static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002762{
2763 uint32_t msg_len, frag_off, frag_len;
2764
2765 msg_len = ssl_get_hs_total_len( ssl );
2766 frag_off = ssl_get_hs_frag_off( ssl );
2767 frag_len = ssl_get_hs_frag_len( ssl );
2768
2769 if( frag_off > msg_len )
2770 return( -1 );
2771
2772 if( frag_len > msg_len - frag_off )
2773 return( -1 );
2774
2775 if( frag_len + 12 > ssl->in_msglen )
2776 return( -1 );
2777
2778 return( 0 );
2779}
2780
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002781/*
2782 * Mark bits in bitmask (used for DTLS HS reassembly)
2783 */
2784static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2785{
2786 unsigned int start_bits, end_bits;
2787
2788 start_bits = 8 - ( offset % 8 );
2789 if( start_bits != 8 )
2790 {
2791 size_t first_byte_idx = offset / 8;
2792
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002793 /* Special case */
2794 if( len <= start_bits )
2795 {
2796 for( ; len != 0; len-- )
2797 mask[first_byte_idx] |= 1 << ( start_bits - len );
2798
2799 /* Avoid potential issues with offset or len becoming invalid */
2800 return;
2801 }
2802
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002803 offset += start_bits; /* Now offset % 8 == 0 */
2804 len -= start_bits;
2805
2806 for( ; start_bits != 0; start_bits-- )
2807 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2808 }
2809
2810 end_bits = len % 8;
2811 if( end_bits != 0 )
2812 {
2813 size_t last_byte_idx = ( offset + len ) / 8;
2814
2815 len -= end_bits; /* Now len % 8 == 0 */
2816
2817 for( ; end_bits != 0; end_bits-- )
2818 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2819 }
2820
2821 memset( mask + offset / 8, 0xFF, len / 8 );
2822}
2823
2824/*
2825 * Check that bitmask is full
2826 */
2827static int ssl_bitmask_check( unsigned char *mask, size_t len )
2828{
2829 size_t i;
2830
2831 for( i = 0; i < len / 8; i++ )
2832 if( mask[i] != 0xFF )
2833 return( -1 );
2834
2835 for( i = 0; i < len % 8; i++ )
2836 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2837 return( -1 );
2838
2839 return( 0 );
2840}
2841
Hanno Becker56e205e2018-08-16 09:06:12 +01002842/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002843static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002844 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002845{
Hanno Becker56e205e2018-08-16 09:06:12 +01002846 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002847
Hanno Becker56e205e2018-08-16 09:06:12 +01002848 alloc_len = 12; /* Handshake header */
2849 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002850
Hanno Beckerd07df862018-08-16 09:14:58 +01002851 if( add_bitmap )
2852 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002853
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002854 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002855}
Hanno Becker56e205e2018-08-16 09:06:12 +01002856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002858
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002859static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002860{
2861 return( ( ssl->in_msg[1] << 16 ) |
2862 ( ssl->in_msg[2] << 8 ) |
2863 ssl->in_msg[3] );
2864}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002865
Simon Butcher99000142016-10-13 17:21:01 +01002866int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002867{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002869 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002870 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002871 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002873 }
2874
Hanno Becker12555c62018-08-16 12:47:53 +01002875 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002878 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002879 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002882 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002883 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002884 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002885 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002886
Hanno Becker44650b72018-08-16 12:51:11 +01002887 if( ssl_check_hs_header( ssl ) != 0 )
2888 {
2889 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2890 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2891 }
2892
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002893 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002894 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2895 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2896 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2897 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002898 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002899 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2900 {
2901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2902 recv_msg_seq,
2903 ssl->handshake->in_msg_seq ) );
2904 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2905 }
2906
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002907 /* Retransmit only on last message from previous flight, to avoid
2908 * too many retransmissions.
2909 * Besides, No sane server ever retransmits HelloVerifyRequest */
2910 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002912 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002914 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002915 recv_msg_seq,
2916 ssl->handshake->in_flight_start_seq ) );
2917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002919 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002921 return( ret );
2922 }
2923 }
2924 else
2925 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002927 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002928 recv_msg_seq,
2929 ssl->handshake->in_msg_seq ) );
2930 }
2931
Hanno Becker90333da2017-10-10 11:27:13 +01002932 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002933 }
2934 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002935
Hanno Becker6d97ef52018-08-16 13:09:04 +01002936 /* Message reassembly is handled alongside buffering of future
2937 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002938 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002939 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002940 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002941 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002943 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002944 }
2945 }
2946 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002948 /* With TLS we don't handle fragmentation (for now) */
2949 if( ssl->in_msglen < ssl->in_hslen )
2950 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2952 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002953 }
2954
Simon Butcher99000142016-10-13 17:21:01 +01002955 return( 0 );
2956}
2957
2958void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2959{
Hanno Becker0271f962018-08-16 13:23:47 +01002960 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002961
Hanno Becker0271f962018-08-16 13:23:47 +01002962 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002963 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002964 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002965 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002966
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002967 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002969 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002970 ssl->handshake != NULL )
2971 {
Hanno Becker0271f962018-08-16 13:23:47 +01002972 unsigned offset;
2973 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002974
Hanno Becker0271f962018-08-16 13:23:47 +01002975 /* Increment handshake sequence number */
2976 hs->in_msg_seq++;
2977
2978 /*
2979 * Clear up handshake buffering and reassembly structure.
2980 */
2981
2982 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002983 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002984
2985 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002986 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2987 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002988 offset++, hs_buf++ )
2989 {
2990 *hs_buf = *(hs_buf + 1);
2991 }
2992
2993 /* Create a fresh last entry */
2994 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002995 }
2996#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002997}
2998
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002999/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003000 * DTLS anti-replay: RFC 6347 4.1.2.6
3001 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003002 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3003 * Bit n is set iff record number in_window_top - n has been seen.
3004 *
3005 * Usually, in_window_top is the last record number seen and the lsb of
3006 * in_window is set. The only exception is the initial state (record number 0
3007 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003010void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003011{
3012 ssl->in_window_top = 0;
3013 ssl->in_window = 0;
3014}
3015
3016static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3017{
3018 return( ( (uint64_t) buf[0] << 40 ) |
3019 ( (uint64_t) buf[1] << 32 ) |
3020 ( (uint64_t) buf[2] << 24 ) |
3021 ( (uint64_t) buf[3] << 16 ) |
3022 ( (uint64_t) buf[4] << 8 ) |
3023 ( (uint64_t) buf[5] ) );
3024}
3025
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003026static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3027{
Janos Follath865b3eb2019-12-16 11:46:15 +00003028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003029 unsigned char *original_in_ctr;
3030
3031 // save original in_ctr
3032 original_in_ctr = ssl->in_ctr;
3033
3034 // use counter from record
3035 ssl->in_ctr = record_in_ctr;
3036
3037 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3038
3039 // restore the counter
3040 ssl->in_ctr = original_in_ctr;
3041
3042 return ret;
3043}
3044
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003045/*
3046 * Return 0 if sequence number is acceptable, -1 otherwise
3047 */
Hanno Becker0183d692019-07-12 08:50:37 +01003048int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003049{
3050 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3051 uint64_t bit;
3052
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003053 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003054 return( 0 );
3055
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003056 if( rec_seqnum > ssl->in_window_top )
3057 return( 0 );
3058
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003059 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003060
3061 if( bit >= 64 )
3062 return( -1 );
3063
3064 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3065 return( -1 );
3066
3067 return( 0 );
3068}
3069
3070/*
3071 * Update replay window on new validated record
3072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003074{
3075 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3076
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003077 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003078 return;
3079
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003080 if( rec_seqnum > ssl->in_window_top )
3081 {
3082 /* Update window_top and the contents of the window */
3083 uint64_t shift = rec_seqnum - ssl->in_window_top;
3084
3085 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003086 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003087 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003088 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003089 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003090 ssl->in_window |= 1;
3091 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003092
3093 ssl->in_window_top = rec_seqnum;
3094 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003095 else
3096 {
3097 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003098 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003099
3100 if( bit < 64 ) /* Always true, but be extra sure */
3101 ssl->in_window |= (uint64_t) 1 << bit;
3102 }
3103}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003105
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003106#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003107/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003108 * Without any SSL context, check if a datagram looks like a ClientHello with
3109 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003110 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003111 *
3112 * - if cookie is valid, return 0
3113 * - if ClientHello looks superficially valid but cookie is not,
3114 * fill obuf and set olen, then
3115 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3116 * - otherwise return a specific error code
3117 */
3118static int ssl_check_dtls_clihlo_cookie(
3119 mbedtls_ssl_cookie_write_t *f_cookie_write,
3120 mbedtls_ssl_cookie_check_t *f_cookie_check,
3121 void *p_cookie,
3122 const unsigned char *cli_id, size_t cli_id_len,
3123 const unsigned char *in, size_t in_len,
3124 unsigned char *obuf, size_t buf_len, size_t *olen )
3125{
3126 size_t sid_len, cookie_len;
3127 unsigned char *p;
3128
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003129 /*
3130 * Structure of ClientHello with record and handshake headers,
3131 * and expected values. We don't need to check a lot, more checks will be
3132 * done when actually parsing the ClientHello - skipping those checks
3133 * avoids code duplication and does not make cookie forging any easier.
3134 *
3135 * 0-0 ContentType type; copied, must be handshake
3136 * 1-2 ProtocolVersion version; copied
3137 * 3-4 uint16 epoch; copied, must be 0
3138 * 5-10 uint48 sequence_number; copied
3139 * 11-12 uint16 length; (ignored)
3140 *
3141 * 13-13 HandshakeType msg_type; (ignored)
3142 * 14-16 uint24 length; (ignored)
3143 * 17-18 uint16 message_seq; copied
3144 * 19-21 uint24 fragment_offset; copied, must be 0
3145 * 22-24 uint24 fragment_length; (ignored)
3146 *
3147 * 25-26 ProtocolVersion client_version; (ignored)
3148 * 27-58 Random random; (ignored)
3149 * 59-xx SessionID session_id; 1 byte len + sid_len content
3150 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3151 * ...
3152 *
3153 * Minimum length is 61 bytes.
3154 */
3155 if( in_len < 61 ||
3156 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3157 in[3] != 0 || in[4] != 0 ||
3158 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3159 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003160 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003161 }
3162
3163 sid_len = in[59];
3164 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003165 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003166
3167 cookie_len = in[60 + sid_len];
3168 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003169 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003170
3171 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3172 cli_id, cli_id_len ) == 0 )
3173 {
3174 /* Valid cookie */
3175 return( 0 );
3176 }
3177
3178 /*
3179 * If we get here, we've got an invalid cookie, let's prepare HVR.
3180 *
3181 * 0-0 ContentType type; copied
3182 * 1-2 ProtocolVersion version; copied
3183 * 3-4 uint16 epoch; copied
3184 * 5-10 uint48 sequence_number; copied
3185 * 11-12 uint16 length; olen - 13
3186 *
3187 * 13-13 HandshakeType msg_type; hello_verify_request
3188 * 14-16 uint24 length; olen - 25
3189 * 17-18 uint16 message_seq; copied
3190 * 19-21 uint24 fragment_offset; copied
3191 * 22-24 uint24 fragment_length; olen - 25
3192 *
3193 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3194 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3195 *
3196 * Minimum length is 28.
3197 */
3198 if( buf_len < 28 )
3199 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3200
3201 /* Copy most fields and adapt others */
3202 memcpy( obuf, in, 25 );
3203 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3204 obuf[25] = 0xfe;
3205 obuf[26] = 0xff;
3206
3207 /* Generate and write actual cookie */
3208 p = obuf + 28;
3209 if( f_cookie_write( p_cookie,
3210 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3211 {
3212 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3213 }
3214
3215 *olen = p - obuf;
3216
3217 /* Go back and fill length fields */
3218 obuf[27] = (unsigned char)( *olen - 28 );
3219
Joe Subbianifbeb6922021-07-16 14:27:50 +01003220 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3221 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3222 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003223
Joe Subbiani6dd73642021-07-19 11:56:54 +01003224 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003225
3226 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3227}
3228
3229/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003230 * Handle possible client reconnect with the same UDP quadruplet
3231 * (RFC 6347 Section 4.2.8).
3232 *
3233 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3234 * that looks like a ClientHello.
3235 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003236 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003237 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003238 * - if the input looks like a ClientHello with a valid cookie,
3239 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003240 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003241 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003242 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003243 * This function is called (through ssl_check_client_reconnect()) when an
3244 * unexpected record is found in ssl_get_next_record(), which will discard the
3245 * record if we return 0, and bubble up the return value otherwise (this
3246 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3247 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003248 */
3249static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3250{
Janos Follath865b3eb2019-12-16 11:46:15 +00003251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003252 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003253
Hanno Becker2fddd372019-07-10 14:37:41 +01003254 if( ssl->conf->f_cookie_write == NULL ||
3255 ssl->conf->f_cookie_check == NULL )
3256 {
3257 /* If we can't use cookies to verify reachability of the peer,
3258 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3260 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003261 return( 0 );
3262 }
3263
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003264 ret = ssl_check_dtls_clihlo_cookie(
3265 ssl->conf->f_cookie_write,
3266 ssl->conf->f_cookie_check,
3267 ssl->conf->p_cookie,
3268 ssl->cli_id, ssl->cli_id_len,
3269 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003270 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003271
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003272 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3273
3274 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003275 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003276 int send_ret;
3277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3278 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3279 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003280 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003281 * If the error is permanent we'll catch it later,
3282 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003283 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3284 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3285 (void) send_ret;
3286
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003287 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003288 }
3289
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003290 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003291 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003293 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003294 {
3295 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3296 return( ret );
3297 }
3298
3299 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003300 }
3301
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003302 return( ret );
3303}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003304#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003305
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003306static int ssl_check_record_type( uint8_t record_type )
3307{
3308 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3309 record_type != MBEDTLS_SSL_MSG_ALERT &&
3310 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3311 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3312 {
3313 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3314 }
3315
3316 return( 0 );
3317}
3318
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003319/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003320 * ContentType type;
3321 * ProtocolVersion version;
3322 * uint16 epoch; // DTLS only
3323 * uint48 sequence_number; // DTLS only
3324 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003325 *
3326 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003327 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003328 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3329 *
3330 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003331 * 1. proceed with the record if this function returns 0
3332 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3333 * 3. return CLIENT_RECONNECT if this function return that value
3334 * 4. drop the whole datagram if this function returns anything else.
3335 * Point 2 is needed when the peer is resending, and we have already received
3336 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003337 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003338static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003339 unsigned char *buf,
3340 size_t len,
3341 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003342{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003343 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003344
Hanno Beckere5e7e782019-07-11 12:29:35 +01003345 size_t const rec_hdr_type_offset = 0;
3346 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003347
Hanno Beckere5e7e782019-07-11 12:29:35 +01003348 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3349 rec_hdr_type_len;
3350 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003351
Hanno Beckere5e7e782019-07-11 12:29:35 +01003352 size_t const rec_hdr_ctr_len = 8;
3353#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003354 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003355 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3356 rec_hdr_version_len;
3357
Hanno Beckera0e20d02019-05-15 14:03:01 +01003358#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003359 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3360 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003361 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003362#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3363#endif /* MBEDTLS_SSL_PROTO_DTLS */
3364
3365 size_t rec_hdr_len_offset; /* To be determined */
3366 size_t const rec_hdr_len_len = 2;
3367
3368 /*
3369 * Check minimum lengths for record header.
3370 */
3371
3372#if defined(MBEDTLS_SSL_PROTO_DTLS)
3373 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3374 {
3375 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3376 }
3377 else
3378#endif /* MBEDTLS_SSL_PROTO_DTLS */
3379 {
3380 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3381 }
3382
3383 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3384 {
3385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3386 (unsigned) len,
3387 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3388 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3389 }
3390
3391 /*
3392 * Parse and validate record content type
3393 */
3394
3395 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003396
3397 /* Check record content type */
3398#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3399 rec->cid_len = 0;
3400
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003401 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003402 ssl->conf->cid_len != 0 &&
3403 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003404 {
3405 /* Shift pointers to account for record header including CID
3406 * struct {
3407 * ContentType special_type = tls12_cid;
3408 * ProtocolVersion version;
3409 * uint16 epoch;
3410 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003411 * opaque cid[cid_length]; // Additional field compared to
3412 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003413 * uint16 length;
3414 * opaque enc_content[DTLSCiphertext.length];
3415 * } DTLSCiphertext;
3416 */
3417
3418 /* So far, we only support static CID lengths
3419 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003420 rec_hdr_cid_len = ssl->conf->cid_len;
3421 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003422
Hanno Beckere5e7e782019-07-11 12:29:35 +01003423 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003424 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3426 (unsigned) len,
3427 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003428 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003429 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003430
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003431 /* configured CID len is guaranteed at most 255, see
3432 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3433 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003434 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003435 }
3436 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003437#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003438 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003439 if( ssl_check_record_type( rec->type ) )
3440 {
Hanno Becker54229812019-07-12 14:40:00 +01003441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3442 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003443 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3444 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003445 }
3446
Hanno Beckere5e7e782019-07-11 12:29:35 +01003447 /*
3448 * Parse and validate record version
3449 */
3450
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003451 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3452 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003453 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3454 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003455 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003456
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003457 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003458 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3460 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003461 }
3462
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003463 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003464 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3466 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003467 }
3468
Hanno Beckere5e7e782019-07-11 12:29:35 +01003469 /*
3470 * Parse/Copy record sequence number.
3471 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003472
Hanno Beckere5e7e782019-07-11 12:29:35 +01003473#if defined(MBEDTLS_SSL_PROTO_DTLS)
3474 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003475 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003476 /* Copy explicit record sequence number from input buffer. */
3477 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3478 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003479 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003480 else
3481#endif /* MBEDTLS_SSL_PROTO_DTLS */
3482 {
3483 /* Copy implicit record sequence number from SSL context structure. */
3484 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3485 }
Paul Bakker40e46942009-01-03 21:51:57 +00003486
Hanno Beckere5e7e782019-07-11 12:29:35 +01003487 /*
3488 * Parse record length.
3489 */
3490
Hanno Beckere5e7e782019-07-11 12:29:35 +01003491 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003492 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3493 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003494 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003495
Paul Elliott9f352112020-12-09 14:55:45 +00003496 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003497 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003498 rec->type,
3499 major_ver, minor_ver, rec->data_len ) );
3500
3501 rec->buf = buf;
3502 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003503
Hanno Beckerd417cc92019-07-26 08:20:27 +01003504 if( rec->data_len == 0 )
3505 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003506
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003507 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003508 * DTLS-related tests.
3509 * Check epoch before checking length constraint because
3510 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3511 * message gets duplicated before the corresponding Finished message,
3512 * the second ChangeCipherSpec should be discarded because it belongs
3513 * to an old epoch, but not because its length is shorter than
3514 * the minimum record length for packets using the new record transform.
3515 * Note that these two kinds of failures are handled differently,
3516 * as an unexpected record is silently skipped but an invalid
3517 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003518 */
3519#if defined(MBEDTLS_SSL_PROTO_DTLS)
3520 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3521 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003522 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003523
Hanno Becker955a5c92019-07-10 17:12:07 +01003524 /* Check that the datagram is large enough to contain a record
3525 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003526 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003527 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003528 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3529 (unsigned) len,
3530 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003531 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3532 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003533
Hanno Becker37cfe732019-07-10 17:20:01 +01003534 /* Records from other, non-matching epochs are silently discarded.
3535 * (The case of same-port Client reconnects must be considered in
3536 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003537 if( rec_epoch != ssl->in_epoch )
3538 {
3539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003540 "expected %u, received %lu",
3541 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003542
Hanno Becker552f7472019-07-19 10:59:12 +01003543 /* Records from the next epoch are considered for buffering
3544 * (concretely: early Finished messages). */
3545 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003546 {
Hanno Becker552f7472019-07-19 10:59:12 +01003547 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3548 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003549 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003550
Hanno Becker2fddd372019-07-10 14:37:41 +01003551 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003552 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003553#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003554 /* For records from the correct epoch, check whether their
3555 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003556 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3557 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003558 {
3559 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3560 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3561 }
3562#endif
3563 }
3564#endif /* MBEDTLS_SSL_PROTO_DTLS */
3565
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003566 return( 0 );
3567}
Paul Bakker5121ce52009-01-03 21:22:43 +00003568
Paul Bakker5121ce52009-01-03 21:22:43 +00003569
Hanno Becker2fddd372019-07-10 14:37:41 +01003570#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3571static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3572{
3573 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3574
3575 /*
3576 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3577 * access the first byte of record content (handshake type), as we
3578 * have an active transform (possibly iv_len != 0), so use the
3579 * fact that the record header len is 13 instead.
3580 */
3581 if( rec_epoch == 0 &&
3582 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3583 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3584 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3585 ssl->in_left > 13 &&
3586 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3587 {
3588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3589 "from the same port" ) );
3590 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003591 }
3592
3593 return( 0 );
3594}
Hanno Becker2fddd372019-07-10 14:37:41 +01003595#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003596
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003597/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003598 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003599 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003600static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3601 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003602{
3603 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003606 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003607
Ronald Cron7e38cba2021-11-24 12:43:39 +01003608 /*
3609 * In TLS 1.3, always treat ChangeCipherSpec records
3610 * as unencrypted. The only thing we do with them is
3611 * check the length and content and ignore them.
3612 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003613#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003614 if( ssl->transform_in != NULL &&
3615 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3616 {
3617 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3618 done = 1;
3619 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003620#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003621
Paul Bakker48916f92012-09-16 19:57:18 +00003622 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003623 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003624 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003625
Hanno Beckera18d1322018-01-03 14:27:32 +00003626 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003627 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003628 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003630
Hanno Beckera0e20d02019-05-15 14:03:01 +01003631#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003632 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3633 ssl->conf->ignore_unexpected_cid
3634 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3635 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003636 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003637 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003638 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003639#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003640
Paul Bakker5121ce52009-01-03 21:22:43 +00003641 return( ret );
3642 }
3643
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003644 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003645 {
3646 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003647 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003648 }
3649
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003650 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003651 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003652
Hanno Beckera0e20d02019-05-15 14:03:01 +01003653#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003654 /* We have already checked the record content type
3655 * in ssl_parse_record_header(), failing or silently
3656 * dropping the record in the case of an unknown type.
3657 *
3658 * Since with the use of CIDs, the record content type
3659 * might change during decryption, re-check the record
3660 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003661 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003662 {
3663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3664 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3665 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003666#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003667
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003668 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003669 {
3670#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3671 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003672 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003673 {
3674 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3675 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3676 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3677 }
3678#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3679
3680 ssl->nb_zero++;
3681
3682 /*
3683 * Three or more empty messages may be a DoS attack
3684 * (excessive CPU consumption).
3685 */
3686 if( ssl->nb_zero > 3 )
3687 {
3688 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003689 "messages, possible DoS attack" ) );
3690 /* Treat the records as if they were not properly authenticated,
3691 * thereby failing the connection if we see more than allowed
3692 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003693 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3694 }
3695 }
3696 else
3697 ssl->nb_zero = 0;
3698
3699#if defined(MBEDTLS_SSL_PROTO_DTLS)
3700 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3701 {
3702 ; /* in_ctr read from peer, not maintained internally */
3703 }
3704 else
3705#endif
3706 {
3707 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003708 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3709 i > mbedtls_ssl_ep_len( ssl ); i-- )
3710 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003711 if( ++ssl->in_ctr[i - 1] != 0 )
3712 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003713 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003714
3715 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003716 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003717 {
3718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3719 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3720 }
3721 }
3722
Paul Bakker5121ce52009-01-03 21:22:43 +00003723 }
3724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003725#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003726 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003727 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003728 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003729 }
3730#endif
3731
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003732 /* Check actual (decrypted) record content length against
3733 * configured maximum. */
3734 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3735 {
3736 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3737 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3738 }
3739
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003740 return( 0 );
3741}
3742
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003743/*
3744 * Read a record.
3745 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003746 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3747 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3748 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003749 */
Hanno Becker1097b342018-08-15 14:09:41 +01003750
3751/* Helper functions for mbedtls_ssl_read_record(). */
3752static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003753static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3754static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003755
Hanno Becker327c93b2018-08-15 13:56:18 +01003756int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003757 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003758{
Janos Follath865b3eb2019-12-16 11:46:15 +00003759 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003762
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003763 if( ssl->keep_current_message == 0 )
3764 {
3765 do {
Simon Butcher99000142016-10-13 17:21:01 +01003766
Hanno Becker26994592018-08-15 14:14:59 +01003767 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003768 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003769 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003770
Hanno Beckere74d5562018-08-15 14:26:08 +01003771 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003772 {
Hanno Becker40f50842018-08-15 14:48:01 +01003773#if defined(MBEDTLS_SSL_PROTO_DTLS)
3774 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003775
Hanno Becker40f50842018-08-15 14:48:01 +01003776 /* We only check for buffered messages if the
3777 * current datagram is fully consumed. */
3778 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003779 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003780 {
Hanno Becker40f50842018-08-15 14:48:01 +01003781 if( ssl_load_buffered_message( ssl ) == 0 )
3782 have_buffered = 1;
3783 }
3784
3785 if( have_buffered == 0 )
3786#endif /* MBEDTLS_SSL_PROTO_DTLS */
3787 {
3788 ret = ssl_get_next_record( ssl );
3789 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3790 continue;
3791
3792 if( ret != 0 )
3793 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003794 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003795 return( ret );
3796 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003797 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003798 }
3799
3800 ret = mbedtls_ssl_handle_message_type( ssl );
3801
Hanno Becker40f50842018-08-15 14:48:01 +01003802#if defined(MBEDTLS_SSL_PROTO_DTLS)
3803 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3804 {
3805 /* Buffer future message */
3806 ret = ssl_buffer_message( ssl );
3807 if( ret != 0 )
3808 return( ret );
3809
3810 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3811 }
3812#endif /* MBEDTLS_SSL_PROTO_DTLS */
3813
Hanno Becker90333da2017-10-10 11:27:13 +01003814 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3815 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003816
3817 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003818 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003819 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003820 return( ret );
3821 }
3822
Hanno Becker327c93b2018-08-15 13:56:18 +01003823 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003824 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003825 {
3826 mbedtls_ssl_update_handshake_status( ssl );
3827 }
Simon Butcher99000142016-10-13 17:21:01 +01003828 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003829 else
Simon Butcher99000142016-10-13 17:21:01 +01003830 {
Hanno Becker02f59072018-08-15 14:00:24 +01003831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003832 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003833 }
3834
3835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3836
3837 return( 0 );
3838}
3839
Hanno Becker40f50842018-08-15 14:48:01 +01003840#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003841static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003842{
Hanno Becker40f50842018-08-15 14:48:01 +01003843 if( ssl->in_left > ssl->next_record_offset )
3844 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003845
Hanno Becker40f50842018-08-15 14:48:01 +01003846 return( 0 );
3847}
3848
3849static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3850{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003851 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003852 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003853 int ret = 0;
3854
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003855 if( hs == NULL )
3856 return( -1 );
3857
Hanno Beckere00ae372018-08-20 09:39:42 +01003858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3859
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003860 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3861 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3862 {
3863 /* Check if we have seen a ChangeCipherSpec before.
3864 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003865 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003866 {
3867 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3868 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003869 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003870 }
3871
Hanno Becker39b8bc92018-08-28 17:17:13 +01003872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003873 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3874 ssl->in_msglen = 1;
3875 ssl->in_msg[0] = 1;
3876
3877 /* As long as they are equal, the exact value doesn't matter. */
3878 ssl->in_left = 0;
3879 ssl->next_record_offset = 0;
3880
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003881 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003882 goto exit;
3883 }
Hanno Becker37f95322018-08-16 13:55:32 +01003884
Hanno Beckerb8f50142018-08-28 10:01:34 +01003885#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003886 /* Debug only */
3887 {
3888 unsigned offset;
3889 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3890 {
3891 hs_buf = &hs->buffering.hs[offset];
3892 if( hs_buf->is_valid == 1 )
3893 {
3894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3895 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003896 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003897 }
3898 }
3899 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003900#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003901
3902 /* Check if we have buffered and/or fully reassembled the
3903 * next handshake message. */
3904 hs_buf = &hs->buffering.hs[0];
3905 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3906 {
3907 /* Synthesize a record containing the buffered HS message. */
3908 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3909 ( hs_buf->data[2] << 8 ) |
3910 hs_buf->data[3];
3911
3912 /* Double-check that we haven't accidentally buffered
3913 * a message that doesn't fit into the input buffer. */
3914 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3915 {
3916 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3917 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3918 }
3919
3920 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3921 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3922 hs_buf->data, msg_len + 12 );
3923
3924 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3925 ssl->in_hslen = msg_len + 12;
3926 ssl->in_msglen = msg_len + 12;
3927 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3928
3929 ret = 0;
3930 goto exit;
3931 }
3932 else
3933 {
3934 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3935 hs->in_msg_seq ) );
3936 }
3937
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003938 ret = -1;
3939
3940exit:
3941
3942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3943 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003944}
3945
Hanno Beckera02b0b42018-08-21 17:20:27 +01003946static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3947 size_t desired )
3948{
3949 int offset;
3950 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003951 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3952 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003953
Hanno Becker01315ea2018-08-21 17:22:17 +01003954 /* Get rid of future records epoch first, if such exist. */
3955 ssl_free_buffered_record( ssl );
3956
3957 /* Check if we have enough space available now. */
3958 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3959 hs->buffering.total_bytes_buffered ) )
3960 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003961 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003962 return( 0 );
3963 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003964
Hanno Becker4f432ad2018-08-28 10:02:32 +01003965 /* We don't have enough space to buffer the next expected handshake
3966 * message. Remove buffers used for future messages to gain space,
3967 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003968 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3969 offset >= 0; offset-- )
3970 {
3971 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3972 offset ) );
3973
Hanno Beckerb309b922018-08-23 13:18:05 +01003974 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003975
3976 /* Check if we have enough space available now. */
3977 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3978 hs->buffering.total_bytes_buffered ) )
3979 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003980 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003981 return( 0 );
3982 }
3983 }
3984
3985 return( -1 );
3986}
3987
Hanno Becker40f50842018-08-15 14:48:01 +01003988static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3989{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003990 int ret = 0;
3991 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3992
3993 if( hs == NULL )
3994 return( 0 );
3995
3996 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3997
3998 switch( ssl->in_msgtype )
3999 {
4000 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004002
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004003 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004004 break;
4005
4006 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004007 {
4008 unsigned recv_msg_seq_offset;
4009 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4010 mbedtls_ssl_hs_buffer *hs_buf;
4011 size_t msg_len = ssl->in_hslen - 12;
4012
4013 /* We should never receive an old handshake
4014 * message - double-check nonetheless. */
4015 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4016 {
4017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4018 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4019 }
4020
4021 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4022 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4023 {
4024 /* Silently ignore -- message too far in the future */
4025 MBEDTLS_SSL_DEBUG_MSG( 2,
4026 ( "Ignore future HS message with sequence number %u, "
4027 "buffering window %u - %u",
4028 recv_msg_seq, ssl->handshake->in_msg_seq,
4029 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4030
4031 goto exit;
4032 }
4033
4034 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4035 recv_msg_seq, recv_msg_seq_offset ) );
4036
4037 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4038
4039 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004040 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004041 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004042 size_t reassembly_buf_sz;
4043
Hanno Becker37f95322018-08-16 13:55:32 +01004044 hs_buf->is_fragmented =
4045 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4046
4047 /* We copy the message back into the input buffer
4048 * after reassembly, so check that it's not too large.
4049 * This is an implementation-specific limitation
4050 * and not one from the standard, hence it is not
4051 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004052 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004053 {
4054 /* Ignore message */
4055 goto exit;
4056 }
4057
Hanno Beckere0b150f2018-08-21 15:51:03 +01004058 /* Check if we have enough space to buffer the message. */
4059 if( hs->buffering.total_bytes_buffered >
4060 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4061 {
4062 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4063 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4064 }
4065
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004066 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4067 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004068
4069 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4070 hs->buffering.total_bytes_buffered ) )
4071 {
4072 if( recv_msg_seq_offset > 0 )
4073 {
4074 /* If we can't buffer a future message because
4075 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004076 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4077 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4078 " (already %" MBEDTLS_PRINTF_SIZET
4079 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004080 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004081 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004082 goto exit;
4083 }
Hanno Beckere1801392018-08-21 16:51:05 +01004084 else
4085 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4087 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4088 " (already %" MBEDTLS_PRINTF_SIZET
4089 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004090 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004091 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004092 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004093
Hanno Beckera02b0b42018-08-21 17:20:27 +01004094 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004095 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4097 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4098 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4099 " (already %" MBEDTLS_PRINTF_SIZET
4100 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004101 msg_len,
4102 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004103 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004104 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004105 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4106 goto exit;
4107 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004108 }
4109
Paul Elliottd48d5c62021-01-07 14:47:05 +00004110 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004111 msg_len ) );
4112
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004113 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4114 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004115 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004116 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004117 goto exit;
4118 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004119 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004120
4121 /* Prepare final header: copy msg_type, length and message_seq,
4122 * then add standardised fragment_offset and fragment_length */
4123 memcpy( hs_buf->data, ssl->in_msg, 6 );
4124 memset( hs_buf->data + 6, 0, 3 );
4125 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4126
4127 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004128
4129 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004130 }
4131 else
4132 {
4133 /* Make sure msg_type and length are consistent */
4134 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4135 {
4136 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4137 /* Ignore */
4138 goto exit;
4139 }
4140 }
4141
Hanno Becker4422bbb2018-08-20 09:40:19 +01004142 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004143 {
4144 size_t frag_len, frag_off;
4145 unsigned char * const msg = hs_buf->data + 12;
4146
4147 /*
4148 * Check and copy current fragment
4149 */
4150
4151 /* Validation of header fields already done in
4152 * mbedtls_ssl_prepare_handshake_record(). */
4153 frag_off = ssl_get_hs_frag_off( ssl );
4154 frag_len = ssl_get_hs_frag_len( ssl );
4155
Paul Elliottd48d5c62021-01-07 14:47:05 +00004156 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4157 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004158 frag_off, frag_len ) );
4159 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4160
4161 if( hs_buf->is_fragmented )
4162 {
4163 unsigned char * const bitmask = msg + msg_len;
4164 ssl_bitmask_set( bitmask, frag_off, frag_len );
4165 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4166 msg_len ) == 0 );
4167 }
4168 else
4169 {
4170 hs_buf->is_complete = 1;
4171 }
4172
4173 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4174 hs_buf->is_complete ? "" : "not yet " ) );
4175 }
4176
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004177 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004178 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004179
4180 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004181 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004182 break;
4183 }
4184
4185exit:
4186
4187 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4188 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004189}
4190#endif /* MBEDTLS_SSL_PROTO_DTLS */
4191
Hanno Becker1097b342018-08-15 14:09:41 +01004192static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004193{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004194 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004195 * Consume last content-layer message and potentially
4196 * update in_msglen which keeps track of the contents'
4197 * consumption state.
4198 *
4199 * (1) Handshake messages:
4200 * Remove last handshake message, move content
4201 * and adapt in_msglen.
4202 *
4203 * (2) Alert messages:
4204 * Consume whole record content, in_msglen = 0.
4205 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004206 * (3) Change cipher spec:
4207 * Consume whole record content, in_msglen = 0.
4208 *
4209 * (4) Application data:
4210 * Don't do anything - the record layer provides
4211 * the application data as a stream transport
4212 * and consumes through mbedtls_ssl_read only.
4213 *
4214 */
4215
4216 /* Case (1): Handshake messages */
4217 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004218 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004219 /* Hard assertion to be sure that no application data
4220 * is in flight, as corrupting ssl->in_msglen during
4221 * ssl->in_offt != NULL is fatal. */
4222 if( ssl->in_offt != NULL )
4223 {
4224 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4225 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4226 }
4227
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004228 /*
4229 * Get next Handshake message in the current record
4230 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004231
Hanno Becker4a810fb2017-05-24 16:27:30 +01004232 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004233 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004234 * current handshake content: If DTLS handshake
4235 * fragmentation is used, that's the fragment
4236 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004237 * size here is faulty and should be changed at
4238 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004239 * (2) While it doesn't seem to cause problems, one
4240 * has to be very careful not to assume that in_hslen
4241 * is always <= in_msglen in a sensible communication.
4242 * Again, it's wrong for DTLS handshake fragmentation.
4243 * The following check is therefore mandatory, and
4244 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004245 * Additionally, ssl->in_hslen might be arbitrarily out of
4246 * bounds after handling a DTLS message with an unexpected
4247 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004248 */
4249 if( ssl->in_hslen < ssl->in_msglen )
4250 {
4251 ssl->in_msglen -= ssl->in_hslen;
4252 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4253 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004254
Hanno Becker4a810fb2017-05-24 16:27:30 +01004255 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4256 ssl->in_msg, ssl->in_msglen );
4257 }
4258 else
4259 {
4260 ssl->in_msglen = 0;
4261 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004262
Hanno Becker4a810fb2017-05-24 16:27:30 +01004263 ssl->in_hslen = 0;
4264 }
4265 /* Case (4): Application data */
4266 else if( ssl->in_offt != NULL )
4267 {
4268 return( 0 );
4269 }
4270 /* Everything else (CCS & Alerts) */
4271 else
4272 {
4273 ssl->in_msglen = 0;
4274 }
4275
Hanno Becker1097b342018-08-15 14:09:41 +01004276 return( 0 );
4277}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004278
Hanno Beckere74d5562018-08-15 14:26:08 +01004279static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4280{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004281 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004282 return( 1 );
4283
4284 return( 0 );
4285}
4286
Hanno Becker5f066e72018-08-16 14:56:31 +01004287#if defined(MBEDTLS_SSL_PROTO_DTLS)
4288
4289static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4290{
4291 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4292 if( hs == NULL )
4293 return;
4294
Hanno Becker01315ea2018-08-21 17:22:17 +01004295 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004296 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004297 hs->buffering.total_bytes_buffered -=
4298 hs->buffering.future_record.len;
4299
4300 mbedtls_free( hs->buffering.future_record.data );
4301 hs->buffering.future_record.data = NULL;
4302 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004303}
4304
4305static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4306{
4307 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4308 unsigned char * rec;
4309 size_t rec_len;
4310 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004311#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4312 size_t in_buf_len = ssl->in_buf_len;
4313#else
4314 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4315#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004316 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4317 return( 0 );
4318
4319 if( hs == NULL )
4320 return( 0 );
4321
Hanno Becker5f066e72018-08-16 14:56:31 +01004322 rec = hs->buffering.future_record.data;
4323 rec_len = hs->buffering.future_record.len;
4324 rec_epoch = hs->buffering.future_record.epoch;
4325
4326 if( rec == NULL )
4327 return( 0 );
4328
Hanno Becker4cb782d2018-08-20 11:19:05 +01004329 /* Only consider loading future records if the
4330 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004331 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004332 return( 0 );
4333
Hanno Becker5f066e72018-08-16 14:56:31 +01004334 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4335
4336 if( rec_epoch != ssl->in_epoch )
4337 {
4338 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4339 goto exit;
4340 }
4341
4342 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4343
4344 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004345 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004346 {
4347 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4348 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4349 }
4350
4351 memcpy( ssl->in_hdr, rec, rec_len );
4352 ssl->in_left = rec_len;
4353 ssl->next_record_offset = 0;
4354
4355 ssl_free_buffered_record( ssl );
4356
4357exit:
4358 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4359 return( 0 );
4360}
4361
Hanno Becker519f15d2019-07-11 12:43:20 +01004362static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4363 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004364{
4365 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004366
4367 /* Don't buffer future records outside handshakes. */
4368 if( hs == NULL )
4369 return( 0 );
4370
4371 /* Only buffer handshake records (we are only interested
4372 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004373 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004374 return( 0 );
4375
4376 /* Don't buffer more than one future epoch record. */
4377 if( hs->buffering.future_record.data != NULL )
4378 return( 0 );
4379
Hanno Becker01315ea2018-08-21 17:22:17 +01004380 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004381 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004382 hs->buffering.total_bytes_buffered ) )
4383 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004384 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4385 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4386 " (already %" MBEDTLS_PRINTF_SIZET
4387 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004388 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004389 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004390 return( 0 );
4391 }
4392
Hanno Becker5f066e72018-08-16 14:56:31 +01004393 /* Buffer record */
4394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004395 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004396 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004397
4398 /* ssl_parse_record_header() only considers records
4399 * of the next epoch as candidates for buffering. */
4400 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004401 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004402
4403 hs->buffering.future_record.data =
4404 mbedtls_calloc( 1, hs->buffering.future_record.len );
4405 if( hs->buffering.future_record.data == NULL )
4406 {
4407 /* If we run out of RAM trying to buffer a
4408 * record from the next epoch, just ignore. */
4409 return( 0 );
4410 }
4411
Hanno Becker519f15d2019-07-11 12:43:20 +01004412 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004413
Hanno Becker519f15d2019-07-11 12:43:20 +01004414 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004415 return( 0 );
4416}
4417
4418#endif /* MBEDTLS_SSL_PROTO_DTLS */
4419
Hanno Beckere74d5562018-08-15 14:26:08 +01004420static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004421{
Janos Follath865b3eb2019-12-16 11:46:15 +00004422 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004423 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004424
Hanno Becker5f066e72018-08-16 14:56:31 +01004425#if defined(MBEDTLS_SSL_PROTO_DTLS)
4426 /* We might have buffered a future record; if so,
4427 * and if the epoch matches now, load it.
4428 * On success, this call will set ssl->in_left to
4429 * the length of the buffered record, so that
4430 * the calls to ssl_fetch_input() below will
4431 * essentially be no-ops. */
4432 ret = ssl_load_buffered_record( ssl );
4433 if( ret != 0 )
4434 return( ret );
4435#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004436
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004437 /* Ensure that we have enough space available for the default form
4438 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4439 * with no space for CIDs counted in). */
4440 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4441 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004442 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004443 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004444 return( ret );
4445 }
4446
Hanno Beckere5e7e782019-07-11 12:29:35 +01004447 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4448 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004449 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004450#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004451 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004452 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004453 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4454 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004455 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004456 if( ret != 0 )
4457 return( ret );
4458
4459 /* Fall through to handling of unexpected records */
4460 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4461 }
4462
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004463 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4464 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004465#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004466 /* Reset in pointers to default state for TLS/DTLS records,
4467 * assuming no CID and no offset between record content and
4468 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004469 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004470
Hanno Becker7ae20e02019-07-12 08:33:49 +01004471 /* Setup internal message pointers from record structure. */
4472 ssl->in_msgtype = rec.type;
4473#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4474 ssl->in_len = ssl->in_cid + rec.cid_len;
4475#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4476 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4477 ssl->in_msglen = rec.data_len;
4478
Hanno Becker2fddd372019-07-10 14:37:41 +01004479 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004480 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004481 if( ret != 0 )
4482 return( ret );
4483#endif
4484
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004485 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004486 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004487
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4489 "(header)" ) );
4490 }
4491 else
4492 {
4493 /* Skip invalid record and the rest of the datagram */
4494 ssl->next_record_offset = 0;
4495 ssl->in_left = 0;
4496
4497 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4498 "(header)" ) );
4499 }
4500
4501 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004502 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004503 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004504 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004505#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004506 {
4507 return( ret );
4508 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004509 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004511#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004512 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004513 {
Hanno Beckera8814792019-07-10 15:01:45 +01004514 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004515 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004516 if( ssl->next_record_offset < ssl->in_left )
4517 {
4518 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4519 }
4520 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004521 else
4522#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004523 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004524 /*
4525 * Fetch record contents from underlying transport.
4526 */
Hanno Beckera3175662019-07-11 12:50:29 +01004527 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004528 if( ret != 0 )
4529 {
4530 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4531 return( ret );
4532 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004533
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004534 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004535 }
4536
4537 /*
4538 * Decrypt record contents.
4539 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004540
Hanno Beckerfdf66042019-07-11 13:07:45 +01004541 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004542 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004543#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004544 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004545 {
4546 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004547 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004548 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004549 /* Except when waiting for Finished as a bad mac here
4550 * probably means something went wrong in the handshake
4551 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4552 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4553 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4554 {
4555#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4556 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4557 {
4558 mbedtls_ssl_send_alert_message( ssl,
4559 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4560 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4561 }
4562#endif
4563 return( ret );
4564 }
4565
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004566 if( ssl->conf->badmac_limit != 0 &&
4567 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004568 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4570 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004571 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004572
Hanno Becker4a810fb2017-05-24 16:27:30 +01004573 /* As above, invalid records cause
4574 * dismissal of the whole datagram. */
4575
4576 ssl->next_record_offset = 0;
4577 ssl->in_left = 0;
4578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004580 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004581 }
4582
4583 return( ret );
4584 }
4585 else
4586#endif
4587 {
4588 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004589#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4590 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004591 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004592 mbedtls_ssl_send_alert_message( ssl,
4593 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4594 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004595 }
4596#endif
4597 return( ret );
4598 }
4599 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004600
Hanno Becker44d89b22019-07-12 09:40:44 +01004601
4602 /* Reset in pointers to default state for TLS/DTLS records,
4603 * assuming no CID and no offset between record content and
4604 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004605 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004606#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4607 ssl->in_len = ssl->in_cid + rec.cid_len;
4608#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004609 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004610
Hanno Becker8685c822019-07-12 09:37:30 +01004611 /* The record content type may change during decryption,
4612 * so re-read it. */
4613 ssl->in_msgtype = rec.type;
4614 /* Also update the input buffer, because unfortunately
4615 * the server-side ssl_parse_client_hello() reparses the
4616 * record header when receiving a ClientHello initiating
4617 * a renegotiation. */
4618 ssl->in_hdr[0] = rec.type;
4619 ssl->in_msg = rec.buf + rec.data_offset;
4620 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004621 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004622
Simon Butcher99000142016-10-13 17:21:01 +01004623 return( 0 );
4624}
4625
4626int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4627{
Janos Follath865b3eb2019-12-16 11:46:15 +00004628 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004629
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004630 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004631 * Handle particular types of records
4632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004634 {
Simon Butcher99000142016-10-13 17:21:01 +01004635 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4636 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004637 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004638 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004639 }
4640
Hanno Beckere678eaa2018-08-21 14:57:46 +01004641 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004642 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004643 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004644 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004645 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004646 ssl->in_msglen ) );
4647 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004648 }
4649
Hanno Beckere678eaa2018-08-21 14:57:46 +01004650 if( ssl->in_msg[0] != 1 )
4651 {
4652 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4653 ssl->in_msg[0] ) );
4654 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4655 }
4656
4657#if defined(MBEDTLS_SSL_PROTO_DTLS)
4658 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4659 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4660 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4661 {
4662 if( ssl->handshake == NULL )
4663 {
4664 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4665 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4666 }
4667
4668 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4669 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4670 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004671#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004672
Ronald Cron6f135e12021-12-08 16:57:54 +01004673#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004674 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4675 {
4676#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4677 MBEDTLS_SSL_DEBUG_MSG( 1,
4678 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4679 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4680#else
4681 MBEDTLS_SSL_DEBUG_MSG( 1,
4682 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4683 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4684#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4685 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004686#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004687 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004689 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004690 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004691 if( ssl->in_msglen != 2 )
4692 {
4693 /* Note: Standard allows for more than one 2 byte alert
4694 to be packed in a single message, but Mbed TLS doesn't
4695 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004697 ssl->in_msglen ) );
4698 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4699 }
4700
Paul Elliott9f352112020-12-09 14:55:45 +00004701 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004702 ssl->in_msg[0], ssl->in_msg[1] ) );
4703
4704 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004705 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004706 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004707 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004708 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004710 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004711 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004712 }
4713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4715 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004716 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4718 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004719 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004720
4721#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4722 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4723 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4724 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004726 /* Will be handled when trying to parse ServerHello */
4727 return( 0 );
4728 }
4729#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004730 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004731 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004732 }
4733
Hanno Beckerc76c6192017-06-06 10:03:17 +01004734#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004735 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004736 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004737 /* Drop unexpected ApplicationData records,
4738 * except at the beginning of renegotiations */
4739 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4740 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4741#if defined(MBEDTLS_SSL_RENEGOTIATION)
4742 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4743 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004744#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004745 )
4746 {
4747 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4748 return( MBEDTLS_ERR_SSL_NON_FATAL );
4749 }
4750
4751 if( ssl->handshake != NULL &&
4752 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4753 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004754 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004755 }
4756 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004757#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004758
Paul Bakker5121ce52009-01-03 21:22:43 +00004759 return( 0 );
4760}
4761
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004762int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004763{
irwir6c0da642019-09-26 21:07:41 +03004764 return( mbedtls_ssl_send_alert_message( ssl,
4765 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4766 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004767}
4768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004770 unsigned char level,
4771 unsigned char message )
4772{
Janos Follath865b3eb2019-12-16 11:46:15 +00004773 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004774
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004775 if( ssl == NULL || ssl->conf == NULL )
4776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004779 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004782 ssl->out_msglen = 2;
4783 ssl->out_msg[0] = level;
4784 ssl->out_msg[1] = message;
4785
Hanno Becker67bc7c32018-08-06 11:33:50 +01004786 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004787 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004788 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004789 return( ret );
4790 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004792
4793 return( 0 );
4794}
4795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004796int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004797{
Janos Follath865b3eb2019-12-16 11:46:15 +00004798 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004799
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004803 ssl->out_msglen = 1;
4804 ssl->out_msg[0] = 1;
4805
Paul Bakker5121ce52009-01-03 21:22:43 +00004806 ssl->state++;
4807
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004808 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004809 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004810 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004811 return( ret );
4812 }
4813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004815
4816 return( 0 );
4817}
4818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004819int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004820{
Janos Follath865b3eb2019-12-16 11:46:15 +00004821 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004824
Hanno Becker327c93b2018-08-15 13:56:18 +01004825 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004827 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004828 return( ret );
4829 }
4830
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004832 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004833 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004834 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4835 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004837 }
4838
Hanno Beckere678eaa2018-08-21 14:57:46 +01004839 /* CCS records are only accepted if they have length 1 and content '1',
4840 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004841
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004842 /*
4843 * Switch to our negotiated transform and session parameters for inbound
4844 * data.
4845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004846 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004847 ssl->transform_in = ssl->transform_negotiate;
4848 ssl->session_in = ssl->session_negotiate;
4849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004850#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004851 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004852 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004853#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004854 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004855#endif
4856
4857 /* Increment epoch */
4858 if( ++ssl->in_epoch == 0 )
4859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004861 /* This is highly unlikely to happen for legitimate reasons, so
4862 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004863 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004864 }
4865 }
4866 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004867#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004868 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004869
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004870 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004871
Paul Bakker5121ce52009-01-03 21:22:43 +00004872 ssl->state++;
4873
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004874 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004875
4876 return( 0 );
4877}
4878
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004879/* Once ssl->out_hdr as the address of the beginning of the
4880 * next outgoing record is set, deduce the other pointers.
4881 *
4882 * Note: For TLS, we save the implicit record sequence number
4883 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4884 * and the caller has to make sure there's space for this.
4885 */
4886
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004887static size_t ssl_transform_get_explicit_iv_len(
4888 mbedtls_ssl_transform const *transform )
4889{
TRodziewiczef73f012021-05-13 14:53:36 +02004890 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004891 return( 0 );
4892
4893 return( transform->ivlen - transform->fixed_ivlen );
4894}
4895
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004896void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4897 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004898{
4899#if defined(MBEDTLS_SSL_PROTO_DTLS)
4900 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4901 {
4902 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004903#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004904 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004905 ssl->out_len = ssl->out_cid;
4906 if( transform != NULL )
4907 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004908#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004909 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004910#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004911 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004912 }
4913 else
4914#endif
4915 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004916 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004917#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004918 ssl->out_cid = ssl->out_len;
4919#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004920 ssl->out_iv = ssl->out_hdr + 5;
4921 }
4922
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004923 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004924 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004925 if( transform != NULL )
4926 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004927}
4928
4929/* Once ssl->in_hdr as the address of the beginning of the
4930 * next incoming record is set, deduce the other pointers.
4931 *
4932 * Note: For TLS, we save the implicit record sequence number
4933 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4934 * and the caller has to make sure there's space for this.
4935 */
4936
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004937void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004938{
Hanno Becker79594fd2019-05-08 09:38:41 +01004939 /* This function sets the pointers to match the case
4940 * of unprotected TLS/DTLS records, with both ssl->in_iv
4941 * and ssl->in_msg pointing to the beginning of the record
4942 * content.
4943 *
4944 * When decrypting a protected record, ssl->in_msg
4945 * will be shifted to point to the beginning of the
4946 * record plaintext.
4947 */
4948
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004949#if defined(MBEDTLS_SSL_PROTO_DTLS)
4950 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4951 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004952 /* This sets the header pointers to match records
4953 * without CID. When we receive a record containing
4954 * a CID, the fields are shifted accordingly in
4955 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004956 ssl->in_ctr = ssl->in_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->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004959 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004960#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004961 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004962#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004963 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004964 }
4965 else
4966#endif
4967 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004968 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004969 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004970#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004971 ssl->in_cid = ssl->in_len;
4972#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004973 ssl->in_iv = ssl->in_hdr + 5;
4974 }
4975
Hanno Becker79594fd2019-05-08 09:38:41 +01004976 /* This will be adjusted at record decryption time. */
4977 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004978}
4979
Paul Bakker5121ce52009-01-03 21:22:43 +00004980/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004981 * Setup an SSL context
4982 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004983
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004984void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004985{
4986 /* Set the incoming and outgoing record pointers. */
4987#if defined(MBEDTLS_SSL_PROTO_DTLS)
4988 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4989 {
4990 ssl->out_hdr = ssl->out_buf;
4991 ssl->in_hdr = ssl->in_buf;
4992 }
4993 else
4994#endif /* MBEDTLS_SSL_PROTO_DTLS */
4995 {
Hanno Becker12078f42021-03-02 15:28:41 +00004996 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004997 ssl->out_hdr = ssl->out_buf + 8;
4998 ssl->in_hdr = ssl->in_buf + 8;
4999 }
5000
5001 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005002 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5003 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005004}
5005
Paul Bakker5121ce52009-01-03 21:22:43 +00005006/*
5007 * SSL get accessors
5008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005009size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005010{
5011 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5012}
5013
Hanno Becker8b170a02017-10-10 11:51:19 +01005014int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5015{
5016 /*
5017 * Case A: We're currently holding back
5018 * a message for further processing.
5019 */
5020
5021 if( ssl->keep_current_message == 1 )
5022 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005023 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005024 return( 1 );
5025 }
5026
5027 /*
5028 * Case B: Further records are pending in the current datagram.
5029 */
5030
5031#if defined(MBEDTLS_SSL_PROTO_DTLS)
5032 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5033 ssl->in_left > ssl->next_record_offset )
5034 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005035 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005036 return( 1 );
5037 }
5038#endif /* MBEDTLS_SSL_PROTO_DTLS */
5039
5040 /*
5041 * Case C: A handshake message is being processed.
5042 */
5043
Hanno Becker8b170a02017-10-10 11:51:19 +01005044 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5045 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005046 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005047 return( 1 );
5048 }
5049
5050 /*
5051 * Case D: An application data message is being processed
5052 */
5053 if( ssl->in_offt != NULL )
5054 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005055 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005056 return( 1 );
5057 }
5058
5059 /*
5060 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005061 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005062 * we implement support for multiple alerts in single records.
5063 */
5064
5065 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5066 return( 0 );
5067}
5068
Paul Bakker43ca69c2011-01-15 17:35:19 +00005069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005070int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005071{
Hanno Becker3136ede2018-08-17 15:28:19 +01005072 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005073 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005074 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005075#if defined(MBEDTLS_USE_PSA_CRYPTO)
5076 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5077 psa_key_type_t key_type;
5078#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005079
Hanno Becker5903de42019-05-03 14:46:38 +01005080 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5081
Hanno Becker78640902018-08-13 16:35:15 +01005082 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005083 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005084
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005085
5086#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005087 if ( transform->psa_alg == PSA_ALG_GCM ||
5088 transform->psa_alg == PSA_ALG_CCM ||
5089 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5090 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005091 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005092 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005093 transform_expansion = transform->minlen;
5094 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005095 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005096 {
5097 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5098 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005099
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005100 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005101
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005102 /* Expansion due to the addition of the MAC. */
5103 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005104
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005105 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005106 * Theoretically up to 256 bytes, but we never use
5107 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005108 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005109
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005110 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005111 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005112#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005113 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005114#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005115 }
5116 else
5117 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005118 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005119 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005120 }
5121#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005122 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005123 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005124 case MBEDTLS_MODE_GCM:
5125 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005126 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005127 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005128 transform_expansion = transform->minlen;
5129 break;
5130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005131 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005132
5133 block_size = mbedtls_cipher_get_block_size(
5134 &transform->cipher_ctx_enc );
5135
Hanno Becker3136ede2018-08-17 15:28:19 +01005136 /* Expansion due to the addition of the MAC. */
5137 transform_expansion += transform->maclen;
5138
5139 /* Expansion due to the addition of CBC padding;
5140 * Theoretically up to 256 bytes, but we never use
5141 * more than the block size of the underlying cipher. */
5142 transform_expansion += block_size;
5143
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005144 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005145 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005146#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005147 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005148#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005149
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005150 break;
5151
5152 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005153 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005155 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005156#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005157
Hanno Beckera0e20d02019-05-15 14:03:01 +01005158#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005159 if( transform->out_cid_len != 0 )
5160 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005161#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005162
Hanno Becker5903de42019-05-03 14:46:38 +01005163 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005164}
5165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005166#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005167/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005168 * Check record counters and renegotiate if they're above the limit.
5169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005170static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005171{
Hanno Beckerdd772292020-02-05 10:38:31 +00005172 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005173 int in_ctr_cmp;
5174 int out_ctr_cmp;
5175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005176 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5177 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005178 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005179 {
5180 return( 0 );
5181 }
5182
Andres AG2196c7f2016-12-15 17:01:16 +00005183 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005184 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005185 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005186 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5187 &ssl->conf->renego_period[ep_len],
5188 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005189
5190 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005191 {
5192 return( 0 );
5193 }
5194
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005195 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005196 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005197}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005198#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005199
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005200/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005201 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005202 * may only be sent for the purpose of initiating renegotiations.
5203 *
5204 * This function is introduced as a separate helper since the handling
5205 * of post-handshake handshake messages changes significantly in TLS 1.3,
5206 * and having a helper function allows to distinguish between TLS <= 1.2 and
5207 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5208 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005209static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005210{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005212
5213 /*
5214 * - For client-side, expect SERVER_HELLO_REQUEST.
5215 * - For server-side, expect CLIENT_HELLO.
5216 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5217 */
5218
5219#if defined(MBEDTLS_SSL_CLI_C)
5220 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5221 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5222 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5223 {
5224 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5225
5226 /* With DTLS, drop the packet (probably from last handshake) */
5227#if defined(MBEDTLS_SSL_PROTO_DTLS)
5228 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5229 {
5230 return( 0 );
5231 }
5232#endif
5233 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5234 }
5235#endif /* MBEDTLS_SSL_CLI_C */
5236
5237#if defined(MBEDTLS_SSL_SRV_C)
5238 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5239 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5240 {
5241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5242
5243 /* With DTLS, drop the packet (probably from last handshake) */
5244#if defined(MBEDTLS_SSL_PROTO_DTLS)
5245 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5246 {
5247 return( 0 );
5248 }
5249#endif
5250 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5251 }
5252#endif /* MBEDTLS_SSL_SRV_C */
5253
5254#if defined(MBEDTLS_SSL_RENEGOTIATION)
5255 /* Determine whether renegotiation attempt should be accepted */
5256 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5257 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5258 ssl->conf->allow_legacy_renegotiation ==
5259 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5260 {
5261 /*
5262 * Accept renegotiation request
5263 */
5264
5265 /* DTLS clients need to know renego is server-initiated */
5266#if defined(MBEDTLS_SSL_PROTO_DTLS)
5267 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5268 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5269 {
5270 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5271 }
5272#endif
5273 ret = mbedtls_ssl_start_renegotiation( ssl );
5274 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5275 ret != 0 )
5276 {
5277 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5278 ret );
5279 return( ret );
5280 }
5281 }
5282 else
5283#endif /* MBEDTLS_SSL_RENEGOTIATION */
5284 {
5285 /*
5286 * Refuse renegotiation
5287 */
5288
5289 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5290
TRodziewicz0f82ec62021-05-12 17:49:18 +02005291#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005292 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5293 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5294 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005295 {
TRodziewicz345165c2021-07-06 13:42:11 +02005296 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005297 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005298#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005299 }
5300
5301 return( 0 );
5302}
5303
Paul Bakker48916f92012-09-16 19:57:18 +00005304/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005305 * Receive application data decrypted from the SSL layer
5306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005307int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005308{
Janos Follath865b3eb2019-12-16 11:46:15 +00005309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005310 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005311
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005312 if( ssl == NULL || ssl->conf == NULL )
5313 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005315 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005317#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005318 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005319 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005320 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005321 return( ret );
5322
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005323 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005324 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005325 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005326 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005327 return( ret );
5328 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005329 }
5330#endif
5331
Hanno Becker4a810fb2017-05-24 16:27:30 +01005332 /*
5333 * Check if renegotiation is necessary and/or handshake is
5334 * in process. If yes, perform/continue, and fall through
5335 * if an unexpected packet is received while the client
5336 * is waiting for the ServerHello.
5337 *
5338 * (There is no equivalent to the last condition on
5339 * the server-side as it is not treated as within
5340 * a handshake while waiting for the ClientHello
5341 * after a renegotiation request.)
5342 */
5343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005345 ret = ssl_check_ctr_renegotiate( ssl );
5346 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5347 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005348 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005349 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005350 return( ret );
5351 }
5352#endif
5353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005356 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005357 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5358 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005361 return( ret );
5362 }
5363 }
5364
Hanno Beckere41158b2017-10-23 13:30:32 +01005365 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005366 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005367 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005368 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005369 if( ssl->f_get_timer != NULL &&
5370 ssl->f_get_timer( ssl->p_timer ) == -1 )
5371 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005372 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005373 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005374
Hanno Becker327c93b2018-08-15 13:56:18 +01005375 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005376 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005377 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5378 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005379
Hanno Becker4a810fb2017-05-24 16:27:30 +01005380 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5381 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005382 }
5383
5384 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005385 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005386 {
5387 /*
5388 * OpenSSL sends empty messages to randomize the IV
5389 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005390 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005391 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005392 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005393 return( 0 );
5394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005396 return( ret );
5397 }
5398 }
5399
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005400 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005401 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005402 ret = ssl_handle_hs_message_post_handshake( ssl );
5403 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005404 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005405 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5406 ret );
5407 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005408 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005409
Hanno Beckerf26cc722021-04-21 07:30:13 +01005410 /* At this point, we don't know whether the renegotiation triggered
5411 * by the post-handshake message has been completed or not. The cases
5412 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005413 * 1) The renegotiation is complete. In this case, no new record
5414 * has been read yet.
5415 * 2) The renegotiation is incomplete because the client received
5416 * an application data record while awaiting the ServerHello.
5417 * 3) The renegotiation is incomplete because the client received
5418 * a non-handshake, non-application data message while awaiting
5419 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005420 *
5421 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005422 * - For 1), the next iteration will read a new record and check
5423 * if it's application data.
5424 * - For 2), the loop condition isn't satisfied as application data
5425 * is present, hence continue is the same as break
5426 * - For 3), the loop condition is satisfied and read_record
5427 * will re-deliver the message that was held back by the client
5428 * when expecting the ServerHello.
5429 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005430
Hanno Becker90333da2017-10-10 11:27:13 +01005431 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005432 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005433#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005435 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005436 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005437 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005438 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005440 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005441 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005443 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005444 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005445 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5449 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005450 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005451 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005452 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005453 }
5454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005456 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5458 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005459 }
5460
5461 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005462
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005463 /* We're going to return something now, cancel timer,
5464 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005466 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005467
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005468#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005469 /* If we requested renego but received AppData, resend HelloRequest.
5470 * Do it now, after setting in_offt, to avoid taking this branch
5471 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005473 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005475 {
Hanno Becker786300f2020-02-05 10:46:40 +00005476 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005477 {
Hanno Becker786300f2020-02-05 10:46:40 +00005478 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5479 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005480 return( ret );
5481 }
5482 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005484#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005485 }
5486
5487 n = ( len < ssl->in_msglen )
5488 ? len : ssl->in_msglen;
5489
5490 memcpy( buf, ssl->in_offt, n );
5491 ssl->in_msglen -= n;
5492
gabor-mezei-arma3214132020-07-15 10:55:00 +02005493 /* Zeroising the plaintext buffer to erase unused application data
5494 from the memory. */
5495 mbedtls_platform_zeroize( ssl->in_offt, n );
5496
Paul Bakker5121ce52009-01-03 21:22:43 +00005497 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005498 {
5499 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005500 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005501 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005502 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005503 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005504 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005505 /* more data available */
5506 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005507 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005509 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005510
Paul Bakker23986e52011-04-24 08:57:21 +00005511 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005512}
5513
5514/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005515 * Send application data to be encrypted by the SSL layer, taking care of max
5516 * fragment length and buffer size.
5517 *
5518 * According to RFC 5246 Section 6.2.1:
5519 *
5520 * Zero-length fragments of Application data MAY be sent as they are
5521 * potentially useful as a traffic analysis countermeasure.
5522 *
5523 * Therefore, it is possible that the input message length is 0 and the
5524 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005525 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005526static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005527 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005528{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005529 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5530 const size_t max_len = (size_t) ret;
5531
5532 if( ret < 0 )
5533 {
5534 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5535 return( ret );
5536 }
5537
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005538 if( len > max_len )
5539 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005541 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005542 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005544 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5545 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005546 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005548 }
5549 else
5550#endif
5551 len = max_len;
5552 }
Paul Bakker887bd502011-06-08 13:10:54 +00005553
Paul Bakker5121ce52009-01-03 21:22:43 +00005554 if( ssl->out_left != 0 )
5555 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005556 /*
5557 * The user has previously tried to send the data and
5558 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5559 * written. In this case, we expect the high-level write function
5560 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005562 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005563 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005564 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005565 return( ret );
5566 }
5567 }
Paul Bakker887bd502011-06-08 13:10:54 +00005568 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005569 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005570 /*
5571 * The user is trying to send a message the first time, so we need to
5572 * copy the data into the internal buffers and setup the data structure
5573 * to keep track of partial writes
5574 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005575 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005577 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005578
Hanno Becker67bc7c32018-08-06 11:33:50 +01005579 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005581 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005582 return( ret );
5583 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005584 }
5585
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005586 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005587}
5588
5589/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005590 * Write application data (public-facing wrapper)
5591 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005592int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005593{
Janos Follath865b3eb2019-12-16 11:46:15 +00005594 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005595
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005596 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005597
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005598 if( ssl == NULL || ssl->conf == NULL )
5599 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5600
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005601#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005602 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5603 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005604 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005605 return( ret );
5606 }
5607#endif
5608
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005609 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005610 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005611 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005612 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005613 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005614 return( ret );
5615 }
5616 }
5617
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005618 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005619
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005620 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005621
5622 return( ret );
5623}
5624
5625/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005626 * Notify the peer that the connection is being closed
5627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005628int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005629{
Janos Follath865b3eb2019-12-16 11:46:15 +00005630 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005631
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005632 if( ssl == NULL || ssl->conf == NULL )
5633 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005635 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005636
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005637 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005638 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005641 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005642 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5643 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5644 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005645 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005646 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005647 return( ret );
5648 }
5649 }
5650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005652
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005653 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005654}
5655
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005656void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005657{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005658 if( transform == NULL )
5659 return;
5660
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005661#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005662 psa_destroy_key( transform->psa_key_enc );
5663 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005664#else
5665 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5666 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5667#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005668
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005669#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005670 mbedtls_md_free( &transform->md_ctx_enc );
5671 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005672#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005673
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005674 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005675}
5676
Jerry Yuc7875b52021-09-05 21:05:50 +08005677void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5678 mbedtls_ssl_transform *transform )
5679{
Jerry Yuc7875b52021-09-05 21:05:50 +08005680 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005681 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005682}
5683
5684void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5685 mbedtls_ssl_transform *transform )
5686{
5687 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005688 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005689}
5690
Hanno Becker0271f962018-08-16 13:23:47 +01005691#if defined(MBEDTLS_SSL_PROTO_DTLS)
5692
Hanno Becker533ab5f2020-02-05 10:49:13 +00005693void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005694{
5695 unsigned offset;
5696 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5697
5698 if( hs == NULL )
5699 return;
5700
Hanno Becker283f5ef2018-08-24 09:34:47 +01005701 ssl_free_buffered_record( ssl );
5702
Hanno Becker0271f962018-08-16 13:23:47 +01005703 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005704 ssl_buffering_free_slot( ssl, offset );
5705}
5706
5707static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5708 uint8_t slot )
5709{
5710 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5711 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005712
5713 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5714 return;
5715
Hanno Beckere605b192018-08-21 15:59:07 +01005716 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005717 {
Hanno Beckere605b192018-08-21 15:59:07 +01005718 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005719 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005720 mbedtls_free( hs_buf->data );
5721 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005722 }
5723}
5724
5725#endif /* MBEDTLS_SSL_PROTO_DTLS */
5726
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005727/*
5728 * Convert version numbers to/from wire format
5729 * and, for DTLS, to/from TLS equivalent.
5730 *
5731 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005732 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005733 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005735void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005736 unsigned char ver[2] )
5737{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738#if defined(MBEDTLS_SSL_PROTO_DTLS)
5739 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005740 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005741 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005742 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5743
5744 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5745 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5746 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005747 else
5748#else
5749 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005750#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005751 {
5752 ver[0] = (unsigned char) major;
5753 ver[1] = (unsigned char) minor;
5754 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005755}
5756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005757void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005758 const unsigned char ver[2] )
5759{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005760#if defined(MBEDTLS_SSL_PROTO_DTLS)
5761 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005762 {
5763 *major = 255 - ver[0] + 2;
5764 *minor = 255 - ver[1] + 1;
5765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005766 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005767 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5768 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005769 else
5770#else
5771 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005772#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005773 {
5774 *major = ver[0];
5775 *minor = ver[1];
5776 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005777}
5778
Jerry Yue7047812021-09-13 19:26:39 +08005779/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005780 * Send pending fatal alert.
5781 * 0, No alert message.
5782 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5783 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005784 */
5785int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5786{
5787 int ret;
5788
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005789 /* No pending alert, return success*/
5790 if( ssl->send_alert == 0 )
5791 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005792
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005793 ret = mbedtls_ssl_send_alert_message( ssl,
5794 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5795 ssl->alert_type );
5796
Jerry Yu3bf1f972021-09-22 21:37:18 +08005797 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5798 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005799 */
5800 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5801 {
5802 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005803 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005804
5805 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005806 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005807
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005808 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005809}
5810
Jerry Yu394ece62021-09-14 22:17:21 +08005811/*
5812 * Set pending fatal alert flag.
5813 */
5814void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5815 unsigned char alert_type,
5816 int alert_reason )
5817{
5818 ssl->send_alert = 1;
5819 ssl->alert_type = alert_type;
5820 ssl->alert_reason = alert_reason;
5821}
5822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823#endif /* MBEDTLS_SSL_TLS_C */