blob: 0e8ce6590ef79e3cc06be86f222f6fe0192a3233 [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 Stekiel1fe065b2022-01-13 15:56:33 +0100778#else
779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100780#endif /* MBEDTLS_USE_PSA_CRYPTO */
781
Paul Bakkerca4ab492012-04-18 14:23:57 +0000782
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100783 /* Check that there's space for the authentication tag. */
784 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000785 {
786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
787 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
788 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000789
Paul Bakker68884e32013-01-07 18:20:04 +0100790 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100791 * Build nonce for AEAD encryption.
792 *
793 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
794 * part of the IV is prepended to the ciphertext and
795 * can be chosen freely - in particular, it need not
796 * agree with the record sequence number.
797 * However, since ChaChaPoly as well as all AEAD modes
798 * in TLS 1.3 use the record sequence number as the
799 * dynamic part of the nonce, we uniformly use the
800 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100801 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100802 dynamic_iv = rec->ctr;
803 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200804
Hanno Becker17263802020-05-28 07:05:48 +0100805 ssl_build_record_nonce( iv, sizeof( iv ),
806 transform->iv_enc,
807 transform->fixed_ivlen,
808 dynamic_iv,
809 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100810
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100811 /*
812 * Build additional data for AEAD encryption.
813 * This depends on the TLS version.
814 */
815 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000816 transform->minor_ver,
817 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100818
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200819 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100820 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200821 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100822 dynamic_iv,
823 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000824 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100825 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000826 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200827 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000829
Paul Bakker68884e32013-01-07 18:20:04 +0100830 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200831 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200832 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100833#if defined(MBEDTLS_USE_PSA_CRYPTO)
834 status = psa_aead_encrypt( transform->psa_key_enc,
835 transform->psa_alg,
836 iv, transform->ivlen,
837 add_data, add_data_len,
838 data, rec->data_len,
839 data, rec->buf_len - (data - rec->buf),
840 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000841
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100842 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +0100843 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100844#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100845 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100847 add_data, add_data_len,
848 data, rec->data_len, /* src */
849 data, rec->buf_len - (data - rec->buf), /* dst */
850 &rec->data_len,
851 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200852 {
TRodziewicz18efb732021-04-29 23:12:19 +0200853 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200854 return( ret );
855 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100856#endif /* MBEDTLS_USE_PSA_CRYPTO */
857
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000858 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100859 data + rec->data_len - transform->taglen,
860 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100861 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000862 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100863
864 /*
865 * Prefix record content with dynamic IV in case it is explicit.
866 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100867 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100868 {
869 if( rec->data_offset < dynamic_iv_len )
870 {
871 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
872 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
873 }
874
875 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
876 rec->data_offset -= dynamic_iv_len;
877 rec->data_len += dynamic_iv_len;
878 }
879
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100880 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000881 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000882 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100883#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200884#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100885#if defined(MBEDTLS_USE_PSA_CRYPTO)
886 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
887#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100889#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000890 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000892 size_t padlen, i;
893 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100894#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100895 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100896 size_t part_len;
897 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
898#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000899
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000900 /* Currently we're always using minimal padding
901 * (up to 255 bytes would be allowed). */
902 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
903 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000904 padlen = 0;
905
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000906 /* Check there's enough space in the buffer for the padding. */
907 if( post_avail < padlen + 1 )
908 {
909 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
910 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
911 }
912
Paul Bakker5121ce52009-01-03 21:22:43 +0000913 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000914 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000915
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916 rec->data_len += padlen + 1;
917 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000918
TRodziewicz0f82ec62021-05-12 17:49:18 +0200919#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000920 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200921 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000922 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000923 */
TRodziewicz345165c2021-07-06 13:42:11 +0200924 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000925 {
TRodziewicz345165c2021-07-06 13:42:11 +0200926 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
927 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000928 }
TRodziewicz345165c2021-07-06 13:42:11 +0200929
930 if( rec->data_offset < transform->ivlen )
931 {
932 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
933 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
934 }
935
936 /*
937 * Generate IV
938 */
939 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
940 if( ret != 0 )
941 return( ret );
942
943 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200944#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000945
Paul Elliottd48d5c62021-01-07 14:47:05 +0000946 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
947 "including %" MBEDTLS_PRINTF_SIZET
948 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000949 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200950 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000951
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100952#if defined(MBEDTLS_USE_PSA_CRYPTO)
953 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100954 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100955
956 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +0100957 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100958
959 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
960
961 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +0100962 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100963
964 status = psa_cipher_update( &cipher_op,
965 data, rec->data_len,
966 data, rec->data_len, &olen );
967
968 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +0100969 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100970
971 status = psa_cipher_finish( &cipher_op,
972 data + olen, rec->data_len - olen,
973 &part_len );
974
975 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +0100976 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100977
978 olen += part_len;
979#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
981 transform->iv_enc,
982 transform->ivlen,
983 data, rec->data_len,
984 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200985 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200987 return( ret );
988 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100989#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200990
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000991 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
994 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200995 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200996
TRodziewicz0f82ec62021-05-12 17:49:18 +0200997 data -= transform->ivlen;
998 rec->data_offset -= transform->ivlen;
999 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001002 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001003 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001004 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1005
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001006 /*
1007 * MAC(MAC_write_key, seq_num +
1008 * TLSCipherText.type +
1009 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001010 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001011 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001012 * ENC(content + padding + padding_length));
1013 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001014
1015 if( post_avail < transform->maclen)
1016 {
1017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1018 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1019 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001020
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001021 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001022 rec, transform->minor_ver,
1023 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001026 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001027 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001028
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001029 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1030 add_data_len );
1031 if( ret != 0 )
1032 goto hmac_failed_etm_enabled;
1033 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1034 data, rec->data_len );
1035 if( ret != 0 )
1036 goto hmac_failed_etm_enabled;
1037 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1038 if( ret != 0 )
1039 goto hmac_failed_etm_enabled;
1040 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1041 if( ret != 0 )
1042 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001043
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001044 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001045
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001046 rec->data_len += transform->maclen;
1047 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001048 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001049
1050 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001051 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001052 if( ret != 0 )
1053 {
1054 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1055 return( ret );
1056 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001057 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001059 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001060 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001061#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001062 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1064 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001065 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001066
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001067 /* Make extra sure authentication was performed, exactly once */
1068 if( auth_done != 1 )
1069 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1071 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001072 }
1073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001075
1076 return( 0 );
1077}
1078
Hanno Becker605949f2019-07-12 08:23:59 +01001079int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001080 mbedtls_ssl_transform *transform,
1081 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001082{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001083 size_t olen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001084#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 mbedtls_cipher_mode_t mode;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001086#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001087#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1088 int ret;
1089#endif
1090 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001091#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001092 size_t padlen = 0, correct = 1;
1093#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001094 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001095 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001096 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001097
Hanno Beckera18d1322018-01-03 14:27:32 +00001098#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001099 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001100 ((void) ssl);
1101#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001104 if( rec == NULL ||
1105 rec->buf == NULL ||
1106 rec->buf_len < rec->data_offset ||
1107 rec->buf_len - rec->data_offset < rec->data_len )
1108 {
1109 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001111 }
1112
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001113 data = rec->buf + rec->data_offset;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001114#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001115 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001116#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001117
Hanno Beckera0e20d02019-05-15 14:03:01 +01001118#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001119 /*
1120 * Match record's CID with incoming CID.
1121 */
Hanno Becker938489a2019-05-08 13:02:22 +01001122 if( rec->cid_len != transform->in_cid_len ||
1123 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1124 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001125 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001126 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001127#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001128
Hanno Beckerd086bf02021-03-22 13:01:27 +00001129#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001130#if defined(MBEDTLS_USE_PSA_CRYPTO)
1131 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
1132#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001134#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker68884e32013-01-07 18:20:04 +01001135 {
1136 padlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001137
1138#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001139 /* The only stream "cipher" we support is "NULL" */
1140 if ( transform->psa_alg != MBEDTLS_SSL_NULL_CIPHER )
1141 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001142
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001143 olen = rec->data_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001144#else
1145
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001146 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1147 transform->iv_dec,
1148 transform->ivlen,
1149 data, rec->data_len,
1150 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001151 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001153 return( ret );
1154 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001155#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001156
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001157 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001158 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1160 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001161 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001162
Paul Bakker5121ce52009-01-03 21:22:43 +00001163 }
Paul Bakker68884e32013-01-07 18:20:04 +01001164 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001165#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001166#if defined(MBEDTLS_GCM_C) || \
1167 defined(MBEDTLS_CCM_C) || \
1168 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001169#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +01001170 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001171#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001173 mode == MBEDTLS_MODE_CCM ||
1174 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001175#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001176 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001177 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001178 unsigned char *dynamic_iv;
1179 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001180#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001182#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001183
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001184 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001185 * Extract dynamic part of nonce for AEAD decryption.
1186 *
1187 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1188 * part of the IV is prepended to the ciphertext and
1189 * can be chosen freely - in particular, it need not
1190 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001191 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001192 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001193 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001194 {
1195 if( rec->data_len < dynamic_iv_len )
1196 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001197 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1198 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001199 rec->data_len,
1200 dynamic_iv_len ) );
1201 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1202 }
1203 dynamic_iv = data;
1204
1205 data += dynamic_iv_len;
1206 rec->data_offset += dynamic_iv_len;
1207 rec->data_len -= dynamic_iv_len;
1208 }
Hanno Becker17263802020-05-28 07:05:48 +01001209 else
1210 {
1211 dynamic_iv = rec->ctr;
1212 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001213
1214 /* Check that there's space for the authentication tag. */
1215 if( rec->data_len < transform->taglen )
1216 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001217 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1218 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001219 rec->data_len,
1220 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001222 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001223 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001224
Hanno Beckerdf8be222020-05-21 15:30:57 +01001225 /*
1226 * Prepare nonce from dynamic and static parts.
1227 */
Hanno Becker17263802020-05-28 07:05:48 +01001228 ssl_build_record_nonce( iv, sizeof( iv ),
1229 transform->iv_dec,
1230 transform->fixed_ivlen,
1231 dynamic_iv,
1232 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001233
Hanno Beckerdf8be222020-05-21 15:30:57 +01001234 /*
1235 * Build additional data for AEAD encryption.
1236 * This depends on the TLS version.
1237 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001238 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001239 transform->minor_ver,
1240 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001241 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001242 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001243
Hanno Beckerd96a6522019-07-10 13:55:25 +01001244 /* Because of the check above, we know that there are
1245 * explicit_iv_len Bytes preceeding data, and taglen
1246 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001247 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001248 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001249
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001250 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001251 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001252 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001253
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001254 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001255 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001256 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001257#if defined(MBEDTLS_USE_PSA_CRYPTO)
1258 status = psa_aead_decrypt( transform->psa_key_dec,
1259 transform->psa_alg,
1260 iv, transform->ivlen,
1261 add_data, add_data_len,
1262 data, rec->data_len + transform->taglen,
1263 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001264 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001265
1266 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001267 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001268#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001269 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001270 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001271 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001272 data, rec->data_len + transform->taglen, /* src */
1273 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001274 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001275 {
TRodziewicz18efb732021-04-29 23:12:19 +02001276 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1279 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001280
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001281 return( ret );
1282 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001283#endif /* MBEDTLS_USE_PSA_CRYPTO */
1284
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001285 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001286
Hanno Beckerd96a6522019-07-10 13:55:25 +01001287 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001288 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001289 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1291 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001292 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001293 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001294 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001296#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001297#if defined(MBEDTLS_USE_PSA_CRYPTO)
1298 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
1299#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001301#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001302 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001303 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001304#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001305 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001306 size_t part_len;
1307 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1308#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001309
Paul Bakker5121ce52009-01-03 21:22:43 +00001310 /*
Paul Bakker45829992013-01-03 14:52:21 +01001311 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001312 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001313#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001314 /* The ciphertext is prefixed with the CBC IV. */
1315 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001316#endif
Paul Bakker45829992013-01-03 14:52:21 +01001317
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001318 /* Size considerations:
1319 *
1320 * - The CBC cipher text must not be empty and hence
1321 * at least of size transform->ivlen.
1322 *
1323 * Together with the potential IV-prefix, this explains
1324 * the first of the two checks below.
1325 *
1326 * - The record must contain a MAC, either in plain or
1327 * encrypted, depending on whether Encrypt-then-MAC
1328 * is used or not.
1329 * - If it is, the message contains the IV-prefix,
1330 * the CBC ciphertext, and the MAC.
1331 * - If it is not, the padded plaintext, and hence
1332 * the CBC ciphertext, has at least length maclen + 1
1333 * because there is at least the padding length byte.
1334 *
1335 * As the CBC ciphertext is not empty, both cases give the
1336 * lower bound minlen + maclen + 1 on the record size, which
1337 * we test for in the second check below.
1338 */
1339 if( rec->data_len < minlen + transform->ivlen ||
1340 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001341 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1343 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1344 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001345 "+ 1 ) ( + expl IV )", rec->data_len,
1346 transform->ivlen,
1347 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001349 }
1350
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001351 /*
1352 * Authenticate before decrypt if enabled
1353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001355 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001356 {
Hanno Becker992b6872017-11-09 18:57:39 +00001357 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001360
Hanno Beckerd96a6522019-07-10 13:55:25 +01001361 /* Update data_len in tandem with add_data.
1362 *
1363 * The subtraction is safe because of the previous check
1364 * data_len >= minlen + maclen + 1.
1365 *
1366 * Afterwards, we know that data + data_len is followed by at
1367 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001368 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001369 *
1370 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001371 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001372 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001373 transform->minor_ver,
1374 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001375
Hanno Beckerd96a6522019-07-10 13:55:25 +01001376 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001377 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1378 add_data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001379 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1380 add_data_len );
1381 if( ret != 0 )
1382 goto hmac_failed_etm_enabled;
1383 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001384 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001385 if( ret != 0 )
1386 goto hmac_failed_etm_enabled;
1387 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1388 if( ret != 0 )
1389 goto hmac_failed_etm_enabled;
1390 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1391 if( ret != 0 )
1392 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001393
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001394 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1395 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001396 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001397 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001398
Hanno Beckerd96a6522019-07-10 13:55:25 +01001399 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001400 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001401 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001403 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001404 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1405 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001406 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001407 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001408
1409 hmac_failed_etm_enabled:
1410 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1411 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001412 {
1413 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1414 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001415 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001416 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001417 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001418#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001419
1420 /*
1421 * Check length sanity
1422 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001423
1424 /* We know from above that data_len > minlen >= 0,
1425 * so the following check in particular implies that
1426 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001427 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001428 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001429 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1430 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001431 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001433 }
1434
TRodziewicz0f82ec62021-05-12 17:49:18 +02001435#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001436 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001437 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001438 */
TRodziewicz345165c2021-07-06 13:42:11 +02001439 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1440 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001441
TRodziewicz345165c2021-07-06 13:42:11 +02001442 data += transform->ivlen;
1443 rec->data_offset += transform->ivlen;
1444 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001445#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001446
Hanno Beckerd96a6522019-07-10 13:55:25 +01001447 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1448
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001449#if defined(MBEDTLS_USE_PSA_CRYPTO)
1450 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001451 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001452
1453 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001454 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001455
1456 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1457
1458 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001459 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001460
1461 status = psa_cipher_update( &cipher_op,
1462 data, rec->data_len,
1463 data, rec->data_len, &olen );
1464
1465 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001466 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001467
1468 status = psa_cipher_finish( &cipher_op,
1469 data + olen, rec->data_len - olen,
1470 &part_len );
1471
1472 if( status != PSA_SUCCESS )
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01001473 return( psa_ssl_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001474
1475 olen += part_len;
1476#else
1477
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001478 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1479 transform->iv_dec, transform->ivlen,
1480 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001481 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001483 return( ret );
1484 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001485#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001486
Hanno Beckerd96a6522019-07-10 13:55:25 +01001487 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001488 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001489 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1491 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001492 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001493
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 /* Safe since data_len >= minlen + maclen + 1, so after having
1495 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001496 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1497 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001498 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001499
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 if( auth_done == 1 )
1501 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001502 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001503 rec->data_len,
1504 padlen + 1 );
1505 correct &= mask;
1506 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001507 }
1508 else
Paul Bakker45829992013-01-03 14:52:21 +01001509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001511 if( rec->data_len < transform->maclen + padlen + 1 )
1512 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1514 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1515 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001516 rec->data_len,
1517 transform->maclen,
1518 padlen + 1 ) );
1519 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001520#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521
Gabor Mezei90437e32021-10-20 11:59:27 +02001522 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001523 rec->data_len,
1524 transform->maclen + padlen + 1 );
1525 correct &= mask;
1526 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001527 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001528
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001529 padlen++;
1530
1531 /* Regardless of the validity of the padding,
1532 * we have data_len >= padlen here. */
1533
TRodziewicz0f82ec62021-05-12 17:49:18 +02001534#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001535 /* The padding check involves a series of up to 256
1536 * consecutive memory reads at the end of the record
1537 * plaintext buffer. In order to hide the length and
1538 * validity of the padding, always perform exactly
1539 * `min(256,plaintext_len)` reads (but take into account
1540 * only the last `padlen` bytes for the padding check). */
1541 size_t pad_count = 0;
1542 volatile unsigned char* const check = data;
1543
1544 /* Index of first padding byte; it has been ensured above
1545 * that the subtraction is safe. */
1546 size_t const padding_idx = rec->data_len - padlen;
1547 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1548 size_t const start_idx = rec->data_len - num_checks;
1549 size_t idx;
1550
1551 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001552 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001553 /* pad_count += (idx >= padding_idx) &&
1554 * (check[idx] == padlen - 1);
1555 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001556 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1557 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001558 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001559 pad_count += mask & equal;
1560 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001561 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001564 if( padlen > 0 && correct == 0 )
1565 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001566#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001567 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001568
TRodziewicz0f82ec62021-05-12 17:49:18 +02001569#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001570
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001571 /* If the padding was found to be invalid, padlen == 0
1572 * and the subtraction is safe. If the padding was found valid,
1573 * padlen hasn't been changed and the previous assertion
1574 * data_len >= padlen still holds. */
1575 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001576 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001577 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001578#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001579 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1581 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001582 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001583
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001584#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001586 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001587#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001588
1589 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001590 * Authenticate if not done yet.
1591 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001592 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001593#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001594 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001595 {
Hanno Becker992b6872017-11-09 18:57:39 +00001596 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001597 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001598
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001599 /* If the initial value of padlen was such that
1600 * data_len < maclen + padlen + 1, then padlen
1601 * got reset to 1, and the initial check
1602 * data_len >= minlen + maclen + 1
1603 * guarantees that at this point we still
1604 * have at least data_len >= maclen.
1605 *
1606 * If the initial value of padlen was such that
1607 * data_len >= maclen + padlen + 1, then we have
1608 * subtracted either padlen + 1 (if the padding was correct)
1609 * or 0 (if the padding was incorrect) since then,
1610 * hence data_len >= maclen in any case.
1611 */
1612 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001613 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001614 transform->minor_ver,
1615 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001616
TRodziewicz0f82ec62021-05-12 17:49:18 +02001617#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001618 /*
1619 * The next two sizes are the minimum and maximum values of
1620 * data_len over all padlen values.
1621 *
1622 * They're independent of padlen, since we previously did
1623 * data_len -= padlen.
1624 *
1625 * Note that max_len + maclen is never more than the buffer
1626 * length, as we previously did in_msglen -= maclen too.
1627 */
1628 const size_t max_len = rec->data_len + padlen;
1629 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1630
Gabor Mezei90437e32021-10-20 11:59:27 +02001631 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001632 add_data, add_data_len,
1633 data, rec->data_len, min_len, max_len,
1634 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001635 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001636 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001637 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001638 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001639 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001640
Gabor Mezei90437e32021-10-20 11:59:27 +02001641 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001642 rec->data_len,
1643 min_len, max_len,
1644 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001645#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001646
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001647#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001648 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001649 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001650#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001651
Gabor Mezei90437e32021-10-20 11:59:27 +02001652 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001653 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001654 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#if defined(MBEDTLS_SSL_DEBUG_ALL)
1656 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001657#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001658 correct = 0;
1659 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001660 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001661
1662 hmac_failed_etm_disabled:
1663 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1664 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1665 if( ret != 0 )
1666 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001667 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001668
1669 /*
1670 * Finally check the correct flag
1671 */
1672 if( correct == 0 )
1673 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001674#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001675
1676 /* Make extra sure authentication was performed, exactly once */
1677 if( auth_done != 1 )
1678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1680 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001681 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001682
Ronald Cron6f135e12021-12-08 16:57:54 +01001683#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001684 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1685 {
1686 /* Remove inner padding and infer true content type. */
1687 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1688 &rec->type );
1689
1690 if( ret != 0 )
1691 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1692 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001693#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001694
Hanno Beckera0e20d02019-05-15 14:03:01 +01001695#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001696 if( rec->cid_len != 0 )
1697 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001698 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1699 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001700 if( ret != 0 )
1701 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1702 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001703#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001706
1707 return( 0 );
1708}
1709
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001710#undef MAC_NONE
1711#undef MAC_PLAINTEXT
1712#undef MAC_CIPHERTEXT
1713
Paul Bakker5121ce52009-01-03 21:22:43 +00001714/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001715 * Fill the input message buffer by appending data to it.
1716 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001717 *
1718 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1719 * available (from this read and/or a previous one). Otherwise, an error code
1720 * is returned (possibly EOF or WANT_READ).
1721 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001722 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1723 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1724 * since we always read a whole datagram at once.
1725 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001726 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001727 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Janos Follath865b3eb2019-12-16 11:46:15 +00001731 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001732 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001733#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1734 size_t in_buf_len = ssl->in_buf_len;
1735#else
1736 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1737#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001738
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001740
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001741 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1742 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001744 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001746 }
1747
Darryl Greenb33cc762019-11-28 14:29:44 +00001748 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001749 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1751 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001752 }
1753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001755 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001756 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001757 uint32_t timeout;
1758
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001759 /*
1760 * The point is, we need to always read a full datagram at once, so we
1761 * sometimes read more then requested, and handle the additional data.
1762 * It could be the rest of the current record (while fetching the
1763 * header) and/or some other records in the same datagram.
1764 */
1765
1766 /*
1767 * Move to the next record in the already read datagram if applicable
1768 */
1769 if( ssl->next_record_offset != 0 )
1770 {
1771 if( ssl->in_left < ssl->next_record_offset )
1772 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1774 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001775 }
1776
1777 ssl->in_left -= ssl->next_record_offset;
1778
1779 if( ssl->in_left != 0 )
1780 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001781 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1782 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001783 ssl->next_record_offset ) );
1784 memmove( ssl->in_hdr,
1785 ssl->in_hdr + ssl->next_record_offset,
1786 ssl->in_left );
1787 }
1788
1789 ssl->next_record_offset = 0;
1790 }
1791
Paul Elliottd48d5c62021-01-07 14:47:05 +00001792 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1793 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001794 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001795
1796 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001797 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001798 */
1799 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001800 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001802 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001803 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001804
1805 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001806 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001807 * are not at the beginning of a new record, the caller did something
1808 * wrong.
1809 */
1810 if( ssl->in_left != 0 )
1811 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1813 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001814 }
1815
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001816 /*
1817 * Don't even try to read if time's out already.
1818 * This avoids by-passing the timer when repeatedly receiving messages
1819 * that will end up being dropped.
1820 */
Hanno Becker7876d122020-02-05 10:39:31 +00001821 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001822 {
1823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001824 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001825 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001826 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001827 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001828 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001829
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001831 timeout = ssl->handshake->retransmit_timeout;
1832 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001833 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001834
Paul Elliott9f352112020-12-09 14:55:45 +00001835 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001836
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001837 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001838 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1839 timeout );
1840 else
1841 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001843 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001844
1845 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001847 }
1848
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001849 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001850 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001852 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001854 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001855 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001856 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1857 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001859 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001860 }
1861
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001865 return( ret );
1866 }
1867
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001868 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001869 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001871 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001873 {
Hanno Becker786300f2020-02-05 10:46:40 +00001874 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001875 {
Hanno Becker786300f2020-02-05 10:46:40 +00001876 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1877 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001878 return( ret );
1879 }
1880
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001881 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001882 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001884 }
1885
Paul Bakker5121ce52009-01-03 21:22:43 +00001886 if( ret < 0 )
1887 return( ret );
1888
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001889 ssl->in_left = ret;
1890 }
1891 else
1892#endif
1893 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1895 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001896 ssl->in_left, nb_want ) );
1897
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001898 while( ssl->in_left < nb_want )
1899 {
1900 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001901
Hanno Becker7876d122020-02-05 10:39:31 +00001902 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001903 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1904 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001905 {
1906 if( ssl->f_recv_timeout != NULL )
1907 {
1908 ret = ssl->f_recv_timeout( ssl->p_bio,
1909 ssl->in_hdr + ssl->in_left, len,
1910 ssl->conf->read_timeout );
1911 }
1912 else
1913 {
1914 ret = ssl->f_recv( ssl->p_bio,
1915 ssl->in_hdr + ssl->in_left, len );
1916 }
1917 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001918
Paul Elliottd48d5c62021-01-07 14:47:05 +00001919 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1920 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001921 ssl->in_left, nb_want ) );
1922 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001923
1924 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001926
1927 if( ret < 0 )
1928 return( ret );
1929
makise-homuraaf9513b2020-08-24 18:26:27 +03001930 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001931 {
Darryl Green11999bb2018-03-13 15:22:58 +00001932 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001933 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001934 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001935 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1936 }
1937
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001938 ssl->in_left += ret;
1939 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001940 }
1941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001943
1944 return( 0 );
1945}
1946
1947/*
1948 * Flush any data not yet written
1949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001951{
Janos Follath865b3eb2019-12-16 11:46:15 +00001952 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001953 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001956
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001957 if( ssl->f_send == NULL )
1958 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001960 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001962 }
1963
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001964 /* Avoid incrementing counter if data is flushed */
1965 if( ssl->out_left == 0 )
1966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001968 return( 0 );
1969 }
1970
Paul Bakker5121ce52009-01-03 21:22:43 +00001971 while( ssl->out_left > 0 )
1972 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1974 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001975 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001976
Hanno Becker2b1e3542018-08-06 11:19:13 +01001977 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001978 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001981
1982 if( ret <= 0 )
1983 return( ret );
1984
makise-homuraaf9513b2020-08-24 18:26:27 +03001985 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001986 {
Darryl Green11999bb2018-03-13 15:22:58 +00001987 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001988 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001989 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001990 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1991 }
1992
Paul Bakker5121ce52009-01-03 21:22:43 +00001993 ssl->out_left -= ret;
1994 }
1995
Hanno Becker2b1e3542018-08-06 11:19:13 +01001996#if defined(MBEDTLS_SSL_PROTO_DTLS)
1997 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001998 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001999 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002000 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002001 else
2002#endif
2003 {
2004 ssl->out_hdr = ssl->out_buf + 8;
2005 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002006 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002009
2010 return( 0 );
2011}
2012
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002013/*
2014 * Functions to handle the DTLS retransmission state machine
2015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002017/*
2018 * Append current handshake message to current outgoing flight
2019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002021{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2024 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2025 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002026
2027 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002028 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002029 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002030 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002032 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002033 }
2034
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002035 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2038 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002040 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002041 }
2042
2043 /* Copy current handshake message with headers */
2044 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2045 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002046 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002047 msg->next = NULL;
2048
2049 /* Append to the current flight */
2050 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002051 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002052 else
2053 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002055 while( cur->next != NULL )
2056 cur = cur->next;
2057 cur->next = msg;
2058 }
2059
Hanno Becker3b235902018-08-06 09:54:53 +01002060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002061 return( 0 );
2062}
2063
2064/*
2065 * Free the current flight of handshake messages
2066 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002067void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002068{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 mbedtls_ssl_flight_item *cur = flight;
2070 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002071
2072 while( cur != NULL )
2073 {
2074 next = cur->next;
2075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 mbedtls_free( cur->p );
2077 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078
2079 cur = next;
2080 }
2081}
2082
2083/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002084 * Swap transform_out and out_ctr with the alternative ones
2085 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002086static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002087{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002089 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002090
2091 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2092 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002094 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002095 }
2096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002098
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002099 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002100 tmp_transform = ssl->transform_out;
2101 ssl->transform_out = ssl->handshake->alt_transform_out;
2102 ssl->handshake->alt_transform_out = tmp_transform;
2103
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002104 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002105 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2106 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2107 sizeof( ssl->cur_out_ctr ) );
2108 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2109 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002110
2111 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002112 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002113
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002114 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002115}
2116
2117/*
2118 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002119 */
2120int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2121{
2122 int ret = 0;
2123
2124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2125
2126 ret = mbedtls_ssl_flight_transmit( ssl );
2127
2128 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2129
2130 return( ret );
2131}
2132
2133/*
2134 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002135 *
2136 * Need to remember the current message in case flush_output returns
2137 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002138 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002139 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002140int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002141{
Janos Follath865b3eb2019-12-16 11:46:15 +00002142 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002146 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002147 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002148
2149 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002150 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002151 ret = ssl_swap_epochs( ssl );
2152 if( ret != 0 )
2153 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002156 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002157
2158 while( ssl->handshake->cur_msg != NULL )
2159 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002160 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002161 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002162
Hanno Beckere1dcb032018-08-17 16:47:58 +01002163 int const is_finished =
2164 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2165 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2166
Hanno Becker04da1892018-08-14 13:22:10 +01002167 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2168 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2169
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002170 /* Swap epochs before sending Finished: we can't do it after
2171 * sending ChangeCipherSpec, in case write returns WANT_READ.
2172 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002173 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002174 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002175 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002176 ret = ssl_swap_epochs( ssl );
2177 if( ret != 0 )
2178 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002179 }
2180
Hanno Becker67bc7c32018-08-06 11:33:50 +01002181 ret = ssl_get_remaining_payload_in_datagram( ssl );
2182 if( ret < 0 )
2183 return( ret );
2184 max_frag_len = (size_t) ret;
2185
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002186 /* CCS is copied as is, while HS messages may need fragmentation */
2187 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2188 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002189 if( max_frag_len == 0 )
2190 {
2191 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2192 return( ret );
2193
2194 continue;
2195 }
2196
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002197 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002198 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002199 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002200
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002201 /* Update position inside current message */
2202 ssl->handshake->cur_msg_p += cur->len;
2203 }
2204 else
2205 {
2206 const unsigned char * const p = ssl->handshake->cur_msg_p;
2207 const size_t hs_len = cur->len - 12;
2208 const size_t frag_off = p - ( cur->p + 12 );
2209 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002210 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002211
Hanno Beckere1dcb032018-08-17 16:47:58 +01002212 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002213 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002214 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002215 {
2216 ret = ssl_swap_epochs( ssl );
2217 if( ret != 0 )
2218 return( ret );
2219 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002220
Hanno Becker67bc7c32018-08-06 11:33:50 +01002221 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2222 return( ret );
2223
2224 continue;
2225 }
2226 max_hs_frag_len = max_frag_len - 12;
2227
2228 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2229 max_hs_frag_len : rem_len;
2230
2231 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002232 {
2233 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002234 (unsigned) cur_hs_frag_len,
2235 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002236 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002237
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002238 /* Messages are stored with handshake headers as if not fragmented,
2239 * copy beginning of headers then fill fragmentation fields.
2240 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2241 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002242
Joe Subbiani5ecac212021-06-24 13:00:03 +01002243 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2244 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2245 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002246
Joe Subbiani5ecac212021-06-24 13:00:03 +01002247 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2248 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2249 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002250
2251 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2252
Hanno Becker3f7b9732018-08-28 09:53:25 +01002253 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002254 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2255 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002256 ssl->out_msgtype = cur->type;
2257
2258 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002259 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002260 }
2261
2262 /* If done with the current message move to the next one if any */
2263 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2264 {
2265 if( cur->next != NULL )
2266 {
2267 ssl->handshake->cur_msg = cur->next;
2268 ssl->handshake->cur_msg_p = cur->next->p + 12;
2269 }
2270 else
2271 {
2272 ssl->handshake->cur_msg = NULL;
2273 ssl->handshake->cur_msg_p = NULL;
2274 }
2275 }
2276
2277 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002278 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002279 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002281 return( ret );
2282 }
2283 }
2284
Hanno Becker67bc7c32018-08-06 11:33:50 +01002285 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2286 return( ret );
2287
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002288 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2290 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002291 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002292 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002294 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002295 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002296
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002297 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002298
2299 return( 0 );
2300}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002301
2302/*
2303 * To be called when the last message of an incoming flight is received.
2304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002306{
2307 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002308 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002309 ssl->handshake->flight = NULL;
2310 ssl->handshake->cur_msg = NULL;
2311
2312 /* The next incoming flight will start with this msg_seq */
2313 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2314
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002315 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002316 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002317
Hanno Becker0271f962018-08-16 13:23:47 +01002318 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002319 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002320
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002321 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002322 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2325 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002326 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002328 }
2329 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002330 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002331}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002332
2333/*
2334 * To be called when the last message of an outgoing flight is send.
2335 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002337{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002338 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002339 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2342 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002343 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002345 }
2346 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002348}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002350
Paul Bakker5121ce52009-01-03 21:22:43 +00002351/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002352 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002353 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002354
2355/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002356 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002357 *
2358 * - fill in handshake headers
2359 * - update handshake checksum
2360 * - DTLS: save message for resending
2361 * - then pass to the record layer
2362 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002363 * DTLS: except for HelloRequest, messages are only queued, and will only be
2364 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002365 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002366 * Inputs:
2367 * - ssl->out_msglen: 4 + actual handshake message len
2368 * (4 is the size of handshake headers for TLS)
2369 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2370 * - ssl->out_msg + 4: the handshake message body
2371 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002372 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002373 * - ssl->out_msglen: the length of the record contents
2374 * (including handshake headers but excluding record headers)
2375 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002376 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002377int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2378 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002379{
Janos Follath865b3eb2019-12-16 11:46:15 +00002380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002381 const size_t hs_len = ssl->out_msglen - 4;
2382 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002383
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002384 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2385
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002386 /*
2387 * Sanity checks
2388 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002389 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002390 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2391 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002392 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2393 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002394 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002395
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002396 /* Whenever we send anything different from a
2397 * HelloRequest we should be in a handshake - double check. */
2398 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2399 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002400 ssl->handshake == NULL )
2401 {
2402 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2403 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2404 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002407 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002408 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002410 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002411 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2412 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002413 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002414#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002415
Hanno Beckerb50a2532018-08-06 11:52:54 +01002416 /* Double-check that we did not exceed the bounds
2417 * of the outgoing record buffer.
2418 * This should never fail as the various message
2419 * writing functions must obey the bounds of the
2420 * outgoing record buffer, but better be safe.
2421 *
2422 * Note: We deliberately do not check for the MTU or MFL here.
2423 */
2424 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2425 {
2426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002427 "size %" MBEDTLS_PRINTF_SIZET
2428 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002429 ssl->out_msglen,
2430 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002431 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2432 }
2433
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002434 /*
2435 * Fill handshake headers
2436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002438 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002439 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2440 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2441 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002442
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002443 /*
2444 * DTLS has additional fields in the Handshake layer,
2445 * between the length field and the actual payload:
2446 * uint16 message_seq;
2447 * uint24 fragment_offset;
2448 * uint24 fragment_length;
2449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002451 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002452 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002453 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002454 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002455 {
2456 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002457 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002458 hs_len,
2459 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002460 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2461 }
2462
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002463 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002464 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002465
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002466 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002467 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002468 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002469 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002470 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002471 }
2472 else
2473 {
2474 ssl->out_msg[4] = 0;
2475 ssl->out_msg[5] = 0;
2476 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002477
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002478 /* Handshake hashes are computed without fragmentation,
2479 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002480 memset( ssl->out_msg + 6, 0x00, 3 );
2481 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002482 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002483#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002484
Hanno Becker0207e532018-08-28 10:28:28 +01002485 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002486 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002487 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002488 }
2489
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002490 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002492 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002493 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2494 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002495 {
2496 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002499 return( ret );
2500 }
2501 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002502 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002503#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002504 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002505 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002506 {
2507 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2508 return( ret );
2509 }
2510 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002511
2512 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2513
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002514 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002515}
2516
2517/*
2518 * Record layer functions
2519 */
2520
2521/*
2522 * Write current record.
2523 *
2524 * Uses:
2525 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2526 * - ssl->out_msglen: length of the record content (excl headers)
2527 * - ssl->out_msg: record content
2528 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002529int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002530{
2531 int ret, done = 0;
2532 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002533 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002534
2535 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002536
Paul Bakker05ef8352012-05-08 09:17:57 +00002537 if( !done )
2538 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002539 unsigned i;
2540 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002541#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2542 size_t out_buf_len = ssl->out_buf_len;
2543#else
2544 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2545#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002546 /* Skip writing the record content type to after the encryption,
2547 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002548 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002549#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002550 /* TLS 1.3 still uses the TLS 1.2 version identifier
2551 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002552 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2553 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002554#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002555 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2556 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002557
Jerry Yuae0b2e22021-10-08 15:21:19 +08002558 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002559 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002560
Paul Bakker48916f92012-09-16 19:57:18 +00002561 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002562 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002563 mbedtls_record rec;
2564
2565 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002566 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002567 rec.data_len = ssl->out_msglen;
2568 rec.data_offset = ssl->out_msg - rec.buf;
2569
Jerry Yud96a5c22021-09-29 17:46:51 +08002570 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002571 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002572 ssl->conf->transport, rec.ver );
2573 rec.type = ssl->out_msgtype;
2574
Hanno Beckera0e20d02019-05-15 14:03:01 +01002575#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002576 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002577 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002578#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002579
Hanno Beckera18d1322018-01-03 14:27:32 +00002580 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002581 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002582 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002584 return( ret );
2585 }
2586
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002587 if( rec.data_offset != 0 )
2588 {
2589 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2590 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2591 }
2592
Hanno Becker6430faf2019-05-08 11:57:13 +01002593 /* Update the record content type and CID. */
2594 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002595#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002596 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002597#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002598 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002599 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002600 }
2601
Hanno Becker5903de42019-05-03 14:46:38 +01002602 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002603
2604#if defined(MBEDTLS_SSL_PROTO_DTLS)
2605 /* In case of DTLS, double-check that we don't exceed
2606 * the remaining space in the datagram. */
2607 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2608 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002609 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002610 if( ret < 0 )
2611 return( ret );
2612
2613 if( protected_record_size > (size_t) ret )
2614 {
2615 /* Should never happen */
2616 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2617 }
2618 }
2619#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002620
Hanno Becker6430faf2019-05-08 11:57:13 +01002621 /* Now write the potentially updated record content type. */
2622 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2623
Paul Elliott9f352112020-12-09 14:55:45 +00002624 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002625 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002626 ssl->out_hdr[0], ssl->out_hdr[1],
2627 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002630 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002631
2632 ssl->out_left += protected_record_size;
2633 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002634 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002635
Hanno Beckerdd772292020-02-05 10:38:31 +00002636 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002637 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2638 break;
2639
2640 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002641 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002642 {
2643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2644 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2645 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002646 }
2647
Hanno Becker67bc7c32018-08-06 11:33:50 +01002648#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002649 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2650 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002651 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002652 size_t remaining;
2653 ret = ssl_get_remaining_payload_in_datagram( ssl );
2654 if( ret < 0 )
2655 {
2656 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2657 ret );
2658 return( ret );
2659 }
2660
2661 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002662 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002663 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002664 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002665 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002666 else
2667 {
Hanno Becker513815a2018-08-20 11:56:09 +01002668 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002669 }
2670 }
2671#endif /* MBEDTLS_SSL_PROTO_DTLS */
2672
2673 if( ( flush == SSL_FORCE_FLUSH ) &&
2674 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002675 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002677 return( ret );
2678 }
2679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002681
2682 return( 0 );
2683}
2684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002686
2687static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2688{
2689 if( ssl->in_msglen < ssl->in_hslen ||
2690 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2691 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2692 {
2693 return( 1 );
2694 }
2695 return( 0 );
2696}
Hanno Becker44650b72018-08-16 12:51:11 +01002697
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002698static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002699{
2700 return( ( ssl->in_msg[9] << 16 ) |
2701 ( ssl->in_msg[10] << 8 ) |
2702 ssl->in_msg[11] );
2703}
2704
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002705static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002706{
2707 return( ( ssl->in_msg[6] << 16 ) |
2708 ( ssl->in_msg[7] << 8 ) |
2709 ssl->in_msg[8] );
2710}
2711
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002712static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002713{
2714 uint32_t msg_len, frag_off, frag_len;
2715
2716 msg_len = ssl_get_hs_total_len( ssl );
2717 frag_off = ssl_get_hs_frag_off( ssl );
2718 frag_len = ssl_get_hs_frag_len( ssl );
2719
2720 if( frag_off > msg_len )
2721 return( -1 );
2722
2723 if( frag_len > msg_len - frag_off )
2724 return( -1 );
2725
2726 if( frag_len + 12 > ssl->in_msglen )
2727 return( -1 );
2728
2729 return( 0 );
2730}
2731
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002732/*
2733 * Mark bits in bitmask (used for DTLS HS reassembly)
2734 */
2735static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2736{
2737 unsigned int start_bits, end_bits;
2738
2739 start_bits = 8 - ( offset % 8 );
2740 if( start_bits != 8 )
2741 {
2742 size_t first_byte_idx = offset / 8;
2743
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002744 /* Special case */
2745 if( len <= start_bits )
2746 {
2747 for( ; len != 0; len-- )
2748 mask[first_byte_idx] |= 1 << ( start_bits - len );
2749
2750 /* Avoid potential issues with offset or len becoming invalid */
2751 return;
2752 }
2753
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002754 offset += start_bits; /* Now offset % 8 == 0 */
2755 len -= start_bits;
2756
2757 for( ; start_bits != 0; start_bits-- )
2758 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2759 }
2760
2761 end_bits = len % 8;
2762 if( end_bits != 0 )
2763 {
2764 size_t last_byte_idx = ( offset + len ) / 8;
2765
2766 len -= end_bits; /* Now len % 8 == 0 */
2767
2768 for( ; end_bits != 0; end_bits-- )
2769 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2770 }
2771
2772 memset( mask + offset / 8, 0xFF, len / 8 );
2773}
2774
2775/*
2776 * Check that bitmask is full
2777 */
2778static int ssl_bitmask_check( unsigned char *mask, size_t len )
2779{
2780 size_t i;
2781
2782 for( i = 0; i < len / 8; i++ )
2783 if( mask[i] != 0xFF )
2784 return( -1 );
2785
2786 for( i = 0; i < len % 8; i++ )
2787 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2788 return( -1 );
2789
2790 return( 0 );
2791}
2792
Hanno Becker56e205e2018-08-16 09:06:12 +01002793/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002794static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002795 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002796{
Hanno Becker56e205e2018-08-16 09:06:12 +01002797 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002798
Hanno Becker56e205e2018-08-16 09:06:12 +01002799 alloc_len = 12; /* Handshake header */
2800 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002801
Hanno Beckerd07df862018-08-16 09:14:58 +01002802 if( add_bitmap )
2803 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002804
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002805 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002806}
Hanno Becker56e205e2018-08-16 09:06:12 +01002807
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002809
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002810static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002811{
2812 return( ( ssl->in_msg[1] << 16 ) |
2813 ( ssl->in_msg[2] << 8 ) |
2814 ssl->in_msg[3] );
2815}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002816
Simon Butcher99000142016-10-13 17:21:01 +01002817int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002818{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002820 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002821 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002822 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002824 }
2825
Hanno Becker12555c62018-08-16 12:47:53 +01002826 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002829 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002830 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002831
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002833 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002834 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002836 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002837
Hanno Becker44650b72018-08-16 12:51:11 +01002838 if( ssl_check_hs_header( ssl ) != 0 )
2839 {
2840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2841 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2842 }
2843
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002844 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002845 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2846 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2847 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2848 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002849 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002850 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2851 {
2852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2853 recv_msg_seq,
2854 ssl->handshake->in_msg_seq ) );
2855 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2856 }
2857
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002858 /* Retransmit only on last message from previous flight, to avoid
2859 * too many retransmissions.
2860 * Besides, No sane server ever retransmits HelloVerifyRequest */
2861 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002865 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002866 recv_msg_seq,
2867 ssl->handshake->in_flight_start_seq ) );
2868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002870 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002872 return( ret );
2873 }
2874 }
2875 else
2876 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002878 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002879 recv_msg_seq,
2880 ssl->handshake->in_msg_seq ) );
2881 }
2882
Hanno Becker90333da2017-10-10 11:27:13 +01002883 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002884 }
2885 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002886
Hanno Becker6d97ef52018-08-16 13:09:04 +01002887 /* Message reassembly is handled alongside buffering of future
2888 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002889 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002890 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002891 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002892 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002894 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002895 }
2896 }
2897 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002899 /* With TLS we don't handle fragmentation (for now) */
2900 if( ssl->in_msglen < ssl->in_hslen )
2901 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2903 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002904 }
2905
Simon Butcher99000142016-10-13 17:21:01 +01002906 return( 0 );
2907}
2908
2909void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2910{
Hanno Becker0271f962018-08-16 13:23:47 +01002911 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002912
Hanno Becker0271f962018-08-16 13:23:47 +01002913 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002914 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002915 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002916 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002917
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002918 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002920 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002921 ssl->handshake != NULL )
2922 {
Hanno Becker0271f962018-08-16 13:23:47 +01002923 unsigned offset;
2924 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002925
Hanno Becker0271f962018-08-16 13:23:47 +01002926 /* Increment handshake sequence number */
2927 hs->in_msg_seq++;
2928
2929 /*
2930 * Clear up handshake buffering and reassembly structure.
2931 */
2932
2933 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002934 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002935
2936 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002937 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2938 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002939 offset++, hs_buf++ )
2940 {
2941 *hs_buf = *(hs_buf + 1);
2942 }
2943
2944 /* Create a fresh last entry */
2945 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002946 }
2947#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002948}
2949
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002950/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002951 * DTLS anti-replay: RFC 6347 4.1.2.6
2952 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002953 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2954 * Bit n is set iff record number in_window_top - n has been seen.
2955 *
2956 * Usually, in_window_top is the last record number seen and the lsb of
2957 * in_window is set. The only exception is the initial state (record number 0
2958 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002961void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002962{
2963 ssl->in_window_top = 0;
2964 ssl->in_window = 0;
2965}
2966
2967static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2968{
2969 return( ( (uint64_t) buf[0] << 40 ) |
2970 ( (uint64_t) buf[1] << 32 ) |
2971 ( (uint64_t) buf[2] << 24 ) |
2972 ( (uint64_t) buf[3] << 16 ) |
2973 ( (uint64_t) buf[4] << 8 ) |
2974 ( (uint64_t) buf[5] ) );
2975}
2976
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002977static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2978{
Janos Follath865b3eb2019-12-16 11:46:15 +00002979 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002980 unsigned char *original_in_ctr;
2981
2982 // save original in_ctr
2983 original_in_ctr = ssl->in_ctr;
2984
2985 // use counter from record
2986 ssl->in_ctr = record_in_ctr;
2987
2988 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2989
2990 // restore the counter
2991 ssl->in_ctr = original_in_ctr;
2992
2993 return ret;
2994}
2995
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002996/*
2997 * Return 0 if sequence number is acceptable, -1 otherwise
2998 */
Hanno Becker0183d692019-07-12 08:50:37 +01002999int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003000{
3001 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3002 uint64_t bit;
3003
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003004 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003005 return( 0 );
3006
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003007 if( rec_seqnum > ssl->in_window_top )
3008 return( 0 );
3009
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003010 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003011
3012 if( bit >= 64 )
3013 return( -1 );
3014
3015 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3016 return( -1 );
3017
3018 return( 0 );
3019}
3020
3021/*
3022 * Update replay window on new validated record
3023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003025{
3026 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3027
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003028 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003029 return;
3030
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003031 if( rec_seqnum > ssl->in_window_top )
3032 {
3033 /* Update window_top and the contents of the window */
3034 uint64_t shift = rec_seqnum - ssl->in_window_top;
3035
3036 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003037 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003038 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003039 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003040 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003041 ssl->in_window |= 1;
3042 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003043
3044 ssl->in_window_top = rec_seqnum;
3045 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003046 else
3047 {
3048 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003049 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003050
3051 if( bit < 64 ) /* Always true, but be extra sure */
3052 ssl->in_window |= (uint64_t) 1 << bit;
3053 }
3054}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003056
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003057#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003058/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003059 * Without any SSL context, check if a datagram looks like a ClientHello with
3060 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003061 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003062 *
3063 * - if cookie is valid, return 0
3064 * - if ClientHello looks superficially valid but cookie is not,
3065 * fill obuf and set olen, then
3066 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3067 * - otherwise return a specific error code
3068 */
3069static int ssl_check_dtls_clihlo_cookie(
3070 mbedtls_ssl_cookie_write_t *f_cookie_write,
3071 mbedtls_ssl_cookie_check_t *f_cookie_check,
3072 void *p_cookie,
3073 const unsigned char *cli_id, size_t cli_id_len,
3074 const unsigned char *in, size_t in_len,
3075 unsigned char *obuf, size_t buf_len, size_t *olen )
3076{
3077 size_t sid_len, cookie_len;
3078 unsigned char *p;
3079
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003080 /*
3081 * Structure of ClientHello with record and handshake headers,
3082 * and expected values. We don't need to check a lot, more checks will be
3083 * done when actually parsing the ClientHello - skipping those checks
3084 * avoids code duplication and does not make cookie forging any easier.
3085 *
3086 * 0-0 ContentType type; copied, must be handshake
3087 * 1-2 ProtocolVersion version; copied
3088 * 3-4 uint16 epoch; copied, must be 0
3089 * 5-10 uint48 sequence_number; copied
3090 * 11-12 uint16 length; (ignored)
3091 *
3092 * 13-13 HandshakeType msg_type; (ignored)
3093 * 14-16 uint24 length; (ignored)
3094 * 17-18 uint16 message_seq; copied
3095 * 19-21 uint24 fragment_offset; copied, must be 0
3096 * 22-24 uint24 fragment_length; (ignored)
3097 *
3098 * 25-26 ProtocolVersion client_version; (ignored)
3099 * 27-58 Random random; (ignored)
3100 * 59-xx SessionID session_id; 1 byte len + sid_len content
3101 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3102 * ...
3103 *
3104 * Minimum length is 61 bytes.
3105 */
3106 if( in_len < 61 ||
3107 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3108 in[3] != 0 || in[4] != 0 ||
3109 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3110 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003111 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003112 }
3113
3114 sid_len = in[59];
3115 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003116 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003117
3118 cookie_len = in[60 + sid_len];
3119 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003120 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003121
3122 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3123 cli_id, cli_id_len ) == 0 )
3124 {
3125 /* Valid cookie */
3126 return( 0 );
3127 }
3128
3129 /*
3130 * If we get here, we've got an invalid cookie, let's prepare HVR.
3131 *
3132 * 0-0 ContentType type; copied
3133 * 1-2 ProtocolVersion version; copied
3134 * 3-4 uint16 epoch; copied
3135 * 5-10 uint48 sequence_number; copied
3136 * 11-12 uint16 length; olen - 13
3137 *
3138 * 13-13 HandshakeType msg_type; hello_verify_request
3139 * 14-16 uint24 length; olen - 25
3140 * 17-18 uint16 message_seq; copied
3141 * 19-21 uint24 fragment_offset; copied
3142 * 22-24 uint24 fragment_length; olen - 25
3143 *
3144 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3145 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3146 *
3147 * Minimum length is 28.
3148 */
3149 if( buf_len < 28 )
3150 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3151
3152 /* Copy most fields and adapt others */
3153 memcpy( obuf, in, 25 );
3154 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3155 obuf[25] = 0xfe;
3156 obuf[26] = 0xff;
3157
3158 /* Generate and write actual cookie */
3159 p = obuf + 28;
3160 if( f_cookie_write( p_cookie,
3161 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3162 {
3163 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3164 }
3165
3166 *olen = p - obuf;
3167
3168 /* Go back and fill length fields */
3169 obuf[27] = (unsigned char)( *olen - 28 );
3170
Joe Subbianifbeb6922021-07-16 14:27:50 +01003171 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3172 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3173 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003174
Joe Subbiani6dd73642021-07-19 11:56:54 +01003175 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003176
3177 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3178}
3179
3180/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003181 * Handle possible client reconnect with the same UDP quadruplet
3182 * (RFC 6347 Section 4.2.8).
3183 *
3184 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3185 * that looks like a ClientHello.
3186 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003187 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003188 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003189 * - if the input looks like a ClientHello with a valid cookie,
3190 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003191 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003192 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003193 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003194 * This function is called (through ssl_check_client_reconnect()) when an
3195 * unexpected record is found in ssl_get_next_record(), which will discard the
3196 * record if we return 0, and bubble up the return value otherwise (this
3197 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3198 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003199 */
3200static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3201{
Janos Follath865b3eb2019-12-16 11:46:15 +00003202 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003203 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003204
Hanno Becker2fddd372019-07-10 14:37:41 +01003205 if( ssl->conf->f_cookie_write == NULL ||
3206 ssl->conf->f_cookie_check == NULL )
3207 {
3208 /* If we can't use cookies to verify reachability of the peer,
3209 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003210 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3211 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003212 return( 0 );
3213 }
3214
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003215 ret = ssl_check_dtls_clihlo_cookie(
3216 ssl->conf->f_cookie_write,
3217 ssl->conf->f_cookie_check,
3218 ssl->conf->p_cookie,
3219 ssl->cli_id, ssl->cli_id_len,
3220 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003221 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003222
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003223 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3224
3225 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003226 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003227 int send_ret;
3228 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3229 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3230 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003231 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003232 * If the error is permanent we'll catch it later,
3233 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003234 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3235 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3236 (void) send_ret;
3237
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003238 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003239 }
3240
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003241 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003242 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003243 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003244 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003245 {
3246 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3247 return( ret );
3248 }
3249
3250 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003251 }
3252
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003253 return( ret );
3254}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003255#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003256
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003257static int ssl_check_record_type( uint8_t record_type )
3258{
3259 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3260 record_type != MBEDTLS_SSL_MSG_ALERT &&
3261 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3262 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3263 {
3264 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3265 }
3266
3267 return( 0 );
3268}
3269
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003270/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003271 * ContentType type;
3272 * ProtocolVersion version;
3273 * uint16 epoch; // DTLS only
3274 * uint48 sequence_number; // DTLS only
3275 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003276 *
3277 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003278 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003279 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3280 *
3281 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003282 * 1. proceed with the record if this function returns 0
3283 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3284 * 3. return CLIENT_RECONNECT if this function return that value
3285 * 4. drop the whole datagram if this function returns anything else.
3286 * Point 2 is needed when the peer is resending, and we have already received
3287 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003288 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003289static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003290 unsigned char *buf,
3291 size_t len,
3292 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003293{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003294 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003295
Hanno Beckere5e7e782019-07-11 12:29:35 +01003296 size_t const rec_hdr_type_offset = 0;
3297 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003298
Hanno Beckere5e7e782019-07-11 12:29:35 +01003299 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3300 rec_hdr_type_len;
3301 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003302
Hanno Beckere5e7e782019-07-11 12:29:35 +01003303 size_t const rec_hdr_ctr_len = 8;
3304#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003305 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003306 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3307 rec_hdr_version_len;
3308
Hanno Beckera0e20d02019-05-15 14:03:01 +01003309#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003310 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3311 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003312 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003313#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3314#endif /* MBEDTLS_SSL_PROTO_DTLS */
3315
3316 size_t rec_hdr_len_offset; /* To be determined */
3317 size_t const rec_hdr_len_len = 2;
3318
3319 /*
3320 * Check minimum lengths for record header.
3321 */
3322
3323#if defined(MBEDTLS_SSL_PROTO_DTLS)
3324 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3325 {
3326 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3327 }
3328 else
3329#endif /* MBEDTLS_SSL_PROTO_DTLS */
3330 {
3331 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3332 }
3333
3334 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3335 {
3336 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3337 (unsigned) len,
3338 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3339 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3340 }
3341
3342 /*
3343 * Parse and validate record content type
3344 */
3345
3346 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003347
3348 /* Check record content type */
3349#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3350 rec->cid_len = 0;
3351
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003352 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003353 ssl->conf->cid_len != 0 &&
3354 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003355 {
3356 /* Shift pointers to account for record header including CID
3357 * struct {
3358 * ContentType special_type = tls12_cid;
3359 * ProtocolVersion version;
3360 * uint16 epoch;
3361 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003362 * opaque cid[cid_length]; // Additional field compared to
3363 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003364 * uint16 length;
3365 * opaque enc_content[DTLSCiphertext.length];
3366 * } DTLSCiphertext;
3367 */
3368
3369 /* So far, we only support static CID lengths
3370 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003371 rec_hdr_cid_len = ssl->conf->cid_len;
3372 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003373
Hanno Beckere5e7e782019-07-11 12:29:35 +01003374 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003375 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3377 (unsigned) len,
3378 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003379 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003380 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003381
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003382 /* configured CID len is guaranteed at most 255, see
3383 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3384 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003385 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003386 }
3387 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003388#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003389 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003390 if( ssl_check_record_type( rec->type ) )
3391 {
Hanno Becker54229812019-07-12 14:40:00 +01003392 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3393 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003394 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3395 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003396 }
3397
Hanno Beckere5e7e782019-07-11 12:29:35 +01003398 /*
3399 * Parse and validate record version
3400 */
3401
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003402 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3403 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003404 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3405 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003406 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003407
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003408 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3411 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003412 }
3413
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003414 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003415 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3417 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003418 }
3419
Hanno Beckere5e7e782019-07-11 12:29:35 +01003420 /*
3421 * Parse/Copy record sequence number.
3422 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003423
Hanno Beckere5e7e782019-07-11 12:29:35 +01003424#if defined(MBEDTLS_SSL_PROTO_DTLS)
3425 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003426 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003427 /* Copy explicit record sequence number from input buffer. */
3428 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3429 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003430 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003431 else
3432#endif /* MBEDTLS_SSL_PROTO_DTLS */
3433 {
3434 /* Copy implicit record sequence number from SSL context structure. */
3435 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3436 }
Paul Bakker40e46942009-01-03 21:51:57 +00003437
Hanno Beckere5e7e782019-07-11 12:29:35 +01003438 /*
3439 * Parse record length.
3440 */
3441
Hanno Beckere5e7e782019-07-11 12:29:35 +01003442 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003443 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3444 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003445 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003446
Paul Elliott9f352112020-12-09 14:55:45 +00003447 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003448 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003449 rec->type,
3450 major_ver, minor_ver, rec->data_len ) );
3451
3452 rec->buf = buf;
3453 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003454
Hanno Beckerd417cc92019-07-26 08:20:27 +01003455 if( rec->data_len == 0 )
3456 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003457
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003458 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003459 * DTLS-related tests.
3460 * Check epoch before checking length constraint because
3461 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3462 * message gets duplicated before the corresponding Finished message,
3463 * the second ChangeCipherSpec should be discarded because it belongs
3464 * to an old epoch, but not because its length is shorter than
3465 * the minimum record length for packets using the new record transform.
3466 * Note that these two kinds of failures are handled differently,
3467 * as an unexpected record is silently skipped but an invalid
3468 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003469 */
3470#if defined(MBEDTLS_SSL_PROTO_DTLS)
3471 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3472 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003473 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003474
Hanno Becker955a5c92019-07-10 17:12:07 +01003475 /* Check that the datagram is large enough to contain a record
3476 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003477 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003478 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003479 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3480 (unsigned) len,
3481 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003482 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3483 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003484
Hanno Becker37cfe732019-07-10 17:20:01 +01003485 /* Records from other, non-matching epochs are silently discarded.
3486 * (The case of same-port Client reconnects must be considered in
3487 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003488 if( rec_epoch != ssl->in_epoch )
3489 {
3490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003491 "expected %u, received %lu",
3492 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003493
Hanno Becker552f7472019-07-19 10:59:12 +01003494 /* Records from the next epoch are considered for buffering
3495 * (concretely: early Finished messages). */
3496 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003497 {
Hanno Becker552f7472019-07-19 10:59:12 +01003498 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3499 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003500 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003501
Hanno Becker2fddd372019-07-10 14:37:41 +01003502 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003503 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003504#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003505 /* For records from the correct epoch, check whether their
3506 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003507 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3508 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003509 {
3510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3511 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3512 }
3513#endif
3514 }
3515#endif /* MBEDTLS_SSL_PROTO_DTLS */
3516
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003517 return( 0 );
3518}
Paul Bakker5121ce52009-01-03 21:22:43 +00003519
Paul Bakker5121ce52009-01-03 21:22:43 +00003520
Hanno Becker2fddd372019-07-10 14:37:41 +01003521#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3522static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3523{
3524 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3525
3526 /*
3527 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3528 * access the first byte of record content (handshake type), as we
3529 * have an active transform (possibly iv_len != 0), so use the
3530 * fact that the record header len is 13 instead.
3531 */
3532 if( rec_epoch == 0 &&
3533 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3534 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3535 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3536 ssl->in_left > 13 &&
3537 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3538 {
3539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3540 "from the same port" ) );
3541 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003542 }
3543
3544 return( 0 );
3545}
Hanno Becker2fddd372019-07-10 14:37:41 +01003546#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003547
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003548/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003549 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003550 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003551static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3552 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003553{
3554 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003557 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003558
Ronald Cron7e38cba2021-11-24 12:43:39 +01003559 /*
3560 * In TLS 1.3, always treat ChangeCipherSpec records
3561 * as unencrypted. The only thing we do with them is
3562 * check the length and content and ignore them.
3563 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003564#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003565 if( ssl->transform_in != NULL &&
3566 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3567 {
3568 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3569 done = 1;
3570 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003571#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003572
Paul Bakker48916f92012-09-16 19:57:18 +00003573 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003574 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003575 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003576
Hanno Beckera18d1322018-01-03 14:27:32 +00003577 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003578 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003579 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003581
Hanno Beckera0e20d02019-05-15 14:03:01 +01003582#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003583 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3584 ssl->conf->ignore_unexpected_cid
3585 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3586 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003587 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003588 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003589 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003590#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003591
Paul Bakker5121ce52009-01-03 21:22:43 +00003592 return( ret );
3593 }
3594
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003595 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003596 {
3597 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003598 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003599 }
3600
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003601 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003602 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003603
Hanno Beckera0e20d02019-05-15 14:03:01 +01003604#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003605 /* We have already checked the record content type
3606 * in ssl_parse_record_header(), failing or silently
3607 * dropping the record in the case of an unknown type.
3608 *
3609 * Since with the use of CIDs, the record content type
3610 * might change during decryption, re-check the record
3611 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003612 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003613 {
3614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3615 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3616 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003617#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003618
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003619 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003620 {
3621#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3622 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003623 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003624 {
3625 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3627 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3628 }
3629#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3630
3631 ssl->nb_zero++;
3632
3633 /*
3634 * Three or more empty messages may be a DoS attack
3635 * (excessive CPU consumption).
3636 */
3637 if( ssl->nb_zero > 3 )
3638 {
3639 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003640 "messages, possible DoS attack" ) );
3641 /* Treat the records as if they were not properly authenticated,
3642 * thereby failing the connection if we see more than allowed
3643 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003644 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3645 }
3646 }
3647 else
3648 ssl->nb_zero = 0;
3649
3650#if defined(MBEDTLS_SSL_PROTO_DTLS)
3651 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3652 {
3653 ; /* in_ctr read from peer, not maintained internally */
3654 }
3655 else
3656#endif
3657 {
3658 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003659 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3660 i > mbedtls_ssl_ep_len( ssl ); i-- )
3661 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003662 if( ++ssl->in_ctr[i - 1] != 0 )
3663 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003664 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003665
3666 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003667 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003668 {
3669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3670 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3671 }
3672 }
3673
Paul Bakker5121ce52009-01-03 21:22:43 +00003674 }
3675
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003676#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003677 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003679 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003680 }
3681#endif
3682
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003683 /* Check actual (decrypted) record content length against
3684 * configured maximum. */
3685 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3686 {
3687 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3688 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3689 }
3690
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003691 return( 0 );
3692}
3693
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003694/*
3695 * Read a record.
3696 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003697 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3698 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3699 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003700 */
Hanno Becker1097b342018-08-15 14:09:41 +01003701
3702/* Helper functions for mbedtls_ssl_read_record(). */
3703static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003704static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3705static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003706
Hanno Becker327c93b2018-08-15 13:56:18 +01003707int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003708 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003709{
Janos Follath865b3eb2019-12-16 11:46:15 +00003710 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003712 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003713
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003714 if( ssl->keep_current_message == 0 )
3715 {
3716 do {
Simon Butcher99000142016-10-13 17:21:01 +01003717
Hanno Becker26994592018-08-15 14:14:59 +01003718 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003719 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003720 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003721
Hanno Beckere74d5562018-08-15 14:26:08 +01003722 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003723 {
Hanno Becker40f50842018-08-15 14:48:01 +01003724#if defined(MBEDTLS_SSL_PROTO_DTLS)
3725 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003726
Hanno Becker40f50842018-08-15 14:48:01 +01003727 /* We only check for buffered messages if the
3728 * current datagram is fully consumed. */
3729 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003730 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003731 {
Hanno Becker40f50842018-08-15 14:48:01 +01003732 if( ssl_load_buffered_message( ssl ) == 0 )
3733 have_buffered = 1;
3734 }
3735
3736 if( have_buffered == 0 )
3737#endif /* MBEDTLS_SSL_PROTO_DTLS */
3738 {
3739 ret = ssl_get_next_record( ssl );
3740 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3741 continue;
3742
3743 if( ret != 0 )
3744 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003745 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003746 return( ret );
3747 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003748 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003749 }
3750
3751 ret = mbedtls_ssl_handle_message_type( ssl );
3752
Hanno Becker40f50842018-08-15 14:48:01 +01003753#if defined(MBEDTLS_SSL_PROTO_DTLS)
3754 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3755 {
3756 /* Buffer future message */
3757 ret = ssl_buffer_message( ssl );
3758 if( ret != 0 )
3759 return( ret );
3760
3761 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3762 }
3763#endif /* MBEDTLS_SSL_PROTO_DTLS */
3764
Hanno Becker90333da2017-10-10 11:27:13 +01003765 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3766 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003767
3768 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003769 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003770 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003771 return( ret );
3772 }
3773
Hanno Becker327c93b2018-08-15 13:56:18 +01003774 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003775 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003776 {
3777 mbedtls_ssl_update_handshake_status( ssl );
3778 }
Simon Butcher99000142016-10-13 17:21:01 +01003779 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003780 else
Simon Butcher99000142016-10-13 17:21:01 +01003781 {
Hanno Becker02f59072018-08-15 14:00:24 +01003782 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003783 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003784 }
3785
3786 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3787
3788 return( 0 );
3789}
3790
Hanno Becker40f50842018-08-15 14:48:01 +01003791#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003792static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003793{
Hanno Becker40f50842018-08-15 14:48:01 +01003794 if( ssl->in_left > ssl->next_record_offset )
3795 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003796
Hanno Becker40f50842018-08-15 14:48:01 +01003797 return( 0 );
3798}
3799
3800static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3801{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003802 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003803 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003804 int ret = 0;
3805
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003806 if( hs == NULL )
3807 return( -1 );
3808
Hanno Beckere00ae372018-08-20 09:39:42 +01003809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3810
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003811 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3812 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3813 {
3814 /* Check if we have seen a ChangeCipherSpec before.
3815 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003816 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003817 {
3818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3819 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003820 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003821 }
3822
Hanno Becker39b8bc92018-08-28 17:17:13 +01003823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003824 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3825 ssl->in_msglen = 1;
3826 ssl->in_msg[0] = 1;
3827
3828 /* As long as they are equal, the exact value doesn't matter. */
3829 ssl->in_left = 0;
3830 ssl->next_record_offset = 0;
3831
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003832 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003833 goto exit;
3834 }
Hanno Becker37f95322018-08-16 13:55:32 +01003835
Hanno Beckerb8f50142018-08-28 10:01:34 +01003836#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003837 /* Debug only */
3838 {
3839 unsigned offset;
3840 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3841 {
3842 hs_buf = &hs->buffering.hs[offset];
3843 if( hs_buf->is_valid == 1 )
3844 {
3845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3846 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003847 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003848 }
3849 }
3850 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003851#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003852
3853 /* Check if we have buffered and/or fully reassembled the
3854 * next handshake message. */
3855 hs_buf = &hs->buffering.hs[0];
3856 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3857 {
3858 /* Synthesize a record containing the buffered HS message. */
3859 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3860 ( hs_buf->data[2] << 8 ) |
3861 hs_buf->data[3];
3862
3863 /* Double-check that we haven't accidentally buffered
3864 * a message that doesn't fit into the input buffer. */
3865 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3866 {
3867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3868 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3869 }
3870
3871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3872 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3873 hs_buf->data, msg_len + 12 );
3874
3875 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3876 ssl->in_hslen = msg_len + 12;
3877 ssl->in_msglen = msg_len + 12;
3878 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3879
3880 ret = 0;
3881 goto exit;
3882 }
3883 else
3884 {
3885 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3886 hs->in_msg_seq ) );
3887 }
3888
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003889 ret = -1;
3890
3891exit:
3892
3893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3894 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003895}
3896
Hanno Beckera02b0b42018-08-21 17:20:27 +01003897static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3898 size_t desired )
3899{
3900 int offset;
3901 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3903 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003904
Hanno Becker01315ea2018-08-21 17:22:17 +01003905 /* Get rid of future records epoch first, if such exist. */
3906 ssl_free_buffered_record( ssl );
3907
3908 /* Check if we have enough space available now. */
3909 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3910 hs->buffering.total_bytes_buffered ) )
3911 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003913 return( 0 );
3914 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003915
Hanno Becker4f432ad2018-08-28 10:02:32 +01003916 /* We don't have enough space to buffer the next expected handshake
3917 * message. Remove buffers used for future messages to gain space,
3918 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003919 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3920 offset >= 0; offset-- )
3921 {
3922 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3923 offset ) );
3924
Hanno Beckerb309b922018-08-23 13:18:05 +01003925 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003926
3927 /* Check if we have enough space available now. */
3928 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3929 hs->buffering.total_bytes_buffered ) )
3930 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003932 return( 0 );
3933 }
3934 }
3935
3936 return( -1 );
3937}
3938
Hanno Becker40f50842018-08-15 14:48:01 +01003939static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3940{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003941 int ret = 0;
3942 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3943
3944 if( hs == NULL )
3945 return( 0 );
3946
3947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3948
3949 switch( ssl->in_msgtype )
3950 {
3951 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003953
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003954 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003955 break;
3956
3957 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003958 {
3959 unsigned recv_msg_seq_offset;
3960 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3961 mbedtls_ssl_hs_buffer *hs_buf;
3962 size_t msg_len = ssl->in_hslen - 12;
3963
3964 /* We should never receive an old handshake
3965 * message - double-check nonetheless. */
3966 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3967 {
3968 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3969 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3970 }
3971
3972 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3973 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3974 {
3975 /* Silently ignore -- message too far in the future */
3976 MBEDTLS_SSL_DEBUG_MSG( 2,
3977 ( "Ignore future HS message with sequence number %u, "
3978 "buffering window %u - %u",
3979 recv_msg_seq, ssl->handshake->in_msg_seq,
3980 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3981
3982 goto exit;
3983 }
3984
3985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3986 recv_msg_seq, recv_msg_seq_offset ) );
3987
3988 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3989
3990 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003991 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003992 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003993 size_t reassembly_buf_sz;
3994
Hanno Becker37f95322018-08-16 13:55:32 +01003995 hs_buf->is_fragmented =
3996 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3997
3998 /* We copy the message back into the input buffer
3999 * after reassembly, so check that it's not too large.
4000 * This is an implementation-specific limitation
4001 * and not one from the standard, hence it is not
4002 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004003 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004004 {
4005 /* Ignore message */
4006 goto exit;
4007 }
4008
Hanno Beckere0b150f2018-08-21 15:51:03 +01004009 /* Check if we have enough space to buffer the message. */
4010 if( hs->buffering.total_bytes_buffered >
4011 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4012 {
4013 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4014 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4015 }
4016
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004017 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4018 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004019
4020 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4021 hs->buffering.total_bytes_buffered ) )
4022 {
4023 if( recv_msg_seq_offset > 0 )
4024 {
4025 /* If we can't buffer a future message because
4026 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004027 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4028 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4029 " (already %" MBEDTLS_PRINTF_SIZET
4030 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004031 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004032 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004033 goto exit;
4034 }
Hanno Beckere1801392018-08-21 16:51:05 +01004035 else
4036 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4038 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4039 " (already %" MBEDTLS_PRINTF_SIZET
4040 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004041 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004042 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004043 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004044
Hanno Beckera02b0b42018-08-21 17:20:27 +01004045 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004046 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4048 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4049 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4050 " (already %" MBEDTLS_PRINTF_SIZET
4051 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004052 msg_len,
4053 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004054 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004055 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004056 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4057 goto exit;
4058 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004059 }
4060
Paul Elliottd48d5c62021-01-07 14:47:05 +00004061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004062 msg_len ) );
4063
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004064 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4065 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004066 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004067 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004068 goto exit;
4069 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004070 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004071
4072 /* Prepare final header: copy msg_type, length and message_seq,
4073 * then add standardised fragment_offset and fragment_length */
4074 memcpy( hs_buf->data, ssl->in_msg, 6 );
4075 memset( hs_buf->data + 6, 0, 3 );
4076 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4077
4078 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004079
4080 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004081 }
4082 else
4083 {
4084 /* Make sure msg_type and length are consistent */
4085 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4086 {
4087 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4088 /* Ignore */
4089 goto exit;
4090 }
4091 }
4092
Hanno Becker4422bbb2018-08-20 09:40:19 +01004093 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004094 {
4095 size_t frag_len, frag_off;
4096 unsigned char * const msg = hs_buf->data + 12;
4097
4098 /*
4099 * Check and copy current fragment
4100 */
4101
4102 /* Validation of header fields already done in
4103 * mbedtls_ssl_prepare_handshake_record(). */
4104 frag_off = ssl_get_hs_frag_off( ssl );
4105 frag_len = ssl_get_hs_frag_len( ssl );
4106
Paul Elliottd48d5c62021-01-07 14:47:05 +00004107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4108 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004109 frag_off, frag_len ) );
4110 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4111
4112 if( hs_buf->is_fragmented )
4113 {
4114 unsigned char * const bitmask = msg + msg_len;
4115 ssl_bitmask_set( bitmask, frag_off, frag_len );
4116 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4117 msg_len ) == 0 );
4118 }
4119 else
4120 {
4121 hs_buf->is_complete = 1;
4122 }
4123
4124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4125 hs_buf->is_complete ? "" : "not yet " ) );
4126 }
4127
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004128 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004129 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004130
4131 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004132 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004133 break;
4134 }
4135
4136exit:
4137
4138 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4139 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004140}
4141#endif /* MBEDTLS_SSL_PROTO_DTLS */
4142
Hanno Becker1097b342018-08-15 14:09:41 +01004143static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004144{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004145 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004146 * Consume last content-layer message and potentially
4147 * update in_msglen which keeps track of the contents'
4148 * consumption state.
4149 *
4150 * (1) Handshake messages:
4151 * Remove last handshake message, move content
4152 * and adapt in_msglen.
4153 *
4154 * (2) Alert messages:
4155 * Consume whole record content, in_msglen = 0.
4156 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004157 * (3) Change cipher spec:
4158 * Consume whole record content, in_msglen = 0.
4159 *
4160 * (4) Application data:
4161 * Don't do anything - the record layer provides
4162 * the application data as a stream transport
4163 * and consumes through mbedtls_ssl_read only.
4164 *
4165 */
4166
4167 /* Case (1): Handshake messages */
4168 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004169 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004170 /* Hard assertion to be sure that no application data
4171 * is in flight, as corrupting ssl->in_msglen during
4172 * ssl->in_offt != NULL is fatal. */
4173 if( ssl->in_offt != NULL )
4174 {
4175 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4176 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4177 }
4178
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004179 /*
4180 * Get next Handshake message in the current record
4181 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004182
Hanno Becker4a810fb2017-05-24 16:27:30 +01004183 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004184 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004185 * current handshake content: If DTLS handshake
4186 * fragmentation is used, that's the fragment
4187 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004188 * size here is faulty and should be changed at
4189 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004190 * (2) While it doesn't seem to cause problems, one
4191 * has to be very careful not to assume that in_hslen
4192 * is always <= in_msglen in a sensible communication.
4193 * Again, it's wrong for DTLS handshake fragmentation.
4194 * The following check is therefore mandatory, and
4195 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004196 * Additionally, ssl->in_hslen might be arbitrarily out of
4197 * bounds after handling a DTLS message with an unexpected
4198 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004199 */
4200 if( ssl->in_hslen < ssl->in_msglen )
4201 {
4202 ssl->in_msglen -= ssl->in_hslen;
4203 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4204 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004205
Hanno Becker4a810fb2017-05-24 16:27:30 +01004206 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4207 ssl->in_msg, ssl->in_msglen );
4208 }
4209 else
4210 {
4211 ssl->in_msglen = 0;
4212 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004213
Hanno Becker4a810fb2017-05-24 16:27:30 +01004214 ssl->in_hslen = 0;
4215 }
4216 /* Case (4): Application data */
4217 else if( ssl->in_offt != NULL )
4218 {
4219 return( 0 );
4220 }
4221 /* Everything else (CCS & Alerts) */
4222 else
4223 {
4224 ssl->in_msglen = 0;
4225 }
4226
Hanno Becker1097b342018-08-15 14:09:41 +01004227 return( 0 );
4228}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004229
Hanno Beckere74d5562018-08-15 14:26:08 +01004230static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4231{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004232 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004233 return( 1 );
4234
4235 return( 0 );
4236}
4237
Hanno Becker5f066e72018-08-16 14:56:31 +01004238#if defined(MBEDTLS_SSL_PROTO_DTLS)
4239
4240static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4241{
4242 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4243 if( hs == NULL )
4244 return;
4245
Hanno Becker01315ea2018-08-21 17:22:17 +01004246 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004247 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004248 hs->buffering.total_bytes_buffered -=
4249 hs->buffering.future_record.len;
4250
4251 mbedtls_free( hs->buffering.future_record.data );
4252 hs->buffering.future_record.data = NULL;
4253 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004254}
4255
4256static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4257{
4258 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4259 unsigned char * rec;
4260 size_t rec_len;
4261 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004262#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4263 size_t in_buf_len = ssl->in_buf_len;
4264#else
4265 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4266#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004267 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4268 return( 0 );
4269
4270 if( hs == NULL )
4271 return( 0 );
4272
Hanno Becker5f066e72018-08-16 14:56:31 +01004273 rec = hs->buffering.future_record.data;
4274 rec_len = hs->buffering.future_record.len;
4275 rec_epoch = hs->buffering.future_record.epoch;
4276
4277 if( rec == NULL )
4278 return( 0 );
4279
Hanno Becker4cb782d2018-08-20 11:19:05 +01004280 /* Only consider loading future records if the
4281 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004282 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004283 return( 0 );
4284
Hanno Becker5f066e72018-08-16 14:56:31 +01004285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4286
4287 if( rec_epoch != ssl->in_epoch )
4288 {
4289 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4290 goto exit;
4291 }
4292
4293 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4294
4295 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004296 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004297 {
4298 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4299 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4300 }
4301
4302 memcpy( ssl->in_hdr, rec, rec_len );
4303 ssl->in_left = rec_len;
4304 ssl->next_record_offset = 0;
4305
4306 ssl_free_buffered_record( ssl );
4307
4308exit:
4309 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4310 return( 0 );
4311}
4312
Hanno Becker519f15d2019-07-11 12:43:20 +01004313static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4314 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004315{
4316 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004317
4318 /* Don't buffer future records outside handshakes. */
4319 if( hs == NULL )
4320 return( 0 );
4321
4322 /* Only buffer handshake records (we are only interested
4323 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004324 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004325 return( 0 );
4326
4327 /* Don't buffer more than one future epoch record. */
4328 if( hs->buffering.future_record.data != NULL )
4329 return( 0 );
4330
Hanno Becker01315ea2018-08-21 17:22:17 +01004331 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004332 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004333 hs->buffering.total_bytes_buffered ) )
4334 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4336 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4337 " (already %" MBEDTLS_PRINTF_SIZET
4338 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004339 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004340 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004341 return( 0 );
4342 }
4343
Hanno Becker5f066e72018-08-16 14:56:31 +01004344 /* Buffer record */
4345 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004346 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004347 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004348
4349 /* ssl_parse_record_header() only considers records
4350 * of the next epoch as candidates for buffering. */
4351 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004352 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004353
4354 hs->buffering.future_record.data =
4355 mbedtls_calloc( 1, hs->buffering.future_record.len );
4356 if( hs->buffering.future_record.data == NULL )
4357 {
4358 /* If we run out of RAM trying to buffer a
4359 * record from the next epoch, just ignore. */
4360 return( 0 );
4361 }
4362
Hanno Becker519f15d2019-07-11 12:43:20 +01004363 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004364
Hanno Becker519f15d2019-07-11 12:43:20 +01004365 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004366 return( 0 );
4367}
4368
4369#endif /* MBEDTLS_SSL_PROTO_DTLS */
4370
Hanno Beckere74d5562018-08-15 14:26:08 +01004371static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004372{
Janos Follath865b3eb2019-12-16 11:46:15 +00004373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004374 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004375
Hanno Becker5f066e72018-08-16 14:56:31 +01004376#if defined(MBEDTLS_SSL_PROTO_DTLS)
4377 /* We might have buffered a future record; if so,
4378 * and if the epoch matches now, load it.
4379 * On success, this call will set ssl->in_left to
4380 * the length of the buffered record, so that
4381 * the calls to ssl_fetch_input() below will
4382 * essentially be no-ops. */
4383 ret = ssl_load_buffered_record( ssl );
4384 if( ret != 0 )
4385 return( ret );
4386#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004387
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004388 /* Ensure that we have enough space available for the default form
4389 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4390 * with no space for CIDs counted in). */
4391 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4392 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004393 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004394 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004395 return( ret );
4396 }
4397
Hanno Beckere5e7e782019-07-11 12:29:35 +01004398 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4399 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004400 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004401#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004402 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004403 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004404 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4405 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004406 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004407 if( ret != 0 )
4408 return( ret );
4409
4410 /* Fall through to handling of unexpected records */
4411 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4412 }
4413
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004414 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4415 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004416#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004417 /* Reset in pointers to default state for TLS/DTLS records,
4418 * assuming no CID and no offset between record content and
4419 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004420 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004421
Hanno Becker7ae20e02019-07-12 08:33:49 +01004422 /* Setup internal message pointers from record structure. */
4423 ssl->in_msgtype = rec.type;
4424#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4425 ssl->in_len = ssl->in_cid + rec.cid_len;
4426#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4427 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4428 ssl->in_msglen = rec.data_len;
4429
Hanno Becker2fddd372019-07-10 14:37:41 +01004430 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004431 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004432 if( ret != 0 )
4433 return( ret );
4434#endif
4435
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004436 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004437 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004438
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4440 "(header)" ) );
4441 }
4442 else
4443 {
4444 /* Skip invalid record and the rest of the datagram */
4445 ssl->next_record_offset = 0;
4446 ssl->in_left = 0;
4447
4448 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4449 "(header)" ) );
4450 }
4451
4452 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004453 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004454 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004455 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004456#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004457 {
4458 return( ret );
4459 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004460 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004461
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004462#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004463 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004464 {
Hanno Beckera8814792019-07-10 15:01:45 +01004465 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004466 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004467 if( ssl->next_record_offset < ssl->in_left )
4468 {
4469 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4470 }
4471 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004472 else
4473#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004474 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004475 /*
4476 * Fetch record contents from underlying transport.
4477 */
Hanno Beckera3175662019-07-11 12:50:29 +01004478 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004479 if( ret != 0 )
4480 {
4481 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4482 return( ret );
4483 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004484
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004485 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004486 }
4487
4488 /*
4489 * Decrypt record contents.
4490 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004491
Hanno Beckerfdf66042019-07-11 13:07:45 +01004492 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004493 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004494#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004495 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004496 {
4497 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004498 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004499 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004500 /* Except when waiting for Finished as a bad mac here
4501 * probably means something went wrong in the handshake
4502 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4503 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4504 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4505 {
4506#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4507 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4508 {
4509 mbedtls_ssl_send_alert_message( ssl,
4510 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4511 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4512 }
4513#endif
4514 return( ret );
4515 }
4516
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004517 if( ssl->conf->badmac_limit != 0 &&
4518 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4521 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004522 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004523
Hanno Becker4a810fb2017-05-24 16:27:30 +01004524 /* As above, invalid records cause
4525 * dismissal of the whole datagram. */
4526
4527 ssl->next_record_offset = 0;
4528 ssl->in_left = 0;
4529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004531 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004532 }
4533
4534 return( ret );
4535 }
4536 else
4537#endif
4538 {
4539 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4541 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004542 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004543 mbedtls_ssl_send_alert_message( ssl,
4544 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4545 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004546 }
4547#endif
4548 return( ret );
4549 }
4550 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004551
Hanno Becker44d89b22019-07-12 09:40:44 +01004552
4553 /* Reset in pointers to default state for TLS/DTLS records,
4554 * assuming no CID and no offset between record content and
4555 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004556 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004557#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4558 ssl->in_len = ssl->in_cid + rec.cid_len;
4559#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004560 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004561
Hanno Becker8685c822019-07-12 09:37:30 +01004562 /* The record content type may change during decryption,
4563 * so re-read it. */
4564 ssl->in_msgtype = rec.type;
4565 /* Also update the input buffer, because unfortunately
4566 * the server-side ssl_parse_client_hello() reparses the
4567 * record header when receiving a ClientHello initiating
4568 * a renegotiation. */
4569 ssl->in_hdr[0] = rec.type;
4570 ssl->in_msg = rec.buf + rec.data_offset;
4571 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004572 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004573
Simon Butcher99000142016-10-13 17:21:01 +01004574 return( 0 );
4575}
4576
4577int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4578{
Janos Follath865b3eb2019-12-16 11:46:15 +00004579 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004580
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004581 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004582 * Handle particular types of records
4583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004584 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004585 {
Simon Butcher99000142016-10-13 17:21:01 +01004586 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4587 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004588 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004589 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004590 }
4591
Hanno Beckere678eaa2018-08-21 14:57:46 +01004592 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004593 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004594 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004595 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004596 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004597 ssl->in_msglen ) );
4598 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004599 }
4600
Hanno Beckere678eaa2018-08-21 14:57:46 +01004601 if( ssl->in_msg[0] != 1 )
4602 {
4603 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4604 ssl->in_msg[0] ) );
4605 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4606 }
4607
4608#if defined(MBEDTLS_SSL_PROTO_DTLS)
4609 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4610 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4611 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4612 {
4613 if( ssl->handshake == NULL )
4614 {
4615 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4616 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4617 }
4618
4619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4620 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4621 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004622#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004623
Ronald Cron6f135e12021-12-08 16:57:54 +01004624#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004625 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4626 {
4627#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4628 MBEDTLS_SSL_DEBUG_MSG( 1,
4629 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4630 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4631#else
4632 MBEDTLS_SSL_DEBUG_MSG( 1,
4633 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4634 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4635#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4636 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004637#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004638 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004641 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004642 if( ssl->in_msglen != 2 )
4643 {
4644 /* Note: Standard allows for more than one 2 byte alert
4645 to be packed in a single message, but Mbed TLS doesn't
4646 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004648 ssl->in_msglen ) );
4649 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4650 }
4651
Paul Elliott9f352112020-12-09 14:55:45 +00004652 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004653 ssl->in_msg[0], ssl->in_msg[1] ) );
4654
4655 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004656 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004658 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004659 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004660 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004661 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004662 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004663 }
4664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4666 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004668 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4669 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004670 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004671
4672#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4673 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4674 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4675 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004676 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004677 /* Will be handled when trying to parse ServerHello */
4678 return( 0 );
4679 }
4680#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004681 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004682 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004683 }
4684
Hanno Beckerc76c6192017-06-06 10:03:17 +01004685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004686 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004687 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004688 /* Drop unexpected ApplicationData records,
4689 * except at the beginning of renegotiations */
4690 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4691 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4692#if defined(MBEDTLS_SSL_RENEGOTIATION)
4693 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4694 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004695#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004696 )
4697 {
4698 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4699 return( MBEDTLS_ERR_SSL_NON_FATAL );
4700 }
4701
4702 if( ssl->handshake != NULL &&
4703 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4704 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004705 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004706 }
4707 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004708#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004709
Paul Bakker5121ce52009-01-03 21:22:43 +00004710 return( 0 );
4711}
4712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004714{
irwir6c0da642019-09-26 21:07:41 +03004715 return( mbedtls_ssl_send_alert_message( ssl,
4716 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4717 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004718}
4719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004720int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004721 unsigned char level,
4722 unsigned char message )
4723{
Janos Follath865b3eb2019-12-16 11:46:15 +00004724 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004725
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004726 if( ssl == NULL || ssl->conf == NULL )
4727 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004730 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004733 ssl->out_msglen = 2;
4734 ssl->out_msg[0] = level;
4735 ssl->out_msg[1] = message;
4736
Hanno Becker67bc7c32018-08-06 11:33:50 +01004737 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004738 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004739 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004740 return( ret );
4741 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004743
4744 return( 0 );
4745}
4746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004748{
Janos Follath865b3eb2019-12-16 11:46:15 +00004749 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004751 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004752
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004754 ssl->out_msglen = 1;
4755 ssl->out_msg[0] = 1;
4756
Paul Bakker5121ce52009-01-03 21:22:43 +00004757 ssl->state++;
4758
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004759 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004760 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004761 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004762 return( ret );
4763 }
4764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004766
4767 return( 0 );
4768}
4769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004770int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004771{
Janos Follath865b3eb2019-12-16 11:46:15 +00004772 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004773
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004774 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004775
Hanno Becker327c93b2018-08-15 13:56:18 +01004776 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004777 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004778 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004779 return( ret );
4780 }
4781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004782 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004785 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4786 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004787 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004788 }
4789
Hanno Beckere678eaa2018-08-21 14:57:46 +01004790 /* CCS records are only accepted if they have length 1 and content '1',
4791 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004792
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004793 /*
4794 * Switch to our negotiated transform and session parameters for inbound
4795 * data.
4796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004798 ssl->transform_in = ssl->transform_negotiate;
4799 ssl->session_in = ssl->session_negotiate;
4800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004801#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004802 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004804#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004805 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004806#endif
4807
4808 /* Increment epoch */
4809 if( ++ssl->in_epoch == 0 )
4810 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004812 /* This is highly unlikely to happen for legitimate reasons, so
4813 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004815 }
4816 }
4817 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004819 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004820
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004821 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004822
Paul Bakker5121ce52009-01-03 21:22:43 +00004823 ssl->state++;
4824
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004825 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004826
4827 return( 0 );
4828}
4829
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004830/* Once ssl->out_hdr as the address of the beginning of the
4831 * next outgoing record is set, deduce the other pointers.
4832 *
4833 * Note: For TLS, we save the implicit record sequence number
4834 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4835 * and the caller has to make sure there's space for this.
4836 */
4837
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004838static size_t ssl_transform_get_explicit_iv_len(
4839 mbedtls_ssl_transform const *transform )
4840{
TRodziewiczef73f012021-05-13 14:53:36 +02004841 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004842 return( 0 );
4843
4844 return( transform->ivlen - transform->fixed_ivlen );
4845}
4846
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004847void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4848 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004849{
4850#if defined(MBEDTLS_SSL_PROTO_DTLS)
4851 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4852 {
4853 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004854#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004855 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004856 ssl->out_len = ssl->out_cid;
4857 if( transform != NULL )
4858 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004859#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004860 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004861#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004862 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004863 }
4864 else
4865#endif
4866 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004867 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004868#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004869 ssl->out_cid = ssl->out_len;
4870#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004871 ssl->out_iv = ssl->out_hdr + 5;
4872 }
4873
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004874 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004875 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004876 if( transform != NULL )
4877 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004878}
4879
4880/* Once ssl->in_hdr as the address of the beginning of the
4881 * next incoming record is set, deduce the other pointers.
4882 *
4883 * Note: For TLS, we save the implicit record sequence number
4884 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4885 * and the caller has to make sure there's space for this.
4886 */
4887
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004888void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004889{
Hanno Becker79594fd2019-05-08 09:38:41 +01004890 /* This function sets the pointers to match the case
4891 * of unprotected TLS/DTLS records, with both ssl->in_iv
4892 * and ssl->in_msg pointing to the beginning of the record
4893 * content.
4894 *
4895 * When decrypting a protected record, ssl->in_msg
4896 * will be shifted to point to the beginning of the
4897 * record plaintext.
4898 */
4899
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004900#if defined(MBEDTLS_SSL_PROTO_DTLS)
4901 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4902 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004903 /* This sets the header pointers to match records
4904 * without CID. When we receive a record containing
4905 * a CID, the fields are shifted accordingly in
4906 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004907 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004908#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004909 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004910 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004911#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004912 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004913#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004914 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004915 }
4916 else
4917#endif
4918 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004919 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004920 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004921#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004922 ssl->in_cid = ssl->in_len;
4923#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004924 ssl->in_iv = ssl->in_hdr + 5;
4925 }
4926
Hanno Becker79594fd2019-05-08 09:38:41 +01004927 /* This will be adjusted at record decryption time. */
4928 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004929}
4930
Paul Bakker5121ce52009-01-03 21:22:43 +00004931/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004932 * Setup an SSL context
4933 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004934
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004935void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004936{
4937 /* Set the incoming and outgoing record pointers. */
4938#if defined(MBEDTLS_SSL_PROTO_DTLS)
4939 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4940 {
4941 ssl->out_hdr = ssl->out_buf;
4942 ssl->in_hdr = ssl->in_buf;
4943 }
4944 else
4945#endif /* MBEDTLS_SSL_PROTO_DTLS */
4946 {
Hanno Becker12078f42021-03-02 15:28:41 +00004947 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004948 ssl->out_hdr = ssl->out_buf + 8;
4949 ssl->in_hdr = ssl->in_buf + 8;
4950 }
4951
4952 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004953 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4954 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004955}
4956
Paul Bakker5121ce52009-01-03 21:22:43 +00004957/*
4958 * SSL get accessors
4959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004961{
4962 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4963}
4964
Hanno Becker8b170a02017-10-10 11:51:19 +01004965int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4966{
4967 /*
4968 * Case A: We're currently holding back
4969 * a message for further processing.
4970 */
4971
4972 if( ssl->keep_current_message == 1 )
4973 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004974 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004975 return( 1 );
4976 }
4977
4978 /*
4979 * Case B: Further records are pending in the current datagram.
4980 */
4981
4982#if defined(MBEDTLS_SSL_PROTO_DTLS)
4983 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4984 ssl->in_left > ssl->next_record_offset )
4985 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004986 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004987 return( 1 );
4988 }
4989#endif /* MBEDTLS_SSL_PROTO_DTLS */
4990
4991 /*
4992 * Case C: A handshake message is being processed.
4993 */
4994
Hanno Becker8b170a02017-10-10 11:51:19 +01004995 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4996 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004997 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004998 return( 1 );
4999 }
5000
5001 /*
5002 * Case D: An application data message is being processed
5003 */
5004 if( ssl->in_offt != NULL )
5005 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005006 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005007 return( 1 );
5008 }
5009
5010 /*
5011 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005012 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005013 * we implement support for multiple alerts in single records.
5014 */
5015
5016 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5017 return( 0 );
5018}
5019
Paul Bakker43ca69c2011-01-15 17:35:19 +00005020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005022{
Hanno Becker3136ede2018-08-17 15:28:19 +01005023 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005024 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005025 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005026#if defined(MBEDTLS_USE_PSA_CRYPTO)
5027 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5028 psa_key_type_t key_type;
5029#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005030
Hanno Becker5903de42019-05-03 14:46:38 +01005031 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5032
Hanno Becker78640902018-08-13 16:35:15 +01005033 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005034 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005035
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005036
5037#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005038 if ( transform->psa_alg == PSA_ALG_GCM ||
5039 transform->psa_alg == PSA_ALG_CCM ||
5040 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5041 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005042 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005043 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005044 transform_expansion = transform->minlen;
5045 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005046 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005047 {
5048 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5049 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005050
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005051 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005052
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005053 /* Expansion due to the addition of the MAC. */
5054 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005055
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005056 /* Expansion due to the addition of CBC padding;
5057 * Theoretically up to 256 bytes, but we never use
5058 * more than the block size of the underlying cipher. */
5059 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005060
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005061 /* For TLS 1.2 or higher, an explicit IV is added
5062 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005063#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005064 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005065#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005066 }
5067 else
5068 {
5069 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5070 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005071 }
5072#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005073 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005074 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005075 case MBEDTLS_MODE_GCM:
5076 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005077 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005078 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005079 transform_expansion = transform->minlen;
5080 break;
5081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005082 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005083
5084 block_size = mbedtls_cipher_get_block_size(
5085 &transform->cipher_ctx_enc );
5086
Hanno Becker3136ede2018-08-17 15:28:19 +01005087 /* Expansion due to the addition of the MAC. */
5088 transform_expansion += transform->maclen;
5089
5090 /* Expansion due to the addition of CBC padding;
5091 * Theoretically up to 256 bytes, but we never use
5092 * more than the block size of the underlying cipher. */
5093 transform_expansion += block_size;
5094
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005095 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005096 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005097#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005098 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005099#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005100
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005101 break;
5102
5103 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005104 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005106 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005108
Hanno Beckera0e20d02019-05-15 14:03:01 +01005109#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005110 if( transform->out_cid_len != 0 )
5111 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005112#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005113
Hanno Becker5903de42019-05-03 14:46:38 +01005114 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005115}
5116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005117#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005118/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005119 * Check record counters and renegotiate if they're above the limit.
5120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005121static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005122{
Hanno Beckerdd772292020-02-05 10:38:31 +00005123 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005124 int in_ctr_cmp;
5125 int out_ctr_cmp;
5126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005127 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5128 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005129 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005130 {
5131 return( 0 );
5132 }
5133
Andres AG2196c7f2016-12-15 17:01:16 +00005134 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005135 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005136 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005137 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5138 &ssl->conf->renego_period[ep_len],
5139 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005140
5141 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005142 {
5143 return( 0 );
5144 }
5145
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005146 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005147 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005148}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005149#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005150
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005151/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005152 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005153 * may only be sent for the purpose of initiating renegotiations.
5154 *
5155 * This function is introduced as a separate helper since the handling
5156 * of post-handshake handshake messages changes significantly in TLS 1.3,
5157 * and having a helper function allows to distinguish between TLS <= 1.2 and
5158 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5159 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005160static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005161{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005162 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005163
5164 /*
5165 * - For client-side, expect SERVER_HELLO_REQUEST.
5166 * - For server-side, expect CLIENT_HELLO.
5167 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5168 */
5169
5170#if defined(MBEDTLS_SSL_CLI_C)
5171 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5172 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5173 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5174 {
5175 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5176
5177 /* With DTLS, drop the packet (probably from last handshake) */
5178#if defined(MBEDTLS_SSL_PROTO_DTLS)
5179 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5180 {
5181 return( 0 );
5182 }
5183#endif
5184 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5185 }
5186#endif /* MBEDTLS_SSL_CLI_C */
5187
5188#if defined(MBEDTLS_SSL_SRV_C)
5189 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5190 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5191 {
5192 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5193
5194 /* With DTLS, drop the packet (probably from last handshake) */
5195#if defined(MBEDTLS_SSL_PROTO_DTLS)
5196 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5197 {
5198 return( 0 );
5199 }
5200#endif
5201 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5202 }
5203#endif /* MBEDTLS_SSL_SRV_C */
5204
5205#if defined(MBEDTLS_SSL_RENEGOTIATION)
5206 /* Determine whether renegotiation attempt should be accepted */
5207 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5208 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5209 ssl->conf->allow_legacy_renegotiation ==
5210 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5211 {
5212 /*
5213 * Accept renegotiation request
5214 */
5215
5216 /* DTLS clients need to know renego is server-initiated */
5217#if defined(MBEDTLS_SSL_PROTO_DTLS)
5218 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5219 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5220 {
5221 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5222 }
5223#endif
5224 ret = mbedtls_ssl_start_renegotiation( ssl );
5225 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5226 ret != 0 )
5227 {
5228 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5229 ret );
5230 return( ret );
5231 }
5232 }
5233 else
5234#endif /* MBEDTLS_SSL_RENEGOTIATION */
5235 {
5236 /*
5237 * Refuse renegotiation
5238 */
5239
5240 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5241
TRodziewicz0f82ec62021-05-12 17:49:18 +02005242#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005243 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5244 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5245 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005246 {
TRodziewicz345165c2021-07-06 13:42:11 +02005247 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005248 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005249#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005250 }
5251
5252 return( 0 );
5253}
5254
Paul Bakker48916f92012-09-16 19:57:18 +00005255/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005256 * Receive application data decrypted from the SSL layer
5257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005258int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005259{
Janos Follath865b3eb2019-12-16 11:46:15 +00005260 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005261 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005262
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005263 if( ssl == NULL || ssl->conf == NULL )
5264 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5265
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005269 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005270 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005271 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005272 return( ret );
5273
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005274 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005275 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005276 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005277 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005278 return( ret );
5279 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005280 }
5281#endif
5282
Hanno Becker4a810fb2017-05-24 16:27:30 +01005283 /*
5284 * Check if renegotiation is necessary and/or handshake is
5285 * in process. If yes, perform/continue, and fall through
5286 * if an unexpected packet is received while the client
5287 * is waiting for the ServerHello.
5288 *
5289 * (There is no equivalent to the last condition on
5290 * the server-side as it is not treated as within
5291 * a handshake while waiting for the ClientHello
5292 * after a renegotiation request.)
5293 */
5294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005295#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005296 ret = ssl_check_ctr_renegotiate( ssl );
5297 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5298 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005299 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005300 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005301 return( ret );
5302 }
5303#endif
5304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005305 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005306 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005307 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005308 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5309 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005310 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005311 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005312 return( ret );
5313 }
5314 }
5315
Hanno Beckere41158b2017-10-23 13:30:32 +01005316 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005317 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005318 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005319 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005320 if( ssl->f_get_timer != NULL &&
5321 ssl->f_get_timer( ssl->p_timer ) == -1 )
5322 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005323 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005324 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005325
Hanno Becker327c93b2018-08-15 13:56:18 +01005326 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005327 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005328 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5329 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005330
Hanno Becker4a810fb2017-05-24 16:27:30 +01005331 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5332 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005333 }
5334
5335 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005336 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005337 {
5338 /*
5339 * OpenSSL sends empty messages to randomize the IV
5340 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005341 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005342 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005344 return( 0 );
5345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005347 return( ret );
5348 }
5349 }
5350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005351 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005352 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005353 ret = ssl_handle_hs_message_post_handshake( ssl );
5354 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005355 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005356 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5357 ret );
5358 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005359 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005360
Hanno Beckerf26cc722021-04-21 07:30:13 +01005361 /* At this point, we don't know whether the renegotiation triggered
5362 * by the post-handshake message has been completed or not. The cases
5363 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005364 * 1) The renegotiation is complete. In this case, no new record
5365 * has been read yet.
5366 * 2) The renegotiation is incomplete because the client received
5367 * an application data record while awaiting the ServerHello.
5368 * 3) The renegotiation is incomplete because the client received
5369 * a non-handshake, non-application data message while awaiting
5370 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005371 *
5372 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005373 * - For 1), the next iteration will read a new record and check
5374 * if it's application data.
5375 * - For 2), the loop condition isn't satisfied as application data
5376 * is present, hence continue is the same as break
5377 * - For 3), the loop condition is satisfied and read_record
5378 * will re-deliver the message that was held back by the client
5379 * when expecting the ServerHello.
5380 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005381
Hanno Becker90333da2017-10-10 11:27:13 +01005382 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005383 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005384#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005385 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005386 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005387 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005388 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005389 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005390 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005392 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005394 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005395 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005396 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005397#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5400 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005401 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005402 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005403 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005404 }
5405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005406 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005407 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005408 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5409 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005410 }
5411
5412 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005413
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005414 /* We're going to return something now, cancel timer,
5415 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005417 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005418
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005419#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005420 /* If we requested renego but received AppData, resend HelloRequest.
5421 * Do it now, after setting in_offt, to avoid taking this branch
5422 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005424 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005425 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005426 {
Hanno Becker786300f2020-02-05 10:46:40 +00005427 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005428 {
Hanno Becker786300f2020-02-05 10:46:40 +00005429 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5430 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005431 return( ret );
5432 }
5433 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005435#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 }
5437
5438 n = ( len < ssl->in_msglen )
5439 ? len : ssl->in_msglen;
5440
5441 memcpy( buf, ssl->in_offt, n );
5442 ssl->in_msglen -= n;
5443
gabor-mezei-arma3214132020-07-15 10:55:00 +02005444 /* Zeroising the plaintext buffer to erase unused application data
5445 from the memory. */
5446 mbedtls_platform_zeroize( ssl->in_offt, n );
5447
Paul Bakker5121ce52009-01-03 21:22:43 +00005448 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005449 {
5450 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005451 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005452 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005453 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005454 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005455 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005456 /* more data available */
5457 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005458 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005459
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005460 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005461
Paul Bakker23986e52011-04-24 08:57:21 +00005462 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005463}
5464
5465/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005466 * Send application data to be encrypted by the SSL layer, taking care of max
5467 * fragment length and buffer size.
5468 *
5469 * According to RFC 5246 Section 6.2.1:
5470 *
5471 * Zero-length fragments of Application data MAY be sent as they are
5472 * potentially useful as a traffic analysis countermeasure.
5473 *
5474 * Therefore, it is possible that the input message length is 0 and the
5475 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005476 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005477static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005478 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005479{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005480 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5481 const size_t max_len = (size_t) ret;
5482
5483 if( ret < 0 )
5484 {
5485 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5486 return( ret );
5487 }
5488
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005489 if( len > max_len )
5490 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005492 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005493 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005495 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5496 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005497 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005499 }
5500 else
5501#endif
5502 len = max_len;
5503 }
Paul Bakker887bd502011-06-08 13:10:54 +00005504
Paul Bakker5121ce52009-01-03 21:22:43 +00005505 if( ssl->out_left != 0 )
5506 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005507 /*
5508 * The user has previously tried to send the data and
5509 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5510 * written. In this case, we expect the high-level write function
5511 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005513 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005514 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005515 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005516 return( ret );
5517 }
5518 }
Paul Bakker887bd502011-06-08 13:10:54 +00005519 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005520 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005521 /*
5522 * The user is trying to send a message the first time, so we need to
5523 * copy the data into the internal buffers and setup the data structure
5524 * to keep track of partial writes
5525 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005526 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005527 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005528 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005529
Hanno Becker67bc7c32018-08-06 11:33:50 +01005530 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005532 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005533 return( ret );
5534 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005535 }
5536
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005537 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005538}
5539
5540/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005541 * Write application data (public-facing wrapper)
5542 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005543int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005544{
Janos Follath865b3eb2019-12-16 11:46:15 +00005545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005546
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005547 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005548
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005549 if( ssl == NULL || ssl->conf == NULL )
5550 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5551
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005552#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005553 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5554 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005555 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005556 return( ret );
5557 }
5558#endif
5559
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005560 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005561 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005562 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005563 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005564 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005565 return( ret );
5566 }
5567 }
5568
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005569 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005570
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005571 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005572
5573 return( ret );
5574}
5575
5576/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005577 * Notify the peer that the connection is being closed
5578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005579int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005580{
Janos Follath865b3eb2019-12-16 11:46:15 +00005581 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005582
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005583 if( ssl == NULL || ssl->conf == NULL )
5584 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005586 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005587
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005588 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005589 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005591 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005593 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5594 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5595 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005596 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005597 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005598 return( ret );
5599 }
5600 }
5601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005602 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005603
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005604 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005605}
5606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005607void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005608{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005609 if( transform == NULL )
5610 return;
5611
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005612#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005613 psa_destroy_key( transform->psa_key_enc );
5614 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005615#else
5616 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5617 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5618#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005619
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005620#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005621 mbedtls_md_free( &transform->md_ctx_enc );
5622 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005623#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005624
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005625 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005626}
5627
Jerry Yuc7875b52021-09-05 21:05:50 +08005628void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5629 mbedtls_ssl_transform *transform )
5630{
Jerry Yuc7875b52021-09-05 21:05:50 +08005631 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005632 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005633}
5634
5635void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5636 mbedtls_ssl_transform *transform )
5637{
5638 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005639 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005640}
5641
Hanno Becker0271f962018-08-16 13:23:47 +01005642#if defined(MBEDTLS_SSL_PROTO_DTLS)
5643
Hanno Becker533ab5f2020-02-05 10:49:13 +00005644void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005645{
5646 unsigned offset;
5647 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5648
5649 if( hs == NULL )
5650 return;
5651
Hanno Becker283f5ef2018-08-24 09:34:47 +01005652 ssl_free_buffered_record( ssl );
5653
Hanno Becker0271f962018-08-16 13:23:47 +01005654 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005655 ssl_buffering_free_slot( ssl, offset );
5656}
5657
5658static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5659 uint8_t slot )
5660{
5661 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5662 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005663
5664 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5665 return;
5666
Hanno Beckere605b192018-08-21 15:59:07 +01005667 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005668 {
Hanno Beckere605b192018-08-21 15:59:07 +01005669 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005670 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005671 mbedtls_free( hs_buf->data );
5672 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005673 }
5674}
5675
5676#endif /* MBEDTLS_SSL_PROTO_DTLS */
5677
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005678/*
5679 * Convert version numbers to/from wire format
5680 * and, for DTLS, to/from TLS equivalent.
5681 *
5682 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005683 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005684 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005686void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005687 unsigned char ver[2] )
5688{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689#if defined(MBEDTLS_SSL_PROTO_DTLS)
5690 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005692 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005693 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5694
5695 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5696 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5697 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005698 else
5699#else
5700 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005701#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005702 {
5703 ver[0] = (unsigned char) major;
5704 ver[1] = (unsigned char) minor;
5705 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005706}
5707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005708void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005709 const unsigned char ver[2] )
5710{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005711#if defined(MBEDTLS_SSL_PROTO_DTLS)
5712 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005713 {
5714 *major = 255 - ver[0] + 2;
5715 *minor = 255 - ver[1] + 1;
5716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005718 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5719 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005720 else
5721#else
5722 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005723#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005724 {
5725 *major = ver[0];
5726 *minor = ver[1];
5727 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005728}
5729
Jerry Yue7047812021-09-13 19:26:39 +08005730/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005731 * Send pending fatal alert.
5732 * 0, No alert message.
5733 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5734 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005735 */
5736int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5737{
5738 int ret;
5739
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005740 /* No pending alert, return success*/
5741 if( ssl->send_alert == 0 )
5742 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005743
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005744 ret = mbedtls_ssl_send_alert_message( ssl,
5745 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5746 ssl->alert_type );
5747
Jerry Yu3bf1f972021-09-22 21:37:18 +08005748 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5749 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005750 */
5751 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5752 {
5753 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005754 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005755
5756 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005757 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005758
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005759 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005760}
5761
Jerry Yu394ece62021-09-14 22:17:21 +08005762/*
5763 * Set pending fatal alert flag.
5764 */
5765void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5766 unsigned char alert_type,
5767 int alert_reason )
5768{
5769 ssl->send_alert = 1;
5770 ssl->alert_type = alert_type;
5771 ssl->alert_reason = alert_reason;
5772}
5773
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005774#endif /* MBEDTLS_SSL_TLS_C */