blob: e473c27f13baa2aba79f3199478064b0da104544 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Ronald Cron6f135e12021-12-08 16:57:54 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100297
298static size_t ssl_compute_padding_length( size_t len,
299 size_t granularity )
300{
301 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
302}
303
Hanno Becker581bc1b2020-05-04 12:20:03 +0100304/* This functions transforms a (D)TLS plaintext fragment and a record content
305 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
306 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
307 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100308 *
309 * struct {
310 * opaque content[DTLSPlaintext.length];
311 * ContentType real_type;
312 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100313 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100314 *
315 * Input:
316 * - `content`: The beginning of the buffer holding the
317 * plaintext to be wrapped.
318 * - `*content_size`: The length of the plaintext in Bytes.
319 * - `max_len`: The number of Bytes available starting from
320 * `content`. This must be `>= *content_size`.
321 * - `rec_type`: The desired record content type.
322 *
323 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100324 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
325 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100326 *
327 * Returns:
328 * - `0` on success.
329 * - A negative error code if `max_len` didn't offer enough space
330 * for the expansion.
331 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100332static int ssl_build_inner_plaintext( unsigned char *content,
333 size_t *content_size,
334 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100335 uint8_t rec_type,
336 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100337{
338 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339
340 /* Write real content type */
341 if( remaining == 0 )
342 return( -1 );
343 content[ len ] = rec_type;
344 len++;
345 remaining--;
346
347 if( remaining < pad )
348 return( -1 );
349 memset( content + len, 0, pad );
350 len += pad;
351 remaining -= pad;
352
353 *content_size = len;
354 return( 0 );
355}
356
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357/* This function parses a (D)TLSInnerPlaintext structure.
358 * See ssl_build_inner_plaintext() for details. */
359static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100360 size_t *content_size,
361 uint8_t *rec_type )
362{
363 size_t remaining = *content_size;
364
365 /* Determine length of padding by skipping zeroes from the back. */
366 do
367 {
368 if( remaining == 0 )
369 return( -1 );
370 remaining--;
371 } while( content[ remaining ] == 0 );
372
373 *content_size = remaining;
374 *rec_type = content[ remaining ];
375
376 return( 0 );
377}
Ronald Cron6f135e12021-12-08 16:57:54 +0100378#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100379
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100380/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100381 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000382static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100383 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100384 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000385 unsigned minor_ver,
386 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000387{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100388 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100389 *
390 * additional_data = seq_num + TLSCompressed.type +
391 * TLSCompressed.version + TLSCompressed.length;
392 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100393 * For the CID extension, this is extended as follows
394 * (quoting draft-ietf-tls-dtls-connection-id-05,
395 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100396 *
397 * additional_data = seq_num + DTLSPlaintext.type +
398 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100399 * cid +
400 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100401 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100402 *
403 * For TLS 1.3, the record sequence number is dropped from the AAD
404 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000405 * Moreover, the additional data involves the length of the TLS
406 * ciphertext, not the TLS plaintext as in earlier versions.
407 * Quoting RFC 8446 (TLS 1.3):
408 *
409 * additional_data = TLSCiphertext.opaque_type ||
410 * TLSCiphertext.legacy_record_version ||
411 * TLSCiphertext.length
412 *
413 * We pass the tag length to this function in order to compute the
414 * ciphertext length from the inner plaintext length rec->data_len via
415 *
416 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
417 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100418 */
419
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100420 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000421 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422
Ronald Cron6f135e12021-12-08 16:57:54 +0100423#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000424 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
425 {
426 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
427 * which differs from the length of the TLSInnerPlaintext
428 * by the length of the authentication tag. */
429 ad_len_field += taglen;
430 }
431 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100432#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100433 {
434 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000435 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100436 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
437 cur += sizeof( rec->ctr );
438 }
439
440 *cur = rec->type;
441 cur++;
442
443 memcpy( cur, rec->ver, sizeof( rec->ver ) );
444 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100445
Hanno Beckera0e20d02019-05-15 14:03:01 +0100446#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100447 if( rec->cid_len != 0 )
448 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100449 memcpy( cur, rec->cid, rec->cid_len );
450 cur += rec->cid_len;
451
452 *cur = rec->cid_len;
453 cur++;
454
Joe Subbiani6dd73642021-07-19 11:56:54 +0100455 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100456 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100457 }
458 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100461 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100462 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464
465 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000466}
467
Hanno Becker67a37db2020-05-28 16:27:07 +0100468#if defined(MBEDTLS_GCM_C) || \
469 defined(MBEDTLS_CCM_C) || \
470 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100471static int ssl_transform_aead_dynamic_iv_is_explicit(
472 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100473{
Hanno Becker17263802020-05-28 07:05:48 +0100474 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475}
476
Hanno Becker17263802020-05-28 07:05:48 +0100477/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
478 *
479 * Concretely, this occurs in two variants:
480 *
481 * a) Fixed and dynamic IV lengths add up to total IV length, giving
482 * IV = fixed_iv || dynamic_iv
483 *
Hanno Becker15952812020-06-04 13:31:46 +0100484 * This variant is used in TLS 1.2 when used with GCM or CCM.
485 *
Hanno Becker17263802020-05-28 07:05:48 +0100486 * b) Fixed IV lengths matches total IV length, giving
487 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100488 *
489 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
490 *
491 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100492 *
493 * This function has the precondition that
494 *
495 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
496 *
497 * which has to be ensured by the caller. If this precondition
498 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100499 */
500static void ssl_build_record_nonce( unsigned char *dst_iv,
501 size_t dst_iv_len,
502 unsigned char const *fixed_iv,
503 size_t fixed_iv_len,
504 unsigned char const *dynamic_iv,
505 size_t dynamic_iv_len )
506{
507 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100508
509 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100510 memset( dst_iv, 0, dst_iv_len );
511 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100512
Hanno Becker17263802020-05-28 07:05:48 +0100513 dst_iv += dst_iv_len - dynamic_iv_len;
514 for( i = 0; i < dynamic_iv_len; i++ )
515 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100516}
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518
Hanno Beckera18d1322018-01-03 14:27:32 +0000519int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
520 mbedtls_ssl_transform *transform,
521 mbedtls_record *rec,
522 int (*f_rng)(void *, unsigned char *, size_t),
523 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000524{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100525#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 mbedtls_cipher_mode_t mode;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100527#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100573#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000574 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100575#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000576
577 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
578 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
580 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000581 rec->data_len,
582 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000583 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
584 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100585
Hanno Becker92313402020-05-20 13:58:58 +0100586 /* The following two code paths implement the (D)TLSInnerPlaintext
587 * structure present in TLS 1.3 and DTLS 1.2 + CID.
588 *
589 * See ssl_build_inner_plaintext() for more information.
590 *
591 * Note that this changes `rec->data_len`, and hence
592 * `post_avail` needs to be recalculated afterwards.
593 *
594 * Note also that the two code paths cannot occur simultaneously
595 * since they apply to different versions of the protocol. There
596 * is hence no risk of double-addition of the inner plaintext.
597 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100598#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +0100599 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
600 {
Hanno Becker13996922020-05-28 16:15:19 +0100601 size_t padding =
602 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200603 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100604 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100605 &rec->data_len,
606 post_avail,
607 rec->type,
608 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100609 {
610 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
611 }
612
613 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
614 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100615#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100616
Hanno Beckera0e20d02019-05-15 14:03:01 +0100617#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100618 /*
619 * Add CID information
620 */
621 rec->cid_len = transform->out_cid_len;
622 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
623 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624
625 if( rec->cid_len != 0 )
626 {
Hanno Becker13996922020-05-28 16:15:19 +0100627 size_t padding =
628 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200629 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100630 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100631 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100632 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100634 * Note that this changes `rec->data_len`, and hence
635 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100637 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100638 &rec->data_len,
639 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100640 rec->type,
641 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100642 {
643 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
644 }
645
646 rec->type = MBEDTLS_SSL_MSG_CID;
647 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100648#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100649
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100650 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
651
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100653 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000654 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000655#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100656#if defined(MBEDTLS_USE_PSA_CRYPTO)
657 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ||
658 ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING
659#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660 if( mode == MBEDTLS_MODE_STREAM ||
661 ( mode == MBEDTLS_MODE_CBC
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100662#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100665#endif
666 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000667 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000668 if( post_avail < transform->maclen )
669 {
670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
671 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
672 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200674 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker992b6872017-11-09 18:57:39 +0000676
TRodziewicz345165c2021-07-06 13:42:11 +0200677 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000678 transform->minor_ver,
679 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000680
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100681 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
682 add_data_len );
683 if( ret != 0 )
684 goto hmac_failed_etm_disabled;
685 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
686 if( ret != 0 )
687 goto hmac_failed_etm_disabled;
688 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
689 if( ret != 0 )
690 goto hmac_failed_etm_disabled;
691 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
692 if( ret != 0 )
693 goto hmac_failed_etm_disabled;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000694
TRodziewicz345165c2021-07-06 13:42:11 +0200695 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200696#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200697
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
699 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200700
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000701 rec->data_len += transform->maclen;
702 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100703 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100704
705 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100706 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100707 if( ret != 0 )
708 {
709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
710 return( ret );
711 }
Paul Bakker577e0062013-08-28 11:57:20 +0200712 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000713#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000714
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200715 /*
716 * Encrypt
717 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000718#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100719#if defined(MBEDTLS_USE_PSA_CRYPTO)
720 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
721#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100723#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000724 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000725 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100726#if defined(MBEDTLS_USE_PSA_CRYPTO)
727 psa_status_t status;
728 size_t part_len;
729 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
730
Przemyslaw Stekiel1fe065b2022-01-13 15:56:33 +0100731#else /* MBEDTLS_USE_PSA_CRYPTO */
732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
733#endif
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100734
Paul Elliottd48d5c62021-01-07 14:47:05 +0000735 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000736 "including %d bytes of padding",
737 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000738
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100739#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100740 /* Skip psa encryption for null cipher */
741 if ( transform->psa_alg != MBEDTLS_SSL_NULL_CIPHER )
742 {
743 status = psa_cipher_encrypt_setup( &cipher_op,
744 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100745
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100746 if( status != PSA_SUCCESS )
747 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100748
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100749 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100750
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100751 if( status != PSA_SUCCESS )
752 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100753
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100754 status = psa_cipher_update( &cipher_op,
755 data, rec->data_len,
756 data, rec->data_len, &olen );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100757
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100758 if( status != PSA_SUCCESS )
759 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100760
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100761 status = psa_cipher_finish( &cipher_op,
762 data + olen, rec->data_len - olen,
763 &part_len );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100764
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100765 if( status != PSA_SUCCESS )
766 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100767
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100768 olen += part_len;
769 } else {
770 olen = rec->data_len;
771 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100772#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000773 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
774 transform->iv_enc, transform->ivlen,
775 data, rec->data_len,
776 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200777 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200779 return( ret );
780 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100781#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200782
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000783 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200784 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
786 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200787 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000788 }
Paul Bakker68884e32013-01-07 18:20:04 +0100789 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000790#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000791
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200792#if defined(MBEDTLS_GCM_C) || \
793 defined(MBEDTLS_CCM_C) || \
794 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100795#if defined(MBEDTLS_USE_PSA_CRYPTO)
796 if ( transform->psa_alg == PSA_ALG_GCM ||
797 /* PSA_ALG_IS_AEAD( transform->psa_alg ) corresponds to
798 psa_alg == PSA_ALG_CCM || psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 )
799 in tls context (TLS only uses the default taglen or 8) */
800 PSA_ALG_IS_AEAD( transform->psa_alg ) ||
801 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 )
802#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200804 mode == MBEDTLS_MODE_CCM ||
805 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100806#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +0000807 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200808 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100809 unsigned char *dynamic_iv;
810 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100811 int dynamic_iv_is_explicit =
812 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100813#if defined(MBEDTLS_USE_PSA_CRYPTO)
814 psa_status_t status;
Przemyslaw Stekiel1fe065b2022-01-13 15:56:33 +0100815#else
816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100817#endif /* MBEDTLS_USE_PSA_CRYPTO */
818
Paul Bakkerca4ab492012-04-18 14:23:57 +0000819
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100820 /* Check that there's space for the authentication tag. */
821 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000822 {
823 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
824 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
825 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000826
Paul Bakker68884e32013-01-07 18:20:04 +0100827 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100828 * Build nonce for AEAD encryption.
829 *
830 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
831 * part of the IV is prepended to the ciphertext and
832 * can be chosen freely - in particular, it need not
833 * agree with the record sequence number.
834 * However, since ChaChaPoly as well as all AEAD modes
835 * in TLS 1.3 use the record sequence number as the
836 * dynamic part of the nonce, we uniformly use the
837 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100838 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100839 dynamic_iv = rec->ctr;
840 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200841
Hanno Becker17263802020-05-28 07:05:48 +0100842 ssl_build_record_nonce( iv, sizeof( iv ),
843 transform->iv_enc,
844 transform->fixed_ivlen,
845 dynamic_iv,
846 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100847
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100848 /*
849 * Build additional data for AEAD encryption.
850 * This depends on the TLS version.
851 */
852 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000853 transform->minor_ver,
854 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100855
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200856 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100857 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200858 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100859 dynamic_iv,
860 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000861 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100862 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000863 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200864 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000865 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000866
Paul Bakker68884e32013-01-07 18:20:04 +0100867 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200868 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200869 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100870#if defined(MBEDTLS_USE_PSA_CRYPTO)
871 status = psa_aead_encrypt( transform->psa_key_enc,
872 transform->psa_alg,
873 iv, transform->ivlen,
874 add_data, add_data_len,
875 data, rec->data_len,
876 data, rec->buf_len - (data - rec->buf),
877 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000878
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100879 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +0100880 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100881#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100882 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000883 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100884 add_data, add_data_len,
885 data, rec->data_len, /* src */
886 data, rec->buf_len - (data - rec->buf), /* dst */
887 &rec->data_len,
888 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200889 {
TRodziewicz18efb732021-04-29 23:12:19 +0200890 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200891 return( ret );
892 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100893#endif /* MBEDTLS_USE_PSA_CRYPTO */
894
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000895 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100896 data + rec->data_len - transform->taglen,
897 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100898 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000899 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100900
901 /*
902 * Prefix record content with dynamic IV in case it is explicit.
903 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100904 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100905 {
906 if( rec->data_offset < dynamic_iv_len )
907 {
908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
909 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
910 }
911
912 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
913 rec->data_offset -= dynamic_iv_len;
914 rec->data_len += dynamic_iv_len;
915 }
916
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100917 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000918 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000919 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100920#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200921#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100922#if defined(MBEDTLS_USE_PSA_CRYPTO)
923 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
924#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100926#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000927 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000928 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000929 size_t padlen, i;
930 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100931#if defined(MBEDTLS_USE_PSA_CRYPTO)
932 psa_status_t status;
933 size_t part_len;
934 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
935#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000936
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 /* Currently we're always using minimal padding
938 * (up to 255 bytes would be allowed). */
939 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
940 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000941 padlen = 0;
942
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000943 /* Check there's enough space in the buffer for the padding. */
944 if( post_avail < padlen + 1 )
945 {
946 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
947 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
948 }
949
Paul Bakker5121ce52009-01-03 21:22:43 +0000950 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000951 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000952
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000953 rec->data_len += padlen + 1;
954 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000955
TRodziewicz0f82ec62021-05-12 17:49:18 +0200956#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000957 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200958 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000959 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000960 */
TRodziewicz345165c2021-07-06 13:42:11 +0200961 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000962 {
TRodziewicz345165c2021-07-06 13:42:11 +0200963 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
964 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000965 }
TRodziewicz345165c2021-07-06 13:42:11 +0200966
967 if( rec->data_offset < transform->ivlen )
968 {
969 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
970 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
971 }
972
973 /*
974 * Generate IV
975 */
976 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
977 if( ret != 0 )
978 return( ret );
979
980 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200981#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000982
Paul Elliottd48d5c62021-01-07 14:47:05 +0000983 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
984 "including %" MBEDTLS_PRINTF_SIZET
985 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000986 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200987 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000988
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100989#if defined(MBEDTLS_USE_PSA_CRYPTO)
990 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100991 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100992
993 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +0100994 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100995
996 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
997
998 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +0100999 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001000
1001 status = psa_cipher_update( &cipher_op,
1002 data, rec->data_len,
1003 data, rec->data_len, &olen );
1004
1005 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +01001006 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001007
1008 status = psa_cipher_finish( &cipher_op,
1009 data + olen, rec->data_len - olen,
1010 &part_len );
1011
1012 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +01001013 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001014
1015 olen += part_len;
1016#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001017 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
1018 transform->iv_enc,
1019 transform->ivlen,
1020 data, rec->data_len,
1021 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001022 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001024 return( ret );
1025 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001026#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001027
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001028 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001029 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1031 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001032 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001033
TRodziewicz0f82ec62021-05-12 17:49:18 +02001034 data -= transform->ivlen;
1035 rec->data_offset -= transform->ivlen;
1036 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001039 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001040 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001041 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1042
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001043 /*
1044 * MAC(MAC_write_key, seq_num +
1045 * TLSCipherText.type +
1046 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001047 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001048 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001049 * ENC(content + padding + padding_length));
1050 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001051
1052 if( post_avail < transform->maclen)
1053 {
1054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1055 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1056 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001057
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001058 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001059 rec, transform->minor_ver,
1060 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001063 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001064 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001065
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001066 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1067 add_data_len );
1068 if( ret != 0 )
1069 goto hmac_failed_etm_enabled;
1070 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1071 data, rec->data_len );
1072 if( ret != 0 )
1073 goto hmac_failed_etm_enabled;
1074 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1075 if( ret != 0 )
1076 goto hmac_failed_etm_enabled;
1077 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1078 if( ret != 0 )
1079 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001080
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001081 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001082
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001083 rec->data_len += transform->maclen;
1084 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001085 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001086
1087 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001088 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001089 if( ret != 0 )
1090 {
1091 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1092 return( ret );
1093 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001094 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001096 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001097 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001098#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001099 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1101 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001102 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001103
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001104 /* Make extra sure authentication was performed, exactly once */
1105 if( auth_done != 1 )
1106 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001109 }
1110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001112
1113 return( 0 );
1114}
1115
Hanno Becker605949f2019-07-12 08:23:59 +01001116int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001117 mbedtls_ssl_transform *transform,
1118 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001119{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001120 size_t olen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001121#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 mbedtls_cipher_mode_t mode;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001123#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001124 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001125#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001126 size_t padlen = 0, correct = 1;
1127#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001128 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001129 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001130 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001131
Hanno Beckera18d1322018-01-03 14:27:32 +00001132#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001133 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001134 ((void) ssl);
1135#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001138 if( rec == NULL ||
1139 rec->buf == NULL ||
1140 rec->buf_len < rec->data_offset ||
1141 rec->buf_len - rec->data_offset < rec->data_len )
1142 {
1143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001145 }
1146
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001147 data = rec->buf + rec->data_offset;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001148#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001149 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001150#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001151
Hanno Beckera0e20d02019-05-15 14:03:01 +01001152#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001153 /*
1154 * Match record's CID with incoming CID.
1155 */
Hanno Becker938489a2019-05-08 13:02:22 +01001156 if( rec->cid_len != transform->in_cid_len ||
1157 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1158 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001159 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001160 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001161#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001162
Hanno Beckerd086bf02021-03-22 13:01:27 +00001163#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001164#if defined(MBEDTLS_USE_PSA_CRYPTO)
1165 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
1166#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001168#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker68884e32013-01-07 18:20:04 +01001169 {
1170 padlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001171#if defined(MBEDTLS_USE_PSA_CRYPTO)
1172 psa_status_t status;
1173 size_t part_len;
1174 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1175#endif /* MBEDTLS_USE_PSA_CRYPTO */
1176
1177#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001178 /* Skip psa decryption for null cipher */
1179 if ( transform->psa_alg != MBEDTLS_SSL_NULL_CIPHER )
1180 {
1181 status = psa_cipher_decrypt_setup( &cipher_op,
1182 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001183
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001184 if( status != PSA_SUCCESS )
1185 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001186
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001187 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001188
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001189 if( status != PSA_SUCCESS )
1190 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001191
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001192 status = psa_cipher_update( &cipher_op,
1193 data, rec->data_len,
1194 data, rec->data_len, &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001195
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001196 if( status != PSA_SUCCESS )
1197 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001198
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001199 status = psa_cipher_finish( &cipher_op,
1200 data + olen, rec->data_len - olen,
1201 &part_len );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001202
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001203 if( status != PSA_SUCCESS )
1204 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001205
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001206 olen += part_len;
1207 } else {
1208 olen = rec->data_len;
1209 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001210#else
1211
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001212 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1213 transform->iv_dec,
1214 transform->ivlen,
1215 data, rec->data_len,
1216 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001217 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001219 return( ret );
1220 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001221#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001222
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001223 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001224 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1226 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001227 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001228
Paul Bakker5121ce52009-01-03 21:22:43 +00001229 }
Paul Bakker68884e32013-01-07 18:20:04 +01001230 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001231#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001232#if defined(MBEDTLS_GCM_C) || \
1233 defined(MBEDTLS_CCM_C) || \
1234 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001235#if defined(MBEDTLS_USE_PSA_CRYPTO)
1236 if ( transform->psa_alg == PSA_ALG_GCM ||
1237 /* PSA_ALG_IS_AEAD( transform->psa_alg ) corresponds to
1238 psa_alg == PSA_ALG_CCM || psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 )
1239 in tls context (TLS only uses the default taglen or 8) */
1240 PSA_ALG_IS_AEAD( transform->psa_alg ) ||
1241 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 )
1242#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001244 mode == MBEDTLS_MODE_CCM ||
1245 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001246#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001247 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001248 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001249 unsigned char *dynamic_iv;
1250 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001251#if defined(MBEDTLS_USE_PSA_CRYPTO)
1252 psa_status_t status;
1253#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001254
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001255 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001256 * Extract dynamic part of nonce for AEAD decryption.
1257 *
1258 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1259 * part of the IV is prepended to the ciphertext and
1260 * can be chosen freely - in particular, it need not
1261 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001262 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001263 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001264 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001265 {
1266 if( rec->data_len < dynamic_iv_len )
1267 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001268 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1269 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001270 rec->data_len,
1271 dynamic_iv_len ) );
1272 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1273 }
1274 dynamic_iv = data;
1275
1276 data += dynamic_iv_len;
1277 rec->data_offset += dynamic_iv_len;
1278 rec->data_len -= dynamic_iv_len;
1279 }
Hanno Becker17263802020-05-28 07:05:48 +01001280 else
1281 {
1282 dynamic_iv = rec->ctr;
1283 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001284
1285 /* Check that there's space for the authentication tag. */
1286 if( rec->data_len < transform->taglen )
1287 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001288 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1289 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001290 rec->data_len,
1291 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001293 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001294 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001295
Hanno Beckerdf8be222020-05-21 15:30:57 +01001296 /*
1297 * Prepare nonce from dynamic and static parts.
1298 */
Hanno Becker17263802020-05-28 07:05:48 +01001299 ssl_build_record_nonce( iv, sizeof( iv ),
1300 transform->iv_dec,
1301 transform->fixed_ivlen,
1302 dynamic_iv,
1303 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001304
Hanno Beckerdf8be222020-05-21 15:30:57 +01001305 /*
1306 * Build additional data for AEAD encryption.
1307 * This depends on the TLS version.
1308 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001309 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001310 transform->minor_ver,
1311 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001312 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001313 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001314
Hanno Beckerd96a6522019-07-10 13:55:25 +01001315 /* Because of the check above, we know that there are
1316 * explicit_iv_len Bytes preceeding data, and taglen
1317 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001318 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001319 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001320
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001321 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001322 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001323 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001324
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001325 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001326 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001327 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001328#if defined(MBEDTLS_USE_PSA_CRYPTO)
1329 status = psa_aead_decrypt( transform->psa_key_dec,
1330 transform->psa_alg,
1331 iv, transform->ivlen,
1332 add_data, add_data_len,
1333 data, rec->data_len + transform->taglen,
1334 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001335 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001336
1337 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +01001338 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001339#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001340 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001341 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001342 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001343 data, rec->data_len + transform->taglen, /* src */
1344 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001345 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001346 {
TRodziewicz18efb732021-04-29 23:12:19 +02001347 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1350 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001351
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001352 return( ret );
1353 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001354#endif /* MBEDTLS_USE_PSA_CRYPTO */
1355
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001356 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001357
Hanno Beckerd96a6522019-07-10 13:55:25 +01001358 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001359 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1362 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001363 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001364 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001365 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001366#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001367#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001368#if defined(MBEDTLS_USE_PSA_CRYPTO)
1369 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
1370#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001372#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001373 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001374 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001375#if defined(MBEDTLS_USE_PSA_CRYPTO)
1376 psa_status_t status;
1377 size_t part_len;
1378 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1379#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001380
Paul Bakker5121ce52009-01-03 21:22:43 +00001381 /*
Paul Bakker45829992013-01-03 14:52:21 +01001382 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001383 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001384#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001385 /* The ciphertext is prefixed with the CBC IV. */
1386 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001387#endif
Paul Bakker45829992013-01-03 14:52:21 +01001388
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001389 /* Size considerations:
1390 *
1391 * - The CBC cipher text must not be empty and hence
1392 * at least of size transform->ivlen.
1393 *
1394 * Together with the potential IV-prefix, this explains
1395 * the first of the two checks below.
1396 *
1397 * - The record must contain a MAC, either in plain or
1398 * encrypted, depending on whether Encrypt-then-MAC
1399 * is used or not.
1400 * - If it is, the message contains the IV-prefix,
1401 * the CBC ciphertext, and the MAC.
1402 * - If it is not, the padded plaintext, and hence
1403 * the CBC ciphertext, has at least length maclen + 1
1404 * because there is at least the padding length byte.
1405 *
1406 * As the CBC ciphertext is not empty, both cases give the
1407 * lower bound minlen + maclen + 1 on the record size, which
1408 * we test for in the second check below.
1409 */
1410 if( rec->data_len < minlen + transform->ivlen ||
1411 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001412 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1414 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1415 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001416 "+ 1 ) ( + expl IV )", rec->data_len,
1417 transform->ivlen,
1418 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001420 }
1421
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001422 /*
1423 * Authenticate before decrypt if enabled
1424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001427 {
Hanno Becker992b6872017-11-09 18:57:39 +00001428 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001429
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001430 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001431
Hanno Beckerd96a6522019-07-10 13:55:25 +01001432 /* Update data_len in tandem with add_data.
1433 *
1434 * The subtraction is safe because of the previous check
1435 * data_len >= minlen + maclen + 1.
1436 *
1437 * Afterwards, we know that data + data_len is followed by at
1438 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001439 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001440 *
1441 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001442 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001443 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001444 transform->minor_ver,
1445 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001446
Hanno Beckerd96a6522019-07-10 13:55:25 +01001447 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001448 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1449 add_data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001450 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1451 add_data_len );
1452 if( ret != 0 )
1453 goto hmac_failed_etm_enabled;
1454 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001455 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001456 if( ret != 0 )
1457 goto hmac_failed_etm_enabled;
1458 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1459 if( ret != 0 )
1460 goto hmac_failed_etm_enabled;
1461 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1462 if( ret != 0 )
1463 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001464
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001465 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1466 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001467 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001468 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001469
Hanno Beckerd96a6522019-07-10 13:55:25 +01001470 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001471 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001472 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001473 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001474 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001475 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1476 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001477 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001478 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001479
1480 hmac_failed_etm_enabled:
1481 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1482 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001483 {
1484 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1485 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001486 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001487 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001488 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001490
1491 /*
1492 * Check length sanity
1493 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001494
1495 /* We know from above that data_len > minlen >= 0,
1496 * so the following check in particular implies that
1497 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001498 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001499 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001500 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1501 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001504 }
1505
TRodziewicz0f82ec62021-05-12 17:49:18 +02001506#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001507 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001508 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001509 */
TRodziewicz345165c2021-07-06 13:42:11 +02001510 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1511 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001512
TRodziewicz345165c2021-07-06 13:42:11 +02001513 data += transform->ivlen;
1514 rec->data_offset += transform->ivlen;
1515 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001516#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001517
Hanno Beckerd96a6522019-07-10 13:55:25 +01001518 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1519
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001520#if defined(MBEDTLS_USE_PSA_CRYPTO)
1521 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001522 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001523
1524 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +01001525 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001526
1527 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1528
1529 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +01001530 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001531
1532 status = psa_cipher_update( &cipher_op,
1533 data, rec->data_len,
1534 data, rec->data_len, &olen );
1535
1536 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +01001537 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001538
1539 status = psa_cipher_finish( &cipher_op,
1540 data + olen, rec->data_len - olen,
1541 &part_len );
1542
1543 if( status != PSA_SUCCESS )
Przemyslaw Stekielce09e7d2022-01-17 16:03:22 +01001544 return( psa_status_to_mbedtls( status ) );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001545
1546 olen += part_len;
1547#else
1548
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001549 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1550 transform->iv_dec, transform->ivlen,
1551 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001552 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001554 return( ret );
1555 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001556#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001557
Hanno Beckerd96a6522019-07-10 13:55:25 +01001558 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001559 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1562 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001563 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001564
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001565 /* Safe since data_len >= minlen + maclen + 1, so after having
1566 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001567 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1568 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001569 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001570
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001571 if( auth_done == 1 )
1572 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001573 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001574 rec->data_len,
1575 padlen + 1 );
1576 correct &= mask;
1577 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001578 }
1579 else
Paul Bakker45829992013-01-03 14:52:21 +01001580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001582 if( rec->data_len < transform->maclen + padlen + 1 )
1583 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001584 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1585 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1586 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001587 rec->data_len,
1588 transform->maclen,
1589 padlen + 1 ) );
1590 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001591#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001592
Gabor Mezei90437e32021-10-20 11:59:27 +02001593 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001594 rec->data_len,
1595 transform->maclen + padlen + 1 );
1596 correct &= mask;
1597 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001598 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001599
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001600 padlen++;
1601
1602 /* Regardless of the validity of the padding,
1603 * we have data_len >= padlen here. */
1604
TRodziewicz0f82ec62021-05-12 17:49:18 +02001605#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001606 /* The padding check involves a series of up to 256
1607 * consecutive memory reads at the end of the record
1608 * plaintext buffer. In order to hide the length and
1609 * validity of the padding, always perform exactly
1610 * `min(256,plaintext_len)` reads (but take into account
1611 * only the last `padlen` bytes for the padding check). */
1612 size_t pad_count = 0;
1613 volatile unsigned char* const check = data;
1614
1615 /* Index of first padding byte; it has been ensured above
1616 * that the subtraction is safe. */
1617 size_t const padding_idx = rec->data_len - padlen;
1618 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1619 size_t const start_idx = rec->data_len - num_checks;
1620 size_t idx;
1621
1622 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001623 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001624 /* pad_count += (idx >= padding_idx) &&
1625 * (check[idx] == padlen - 1);
1626 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001627 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1628 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001629 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001630 pad_count += mask & equal;
1631 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001632 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001635 if( padlen > 0 && correct == 0 )
1636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001637#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001638 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001639
TRodziewicz0f82ec62021-05-12 17:49:18 +02001640#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001641
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001642 /* If the padding was found to be invalid, padlen == 0
1643 * and the subtraction is safe. If the padding was found valid,
1644 * padlen hasn't been changed and the previous assertion
1645 * data_len >= padlen still holds. */
1646 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001647 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001648 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001649#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001650 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1652 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001653 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001654
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001655#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001657 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001658#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001659
1660 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001661 * Authenticate if not done yet.
1662 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001663 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001665 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001666 {
Hanno Becker992b6872017-11-09 18:57:39 +00001667 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001668 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001669
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001670 /* If the initial value of padlen was such that
1671 * data_len < maclen + padlen + 1, then padlen
1672 * got reset to 1, and the initial check
1673 * data_len >= minlen + maclen + 1
1674 * guarantees that at this point we still
1675 * have at least data_len >= maclen.
1676 *
1677 * If the initial value of padlen was such that
1678 * data_len >= maclen + padlen + 1, then we have
1679 * subtracted either padlen + 1 (if the padding was correct)
1680 * or 0 (if the padding was incorrect) since then,
1681 * hence data_len >= maclen in any case.
1682 */
1683 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001684 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001685 transform->minor_ver,
1686 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001687
TRodziewicz0f82ec62021-05-12 17:49:18 +02001688#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001689 /*
1690 * The next two sizes are the minimum and maximum values of
1691 * data_len over all padlen values.
1692 *
1693 * They're independent of padlen, since we previously did
1694 * data_len -= padlen.
1695 *
1696 * Note that max_len + maclen is never more than the buffer
1697 * length, as we previously did in_msglen -= maclen too.
1698 */
1699 const size_t max_len = rec->data_len + padlen;
1700 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1701
Gabor Mezei90437e32021-10-20 11:59:27 +02001702 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001703 add_data, add_data_len,
1704 data, rec->data_len, min_len, max_len,
1705 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001706 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001707 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001709 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001710 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001711
Gabor Mezei90437e32021-10-20 11:59:27 +02001712 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001713 rec->data_len,
1714 min_len, max_len,
1715 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001716#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001717
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001718#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001719 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001720 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001721#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001722
Gabor Mezei90437e32021-10-20 11:59:27 +02001723 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001724 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001725 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#if defined(MBEDTLS_SSL_DEBUG_ALL)
1727 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001728#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001729 correct = 0;
1730 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001731 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001732
1733 hmac_failed_etm_disabled:
1734 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1735 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1736 if( ret != 0 )
1737 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001738 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001739
1740 /*
1741 * Finally check the correct flag
1742 */
1743 if( correct == 0 )
1744 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001745#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001746
1747 /* Make extra sure authentication was performed, exactly once */
1748 if( auth_done != 1 )
1749 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1751 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001752 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001753
Ronald Cron6f135e12021-12-08 16:57:54 +01001754#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001755 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1756 {
1757 /* Remove inner padding and infer true content type. */
1758 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1759 &rec->type );
1760
1761 if( ret != 0 )
1762 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1763 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001764#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001765
Hanno Beckera0e20d02019-05-15 14:03:01 +01001766#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001767 if( rec->cid_len != 0 )
1768 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001769 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1770 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001771 if( ret != 0 )
1772 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1773 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001774#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001775
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001777
1778 return( 0 );
1779}
1780
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001781#undef MAC_NONE
1782#undef MAC_PLAINTEXT
1783#undef MAC_CIPHERTEXT
1784
Paul Bakker5121ce52009-01-03 21:22:43 +00001785/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001786 * Fill the input message buffer by appending data to it.
1787 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001788 *
1789 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1790 * available (from this read and/or a previous one). Otherwise, an error code
1791 * is returned (possibly EOF or WANT_READ).
1792 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001793 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1794 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1795 * since we always read a whole datagram at once.
1796 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001797 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001798 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001801{
Janos Follath865b3eb2019-12-16 11:46:15 +00001802 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001803 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001804#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1805 size_t in_buf_len = ssl->in_buf_len;
1806#else
1807 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1808#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001811
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001812 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1813 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001815 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001817 }
1818
Darryl Greenb33cc762019-11-28 14:29:44 +00001819 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001820 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1822 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001823 }
1824
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001826 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001827 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001828 uint32_t timeout;
1829
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001830 /*
1831 * The point is, we need to always read a full datagram at once, so we
1832 * sometimes read more then requested, and handle the additional data.
1833 * It could be the rest of the current record (while fetching the
1834 * header) and/or some other records in the same datagram.
1835 */
1836
1837 /*
1838 * Move to the next record in the already read datagram if applicable
1839 */
1840 if( ssl->next_record_offset != 0 )
1841 {
1842 if( ssl->in_left < ssl->next_record_offset )
1843 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1845 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001846 }
1847
1848 ssl->in_left -= ssl->next_record_offset;
1849
1850 if( ssl->in_left != 0 )
1851 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1853 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001854 ssl->next_record_offset ) );
1855 memmove( ssl->in_hdr,
1856 ssl->in_hdr + ssl->next_record_offset,
1857 ssl->in_left );
1858 }
1859
1860 ssl->next_record_offset = 0;
1861 }
1862
Paul Elliottd48d5c62021-01-07 14:47:05 +00001863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1864 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001865 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001866
1867 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001868 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001869 */
1870 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001873 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001874 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001875
1876 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001877 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001878 * are not at the beginning of a new record, the caller did something
1879 * wrong.
1880 */
1881 if( ssl->in_left != 0 )
1882 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1884 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001885 }
1886
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001887 /*
1888 * Don't even try to read if time's out already.
1889 * This avoids by-passing the timer when repeatedly receiving messages
1890 * that will end up being dropped.
1891 */
Hanno Becker7876d122020-02-05 10:39:31 +00001892 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001893 {
1894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001895 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001896 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001897 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001898 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001899 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001900
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001902 timeout = ssl->handshake->retransmit_timeout;
1903 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001904 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001905
Paul Elliott9f352112020-12-09 14:55:45 +00001906 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001907
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001908 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001909 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1910 timeout );
1911 else
1912 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001915
1916 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001918 }
1919
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001920 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001921 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001923 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001924
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001926 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001927 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1928 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001930 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001931 }
1932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001934 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001936 return( ret );
1937 }
1938
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001939 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001940 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001942 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001944 {
Hanno Becker786300f2020-02-05 10:46:40 +00001945 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001946 {
Hanno Becker786300f2020-02-05 10:46:40 +00001947 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1948 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001949 return( ret );
1950 }
1951
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001952 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001953 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001955 }
1956
Paul Bakker5121ce52009-01-03 21:22:43 +00001957 if( ret < 0 )
1958 return( ret );
1959
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001960 ssl->in_left = ret;
1961 }
1962 else
1963#endif
1964 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1966 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001967 ssl->in_left, nb_want ) );
1968
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001969 while( ssl->in_left < nb_want )
1970 {
1971 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001972
Hanno Becker7876d122020-02-05 10:39:31 +00001973 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001974 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1975 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001976 {
1977 if( ssl->f_recv_timeout != NULL )
1978 {
1979 ret = ssl->f_recv_timeout( ssl->p_bio,
1980 ssl->in_hdr + ssl->in_left, len,
1981 ssl->conf->read_timeout );
1982 }
1983 else
1984 {
1985 ret = ssl->f_recv( ssl->p_bio,
1986 ssl->in_hdr + ssl->in_left, len );
1987 }
1988 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001989
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é-Gonnard07617332015-06-24 23:00:03 +02001992 ssl->in_left, nb_want ) );
1993 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001994
1995 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001997
1998 if( ret < 0 )
1999 return( ret );
2000
makise-homuraaf9513b2020-08-24 18:26:27 +03002001 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002002 {
Darryl Green11999bb2018-03-13 15:22:58 +00002003 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002004 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002005 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002006 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2007 }
2008
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002009 ssl->in_left += ret;
2010 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002011 }
2012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002014
2015 return( 0 );
2016}
2017
2018/*
2019 * Flush any data not yet written
2020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002021int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002022{
Janos Follath865b3eb2019-12-16 11:46:15 +00002023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002024 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002027
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002028 if( ssl->f_send == NULL )
2029 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002031 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002033 }
2034
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002035 /* Avoid incrementing counter if data is flushed */
2036 if( ssl->out_left == 0 )
2037 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002039 return( 0 );
2040 }
2041
Paul Bakker5121ce52009-01-03 21:22:43 +00002042 while( ssl->out_left > 0 )
2043 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002044 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2045 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002046 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002047
Hanno Becker2b1e3542018-08-06 11:19:13 +01002048 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002049 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002052
2053 if( ret <= 0 )
2054 return( ret );
2055
makise-homuraaf9513b2020-08-24 18:26:27 +03002056 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002057 {
Darryl Green11999bb2018-03-13 15:22:58 +00002058 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002059 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002060 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002061 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2062 }
2063
Paul Bakker5121ce52009-01-03 21:22:43 +00002064 ssl->out_left -= ret;
2065 }
2066
Hanno Becker2b1e3542018-08-06 11:19:13 +01002067#if defined(MBEDTLS_SSL_PROTO_DTLS)
2068 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002069 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002070 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002071 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002072 else
2073#endif
2074 {
2075 ssl->out_hdr = ssl->out_buf + 8;
2076 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002077 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002080
2081 return( 0 );
2082}
2083
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002084/*
2085 * Functions to handle the DTLS retransmission state machine
2086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002088/*
2089 * Append current handshake message to current outgoing flight
2090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002092{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002094 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2095 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2096 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002097
2098 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002099 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002100 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002101 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002103 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002104 }
2105
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002106 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002107 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002108 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2109 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002111 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002112 }
2113
2114 /* Copy current handshake message with headers */
2115 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2116 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002117 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002118 msg->next = NULL;
2119
2120 /* Append to the current flight */
2121 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002122 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002123 else
2124 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002126 while( cur->next != NULL )
2127 cur = cur->next;
2128 cur->next = msg;
2129 }
2130
Hanno Becker3b235902018-08-06 09:54:53 +01002131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002132 return( 0 );
2133}
2134
2135/*
2136 * Free the current flight of handshake messages
2137 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002138void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002139{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 mbedtls_ssl_flight_item *cur = flight;
2141 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002142
2143 while( cur != NULL )
2144 {
2145 next = cur->next;
2146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002147 mbedtls_free( cur->p );
2148 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002149
2150 cur = next;
2151 }
2152}
2153
2154/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002155 * Swap transform_out and out_ctr with the alternative ones
2156 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002157static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002158{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002159 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002160 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002161
2162 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2163 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002164 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002165 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002166 }
2167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002169
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002170 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002171 tmp_transform = ssl->transform_out;
2172 ssl->transform_out = ssl->handshake->alt_transform_out;
2173 ssl->handshake->alt_transform_out = tmp_transform;
2174
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002175 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002176 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2177 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2178 sizeof( ssl->cur_out_ctr ) );
2179 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2180 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002181
2182 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002183 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002184
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002185 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002186}
2187
2188/*
2189 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002190 */
2191int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2192{
2193 int ret = 0;
2194
2195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2196
2197 ret = mbedtls_ssl_flight_transmit( ssl );
2198
2199 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2200
2201 return( ret );
2202}
2203
2204/*
2205 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002206 *
2207 * Need to remember the current message in case flush_output returns
2208 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002209 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002210 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002211int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002212{
Janos Follath865b3eb2019-12-16 11:46:15 +00002213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002214 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002215
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002217 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002218 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002219
2220 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002221 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002222 ret = ssl_swap_epochs( ssl );
2223 if( ret != 0 )
2224 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002227 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002228
2229 while( ssl->handshake->cur_msg != NULL )
2230 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002231 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002232 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002233
Hanno Beckere1dcb032018-08-17 16:47:58 +01002234 int const is_finished =
2235 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2236 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2237
Hanno Becker04da1892018-08-14 13:22:10 +01002238 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2239 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2240
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002241 /* Swap epochs before sending Finished: we can't do it after
2242 * sending ChangeCipherSpec, in case write returns WANT_READ.
2243 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002244 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002245 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002246 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
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é-Gonnardc715aed2014-09-19 21:39:13 +02002250 }
2251
Hanno Becker67bc7c32018-08-06 11:33:50 +01002252 ret = ssl_get_remaining_payload_in_datagram( ssl );
2253 if( ret < 0 )
2254 return( ret );
2255 max_frag_len = (size_t) ret;
2256
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002257 /* CCS is copied as is, while HS messages may need fragmentation */
2258 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2259 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002260 if( max_frag_len == 0 )
2261 {
2262 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2263 return( ret );
2264
2265 continue;
2266 }
2267
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002268 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002269 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002270 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002271
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002272 /* Update position inside current message */
2273 ssl->handshake->cur_msg_p += cur->len;
2274 }
2275 else
2276 {
2277 const unsigned char * const p = ssl->handshake->cur_msg_p;
2278 const size_t hs_len = cur->len - 12;
2279 const size_t frag_off = p - ( cur->p + 12 );
2280 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002281 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002282
Hanno Beckere1dcb032018-08-17 16:47:58 +01002283 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002284 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002285 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002286 {
2287 ret = ssl_swap_epochs( ssl );
2288 if( ret != 0 )
2289 return( ret );
2290 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002291
Hanno Becker67bc7c32018-08-06 11:33:50 +01002292 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2293 return( ret );
2294
2295 continue;
2296 }
2297 max_hs_frag_len = max_frag_len - 12;
2298
2299 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2300 max_hs_frag_len : rem_len;
2301
2302 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002303 {
2304 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002305 (unsigned) cur_hs_frag_len,
2306 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002307 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002308
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002309 /* Messages are stored with handshake headers as if not fragmented,
2310 * copy beginning of headers then fill fragmentation fields.
2311 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2312 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313
Joe Subbiani5ecac212021-06-24 13:00:03 +01002314 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2315 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2316 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002317
Joe Subbiani5ecac212021-06-24 13:00:03 +01002318 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2319 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2320 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002321
2322 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2323
Hanno Becker3f7b9732018-08-28 09:53:25 +01002324 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002325 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2326 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002327 ssl->out_msgtype = cur->type;
2328
2329 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002330 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002331 }
2332
2333 /* If done with the current message move to the next one if any */
2334 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2335 {
2336 if( cur->next != NULL )
2337 {
2338 ssl->handshake->cur_msg = cur->next;
2339 ssl->handshake->cur_msg_p = cur->next->p + 12;
2340 }
2341 else
2342 {
2343 ssl->handshake->cur_msg = NULL;
2344 ssl->handshake->cur_msg_p = NULL;
2345 }
2346 }
2347
2348 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002349 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002350 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002352 return( ret );
2353 }
2354 }
2355
Hanno Becker67bc7c32018-08-06 11:33:50 +01002356 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2357 return( ret );
2358
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002359 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2361 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002362 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002363 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002365 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002366 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002367
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002368 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002369
2370 return( 0 );
2371}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002372
2373/*
2374 * To be called when the last message of an incoming flight is received.
2375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002377{
2378 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002379 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002380 ssl->handshake->flight = NULL;
2381 ssl->handshake->cur_msg = NULL;
2382
2383 /* The next incoming flight will start with this msg_seq */
2384 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2385
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002386 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002387 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002388
Hanno Becker0271f962018-08-16 13:23:47 +01002389 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002390 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002391
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002392 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002393 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2396 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002397 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002398 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002399 }
2400 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002402}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002403
2404/*
2405 * To be called when the last message of an outgoing flight is send.
2406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002408{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002409 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002410 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2413 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002414 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002416 }
2417 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002419}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002421
Paul Bakker5121ce52009-01-03 21:22:43 +00002422/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002423 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425
2426/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002427 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002428 *
2429 * - fill in handshake headers
2430 * - update handshake checksum
2431 * - DTLS: save message for resending
2432 * - then pass to the record layer
2433 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002434 * DTLS: except for HelloRequest, messages are only queued, and will only be
2435 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002436 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002437 * Inputs:
2438 * - ssl->out_msglen: 4 + actual handshake message len
2439 * (4 is the size of handshake headers for TLS)
2440 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2441 * - ssl->out_msg + 4: the handshake message body
2442 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002443 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002444 * - ssl->out_msglen: the length of the record contents
2445 * (including handshake headers but excluding record headers)
2446 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002447 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002448int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2449 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002450{
Janos Follath865b3eb2019-12-16 11:46:15 +00002451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002452 const size_t hs_len = ssl->out_msglen - 4;
2453 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002454
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002455 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2456
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002457 /*
2458 * Sanity checks
2459 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002460 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002461 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2462 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2464 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002465 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002466
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002467 /* Whenever we send anything different from a
2468 * HelloRequest we should be in a handshake - double check. */
2469 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2470 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002471 ssl->handshake == NULL )
2472 {
2473 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2474 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2475 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002478 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002479 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002481 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2483 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002484 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002485#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002486
Hanno Beckerb50a2532018-08-06 11:52:54 +01002487 /* Double-check that we did not exceed the bounds
2488 * of the outgoing record buffer.
2489 * This should never fail as the various message
2490 * writing functions must obey the bounds of the
2491 * outgoing record buffer, but better be safe.
2492 *
2493 * Note: We deliberately do not check for the MTU or MFL here.
2494 */
2495 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2496 {
2497 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002498 "size %" MBEDTLS_PRINTF_SIZET
2499 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002500 ssl->out_msglen,
2501 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002502 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2503 }
2504
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002505 /*
2506 * Fill handshake headers
2507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002509 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002510 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2511 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2512 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002513
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002514 /*
2515 * DTLS has additional fields in the Handshake layer,
2516 * between the length field and the actual payload:
2517 * uint16 message_seq;
2518 * uint24 fragment_offset;
2519 * uint24 fragment_length;
2520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002522 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002523 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002524 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002525 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002526 {
2527 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002528 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002529 hs_len,
2530 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002531 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2532 }
2533
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002534 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002535 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002536
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002537 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002538 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002539 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002540 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002541 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002542 }
2543 else
2544 {
2545 ssl->out_msg[4] = 0;
2546 ssl->out_msg[5] = 0;
2547 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002548
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002549 /* Handshake hashes are computed without fragmentation,
2550 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002551 memset( ssl->out_msg + 6, 0x00, 3 );
2552 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002553 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002555
Hanno Becker0207e532018-08-28 10:28:28 +01002556 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002557 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002558 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 }
2560
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002561 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002563 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002564 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2565 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002566 {
2567 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2568 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002570 return( ret );
2571 }
2572 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002573 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002574#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002575 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002576 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002577 {
2578 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2579 return( ret );
2580 }
2581 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002582
2583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2584
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002585 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002586}
2587
2588/*
2589 * Record layer functions
2590 */
2591
2592/*
2593 * Write current record.
2594 *
2595 * Uses:
2596 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2597 * - ssl->out_msglen: length of the record content (excl headers)
2598 * - ssl->out_msg: record content
2599 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002600int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002601{
2602 int ret, done = 0;
2603 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002604 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002605
2606 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002607
Paul Bakker05ef8352012-05-08 09:17:57 +00002608 if( !done )
2609 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002610 unsigned i;
2611 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002612#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2613 size_t out_buf_len = ssl->out_buf_len;
2614#else
2615 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2616#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002617 /* Skip writing the record content type to after the encryption,
2618 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002619 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002620#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002621 /* TLS 1.3 still uses the TLS 1.2 version identifier
2622 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002623 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2624 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002625#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002626 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2627 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002628
Jerry Yuae0b2e22021-10-08 15:21:19 +08002629 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002630 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002631
Paul Bakker48916f92012-09-16 19:57:18 +00002632 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002633 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002634 mbedtls_record rec;
2635
2636 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002637 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002638 rec.data_len = ssl->out_msglen;
2639 rec.data_offset = ssl->out_msg - rec.buf;
2640
Jerry Yud96a5c22021-09-29 17:46:51 +08002641 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002642 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002643 ssl->conf->transport, rec.ver );
2644 rec.type = ssl->out_msgtype;
2645
Hanno Beckera0e20d02019-05-15 14:03:01 +01002646#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002647 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002648 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002649#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002650
Hanno Beckera18d1322018-01-03 14:27:32 +00002651 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002652 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002653 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002655 return( ret );
2656 }
2657
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002658 if( rec.data_offset != 0 )
2659 {
2660 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2661 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2662 }
2663
Hanno Becker6430faf2019-05-08 11:57:13 +01002664 /* Update the record content type and CID. */
2665 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002666#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002667 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002668#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002669 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002670 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002671 }
2672
Hanno Becker5903de42019-05-03 14:46:38 +01002673 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002674
2675#if defined(MBEDTLS_SSL_PROTO_DTLS)
2676 /* In case of DTLS, double-check that we don't exceed
2677 * the remaining space in the datagram. */
2678 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2679 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002680 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002681 if( ret < 0 )
2682 return( ret );
2683
2684 if( protected_record_size > (size_t) ret )
2685 {
2686 /* Should never happen */
2687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2688 }
2689 }
2690#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002691
Hanno Becker6430faf2019-05-08 11:57:13 +01002692 /* Now write the potentially updated record content type. */
2693 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2694
Paul Elliott9f352112020-12-09 14:55:45 +00002695 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002696 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002697 ssl->out_hdr[0], ssl->out_hdr[1],
2698 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002701 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002702
2703 ssl->out_left += protected_record_size;
2704 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002705 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002706
Hanno Beckerdd772292020-02-05 10:38:31 +00002707 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002708 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2709 break;
2710
2711 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002712 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002713 {
2714 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2715 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2716 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002717 }
2718
Hanno Becker67bc7c32018-08-06 11:33:50 +01002719#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002720 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2721 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002722 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002723 size_t remaining;
2724 ret = ssl_get_remaining_payload_in_datagram( ssl );
2725 if( ret < 0 )
2726 {
2727 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2728 ret );
2729 return( ret );
2730 }
2731
2732 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002733 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002734 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002735 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002736 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002737 else
2738 {
Hanno Becker513815a2018-08-20 11:56:09 +01002739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002740 }
2741 }
2742#endif /* MBEDTLS_SSL_PROTO_DTLS */
2743
2744 if( ( flush == SSL_FORCE_FLUSH ) &&
2745 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002746 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002748 return( ret );
2749 }
2750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002752
2753 return( 0 );
2754}
2755
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002757
2758static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2759{
2760 if( ssl->in_msglen < ssl->in_hslen ||
2761 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2762 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2763 {
2764 return( 1 );
2765 }
2766 return( 0 );
2767}
Hanno Becker44650b72018-08-16 12:51:11 +01002768
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002769static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002770{
2771 return( ( ssl->in_msg[9] << 16 ) |
2772 ( ssl->in_msg[10] << 8 ) |
2773 ssl->in_msg[11] );
2774}
2775
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002776static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002777{
2778 return( ( ssl->in_msg[6] << 16 ) |
2779 ( ssl->in_msg[7] << 8 ) |
2780 ssl->in_msg[8] );
2781}
2782
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002783static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002784{
2785 uint32_t msg_len, frag_off, frag_len;
2786
2787 msg_len = ssl_get_hs_total_len( ssl );
2788 frag_off = ssl_get_hs_frag_off( ssl );
2789 frag_len = ssl_get_hs_frag_len( ssl );
2790
2791 if( frag_off > msg_len )
2792 return( -1 );
2793
2794 if( frag_len > msg_len - frag_off )
2795 return( -1 );
2796
2797 if( frag_len + 12 > ssl->in_msglen )
2798 return( -1 );
2799
2800 return( 0 );
2801}
2802
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002803/*
2804 * Mark bits in bitmask (used for DTLS HS reassembly)
2805 */
2806static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2807{
2808 unsigned int start_bits, end_bits;
2809
2810 start_bits = 8 - ( offset % 8 );
2811 if( start_bits != 8 )
2812 {
2813 size_t first_byte_idx = offset / 8;
2814
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002815 /* Special case */
2816 if( len <= start_bits )
2817 {
2818 for( ; len != 0; len-- )
2819 mask[first_byte_idx] |= 1 << ( start_bits - len );
2820
2821 /* Avoid potential issues with offset or len becoming invalid */
2822 return;
2823 }
2824
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002825 offset += start_bits; /* Now offset % 8 == 0 */
2826 len -= start_bits;
2827
2828 for( ; start_bits != 0; start_bits-- )
2829 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2830 }
2831
2832 end_bits = len % 8;
2833 if( end_bits != 0 )
2834 {
2835 size_t last_byte_idx = ( offset + len ) / 8;
2836
2837 len -= end_bits; /* Now len % 8 == 0 */
2838
2839 for( ; end_bits != 0; end_bits-- )
2840 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2841 }
2842
2843 memset( mask + offset / 8, 0xFF, len / 8 );
2844}
2845
2846/*
2847 * Check that bitmask is full
2848 */
2849static int ssl_bitmask_check( unsigned char *mask, size_t len )
2850{
2851 size_t i;
2852
2853 for( i = 0; i < len / 8; i++ )
2854 if( mask[i] != 0xFF )
2855 return( -1 );
2856
2857 for( i = 0; i < len % 8; i++ )
2858 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2859 return( -1 );
2860
2861 return( 0 );
2862}
2863
Hanno Becker56e205e2018-08-16 09:06:12 +01002864/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002865static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002866 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002867{
Hanno Becker56e205e2018-08-16 09:06:12 +01002868 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002869
Hanno Becker56e205e2018-08-16 09:06:12 +01002870 alloc_len = 12; /* Handshake header */
2871 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002872
Hanno Beckerd07df862018-08-16 09:14:58 +01002873 if( add_bitmap )
2874 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002875
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002876 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002877}
Hanno Becker56e205e2018-08-16 09:06:12 +01002878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002880
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002881static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002882{
2883 return( ( ssl->in_msg[1] << 16 ) |
2884 ( ssl->in_msg[2] << 8 ) |
2885 ssl->in_msg[3] );
2886}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002887
Simon Butcher99000142016-10-13 17:21:01 +01002888int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002889{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002891 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002892 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002893 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002895 }
2896
Hanno Becker12555c62018-08-16 12:47:53 +01002897 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002898
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002900 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002901 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002904 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002905 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002906 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002907 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002908
Hanno Becker44650b72018-08-16 12:51:11 +01002909 if( ssl_check_hs_header( ssl ) != 0 )
2910 {
2911 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2912 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2913 }
2914
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002915 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002916 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2917 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2918 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2919 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002920 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002921 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2922 {
2923 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2924 recv_msg_seq,
2925 ssl->handshake->in_msg_seq ) );
2926 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2927 }
2928
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002929 /* Retransmit only on last message from previous flight, to avoid
2930 * too many retransmissions.
2931 * Besides, No sane server ever retransmits HelloVerifyRequest */
2932 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002934 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002936 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002937 recv_msg_seq,
2938 ssl->handshake->in_flight_start_seq ) );
2939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002941 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002943 return( ret );
2944 }
2945 }
2946 else
2947 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002949 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002950 recv_msg_seq,
2951 ssl->handshake->in_msg_seq ) );
2952 }
2953
Hanno Becker90333da2017-10-10 11:27:13 +01002954 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002955 }
2956 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002957
Hanno Becker6d97ef52018-08-16 13:09:04 +01002958 /* Message reassembly is handled alongside buffering of future
2959 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002960 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002961 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002962 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002965 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002966 }
2967 }
2968 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002970 /* With TLS we don't handle fragmentation (for now) */
2971 if( ssl->in_msglen < ssl->in_hslen )
2972 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2974 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002975 }
2976
Simon Butcher99000142016-10-13 17:21:01 +01002977 return( 0 );
2978}
2979
2980void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2981{
Hanno Becker0271f962018-08-16 13:23:47 +01002982 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002983
Hanno Becker0271f962018-08-16 13:23:47 +01002984 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002985 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002986 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002987 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002988
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002989 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002991 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002992 ssl->handshake != NULL )
2993 {
Hanno Becker0271f962018-08-16 13:23:47 +01002994 unsigned offset;
2995 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002996
Hanno Becker0271f962018-08-16 13:23:47 +01002997 /* Increment handshake sequence number */
2998 hs->in_msg_seq++;
2999
3000 /*
3001 * Clear up handshake buffering and reassembly structure.
3002 */
3003
3004 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003005 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003006
3007 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003008 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3009 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003010 offset++, hs_buf++ )
3011 {
3012 *hs_buf = *(hs_buf + 1);
3013 }
3014
3015 /* Create a fresh last entry */
3016 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003017 }
3018#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003019}
3020
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003021/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003022 * DTLS anti-replay: RFC 6347 4.1.2.6
3023 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003024 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3025 * Bit n is set iff record number in_window_top - n has been seen.
3026 *
3027 * Usually, in_window_top is the last record number seen and the lsb of
3028 * in_window is set. The only exception is the initial state (record number 0
3029 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003032void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003033{
3034 ssl->in_window_top = 0;
3035 ssl->in_window = 0;
3036}
3037
3038static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3039{
3040 return( ( (uint64_t) buf[0] << 40 ) |
3041 ( (uint64_t) buf[1] << 32 ) |
3042 ( (uint64_t) buf[2] << 24 ) |
3043 ( (uint64_t) buf[3] << 16 ) |
3044 ( (uint64_t) buf[4] << 8 ) |
3045 ( (uint64_t) buf[5] ) );
3046}
3047
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003048static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3049{
Janos Follath865b3eb2019-12-16 11:46:15 +00003050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003051 unsigned char *original_in_ctr;
3052
3053 // save original in_ctr
3054 original_in_ctr = ssl->in_ctr;
3055
3056 // use counter from record
3057 ssl->in_ctr = record_in_ctr;
3058
3059 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3060
3061 // restore the counter
3062 ssl->in_ctr = original_in_ctr;
3063
3064 return ret;
3065}
3066
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003067/*
3068 * Return 0 if sequence number is acceptable, -1 otherwise
3069 */
Hanno Becker0183d692019-07-12 08:50:37 +01003070int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003071{
3072 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3073 uint64_t bit;
3074
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003075 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003076 return( 0 );
3077
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003078 if( rec_seqnum > ssl->in_window_top )
3079 return( 0 );
3080
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003081 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003082
3083 if( bit >= 64 )
3084 return( -1 );
3085
3086 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3087 return( -1 );
3088
3089 return( 0 );
3090}
3091
3092/*
3093 * Update replay window on new validated record
3094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *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
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003099 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003100 return;
3101
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003102 if( rec_seqnum > ssl->in_window_top )
3103 {
3104 /* Update window_top and the contents of the window */
3105 uint64_t shift = rec_seqnum - ssl->in_window_top;
3106
3107 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003108 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003109 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003110 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003111 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003112 ssl->in_window |= 1;
3113 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003114
3115 ssl->in_window_top = rec_seqnum;
3116 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003117 else
3118 {
3119 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003120 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003121
3122 if( bit < 64 ) /* Always true, but be extra sure */
3123 ssl->in_window |= (uint64_t) 1 << bit;
3124 }
3125}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003127
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003128#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003129/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003130 * Without any SSL context, check if a datagram looks like a ClientHello with
3131 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003132 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003133 *
3134 * - if cookie is valid, return 0
3135 * - if ClientHello looks superficially valid but cookie is not,
3136 * fill obuf and set olen, then
3137 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3138 * - otherwise return a specific error code
3139 */
3140static int ssl_check_dtls_clihlo_cookie(
3141 mbedtls_ssl_cookie_write_t *f_cookie_write,
3142 mbedtls_ssl_cookie_check_t *f_cookie_check,
3143 void *p_cookie,
3144 const unsigned char *cli_id, size_t cli_id_len,
3145 const unsigned char *in, size_t in_len,
3146 unsigned char *obuf, size_t buf_len, size_t *olen )
3147{
3148 size_t sid_len, cookie_len;
3149 unsigned char *p;
3150
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003151 /*
3152 * Structure of ClientHello with record and handshake headers,
3153 * and expected values. We don't need to check a lot, more checks will be
3154 * done when actually parsing the ClientHello - skipping those checks
3155 * avoids code duplication and does not make cookie forging any easier.
3156 *
3157 * 0-0 ContentType type; copied, must be handshake
3158 * 1-2 ProtocolVersion version; copied
3159 * 3-4 uint16 epoch; copied, must be 0
3160 * 5-10 uint48 sequence_number; copied
3161 * 11-12 uint16 length; (ignored)
3162 *
3163 * 13-13 HandshakeType msg_type; (ignored)
3164 * 14-16 uint24 length; (ignored)
3165 * 17-18 uint16 message_seq; copied
3166 * 19-21 uint24 fragment_offset; copied, must be 0
3167 * 22-24 uint24 fragment_length; (ignored)
3168 *
3169 * 25-26 ProtocolVersion client_version; (ignored)
3170 * 27-58 Random random; (ignored)
3171 * 59-xx SessionID session_id; 1 byte len + sid_len content
3172 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3173 * ...
3174 *
3175 * Minimum length is 61 bytes.
3176 */
3177 if( in_len < 61 ||
3178 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3179 in[3] != 0 || in[4] != 0 ||
3180 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3181 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003182 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003183 }
3184
3185 sid_len = in[59];
3186 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003187 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003188
3189 cookie_len = in[60 + sid_len];
3190 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003191 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003192
3193 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3194 cli_id, cli_id_len ) == 0 )
3195 {
3196 /* Valid cookie */
3197 return( 0 );
3198 }
3199
3200 /*
3201 * If we get here, we've got an invalid cookie, let's prepare HVR.
3202 *
3203 * 0-0 ContentType type; copied
3204 * 1-2 ProtocolVersion version; copied
3205 * 3-4 uint16 epoch; copied
3206 * 5-10 uint48 sequence_number; copied
3207 * 11-12 uint16 length; olen - 13
3208 *
3209 * 13-13 HandshakeType msg_type; hello_verify_request
3210 * 14-16 uint24 length; olen - 25
3211 * 17-18 uint16 message_seq; copied
3212 * 19-21 uint24 fragment_offset; copied
3213 * 22-24 uint24 fragment_length; olen - 25
3214 *
3215 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3216 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3217 *
3218 * Minimum length is 28.
3219 */
3220 if( buf_len < 28 )
3221 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3222
3223 /* Copy most fields and adapt others */
3224 memcpy( obuf, in, 25 );
3225 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3226 obuf[25] = 0xfe;
3227 obuf[26] = 0xff;
3228
3229 /* Generate and write actual cookie */
3230 p = obuf + 28;
3231 if( f_cookie_write( p_cookie,
3232 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3233 {
3234 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3235 }
3236
3237 *olen = p - obuf;
3238
3239 /* Go back and fill length fields */
3240 obuf[27] = (unsigned char)( *olen - 28 );
3241
Joe Subbianifbeb6922021-07-16 14:27:50 +01003242 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3243 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3244 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003245
Joe Subbiani6dd73642021-07-19 11:56:54 +01003246 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003247
3248 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3249}
3250
3251/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003252 * Handle possible client reconnect with the same UDP quadruplet
3253 * (RFC 6347 Section 4.2.8).
3254 *
3255 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3256 * that looks like a ClientHello.
3257 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003258 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003259 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003260 * - if the input looks like a ClientHello with a valid cookie,
3261 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003262 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003263 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003264 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003265 * This function is called (through ssl_check_client_reconnect()) when an
3266 * unexpected record is found in ssl_get_next_record(), which will discard the
3267 * record if we return 0, and bubble up the return value otherwise (this
3268 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3269 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003270 */
3271static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3272{
Janos Follath865b3eb2019-12-16 11:46:15 +00003273 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003274 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003275
Hanno Becker2fddd372019-07-10 14:37:41 +01003276 if( ssl->conf->f_cookie_write == NULL ||
3277 ssl->conf->f_cookie_check == NULL )
3278 {
3279 /* If we can't use cookies to verify reachability of the peer,
3280 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003281 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3282 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003283 return( 0 );
3284 }
3285
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003286 ret = ssl_check_dtls_clihlo_cookie(
3287 ssl->conf->f_cookie_write,
3288 ssl->conf->f_cookie_check,
3289 ssl->conf->p_cookie,
3290 ssl->cli_id, ssl->cli_id_len,
3291 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003292 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003293
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003294 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3295
3296 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003297 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003298 int send_ret;
3299 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3300 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3301 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003302 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003303 * If the error is permanent we'll catch it later,
3304 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003305 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3306 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3307 (void) send_ret;
3308
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003309 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003310 }
3311
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003312 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003313 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003314 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003315 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003316 {
3317 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3318 return( ret );
3319 }
3320
3321 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003322 }
3323
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003324 return( ret );
3325}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003326#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003327
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003328static int ssl_check_record_type( uint8_t record_type )
3329{
3330 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3331 record_type != MBEDTLS_SSL_MSG_ALERT &&
3332 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3333 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3334 {
3335 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3336 }
3337
3338 return( 0 );
3339}
3340
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003341/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003342 * ContentType type;
3343 * ProtocolVersion version;
3344 * uint16 epoch; // DTLS only
3345 * uint48 sequence_number; // DTLS only
3346 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003347 *
3348 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003349 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003350 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3351 *
3352 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003353 * 1. proceed with the record if this function returns 0
3354 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3355 * 3. return CLIENT_RECONNECT if this function return that value
3356 * 4. drop the whole datagram if this function returns anything else.
3357 * Point 2 is needed when the peer is resending, and we have already received
3358 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003359 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003360static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003361 unsigned char *buf,
3362 size_t len,
3363 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003364{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003365 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003366
Hanno Beckere5e7e782019-07-11 12:29:35 +01003367 size_t const rec_hdr_type_offset = 0;
3368 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003369
Hanno Beckere5e7e782019-07-11 12:29:35 +01003370 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3371 rec_hdr_type_len;
3372 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003373
Hanno Beckere5e7e782019-07-11 12:29:35 +01003374 size_t const rec_hdr_ctr_len = 8;
3375#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003376 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003377 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3378 rec_hdr_version_len;
3379
Hanno Beckera0e20d02019-05-15 14:03:01 +01003380#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003381 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3382 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003383 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003384#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3385#endif /* MBEDTLS_SSL_PROTO_DTLS */
3386
3387 size_t rec_hdr_len_offset; /* To be determined */
3388 size_t const rec_hdr_len_len = 2;
3389
3390 /*
3391 * Check minimum lengths for record header.
3392 */
3393
3394#if defined(MBEDTLS_SSL_PROTO_DTLS)
3395 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3396 {
3397 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3398 }
3399 else
3400#endif /* MBEDTLS_SSL_PROTO_DTLS */
3401 {
3402 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3403 }
3404
3405 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3406 {
3407 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3408 (unsigned) len,
3409 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3410 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3411 }
3412
3413 /*
3414 * Parse and validate record content type
3415 */
3416
3417 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003418
3419 /* Check record content type */
3420#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3421 rec->cid_len = 0;
3422
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003423 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003424 ssl->conf->cid_len != 0 &&
3425 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003426 {
3427 /* Shift pointers to account for record header including CID
3428 * struct {
3429 * ContentType special_type = tls12_cid;
3430 * ProtocolVersion version;
3431 * uint16 epoch;
3432 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003433 * opaque cid[cid_length]; // Additional field compared to
3434 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003435 * uint16 length;
3436 * opaque enc_content[DTLSCiphertext.length];
3437 * } DTLSCiphertext;
3438 */
3439
3440 /* So far, we only support static CID lengths
3441 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003442 rec_hdr_cid_len = ssl->conf->cid_len;
3443 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003444
Hanno Beckere5e7e782019-07-11 12:29:35 +01003445 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003446 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003447 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3448 (unsigned) len,
3449 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003450 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003451 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003452
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003453 /* configured CID len is guaranteed at most 255, see
3454 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3455 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003456 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003457 }
3458 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003460 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003461 if( ssl_check_record_type( rec->type ) )
3462 {
Hanno Becker54229812019-07-12 14:40:00 +01003463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3464 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003465 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3466 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003467 }
3468
Hanno Beckere5e7e782019-07-11 12:29:35 +01003469 /*
3470 * Parse and validate record version
3471 */
3472
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003473 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3474 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003475 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3476 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003477 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003478
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003479 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003480 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3482 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003483 }
3484
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003485 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3488 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003489 }
3490
Hanno Beckere5e7e782019-07-11 12:29:35 +01003491 /*
3492 * Parse/Copy record sequence number.
3493 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003494
Hanno Beckere5e7e782019-07-11 12:29:35 +01003495#if defined(MBEDTLS_SSL_PROTO_DTLS)
3496 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003497 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003498 /* Copy explicit record sequence number from input buffer. */
3499 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3500 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003501 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003502 else
3503#endif /* MBEDTLS_SSL_PROTO_DTLS */
3504 {
3505 /* Copy implicit record sequence number from SSL context structure. */
3506 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3507 }
Paul Bakker40e46942009-01-03 21:51:57 +00003508
Hanno Beckere5e7e782019-07-11 12:29:35 +01003509 /*
3510 * Parse record length.
3511 */
3512
Hanno Beckere5e7e782019-07-11 12:29:35 +01003513 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003514 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3515 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003516 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003517
Paul Elliott9f352112020-12-09 14:55:45 +00003518 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003519 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003520 rec->type,
3521 major_ver, minor_ver, rec->data_len ) );
3522
3523 rec->buf = buf;
3524 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003525
Hanno Beckerd417cc92019-07-26 08:20:27 +01003526 if( rec->data_len == 0 )
3527 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003528
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003529 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003530 * DTLS-related tests.
3531 * Check epoch before checking length constraint because
3532 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3533 * message gets duplicated before the corresponding Finished message,
3534 * the second ChangeCipherSpec should be discarded because it belongs
3535 * to an old epoch, but not because its length is shorter than
3536 * the minimum record length for packets using the new record transform.
3537 * Note that these two kinds of failures are handled differently,
3538 * as an unexpected record is silently skipped but an invalid
3539 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003540 */
3541#if defined(MBEDTLS_SSL_PROTO_DTLS)
3542 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3543 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003544 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003545
Hanno Becker955a5c92019-07-10 17:12:07 +01003546 /* Check that the datagram is large enough to contain a record
3547 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003548 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003549 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3551 (unsigned) len,
3552 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003553 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3554 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003555
Hanno Becker37cfe732019-07-10 17:20:01 +01003556 /* Records from other, non-matching epochs are silently discarded.
3557 * (The case of same-port Client reconnects must be considered in
3558 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003559 if( rec_epoch != ssl->in_epoch )
3560 {
3561 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003562 "expected %u, received %lu",
3563 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003564
Hanno Becker552f7472019-07-19 10:59:12 +01003565 /* Records from the next epoch are considered for buffering
3566 * (concretely: early Finished messages). */
3567 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003568 {
Hanno Becker552f7472019-07-19 10:59:12 +01003569 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3570 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003571 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003572
Hanno Becker2fddd372019-07-10 14:37:41 +01003573 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003574 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003575#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003576 /* For records from the correct epoch, check whether their
3577 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003578 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3579 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003580 {
3581 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3582 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3583 }
3584#endif
3585 }
3586#endif /* MBEDTLS_SSL_PROTO_DTLS */
3587
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003588 return( 0 );
3589}
Paul Bakker5121ce52009-01-03 21:22:43 +00003590
Paul Bakker5121ce52009-01-03 21:22:43 +00003591
Hanno Becker2fddd372019-07-10 14:37:41 +01003592#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3593static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3594{
3595 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3596
3597 /*
3598 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3599 * access the first byte of record content (handshake type), as we
3600 * have an active transform (possibly iv_len != 0), so use the
3601 * fact that the record header len is 13 instead.
3602 */
3603 if( rec_epoch == 0 &&
3604 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3605 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3606 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3607 ssl->in_left > 13 &&
3608 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3609 {
3610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3611 "from the same port" ) );
3612 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003613 }
3614
3615 return( 0 );
3616}
Hanno Becker2fddd372019-07-10 14:37:41 +01003617#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003618
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003619/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003620 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003621 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003622static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3623 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003624{
3625 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003628 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003629
Ronald Cron7e38cba2021-11-24 12:43:39 +01003630 /*
3631 * In TLS 1.3, always treat ChangeCipherSpec records
3632 * as unencrypted. The only thing we do with them is
3633 * check the length and content and ignore them.
3634 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003635#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003636 if( ssl->transform_in != NULL &&
3637 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3638 {
3639 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3640 done = 1;
3641 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003642#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003643
Paul Bakker48916f92012-09-16 19:57:18 +00003644 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003645 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003646 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003647
Hanno Beckera18d1322018-01-03 14:27:32 +00003648 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003649 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003650 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003652
Hanno Beckera0e20d02019-05-15 14:03:01 +01003653#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003654 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3655 ssl->conf->ignore_unexpected_cid
3656 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3657 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003658 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003659 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003660 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003661#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003662
Paul Bakker5121ce52009-01-03 21:22:43 +00003663 return( ret );
3664 }
3665
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003666 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003667 {
3668 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003669 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003670 }
3671
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003672 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003673 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003674
Hanno Beckera0e20d02019-05-15 14:03:01 +01003675#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003676 /* We have already checked the record content type
3677 * in ssl_parse_record_header(), failing or silently
3678 * dropping the record in the case of an unknown type.
3679 *
3680 * Since with the use of CIDs, the record content type
3681 * might change during decryption, re-check the record
3682 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003683 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003684 {
3685 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3686 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3687 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003688#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003689
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003690 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003691 {
3692#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3693 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003694 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003695 {
3696 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3698 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3699 }
3700#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3701
3702 ssl->nb_zero++;
3703
3704 /*
3705 * Three or more empty messages may be a DoS attack
3706 * (excessive CPU consumption).
3707 */
3708 if( ssl->nb_zero > 3 )
3709 {
3710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003711 "messages, possible DoS attack" ) );
3712 /* Treat the records as if they were not properly authenticated,
3713 * thereby failing the connection if we see more than allowed
3714 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003715 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3716 }
3717 }
3718 else
3719 ssl->nb_zero = 0;
3720
3721#if defined(MBEDTLS_SSL_PROTO_DTLS)
3722 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3723 {
3724 ; /* in_ctr read from peer, not maintained internally */
3725 }
3726 else
3727#endif
3728 {
3729 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003730 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3731 i > mbedtls_ssl_ep_len( ssl ); i-- )
3732 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003733 if( ++ssl->in_ctr[i - 1] != 0 )
3734 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003735 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003736
3737 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003738 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003739 {
3740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3741 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3742 }
3743 }
3744
Paul Bakker5121ce52009-01-03 21:22:43 +00003745 }
3746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003747#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003748 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003749 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003750 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003751 }
3752#endif
3753
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003754 /* Check actual (decrypted) record content length against
3755 * configured maximum. */
3756 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3757 {
3758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3759 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3760 }
3761
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003762 return( 0 );
3763}
3764
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003765/*
3766 * Read a record.
3767 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003768 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3769 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3770 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003771 */
Hanno Becker1097b342018-08-15 14:09:41 +01003772
3773/* Helper functions for mbedtls_ssl_read_record(). */
3774static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003775static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3776static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003777
Hanno Becker327c93b2018-08-15 13:56:18 +01003778int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003779 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003780{
Janos Follath865b3eb2019-12-16 11:46:15 +00003781 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003782
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003784
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003785 if( ssl->keep_current_message == 0 )
3786 {
3787 do {
Simon Butcher99000142016-10-13 17:21:01 +01003788
Hanno Becker26994592018-08-15 14:14:59 +01003789 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003790 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003791 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003792
Hanno Beckere74d5562018-08-15 14:26:08 +01003793 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003794 {
Hanno Becker40f50842018-08-15 14:48:01 +01003795#if defined(MBEDTLS_SSL_PROTO_DTLS)
3796 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003797
Hanno Becker40f50842018-08-15 14:48:01 +01003798 /* We only check for buffered messages if the
3799 * current datagram is fully consumed. */
3800 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003801 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003802 {
Hanno Becker40f50842018-08-15 14:48:01 +01003803 if( ssl_load_buffered_message( ssl ) == 0 )
3804 have_buffered = 1;
3805 }
3806
3807 if( have_buffered == 0 )
3808#endif /* MBEDTLS_SSL_PROTO_DTLS */
3809 {
3810 ret = ssl_get_next_record( ssl );
3811 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3812 continue;
3813
3814 if( ret != 0 )
3815 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003816 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003817 return( ret );
3818 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003819 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003820 }
3821
3822 ret = mbedtls_ssl_handle_message_type( ssl );
3823
Hanno Becker40f50842018-08-15 14:48:01 +01003824#if defined(MBEDTLS_SSL_PROTO_DTLS)
3825 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3826 {
3827 /* Buffer future message */
3828 ret = ssl_buffer_message( ssl );
3829 if( ret != 0 )
3830 return( ret );
3831
3832 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3833 }
3834#endif /* MBEDTLS_SSL_PROTO_DTLS */
3835
Hanno Becker90333da2017-10-10 11:27:13 +01003836 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3837 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003838
3839 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003840 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003841 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003842 return( ret );
3843 }
3844
Hanno Becker327c93b2018-08-15 13:56:18 +01003845 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003846 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003847 {
3848 mbedtls_ssl_update_handshake_status( ssl );
3849 }
Simon Butcher99000142016-10-13 17:21:01 +01003850 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003851 else
Simon Butcher99000142016-10-13 17:21:01 +01003852 {
Hanno Becker02f59072018-08-15 14:00:24 +01003853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003854 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003855 }
3856
3857 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3858
3859 return( 0 );
3860}
3861
Hanno Becker40f50842018-08-15 14:48:01 +01003862#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003863static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003864{
Hanno Becker40f50842018-08-15 14:48:01 +01003865 if( ssl->in_left > ssl->next_record_offset )
3866 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003867
Hanno Becker40f50842018-08-15 14:48:01 +01003868 return( 0 );
3869}
3870
3871static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3872{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003873 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003874 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003875 int ret = 0;
3876
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003877 if( hs == NULL )
3878 return( -1 );
3879
Hanno Beckere00ae372018-08-20 09:39:42 +01003880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3881
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003882 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3883 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3884 {
3885 /* Check if we have seen a ChangeCipherSpec before.
3886 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003887 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003888 {
3889 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3890 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003891 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003892 }
3893
Hanno Becker39b8bc92018-08-28 17:17:13 +01003894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003895 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3896 ssl->in_msglen = 1;
3897 ssl->in_msg[0] = 1;
3898
3899 /* As long as they are equal, the exact value doesn't matter. */
3900 ssl->in_left = 0;
3901 ssl->next_record_offset = 0;
3902
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003903 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003904 goto exit;
3905 }
Hanno Becker37f95322018-08-16 13:55:32 +01003906
Hanno Beckerb8f50142018-08-28 10:01:34 +01003907#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003908 /* Debug only */
3909 {
3910 unsigned offset;
3911 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3912 {
3913 hs_buf = &hs->buffering.hs[offset];
3914 if( hs_buf->is_valid == 1 )
3915 {
3916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3917 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003918 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003919 }
3920 }
3921 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003922#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003923
3924 /* Check if we have buffered and/or fully reassembled the
3925 * next handshake message. */
3926 hs_buf = &hs->buffering.hs[0];
3927 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3928 {
3929 /* Synthesize a record containing the buffered HS message. */
3930 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3931 ( hs_buf->data[2] << 8 ) |
3932 hs_buf->data[3];
3933
3934 /* Double-check that we haven't accidentally buffered
3935 * a message that doesn't fit into the input buffer. */
3936 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3937 {
3938 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3939 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3940 }
3941
3942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3943 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3944 hs_buf->data, msg_len + 12 );
3945
3946 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3947 ssl->in_hslen = msg_len + 12;
3948 ssl->in_msglen = msg_len + 12;
3949 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3950
3951 ret = 0;
3952 goto exit;
3953 }
3954 else
3955 {
3956 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3957 hs->in_msg_seq ) );
3958 }
3959
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003960 ret = -1;
3961
3962exit:
3963
3964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3965 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003966}
3967
Hanno Beckera02b0b42018-08-21 17:20:27 +01003968static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3969 size_t desired )
3970{
3971 int offset;
3972 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3974 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003975
Hanno Becker01315ea2018-08-21 17:22:17 +01003976 /* Get rid of future records epoch first, if such exist. */
3977 ssl_free_buffered_record( ssl );
3978
3979 /* Check if we have enough space available now. */
3980 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3981 hs->buffering.total_bytes_buffered ) )
3982 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003984 return( 0 );
3985 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003986
Hanno Becker4f432ad2018-08-28 10:02:32 +01003987 /* We don't have enough space to buffer the next expected handshake
3988 * message. Remove buffers used for future messages to gain space,
3989 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003990 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3991 offset >= 0; offset-- )
3992 {
3993 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3994 offset ) );
3995
Hanno Beckerb309b922018-08-23 13:18:05 +01003996 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003997
3998 /* Check if we have enough space available now. */
3999 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4000 hs->buffering.total_bytes_buffered ) )
4001 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004002 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004003 return( 0 );
4004 }
4005 }
4006
4007 return( -1 );
4008}
4009
Hanno Becker40f50842018-08-15 14:48:01 +01004010static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4011{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004012 int ret = 0;
4013 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4014
4015 if( hs == NULL )
4016 return( 0 );
4017
4018 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4019
4020 switch( ssl->in_msgtype )
4021 {
4022 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004024
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004025 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004026 break;
4027
4028 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004029 {
4030 unsigned recv_msg_seq_offset;
4031 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4032 mbedtls_ssl_hs_buffer *hs_buf;
4033 size_t msg_len = ssl->in_hslen - 12;
4034
4035 /* We should never receive an old handshake
4036 * message - double-check nonetheless. */
4037 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4038 {
4039 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4040 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4041 }
4042
4043 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4044 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4045 {
4046 /* Silently ignore -- message too far in the future */
4047 MBEDTLS_SSL_DEBUG_MSG( 2,
4048 ( "Ignore future HS message with sequence number %u, "
4049 "buffering window %u - %u",
4050 recv_msg_seq, ssl->handshake->in_msg_seq,
4051 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4052
4053 goto exit;
4054 }
4055
4056 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4057 recv_msg_seq, recv_msg_seq_offset ) );
4058
4059 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4060
4061 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004062 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004063 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004064 size_t reassembly_buf_sz;
4065
Hanno Becker37f95322018-08-16 13:55:32 +01004066 hs_buf->is_fragmented =
4067 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4068
4069 /* We copy the message back into the input buffer
4070 * after reassembly, so check that it's not too large.
4071 * This is an implementation-specific limitation
4072 * and not one from the standard, hence it is not
4073 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004074 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004075 {
4076 /* Ignore message */
4077 goto exit;
4078 }
4079
Hanno Beckere0b150f2018-08-21 15:51:03 +01004080 /* Check if we have enough space to buffer the message. */
4081 if( hs->buffering.total_bytes_buffered >
4082 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4083 {
4084 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4085 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4086 }
4087
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004088 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4089 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004090
4091 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4092 hs->buffering.total_bytes_buffered ) )
4093 {
4094 if( recv_msg_seq_offset > 0 )
4095 {
4096 /* If we can't buffer a future message because
4097 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4099 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4100 " (already %" MBEDTLS_PRINTF_SIZET
4101 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004102 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004103 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004104 goto exit;
4105 }
Hanno Beckere1801392018-08-21 16:51:05 +01004106 else
4107 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004108 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4109 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4110 " (already %" MBEDTLS_PRINTF_SIZET
4111 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004112 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004113 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004114 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004115
Hanno Beckera02b0b42018-08-21 17:20:27 +01004116 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004117 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4119 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4120 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4121 " (already %" MBEDTLS_PRINTF_SIZET
4122 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004123 msg_len,
4124 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004125 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004126 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004127 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4128 goto exit;
4129 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004130 }
4131
Paul Elliottd48d5c62021-01-07 14:47:05 +00004132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004133 msg_len ) );
4134
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004135 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4136 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004137 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004138 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004139 goto exit;
4140 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004141 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004142
4143 /* Prepare final header: copy msg_type, length and message_seq,
4144 * then add standardised fragment_offset and fragment_length */
4145 memcpy( hs_buf->data, ssl->in_msg, 6 );
4146 memset( hs_buf->data + 6, 0, 3 );
4147 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4148
4149 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004150
4151 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004152 }
4153 else
4154 {
4155 /* Make sure msg_type and length are consistent */
4156 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4157 {
4158 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4159 /* Ignore */
4160 goto exit;
4161 }
4162 }
4163
Hanno Becker4422bbb2018-08-20 09:40:19 +01004164 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004165 {
4166 size_t frag_len, frag_off;
4167 unsigned char * const msg = hs_buf->data + 12;
4168
4169 /*
4170 * Check and copy current fragment
4171 */
4172
4173 /* Validation of header fields already done in
4174 * mbedtls_ssl_prepare_handshake_record(). */
4175 frag_off = ssl_get_hs_frag_off( ssl );
4176 frag_len = ssl_get_hs_frag_len( ssl );
4177
Paul Elliottd48d5c62021-01-07 14:47:05 +00004178 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4179 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004180 frag_off, frag_len ) );
4181 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4182
4183 if( hs_buf->is_fragmented )
4184 {
4185 unsigned char * const bitmask = msg + msg_len;
4186 ssl_bitmask_set( bitmask, frag_off, frag_len );
4187 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4188 msg_len ) == 0 );
4189 }
4190 else
4191 {
4192 hs_buf->is_complete = 1;
4193 }
4194
4195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4196 hs_buf->is_complete ? "" : "not yet " ) );
4197 }
4198
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004199 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004200 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004201
4202 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004203 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004204 break;
4205 }
4206
4207exit:
4208
4209 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4210 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004211}
4212#endif /* MBEDTLS_SSL_PROTO_DTLS */
4213
Hanno Becker1097b342018-08-15 14:09:41 +01004214static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004215{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004216 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004217 * Consume last content-layer message and potentially
4218 * update in_msglen which keeps track of the contents'
4219 * consumption state.
4220 *
4221 * (1) Handshake messages:
4222 * Remove last handshake message, move content
4223 * and adapt in_msglen.
4224 *
4225 * (2) Alert messages:
4226 * Consume whole record content, in_msglen = 0.
4227 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004228 * (3) Change cipher spec:
4229 * Consume whole record content, in_msglen = 0.
4230 *
4231 * (4) Application data:
4232 * Don't do anything - the record layer provides
4233 * the application data as a stream transport
4234 * and consumes through mbedtls_ssl_read only.
4235 *
4236 */
4237
4238 /* Case (1): Handshake messages */
4239 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004240 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004241 /* Hard assertion to be sure that no application data
4242 * is in flight, as corrupting ssl->in_msglen during
4243 * ssl->in_offt != NULL is fatal. */
4244 if( ssl->in_offt != NULL )
4245 {
4246 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4247 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4248 }
4249
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004250 /*
4251 * Get next Handshake message in the current record
4252 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004253
Hanno Becker4a810fb2017-05-24 16:27:30 +01004254 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004255 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004256 * current handshake content: If DTLS handshake
4257 * fragmentation is used, that's the fragment
4258 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004259 * size here is faulty and should be changed at
4260 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004261 * (2) While it doesn't seem to cause problems, one
4262 * has to be very careful not to assume that in_hslen
4263 * is always <= in_msglen in a sensible communication.
4264 * Again, it's wrong for DTLS handshake fragmentation.
4265 * The following check is therefore mandatory, and
4266 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004267 * Additionally, ssl->in_hslen might be arbitrarily out of
4268 * bounds after handling a DTLS message with an unexpected
4269 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004270 */
4271 if( ssl->in_hslen < ssl->in_msglen )
4272 {
4273 ssl->in_msglen -= ssl->in_hslen;
4274 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4275 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004276
Hanno Becker4a810fb2017-05-24 16:27:30 +01004277 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4278 ssl->in_msg, ssl->in_msglen );
4279 }
4280 else
4281 {
4282 ssl->in_msglen = 0;
4283 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004284
Hanno Becker4a810fb2017-05-24 16:27:30 +01004285 ssl->in_hslen = 0;
4286 }
4287 /* Case (4): Application data */
4288 else if( ssl->in_offt != NULL )
4289 {
4290 return( 0 );
4291 }
4292 /* Everything else (CCS & Alerts) */
4293 else
4294 {
4295 ssl->in_msglen = 0;
4296 }
4297
Hanno Becker1097b342018-08-15 14:09:41 +01004298 return( 0 );
4299}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004300
Hanno Beckere74d5562018-08-15 14:26:08 +01004301static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4302{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004303 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004304 return( 1 );
4305
4306 return( 0 );
4307}
4308
Hanno Becker5f066e72018-08-16 14:56:31 +01004309#if defined(MBEDTLS_SSL_PROTO_DTLS)
4310
4311static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4312{
4313 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4314 if( hs == NULL )
4315 return;
4316
Hanno Becker01315ea2018-08-21 17:22:17 +01004317 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004318 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004319 hs->buffering.total_bytes_buffered -=
4320 hs->buffering.future_record.len;
4321
4322 mbedtls_free( hs->buffering.future_record.data );
4323 hs->buffering.future_record.data = NULL;
4324 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004325}
4326
4327static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4328{
4329 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4330 unsigned char * rec;
4331 size_t rec_len;
4332 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004333#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4334 size_t in_buf_len = ssl->in_buf_len;
4335#else
4336 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4337#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004338 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4339 return( 0 );
4340
4341 if( hs == NULL )
4342 return( 0 );
4343
Hanno Becker5f066e72018-08-16 14:56:31 +01004344 rec = hs->buffering.future_record.data;
4345 rec_len = hs->buffering.future_record.len;
4346 rec_epoch = hs->buffering.future_record.epoch;
4347
4348 if( rec == NULL )
4349 return( 0 );
4350
Hanno Becker4cb782d2018-08-20 11:19:05 +01004351 /* Only consider loading future records if the
4352 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004353 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004354 return( 0 );
4355
Hanno Becker5f066e72018-08-16 14:56:31 +01004356 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4357
4358 if( rec_epoch != ssl->in_epoch )
4359 {
4360 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4361 goto exit;
4362 }
4363
4364 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4365
4366 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004367 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004368 {
4369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4370 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4371 }
4372
4373 memcpy( ssl->in_hdr, rec, rec_len );
4374 ssl->in_left = rec_len;
4375 ssl->next_record_offset = 0;
4376
4377 ssl_free_buffered_record( ssl );
4378
4379exit:
4380 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4381 return( 0 );
4382}
4383
Hanno Becker519f15d2019-07-11 12:43:20 +01004384static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4385 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004386{
4387 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004388
4389 /* Don't buffer future records outside handshakes. */
4390 if( hs == NULL )
4391 return( 0 );
4392
4393 /* Only buffer handshake records (we are only interested
4394 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004395 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004396 return( 0 );
4397
4398 /* Don't buffer more than one future epoch record. */
4399 if( hs->buffering.future_record.data != NULL )
4400 return( 0 );
4401
Hanno Becker01315ea2018-08-21 17:22:17 +01004402 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004403 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004404 hs->buffering.total_bytes_buffered ) )
4405 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004406 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4407 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4408 " (already %" MBEDTLS_PRINTF_SIZET
4409 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004410 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004411 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004412 return( 0 );
4413 }
4414
Hanno Becker5f066e72018-08-16 14:56:31 +01004415 /* Buffer record */
4416 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004417 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004418 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004419
4420 /* ssl_parse_record_header() only considers records
4421 * of the next epoch as candidates for buffering. */
4422 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004423 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004424
4425 hs->buffering.future_record.data =
4426 mbedtls_calloc( 1, hs->buffering.future_record.len );
4427 if( hs->buffering.future_record.data == NULL )
4428 {
4429 /* If we run out of RAM trying to buffer a
4430 * record from the next epoch, just ignore. */
4431 return( 0 );
4432 }
4433
Hanno Becker519f15d2019-07-11 12:43:20 +01004434 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004435
Hanno Becker519f15d2019-07-11 12:43:20 +01004436 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004437 return( 0 );
4438}
4439
4440#endif /* MBEDTLS_SSL_PROTO_DTLS */
4441
Hanno Beckere74d5562018-08-15 14:26:08 +01004442static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004443{
Janos Follath865b3eb2019-12-16 11:46:15 +00004444 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004445 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004446
Hanno Becker5f066e72018-08-16 14:56:31 +01004447#if defined(MBEDTLS_SSL_PROTO_DTLS)
4448 /* We might have buffered a future record; if so,
4449 * and if the epoch matches now, load it.
4450 * On success, this call will set ssl->in_left to
4451 * the length of the buffered record, so that
4452 * the calls to ssl_fetch_input() below will
4453 * essentially be no-ops. */
4454 ret = ssl_load_buffered_record( ssl );
4455 if( ret != 0 )
4456 return( ret );
4457#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004458
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004459 /* Ensure that we have enough space available for the default form
4460 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4461 * with no space for CIDs counted in). */
4462 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4463 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004464 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004465 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004466 return( ret );
4467 }
4468
Hanno Beckere5e7e782019-07-11 12:29:35 +01004469 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4470 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004471 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004472#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004473 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004474 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004475 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4476 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004477 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004478 if( ret != 0 )
4479 return( ret );
4480
4481 /* Fall through to handling of unexpected records */
4482 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4483 }
4484
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004485 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4486 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004487#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004488 /* Reset in pointers to default state for TLS/DTLS records,
4489 * assuming no CID and no offset between record content and
4490 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004491 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004492
Hanno Becker7ae20e02019-07-12 08:33:49 +01004493 /* Setup internal message pointers from record structure. */
4494 ssl->in_msgtype = rec.type;
4495#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4496 ssl->in_len = ssl->in_cid + rec.cid_len;
4497#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4498 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4499 ssl->in_msglen = rec.data_len;
4500
Hanno Becker2fddd372019-07-10 14:37:41 +01004501 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004502 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004503 if( ret != 0 )
4504 return( ret );
4505#endif
4506
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004507 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004508 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004509
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4511 "(header)" ) );
4512 }
4513 else
4514 {
4515 /* Skip invalid record and the rest of the datagram */
4516 ssl->next_record_offset = 0;
4517 ssl->in_left = 0;
4518
4519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4520 "(header)" ) );
4521 }
4522
4523 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004524 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004525 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004526 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004527#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004528 {
4529 return( ret );
4530 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004531 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004534 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004535 {
Hanno Beckera8814792019-07-10 15:01:45 +01004536 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004537 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004538 if( ssl->next_record_offset < ssl->in_left )
4539 {
4540 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4541 }
4542 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004543 else
4544#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004545 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004546 /*
4547 * Fetch record contents from underlying transport.
4548 */
Hanno Beckera3175662019-07-11 12:50:29 +01004549 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004550 if( ret != 0 )
4551 {
4552 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4553 return( ret );
4554 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004555
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004556 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004557 }
4558
4559 /*
4560 * Decrypt record contents.
4561 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004562
Hanno Beckerfdf66042019-07-11 13:07:45 +01004563 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004564 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004566 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004567 {
4568 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004569 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004570 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004571 /* Except when waiting for Finished as a bad mac here
4572 * probably means something went wrong in the handshake
4573 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4574 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4575 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4576 {
4577#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4578 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4579 {
4580 mbedtls_ssl_send_alert_message( ssl,
4581 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4582 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4583 }
4584#endif
4585 return( ret );
4586 }
4587
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004588 if( ssl->conf->badmac_limit != 0 &&
4589 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004590 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4592 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004593 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004594
Hanno Becker4a810fb2017-05-24 16:27:30 +01004595 /* As above, invalid records cause
4596 * dismissal of the whole datagram. */
4597
4598 ssl->next_record_offset = 0;
4599 ssl->in_left = 0;
4600
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004602 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004603 }
4604
4605 return( ret );
4606 }
4607 else
4608#endif
4609 {
4610 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004611#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4612 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004614 mbedtls_ssl_send_alert_message( ssl,
4615 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4616 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004617 }
4618#endif
4619 return( ret );
4620 }
4621 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004622
Hanno Becker44d89b22019-07-12 09:40:44 +01004623
4624 /* Reset in pointers to default state for TLS/DTLS records,
4625 * assuming no CID and no offset between record content and
4626 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004627 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004628#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4629 ssl->in_len = ssl->in_cid + rec.cid_len;
4630#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004631 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004632
Hanno Becker8685c822019-07-12 09:37:30 +01004633 /* The record content type may change during decryption,
4634 * so re-read it. */
4635 ssl->in_msgtype = rec.type;
4636 /* Also update the input buffer, because unfortunately
4637 * the server-side ssl_parse_client_hello() reparses the
4638 * record header when receiving a ClientHello initiating
4639 * a renegotiation. */
4640 ssl->in_hdr[0] = rec.type;
4641 ssl->in_msg = rec.buf + rec.data_offset;
4642 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004643 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004644
Simon Butcher99000142016-10-13 17:21:01 +01004645 return( 0 );
4646}
4647
4648int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4649{
Janos Follath865b3eb2019-12-16 11:46:15 +00004650 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004651
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004652 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004653 * Handle particular types of records
4654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004655 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004656 {
Simon Butcher99000142016-10-13 17:21:01 +01004657 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4658 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004659 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004660 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004661 }
4662
Hanno Beckere678eaa2018-08-21 14:57:46 +01004663 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004664 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004665 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004666 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004667 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004668 ssl->in_msglen ) );
4669 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004670 }
4671
Hanno Beckere678eaa2018-08-21 14:57:46 +01004672 if( ssl->in_msg[0] != 1 )
4673 {
4674 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4675 ssl->in_msg[0] ) );
4676 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4677 }
4678
4679#if defined(MBEDTLS_SSL_PROTO_DTLS)
4680 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4681 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4682 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4683 {
4684 if( ssl->handshake == NULL )
4685 {
4686 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4687 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4688 }
4689
4690 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4691 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4692 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004693#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004694
Ronald Cron6f135e12021-12-08 16:57:54 +01004695#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004696 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4697 {
4698#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4699 MBEDTLS_SSL_DEBUG_MSG( 1,
4700 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4701 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4702#else
4703 MBEDTLS_SSL_DEBUG_MSG( 1,
4704 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4705 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4706#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4707 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004708#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004709 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004711 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004712 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004713 if( ssl->in_msglen != 2 )
4714 {
4715 /* Note: Standard allows for more than one 2 byte alert
4716 to be packed in a single message, but Mbed TLS doesn't
4717 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004719 ssl->in_msglen ) );
4720 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4721 }
4722
Paul Elliott9f352112020-12-09 14:55:45 +00004723 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004724 ssl->in_msg[0], ssl->in_msg[1] ) );
4725
4726 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004727 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004732 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004734 }
4735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4737 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004738 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4740 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004741 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004742
4743#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4744 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4745 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4746 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004747 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004748 /* Will be handled when trying to parse ServerHello */
4749 return( 0 );
4750 }
4751#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004752 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004753 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004754 }
4755
Hanno Beckerc76c6192017-06-06 10:03:17 +01004756#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004757 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004758 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004759 /* Drop unexpected ApplicationData records,
4760 * except at the beginning of renegotiations */
4761 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4762 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4763#if defined(MBEDTLS_SSL_RENEGOTIATION)
4764 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4765 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004766#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004767 )
4768 {
4769 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4770 return( MBEDTLS_ERR_SSL_NON_FATAL );
4771 }
4772
4773 if( ssl->handshake != NULL &&
4774 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4775 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004776 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004777 }
4778 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004779#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004780
Paul Bakker5121ce52009-01-03 21:22:43 +00004781 return( 0 );
4782}
4783
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004785{
irwir6c0da642019-09-26 21:07:41 +03004786 return( mbedtls_ssl_send_alert_message( ssl,
4787 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4788 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004789}
4790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004791int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004792 unsigned char level,
4793 unsigned char message )
4794{
Janos Follath865b3eb2019-12-16 11:46:15 +00004795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004796
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004797 if( ssl == NULL || ssl->conf == NULL )
4798 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4799
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004801 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004804 ssl->out_msglen = 2;
4805 ssl->out_msg[0] = level;
4806 ssl->out_msg[1] = message;
4807
Hanno Becker67bc7c32018-08-06 11:33:50 +01004808 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004809 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004810 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004811 return( ret );
4812 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004814
4815 return( 0 );
4816}
4817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004819{
Janos Follath865b3eb2019-12-16 11:46:15 +00004820 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004821
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004822 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004823
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004824 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004825 ssl->out_msglen = 1;
4826 ssl->out_msg[0] = 1;
4827
Paul Bakker5121ce52009-01-03 21:22:43 +00004828 ssl->state++;
4829
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004830 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004831 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004832 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004833 return( ret );
4834 }
4835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004837
4838 return( 0 );
4839}
4840
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004841int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004842{
Janos Follath865b3eb2019-12-16 11:46:15 +00004843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004846
Hanno Becker327c93b2018-08-15 13:56:18 +01004847 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004848 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004849 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004850 return( ret );
4851 }
4852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004853 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004854 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004855 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004856 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4857 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004858 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004859 }
4860
Hanno Beckere678eaa2018-08-21 14:57:46 +01004861 /* CCS records are only accepted if they have length 1 and content '1',
4862 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004863
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004864 /*
4865 * Switch to our negotiated transform and session parameters for inbound
4866 * data.
4867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004868 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004869 ssl->transform_in = ssl->transform_negotiate;
4870 ssl->session_in = ssl->session_negotiate;
4871
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004872#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004873 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004874 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004875#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004876 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004877#endif
4878
4879 /* Increment epoch */
4880 if( ++ssl->in_epoch == 0 )
4881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004883 /* This is highly unlikely to happen for legitimate reasons, so
4884 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004885 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004886 }
4887 }
4888 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004889#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004890 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004891
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004892 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004893
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 ssl->state++;
4895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004897
4898 return( 0 );
4899}
4900
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004901/* Once ssl->out_hdr as the address of the beginning of the
4902 * next outgoing record is set, deduce the other pointers.
4903 *
4904 * Note: For TLS, we save the implicit record sequence number
4905 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4906 * and the caller has to make sure there's space for this.
4907 */
4908
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004909static size_t ssl_transform_get_explicit_iv_len(
4910 mbedtls_ssl_transform const *transform )
4911{
TRodziewiczef73f012021-05-13 14:53:36 +02004912 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004913 return( 0 );
4914
4915 return( transform->ivlen - transform->fixed_ivlen );
4916}
4917
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004918void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4919 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004920{
4921#if defined(MBEDTLS_SSL_PROTO_DTLS)
4922 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4923 {
4924 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004925#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004926 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004927 ssl->out_len = ssl->out_cid;
4928 if( transform != NULL )
4929 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004930#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004931 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004932#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004933 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004934 }
4935 else
4936#endif
4937 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004938 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004939#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004940 ssl->out_cid = ssl->out_len;
4941#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004942 ssl->out_iv = ssl->out_hdr + 5;
4943 }
4944
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004945 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004946 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004947 if( transform != NULL )
4948 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004949}
4950
4951/* Once ssl->in_hdr as the address of the beginning of the
4952 * next incoming record is set, deduce the other pointers.
4953 *
4954 * Note: For TLS, we save the implicit record sequence number
4955 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4956 * and the caller has to make sure there's space for this.
4957 */
4958
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004959void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004960{
Hanno Becker79594fd2019-05-08 09:38:41 +01004961 /* This function sets the pointers to match the case
4962 * of unprotected TLS/DTLS records, with both ssl->in_iv
4963 * and ssl->in_msg pointing to the beginning of the record
4964 * content.
4965 *
4966 * When decrypting a protected record, ssl->in_msg
4967 * will be shifted to point to the beginning of the
4968 * record plaintext.
4969 */
4970
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004971#if defined(MBEDTLS_SSL_PROTO_DTLS)
4972 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4973 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004974 /* This sets the header pointers to match records
4975 * without CID. When we receive a record containing
4976 * a CID, the fields are shifted accordingly in
4977 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004978 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004979#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004980 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004981 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004982#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004983 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004984#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004985 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004986 }
4987 else
4988#endif
4989 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004990 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004991 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004992#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004993 ssl->in_cid = ssl->in_len;
4994#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004995 ssl->in_iv = ssl->in_hdr + 5;
4996 }
4997
Hanno Becker79594fd2019-05-08 09:38:41 +01004998 /* This will be adjusted at record decryption time. */
4999 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005000}
5001
Paul Bakker5121ce52009-01-03 21:22:43 +00005002/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005003 * Setup an SSL context
5004 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005005
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005006void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005007{
5008 /* Set the incoming and outgoing record pointers. */
5009#if defined(MBEDTLS_SSL_PROTO_DTLS)
5010 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5011 {
5012 ssl->out_hdr = ssl->out_buf;
5013 ssl->in_hdr = ssl->in_buf;
5014 }
5015 else
5016#endif /* MBEDTLS_SSL_PROTO_DTLS */
5017 {
Hanno Becker12078f42021-03-02 15:28:41 +00005018 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005019 ssl->out_hdr = ssl->out_buf + 8;
5020 ssl->in_hdr = ssl->in_buf + 8;
5021 }
5022
5023 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005024 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5025 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005026}
5027
Paul Bakker5121ce52009-01-03 21:22:43 +00005028/*
5029 * SSL get accessors
5030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005031size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005032{
5033 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5034}
5035
Hanno Becker8b170a02017-10-10 11:51:19 +01005036int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5037{
5038 /*
5039 * Case A: We're currently holding back
5040 * a message for further processing.
5041 */
5042
5043 if( ssl->keep_current_message == 1 )
5044 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005045 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005046 return( 1 );
5047 }
5048
5049 /*
5050 * Case B: Further records are pending in the current datagram.
5051 */
5052
5053#if defined(MBEDTLS_SSL_PROTO_DTLS)
5054 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5055 ssl->in_left > ssl->next_record_offset )
5056 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005057 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005058 return( 1 );
5059 }
5060#endif /* MBEDTLS_SSL_PROTO_DTLS */
5061
5062 /*
5063 * Case C: A handshake message is being processed.
5064 */
5065
Hanno Becker8b170a02017-10-10 11:51:19 +01005066 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5067 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005068 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005069 return( 1 );
5070 }
5071
5072 /*
5073 * Case D: An application data message is being processed
5074 */
5075 if( ssl->in_offt != NULL )
5076 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005077 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005078 return( 1 );
5079 }
5080
5081 /*
5082 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005083 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005084 * we implement support for multiple alerts in single records.
5085 */
5086
5087 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5088 return( 0 );
5089}
5090
Paul Bakker43ca69c2011-01-15 17:35:19 +00005091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005092int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005093{
Hanno Becker3136ede2018-08-17 15:28:19 +01005094 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005096 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005097#if defined(MBEDTLS_USE_PSA_CRYPTO)
5098 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5099 psa_key_type_t key_type;
5100#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005101
Hanno Becker5903de42019-05-03 14:46:38 +01005102 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5103
Hanno Becker78640902018-08-13 16:35:15 +01005104 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005105 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005106
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005107
5108#if defined(MBEDTLS_USE_PSA_CRYPTO)
5109 switch( transform->psa_alg )
5110 {
5111 case PSA_ALG_GCM:
5112 case PSA_ALG_CHACHA20_POLY1305:
5113 case MBEDTLS_SSL_NULL_CIPHER:
5114 transform_expansion = transform->minlen;
5115 break;
5116
5117 case PSA_ALG_CBC_NO_PADDING:
5118 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5119 key_type = psa_get_key_type( &attr );
5120
5121 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
5122
5123 /* Expansion due to the addition of the MAC. */
5124 transform_expansion += transform->maclen;
5125
5126 /* Expansion due to the addition of CBC padding;
5127 * Theoretically up to 256 bytes, but we never use
5128 * more than the block size of the underlying cipher. */
5129 transform_expansion += block_size;
5130
5131 /* For TLS 1.2 or higher, an explicit IV is added
5132 * after the record header. */
5133#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5134 transform_expansion += block_size;
5135#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5136 break;
5137
5138 default:
5139 /* Handle CCM case in default:
5140 PSA_ALG_IS_AEAD( transform->psa_alg ) corresponds to
5141 psa_alg == PSA_ALG_CCM || psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 )
5142 in tls context (TLS only uses the default taglen or 8) */
5143 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
5144 {
5145 transform_expansion = transform->minlen;
5146 break;
5147 }
5148
5149 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5150 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5151 }
5152#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005153 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005154 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005155 case MBEDTLS_MODE_GCM:
5156 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005157 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005158 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005159 transform_expansion = transform->minlen;
5160 break;
5161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005162 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005163
5164 block_size = mbedtls_cipher_get_block_size(
5165 &transform->cipher_ctx_enc );
5166
Hanno Becker3136ede2018-08-17 15:28:19 +01005167 /* Expansion due to the addition of the MAC. */
5168 transform_expansion += transform->maclen;
5169
5170 /* Expansion due to the addition of CBC padding;
5171 * Theoretically up to 256 bytes, but we never use
5172 * more than the block size of the underlying cipher. */
5173 transform_expansion += block_size;
5174
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005175 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005176 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005177#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005178 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005179#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005180
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005181 break;
5182
5183 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005184 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005185 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005186 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005187#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005188
Hanno Beckera0e20d02019-05-15 14:03:01 +01005189#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005190 if( transform->out_cid_len != 0 )
5191 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005192#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005193
Hanno Becker5903de42019-05-03 14:46:38 +01005194 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005195}
5196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005197#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005198/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005199 * Check record counters and renegotiate if they're above the limit.
5200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005201static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005202{
Hanno Beckerdd772292020-02-05 10:38:31 +00005203 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005204 int in_ctr_cmp;
5205 int out_ctr_cmp;
5206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005207 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5208 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005209 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005210 {
5211 return( 0 );
5212 }
5213
Andres AG2196c7f2016-12-15 17:01:16 +00005214 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005215 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005216 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005217 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5218 &ssl->conf->renego_period[ep_len],
5219 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005220
5221 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005222 {
5223 return( 0 );
5224 }
5225
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005226 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005227 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005228}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005229#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005230
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005231/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005232 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005233 * may only be sent for the purpose of initiating renegotiations.
5234 *
5235 * This function is introduced as a separate helper since the handling
5236 * of post-handshake handshake messages changes significantly in TLS 1.3,
5237 * and having a helper function allows to distinguish between TLS <= 1.2 and
5238 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5239 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005240static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005241{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005243
5244 /*
5245 * - For client-side, expect SERVER_HELLO_REQUEST.
5246 * - For server-side, expect CLIENT_HELLO.
5247 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5248 */
5249
5250#if defined(MBEDTLS_SSL_CLI_C)
5251 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5252 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5253 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5254 {
5255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5256
5257 /* With DTLS, drop the packet (probably from last handshake) */
5258#if defined(MBEDTLS_SSL_PROTO_DTLS)
5259 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5260 {
5261 return( 0 );
5262 }
5263#endif
5264 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5265 }
5266#endif /* MBEDTLS_SSL_CLI_C */
5267
5268#if defined(MBEDTLS_SSL_SRV_C)
5269 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5270 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5271 {
5272 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5273
5274 /* With DTLS, drop the packet (probably from last handshake) */
5275#if defined(MBEDTLS_SSL_PROTO_DTLS)
5276 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5277 {
5278 return( 0 );
5279 }
5280#endif
5281 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5282 }
5283#endif /* MBEDTLS_SSL_SRV_C */
5284
5285#if defined(MBEDTLS_SSL_RENEGOTIATION)
5286 /* Determine whether renegotiation attempt should be accepted */
5287 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5288 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5289 ssl->conf->allow_legacy_renegotiation ==
5290 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5291 {
5292 /*
5293 * Accept renegotiation request
5294 */
5295
5296 /* DTLS clients need to know renego is server-initiated */
5297#if defined(MBEDTLS_SSL_PROTO_DTLS)
5298 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5299 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5300 {
5301 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5302 }
5303#endif
5304 ret = mbedtls_ssl_start_renegotiation( ssl );
5305 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5306 ret != 0 )
5307 {
5308 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5309 ret );
5310 return( ret );
5311 }
5312 }
5313 else
5314#endif /* MBEDTLS_SSL_RENEGOTIATION */
5315 {
5316 /*
5317 * Refuse renegotiation
5318 */
5319
5320 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5321
TRodziewicz0f82ec62021-05-12 17:49:18 +02005322#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005323 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5324 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5325 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005326 {
TRodziewicz345165c2021-07-06 13:42:11 +02005327 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005328 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005329#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005330 }
5331
5332 return( 0 );
5333}
5334
Paul Bakker48916f92012-09-16 19:57:18 +00005335/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005336 * Receive application data decrypted from the SSL layer
5337 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005338int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005339{
Janos Follath865b3eb2019-12-16 11:46:15 +00005340 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005341 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005342
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005343 if( ssl == NULL || ssl->conf == NULL )
5344 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005348#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005349 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005350 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005351 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005352 return( ret );
5353
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005354 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005355 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005356 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005357 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005358 return( ret );
5359 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005360 }
5361#endif
5362
Hanno Becker4a810fb2017-05-24 16:27:30 +01005363 /*
5364 * Check if renegotiation is necessary and/or handshake is
5365 * in process. If yes, perform/continue, and fall through
5366 * if an unexpected packet is received while the client
5367 * is waiting for the ServerHello.
5368 *
5369 * (There is no equivalent to the last condition on
5370 * the server-side as it is not treated as within
5371 * a handshake while waiting for the ClientHello
5372 * after a renegotiation request.)
5373 */
5374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005375#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005376 ret = ssl_check_ctr_renegotiate( ssl );
5377 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5378 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005379 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005380 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005381 return( ret );
5382 }
5383#endif
5384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005385 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005386 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005387 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005388 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5389 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005390 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005392 return( ret );
5393 }
5394 }
5395
Hanno Beckere41158b2017-10-23 13:30:32 +01005396 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005397 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005398 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005399 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005400 if( ssl->f_get_timer != NULL &&
5401 ssl->f_get_timer( ssl->p_timer ) == -1 )
5402 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005403 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005404 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005405
Hanno Becker327c93b2018-08-15 13:56:18 +01005406 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005407 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005408 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5409 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005410
Hanno Becker4a810fb2017-05-24 16:27:30 +01005411 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5412 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005413 }
5414
5415 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005417 {
5418 /*
5419 * OpenSSL sends empty messages to randomize the IV
5420 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005421 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005422 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005424 return( 0 );
5425
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005426 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005427 return( ret );
5428 }
5429 }
5430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005432 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005433 ret = ssl_handle_hs_message_post_handshake( ssl );
5434 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005435 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005436 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5437 ret );
5438 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005439 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005440
Hanno Beckerf26cc722021-04-21 07:30:13 +01005441 /* At this point, we don't know whether the renegotiation triggered
5442 * by the post-handshake message has been completed or not. The cases
5443 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005444 * 1) The renegotiation is complete. In this case, no new record
5445 * has been read yet.
5446 * 2) The renegotiation is incomplete because the client received
5447 * an application data record while awaiting the ServerHello.
5448 * 3) The renegotiation is incomplete because the client received
5449 * a non-handshake, non-application data message while awaiting
5450 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005451 *
5452 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005453 * - For 1), the next iteration will read a new record and check
5454 * if it's application data.
5455 * - For 2), the loop condition isn't satisfied as application data
5456 * is present, hence continue is the same as break
5457 * - For 3), the loop condition is satisfied and read_record
5458 * will re-deliver the message that was held back by the client
5459 * when expecting the ServerHello.
5460 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005461
Hanno Becker90333da2017-10-10 11:27:13 +01005462 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005463 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005464#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005466 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005467 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005468 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005469 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005470 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005472 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005474 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005475 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005476 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5480 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005481 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005482 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005483 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005484 }
5485
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005486 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005487 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5489 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005490 }
5491
5492 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005493
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005494 /* We're going to return something now, cancel timer,
5495 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005497 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005498
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005499#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005500 /* If we requested renego but received AppData, resend HelloRequest.
5501 * Do it now, after setting in_offt, to avoid taking this branch
5502 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005503#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005504 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005505 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005506 {
Hanno Becker786300f2020-02-05 10:46:40 +00005507 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005508 {
Hanno Becker786300f2020-02-05 10:46:40 +00005509 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5510 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005511 return( ret );
5512 }
5513 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005514#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005515#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005516 }
5517
5518 n = ( len < ssl->in_msglen )
5519 ? len : ssl->in_msglen;
5520
5521 memcpy( buf, ssl->in_offt, n );
5522 ssl->in_msglen -= n;
5523
gabor-mezei-arma3214132020-07-15 10:55:00 +02005524 /* Zeroising the plaintext buffer to erase unused application data
5525 from the memory. */
5526 mbedtls_platform_zeroize( ssl->in_offt, n );
5527
Paul Bakker5121ce52009-01-03 21:22:43 +00005528 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005529 {
5530 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005531 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005532 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005533 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005534 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005535 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005536 /* more data available */
5537 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005538 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005541
Paul Bakker23986e52011-04-24 08:57:21 +00005542 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005543}
5544
5545/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005546 * Send application data to be encrypted by the SSL layer, taking care of max
5547 * fragment length and buffer size.
5548 *
5549 * According to RFC 5246 Section 6.2.1:
5550 *
5551 * Zero-length fragments of Application data MAY be sent as they are
5552 * potentially useful as a traffic analysis countermeasure.
5553 *
5554 * Therefore, it is possible that the input message length is 0 and the
5555 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005556 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005557static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005558 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005559{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005560 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5561 const size_t max_len = (size_t) ret;
5562
5563 if( ret < 0 )
5564 {
5565 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5566 return( ret );
5567 }
5568
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005569 if( len > max_len )
5570 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005571#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005572 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005573 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005574 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005575 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5576 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005577 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005578 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005579 }
5580 else
5581#endif
5582 len = max_len;
5583 }
Paul Bakker887bd502011-06-08 13:10:54 +00005584
Paul Bakker5121ce52009-01-03 21:22:43 +00005585 if( ssl->out_left != 0 )
5586 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005587 /*
5588 * The user has previously tried to send the data and
5589 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5590 * written. In this case, we expect the high-level write function
5591 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005593 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005594 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005595 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005596 return( ret );
5597 }
5598 }
Paul Bakker887bd502011-06-08 13:10:54 +00005599 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005600 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005601 /*
5602 * The user is trying to send a message the first time, so we need to
5603 * copy the data into the internal buffers and setup the data structure
5604 * to keep track of partial writes
5605 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005606 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005607 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005608 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005609
Hanno Becker67bc7c32018-08-06 11:33:50 +01005610 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005611 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005612 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005613 return( ret );
5614 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005615 }
5616
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005617 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005618}
5619
5620/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005621 * Write application data (public-facing wrapper)
5622 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005623int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005624{
Janos Follath865b3eb2019-12-16 11:46:15 +00005625 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005626
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005628
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005629 if( ssl == NULL || ssl->conf == NULL )
5630 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5631
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005632#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005633 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5634 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005635 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005636 return( ret );
5637 }
5638#endif
5639
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005640 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005641 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005642 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005643 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005644 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005645 return( ret );
5646 }
5647 }
5648
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005649 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005650
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005652
5653 return( ret );
5654}
5655
5656/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005657 * Notify the peer that the connection is being closed
5658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005659int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005660{
Janos Follath865b3eb2019-12-16 11:46:15 +00005661 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005662
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005663 if( ssl == NULL || ssl->conf == NULL )
5664 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005666 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005667
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005668 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005669 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005671 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005672 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005673 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5674 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5675 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005677 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005678 return( ret );
5679 }
5680 }
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 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005685}
5686
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005687void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005688{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005689 if( transform == NULL )
5690 return;
5691
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005692#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005693 psa_destroy_key( transform->psa_key_enc );
5694 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005695#else
5696 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5697 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5698#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005699
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005700#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701 mbedtls_md_free( &transform->md_ctx_enc );
5702 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005703#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005704
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005705 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005706}
5707
Jerry Yuc7875b52021-09-05 21:05:50 +08005708void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5709 mbedtls_ssl_transform *transform )
5710{
Jerry Yuc7875b52021-09-05 21:05:50 +08005711 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005712 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005713}
5714
5715void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5716 mbedtls_ssl_transform *transform )
5717{
5718 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005719 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005720}
5721
Hanno Becker0271f962018-08-16 13:23:47 +01005722#if defined(MBEDTLS_SSL_PROTO_DTLS)
5723
Hanno Becker533ab5f2020-02-05 10:49:13 +00005724void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005725{
5726 unsigned offset;
5727 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5728
5729 if( hs == NULL )
5730 return;
5731
Hanno Becker283f5ef2018-08-24 09:34:47 +01005732 ssl_free_buffered_record( ssl );
5733
Hanno Becker0271f962018-08-16 13:23:47 +01005734 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005735 ssl_buffering_free_slot( ssl, offset );
5736}
5737
5738static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5739 uint8_t slot )
5740{
5741 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5742 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005743
5744 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5745 return;
5746
Hanno Beckere605b192018-08-21 15:59:07 +01005747 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005748 {
Hanno Beckere605b192018-08-21 15:59:07 +01005749 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005750 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005751 mbedtls_free( hs_buf->data );
5752 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005753 }
5754}
5755
5756#endif /* MBEDTLS_SSL_PROTO_DTLS */
5757
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005758/*
5759 * Convert version numbers to/from wire format
5760 * and, for DTLS, to/from TLS equivalent.
5761 *
5762 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005763 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005764 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005766void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005767 unsigned char ver[2] )
5768{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005769#if defined(MBEDTLS_SSL_PROTO_DTLS)
5770 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005771 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005773 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5774
5775 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5776 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5777 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005778 else
5779#else
5780 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005781#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005782 {
5783 ver[0] = (unsigned char) major;
5784 ver[1] = (unsigned char) minor;
5785 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005786}
5787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005789 const unsigned char ver[2] )
5790{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791#if defined(MBEDTLS_SSL_PROTO_DTLS)
5792 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005793 {
5794 *major = 255 - ver[0] + 2;
5795 *minor = 255 - ver[1] + 1;
5796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005797 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005798 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5799 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005800 else
5801#else
5802 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005803#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005804 {
5805 *major = ver[0];
5806 *minor = ver[1];
5807 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005808}
5809
Jerry Yue7047812021-09-13 19:26:39 +08005810/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005811 * Send pending fatal alert.
5812 * 0, No alert message.
5813 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5814 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005815 */
5816int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5817{
5818 int ret;
5819
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005820 /* No pending alert, return success*/
5821 if( ssl->send_alert == 0 )
5822 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005823
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005824 ret = mbedtls_ssl_send_alert_message( ssl,
5825 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5826 ssl->alert_type );
5827
Jerry Yu3bf1f972021-09-22 21:37:18 +08005828 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5829 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005830 */
5831 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5832 {
5833 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005834 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005835
5836 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005837 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005838
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005839 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005840}
5841
Jerry Yu394ece62021-09-14 22:17:21 +08005842/*
5843 * Set pending fatal alert flag.
5844 */
5845void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5846 unsigned char alert_type,
5847 int alert_reason )
5848{
5849 ssl->send_alert = 1;
5850 ssl->alert_type = alert_type;
5851 ssl->alert_reason = alert_reason;
5852}
5853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005854#endif /* MBEDTLS_SSL_TLS_C */