blob: 43b81b437d88c1f03b4866ccaf974a05f956d4a2 [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;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100676#if defined(MBEDTLS_USE_PSA_CRYPTO)
677 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
679 size_t sign_mac_length = 0;
680#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +0000681
TRodziewicz345165c2021-07-06 13:42:11 +0200682 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000683 transform->minor_ver,
684 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000685
Neil Armstrong26e6d672022-02-23 09:30:33 +0100686#if defined(MBEDTLS_USE_PSA_CRYPTO)
687 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
688 transform->psa_mac_alg );
689 if( status != PSA_SUCCESS )
690 goto hmac_failed_etm_disabled;
691
692 status = psa_mac_update( &operation, add_data, add_data_len );
693 if( status != PSA_SUCCESS )
694 goto hmac_failed_etm_disabled;
695
696 status = psa_mac_update( &operation, data, rec->data_len );
697 if( status != PSA_SUCCESS )
698 goto hmac_failed_etm_disabled;
699
700 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
701 &sign_mac_length );
702 if( status != PSA_SUCCESS )
703 goto hmac_failed_etm_disabled;
704#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100705 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
706 add_data_len );
707 if( ret != 0 )
708 goto hmac_failed_etm_disabled;
709 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
710 if( ret != 0 )
711 goto hmac_failed_etm_disabled;
712 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
713 if( ret != 0 )
714 goto hmac_failed_etm_disabled;
715 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
716 if( ret != 0 )
717 goto hmac_failed_etm_disabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100718#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000719
TRodziewicz345165c2021-07-06 13:42:11 +0200720 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200721#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200722
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000723 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
724 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200725
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 rec->data_len += transform->maclen;
727 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100728 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100729
730 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100731 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +0100732#if defined(MBEDTLS_USE_PSA_CRYPTO)
733 psa_mac_abort( &operation );
734 if( status != PSA_SUCCESS )
735 {
736 ret = psa_ssl_status_to_mbedtls( status );
737#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100738 if( ret != 0 )
739 {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100740#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100741 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
742 return( ret );
743 }
Paul Bakker577e0062013-08-28 11:57:20 +0200744 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000745#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000746
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200747 /*
748 * Encrypt
749 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000750#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100751#if defined(MBEDTLS_USE_PSA_CRYPTO)
752 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
753#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100755#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000756 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000757 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000758 "including %d bytes of padding",
759 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000760
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100761 /* The only supported stream cipher is "NULL",
762 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000763 }
Paul Bakker68884e32013-01-07 18:20:04 +0100764 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000765#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000766
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200767#if defined(MBEDTLS_GCM_C) || \
768 defined(MBEDTLS_CCM_C) || \
769 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100770#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +0100771 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100772#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200774 mode == MBEDTLS_MODE_CCM ||
775 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100776#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +0000777 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200778 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100779 unsigned char *dynamic_iv;
780 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100781 int dynamic_iv_is_explicit =
782 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100783#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100784 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100785#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000787
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100788 /* Check that there's space for the authentication tag. */
789 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000790 {
791 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
792 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
793 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000794
Paul Bakker68884e32013-01-07 18:20:04 +0100795 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100796 * Build nonce for AEAD encryption.
797 *
798 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
799 * part of the IV is prepended to the ciphertext and
800 * can be chosen freely - in particular, it need not
801 * agree with the record sequence number.
802 * However, since ChaChaPoly as well as all AEAD modes
803 * in TLS 1.3 use the record sequence number as the
804 * dynamic part of the nonce, we uniformly use the
805 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100806 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100807 dynamic_iv = rec->ctr;
808 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200809
Hanno Becker17263802020-05-28 07:05:48 +0100810 ssl_build_record_nonce( iv, sizeof( iv ),
811 transform->iv_enc,
812 transform->fixed_ivlen,
813 dynamic_iv,
814 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100815
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100816 /*
817 * Build additional data for AEAD encryption.
818 * This depends on the TLS version.
819 */
820 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000821 transform->minor_ver,
822 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100823
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200824 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100825 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200826 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100827 dynamic_iv,
828 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000829 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100830 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000831 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200832 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000833 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000834
Paul Bakker68884e32013-01-07 18:20:04 +0100835 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200836 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200837 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100838#if defined(MBEDTLS_USE_PSA_CRYPTO)
839 status = psa_aead_encrypt( transform->psa_key_enc,
840 transform->psa_alg,
841 iv, transform->ivlen,
842 add_data, add_data_len,
843 data, rec->data_len,
844 data, rec->buf_len - (data - rec->buf),
845 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100847 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100848 {
849 ret = psa_ssl_status_to_mbedtls( status );
850 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
851 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100852 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100853#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100854 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000855 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100856 add_data, add_data_len,
857 data, rec->data_len, /* src */
858 data, rec->buf_len - (data - rec->buf), /* dst */
859 &rec->data_len,
860 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200861 {
TRodziewicz18efb732021-04-29 23:12:19 +0200862 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200863 return( ret );
864 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100865#endif /* MBEDTLS_USE_PSA_CRYPTO */
866
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100868 data + rec->data_len - transform->taglen,
869 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100870 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000871 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100872
873 /*
874 * Prefix record content with dynamic IV in case it is explicit.
875 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100876 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100877 {
878 if( rec->data_offset < dynamic_iv_len )
879 {
880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
881 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
882 }
883
884 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
885 rec->data_offset -= dynamic_iv_len;
886 rec->data_len += dynamic_iv_len;
887 }
888
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100889 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000890 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000891 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100892#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200893#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100894#if defined(MBEDTLS_USE_PSA_CRYPTO)
895 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
896#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100898#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000899 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000901 size_t padlen, i;
902 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100903#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100905 size_t part_len;
906 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
907#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000908
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 /* Currently we're always using minimal padding
910 * (up to 255 bytes would be allowed). */
911 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
912 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000913 padlen = 0;
914
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000915 /* Check there's enough space in the buffer for the padding. */
916 if( post_avail < padlen + 1 )
917 {
918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
919 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
920 }
921
Paul Bakker5121ce52009-01-03 21:22:43 +0000922 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000923 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000924
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000925 rec->data_len += padlen + 1;
926 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000927
TRodziewicz0f82ec62021-05-12 17:49:18 +0200928#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000929 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200930 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000931 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000932 */
TRodziewicz345165c2021-07-06 13:42:11 +0200933 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000934 {
TRodziewicz345165c2021-07-06 13:42:11 +0200935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
936 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000937 }
TRodziewicz345165c2021-07-06 13:42:11 +0200938
939 if( rec->data_offset < transform->ivlen )
940 {
941 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
942 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
943 }
944
945 /*
946 * Generate IV
947 */
948 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
949 if( ret != 0 )
950 return( ret );
951
952 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200953#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000954
Paul Elliottd48d5c62021-01-07 14:47:05 +0000955 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
956 "including %" MBEDTLS_PRINTF_SIZET
957 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000958 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200959 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000960
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100961#if defined(MBEDTLS_USE_PSA_CRYPTO)
962 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100963 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100964
965 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100966 {
967 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100968 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_encrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100969 return( ret );
970 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100971
972 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
973
974 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100975 {
976 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100977 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100978 return( ret );
979
980 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100981
982 status = psa_cipher_update( &cipher_op,
983 data, rec->data_len,
984 data, rec->data_len, &olen );
985
986 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100987 {
988 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100989 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100990 return( ret );
991
992 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100993
994 status = psa_cipher_finish( &cipher_op,
995 data + olen, rec->data_len - olen,
996 &part_len );
997
998 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100999 {
1000 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001001 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001002 return( ret );
1003
1004 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001005
1006 olen += part_len;
1007#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001008 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
1009 transform->iv_enc,
1010 transform->ivlen,
1011 data, rec->data_len,
1012 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001013 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001015 return( ret );
1016 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001017#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001018
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001019 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001020 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1022 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001023 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001024
TRodziewicz0f82ec62021-05-12 17:49:18 +02001025 data -= transform->ivlen;
1026 rec->data_offset -= transform->ivlen;
1027 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001030 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001031 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001032 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1035 size_t sign_mac_length = 0;
1036#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001037
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001038 /*
1039 * MAC(MAC_write_key, seq_num +
1040 * TLSCipherText.type +
1041 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001042 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001043 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001044 * ENC(content + padding + padding_length));
1045 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001046
1047 if( post_avail < transform->maclen)
1048 {
1049 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1050 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1051 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001052
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001053 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001054 rec, transform->minor_ver,
1055 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001058 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001059 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001060#if defined(MBEDTLS_USE_PSA_CRYPTO)
1061 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
1062 transform->psa_mac_alg );
1063 if( status != PSA_SUCCESS )
1064 goto hmac_failed_etm_enabled;
1065
1066 status = psa_mac_update( &operation, add_data, add_data_len );
1067 if( status != PSA_SUCCESS )
1068 goto hmac_failed_etm_enabled;
1069
1070 status = psa_mac_update( &operation, data, rec->data_len );
1071 if( status != PSA_SUCCESS )
1072 goto hmac_failed_etm_enabled;
1073
1074 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
1075 &sign_mac_length );
1076 if( status != PSA_SUCCESS )
1077 goto hmac_failed_etm_enabled;
1078#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001079
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001080 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1081 add_data_len );
1082 if( ret != 0 )
1083 goto hmac_failed_etm_enabled;
1084 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1085 data, rec->data_len );
1086 if( ret != 0 )
1087 goto hmac_failed_etm_enabled;
1088 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1089 if( ret != 0 )
1090 goto hmac_failed_etm_enabled;
1091 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1092 if( ret != 0 )
1093 goto hmac_failed_etm_enabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001094#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001095
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001096 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001097
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001098 rec->data_len += transform->maclen;
1099 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001100 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001101
1102 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001103 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001104#if defined(MBEDTLS_USE_PSA_CRYPTO)
1105 psa_mac_abort( &operation );
1106 if( status != PSA_SUCCESS )
1107 {
1108 ret = psa_ssl_status_to_mbedtls( status );
1109#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001110 if( ret != 0 )
1111 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001112#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001113 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1114 return( ret );
1115 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001116 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001118 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001119 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001120#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001121 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1123 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001124 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001125
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001126 /* Make extra sure authentication was performed, exactly once */
1127 if( auth_done != 1 )
1128 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1130 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001131 }
1132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001134
1135 return( 0 );
1136}
1137
Hanno Becker605949f2019-07-12 08:23:59 +01001138int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001139 mbedtls_ssl_transform *transform,
1140 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001141{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001142 size_t olen;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001143#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001144 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001145
1146#else
1147 mbedtls_cipher_mode_t mode;
1148 int ret;
1149#endif /* MBEDTLS_USE_PSA_CRYPTO */
1150
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001151 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001152#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001153 size_t padlen = 0, correct = 1;
1154#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001155 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001156 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001157 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001158
Hanno Beckera18d1322018-01-03 14:27:32 +00001159#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001160 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001161 ((void) ssl);
1162#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001165 if( rec == NULL ||
1166 rec->buf == NULL ||
1167 rec->buf_len < rec->data_offset ||
1168 rec->buf_len - rec->data_offset < rec->data_len )
1169 {
1170 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001172 }
1173
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001174 data = rec->buf + rec->data_offset;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001175#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001176 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001177#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001178
Hanno Beckera0e20d02019-05-15 14:03:01 +01001179#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001180 /*
1181 * Match record's CID with incoming CID.
1182 */
Hanno Becker938489a2019-05-08 13:02:22 +01001183 if( rec->cid_len != transform->in_cid_len ||
1184 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1185 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001186 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001187 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001188#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001189
Hanno Beckerd086bf02021-03-22 13:01:27 +00001190#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001191#if defined(MBEDTLS_USE_PSA_CRYPTO)
1192 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
1193#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001195#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker68884e32013-01-07 18:20:04 +01001196 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001197 /* The only supported stream cipher is "NULL",
1198 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001199 }
Paul Bakker68884e32013-01-07 18:20:04 +01001200 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001201#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001202#if defined(MBEDTLS_GCM_C) || \
1203 defined(MBEDTLS_CCM_C) || \
1204 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001205#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +01001206 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001207#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001209 mode == MBEDTLS_MODE_CCM ||
1210 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001211#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001212 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001213 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001214 unsigned char *dynamic_iv;
1215 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001216#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001217 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001218#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001219
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001220 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001221 * Extract dynamic part of nonce for AEAD decryption.
1222 *
1223 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1224 * part of the IV is prepended to the ciphertext and
1225 * can be chosen freely - in particular, it need not
1226 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001227 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001228 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001229 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001230 {
1231 if( rec->data_len < dynamic_iv_len )
1232 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001233 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1234 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001235 rec->data_len,
1236 dynamic_iv_len ) );
1237 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1238 }
1239 dynamic_iv = data;
1240
1241 data += dynamic_iv_len;
1242 rec->data_offset += dynamic_iv_len;
1243 rec->data_len -= dynamic_iv_len;
1244 }
Hanno Becker17263802020-05-28 07:05:48 +01001245 else
1246 {
1247 dynamic_iv = rec->ctr;
1248 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001249
1250 /* Check that there's space for the authentication tag. */
1251 if( rec->data_len < transform->taglen )
1252 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001253 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1254 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001255 rec->data_len,
1256 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001258 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001259 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001260
Hanno Beckerdf8be222020-05-21 15:30:57 +01001261 /*
1262 * Prepare nonce from dynamic and static parts.
1263 */
Hanno Becker17263802020-05-28 07:05:48 +01001264 ssl_build_record_nonce( iv, sizeof( iv ),
1265 transform->iv_dec,
1266 transform->fixed_ivlen,
1267 dynamic_iv,
1268 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001269
Hanno Beckerdf8be222020-05-21 15:30:57 +01001270 /*
1271 * Build additional data for AEAD encryption.
1272 * This depends on the TLS version.
1273 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001274 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001275 transform->minor_ver,
1276 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001277 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001278 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001279
Hanno Beckerd96a6522019-07-10 13:55:25 +01001280 /* Because of the check above, we know that there are
1281 * explicit_iv_len Bytes preceeding data, and taglen
1282 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001283 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001284 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001285
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001286 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001287 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001288 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001289
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001290 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001291 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001292 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001293#if defined(MBEDTLS_USE_PSA_CRYPTO)
1294 status = psa_aead_decrypt( transform->psa_key_dec,
1295 transform->psa_alg,
1296 iv, transform->ivlen,
1297 add_data, add_data_len,
1298 data, rec->data_len + transform->taglen,
1299 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001300 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001301
1302 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001303 {
1304 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001305 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001306 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001307 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001308#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001309 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001310 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001311 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001312 data, rec->data_len + transform->taglen, /* src */
1313 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001314 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001315 {
TRodziewicz18efb732021-04-29 23:12:19 +02001316 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1319 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001320
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001321 return( ret );
1322 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001323#endif /* MBEDTLS_USE_PSA_CRYPTO */
1324
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001325 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001326
Hanno Beckerd96a6522019-07-10 13:55:25 +01001327 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001328 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001329 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1331 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001332 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001333 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001334 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001336#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001337#if defined(MBEDTLS_USE_PSA_CRYPTO)
1338 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
1339#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001340 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001341#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001342 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001343 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001344#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001346 size_t part_len;
1347 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1348#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001349
Paul Bakker5121ce52009-01-03 21:22:43 +00001350 /*
Paul Bakker45829992013-01-03 14:52:21 +01001351 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001352 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001353#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001354 /* The ciphertext is prefixed with the CBC IV. */
1355 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001356#endif
Paul Bakker45829992013-01-03 14:52:21 +01001357
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001358 /* Size considerations:
1359 *
1360 * - The CBC cipher text must not be empty and hence
1361 * at least of size transform->ivlen.
1362 *
1363 * Together with the potential IV-prefix, this explains
1364 * the first of the two checks below.
1365 *
1366 * - The record must contain a MAC, either in plain or
1367 * encrypted, depending on whether Encrypt-then-MAC
1368 * is used or not.
1369 * - If it is, the message contains the IV-prefix,
1370 * the CBC ciphertext, and the MAC.
1371 * - If it is not, the padded plaintext, and hence
1372 * the CBC ciphertext, has at least length maclen + 1
1373 * because there is at least the padding length byte.
1374 *
1375 * As the CBC ciphertext is not empty, both cases give the
1376 * lower bound minlen + maclen + 1 on the record size, which
1377 * we test for in the second check below.
1378 */
1379 if( rec->data_len < minlen + transform->ivlen ||
1380 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001381 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001382 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1383 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1384 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001385 "+ 1 ) ( + expl IV )", rec->data_len,
1386 transform->ivlen,
1387 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001389 }
1390
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001391 /*
1392 * Authenticate before decrypt if enabled
1393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001395 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001396 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001397#if defined(MBEDTLS_USE_PSA_CRYPTO)
1398 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1399#else
Hanno Becker992b6872017-11-09 18:57:39 +00001400 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001401#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001402
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001403 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001404
Hanno Beckerd96a6522019-07-10 13:55:25 +01001405 /* Update data_len in tandem with add_data.
1406 *
1407 * The subtraction is safe because of the previous check
1408 * data_len >= minlen + maclen + 1.
1409 *
1410 * Afterwards, we know that data + data_len is followed by at
1411 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001412 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001413 *
1414 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001415 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001416 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001417 transform->minor_ver,
1418 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001419
Hanno Beckerd96a6522019-07-10 13:55:25 +01001420 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001421 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1422 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001423#if defined(MBEDTLS_USE_PSA_CRYPTO)
1424 status = psa_mac_verify_setup( &operation, transform->psa_mac_dec,
1425 transform->psa_mac_alg );
1426 if( status != PSA_SUCCESS )
1427 goto hmac_failed_etm_enabled;
1428
1429 status = psa_mac_update( &operation, add_data, add_data_len );
1430 if( status != PSA_SUCCESS )
1431 goto hmac_failed_etm_enabled;
1432
1433 status = psa_mac_update( &operation, data, rec->data_len );
1434 if( status != PSA_SUCCESS )
1435 goto hmac_failed_etm_enabled;
1436
1437 /* Compare expected MAC with MAC at the end of the record. */
1438 status = psa_mac_verify_finish( &operation, data + rec->data_len,
1439 transform->maclen );
1440 if( status != PSA_SUCCESS )
1441 goto hmac_failed_etm_enabled;
1442#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001443 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1444 add_data_len );
1445 if( ret != 0 )
1446 goto hmac_failed_etm_enabled;
1447 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001448 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001449 if( ret != 0 )
1450 goto hmac_failed_etm_enabled;
1451 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1452 if( ret != 0 )
1453 goto hmac_failed_etm_enabled;
1454 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1455 if( ret != 0 )
1456 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001457
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001458 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1459 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001460 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001462
Hanno Beckerd96a6522019-07-10 13:55:25 +01001463 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001464 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001465 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001466 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001467 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001468 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1469 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001470 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001471#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001472 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001473
1474 hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001475#if defined(MBEDTLS_USE_PSA_CRYPTO)
1476 psa_mac_abort( &operation );
1477 if( status != PSA_SUCCESS )
1478 {
1479 ret = psa_ssl_status_to_mbedtls( status );
1480#else
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001481 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1482 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001483 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001484#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001485 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1486 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001487 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001488 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001489 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001491
1492 /*
1493 * Check length sanity
1494 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001495
1496 /* We know from above that data_len > minlen >= 0,
1497 * so the following check in particular implies that
1498 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001499 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001500 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1502 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001503 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001505 }
1506
TRodziewicz0f82ec62021-05-12 17:49:18 +02001507#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001508 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001509 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001510 */
TRodziewicz345165c2021-07-06 13:42:11 +02001511 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1512 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001513
TRodziewicz345165c2021-07-06 13:42:11 +02001514 data += transform->ivlen;
1515 rec->data_offset += transform->ivlen;
1516 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001517#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001518
Hanno Beckerd96a6522019-07-10 13:55:25 +01001519 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1520
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001521#if defined(MBEDTLS_USE_PSA_CRYPTO)
1522 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001523 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001524
1525 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001526 {
1527 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001528 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001529 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001530 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001531
1532 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1533
1534 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001535 {
1536 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001537 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001538 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001539 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001540
1541 status = psa_cipher_update( &cipher_op,
1542 data, rec->data_len,
1543 data, rec->data_len, &olen );
1544
1545 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001546 {
1547 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001548 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001549 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001550 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001551
1552 status = psa_cipher_finish( &cipher_op,
1553 data + olen, rec->data_len - olen,
1554 &part_len );
1555
1556 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001557 {
1558 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001559 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001560 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001561 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001562
1563 olen += part_len;
1564#else
1565
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001566 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1567 transform->iv_dec, transform->ivlen,
1568 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001569 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001571 return( ret );
1572 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001573#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001574
Hanno Beckerd96a6522019-07-10 13:55:25 +01001575 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001576 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001577 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1579 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001580 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001581
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001582 /* Safe since data_len >= minlen + maclen + 1, so after having
1583 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001584 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1585 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001586 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001587
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001588 if( auth_done == 1 )
1589 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001590 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001591 rec->data_len,
1592 padlen + 1 );
1593 correct &= mask;
1594 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001595 }
1596 else
Paul Bakker45829992013-01-03 14:52:21 +01001597 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001599 if( rec->data_len < transform->maclen + padlen + 1 )
1600 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1602 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1603 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001604 rec->data_len,
1605 transform->maclen,
1606 padlen + 1 ) );
1607 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001608#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001609
Gabor Mezei90437e32021-10-20 11:59:27 +02001610 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001611 rec->data_len,
1612 transform->maclen + padlen + 1 );
1613 correct &= mask;
1614 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001615 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001616
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001617 padlen++;
1618
1619 /* Regardless of the validity of the padding,
1620 * we have data_len >= padlen here. */
1621
TRodziewicz0f82ec62021-05-12 17:49:18 +02001622#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001623 /* The padding check involves a series of up to 256
1624 * consecutive memory reads at the end of the record
1625 * plaintext buffer. In order to hide the length and
1626 * validity of the padding, always perform exactly
1627 * `min(256,plaintext_len)` reads (but take into account
1628 * only the last `padlen` bytes for the padding check). */
1629 size_t pad_count = 0;
1630 volatile unsigned char* const check = data;
1631
1632 /* Index of first padding byte; it has been ensured above
1633 * that the subtraction is safe. */
1634 size_t const padding_idx = rec->data_len - padlen;
1635 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1636 size_t const start_idx = rec->data_len - num_checks;
1637 size_t idx;
1638
1639 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001640 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001641 /* pad_count += (idx >= padding_idx) &&
1642 * (check[idx] == padlen - 1);
1643 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001644 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1645 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001646 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001647 pad_count += mask & equal;
1648 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001649 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001652 if( padlen > 0 && correct == 0 )
1653 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001654#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001655 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001656
TRodziewicz0f82ec62021-05-12 17:49:18 +02001657#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001658
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001659 /* If the padding was found to be invalid, padlen == 0
1660 * and the subtraction is safe. If the padding was found valid,
1661 * padlen hasn't been changed and the previous assertion
1662 * data_len >= padlen still holds. */
1663 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001664 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001665 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001666#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1669 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001670 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001671
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001672#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001674 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001675#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001676
1677 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001678 * Authenticate if not done yet.
1679 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001680 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001681#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001682 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001683 {
Hanno Becker992b6872017-11-09 18:57:39 +00001684 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001685 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001686
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001687 /* If the initial value of padlen was such that
1688 * data_len < maclen + padlen + 1, then padlen
1689 * got reset to 1, and the initial check
1690 * data_len >= minlen + maclen + 1
1691 * guarantees that at this point we still
1692 * have at least data_len >= maclen.
1693 *
1694 * If the initial value of padlen was such that
1695 * data_len >= maclen + padlen + 1, then we have
1696 * subtracted either padlen + 1 (if the padding was correct)
1697 * or 0 (if the padding was incorrect) since then,
1698 * hence data_len >= maclen in any case.
1699 */
1700 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001701 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001702 transform->minor_ver,
1703 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001704
TRodziewicz0f82ec62021-05-12 17:49:18 +02001705#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001706 /*
1707 * The next two sizes are the minimum and maximum values of
1708 * data_len over all padlen values.
1709 *
1710 * They're independent of padlen, since we previously did
1711 * data_len -= padlen.
1712 *
1713 * Note that max_len + maclen is never more than the buffer
1714 * length, as we previously did in_msglen -= maclen too.
1715 */
1716 const size_t max_len = rec->data_len + padlen;
1717 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1718
Neil Armstronge8589962022-02-25 15:14:29 +01001719#if defined(MBEDTLS_USE_PSA_CRYPTO)
1720 ret = mbedtls_ct_hmac( transform->psa_mac_dec,
1721 transform->psa_mac_alg,
1722 add_data, add_data_len,
1723 data, rec->data_len, min_len, max_len,
1724 mac_expect );
1725#else
Gabor Mezei90437e32021-10-20 11:59:27 +02001726 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001727 add_data, add_data_len,
1728 data, rec->data_len, min_len, max_len,
1729 mac_expect );
Neil Armstronge8589962022-02-25 15:14:29 +01001730#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001731 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001732 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001733 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001734 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001735 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001736
Gabor Mezei90437e32021-10-20 11:59:27 +02001737 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001738 rec->data_len,
1739 min_len, max_len,
1740 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001741#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001742
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001743#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001744 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001745 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001746#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001747
Gabor Mezei90437e32021-10-20 11:59:27 +02001748 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001749 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001750 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751#if defined(MBEDTLS_SSL_DEBUG_ALL)
1752 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001753#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001754 correct = 0;
1755 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001756 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001757
1758 hmac_failed_etm_disabled:
1759 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1760 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1761 if( ret != 0 )
1762 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001763 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001764
1765 /*
1766 * Finally check the correct flag
1767 */
1768 if( correct == 0 )
1769 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001770#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001771
1772 /* Make extra sure authentication was performed, exactly once */
1773 if( auth_done != 1 )
1774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1776 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001777 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001778
Ronald Cron6f135e12021-12-08 16:57:54 +01001779#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001780 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1781 {
1782 /* Remove inner padding and infer true content type. */
1783 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1784 &rec->type );
1785
1786 if( ret != 0 )
1787 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1788 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001789#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001790
Hanno Beckera0e20d02019-05-15 14:03:01 +01001791#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001792 if( rec->cid_len != 0 )
1793 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001794 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1795 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001796 if( ret != 0 )
1797 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1798 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001799#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001802
1803 return( 0 );
1804}
1805
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001806#undef MAC_NONE
1807#undef MAC_PLAINTEXT
1808#undef MAC_CIPHERTEXT
1809
Paul Bakker5121ce52009-01-03 21:22:43 +00001810/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001811 * Fill the input message buffer by appending data to it.
1812 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001813 *
1814 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1815 * available (from this read and/or a previous one). Otherwise, an error code
1816 * is returned (possibly EOF or WANT_READ).
1817 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001818 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1819 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1820 * since we always read a whole datagram at once.
1821 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001822 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001823 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001826{
Janos Follath865b3eb2019-12-16 11:46:15 +00001827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001828 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001829#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1830 size_t in_buf_len = ssl->in_buf_len;
1831#else
1832 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1833#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001836
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001837 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1838 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001840 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001841 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001842 }
1843
Darryl Greenb33cc762019-11-28 14:29:44 +00001844 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001845 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1847 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001848 }
1849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001850#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001851 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001852 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001853 uint32_t timeout;
1854
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001855 /*
1856 * The point is, we need to always read a full datagram at once, so we
1857 * sometimes read more then requested, and handle the additional data.
1858 * It could be the rest of the current record (while fetching the
1859 * header) and/or some other records in the same datagram.
1860 */
1861
1862 /*
1863 * Move to the next record in the already read datagram if applicable
1864 */
1865 if( ssl->next_record_offset != 0 )
1866 {
1867 if( ssl->in_left < ssl->next_record_offset )
1868 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1870 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001871 }
1872
1873 ssl->in_left -= ssl->next_record_offset;
1874
1875 if( ssl->in_left != 0 )
1876 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001877 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1878 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001879 ssl->next_record_offset ) );
1880 memmove( ssl->in_hdr,
1881 ssl->in_hdr + ssl->next_record_offset,
1882 ssl->in_left );
1883 }
1884
1885 ssl->next_record_offset = 0;
1886 }
1887
Paul Elliottd48d5c62021-01-07 14:47:05 +00001888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1889 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001890 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001891
1892 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001893 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001894 */
1895 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001896 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001898 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001899 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001900
1901 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001902 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001903 * are not at the beginning of a new record, the caller did something
1904 * wrong.
1905 */
1906 if( ssl->in_left != 0 )
1907 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1909 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001910 }
1911
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001912 /*
1913 * Don't even try to read if time's out already.
1914 * This avoids by-passing the timer when repeatedly receiving messages
1915 * that will end up being dropped.
1916 */
Hanno Becker7876d122020-02-05 10:39:31 +00001917 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001918 {
1919 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001920 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001921 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001922 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001923 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001924 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001926 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001927 timeout = ssl->handshake->retransmit_timeout;
1928 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001929 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001930
Paul Elliott9f352112020-12-09 14:55:45 +00001931 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001932
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001933 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001934 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1935 timeout );
1936 else
1937 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001940
1941 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001943 }
1944
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001945 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001946 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001948 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001951 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001952 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1953 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001955 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001956 }
1957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001959 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001961 return( ret );
1962 }
1963
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001964 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001965 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001967 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001969 {
Hanno Becker786300f2020-02-05 10:46:40 +00001970 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001971 {
Hanno Becker786300f2020-02-05 10:46:40 +00001972 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1973 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001974 return( ret );
1975 }
1976
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001977 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001978 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001980 }
1981
Paul Bakker5121ce52009-01-03 21:22:43 +00001982 if( ret < 0 )
1983 return( ret );
1984
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001985 ssl->in_left = ret;
1986 }
1987 else
1988#endif
1989 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001990 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1991 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001992 ssl->in_left, nb_want ) );
1993
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001994 while( ssl->in_left < nb_want )
1995 {
1996 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001997
Hanno Becker7876d122020-02-05 10:39:31 +00001998 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001999 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2000 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002001 {
2002 if( ssl->f_recv_timeout != NULL )
2003 {
2004 ret = ssl->f_recv_timeout( ssl->p_bio,
2005 ssl->in_hdr + ssl->in_left, len,
2006 ssl->conf->read_timeout );
2007 }
2008 else
2009 {
2010 ret = ssl->f_recv( ssl->p_bio,
2011 ssl->in_hdr + ssl->in_left, len );
2012 }
2013 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002014
Paul Elliottd48d5c62021-01-07 14:47:05 +00002015 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2016 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002017 ssl->in_left, nb_want ) );
2018 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002019
2020 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002021 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002022
2023 if( ret < 0 )
2024 return( ret );
2025
makise-homuraaf9513b2020-08-24 18:26:27 +03002026 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002027 {
Darryl Green11999bb2018-03-13 15:22:58 +00002028 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002029 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002030 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002031 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2032 }
2033
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002034 ssl->in_left += ret;
2035 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002036 }
2037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002039
2040 return( 0 );
2041}
2042
2043/*
2044 * Flush any data not yet written
2045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002047{
Janos Follath865b3eb2019-12-16 11:46:15 +00002048 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002049 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002052
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002053 if( ssl->f_send == NULL )
2054 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002056 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002058 }
2059
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002060 /* Avoid incrementing counter if data is flushed */
2061 if( ssl->out_left == 0 )
2062 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002064 return( 0 );
2065 }
2066
Paul Bakker5121ce52009-01-03 21:22:43 +00002067 while( ssl->out_left > 0 )
2068 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002069 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2070 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002071 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002072
Hanno Becker2b1e3542018-08-06 11:19:13 +01002073 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002074 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002077
2078 if( ret <= 0 )
2079 return( ret );
2080
makise-homuraaf9513b2020-08-24 18:26:27 +03002081 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002082 {
Darryl Green11999bb2018-03-13 15:22:58 +00002083 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002084 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002085 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002086 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2087 }
2088
Paul Bakker5121ce52009-01-03 21:22:43 +00002089 ssl->out_left -= ret;
2090 }
2091
Hanno Becker2b1e3542018-08-06 11:19:13 +01002092#if defined(MBEDTLS_SSL_PROTO_DTLS)
2093 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002094 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002095 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002096 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002097 else
2098#endif
2099 {
2100 ssl->out_hdr = ssl->out_buf + 8;
2101 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002102 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002105
2106 return( 0 );
2107}
2108
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002109/*
2110 * Functions to handle the DTLS retransmission state machine
2111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002113/*
2114 * Append current handshake message to current outgoing flight
2115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002117{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2120 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2121 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002122
2123 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002124 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002125 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002126 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002127 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002128 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002129 }
2130
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002131 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002132 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002133 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2134 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002136 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002137 }
2138
2139 /* Copy current handshake message with headers */
2140 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2141 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002142 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002143 msg->next = NULL;
2144
2145 /* Append to the current flight */
2146 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002147 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002148 else
2149 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002151 while( cur->next != NULL )
2152 cur = cur->next;
2153 cur->next = msg;
2154 }
2155
Hanno Becker3b235902018-08-06 09:54:53 +01002156 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002157 return( 0 );
2158}
2159
2160/*
2161 * Free the current flight of handshake messages
2162 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002163void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002164{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 mbedtls_ssl_flight_item *cur = flight;
2166 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002167
2168 while( cur != NULL )
2169 {
2170 next = cur->next;
2171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172 mbedtls_free( cur->p );
2173 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002174
2175 cur = next;
2176 }
2177}
2178
2179/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002180 * Swap transform_out and out_ctr with the alternative ones
2181 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002182static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002183{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002185 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002186
2187 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2188 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002190 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002191 }
2192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002194
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002195 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002196 tmp_transform = ssl->transform_out;
2197 ssl->transform_out = ssl->handshake->alt_transform_out;
2198 ssl->handshake->alt_transform_out = tmp_transform;
2199
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002200 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002201 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2202 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2203 sizeof( ssl->cur_out_ctr ) );
2204 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2205 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002206
2207 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002208 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002209
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002210 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002211}
2212
2213/*
2214 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002215 */
2216int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2217{
2218 int ret = 0;
2219
2220 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2221
2222 ret = mbedtls_ssl_flight_transmit( ssl );
2223
2224 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2225
2226 return( ret );
2227}
2228
2229/*
2230 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002231 *
2232 * Need to remember the current message in case flush_output returns
2233 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002234 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002236int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002237{
Janos Follath865b3eb2019-12-16 11:46:15 +00002238 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002239 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002242 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002243 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002244
2245 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002246 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002247 ret = ssl_swap_epochs( ssl );
2248 if( ret != 0 )
2249 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002252 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002253
2254 while( ssl->handshake->cur_msg != NULL )
2255 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002256 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002257 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002258
Hanno Beckere1dcb032018-08-17 16:47:58 +01002259 int const is_finished =
2260 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2261 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2262
Hanno Becker04da1892018-08-14 13:22:10 +01002263 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2264 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2265
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002266 /* Swap epochs before sending Finished: we can't do it after
2267 * sending ChangeCipherSpec, in case write returns WANT_READ.
2268 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002269 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002270 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002271 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002272 ret = ssl_swap_epochs( ssl );
2273 if( ret != 0 )
2274 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002275 }
2276
Hanno Becker67bc7c32018-08-06 11:33:50 +01002277 ret = ssl_get_remaining_payload_in_datagram( ssl );
2278 if( ret < 0 )
2279 return( ret );
2280 max_frag_len = (size_t) ret;
2281
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002282 /* CCS is copied as is, while HS messages may need fragmentation */
2283 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2284 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002285 if( max_frag_len == 0 )
2286 {
2287 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2288 return( ret );
2289
2290 continue;
2291 }
2292
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002293 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002294 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002295 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002296
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002297 /* Update position inside current message */
2298 ssl->handshake->cur_msg_p += cur->len;
2299 }
2300 else
2301 {
2302 const unsigned char * const p = ssl->handshake->cur_msg_p;
2303 const size_t hs_len = cur->len - 12;
2304 const size_t frag_off = p - ( cur->p + 12 );
2305 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002306 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002307
Hanno Beckere1dcb032018-08-17 16:47:58 +01002308 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002309 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002310 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002311 {
2312 ret = ssl_swap_epochs( ssl );
2313 if( ret != 0 )
2314 return( ret );
2315 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002316
Hanno Becker67bc7c32018-08-06 11:33:50 +01002317 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2318 return( ret );
2319
2320 continue;
2321 }
2322 max_hs_frag_len = max_frag_len - 12;
2323
2324 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2325 max_hs_frag_len : rem_len;
2326
2327 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002328 {
2329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002330 (unsigned) cur_hs_frag_len,
2331 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002332 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002333
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002334 /* Messages are stored with handshake headers as if not fragmented,
2335 * copy beginning of headers then fill fragmentation fields.
2336 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2337 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002338
Joe Subbiani5ecac212021-06-24 13:00:03 +01002339 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2340 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2341 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002342
Joe Subbiani5ecac212021-06-24 13:00:03 +01002343 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2344 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2345 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002346
2347 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2348
Hanno Becker3f7b9732018-08-28 09:53:25 +01002349 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002350 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2351 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002352 ssl->out_msgtype = cur->type;
2353
2354 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002355 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002356 }
2357
2358 /* If done with the current message move to the next one if any */
2359 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2360 {
2361 if( cur->next != NULL )
2362 {
2363 ssl->handshake->cur_msg = cur->next;
2364 ssl->handshake->cur_msg_p = cur->next->p + 12;
2365 }
2366 else
2367 {
2368 ssl->handshake->cur_msg = NULL;
2369 ssl->handshake->cur_msg_p = NULL;
2370 }
2371 }
2372
2373 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002374 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002375 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002377 return( ret );
2378 }
2379 }
2380
Hanno Becker67bc7c32018-08-06 11:33:50 +01002381 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2382 return( ret );
2383
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002384 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2386 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002387 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002388 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002390 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002391 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002392
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002393 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002394
2395 return( 0 );
2396}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002397
2398/*
2399 * To be called when the last message of an incoming flight is received.
2400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002402{
2403 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002404 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002405 ssl->handshake->flight = NULL;
2406 ssl->handshake->cur_msg = NULL;
2407
2408 /* The next incoming flight will start with this msg_seq */
2409 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2410
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002411 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002412 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002413
Hanno Becker0271f962018-08-16 13:23:47 +01002414 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002415 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002416
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002417 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002418 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002419
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2421 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002422 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002424 }
2425 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002427}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002428
2429/*
2430 * To be called when the last message of an outgoing flight is send.
2431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002433{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002434 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002435 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2438 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002441 }
2442 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002444}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002446
Paul Bakker5121ce52009-01-03 21:22:43 +00002447/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002448 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002449 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002450
2451/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002452 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002453 *
2454 * - fill in handshake headers
2455 * - update handshake checksum
2456 * - DTLS: save message for resending
2457 * - then pass to the record layer
2458 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002459 * DTLS: except for HelloRequest, messages are only queued, and will only be
2460 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002461 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002462 * Inputs:
2463 * - ssl->out_msglen: 4 + actual handshake message len
2464 * (4 is the size of handshake headers for TLS)
2465 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2466 * - ssl->out_msg + 4: the handshake message body
2467 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002468 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002469 * - ssl->out_msglen: the length of the record contents
2470 * (including handshake headers but excluding record headers)
2471 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002472 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002473int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2474 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002475{
Janos Follath865b3eb2019-12-16 11:46:15 +00002476 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002477 const size_t hs_len = ssl->out_msglen - 4;
2478 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002479
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2481
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002482 /*
2483 * Sanity checks
2484 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002485 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002486 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2487 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2489 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002490 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002491
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002492 /* Whenever we send anything different from a
2493 * HelloRequest we should be in a handshake - double check. */
2494 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2495 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002496 ssl->handshake == NULL )
2497 {
2498 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2499 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2500 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002503 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002504 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002506 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002507 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2508 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002509 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002510#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002511
Hanno Beckerb50a2532018-08-06 11:52:54 +01002512 /* Double-check that we did not exceed the bounds
2513 * of the outgoing record buffer.
2514 * This should never fail as the various message
2515 * writing functions must obey the bounds of the
2516 * outgoing record buffer, but better be safe.
2517 *
2518 * Note: We deliberately do not check for the MTU or MFL here.
2519 */
2520 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2521 {
2522 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002523 "size %" MBEDTLS_PRINTF_SIZET
2524 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002525 ssl->out_msglen,
2526 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002527 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2528 }
2529
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002530 /*
2531 * Fill handshake headers
2532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002534 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002535 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2536 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2537 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002538
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002539 /*
2540 * DTLS has additional fields in the Handshake layer,
2541 * between the length field and the actual payload:
2542 * uint16 message_seq;
2543 * uint24 fragment_offset;
2544 * uint24 fragment_length;
2545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002547 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002548 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002549 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002550 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002551 {
2552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002553 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002554 hs_len,
2555 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002556 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2557 }
2558
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002559 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002560 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002561
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002562 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002563 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002564 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002565 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002566 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002567 }
2568 else
2569 {
2570 ssl->out_msg[4] = 0;
2571 ssl->out_msg[5] = 0;
2572 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002573
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002574 /* Handshake hashes are computed without fragmentation,
2575 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002576 memset( ssl->out_msg + 6, 0x00, 3 );
2577 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002578 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002579#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002580
Hanno Becker0207e532018-08-28 10:28:28 +01002581 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002582 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002583 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002584 }
2585
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002586 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002588 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002589 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2590 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002591 {
2592 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2593 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002595 return( ret );
2596 }
2597 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002598 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002599#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002600 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002601 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002602 {
2603 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2604 return( ret );
2605 }
2606 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002607
2608 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2609
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002610 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002611}
2612
2613/*
2614 * Record layer functions
2615 */
2616
2617/*
2618 * Write current record.
2619 *
2620 * Uses:
2621 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2622 * - ssl->out_msglen: length of the record content (excl headers)
2623 * - ssl->out_msg: record content
2624 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002625int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002626{
2627 int ret, done = 0;
2628 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002629 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002630
2631 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002632
Paul Bakker05ef8352012-05-08 09:17:57 +00002633 if( !done )
2634 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002635 unsigned i;
2636 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002637#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2638 size_t out_buf_len = ssl->out_buf_len;
2639#else
2640 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2641#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002642 /* Skip writing the record content type to after the encryption,
2643 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002644 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002645#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002646 /* TLS 1.3 still uses the TLS 1.2 version identifier
2647 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002648 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2649 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002650#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002651 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2652 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002653
Jerry Yuae0b2e22021-10-08 15:21:19 +08002654 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002655 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002656
Paul Bakker48916f92012-09-16 19:57:18 +00002657 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002658 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002659 mbedtls_record rec;
2660
2661 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002662 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002663 rec.data_len = ssl->out_msglen;
2664 rec.data_offset = ssl->out_msg - rec.buf;
2665
Jerry Yud96a5c22021-09-29 17:46:51 +08002666 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002667 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002668 ssl->conf->transport, rec.ver );
2669 rec.type = ssl->out_msgtype;
2670
Hanno Beckera0e20d02019-05-15 14:03:01 +01002671#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002672 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002673 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002674#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002675
Hanno Beckera18d1322018-01-03 14:27:32 +00002676 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002677 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002680 return( ret );
2681 }
2682
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002683 if( rec.data_offset != 0 )
2684 {
2685 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2686 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2687 }
2688
Hanno Becker6430faf2019-05-08 11:57:13 +01002689 /* Update the record content type and CID. */
2690 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002691#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002692 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002694 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002695 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002696 }
2697
Hanno Becker5903de42019-05-03 14:46:38 +01002698 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002699
2700#if defined(MBEDTLS_SSL_PROTO_DTLS)
2701 /* In case of DTLS, double-check that we don't exceed
2702 * the remaining space in the datagram. */
2703 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2704 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002705 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002706 if( ret < 0 )
2707 return( ret );
2708
2709 if( protected_record_size > (size_t) ret )
2710 {
2711 /* Should never happen */
2712 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2713 }
2714 }
2715#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002716
Hanno Becker6430faf2019-05-08 11:57:13 +01002717 /* Now write the potentially updated record content type. */
2718 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2719
Paul Elliott9f352112020-12-09 14:55:45 +00002720 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002721 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002722 ssl->out_hdr[0], ssl->out_hdr[1],
2723 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002726 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002727
2728 ssl->out_left += protected_record_size;
2729 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002730 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002731
Hanno Beckerdd772292020-02-05 10:38:31 +00002732 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002733 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2734 break;
2735
2736 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002737 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002738 {
2739 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2740 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2741 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002742 }
2743
Hanno Becker67bc7c32018-08-06 11:33:50 +01002744#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002745 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2746 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002747 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002748 size_t remaining;
2749 ret = ssl_get_remaining_payload_in_datagram( ssl );
2750 if( ret < 0 )
2751 {
2752 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2753 ret );
2754 return( ret );
2755 }
2756
2757 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002758 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002759 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002760 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002761 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002762 else
2763 {
Hanno Becker513815a2018-08-20 11:56:09 +01002764 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002765 }
2766 }
2767#endif /* MBEDTLS_SSL_PROTO_DTLS */
2768
2769 if( ( flush == SSL_FORCE_FLUSH ) &&
2770 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002771 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002773 return( ret );
2774 }
2775
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002777
2778 return( 0 );
2779}
2780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002782
2783static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2784{
2785 if( ssl->in_msglen < ssl->in_hslen ||
2786 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2787 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2788 {
2789 return( 1 );
2790 }
2791 return( 0 );
2792}
Hanno Becker44650b72018-08-16 12:51:11 +01002793
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002794static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002795{
2796 return( ( ssl->in_msg[9] << 16 ) |
2797 ( ssl->in_msg[10] << 8 ) |
2798 ssl->in_msg[11] );
2799}
2800
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002801static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002802{
2803 return( ( ssl->in_msg[6] << 16 ) |
2804 ( ssl->in_msg[7] << 8 ) |
2805 ssl->in_msg[8] );
2806}
2807
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002808static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002809{
2810 uint32_t msg_len, frag_off, frag_len;
2811
2812 msg_len = ssl_get_hs_total_len( ssl );
2813 frag_off = ssl_get_hs_frag_off( ssl );
2814 frag_len = ssl_get_hs_frag_len( ssl );
2815
2816 if( frag_off > msg_len )
2817 return( -1 );
2818
2819 if( frag_len > msg_len - frag_off )
2820 return( -1 );
2821
2822 if( frag_len + 12 > ssl->in_msglen )
2823 return( -1 );
2824
2825 return( 0 );
2826}
2827
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002828/*
2829 * Mark bits in bitmask (used for DTLS HS reassembly)
2830 */
2831static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2832{
2833 unsigned int start_bits, end_bits;
2834
2835 start_bits = 8 - ( offset % 8 );
2836 if( start_bits != 8 )
2837 {
2838 size_t first_byte_idx = offset / 8;
2839
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002840 /* Special case */
2841 if( len <= start_bits )
2842 {
2843 for( ; len != 0; len-- )
2844 mask[first_byte_idx] |= 1 << ( start_bits - len );
2845
2846 /* Avoid potential issues with offset or len becoming invalid */
2847 return;
2848 }
2849
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002850 offset += start_bits; /* Now offset % 8 == 0 */
2851 len -= start_bits;
2852
2853 for( ; start_bits != 0; start_bits-- )
2854 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2855 }
2856
2857 end_bits = len % 8;
2858 if( end_bits != 0 )
2859 {
2860 size_t last_byte_idx = ( offset + len ) / 8;
2861
2862 len -= end_bits; /* Now len % 8 == 0 */
2863
2864 for( ; end_bits != 0; end_bits-- )
2865 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2866 }
2867
2868 memset( mask + offset / 8, 0xFF, len / 8 );
2869}
2870
2871/*
2872 * Check that bitmask is full
2873 */
2874static int ssl_bitmask_check( unsigned char *mask, size_t len )
2875{
2876 size_t i;
2877
2878 for( i = 0; i < len / 8; i++ )
2879 if( mask[i] != 0xFF )
2880 return( -1 );
2881
2882 for( i = 0; i < len % 8; i++ )
2883 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2884 return( -1 );
2885
2886 return( 0 );
2887}
2888
Hanno Becker56e205e2018-08-16 09:06:12 +01002889/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002890static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002891 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002892{
Hanno Becker56e205e2018-08-16 09:06:12 +01002893 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002894
Hanno Becker56e205e2018-08-16 09:06:12 +01002895 alloc_len = 12; /* Handshake header */
2896 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002897
Hanno Beckerd07df862018-08-16 09:14:58 +01002898 if( add_bitmap )
2899 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002900
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002901 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002902}
Hanno Becker56e205e2018-08-16 09:06:12 +01002903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002905
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002906static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002907{
2908 return( ( ssl->in_msg[1] << 16 ) |
2909 ( ssl->in_msg[2] << 8 ) |
2910 ssl->in_msg[3] );
2911}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002912
Simon Butcher99000142016-10-13 17:21:01 +01002913int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002914{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002916 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002918 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002920 }
2921
Hanno Becker12555c62018-08-16 12:47:53 +01002922 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002924 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002925 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002926 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002929 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002930 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002931 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002932 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002933
Hanno Becker44650b72018-08-16 12:51:11 +01002934 if( ssl_check_hs_header( ssl ) != 0 )
2935 {
2936 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2937 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2938 }
2939
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002940 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002941 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2942 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2943 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2944 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002945 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002946 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2947 {
2948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2949 recv_msg_seq,
2950 ssl->handshake->in_msg_seq ) );
2951 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2952 }
2953
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002954 /* Retransmit only on last message from previous flight, to avoid
2955 * too many retransmissions.
2956 * Besides, No sane server ever retransmits HelloVerifyRequest */
2957 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002959 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002961 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002962 recv_msg_seq,
2963 ssl->handshake->in_flight_start_seq ) );
2964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002968 return( ret );
2969 }
2970 }
2971 else
2972 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002974 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002975 recv_msg_seq,
2976 ssl->handshake->in_msg_seq ) );
2977 }
2978
Hanno Becker90333da2017-10-10 11:27:13 +01002979 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002980 }
2981 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002982
Hanno Becker6d97ef52018-08-16 13:09:04 +01002983 /* Message reassembly is handled alongside buffering of future
2984 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002985 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002986 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002987 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002988 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002990 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002991 }
2992 }
2993 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002995 /* With TLS we don't handle fragmentation (for now) */
2996 if( ssl->in_msglen < ssl->in_hslen )
2997 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2999 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003000 }
3001
Simon Butcher99000142016-10-13 17:21:01 +01003002 return( 0 );
3003}
3004
3005void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3006{
Hanno Becker0271f962018-08-16 13:23:47 +01003007 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003008
Hanno Becker0271f962018-08-16 13:23:47 +01003009 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003010 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003011 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003012 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003013
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003014 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003016 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003017 ssl->handshake != NULL )
3018 {
Hanno Becker0271f962018-08-16 13:23:47 +01003019 unsigned offset;
3020 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003021
Hanno Becker0271f962018-08-16 13:23:47 +01003022 /* Increment handshake sequence number */
3023 hs->in_msg_seq++;
3024
3025 /*
3026 * Clear up handshake buffering and reassembly structure.
3027 */
3028
3029 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003030 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003031
3032 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003033 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3034 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003035 offset++, hs_buf++ )
3036 {
3037 *hs_buf = *(hs_buf + 1);
3038 }
3039
3040 /* Create a fresh last entry */
3041 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003042 }
3043#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003044}
3045
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003046/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003047 * DTLS anti-replay: RFC 6347 4.1.2.6
3048 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003049 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3050 * Bit n is set iff record number in_window_top - n has been seen.
3051 *
3052 * Usually, in_window_top is the last record number seen and the lsb of
3053 * in_window is set. The only exception is the initial state (record number 0
3054 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003057void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003058{
3059 ssl->in_window_top = 0;
3060 ssl->in_window = 0;
3061}
3062
3063static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3064{
3065 return( ( (uint64_t) buf[0] << 40 ) |
3066 ( (uint64_t) buf[1] << 32 ) |
3067 ( (uint64_t) buf[2] << 24 ) |
3068 ( (uint64_t) buf[3] << 16 ) |
3069 ( (uint64_t) buf[4] << 8 ) |
3070 ( (uint64_t) buf[5] ) );
3071}
3072
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003073static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3074{
Janos Follath865b3eb2019-12-16 11:46:15 +00003075 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003076 unsigned char *original_in_ctr;
3077
3078 // save original in_ctr
3079 original_in_ctr = ssl->in_ctr;
3080
3081 // use counter from record
3082 ssl->in_ctr = record_in_ctr;
3083
3084 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3085
3086 // restore the counter
3087 ssl->in_ctr = original_in_ctr;
3088
3089 return ret;
3090}
3091
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003092/*
3093 * Return 0 if sequence number is acceptable, -1 otherwise
3094 */
Hanno Becker0183d692019-07-12 08:50:37 +01003095int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003096{
3097 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3098 uint64_t bit;
3099
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003100 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003101 return( 0 );
3102
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003103 if( rec_seqnum > ssl->in_window_top )
3104 return( 0 );
3105
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003106 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003107
3108 if( bit >= 64 )
3109 return( -1 );
3110
3111 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3112 return( -1 );
3113
3114 return( 0 );
3115}
3116
3117/*
3118 * Update replay window on new validated record
3119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003121{
3122 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3123
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003124 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003125 return;
3126
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003127 if( rec_seqnum > ssl->in_window_top )
3128 {
3129 /* Update window_top and the contents of the window */
3130 uint64_t shift = rec_seqnum - ssl->in_window_top;
3131
3132 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003133 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003134 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003135 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003136 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003137 ssl->in_window |= 1;
3138 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003139
3140 ssl->in_window_top = rec_seqnum;
3141 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003142 else
3143 {
3144 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003145 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003146
3147 if( bit < 64 ) /* Always true, but be extra sure */
3148 ssl->in_window |= (uint64_t) 1 << bit;
3149 }
3150}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003152
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003153#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003154/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003155 * Without any SSL context, check if a datagram looks like a ClientHello with
3156 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003157 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003158 *
3159 * - if cookie is valid, return 0
3160 * - if ClientHello looks superficially valid but cookie is not,
3161 * fill obuf and set olen, then
3162 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3163 * - otherwise return a specific error code
3164 */
3165static int ssl_check_dtls_clihlo_cookie(
3166 mbedtls_ssl_cookie_write_t *f_cookie_write,
3167 mbedtls_ssl_cookie_check_t *f_cookie_check,
3168 void *p_cookie,
3169 const unsigned char *cli_id, size_t cli_id_len,
3170 const unsigned char *in, size_t in_len,
3171 unsigned char *obuf, size_t buf_len, size_t *olen )
3172{
3173 size_t sid_len, cookie_len;
3174 unsigned char *p;
3175
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003176 /*
3177 * Structure of ClientHello with record and handshake headers,
3178 * and expected values. We don't need to check a lot, more checks will be
3179 * done when actually parsing the ClientHello - skipping those checks
3180 * avoids code duplication and does not make cookie forging any easier.
3181 *
3182 * 0-0 ContentType type; copied, must be handshake
3183 * 1-2 ProtocolVersion version; copied
3184 * 3-4 uint16 epoch; copied, must be 0
3185 * 5-10 uint48 sequence_number; copied
3186 * 11-12 uint16 length; (ignored)
3187 *
3188 * 13-13 HandshakeType msg_type; (ignored)
3189 * 14-16 uint24 length; (ignored)
3190 * 17-18 uint16 message_seq; copied
3191 * 19-21 uint24 fragment_offset; copied, must be 0
3192 * 22-24 uint24 fragment_length; (ignored)
3193 *
3194 * 25-26 ProtocolVersion client_version; (ignored)
3195 * 27-58 Random random; (ignored)
3196 * 59-xx SessionID session_id; 1 byte len + sid_len content
3197 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3198 * ...
3199 *
3200 * Minimum length is 61 bytes.
3201 */
3202 if( in_len < 61 ||
3203 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3204 in[3] != 0 || in[4] != 0 ||
3205 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3206 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003207 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003208 }
3209
3210 sid_len = in[59];
3211 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003212 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003213
3214 cookie_len = in[60 + sid_len];
3215 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003216 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003217
3218 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3219 cli_id, cli_id_len ) == 0 )
3220 {
3221 /* Valid cookie */
3222 return( 0 );
3223 }
3224
3225 /*
3226 * If we get here, we've got an invalid cookie, let's prepare HVR.
3227 *
3228 * 0-0 ContentType type; copied
3229 * 1-2 ProtocolVersion version; copied
3230 * 3-4 uint16 epoch; copied
3231 * 5-10 uint48 sequence_number; copied
3232 * 11-12 uint16 length; olen - 13
3233 *
3234 * 13-13 HandshakeType msg_type; hello_verify_request
3235 * 14-16 uint24 length; olen - 25
3236 * 17-18 uint16 message_seq; copied
3237 * 19-21 uint24 fragment_offset; copied
3238 * 22-24 uint24 fragment_length; olen - 25
3239 *
3240 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3241 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3242 *
3243 * Minimum length is 28.
3244 */
3245 if( buf_len < 28 )
3246 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3247
3248 /* Copy most fields and adapt others */
3249 memcpy( obuf, in, 25 );
3250 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3251 obuf[25] = 0xfe;
3252 obuf[26] = 0xff;
3253
3254 /* Generate and write actual cookie */
3255 p = obuf + 28;
3256 if( f_cookie_write( p_cookie,
3257 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3258 {
3259 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3260 }
3261
3262 *olen = p - obuf;
3263
3264 /* Go back and fill length fields */
3265 obuf[27] = (unsigned char)( *olen - 28 );
3266
Joe Subbianifbeb6922021-07-16 14:27:50 +01003267 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3268 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3269 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003270
Joe Subbiani6dd73642021-07-19 11:56:54 +01003271 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003272
3273 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3274}
3275
3276/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003277 * Handle possible client reconnect with the same UDP quadruplet
3278 * (RFC 6347 Section 4.2.8).
3279 *
3280 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3281 * that looks like a ClientHello.
3282 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003283 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003284 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003285 * - if the input looks like a ClientHello with a valid cookie,
3286 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003287 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003288 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003289 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003290 * This function is called (through ssl_check_client_reconnect()) when an
3291 * unexpected record is found in ssl_get_next_record(), which will discard the
3292 * record if we return 0, and bubble up the return value otherwise (this
3293 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3294 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003295 */
3296static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3297{
Janos Follath865b3eb2019-12-16 11:46:15 +00003298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003299 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003300
Hanno Becker2fddd372019-07-10 14:37:41 +01003301 if( ssl->conf->f_cookie_write == NULL ||
3302 ssl->conf->f_cookie_check == NULL )
3303 {
3304 /* If we can't use cookies to verify reachability of the peer,
3305 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003306 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3307 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003308 return( 0 );
3309 }
3310
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003311 ret = ssl_check_dtls_clihlo_cookie(
3312 ssl->conf->f_cookie_write,
3313 ssl->conf->f_cookie_check,
3314 ssl->conf->p_cookie,
3315 ssl->cli_id, ssl->cli_id_len,
3316 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003317 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003318
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003319 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3320
3321 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003322 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003323 int send_ret;
3324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3325 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3326 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003327 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003328 * If the error is permanent we'll catch it later,
3329 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003330 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3331 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3332 (void) send_ret;
3333
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003334 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003335 }
3336
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003337 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003338 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003340 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003341 {
3342 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3343 return( ret );
3344 }
3345
3346 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003347 }
3348
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003349 return( ret );
3350}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003351#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003352
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003353static int ssl_check_record_type( uint8_t record_type )
3354{
3355 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3356 record_type != MBEDTLS_SSL_MSG_ALERT &&
3357 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3358 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3359 {
3360 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3361 }
3362
3363 return( 0 );
3364}
3365
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003366/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003367 * ContentType type;
3368 * ProtocolVersion version;
3369 * uint16 epoch; // DTLS only
3370 * uint48 sequence_number; // DTLS only
3371 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003372 *
3373 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003374 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003375 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3376 *
3377 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003378 * 1. proceed with the record if this function returns 0
3379 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3380 * 3. return CLIENT_RECONNECT if this function return that value
3381 * 4. drop the whole datagram if this function returns anything else.
3382 * Point 2 is needed when the peer is resending, and we have already received
3383 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003384 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003385static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003386 unsigned char *buf,
3387 size_t len,
3388 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003389{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003390 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003391
Hanno Beckere5e7e782019-07-11 12:29:35 +01003392 size_t const rec_hdr_type_offset = 0;
3393 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003394
Hanno Beckere5e7e782019-07-11 12:29:35 +01003395 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3396 rec_hdr_type_len;
3397 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003398
Hanno Beckere5e7e782019-07-11 12:29:35 +01003399 size_t const rec_hdr_ctr_len = 8;
3400#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003401 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003402 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3403 rec_hdr_version_len;
3404
Hanno Beckera0e20d02019-05-15 14:03:01 +01003405#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003406 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3407 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003408 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003409#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3410#endif /* MBEDTLS_SSL_PROTO_DTLS */
3411
3412 size_t rec_hdr_len_offset; /* To be determined */
3413 size_t const rec_hdr_len_len = 2;
3414
3415 /*
3416 * Check minimum lengths for record header.
3417 */
3418
3419#if defined(MBEDTLS_SSL_PROTO_DTLS)
3420 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3421 {
3422 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3423 }
3424 else
3425#endif /* MBEDTLS_SSL_PROTO_DTLS */
3426 {
3427 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3428 }
3429
3430 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3431 {
3432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3433 (unsigned) len,
3434 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3435 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3436 }
3437
3438 /*
3439 * Parse and validate record content type
3440 */
3441
3442 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003443
3444 /* Check record content type */
3445#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3446 rec->cid_len = 0;
3447
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003448 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003449 ssl->conf->cid_len != 0 &&
3450 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003451 {
3452 /* Shift pointers to account for record header including CID
3453 * struct {
3454 * ContentType special_type = tls12_cid;
3455 * ProtocolVersion version;
3456 * uint16 epoch;
3457 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003458 * opaque cid[cid_length]; // Additional field compared to
3459 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003460 * uint16 length;
3461 * opaque enc_content[DTLSCiphertext.length];
3462 * } DTLSCiphertext;
3463 */
3464
3465 /* So far, we only support static CID lengths
3466 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003467 rec_hdr_cid_len = ssl->conf->cid_len;
3468 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003469
Hanno Beckere5e7e782019-07-11 12:29:35 +01003470 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003471 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003472 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3473 (unsigned) len,
3474 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003475 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003476 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003477
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003478 /* configured CID len is guaranteed at most 255, see
3479 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3480 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003481 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003482 }
3483 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003484#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003485 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003486 if( ssl_check_record_type( rec->type ) )
3487 {
Hanno Becker54229812019-07-12 14:40:00 +01003488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3489 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003490 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3491 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003492 }
3493
Hanno Beckere5e7e782019-07-11 12:29:35 +01003494 /*
3495 * Parse and validate record version
3496 */
3497
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003498 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3499 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003500 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3501 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003502 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003503
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003504 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3507 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003508 }
3509
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003510 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003511 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3513 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003514 }
3515
Hanno Beckere5e7e782019-07-11 12:29:35 +01003516 /*
3517 * Parse/Copy record sequence number.
3518 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003519
Hanno Beckere5e7e782019-07-11 12:29:35 +01003520#if defined(MBEDTLS_SSL_PROTO_DTLS)
3521 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003522 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003523 /* Copy explicit record sequence number from input buffer. */
3524 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3525 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003526 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003527 else
3528#endif /* MBEDTLS_SSL_PROTO_DTLS */
3529 {
3530 /* Copy implicit record sequence number from SSL context structure. */
3531 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3532 }
Paul Bakker40e46942009-01-03 21:51:57 +00003533
Hanno Beckere5e7e782019-07-11 12:29:35 +01003534 /*
3535 * Parse record length.
3536 */
3537
Hanno Beckere5e7e782019-07-11 12:29:35 +01003538 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003539 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3540 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003541 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Paul Elliott9f352112020-12-09 14:55:45 +00003543 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003544 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003545 rec->type,
3546 major_ver, minor_ver, rec->data_len ) );
3547
3548 rec->buf = buf;
3549 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003550
Hanno Beckerd417cc92019-07-26 08:20:27 +01003551 if( rec->data_len == 0 )
3552 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003553
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003554 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003555 * DTLS-related tests.
3556 * Check epoch before checking length constraint because
3557 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3558 * message gets duplicated before the corresponding Finished message,
3559 * the second ChangeCipherSpec should be discarded because it belongs
3560 * to an old epoch, but not because its length is shorter than
3561 * the minimum record length for packets using the new record transform.
3562 * Note that these two kinds of failures are handled differently,
3563 * as an unexpected record is silently skipped but an invalid
3564 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003565 */
3566#if defined(MBEDTLS_SSL_PROTO_DTLS)
3567 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3568 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003569 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003570
Hanno Becker955a5c92019-07-10 17:12:07 +01003571 /* Check that the datagram is large enough to contain a record
3572 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003573 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003574 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3576 (unsigned) len,
3577 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003578 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3579 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003580
Hanno Becker37cfe732019-07-10 17:20:01 +01003581 /* Records from other, non-matching epochs are silently discarded.
3582 * (The case of same-port Client reconnects must be considered in
3583 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003584 if( rec_epoch != ssl->in_epoch )
3585 {
3586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003587 "expected %u, received %lu",
3588 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003589
Hanno Becker552f7472019-07-19 10:59:12 +01003590 /* Records from the next epoch are considered for buffering
3591 * (concretely: early Finished messages). */
3592 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003593 {
Hanno Becker552f7472019-07-19 10:59:12 +01003594 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3595 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003596 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003597
Hanno Becker2fddd372019-07-10 14:37:41 +01003598 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003599 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003600#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003601 /* For records from the correct epoch, check whether their
3602 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003603 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3604 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003605 {
3606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3607 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3608 }
3609#endif
3610 }
3611#endif /* MBEDTLS_SSL_PROTO_DTLS */
3612
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003613 return( 0 );
3614}
Paul Bakker5121ce52009-01-03 21:22:43 +00003615
Paul Bakker5121ce52009-01-03 21:22:43 +00003616
Hanno Becker2fddd372019-07-10 14:37:41 +01003617#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3618static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3619{
3620 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3621
3622 /*
3623 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3624 * access the first byte of record content (handshake type), as we
3625 * have an active transform (possibly iv_len != 0), so use the
3626 * fact that the record header len is 13 instead.
3627 */
3628 if( rec_epoch == 0 &&
3629 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3630 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3631 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3632 ssl->in_left > 13 &&
3633 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3634 {
3635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3636 "from the same port" ) );
3637 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003638 }
3639
3640 return( 0 );
3641}
Hanno Becker2fddd372019-07-10 14:37:41 +01003642#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003643
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003644/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003645 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003646 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003647static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3648 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003649{
3650 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003651
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003652 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003653 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003654
Ronald Cron7e38cba2021-11-24 12:43:39 +01003655 /*
3656 * In TLS 1.3, always treat ChangeCipherSpec records
3657 * as unencrypted. The only thing we do with them is
3658 * check the length and content and ignore them.
3659 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003660#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003661 if( ssl->transform_in != NULL &&
3662 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3663 {
3664 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3665 done = 1;
3666 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003667#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003668
Paul Bakker48916f92012-09-16 19:57:18 +00003669 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003670 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003671 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003672
Hanno Beckera18d1322018-01-03 14:27:32 +00003673 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003674 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003675 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003676 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003677
Hanno Beckera0e20d02019-05-15 14:03:01 +01003678#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003679 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3680 ssl->conf->ignore_unexpected_cid
3681 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3682 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003683 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003684 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003685 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003686#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003687
Paul Bakker5121ce52009-01-03 21:22:43 +00003688 return( ret );
3689 }
3690
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003691 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003692 {
3693 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003694 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003695 }
3696
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003697 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003698 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003699
Hanno Beckera0e20d02019-05-15 14:03:01 +01003700#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003701 /* We have already checked the record content type
3702 * in ssl_parse_record_header(), failing or silently
3703 * dropping the record in the case of an unknown type.
3704 *
3705 * Since with the use of CIDs, the record content type
3706 * might change during decryption, re-check the record
3707 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003708 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003709 {
3710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3711 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3712 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003713#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003714
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003715 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003716 {
3717#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3718 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003719 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003720 {
3721 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3723 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3724 }
3725#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3726
3727 ssl->nb_zero++;
3728
3729 /*
3730 * Three or more empty messages may be a DoS attack
3731 * (excessive CPU consumption).
3732 */
3733 if( ssl->nb_zero > 3 )
3734 {
3735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003736 "messages, possible DoS attack" ) );
3737 /* Treat the records as if they were not properly authenticated,
3738 * thereby failing the connection if we see more than allowed
3739 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003740 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3741 }
3742 }
3743 else
3744 ssl->nb_zero = 0;
3745
3746#if defined(MBEDTLS_SSL_PROTO_DTLS)
3747 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3748 {
3749 ; /* in_ctr read from peer, not maintained internally */
3750 }
3751 else
3752#endif
3753 {
3754 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003755 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3756 i > mbedtls_ssl_ep_len( ssl ); i-- )
3757 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003758 if( ++ssl->in_ctr[i - 1] != 0 )
3759 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003760 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003761
3762 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003763 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003764 {
3765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3766 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3767 }
3768 }
3769
Paul Bakker5121ce52009-01-03 21:22:43 +00003770 }
3771
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003772#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003773 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003775 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003776 }
3777#endif
3778
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003779 /* Check actual (decrypted) record content length against
3780 * configured maximum. */
3781 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3782 {
3783 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3784 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3785 }
3786
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003787 return( 0 );
3788}
3789
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003790/*
3791 * Read a record.
3792 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003793 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3794 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3795 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003796 */
Hanno Becker1097b342018-08-15 14:09:41 +01003797
3798/* Helper functions for mbedtls_ssl_read_record(). */
3799static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003800static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3801static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003802
Hanno Becker327c93b2018-08-15 13:56:18 +01003803int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003804 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003805{
Janos Follath865b3eb2019-12-16 11:46:15 +00003806 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003807
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003809
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003810 if( ssl->keep_current_message == 0 )
3811 {
3812 do {
Simon Butcher99000142016-10-13 17:21:01 +01003813
Hanno Becker26994592018-08-15 14:14:59 +01003814 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003815 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003816 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003817
Hanno Beckere74d5562018-08-15 14:26:08 +01003818 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003819 {
Hanno Becker40f50842018-08-15 14:48:01 +01003820#if defined(MBEDTLS_SSL_PROTO_DTLS)
3821 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003822
Hanno Becker40f50842018-08-15 14:48:01 +01003823 /* We only check for buffered messages if the
3824 * current datagram is fully consumed. */
3825 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003826 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003827 {
Hanno Becker40f50842018-08-15 14:48:01 +01003828 if( ssl_load_buffered_message( ssl ) == 0 )
3829 have_buffered = 1;
3830 }
3831
3832 if( have_buffered == 0 )
3833#endif /* MBEDTLS_SSL_PROTO_DTLS */
3834 {
3835 ret = ssl_get_next_record( ssl );
3836 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3837 continue;
3838
3839 if( ret != 0 )
3840 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003841 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003842 return( ret );
3843 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003844 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003845 }
3846
3847 ret = mbedtls_ssl_handle_message_type( ssl );
3848
Hanno Becker40f50842018-08-15 14:48:01 +01003849#if defined(MBEDTLS_SSL_PROTO_DTLS)
3850 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3851 {
3852 /* Buffer future message */
3853 ret = ssl_buffer_message( ssl );
3854 if( ret != 0 )
3855 return( ret );
3856
3857 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3858 }
3859#endif /* MBEDTLS_SSL_PROTO_DTLS */
3860
Hanno Becker90333da2017-10-10 11:27:13 +01003861 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3862 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003863
3864 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003865 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003866 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003867 return( ret );
3868 }
3869
Hanno Becker327c93b2018-08-15 13:56:18 +01003870 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003871 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003872 {
3873 mbedtls_ssl_update_handshake_status( ssl );
3874 }
Simon Butcher99000142016-10-13 17:21:01 +01003875 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003876 else
Simon Butcher99000142016-10-13 17:21:01 +01003877 {
Hanno Becker02f59072018-08-15 14:00:24 +01003878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003879 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003880 }
3881
3882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3883
3884 return( 0 );
3885}
3886
Hanno Becker40f50842018-08-15 14:48:01 +01003887#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003888static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003889{
Hanno Becker40f50842018-08-15 14:48:01 +01003890 if( ssl->in_left > ssl->next_record_offset )
3891 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003892
Hanno Becker40f50842018-08-15 14:48:01 +01003893 return( 0 );
3894}
3895
3896static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3897{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003898 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003899 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003900 int ret = 0;
3901
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003902 if( hs == NULL )
3903 return( -1 );
3904
Hanno Beckere00ae372018-08-20 09:39:42 +01003905 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3906
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003907 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3908 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3909 {
3910 /* Check if we have seen a ChangeCipherSpec before.
3911 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003912 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003913 {
3914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3915 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003916 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003917 }
3918
Hanno Becker39b8bc92018-08-28 17:17:13 +01003919 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003920 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3921 ssl->in_msglen = 1;
3922 ssl->in_msg[0] = 1;
3923
3924 /* As long as they are equal, the exact value doesn't matter. */
3925 ssl->in_left = 0;
3926 ssl->next_record_offset = 0;
3927
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003928 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003929 goto exit;
3930 }
Hanno Becker37f95322018-08-16 13:55:32 +01003931
Hanno Beckerb8f50142018-08-28 10:01:34 +01003932#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003933 /* Debug only */
3934 {
3935 unsigned offset;
3936 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3937 {
3938 hs_buf = &hs->buffering.hs[offset];
3939 if( hs_buf->is_valid == 1 )
3940 {
3941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3942 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003943 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003944 }
3945 }
3946 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003947#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003948
3949 /* Check if we have buffered and/or fully reassembled the
3950 * next handshake message. */
3951 hs_buf = &hs->buffering.hs[0];
3952 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3953 {
3954 /* Synthesize a record containing the buffered HS message. */
3955 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3956 ( hs_buf->data[2] << 8 ) |
3957 hs_buf->data[3];
3958
3959 /* Double-check that we haven't accidentally buffered
3960 * a message that doesn't fit into the input buffer. */
3961 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3962 {
3963 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3964 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3965 }
3966
3967 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3968 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3969 hs_buf->data, msg_len + 12 );
3970
3971 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3972 ssl->in_hslen = msg_len + 12;
3973 ssl->in_msglen = msg_len + 12;
3974 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3975
3976 ret = 0;
3977 goto exit;
3978 }
3979 else
3980 {
3981 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3982 hs->in_msg_seq ) );
3983 }
3984
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003985 ret = -1;
3986
3987exit:
3988
3989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3990 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003991}
3992
Hanno Beckera02b0b42018-08-21 17:20:27 +01003993static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3994 size_t desired )
3995{
3996 int offset;
3997 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3999 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004000
Hanno Becker01315ea2018-08-21 17:22:17 +01004001 /* Get rid of future records epoch first, if such exist. */
4002 ssl_free_buffered_record( ssl );
4003
4004 /* Check if we have enough space available now. */
4005 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4006 hs->buffering.total_bytes_buffered ) )
4007 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004009 return( 0 );
4010 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004011
Hanno Becker4f432ad2018-08-28 10:02:32 +01004012 /* We don't have enough space to buffer the next expected handshake
4013 * message. Remove buffers used for future messages to gain space,
4014 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004015 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4016 offset >= 0; offset-- )
4017 {
4018 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4019 offset ) );
4020
Hanno Beckerb309b922018-08-23 13:18:05 +01004021 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004022
4023 /* Check if we have enough space available now. */
4024 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4025 hs->buffering.total_bytes_buffered ) )
4026 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004027 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004028 return( 0 );
4029 }
4030 }
4031
4032 return( -1 );
4033}
4034
Hanno Becker40f50842018-08-15 14:48:01 +01004035static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4036{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004037 int ret = 0;
4038 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4039
4040 if( hs == NULL )
4041 return( 0 );
4042
4043 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4044
4045 switch( ssl->in_msgtype )
4046 {
4047 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4048 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004049
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004050 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004051 break;
4052
4053 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004054 {
4055 unsigned recv_msg_seq_offset;
4056 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4057 mbedtls_ssl_hs_buffer *hs_buf;
4058 size_t msg_len = ssl->in_hslen - 12;
4059
4060 /* We should never receive an old handshake
4061 * message - double-check nonetheless. */
4062 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4063 {
4064 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4065 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4066 }
4067
4068 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4069 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4070 {
4071 /* Silently ignore -- message too far in the future */
4072 MBEDTLS_SSL_DEBUG_MSG( 2,
4073 ( "Ignore future HS message with sequence number %u, "
4074 "buffering window %u - %u",
4075 recv_msg_seq, ssl->handshake->in_msg_seq,
4076 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4077
4078 goto exit;
4079 }
4080
4081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4082 recv_msg_seq, recv_msg_seq_offset ) );
4083
4084 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4085
4086 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004087 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004088 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004089 size_t reassembly_buf_sz;
4090
Hanno Becker37f95322018-08-16 13:55:32 +01004091 hs_buf->is_fragmented =
4092 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4093
4094 /* We copy the message back into the input buffer
4095 * after reassembly, so check that it's not too large.
4096 * This is an implementation-specific limitation
4097 * and not one from the standard, hence it is not
4098 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004099 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004100 {
4101 /* Ignore message */
4102 goto exit;
4103 }
4104
Hanno Beckere0b150f2018-08-21 15:51:03 +01004105 /* Check if we have enough space to buffer the message. */
4106 if( hs->buffering.total_bytes_buffered >
4107 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4108 {
4109 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4110 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4111 }
4112
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004113 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4114 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004115
4116 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4117 hs->buffering.total_bytes_buffered ) )
4118 {
4119 if( recv_msg_seq_offset > 0 )
4120 {
4121 /* If we can't buffer a future message because
4122 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004123 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4124 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4125 " (already %" MBEDTLS_PRINTF_SIZET
4126 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004127 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004128 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004129 goto exit;
4130 }
Hanno Beckere1801392018-08-21 16:51:05 +01004131 else
4132 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4134 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4135 " (already %" MBEDTLS_PRINTF_SIZET
4136 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004137 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004138 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004139 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004140
Hanno Beckera02b0b42018-08-21 17:20:27 +01004141 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004142 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4144 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4145 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4146 " (already %" MBEDTLS_PRINTF_SIZET
4147 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004148 msg_len,
4149 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004150 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004151 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004152 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4153 goto exit;
4154 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004155 }
4156
Paul Elliottd48d5c62021-01-07 14:47:05 +00004157 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004158 msg_len ) );
4159
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004160 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4161 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004162 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004163 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004164 goto exit;
4165 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004166 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004167
4168 /* Prepare final header: copy msg_type, length and message_seq,
4169 * then add standardised fragment_offset and fragment_length */
4170 memcpy( hs_buf->data, ssl->in_msg, 6 );
4171 memset( hs_buf->data + 6, 0, 3 );
4172 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4173
4174 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004175
4176 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004177 }
4178 else
4179 {
4180 /* Make sure msg_type and length are consistent */
4181 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4182 {
4183 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4184 /* Ignore */
4185 goto exit;
4186 }
4187 }
4188
Hanno Becker4422bbb2018-08-20 09:40:19 +01004189 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004190 {
4191 size_t frag_len, frag_off;
4192 unsigned char * const msg = hs_buf->data + 12;
4193
4194 /*
4195 * Check and copy current fragment
4196 */
4197
4198 /* Validation of header fields already done in
4199 * mbedtls_ssl_prepare_handshake_record(). */
4200 frag_off = ssl_get_hs_frag_off( ssl );
4201 frag_len = ssl_get_hs_frag_len( ssl );
4202
Paul Elliottd48d5c62021-01-07 14:47:05 +00004203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4204 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004205 frag_off, frag_len ) );
4206 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4207
4208 if( hs_buf->is_fragmented )
4209 {
4210 unsigned char * const bitmask = msg + msg_len;
4211 ssl_bitmask_set( bitmask, frag_off, frag_len );
4212 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4213 msg_len ) == 0 );
4214 }
4215 else
4216 {
4217 hs_buf->is_complete = 1;
4218 }
4219
4220 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4221 hs_buf->is_complete ? "" : "not yet " ) );
4222 }
4223
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004224 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004225 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004226
4227 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004228 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004229 break;
4230 }
4231
4232exit:
4233
4234 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4235 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004236}
4237#endif /* MBEDTLS_SSL_PROTO_DTLS */
4238
Hanno Becker1097b342018-08-15 14:09:41 +01004239static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004240{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004241 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004242 * Consume last content-layer message and potentially
4243 * update in_msglen which keeps track of the contents'
4244 * consumption state.
4245 *
4246 * (1) Handshake messages:
4247 * Remove last handshake message, move content
4248 * and adapt in_msglen.
4249 *
4250 * (2) Alert messages:
4251 * Consume whole record content, in_msglen = 0.
4252 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004253 * (3) Change cipher spec:
4254 * Consume whole record content, in_msglen = 0.
4255 *
4256 * (4) Application data:
4257 * Don't do anything - the record layer provides
4258 * the application data as a stream transport
4259 * and consumes through mbedtls_ssl_read only.
4260 *
4261 */
4262
4263 /* Case (1): Handshake messages */
4264 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004265 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004266 /* Hard assertion to be sure that no application data
4267 * is in flight, as corrupting ssl->in_msglen during
4268 * ssl->in_offt != NULL is fatal. */
4269 if( ssl->in_offt != NULL )
4270 {
4271 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4272 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4273 }
4274
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004275 /*
4276 * Get next Handshake message in the current record
4277 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004278
Hanno Becker4a810fb2017-05-24 16:27:30 +01004279 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004280 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004281 * current handshake content: If DTLS handshake
4282 * fragmentation is used, that's the fragment
4283 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004284 * size here is faulty and should be changed at
4285 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004286 * (2) While it doesn't seem to cause problems, one
4287 * has to be very careful not to assume that in_hslen
4288 * is always <= in_msglen in a sensible communication.
4289 * Again, it's wrong for DTLS handshake fragmentation.
4290 * The following check is therefore mandatory, and
4291 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004292 * Additionally, ssl->in_hslen might be arbitrarily out of
4293 * bounds after handling a DTLS message with an unexpected
4294 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004295 */
4296 if( ssl->in_hslen < ssl->in_msglen )
4297 {
4298 ssl->in_msglen -= ssl->in_hslen;
4299 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4300 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004301
Hanno Becker4a810fb2017-05-24 16:27:30 +01004302 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4303 ssl->in_msg, ssl->in_msglen );
4304 }
4305 else
4306 {
4307 ssl->in_msglen = 0;
4308 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004309
Hanno Becker4a810fb2017-05-24 16:27:30 +01004310 ssl->in_hslen = 0;
4311 }
4312 /* Case (4): Application data */
4313 else if( ssl->in_offt != NULL )
4314 {
4315 return( 0 );
4316 }
4317 /* Everything else (CCS & Alerts) */
4318 else
4319 {
4320 ssl->in_msglen = 0;
4321 }
4322
Hanno Becker1097b342018-08-15 14:09:41 +01004323 return( 0 );
4324}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004325
Hanno Beckere74d5562018-08-15 14:26:08 +01004326static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4327{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004328 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004329 return( 1 );
4330
4331 return( 0 );
4332}
4333
Hanno Becker5f066e72018-08-16 14:56:31 +01004334#if defined(MBEDTLS_SSL_PROTO_DTLS)
4335
4336static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4337{
4338 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4339 if( hs == NULL )
4340 return;
4341
Hanno Becker01315ea2018-08-21 17:22:17 +01004342 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004343 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004344 hs->buffering.total_bytes_buffered -=
4345 hs->buffering.future_record.len;
4346
4347 mbedtls_free( hs->buffering.future_record.data );
4348 hs->buffering.future_record.data = NULL;
4349 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004350}
4351
4352static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4353{
4354 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4355 unsigned char * rec;
4356 size_t rec_len;
4357 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004358#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4359 size_t in_buf_len = ssl->in_buf_len;
4360#else
4361 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4362#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004363 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4364 return( 0 );
4365
4366 if( hs == NULL )
4367 return( 0 );
4368
Hanno Becker5f066e72018-08-16 14:56:31 +01004369 rec = hs->buffering.future_record.data;
4370 rec_len = hs->buffering.future_record.len;
4371 rec_epoch = hs->buffering.future_record.epoch;
4372
4373 if( rec == NULL )
4374 return( 0 );
4375
Hanno Becker4cb782d2018-08-20 11:19:05 +01004376 /* Only consider loading future records if the
4377 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004378 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004379 return( 0 );
4380
Hanno Becker5f066e72018-08-16 14:56:31 +01004381 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4382
4383 if( rec_epoch != ssl->in_epoch )
4384 {
4385 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4386 goto exit;
4387 }
4388
4389 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4390
4391 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004392 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004393 {
4394 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4395 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4396 }
4397
4398 memcpy( ssl->in_hdr, rec, rec_len );
4399 ssl->in_left = rec_len;
4400 ssl->next_record_offset = 0;
4401
4402 ssl_free_buffered_record( ssl );
4403
4404exit:
4405 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4406 return( 0 );
4407}
4408
Hanno Becker519f15d2019-07-11 12:43:20 +01004409static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4410 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004411{
4412 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004413
4414 /* Don't buffer future records outside handshakes. */
4415 if( hs == NULL )
4416 return( 0 );
4417
4418 /* Only buffer handshake records (we are only interested
4419 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004420 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004421 return( 0 );
4422
4423 /* Don't buffer more than one future epoch record. */
4424 if( hs->buffering.future_record.data != NULL )
4425 return( 0 );
4426
Hanno Becker01315ea2018-08-21 17:22:17 +01004427 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004428 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004429 hs->buffering.total_bytes_buffered ) )
4430 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004431 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4432 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4433 " (already %" MBEDTLS_PRINTF_SIZET
4434 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004435 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004436 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004437 return( 0 );
4438 }
4439
Hanno Becker5f066e72018-08-16 14:56:31 +01004440 /* Buffer record */
4441 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004442 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004443 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004444
4445 /* ssl_parse_record_header() only considers records
4446 * of the next epoch as candidates for buffering. */
4447 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004448 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004449
4450 hs->buffering.future_record.data =
4451 mbedtls_calloc( 1, hs->buffering.future_record.len );
4452 if( hs->buffering.future_record.data == NULL )
4453 {
4454 /* If we run out of RAM trying to buffer a
4455 * record from the next epoch, just ignore. */
4456 return( 0 );
4457 }
4458
Hanno Becker519f15d2019-07-11 12:43:20 +01004459 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004460
Hanno Becker519f15d2019-07-11 12:43:20 +01004461 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004462 return( 0 );
4463}
4464
4465#endif /* MBEDTLS_SSL_PROTO_DTLS */
4466
Hanno Beckere74d5562018-08-15 14:26:08 +01004467static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004468{
Janos Follath865b3eb2019-12-16 11:46:15 +00004469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004470 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004471
Hanno Becker5f066e72018-08-16 14:56:31 +01004472#if defined(MBEDTLS_SSL_PROTO_DTLS)
4473 /* We might have buffered a future record; if so,
4474 * and if the epoch matches now, load it.
4475 * On success, this call will set ssl->in_left to
4476 * the length of the buffered record, so that
4477 * the calls to ssl_fetch_input() below will
4478 * essentially be no-ops. */
4479 ret = ssl_load_buffered_record( ssl );
4480 if( ret != 0 )
4481 return( ret );
4482#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004483
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004484 /* Ensure that we have enough space available for the default form
4485 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4486 * with no space for CIDs counted in). */
4487 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4488 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004489 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004490 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004491 return( ret );
4492 }
4493
Hanno Beckere5e7e782019-07-11 12:29:35 +01004494 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4495 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004496 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004497#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004498 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004499 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004500 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4501 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004502 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004503 if( ret != 0 )
4504 return( ret );
4505
4506 /* Fall through to handling of unexpected records */
4507 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4508 }
4509
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004510 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4511 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004512#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004513 /* Reset in pointers to default state for TLS/DTLS records,
4514 * assuming no CID and no offset between record content and
4515 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004516 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004517
Hanno Becker7ae20e02019-07-12 08:33:49 +01004518 /* Setup internal message pointers from record structure. */
4519 ssl->in_msgtype = rec.type;
4520#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4521 ssl->in_len = ssl->in_cid + rec.cid_len;
4522#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4523 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4524 ssl->in_msglen = rec.data_len;
4525
Hanno Becker2fddd372019-07-10 14:37:41 +01004526 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004527 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004528 if( ret != 0 )
4529 return( ret );
4530#endif
4531
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004532 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004533 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004534
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004535 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4536 "(header)" ) );
4537 }
4538 else
4539 {
4540 /* Skip invalid record and the rest of the datagram */
4541 ssl->next_record_offset = 0;
4542 ssl->in_left = 0;
4543
4544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4545 "(header)" ) );
4546 }
4547
4548 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004549 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004550 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004551 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004552#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004553 {
4554 return( ret );
4555 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004556 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004557
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004558#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004559 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004560 {
Hanno Beckera8814792019-07-10 15:01:45 +01004561 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004562 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004563 if( ssl->next_record_offset < ssl->in_left )
4564 {
4565 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4566 }
4567 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004568 else
4569#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004570 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004571 /*
4572 * Fetch record contents from underlying transport.
4573 */
Hanno Beckera3175662019-07-11 12:50:29 +01004574 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004575 if( ret != 0 )
4576 {
4577 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4578 return( ret );
4579 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004580
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004581 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004582 }
4583
4584 /*
4585 * Decrypt record contents.
4586 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004587
Hanno Beckerfdf66042019-07-11 13:07:45 +01004588 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004590#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004591 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004592 {
4593 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004594 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004595 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004596 /* Except when waiting for Finished as a bad mac here
4597 * probably means something went wrong in the handshake
4598 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4599 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4600 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4601 {
4602#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4603 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4604 {
4605 mbedtls_ssl_send_alert_message( ssl,
4606 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4607 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4608 }
4609#endif
4610 return( ret );
4611 }
4612
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004613 if( ssl->conf->badmac_limit != 0 &&
4614 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004615 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4617 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004618 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004619
Hanno Becker4a810fb2017-05-24 16:27:30 +01004620 /* As above, invalid records cause
4621 * dismissal of the whole datagram. */
4622
4623 ssl->next_record_offset = 0;
4624 ssl->in_left = 0;
4625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004627 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004628 }
4629
4630 return( ret );
4631 }
4632 else
4633#endif
4634 {
4635 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004636#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4637 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004638 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004639 mbedtls_ssl_send_alert_message( ssl,
4640 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4641 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004642 }
4643#endif
4644 return( ret );
4645 }
4646 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004647
Hanno Becker44d89b22019-07-12 09:40:44 +01004648
4649 /* Reset in pointers to default state for TLS/DTLS records,
4650 * assuming no CID and no offset between record content and
4651 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004652 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004653#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4654 ssl->in_len = ssl->in_cid + rec.cid_len;
4655#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004656 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004657
Hanno Becker8685c822019-07-12 09:37:30 +01004658 /* The record content type may change during decryption,
4659 * so re-read it. */
4660 ssl->in_msgtype = rec.type;
4661 /* Also update the input buffer, because unfortunately
4662 * the server-side ssl_parse_client_hello() reparses the
4663 * record header when receiving a ClientHello initiating
4664 * a renegotiation. */
4665 ssl->in_hdr[0] = rec.type;
4666 ssl->in_msg = rec.buf + rec.data_offset;
4667 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004668 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004669
Simon Butcher99000142016-10-13 17:21:01 +01004670 return( 0 );
4671}
4672
4673int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4674{
Janos Follath865b3eb2019-12-16 11:46:15 +00004675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004676
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004677 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004678 * Handle particular types of records
4679 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004681 {
Simon Butcher99000142016-10-13 17:21:01 +01004682 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4683 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004684 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004685 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004686 }
4687
Hanno Beckere678eaa2018-08-21 14:57:46 +01004688 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004689 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004690 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004691 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004693 ssl->in_msglen ) );
4694 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004695 }
4696
Hanno Beckere678eaa2018-08-21 14:57:46 +01004697 if( ssl->in_msg[0] != 1 )
4698 {
4699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4700 ssl->in_msg[0] ) );
4701 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4702 }
4703
4704#if defined(MBEDTLS_SSL_PROTO_DTLS)
4705 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4706 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4707 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4708 {
4709 if( ssl->handshake == NULL )
4710 {
4711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4712 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4713 }
4714
4715 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4716 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4717 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004718#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004719
Ronald Cron6f135e12021-12-08 16:57:54 +01004720#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004721 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4722 {
4723#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4724 MBEDTLS_SSL_DEBUG_MSG( 1,
4725 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4726 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4727#else
4728 MBEDTLS_SSL_DEBUG_MSG( 1,
4729 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4730 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4731#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4732 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004733#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004734 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004737 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004738 if( ssl->in_msglen != 2 )
4739 {
4740 /* Note: Standard allows for more than one 2 byte alert
4741 to be packed in a single message, but Mbed TLS doesn't
4742 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004743 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004744 ssl->in_msglen ) );
4745 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4746 }
4747
Paul Elliott9f352112020-12-09 14:55:45 +00004748 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004749 ssl->in_msg[0], ssl->in_msg[1] ) );
4750
4751 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004752 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004755 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004756 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004757 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004759 }
4760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4762 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4765 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004766 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004767
4768#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4769 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4770 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4771 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004772 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004773 /* Will be handled when trying to parse ServerHello */
4774 return( 0 );
4775 }
4776#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004777 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004778 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004779 }
4780
Hanno Beckerc76c6192017-06-06 10:03:17 +01004781#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004782 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004783 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004784 /* Drop unexpected ApplicationData records,
4785 * except at the beginning of renegotiations */
4786 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4787 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4788#if defined(MBEDTLS_SSL_RENEGOTIATION)
4789 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4790 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004791#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004792 )
4793 {
4794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4795 return( MBEDTLS_ERR_SSL_NON_FATAL );
4796 }
4797
4798 if( ssl->handshake != NULL &&
4799 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4800 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004801 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004802 }
4803 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004804#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004805
Paul Bakker5121ce52009-01-03 21:22:43 +00004806 return( 0 );
4807}
4808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004809int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004810{
irwir6c0da642019-09-26 21:07:41 +03004811 return( mbedtls_ssl_send_alert_message( ssl,
4812 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4813 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004814}
4815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004816int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004817 unsigned char level,
4818 unsigned char message )
4819{
Janos Follath865b3eb2019-12-16 11:46:15 +00004820 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004821
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004822 if( ssl == NULL || ssl->conf == NULL )
4823 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4824
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004825 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004826 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004828 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004829 ssl->out_msglen = 2;
4830 ssl->out_msg[0] = level;
4831 ssl->out_msg[1] = message;
4832
Hanno Becker67bc7c32018-08-06 11:33:50 +01004833 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004834 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004836 return( ret );
4837 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004839
4840 return( 0 );
4841}
4842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004843int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004844{
Janos Follath865b3eb2019-12-16 11:46:15 +00004845 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004847 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004849 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004850 ssl->out_msglen = 1;
4851 ssl->out_msg[0] = 1;
4852
Paul Bakker5121ce52009-01-03 21:22:43 +00004853 ssl->state++;
4854
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004855 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004856 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004857 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004858 return( ret );
4859 }
4860
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004862
4863 return( 0 );
4864}
4865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004866int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004867{
Janos Follath865b3eb2019-12-16 11:46:15 +00004868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004869
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004870 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004871
Hanno Becker327c93b2018-08-15 13:56:18 +01004872 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004873 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004874 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004875 return( ret );
4876 }
4877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004878 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004879 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004881 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4882 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004883 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004884 }
4885
Hanno Beckere678eaa2018-08-21 14:57:46 +01004886 /* CCS records are only accepted if they have length 1 and content '1',
4887 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004888
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004889 /*
4890 * Switch to our negotiated transform and session parameters for inbound
4891 * data.
4892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004893 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004894 ssl->transform_in = ssl->transform_negotiate;
4895 ssl->session_in = ssl->session_negotiate;
4896
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004897#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004898 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004899 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004900#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004901 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004902#endif
4903
4904 /* Increment epoch */
4905 if( ++ssl->in_epoch == 0 )
4906 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004907 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004908 /* This is highly unlikely to happen for legitimate reasons, so
4909 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004910 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004911 }
4912 }
4913 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004914#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004915 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004916
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004917 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004918
Paul Bakker5121ce52009-01-03 21:22:43 +00004919 ssl->state++;
4920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004922
4923 return( 0 );
4924}
4925
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004926/* Once ssl->out_hdr as the address of the beginning of the
4927 * next outgoing record is set, deduce the other pointers.
4928 *
4929 * Note: For TLS, we save the implicit record sequence number
4930 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4931 * and the caller has to make sure there's space for this.
4932 */
4933
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004934static size_t ssl_transform_get_explicit_iv_len(
4935 mbedtls_ssl_transform const *transform )
4936{
TRodziewiczef73f012021-05-13 14:53:36 +02004937 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004938 return( 0 );
4939
4940 return( transform->ivlen - transform->fixed_ivlen );
4941}
4942
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004943void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4944 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004945{
4946#if defined(MBEDTLS_SSL_PROTO_DTLS)
4947 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4948 {
4949 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004950#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004951 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004952 ssl->out_len = ssl->out_cid;
4953 if( transform != NULL )
4954 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004955#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004956 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004957#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004958 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004959 }
4960 else
4961#endif
4962 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004963 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004964#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004965 ssl->out_cid = ssl->out_len;
4966#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004967 ssl->out_iv = ssl->out_hdr + 5;
4968 }
4969
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004970 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004971 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004972 if( transform != NULL )
4973 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004974}
4975
4976/* Once ssl->in_hdr as the address of the beginning of the
4977 * next incoming record is set, deduce the other pointers.
4978 *
4979 * Note: For TLS, we save the implicit record sequence number
4980 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4981 * and the caller has to make sure there's space for this.
4982 */
4983
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004984void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004985{
Hanno Becker79594fd2019-05-08 09:38:41 +01004986 /* This function sets the pointers to match the case
4987 * of unprotected TLS/DTLS records, with both ssl->in_iv
4988 * and ssl->in_msg pointing to the beginning of the record
4989 * content.
4990 *
4991 * When decrypting a protected record, ssl->in_msg
4992 * will be shifted to point to the beginning of the
4993 * record plaintext.
4994 */
4995
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004996#if defined(MBEDTLS_SSL_PROTO_DTLS)
4997 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4998 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004999 /* This sets the header pointers to match records
5000 * without CID. When we receive a record containing
5001 * a CID, the fields are shifted accordingly in
5002 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005003 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005004#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005005 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005006 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005007#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005008 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005009#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005010 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005011 }
5012 else
5013#endif
5014 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005015 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005016 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005017#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005018 ssl->in_cid = ssl->in_len;
5019#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005020 ssl->in_iv = ssl->in_hdr + 5;
5021 }
5022
Hanno Becker79594fd2019-05-08 09:38:41 +01005023 /* This will be adjusted at record decryption time. */
5024 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005025}
5026
Paul Bakker5121ce52009-01-03 21:22:43 +00005027/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005028 * Setup an SSL context
5029 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005030
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005031void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005032{
5033 /* Set the incoming and outgoing record pointers. */
5034#if defined(MBEDTLS_SSL_PROTO_DTLS)
5035 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5036 {
5037 ssl->out_hdr = ssl->out_buf;
5038 ssl->in_hdr = ssl->in_buf;
5039 }
5040 else
5041#endif /* MBEDTLS_SSL_PROTO_DTLS */
5042 {
Hanno Becker12078f42021-03-02 15:28:41 +00005043 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005044 ssl->out_hdr = ssl->out_buf + 8;
5045 ssl->in_hdr = ssl->in_buf + 8;
5046 }
5047
5048 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005049 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5050 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005051}
5052
Paul Bakker5121ce52009-01-03 21:22:43 +00005053/*
5054 * SSL get accessors
5055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005056size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005057{
5058 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5059}
5060
Hanno Becker8b170a02017-10-10 11:51:19 +01005061int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5062{
5063 /*
5064 * Case A: We're currently holding back
5065 * a message for further processing.
5066 */
5067
5068 if( ssl->keep_current_message == 1 )
5069 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005070 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005071 return( 1 );
5072 }
5073
5074 /*
5075 * Case B: Further records are pending in the current datagram.
5076 */
5077
5078#if defined(MBEDTLS_SSL_PROTO_DTLS)
5079 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5080 ssl->in_left > ssl->next_record_offset )
5081 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005082 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005083 return( 1 );
5084 }
5085#endif /* MBEDTLS_SSL_PROTO_DTLS */
5086
5087 /*
5088 * Case C: A handshake message is being processed.
5089 */
5090
Hanno Becker8b170a02017-10-10 11:51:19 +01005091 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5092 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005093 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005094 return( 1 );
5095 }
5096
5097 /*
5098 * Case D: An application data message is being processed
5099 */
5100 if( ssl->in_offt != NULL )
5101 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005102 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005103 return( 1 );
5104 }
5105
5106 /*
5107 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005108 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005109 * we implement support for multiple alerts in single records.
5110 */
5111
5112 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5113 return( 0 );
5114}
5115
Paul Bakker43ca69c2011-01-15 17:35:19 +00005116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005117int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005118{
Hanno Becker3136ede2018-08-17 15:28:19 +01005119 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005120 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005121 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005122#if defined(MBEDTLS_USE_PSA_CRYPTO)
5123 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5124 psa_key_type_t key_type;
5125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005126
Hanno Becker5903de42019-05-03 14:46:38 +01005127 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5128
Hanno Becker78640902018-08-13 16:35:15 +01005129 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005130 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005131
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005132
5133#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005134 if ( transform->psa_alg == PSA_ALG_GCM ||
5135 transform->psa_alg == PSA_ALG_CCM ||
5136 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5137 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005138 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005139 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005140 transform_expansion = transform->minlen;
5141 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005142 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005143 {
5144 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5145 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005146
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005147 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005148
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005149 /* Expansion due to the addition of the MAC. */
5150 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005151
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005152 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005153 * Theoretically up to 256 bytes, but we never use
5154 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005155 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005156
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005157 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005158 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005159#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005160 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005161#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005162 }
5163 else
5164 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005166 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005167 }
5168#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005169 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005170 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005171 case MBEDTLS_MODE_GCM:
5172 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005173 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005174 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005175 transform_expansion = transform->minlen;
5176 break;
5177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005178 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005179
5180 block_size = mbedtls_cipher_get_block_size(
5181 &transform->cipher_ctx_enc );
5182
Hanno Becker3136ede2018-08-17 15:28:19 +01005183 /* Expansion due to the addition of the MAC. */
5184 transform_expansion += transform->maclen;
5185
5186 /* Expansion due to the addition of CBC padding;
5187 * Theoretically up to 256 bytes, but we never use
5188 * more than the block size of the underlying cipher. */
5189 transform_expansion += block_size;
5190
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005191 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005192 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005193#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005194 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005195#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005196
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005197 break;
5198
5199 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005200 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005201 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005202 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005203#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005204
Hanno Beckera0e20d02019-05-15 14:03:01 +01005205#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005206 if( transform->out_cid_len != 0 )
5207 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005208#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005209
Hanno Becker5903de42019-05-03 14:46:38 +01005210 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005211}
5212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005213#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005214/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005215 * Check record counters and renegotiate if they're above the limit.
5216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005217static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005218{
Hanno Beckerdd772292020-02-05 10:38:31 +00005219 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005220 int in_ctr_cmp;
5221 int out_ctr_cmp;
5222
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005223 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5224 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005225 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005226 {
5227 return( 0 );
5228 }
5229
Andres AG2196c7f2016-12-15 17:01:16 +00005230 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005231 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005232 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005233 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5234 &ssl->conf->renego_period[ep_len],
5235 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005236
5237 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005238 {
5239 return( 0 );
5240 }
5241
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005243 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005244}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005245#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005246
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005247/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005248 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005249 * may only be sent for the purpose of initiating renegotiations.
5250 *
5251 * This function is introduced as a separate helper since the handling
5252 * of post-handshake handshake messages changes significantly in TLS 1.3,
5253 * and having a helper function allows to distinguish between TLS <= 1.2 and
5254 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5255 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005256static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005257{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005259
5260 /*
5261 * - For client-side, expect SERVER_HELLO_REQUEST.
5262 * - For server-side, expect CLIENT_HELLO.
5263 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5264 */
5265
5266#if defined(MBEDTLS_SSL_CLI_C)
5267 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5268 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5269 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5270 {
5271 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5272
5273 /* With DTLS, drop the packet (probably from last handshake) */
5274#if defined(MBEDTLS_SSL_PROTO_DTLS)
5275 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5276 {
5277 return( 0 );
5278 }
5279#endif
5280 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5281 }
5282#endif /* MBEDTLS_SSL_CLI_C */
5283
5284#if defined(MBEDTLS_SSL_SRV_C)
5285 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5286 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5287 {
5288 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5289
5290 /* With DTLS, drop the packet (probably from last handshake) */
5291#if defined(MBEDTLS_SSL_PROTO_DTLS)
5292 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5293 {
5294 return( 0 );
5295 }
5296#endif
5297 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5298 }
5299#endif /* MBEDTLS_SSL_SRV_C */
5300
5301#if defined(MBEDTLS_SSL_RENEGOTIATION)
5302 /* Determine whether renegotiation attempt should be accepted */
5303 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5304 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5305 ssl->conf->allow_legacy_renegotiation ==
5306 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5307 {
5308 /*
5309 * Accept renegotiation request
5310 */
5311
5312 /* DTLS clients need to know renego is server-initiated */
5313#if defined(MBEDTLS_SSL_PROTO_DTLS)
5314 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5315 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5316 {
5317 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5318 }
5319#endif
5320 ret = mbedtls_ssl_start_renegotiation( ssl );
5321 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5322 ret != 0 )
5323 {
5324 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5325 ret );
5326 return( ret );
5327 }
5328 }
5329 else
5330#endif /* MBEDTLS_SSL_RENEGOTIATION */
5331 {
5332 /*
5333 * Refuse renegotiation
5334 */
5335
5336 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5337
TRodziewicz0f82ec62021-05-12 17:49:18 +02005338#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005339 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5340 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5341 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005342 {
TRodziewicz345165c2021-07-06 13:42:11 +02005343 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005344 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005345#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005346 }
5347
5348 return( 0 );
5349}
5350
Paul Bakker48916f92012-09-16 19:57:18 +00005351/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005352 * Receive application data decrypted from the SSL layer
5353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005355{
Janos Follath865b3eb2019-12-16 11:46:15 +00005356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005357 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005358
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005359 if( ssl == NULL || ssl->conf == NULL )
5360 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005364#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005365 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005366 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005367 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005368 return( ret );
5369
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005370 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005372 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005373 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005374 return( ret );
5375 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005376 }
5377#endif
5378
Hanno Becker4a810fb2017-05-24 16:27:30 +01005379 /*
5380 * Check if renegotiation is necessary and/or handshake is
5381 * in process. If yes, perform/continue, and fall through
5382 * if an unexpected packet is received while the client
5383 * is waiting for the ServerHello.
5384 *
5385 * (There is no equivalent to the last condition on
5386 * the server-side as it is not treated as within
5387 * a handshake while waiting for the ClientHello
5388 * after a renegotiation request.)
5389 */
5390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005392 ret = ssl_check_ctr_renegotiate( ssl );
5393 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5394 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005395 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005396 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005397 return( ret );
5398 }
5399#endif
5400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005401 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005404 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5405 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005406 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005407 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005408 return( ret );
5409 }
5410 }
5411
Hanno Beckere41158b2017-10-23 13:30:32 +01005412 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005413 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005414 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005415 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005416 if( ssl->f_get_timer != NULL &&
5417 ssl->f_get_timer( ssl->p_timer ) == -1 )
5418 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005419 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005420 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005421
Hanno Becker327c93b2018-08-15 13:56:18 +01005422 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005423 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005424 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5425 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005426
Hanno Becker4a810fb2017-05-24 16:27:30 +01005427 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5428 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005429 }
5430
5431 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005433 {
5434 /*
5435 * OpenSSL sends empty messages to randomize the IV
5436 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005437 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005438 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005439 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005440 return( 0 );
5441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005443 return( ret );
5444 }
5445 }
5446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005448 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005449 ret = ssl_handle_hs_message_post_handshake( ssl );
5450 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005451 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005452 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5453 ret );
5454 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005455 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005456
Hanno Beckerf26cc722021-04-21 07:30:13 +01005457 /* At this point, we don't know whether the renegotiation triggered
5458 * by the post-handshake message has been completed or not. The cases
5459 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005460 * 1) The renegotiation is complete. In this case, no new record
5461 * has been read yet.
5462 * 2) The renegotiation is incomplete because the client received
5463 * an application data record while awaiting the ServerHello.
5464 * 3) The renegotiation is incomplete because the client received
5465 * a non-handshake, non-application data message while awaiting
5466 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005467 *
5468 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005469 * - For 1), the next iteration will read a new record and check
5470 * if it's application data.
5471 * - For 2), the loop condition isn't satisfied as application data
5472 * is present, hence continue is the same as break
5473 * - For 3), the loop condition is satisfied and read_record
5474 * will re-deliver the message that was held back by the client
5475 * when expecting the ServerHello.
5476 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005477
Hanno Becker90333da2017-10-10 11:27:13 +01005478 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005479 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005480#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005482 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005483 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005484 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005485 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005487 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005488 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005489 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005490 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005491 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005492 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005493#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005495 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5496 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005499 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005500 }
5501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005504 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5505 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005506 }
5507
5508 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005509
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005510 /* We're going to return something now, cancel timer,
5511 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005512 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005513 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005514
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005515#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005516 /* If we requested renego but received AppData, resend HelloRequest.
5517 * Do it now, after setting in_offt, to avoid taking this branch
5518 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005520 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005522 {
Hanno Becker786300f2020-02-05 10:46:40 +00005523 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005524 {
Hanno Becker786300f2020-02-05 10:46:40 +00005525 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5526 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005527 return( ret );
5528 }
5529 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005530#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005531#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005532 }
5533
5534 n = ( len < ssl->in_msglen )
5535 ? len : ssl->in_msglen;
5536
5537 memcpy( buf, ssl->in_offt, n );
5538 ssl->in_msglen -= n;
5539
gabor-mezei-arma3214132020-07-15 10:55:00 +02005540 /* Zeroising the plaintext buffer to erase unused application data
5541 from the memory. */
5542 mbedtls_platform_zeroize( ssl->in_offt, n );
5543
Paul Bakker5121ce52009-01-03 21:22:43 +00005544 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005545 {
5546 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005547 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005548 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005549 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005550 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005551 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005552 /* more data available */
5553 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005554 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005556 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005557
Paul Bakker23986e52011-04-24 08:57:21 +00005558 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005559}
5560
5561/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005562 * Send application data to be encrypted by the SSL layer, taking care of max
5563 * fragment length and buffer size.
5564 *
5565 * According to RFC 5246 Section 6.2.1:
5566 *
5567 * Zero-length fragments of Application data MAY be sent as they are
5568 * potentially useful as a traffic analysis countermeasure.
5569 *
5570 * Therefore, it is possible that the input message length is 0 and the
5571 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005572 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005573static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005574 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005575{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005576 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5577 const size_t max_len = (size_t) ret;
5578
5579 if( ret < 0 )
5580 {
5581 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5582 return( ret );
5583 }
5584
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005585 if( len > max_len )
5586 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005588 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005590 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005591 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5592 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005593 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005594 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005595 }
5596 else
5597#endif
5598 len = max_len;
5599 }
Paul Bakker887bd502011-06-08 13:10:54 +00005600
Paul Bakker5121ce52009-01-03 21:22:43 +00005601 if( ssl->out_left != 0 )
5602 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005603 /*
5604 * The user has previously tried to send the data and
5605 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5606 * written. In this case, we expect the high-level write function
5607 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005609 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005610 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005611 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005612 return( ret );
5613 }
5614 }
Paul Bakker887bd502011-06-08 13:10:54 +00005615 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005616 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005617 /*
5618 * The user is trying to send a message the first time, so we need to
5619 * copy the data into the internal buffers and setup the data structure
5620 * to keep track of partial writes
5621 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005622 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005623 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005624 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005625
Hanno Becker67bc7c32018-08-06 11:33:50 +01005626 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005627 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005628 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005629 return( ret );
5630 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005631 }
5632
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005633 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005634}
5635
5636/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005637 * Write application data (public-facing wrapper)
5638 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005639int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005640{
Janos Follath865b3eb2019-12-16 11:46:15 +00005641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005642
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005643 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005644
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005645 if( ssl == NULL || ssl->conf == NULL )
5646 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5647
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005648#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005649 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5650 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005651 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005652 return( ret );
5653 }
5654#endif
5655
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005656 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005657 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005658 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005659 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005660 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005661 return( ret );
5662 }
5663 }
5664
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005665 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005666
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005667 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005668
5669 return( ret );
5670}
5671
5672/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005673 * Notify the peer that the connection is being closed
5674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005675int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005676{
Janos Follath865b3eb2019-12-16 11:46:15 +00005677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005678
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005679 if( ssl == NULL || ssl->conf == NULL )
5680 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005683
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005684 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005686
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005687 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5690 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5691 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005693 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005694 return( ret );
5695 }
5696 }
5697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005699
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005700 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005701}
5702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005703void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005704{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005705 if( transform == NULL )
5706 return;
5707
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005708#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005709 psa_destroy_key( transform->psa_key_enc );
5710 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005711#else
5712 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5713 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5714#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005715
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005716#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005717#if defined(MBEDTLS_USE_PSA_CRYPTO)
5718 psa_destroy_key( transform->psa_mac_enc );
5719 psa_destroy_key( transform->psa_mac_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005720#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005721 mbedtls_md_free( &transform->md_ctx_enc );
5722 mbedtls_md_free( &transform->md_ctx_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005723#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005724#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005725
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005726 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005727}
5728
Jerry Yuc7875b52021-09-05 21:05:50 +08005729void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5730 mbedtls_ssl_transform *transform )
5731{
Jerry Yuc7875b52021-09-05 21:05:50 +08005732 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005733 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005734}
5735
5736void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5737 mbedtls_ssl_transform *transform )
5738{
5739 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005740 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005741}
5742
Hanno Becker0271f962018-08-16 13:23:47 +01005743#if defined(MBEDTLS_SSL_PROTO_DTLS)
5744
Hanno Becker533ab5f2020-02-05 10:49:13 +00005745void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005746{
5747 unsigned offset;
5748 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5749
5750 if( hs == NULL )
5751 return;
5752
Hanno Becker283f5ef2018-08-24 09:34:47 +01005753 ssl_free_buffered_record( ssl );
5754
Hanno Becker0271f962018-08-16 13:23:47 +01005755 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005756 ssl_buffering_free_slot( ssl, offset );
5757}
5758
5759static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5760 uint8_t slot )
5761{
5762 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5763 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005764
5765 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5766 return;
5767
Hanno Beckere605b192018-08-21 15:59:07 +01005768 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005769 {
Hanno Beckere605b192018-08-21 15:59:07 +01005770 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005771 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005772 mbedtls_free( hs_buf->data );
5773 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005774 }
5775}
5776
5777#endif /* MBEDTLS_SSL_PROTO_DTLS */
5778
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005779/*
5780 * Convert version numbers to/from wire format
5781 * and, for DTLS, to/from TLS equivalent.
5782 *
5783 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005784 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005785 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005787void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005788 unsigned char ver[2] )
5789{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005790#if defined(MBEDTLS_SSL_PROTO_DTLS)
5791 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005792 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005794 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5795
5796 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5797 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5798 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005799 else
5800#else
5801 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005802#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005803 {
5804 ver[0] = (unsigned char) major;
5805 ver[1] = (unsigned char) minor;
5806 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005807}
5808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005810 const unsigned char ver[2] )
5811{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005812#if defined(MBEDTLS_SSL_PROTO_DTLS)
5813 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005814 {
5815 *major = 255 - ver[0] + 2;
5816 *minor = 255 - ver[1] + 1;
5817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005818 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005819 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5820 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005821 else
5822#else
5823 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005824#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005825 {
5826 *major = ver[0];
5827 *minor = ver[1];
5828 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005829}
5830
Jerry Yue7047812021-09-13 19:26:39 +08005831/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005832 * Send pending fatal alert.
5833 * 0, No alert message.
5834 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5835 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005836 */
5837int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5838{
5839 int ret;
5840
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005841 /* No pending alert, return success*/
5842 if( ssl->send_alert == 0 )
5843 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005844
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005845 ret = mbedtls_ssl_send_alert_message( ssl,
5846 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5847 ssl->alert_type );
5848
Jerry Yu3bf1f972021-09-22 21:37:18 +08005849 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5850 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005851 */
5852 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5853 {
5854 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005855 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005856
5857 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005858 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005859
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005860 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005861}
5862
Jerry Yu394ece62021-09-14 22:17:21 +08005863/*
5864 * Set pending fatal alert flag.
5865 */
5866void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5867 unsigned char alert_type,
5868 int alert_reason )
5869{
5870 ssl->send_alert = 1;
5871 ssl->alert_type = alert_type;
5872 ssl->alert_reason = alert_reason;
5873}
5874
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005875#endif /* MBEDTLS_SSL_TLS_C */