blob: fedaab78ef650ad4d00bd4d7dfc8ae7b7e4d4229 [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-mezei-armdb9a38c2021-09-27 11:28:54 +020043#include "constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020044
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020045#include "ssl_invasive.h"
46
Rich Evans00ab4702015-02-06 13:43:58 +000047#include <string.h>
48
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050049#if defined(MBEDTLS_USE_PSA_CRYPTO)
50#include "mbedtls/psa_util.h"
51#include "psa/crypto.h"
52#endif
53
Janos Follath23bdca02016-10-07 14:47:14 +010054#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000055#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020056#endif
57
Hanno Beckercd9dcda2018-08-28 17:18:56 +010058static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010059
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020060/*
61 * Start a timer.
62 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020063 */
Hanno Becker0f57a652020-02-05 10:37:26 +000064void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020065{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020066 if( ssl->f_set_timer == NULL )
67 return;
68
69 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
70 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020071}
72
73/*
74 * Return -1 is timer is expired, 0 if it isn't.
75 */
Hanno Becker7876d122020-02-05 10:39:31 +000076int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020077{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020078 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020079 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020080
81 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020082 {
83 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020084 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020086
87 return( 0 );
88}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089
TRodziewicz4ca18aa2021-05-20 14:46:20 +020090static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
91 unsigned char *buf,
92 size_t len,
93 mbedtls_record *rec );
94
95int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t buflen )
98{
99 int ret = 0;
100 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
101 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
102
103 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200104 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200105 */
106 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
107 {
108 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
109 goto exit;
110 }
111#if defined(MBEDTLS_SSL_PROTO_DTLS)
112 else
113 {
114 mbedtls_record rec;
115
116 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
117 if( ret != 0 )
118 {
119 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
120 goto exit;
121 }
122
123 if( ssl->transform_in != NULL )
124 {
125 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
126 if( ret != 0 )
127 {
128 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
129 goto exit;
130 }
131 }
132 }
133#endif /* MBEDTLS_SSL_PROTO_DTLS */
134
135exit:
136 /* On success, we have decrypted the buffer in-place, so make
137 * sure we don't leak any plaintext data. */
138 mbedtls_platform_zeroize( buf, buflen );
139
140 /* For the purpose of this API, treat messages with unexpected CID
141 * as well as such from future epochs as unexpected. */
142 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
143 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
144 {
145 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
146 }
147
148 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
149 return( ret );
150}
151
Hanno Becker67bc7c32018-08-06 11:33:50 +0100152#define SSL_DONT_FORCE_FLUSH 0
153#define SSL_FORCE_FLUSH 1
154
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100156
Hanno Beckerd5847772018-08-28 10:09:23 +0100157/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100158static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
159 uint8_t slot );
160static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
162static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
163static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100164static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
165 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100166static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100167
Hanno Becker11682cc2018-08-22 14:41:02 +0100168static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100169{
Hanno Becker89490712020-02-05 10:50:12 +0000170 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000171#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
172 size_t out_buf_len = ssl->out_buf_len;
173#else
174 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
175#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176
Darryl Greenb33cc762019-11-28 14:29:44 +0000177 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100178 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100179
Darryl Greenb33cc762019-11-28 14:29:44 +0000180 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100181}
182
Hanno Becker67bc7c32018-08-06 11:33:50 +0100183static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
184{
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 size_t const bytes_written = ssl->out_left;
186 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100187
188 /* Double-check that the write-index hasn't gone
189 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100190 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100191 {
192 /* Should never happen... */
193 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
194 }
195
196 return( (int) ( mtu - bytes_written ) );
197}
198
199static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
200{
Janos Follath865b3eb2019-12-16 11:46:15 +0000201 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100202 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400203 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100204
205#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400206 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100207
208 if( max_len > mfl )
209 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100210
211 /* By the standard (RFC 6066 Sect. 4), the MFL extension
212 * only limits the maximum record payload size, so in theory
213 * we would be allowed to pack multiple records of payload size
214 * MFL into a single datagram. However, this would mean that there's
215 * no way to explicitly communicate MTU restrictions to the peer.
216 *
217 * The following reduction of max_len makes sure that we never
218 * write datagrams larger than MFL + Record Expansion Overhead.
219 */
220 if( max_len <= ssl->out_left )
221 return( 0 );
222
223 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100224#endif
225
226 ret = ssl_get_remaining_space_in_datagram( ssl );
227 if( ret < 0 )
228 return( ret );
229 remaining = (size_t) ret;
230
231 ret = mbedtls_ssl_get_record_expansion( ssl );
232 if( ret < 0 )
233 return( ret );
234 expansion = (size_t) ret;
235
236 if( remaining <= expansion )
237 return( 0 );
238
239 remaining -= expansion;
240 if( remaining >= max_len )
241 remaining = max_len;
242
243 return( (int) remaining );
244}
245
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200246/*
247 * Double the retransmit timeout value, within the allowed range,
248 * returning -1 if the maximum value has already been reached.
249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200251{
252 uint32_t new_timeout;
253
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200254 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200255 return( -1 );
256
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200257 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
258 * in the following way: after the initial transmission and a first
259 * retransmission, back off to a temporary estimated MTU of 508 bytes.
260 * This value is guaranteed to be deliverable (if not guaranteed to be
261 * delivered) of any compliant IPv4 (and IPv6) network, and should work
262 * on most non-IP stacks too. */
263 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400264 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200265 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
267 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200268
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200269 new_timeout = 2 * ssl->handshake->retransmit_timeout;
270
271 /* Avoid arithmetic overflow and range overflow */
272 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200273 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200274 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200275 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 }
277
278 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000279 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
280 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200281
282 return( 0 );
283}
284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200286{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200287 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000288 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
289 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200290}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200292
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100293/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000294 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200295 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000296
Hanno Beckerccc13d02020-05-04 12:30:04 +0100297#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
298 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100299
300static size_t ssl_compute_padding_length( size_t len,
301 size_t granularity )
302{
303 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
304}
305
Hanno Becker581bc1b2020-05-04 12:20:03 +0100306/* This functions transforms a (D)TLS plaintext fragment and a record content
307 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
308 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
309 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100310 *
311 * struct {
312 * opaque content[DTLSPlaintext.length];
313 * ContentType real_type;
314 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100315 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100316 *
317 * Input:
318 * - `content`: The beginning of the buffer holding the
319 * plaintext to be wrapped.
320 * - `*content_size`: The length of the plaintext in Bytes.
321 * - `max_len`: The number of Bytes available starting from
322 * `content`. This must be `>= *content_size`.
323 * - `rec_type`: The desired record content type.
324 *
325 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100326 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
327 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100328 *
329 * Returns:
330 * - `0` on success.
331 * - A negative error code if `max_len` didn't offer enough space
332 * for the expansion.
333 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100334static int ssl_build_inner_plaintext( unsigned char *content,
335 size_t *content_size,
336 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100337 uint8_t rec_type,
338 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339{
340 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100341
342 /* Write real content type */
343 if( remaining == 0 )
344 return( -1 );
345 content[ len ] = rec_type;
346 len++;
347 remaining--;
348
349 if( remaining < pad )
350 return( -1 );
351 memset( content + len, 0, pad );
352 len += pad;
353 remaining -= pad;
354
355 *content_size = len;
356 return( 0 );
357}
358
Hanno Becker581bc1b2020-05-04 12:20:03 +0100359/* This function parses a (D)TLSInnerPlaintext structure.
360 * See ssl_build_inner_plaintext() for details. */
361static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100362 size_t *content_size,
363 uint8_t *rec_type )
364{
365 size_t remaining = *content_size;
366
367 /* Determine length of padding by skipping zeroes from the back. */
368 do
369 {
370 if( remaining == 0 )
371 return( -1 );
372 remaining--;
373 } while( content[ remaining ] == 0 );
374
375 *content_size = remaining;
376 *rec_type = content[ remaining ];
377
378 return( 0 );
379}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100380#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
381 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100382
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100383/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100384 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000385static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100386 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100387 mbedtls_record *rec,
388 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000389{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100390 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100391 *
392 * additional_data = seq_num + TLSCompressed.type +
393 * TLSCompressed.version + TLSCompressed.length;
394 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100395 * For the CID extension, this is extended as follows
396 * (quoting draft-ietf-tls-dtls-connection-id-05,
397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100398 *
399 * additional_data = seq_num + DTLSPlaintext.type +
400 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100401 * cid +
402 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100403 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100404 *
405 * For TLS 1.3, the record sequence number is dropped from the AAD
406 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100407 */
408
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100409 unsigned char *cur = add_data;
410
411#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
412 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
413#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
414 {
415 ((void) minor_ver);
416 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
417 cur += sizeof( rec->ctr );
418 }
419
420 *cur = rec->type;
421 cur++;
422
423 memcpy( cur, rec->ver, sizeof( rec->ver ) );
424 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100425
Hanno Beckera0e20d02019-05-15 14:03:01 +0100426#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100427 if( rec->cid_len != 0 )
428 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100429 memcpy( cur, rec->cid, rec->cid_len );
430 cur += rec->cid_len;
431
432 *cur = rec->cid_len;
433 cur++;
434
435 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
436 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
437 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100438 }
439 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100440#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100441 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100442 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
443 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
444 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100445 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100446
447 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000448}
449
Hanno Becker67a37db2020-05-28 16:27:07 +0100450#if defined(MBEDTLS_GCM_C) || \
451 defined(MBEDTLS_CCM_C) || \
452 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100453static int ssl_transform_aead_dynamic_iv_is_explicit(
454 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100455{
Hanno Becker17263802020-05-28 07:05:48 +0100456 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100457}
458
Hanno Becker17263802020-05-28 07:05:48 +0100459/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
460 *
461 * Concretely, this occurs in two variants:
462 *
463 * a) Fixed and dynamic IV lengths add up to total IV length, giving
464 * IV = fixed_iv || dynamic_iv
465 *
Hanno Becker15952812020-06-04 13:31:46 +0100466 * This variant is used in TLS 1.2 when used with GCM or CCM.
467 *
Hanno Becker17263802020-05-28 07:05:48 +0100468 * b) Fixed IV lengths matches total IV length, giving
469 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100470 *
471 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
472 *
473 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100474 *
475 * This function has the precondition that
476 *
477 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
478 *
479 * which has to be ensured by the caller. If this precondition
480 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100481 */
482static void ssl_build_record_nonce( unsigned char *dst_iv,
483 size_t dst_iv_len,
484 unsigned char const *fixed_iv,
485 size_t fixed_iv_len,
486 unsigned char const *dynamic_iv,
487 size_t dynamic_iv_len )
488{
489 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100490
491 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100492 memset( dst_iv, 0, dst_iv_len );
493 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100494
Hanno Becker17263802020-05-28 07:05:48 +0100495 dst_iv += dst_iv_len - dynamic_iv_len;
496 for( i = 0; i < dynamic_iv_len; i++ )
497 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100498}
Hanno Becker67a37db2020-05-28 16:27:07 +0100499#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100500
Hanno Beckera18d1322018-01-03 14:27:32 +0000501int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
502 mbedtls_ssl_transform *transform,
503 mbedtls_record *rec,
504 int (*f_rng)(void *, unsigned char *, size_t),
505 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000506{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200507 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100508 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000509 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100510 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100511 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000512 size_t post_avail;
513
514 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000515#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200516 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000517 ((void) ssl);
518#endif
519
520 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200521 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200522#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200523 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000524 ((void) f_rng);
525 ((void) p_rng);
526#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000529
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000530 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100531 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
533 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
534 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100535 if( rec == NULL
536 || rec->buf == NULL
537 || rec->buf_len < rec->data_offset
538 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100540 || rec->cid_len != 0
541#endif
542 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000543 {
544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100546 }
547
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000548 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100549 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000551 data, rec->data_len );
552
553 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
554
555 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
556 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
558 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000559 rec->data_len,
560 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000561 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
562 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100563
Hanno Becker92313402020-05-20 13:58:58 +0100564 /* The following two code paths implement the (D)TLSInnerPlaintext
565 * structure present in TLS 1.3 and DTLS 1.2 + CID.
566 *
567 * See ssl_build_inner_plaintext() for more information.
568 *
569 * Note that this changes `rec->data_len`, and hence
570 * `post_avail` needs to be recalculated afterwards.
571 *
572 * Note also that the two code paths cannot occur simultaneously
573 * since they apply to different versions of the protocol. There
574 * is hence no risk of double-addition of the inner plaintext.
575 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100576#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
577 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
578 {
Hanno Becker13996922020-05-28 16:15:19 +0100579 size_t padding =
580 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200581 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100582 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100583 &rec->data_len,
584 post_avail,
585 rec->type,
586 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100587 {
588 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
589 }
590
591 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
592 }
593#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
594
Hanno Beckera0e20d02019-05-15 14:03:01 +0100595#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100596 /*
597 * Add CID information
598 */
599 rec->cid_len = transform->out_cid_len;
600 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
601 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100602
603 if( rec->cid_len != 0 )
604 {
Hanno Becker13996922020-05-28 16:15:19 +0100605 size_t padding =
606 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200607 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100608 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100609 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100610 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100611 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100612 * Note that this changes `rec->data_len`, and hence
613 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100614 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100615 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616 &rec->data_len,
617 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100618 rec->type,
619 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100620 {
621 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
622 }
623
624 rec->type = MBEDTLS_SSL_MSG_CID;
625 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100626#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100627
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100628 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
629
Paul Bakker5121ce52009-01-03 21:22:43 +0000630 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100631 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000632 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000633#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634 if( mode == MBEDTLS_MODE_STREAM ||
635 ( mode == MBEDTLS_MODE_CBC
636#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000637 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100638#endif
639 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000640 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000641 if( post_avail < transform->maclen )
642 {
643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
644 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
645 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200646#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200647 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000648
TRodziewicz345165c2021-07-06 13:42:11 +0200649 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
650 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000651
TRodziewicz345165c2021-07-06 13:42:11 +0200652 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
653 add_data_len );
654 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
655 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
656 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657
TRodziewicz345165c2021-07-06 13:42:11 +0200658 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200659#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200660
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
662 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200663
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 rec->data_len += transform->maclen;
665 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100666 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200667 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000668#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000669
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200670 /*
671 * Encrypt
672 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000673#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000675 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000677 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000678 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000679 "including %d bytes of padding",
680 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
683 transform->iv_enc, transform->ivlen,
684 data, rec->data_len,
685 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200688 return( ret );
689 }
690
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000691 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
694 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200695 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000696 }
Paul Bakker68884e32013-01-07 18:20:04 +0100697 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000698#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000699
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200700#if defined(MBEDTLS_GCM_C) || \
701 defined(MBEDTLS_CCM_C) || \
702 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200704 mode == MBEDTLS_MODE_CCM ||
705 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000706 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200708 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100709 unsigned char *dynamic_iv;
710 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100711 int dynamic_iv_is_explicit =
712 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000713
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100714 /* Check that there's space for the authentication tag. */
715 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000716 {
717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
718 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
719 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000720
Paul Bakker68884e32013-01-07 18:20:04 +0100721 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100722 * Build nonce for AEAD encryption.
723 *
724 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
725 * part of the IV is prepended to the ciphertext and
726 * can be chosen freely - in particular, it need not
727 * agree with the record sequence number.
728 * However, since ChaChaPoly as well as all AEAD modes
729 * in TLS 1.3 use the record sequence number as the
730 * dynamic part of the nonce, we uniformly use the
731 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100732 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100733 dynamic_iv = rec->ctr;
734 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200735
Hanno Becker17263802020-05-28 07:05:48 +0100736 ssl_build_record_nonce( iv, sizeof( iv ),
737 transform->iv_enc,
738 transform->fixed_ivlen,
739 dynamic_iv,
740 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100741
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100742 /*
743 * Build additional data for AEAD encryption.
744 * This depends on the TLS version.
745 */
746 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
747 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100748
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200749 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100750 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200751 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100752 dynamic_iv,
753 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000754 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100755 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000756 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200757 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000758 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000759
Paul Bakker68884e32013-01-07 18:20:04 +0100760 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200761 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200762 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000763
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100764 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100766 add_data, add_data_len,
767 data, rec->data_len, /* src */
768 data, rec->buf_len - (data - rec->buf), /* dst */
769 &rec->data_len,
770 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200771 {
TRodziewicz18efb732021-04-29 23:12:19 +0200772 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200773 return( ret );
774 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000775 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100776 data + rec->data_len - transform->taglen,
777 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100778 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100780
781 /*
782 * Prefix record content with dynamic IV in case it is explicit.
783 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100784 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100785 {
786 if( rec->data_offset < dynamic_iv_len )
787 {
788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
789 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
790 }
791
792 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
793 rec->data_offset -= dynamic_iv_len;
794 rec->data_len += dynamic_iv_len;
795 }
796
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100797 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000798 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000799 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100800#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200801#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000803 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000804 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000805 size_t padlen, i;
806 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000807
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000808 /* Currently we're always using minimal padding
809 * (up to 255 bytes would be allowed). */
810 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
811 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000812 padlen = 0;
813
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000814 /* Check there's enough space in the buffer for the padding. */
815 if( post_avail < padlen + 1 )
816 {
817 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
818 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
819 }
820
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000822 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000823
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000824 rec->data_len += padlen + 1;
825 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000826
TRodziewicz0f82ec62021-05-12 17:49:18 +0200827#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000828 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200829 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000830 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000831 */
TRodziewicz345165c2021-07-06 13:42:11 +0200832 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000833 {
TRodziewicz345165c2021-07-06 13:42:11 +0200834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000836 }
TRodziewicz345165c2021-07-06 13:42:11 +0200837
838 if( rec->data_offset < transform->ivlen )
839 {
840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
841 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
842 }
843
844 /*
845 * Generate IV
846 */
847 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
848 if( ret != 0 )
849 return( ret );
850
851 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200852#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000853
Paul Elliottd48d5c62021-01-07 14:47:05 +0000854 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
855 "including %" MBEDTLS_PRINTF_SIZET
856 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000857 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200858 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000859
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000860 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
861 transform->iv_enc,
862 transform->ivlen,
863 data, rec->data_len,
864 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200867 return( ret );
868 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200869
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000870 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
873 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200874 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200875
TRodziewicz0f82ec62021-05-12 17:49:18 +0200876 data -= transform->ivlen;
877 rec->data_offset -= transform->ivlen;
878 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100881 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100882 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000883 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
884
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100885 /*
886 * MAC(MAC_write_key, seq_num +
887 * TLSCipherText.type +
888 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100889 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200890 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100891 * ENC(content + padding + padding_length));
892 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893
894 if( post_avail < transform->maclen)
895 {
896 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
897 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
898 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100899
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100900 ssl_extract_add_data_from_record( add_data, &add_data_len,
901 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000904 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100905 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100906
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000907 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100908 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 mbedtls_md_hmac_update( &transform->md_ctx_enc,
910 data, rec->data_len );
911 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
912 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100913
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000914 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100915
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916 rec->data_len += transform->maclen;
917 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100918 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100919 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000921 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200922 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200923#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200924 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
926 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200927 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000928
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100929 /* Make extra sure authentication was performed, exactly once */
930 if( auth_done != 1 )
931 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
933 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100934 }
935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000937
938 return( 0 );
939}
940
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200941#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200942/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200943 * Constant-flow boolean "equal" comparison:
944 * return x == y
945 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200946 * This function can be used to write constant-time code by replacing branches
947 * with bit operations - it can be used in conjunction with
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200948 * mbedtls_cf_size_mask().
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200949 *
950 * This function is implemented without using comparison operators, as those
951 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200952 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200953static size_t mbedtls_cf_size_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200954{
955 /* diff = 0 if x == y, non-zero otherwise */
956 const size_t diff = x ^ y;
957
958 /* MSVC has a warning about unary minus on unsigned integer types,
959 * but this is well-defined and precisely what we want to do here. */
960#if defined(_MSC_VER)
961#pragma warning( push )
962#pragma warning( disable : 4146 )
963#endif
964
965 /* diff_msb's most significant bit is equal to x != y */
966 const size_t diff_msb = ( diff | -diff );
967
968#if defined(_MSC_VER)
969#pragma warning( pop )
970#endif
971
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200972 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200973 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
974
975 return( 1 ^ diff1 );
976}
977
978/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200979 * Constant-flow conditional memcpy:
980 * - if c1 == c2, equivalent to memcpy(dst, src, len),
981 * - otherwise, a no-op,
982 * but with execution flow independent of the values of c1 and c2.
983 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200984 * This function is implemented without using comparison operators, as those
985 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200986 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200987static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
988 const unsigned char *src,
989 size_t len,
990 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200991{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200992 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200993 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
994 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200995
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200996 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200997 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200998 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200999}
1000
1001/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001002 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001003 *
1004 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1005 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001006 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001007MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001008 mbedtls_md_context_t *ctx,
1009 const unsigned char *add_data, size_t add_data_len,
1010 const unsigned char *data, size_t data_len_secret,
1011 size_t min_data_len, size_t max_data_len,
1012 unsigned char *output )
1013{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001014 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001015 * This function breaks the HMAC abstraction and uses the md_clone()
1016 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001017 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001018 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001019 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001020 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001021 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001022 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1023 * minlen, then cloning the context, and for each byte up to maxlen
1024 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001025 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001026 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001027 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001028 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +02001029 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001030 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001031 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001032 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001033 const unsigned char * const okey = ikey + block_size;
1034 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001035
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001036 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1037 mbedtls_md_context_t aux;
1038 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001040
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001041 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001042
1043#define MD_CHK( func_call ) \
1044 do { \
1045 ret = (func_call); \
1046 if( ret != 0 ) \
1047 goto cleanup; \
1048 } while( 0 )
1049
1050 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001051
1052 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1053 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001054 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1055 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001056
1057 /* For each possible length, compute the hash up to that point */
1058 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001059 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001060 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1061 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001062 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001063 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1064 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001065
1066 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001067 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001068 }
1069
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001070 /* The context needs to finish() before it starts() again */
1071 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1072
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001073 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001074 MD_CHK( mbedtls_md_starts( ctx ) );
1075 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1076 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1077 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001078
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001079 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001080 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001081
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001082#undef MD_CHK
1083
1084cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001085 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001086 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001087}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001088
1089/*
1090 * Constant-flow memcpy from variable position in buffer.
1091 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001092 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001093 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001094MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001095 unsigned char *dst,
1096 const unsigned char *src_base,
1097 size_t offset_secret,
1098 size_t offset_min, size_t offset_max,
1099 size_t len )
1100{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001101 size_t offset;
1102
1103 for( offset = offset_min; offset <= offset_max; offset++ )
1104 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001105 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1106 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001107 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001108}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001109#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001110
Hanno Becker605949f2019-07-12 08:23:59 +01001111int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001112 mbedtls_ssl_transform *transform,
1113 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001114{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001115 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001117 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001118#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001119 size_t padlen = 0, correct = 1;
1120#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001121 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001122 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001123 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001124
Hanno Beckera18d1322018-01-03 14:27:32 +00001125#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001126 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001127 ((void) ssl);
1128#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001129
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001131 if( rec == NULL ||
1132 rec->buf == NULL ||
1133 rec->buf_len < rec->data_offset ||
1134 rec->buf_len - rec->data_offset < rec->data_len )
1135 {
1136 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001138 }
1139
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001140 data = rec->buf + rec->data_offset;
1141 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001142
Hanno Beckera0e20d02019-05-15 14:03:01 +01001143#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001144 /*
1145 * Match record's CID with incoming CID.
1146 */
Hanno Becker938489a2019-05-08 13:02:22 +01001147 if( rec->cid_len != transform->in_cid_len ||
1148 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1149 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001150 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001151 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001152#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001153
Hanno Beckerd086bf02021-03-22 13:01:27 +00001154#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001156 {
1157 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001158 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1159 transform->iv_dec,
1160 transform->ivlen,
1161 data, rec->data_len,
1162 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001163 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001165 return( ret );
1166 }
1167
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001168 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001169 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1171 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001172 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001173 }
Paul Bakker68884e32013-01-07 18:20:04 +01001174 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001175#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001176#if defined(MBEDTLS_GCM_C) || \
1177 defined(MBEDTLS_CCM_C) || \
1178 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001180 mode == MBEDTLS_MODE_CCM ||
1181 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001182 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001183 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001184 unsigned char *dynamic_iv;
1185 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001186
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001187 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001188 * Extract dynamic part of nonce for AEAD decryption.
1189 *
1190 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1191 * part of the IV is prepended to the ciphertext and
1192 * can be chosen freely - in particular, it need not
1193 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001194 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001195 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001196 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001197 {
1198 if( rec->data_len < dynamic_iv_len )
1199 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001200 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1201 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001202 rec->data_len,
1203 dynamic_iv_len ) );
1204 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1205 }
1206 dynamic_iv = data;
1207
1208 data += dynamic_iv_len;
1209 rec->data_offset += dynamic_iv_len;
1210 rec->data_len -= dynamic_iv_len;
1211 }
Hanno Becker17263802020-05-28 07:05:48 +01001212 else
1213 {
1214 dynamic_iv = rec->ctr;
1215 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001216
1217 /* Check that there's space for the authentication tag. */
1218 if( rec->data_len < transform->taglen )
1219 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001220 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1221 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001222 rec->data_len,
1223 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001225 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001226 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001227
Hanno Beckerdf8be222020-05-21 15:30:57 +01001228 /*
1229 * Prepare nonce from dynamic and static parts.
1230 */
Hanno Becker17263802020-05-28 07:05:48 +01001231 ssl_build_record_nonce( iv, sizeof( iv ),
1232 transform->iv_dec,
1233 transform->fixed_ivlen,
1234 dynamic_iv,
1235 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001236
Hanno Beckerdf8be222020-05-21 15:30:57 +01001237 /*
1238 * Build additional data for AEAD encryption.
1239 * This depends on the TLS version.
1240 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001241 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1242 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001243 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001244 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001245
Hanno Beckerd96a6522019-07-10 13:55:25 +01001246 /* Because of the check above, we know that there are
1247 * explicit_iv_len Bytes preceeding data, and taglen
1248 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001249 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001250 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001251
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001252 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001253 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001254 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001255
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001256 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001257 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001258 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001259 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001260 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001261 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001262 data, rec->data_len + transform->taglen, /* src */
1263 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001264 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001265 {
TRodziewicz18efb732021-04-29 23:12:19 +02001266 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1269 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001270
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001271 return( ret );
1272 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001273 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001274
Hanno Beckerd96a6522019-07-10 13:55:25 +01001275 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001276 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001277 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1279 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001280 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001281 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001282 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001284#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001286 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001287 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001288
Paul Bakker5121ce52009-01-03 21:22:43 +00001289 /*
Paul Bakker45829992013-01-03 14:52:21 +01001290 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001291 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001292#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001293 /* The ciphertext is prefixed with the CBC IV. */
1294 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001295#endif
Paul Bakker45829992013-01-03 14:52:21 +01001296
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001297 /* Size considerations:
1298 *
1299 * - The CBC cipher text must not be empty and hence
1300 * at least of size transform->ivlen.
1301 *
1302 * Together with the potential IV-prefix, this explains
1303 * the first of the two checks below.
1304 *
1305 * - The record must contain a MAC, either in plain or
1306 * encrypted, depending on whether Encrypt-then-MAC
1307 * is used or not.
1308 * - If it is, the message contains the IV-prefix,
1309 * the CBC ciphertext, and the MAC.
1310 * - If it is not, the padded plaintext, and hence
1311 * the CBC ciphertext, has at least length maclen + 1
1312 * because there is at least the padding length byte.
1313 *
1314 * As the CBC ciphertext is not empty, both cases give the
1315 * lower bound minlen + maclen + 1 on the record size, which
1316 * we test for in the second check below.
1317 */
1318 if( rec->data_len < minlen + transform->ivlen ||
1319 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001320 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001321 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1322 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1323 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 "+ 1 ) ( + expl IV )", rec->data_len,
1325 transform->ivlen,
1326 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001328 }
1329
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001330 /*
1331 * Authenticate before decrypt if enabled
1332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001334 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001335 {
Hanno Becker992b6872017-11-09 18:57:39 +00001336 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001339
Hanno Beckerd96a6522019-07-10 13:55:25 +01001340 /* Update data_len in tandem with add_data.
1341 *
1342 * The subtraction is safe because of the previous check
1343 * data_len >= minlen + maclen + 1.
1344 *
1345 * Afterwards, we know that data + data_len is followed by at
1346 * least maclen Bytes, which justifies the call to
1347 * mbedtls_ssl_safer_memcmp() below.
1348 *
1349 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001350 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001351 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1352 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001353
Hanno Beckerd96a6522019-07-10 13:55:25 +01001354 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001355 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1356 add_data_len );
1357 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1358 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001359 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1360 data, rec->data_len );
1361 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1362 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001363
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001364 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1365 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001366 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001367 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001368
Hanno Beckerd96a6522019-07-10 13:55:25 +01001369 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001370 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1371 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001372 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001375 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001376 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001377 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001378#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001379
1380 /*
1381 * Check length sanity
1382 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001383
1384 /* We know from above that data_len > minlen >= 0,
1385 * so the following check in particular implies that
1386 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001387 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1390 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001391 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001393 }
1394
TRodziewicz0f82ec62021-05-12 17:49:18 +02001395#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001396 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001397 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001398 */
TRodziewicz345165c2021-07-06 13:42:11 +02001399 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1400 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001401
TRodziewicz345165c2021-07-06 13:42:11 +02001402 data += transform->ivlen;
1403 rec->data_offset += transform->ivlen;
1404 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001405#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001406
Hanno Beckerd96a6522019-07-10 13:55:25 +01001407 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1408
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001409 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1410 transform->iv_dec, transform->ivlen,
1411 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001414 return( ret );
1415 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001416
Hanno Beckerd96a6522019-07-10 13:55:25 +01001417 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001418 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001419 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1421 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001422 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001423
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 /* Safe since data_len >= minlen + maclen + 1, so after having
1425 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001426 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1427 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001428 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001429
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001430 if( auth_done == 1 )
1431 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001432 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001433 rec->data_len,
1434 padlen + 1 );
1435 correct &= mask;
1436 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001437 }
1438 else
Paul Bakker45829992013-01-03 14:52:21 +01001439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001440#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001441 if( rec->data_len < transform->maclen + padlen + 1 )
1442 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001443 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1444 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1445 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001446 rec->data_len,
1447 transform->maclen,
1448 padlen + 1 ) );
1449 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001450#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001451
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001452 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001453 rec->data_len,
1454 transform->maclen + padlen + 1 );
1455 correct &= mask;
1456 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001457 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001458
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001459 padlen++;
1460
1461 /* Regardless of the validity of the padding,
1462 * we have data_len >= padlen here. */
1463
TRodziewicz0f82ec62021-05-12 17:49:18 +02001464#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001465 /* The padding check involves a series of up to 256
1466 * consecutive memory reads at the end of the record
1467 * plaintext buffer. In order to hide the length and
1468 * validity of the padding, always perform exactly
1469 * `min(256,plaintext_len)` reads (but take into account
1470 * only the last `padlen` bytes for the padding check). */
1471 size_t pad_count = 0;
1472 volatile unsigned char* const check = data;
1473
1474 /* Index of first padding byte; it has been ensured above
1475 * that the subtraction is safe. */
1476 size_t const padding_idx = rec->data_len - padlen;
1477 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1478 size_t const start_idx = rec->data_len - num_checks;
1479 size_t idx;
1480
1481 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001482 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001483 /* pad_count += (idx >= padding_idx) &&
1484 * (check[idx] == padlen - 1);
1485 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001486 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1487 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1488 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001489 pad_count += mask & equal;
1490 }
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001491 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001494 if( padlen > 0 && correct == 0 )
1495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001496#endif
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001497 padlen &= mbedtls_cf_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001498
TRodziewicz0f82ec62021-05-12 17:49:18 +02001499#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001500
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001501 /* If the padding was found to be invalid, padlen == 0
1502 * and the subtraction is safe. If the padding was found valid,
1503 * padlen hasn't been changed and the previous assertion
1504 * data_len >= padlen still holds. */
1505 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001506 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001507 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001508#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1511 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001512 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001513
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001514#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001516 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001517#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001518
1519 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001520 * Authenticate if not done yet.
1521 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001522 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001523#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001524 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001525 {
Hanno Becker992b6872017-11-09 18:57:39 +00001526 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001527 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001528
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001529 /* If the initial value of padlen was such that
1530 * data_len < maclen + padlen + 1, then padlen
1531 * got reset to 1, and the initial check
1532 * data_len >= minlen + maclen + 1
1533 * guarantees that at this point we still
1534 * have at least data_len >= maclen.
1535 *
1536 * If the initial value of padlen was such that
1537 * data_len >= maclen + padlen + 1, then we have
1538 * subtracted either padlen + 1 (if the padding was correct)
1539 * or 0 (if the padding was incorrect) since then,
1540 * hence data_len >= maclen in any case.
1541 */
1542 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001543 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1544 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001545
TRodziewicz0f82ec62021-05-12 17:49:18 +02001546#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001547 /*
1548 * The next two sizes are the minimum and maximum values of
1549 * data_len over all padlen values.
1550 *
1551 * They're independent of padlen, since we previously did
1552 * data_len -= padlen.
1553 *
1554 * Note that max_len + maclen is never more than the buffer
1555 * length, as we previously did in_msglen -= maclen too.
1556 */
1557 const size_t max_len = rec->data_len + padlen;
1558 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1559
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001560 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1561 add_data, add_data_len,
1562 data, rec->data_len, min_len, max_len,
1563 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001564 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001565 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001566 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cf_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001567 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001568 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001569
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001570 mbedtls_cf_memcpy_offset( mac_peer, data,
1571 rec->data_len,
1572 min_len, max_len,
1573 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001574#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001575
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001576#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001577 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001578 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001579#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001580
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001581 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001582 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001583 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584#if defined(MBEDTLS_SSL_DEBUG_ALL)
1585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001586#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001587 correct = 0;
1588 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001589 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001590 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001591
1592 /*
1593 * Finally check the correct flag
1594 */
1595 if( correct == 0 )
1596 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001597#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001598
1599 /* Make extra sure authentication was performed, exactly once */
1600 if( auth_done != 1 )
1601 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001602 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1603 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001604 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001605
Hanno Beckerccc13d02020-05-04 12:30:04 +01001606#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1607 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1608 {
1609 /* Remove inner padding and infer true content type. */
1610 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1611 &rec->type );
1612
1613 if( ret != 0 )
1614 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1615 }
1616#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1617
Hanno Beckera0e20d02019-05-15 14:03:01 +01001618#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001619 if( rec->cid_len != 0 )
1620 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001621 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1622 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001623 if( ret != 0 )
1624 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1625 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001626#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001629
1630 return( 0 );
1631}
1632
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001633#undef MAC_NONE
1634#undef MAC_PLAINTEXT
1635#undef MAC_CIPHERTEXT
1636
Paul Bakker5121ce52009-01-03 21:22:43 +00001637/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001638 * Fill the input message buffer by appending data to it.
1639 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001640 *
1641 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1642 * available (from this read and/or a previous one). Otherwise, an error code
1643 * is returned (possibly EOF or WANT_READ).
1644 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001645 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1646 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1647 * since we always read a whole datagram at once.
1648 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001649 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001650 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001653{
Janos Follath865b3eb2019-12-16 11:46:15 +00001654 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001655 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001656#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1657 size_t in_buf_len = ssl->in_buf_len;
1658#else
1659 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1660#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001661
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001663
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001664 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1665 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001667 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001669 }
1670
Darryl Greenb33cc762019-11-28 14:29:44 +00001671 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001672 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1674 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001675 }
1676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001678 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001679 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001680 uint32_t timeout;
1681
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001682 /*
1683 * The point is, we need to always read a full datagram at once, so we
1684 * sometimes read more then requested, and handle the additional data.
1685 * It could be the rest of the current record (while fetching the
1686 * header) and/or some other records in the same datagram.
1687 */
1688
1689 /*
1690 * Move to the next record in the already read datagram if applicable
1691 */
1692 if( ssl->next_record_offset != 0 )
1693 {
1694 if( ssl->in_left < ssl->next_record_offset )
1695 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1697 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001698 }
1699
1700 ssl->in_left -= ssl->next_record_offset;
1701
1702 if( ssl->in_left != 0 )
1703 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001704 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1705 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001706 ssl->next_record_offset ) );
1707 memmove( ssl->in_hdr,
1708 ssl->in_hdr + ssl->next_record_offset,
1709 ssl->in_left );
1710 }
1711
1712 ssl->next_record_offset = 0;
1713 }
1714
Paul Elliottd48d5c62021-01-07 14:47:05 +00001715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1716 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001717 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001718
1719 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001720 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001721 */
1722 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001723 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001725 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001726 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001727
1728 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001729 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001730 * are not at the beginning of a new record, the caller did something
1731 * wrong.
1732 */
1733 if( ssl->in_left != 0 )
1734 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1736 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001737 }
1738
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001739 /*
1740 * Don't even try to read if time's out already.
1741 * This avoids by-passing the timer when repeatedly receiving messages
1742 * that will end up being dropped.
1743 */
Hanno Becker7876d122020-02-05 10:39:31 +00001744 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001745 {
1746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001747 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001748 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001749 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001750 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001751 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001752
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001753 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001754 timeout = ssl->handshake->retransmit_timeout;
1755 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001756 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001757
Paul Elliott9f352112020-12-09 14:55:45 +00001758 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001759
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001760 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001761 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1762 timeout );
1763 else
1764 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001767
1768 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001770 }
1771
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001772 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001773 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001775 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001776
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001778 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001779 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001782 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001783 }
1784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001786 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001788 return( ret );
1789 }
1790
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001791 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001792 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001794 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001796 {
Hanno Becker786300f2020-02-05 10:46:40 +00001797 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001798 {
Hanno Becker786300f2020-02-05 10:46:40 +00001799 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1800 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001801 return( ret );
1802 }
1803
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001804 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001805 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001807 }
1808
Paul Bakker5121ce52009-01-03 21:22:43 +00001809 if( ret < 0 )
1810 return( ret );
1811
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001812 ssl->in_left = ret;
1813 }
1814 else
1815#endif
1816 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1818 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001819 ssl->in_left, nb_want ) );
1820
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001821 while( ssl->in_left < nb_want )
1822 {
1823 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001824
Hanno Becker7876d122020-02-05 10:39:31 +00001825 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001826 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1827 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001828 {
1829 if( ssl->f_recv_timeout != NULL )
1830 {
1831 ret = ssl->f_recv_timeout( ssl->p_bio,
1832 ssl->in_hdr + ssl->in_left, len,
1833 ssl->conf->read_timeout );
1834 }
1835 else
1836 {
1837 ret = ssl->f_recv( ssl->p_bio,
1838 ssl->in_hdr + ssl->in_left, len );
1839 }
1840 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001841
Paul Elliottd48d5c62021-01-07 14:47:05 +00001842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1843 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001844 ssl->in_left, nb_want ) );
1845 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001846
1847 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001849
1850 if( ret < 0 )
1851 return( ret );
1852
makise-homuraaf9513b2020-08-24 18:26:27 +03001853 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001854 {
Darryl Green11999bb2018-03-13 15:22:58 +00001855 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001856 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001857 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001858 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1859 }
1860
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001861 ssl->in_left += ret;
1862 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001863 }
1864
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001866
1867 return( 0 );
1868}
1869
1870/*
1871 * Flush any data not yet written
1872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001874{
Janos Follath865b3eb2019-12-16 11:46:15 +00001875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001876 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001879
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001880 if( ssl->f_send == NULL )
1881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001883 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001885 }
1886
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001887 /* Avoid incrementing counter if data is flushed */
1888 if( ssl->out_left == 0 )
1889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001891 return( 0 );
1892 }
1893
Paul Bakker5121ce52009-01-03 21:22:43 +00001894 while( ssl->out_left > 0 )
1895 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1897 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001898 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001899
Hanno Becker2b1e3542018-08-06 11:19:13 +01001900 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001901 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001904
1905 if( ret <= 0 )
1906 return( ret );
1907
makise-homuraaf9513b2020-08-24 18:26:27 +03001908 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001909 {
Darryl Green11999bb2018-03-13 15:22:58 +00001910 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001911 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001912 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001913 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1914 }
1915
Paul Bakker5121ce52009-01-03 21:22:43 +00001916 ssl->out_left -= ret;
1917 }
1918
Hanno Becker2b1e3542018-08-06 11:19:13 +01001919#if defined(MBEDTLS_SSL_PROTO_DTLS)
1920 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001921 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001922 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001923 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001924 else
1925#endif
1926 {
1927 ssl->out_hdr = ssl->out_buf + 8;
1928 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001929 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001932
1933 return( 0 );
1934}
1935
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001936/*
1937 * Functions to handle the DTLS retransmission state machine
1938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001940/*
1941 * Append current handshake message to current outgoing flight
1942 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001944{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001946 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1947 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1948 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001949
1950 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001951 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001952 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001955 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001956 }
1957
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001958 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001959 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001960 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1961 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001963 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001964 }
1965
1966 /* Copy current handshake message with headers */
1967 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1968 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001969 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001970 msg->next = NULL;
1971
1972 /* Append to the current flight */
1973 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001974 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001975 else
1976 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001978 while( cur->next != NULL )
1979 cur = cur->next;
1980 cur->next = msg;
1981 }
1982
Hanno Becker3b235902018-08-06 09:54:53 +01001983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001984 return( 0 );
1985}
1986
1987/*
1988 * Free the current flight of handshake messages
1989 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001990void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001991{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 mbedtls_ssl_flight_item *cur = flight;
1993 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001994
1995 while( cur != NULL )
1996 {
1997 next = cur->next;
1998
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999 mbedtls_free( cur->p );
2000 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002001
2002 cur = next;
2003 }
2004}
2005
2006/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002007 * Swap transform_out and out_ctr with the alternative ones
2008 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002009static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002010{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002012 unsigned char tmp_out_ctr[8];
2013
2014 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2015 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002017 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002018 }
2019
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002021
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002022 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002023 tmp_transform = ssl->transform_out;
2024 ssl->transform_out = ssl->handshake->alt_transform_out;
2025 ssl->handshake->alt_transform_out = tmp_transform;
2026
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002027 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002028 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2029 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002030 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002031
2032 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002033 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002034
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002035 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002036}
2037
2038/*
2039 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002040 */
2041int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2042{
2043 int ret = 0;
2044
2045 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2046
2047 ret = mbedtls_ssl_flight_transmit( ssl );
2048
2049 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2050
2051 return( ret );
2052}
2053
2054/*
2055 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002056 *
2057 * Need to remember the current message in case flush_output returns
2058 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002059 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002060 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002061int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002062{
Janos Follath865b3eb2019-12-16 11:46:15 +00002063 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002064 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002067 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002068 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002069
2070 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002071 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002072 ret = ssl_swap_epochs( ssl );
2073 if( ret != 0 )
2074 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002077 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078
2079 while( ssl->handshake->cur_msg != NULL )
2080 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002081 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002082 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002083
Hanno Beckere1dcb032018-08-17 16:47:58 +01002084 int const is_finished =
2085 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2086 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2087
Hanno Becker04da1892018-08-14 13:22:10 +01002088 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2089 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2090
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002091 /* Swap epochs before sending Finished: we can't do it after
2092 * sending ChangeCipherSpec, in case write returns WANT_READ.
2093 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002094 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002095 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002097 ret = ssl_swap_epochs( ssl );
2098 if( ret != 0 )
2099 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002100 }
2101
Hanno Becker67bc7c32018-08-06 11:33:50 +01002102 ret = ssl_get_remaining_payload_in_datagram( ssl );
2103 if( ret < 0 )
2104 return( ret );
2105 max_frag_len = (size_t) ret;
2106
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002107 /* CCS is copied as is, while HS messages may need fragmentation */
2108 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2109 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002110 if( max_frag_len == 0 )
2111 {
2112 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2113 return( ret );
2114
2115 continue;
2116 }
2117
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002118 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002119 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002120 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002121
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002122 /* Update position inside current message */
2123 ssl->handshake->cur_msg_p += cur->len;
2124 }
2125 else
2126 {
2127 const unsigned char * const p = ssl->handshake->cur_msg_p;
2128 const size_t hs_len = cur->len - 12;
2129 const size_t frag_off = p - ( cur->p + 12 );
2130 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002131 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002132
Hanno Beckere1dcb032018-08-17 16:47:58 +01002133 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002134 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002135 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002136 {
2137 ret = ssl_swap_epochs( ssl );
2138 if( ret != 0 )
2139 return( ret );
2140 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002141
Hanno Becker67bc7c32018-08-06 11:33:50 +01002142 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2143 return( ret );
2144
2145 continue;
2146 }
2147 max_hs_frag_len = max_frag_len - 12;
2148
2149 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2150 max_hs_frag_len : rem_len;
2151
2152 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002153 {
2154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002155 (unsigned) cur_hs_frag_len,
2156 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002157 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002158
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002159 /* Messages are stored with handshake headers as if not fragmented,
2160 * copy beginning of headers then fill fragmentation fields.
2161 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2162 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002163
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002164 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2165 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2166 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2167
Hanno Becker67bc7c32018-08-06 11:33:50 +01002168 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2169 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2170 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002171
2172 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2173
Hanno Becker3f7b9732018-08-28 09:53:25 +01002174 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002175 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2176 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002177 ssl->out_msgtype = cur->type;
2178
2179 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002180 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002181 }
2182
2183 /* If done with the current message move to the next one if any */
2184 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2185 {
2186 if( cur->next != NULL )
2187 {
2188 ssl->handshake->cur_msg = cur->next;
2189 ssl->handshake->cur_msg_p = cur->next->p + 12;
2190 }
2191 else
2192 {
2193 ssl->handshake->cur_msg = NULL;
2194 ssl->handshake->cur_msg_p = NULL;
2195 }
2196 }
2197
2198 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002199 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002200 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002202 return( ret );
2203 }
2204 }
2205
Hanno Becker67bc7c32018-08-06 11:33:50 +01002206 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2207 return( ret );
2208
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002209 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2211 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002212 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002213 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002214 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002215 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002216 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002217
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002218 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002219
2220 return( 0 );
2221}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002222
2223/*
2224 * To be called when the last message of an incoming flight is received.
2225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002227{
2228 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002229 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002230 ssl->handshake->flight = NULL;
2231 ssl->handshake->cur_msg = NULL;
2232
2233 /* The next incoming flight will start with this msg_seq */
2234 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2235
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002236 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002237 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002238
Hanno Becker0271f962018-08-16 13:23:47 +01002239 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002240 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002241
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002242 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002243 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2246 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002247 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002249 }
2250 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002252}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002253
2254/*
2255 * To be called when the last message of an outgoing flight is send.
2256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002258{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002259 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002260 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2263 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002266 }
2267 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002269}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002271
Paul Bakker5121ce52009-01-03 21:22:43 +00002272/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002273 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002274 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002275
2276/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002277 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002278 *
2279 * - fill in handshake headers
2280 * - update handshake checksum
2281 * - DTLS: save message for resending
2282 * - then pass to the record layer
2283 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002284 * DTLS: except for HelloRequest, messages are only queued, and will only be
2285 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002286 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002287 * Inputs:
2288 * - ssl->out_msglen: 4 + actual handshake message len
2289 * (4 is the size of handshake headers for TLS)
2290 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2291 * - ssl->out_msg + 4: the handshake message body
2292 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002293 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002294 * - ssl->out_msglen: the length of the record contents
2295 * (including handshake headers but excluding record headers)
2296 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002297 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002298int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002299{
Janos Follath865b3eb2019-12-16 11:46:15 +00002300 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002301 const size_t hs_len = ssl->out_msglen - 4;
2302 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002303
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002304 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2305
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002306 /*
2307 * Sanity checks
2308 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002309 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002310 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2311 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002312 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2313 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002314 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002315
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002316 /* Whenever we send anything different from a
2317 * HelloRequest we should be in a handshake - double check. */
2318 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2319 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002320 ssl->handshake == NULL )
2321 {
2322 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2323 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2324 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002327 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002328 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002330 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002331 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2332 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002333 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002334#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002335
Hanno Beckerb50a2532018-08-06 11:52:54 +01002336 /* Double-check that we did not exceed the bounds
2337 * of the outgoing record buffer.
2338 * This should never fail as the various message
2339 * writing functions must obey the bounds of the
2340 * outgoing record buffer, but better be safe.
2341 *
2342 * Note: We deliberately do not check for the MTU or MFL here.
2343 */
2344 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2345 {
2346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002347 "size %" MBEDTLS_PRINTF_SIZET
2348 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002349 ssl->out_msglen,
2350 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002351 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2352 }
2353
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002354 /*
2355 * Fill handshake headers
2356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002358 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002359 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2360 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2361 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002362
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002363 /*
2364 * DTLS has additional fields in the Handshake layer,
2365 * between the length field and the actual payload:
2366 * uint16 message_seq;
2367 * uint24 fragment_offset;
2368 * uint24 fragment_length;
2369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002371 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002372 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002373 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002374 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002375 {
2376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002377 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002378 hs_len,
2379 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002380 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2381 }
2382
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002383 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002384 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002385
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002386 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002387 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002388 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002389 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2390 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2391 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002392 }
2393 else
2394 {
2395 ssl->out_msg[4] = 0;
2396 ssl->out_msg[5] = 0;
2397 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002398
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002399 /* Handshake hashes are computed without fragmentation,
2400 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002401 memset( ssl->out_msg + 6, 0x00, 3 );
2402 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002403 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002405
Hanno Becker0207e532018-08-28 10:28:28 +01002406 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002407 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2408 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002409 }
2410
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002411 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002413 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002414 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2415 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002416 {
2417 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2418 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002420 return( ret );
2421 }
2422 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002423 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002424#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002425 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002426 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002427 {
2428 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2429 return( ret );
2430 }
2431 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002432
2433 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2434
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002435 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002436}
2437
2438/*
2439 * Record layer functions
2440 */
2441
2442/*
2443 * Write current record.
2444 *
2445 * Uses:
2446 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2447 * - ssl->out_msglen: length of the record content (excl headers)
2448 * - ssl->out_msg: record content
2449 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002450int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002451{
2452 int ret, done = 0;
2453 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002454 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002455
2456 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002457
Paul Bakker05ef8352012-05-08 09:17:57 +00002458 if( !done )
2459 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002460 unsigned i;
2461 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002462#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2463 size_t out_buf_len = ssl->out_buf_len;
2464#else
2465 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2466#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002467 /* Skip writing the record content type to after the encryption,
2468 * as it may change when using the CID extension. */
2469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002471 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002472
Hanno Becker19859472018-08-06 09:40:20 +01002473 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002474 ssl->out_len[0] = (unsigned char)( len >> 8 );
2475 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002476
Paul Bakker48916f92012-09-16 19:57:18 +00002477 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002478 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002479 mbedtls_record rec;
2480
2481 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002482 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002483 rec.data_len = ssl->out_msglen;
2484 rec.data_offset = ssl->out_msg - rec.buf;
2485
2486 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2487 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2488 ssl->conf->transport, rec.ver );
2489 rec.type = ssl->out_msgtype;
2490
Hanno Beckera0e20d02019-05-15 14:03:01 +01002491#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002492 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002493 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002494#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002495
Hanno Beckera18d1322018-01-03 14:27:32 +00002496 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002497 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002498 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002500 return( ret );
2501 }
2502
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002503 if( rec.data_offset != 0 )
2504 {
2505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2506 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2507 }
2508
Hanno Becker6430faf2019-05-08 11:57:13 +01002509 /* Update the record content type and CID. */
2510 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002511#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002512 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002513#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002514 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002515 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2516 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002517 }
2518
Hanno Becker5903de42019-05-03 14:46:38 +01002519 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002520
2521#if defined(MBEDTLS_SSL_PROTO_DTLS)
2522 /* In case of DTLS, double-check that we don't exceed
2523 * the remaining space in the datagram. */
2524 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2525 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002526 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002527 if( ret < 0 )
2528 return( ret );
2529
2530 if( protected_record_size > (size_t) ret )
2531 {
2532 /* Should never happen */
2533 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2534 }
2535 }
2536#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002537
Hanno Becker6430faf2019-05-08 11:57:13 +01002538 /* Now write the potentially updated record content type. */
2539 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2540
Paul Elliott9f352112020-12-09 14:55:45 +00002541 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002542 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002543 ssl->out_hdr[0], ssl->out_hdr[1],
2544 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002547 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002548
2549 ssl->out_left += protected_record_size;
2550 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002551 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002552
Hanno Beckerdd772292020-02-05 10:38:31 +00002553 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002554 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2555 break;
2556
2557 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002558 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002559 {
2560 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2561 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2562 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002563 }
2564
Hanno Becker67bc7c32018-08-06 11:33:50 +01002565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002566 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2567 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002568 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002569 size_t remaining;
2570 ret = ssl_get_remaining_payload_in_datagram( ssl );
2571 if( ret < 0 )
2572 {
2573 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2574 ret );
2575 return( ret );
2576 }
2577
2578 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002579 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002580 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002581 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002582 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002583 else
2584 {
Hanno Becker513815a2018-08-20 11:56:09 +01002585 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002586 }
2587 }
2588#endif /* MBEDTLS_SSL_PROTO_DTLS */
2589
2590 if( ( flush == SSL_FORCE_FLUSH ) &&
2591 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002594 return( ret );
2595 }
2596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002598
2599 return( 0 );
2600}
2601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002603
2604static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2605{
2606 if( ssl->in_msglen < ssl->in_hslen ||
2607 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2608 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2609 {
2610 return( 1 );
2611 }
2612 return( 0 );
2613}
Hanno Becker44650b72018-08-16 12:51:11 +01002614
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002615static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002616{
2617 return( ( ssl->in_msg[9] << 16 ) |
2618 ( ssl->in_msg[10] << 8 ) |
2619 ssl->in_msg[11] );
2620}
2621
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002622static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002623{
2624 return( ( ssl->in_msg[6] << 16 ) |
2625 ( ssl->in_msg[7] << 8 ) |
2626 ssl->in_msg[8] );
2627}
2628
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002629static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002630{
2631 uint32_t msg_len, frag_off, frag_len;
2632
2633 msg_len = ssl_get_hs_total_len( ssl );
2634 frag_off = ssl_get_hs_frag_off( ssl );
2635 frag_len = ssl_get_hs_frag_len( ssl );
2636
2637 if( frag_off > msg_len )
2638 return( -1 );
2639
2640 if( frag_len > msg_len - frag_off )
2641 return( -1 );
2642
2643 if( frag_len + 12 > ssl->in_msglen )
2644 return( -1 );
2645
2646 return( 0 );
2647}
2648
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002649/*
2650 * Mark bits in bitmask (used for DTLS HS reassembly)
2651 */
2652static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2653{
2654 unsigned int start_bits, end_bits;
2655
2656 start_bits = 8 - ( offset % 8 );
2657 if( start_bits != 8 )
2658 {
2659 size_t first_byte_idx = offset / 8;
2660
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002661 /* Special case */
2662 if( len <= start_bits )
2663 {
2664 for( ; len != 0; len-- )
2665 mask[first_byte_idx] |= 1 << ( start_bits - len );
2666
2667 /* Avoid potential issues with offset or len becoming invalid */
2668 return;
2669 }
2670
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002671 offset += start_bits; /* Now offset % 8 == 0 */
2672 len -= start_bits;
2673
2674 for( ; start_bits != 0; start_bits-- )
2675 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2676 }
2677
2678 end_bits = len % 8;
2679 if( end_bits != 0 )
2680 {
2681 size_t last_byte_idx = ( offset + len ) / 8;
2682
2683 len -= end_bits; /* Now len % 8 == 0 */
2684
2685 for( ; end_bits != 0; end_bits-- )
2686 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2687 }
2688
2689 memset( mask + offset / 8, 0xFF, len / 8 );
2690}
2691
2692/*
2693 * Check that bitmask is full
2694 */
2695static int ssl_bitmask_check( unsigned char *mask, size_t len )
2696{
2697 size_t i;
2698
2699 for( i = 0; i < len / 8; i++ )
2700 if( mask[i] != 0xFF )
2701 return( -1 );
2702
2703 for( i = 0; i < len % 8; i++ )
2704 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2705 return( -1 );
2706
2707 return( 0 );
2708}
2709
Hanno Becker56e205e2018-08-16 09:06:12 +01002710/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002711static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002712 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002713{
Hanno Becker56e205e2018-08-16 09:06:12 +01002714 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002715
Hanno Becker56e205e2018-08-16 09:06:12 +01002716 alloc_len = 12; /* Handshake header */
2717 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002718
Hanno Beckerd07df862018-08-16 09:14:58 +01002719 if( add_bitmap )
2720 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002721
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002722 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002723}
Hanno Becker56e205e2018-08-16 09:06:12 +01002724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002726
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002727static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002728{
2729 return( ( ssl->in_msg[1] << 16 ) |
2730 ( ssl->in_msg[2] << 8 ) |
2731 ssl->in_msg[3] );
2732}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002733
Simon Butcher99000142016-10-13 17:21:01 +01002734int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002735{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002737 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002739 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002741 }
2742
Hanno Becker12555c62018-08-16 12:47:53 +01002743 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002746 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002747 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002750 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002751 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002753 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002754
Hanno Becker44650b72018-08-16 12:51:11 +01002755 if( ssl_check_hs_header( ssl ) != 0 )
2756 {
2757 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2758 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2759 }
2760
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002761 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002762 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2763 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2764 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2765 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002766 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002767 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2768 {
2769 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2770 recv_msg_seq,
2771 ssl->handshake->in_msg_seq ) );
2772 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2773 }
2774
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002775 /* Retransmit only on last message from previous flight, to avoid
2776 * too many retransmissions.
2777 * Besides, No sane server ever retransmits HelloVerifyRequest */
2778 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002782 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002783 recv_msg_seq,
2784 ssl->handshake->in_flight_start_seq ) );
2785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002787 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002789 return( ret );
2790 }
2791 }
2792 else
2793 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002795 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002796 recv_msg_seq,
2797 ssl->handshake->in_msg_seq ) );
2798 }
2799
Hanno Becker90333da2017-10-10 11:27:13 +01002800 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002801 }
2802 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002803
Hanno Becker6d97ef52018-08-16 13:09:04 +01002804 /* Message reassembly is handled alongside buffering of future
2805 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002806 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002807 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002808 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002809 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002811 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002812 }
2813 }
2814 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002816 /* With TLS we don't handle fragmentation (for now) */
2817 if( ssl->in_msglen < ssl->in_hslen )
2818 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2820 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002821 }
2822
Simon Butcher99000142016-10-13 17:21:01 +01002823 return( 0 );
2824}
2825
2826void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2827{
Hanno Becker0271f962018-08-16 13:23:47 +01002828 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002829
Hanno Becker0271f962018-08-16 13:23:47 +01002830 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002831 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002832 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002833 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002834
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002835 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002837 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002838 ssl->handshake != NULL )
2839 {
Hanno Becker0271f962018-08-16 13:23:47 +01002840 unsigned offset;
2841 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002842
Hanno Becker0271f962018-08-16 13:23:47 +01002843 /* Increment handshake sequence number */
2844 hs->in_msg_seq++;
2845
2846 /*
2847 * Clear up handshake buffering and reassembly structure.
2848 */
2849
2850 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002851 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002852
2853 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002854 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2855 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002856 offset++, hs_buf++ )
2857 {
2858 *hs_buf = *(hs_buf + 1);
2859 }
2860
2861 /* Create a fresh last entry */
2862 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002863 }
2864#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002865}
2866
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002867/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002868 * DTLS anti-replay: RFC 6347 4.1.2.6
2869 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002870 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2871 * Bit n is set iff record number in_window_top - n has been seen.
2872 *
2873 * Usually, in_window_top is the last record number seen and the lsb of
2874 * in_window is set. The only exception is the initial state (record number 0
2875 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002878void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002879{
2880 ssl->in_window_top = 0;
2881 ssl->in_window = 0;
2882}
2883
2884static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2885{
2886 return( ( (uint64_t) buf[0] << 40 ) |
2887 ( (uint64_t) buf[1] << 32 ) |
2888 ( (uint64_t) buf[2] << 24 ) |
2889 ( (uint64_t) buf[3] << 16 ) |
2890 ( (uint64_t) buf[4] << 8 ) |
2891 ( (uint64_t) buf[5] ) );
2892}
2893
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002894static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2895{
Janos Follath865b3eb2019-12-16 11:46:15 +00002896 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002897 unsigned char *original_in_ctr;
2898
2899 // save original in_ctr
2900 original_in_ctr = ssl->in_ctr;
2901
2902 // use counter from record
2903 ssl->in_ctr = record_in_ctr;
2904
2905 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2906
2907 // restore the counter
2908 ssl->in_ctr = original_in_ctr;
2909
2910 return ret;
2911}
2912
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002913/*
2914 * Return 0 if sequence number is acceptable, -1 otherwise
2915 */
Hanno Becker0183d692019-07-12 08:50:37 +01002916int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002917{
2918 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2919 uint64_t bit;
2920
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002921 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002922 return( 0 );
2923
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002924 if( rec_seqnum > ssl->in_window_top )
2925 return( 0 );
2926
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002927 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002928
2929 if( bit >= 64 )
2930 return( -1 );
2931
2932 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2933 return( -1 );
2934
2935 return( 0 );
2936}
2937
2938/*
2939 * Update replay window on new validated record
2940 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002942{
2943 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2944
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002945 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002946 return;
2947
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002948 if( rec_seqnum > ssl->in_window_top )
2949 {
2950 /* Update window_top and the contents of the window */
2951 uint64_t shift = rec_seqnum - ssl->in_window_top;
2952
2953 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002954 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002955 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002956 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002957 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002958 ssl->in_window |= 1;
2959 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002960
2961 ssl->in_window_top = rec_seqnum;
2962 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002963 else
2964 {
2965 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002966 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002967
2968 if( bit < 64 ) /* Always true, but be extra sure */
2969 ssl->in_window |= (uint64_t) 1 << bit;
2970 }
2971}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002973
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002974#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002975/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002976 * Without any SSL context, check if a datagram looks like a ClientHello with
2977 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002978 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002979 *
2980 * - if cookie is valid, return 0
2981 * - if ClientHello looks superficially valid but cookie is not,
2982 * fill obuf and set olen, then
2983 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2984 * - otherwise return a specific error code
2985 */
2986static int ssl_check_dtls_clihlo_cookie(
2987 mbedtls_ssl_cookie_write_t *f_cookie_write,
2988 mbedtls_ssl_cookie_check_t *f_cookie_check,
2989 void *p_cookie,
2990 const unsigned char *cli_id, size_t cli_id_len,
2991 const unsigned char *in, size_t in_len,
2992 unsigned char *obuf, size_t buf_len, size_t *olen )
2993{
2994 size_t sid_len, cookie_len;
2995 unsigned char *p;
2996
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002997 /*
2998 * Structure of ClientHello with record and handshake headers,
2999 * and expected values. We don't need to check a lot, more checks will be
3000 * done when actually parsing the ClientHello - skipping those checks
3001 * avoids code duplication and does not make cookie forging any easier.
3002 *
3003 * 0-0 ContentType type; copied, must be handshake
3004 * 1-2 ProtocolVersion version; copied
3005 * 3-4 uint16 epoch; copied, must be 0
3006 * 5-10 uint48 sequence_number; copied
3007 * 11-12 uint16 length; (ignored)
3008 *
3009 * 13-13 HandshakeType msg_type; (ignored)
3010 * 14-16 uint24 length; (ignored)
3011 * 17-18 uint16 message_seq; copied
3012 * 19-21 uint24 fragment_offset; copied, must be 0
3013 * 22-24 uint24 fragment_length; (ignored)
3014 *
3015 * 25-26 ProtocolVersion client_version; (ignored)
3016 * 27-58 Random random; (ignored)
3017 * 59-xx SessionID session_id; 1 byte len + sid_len content
3018 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3019 * ...
3020 *
3021 * Minimum length is 61 bytes.
3022 */
3023 if( in_len < 61 ||
3024 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3025 in[3] != 0 || in[4] != 0 ||
3026 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3027 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003028 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003029 }
3030
3031 sid_len = in[59];
3032 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003033 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003034
3035 cookie_len = in[60 + sid_len];
3036 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003037 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003038
3039 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3040 cli_id, cli_id_len ) == 0 )
3041 {
3042 /* Valid cookie */
3043 return( 0 );
3044 }
3045
3046 /*
3047 * If we get here, we've got an invalid cookie, let's prepare HVR.
3048 *
3049 * 0-0 ContentType type; copied
3050 * 1-2 ProtocolVersion version; copied
3051 * 3-4 uint16 epoch; copied
3052 * 5-10 uint48 sequence_number; copied
3053 * 11-12 uint16 length; olen - 13
3054 *
3055 * 13-13 HandshakeType msg_type; hello_verify_request
3056 * 14-16 uint24 length; olen - 25
3057 * 17-18 uint16 message_seq; copied
3058 * 19-21 uint24 fragment_offset; copied
3059 * 22-24 uint24 fragment_length; olen - 25
3060 *
3061 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3062 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3063 *
3064 * Minimum length is 28.
3065 */
3066 if( buf_len < 28 )
3067 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3068
3069 /* Copy most fields and adapt others */
3070 memcpy( obuf, in, 25 );
3071 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3072 obuf[25] = 0xfe;
3073 obuf[26] = 0xff;
3074
3075 /* Generate and write actual cookie */
3076 p = obuf + 28;
3077 if( f_cookie_write( p_cookie,
3078 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3079 {
3080 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3081 }
3082
3083 *olen = p - obuf;
3084
3085 /* Go back and fill length fields */
3086 obuf[27] = (unsigned char)( *olen - 28 );
3087
3088 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3089 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3090 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3091
3092 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3093 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3094
3095 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3096}
3097
3098/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003099 * Handle possible client reconnect with the same UDP quadruplet
3100 * (RFC 6347 Section 4.2.8).
3101 *
3102 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3103 * that looks like a ClientHello.
3104 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003105 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003106 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003107 * - if the input looks like a ClientHello with a valid cookie,
3108 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003109 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003110 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003111 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003112 * This function is called (through ssl_check_client_reconnect()) when an
3113 * unexpected record is found in ssl_get_next_record(), which will discard the
3114 * record if we return 0, and bubble up the return value otherwise (this
3115 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3116 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003117 */
3118static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3119{
Janos Follath865b3eb2019-12-16 11:46:15 +00003120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003121 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003122
Hanno Becker2fddd372019-07-10 14:37:41 +01003123 if( ssl->conf->f_cookie_write == NULL ||
3124 ssl->conf->f_cookie_check == NULL )
3125 {
3126 /* If we can't use cookies to verify reachability of the peer,
3127 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003128 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3129 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003130 return( 0 );
3131 }
3132
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003133 ret = ssl_check_dtls_clihlo_cookie(
3134 ssl->conf->f_cookie_write,
3135 ssl->conf->f_cookie_check,
3136 ssl->conf->p_cookie,
3137 ssl->cli_id, ssl->cli_id_len,
3138 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003139 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003140
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003141 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3142
3143 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003144 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003145 int send_ret;
3146 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3147 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3148 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003149 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003150 * If the error is permanent we'll catch it later,
3151 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003152 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3153 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3154 (void) send_ret;
3155
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003156 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003157 }
3158
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003159 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003160 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003161 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003162 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003163 {
3164 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3165 return( ret );
3166 }
3167
3168 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003169 }
3170
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003171 return( ret );
3172}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003173#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003174
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003175static int ssl_check_record_type( uint8_t record_type )
3176{
3177 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3178 record_type != MBEDTLS_SSL_MSG_ALERT &&
3179 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3180 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3181 {
3182 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3183 }
3184
3185 return( 0 );
3186}
3187
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003188/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003189 * ContentType type;
3190 * ProtocolVersion version;
3191 * uint16 epoch; // DTLS only
3192 * uint48 sequence_number; // DTLS only
3193 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003194 *
3195 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003196 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003197 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3198 *
3199 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003200 * 1. proceed with the record if this function returns 0
3201 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3202 * 3. return CLIENT_RECONNECT if this function return that value
3203 * 4. drop the whole datagram if this function returns anything else.
3204 * Point 2 is needed when the peer is resending, and we have already received
3205 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003206 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003207static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003208 unsigned char *buf,
3209 size_t len,
3210 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003211{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003212 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003213
Hanno Beckere5e7e782019-07-11 12:29:35 +01003214 size_t const rec_hdr_type_offset = 0;
3215 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003216
Hanno Beckere5e7e782019-07-11 12:29:35 +01003217 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3218 rec_hdr_type_len;
3219 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003220
Hanno Beckere5e7e782019-07-11 12:29:35 +01003221 size_t const rec_hdr_ctr_len = 8;
3222#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003223 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003224 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3225 rec_hdr_version_len;
3226
Hanno Beckera0e20d02019-05-15 14:03:01 +01003227#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003228 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3229 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003230 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003231#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3232#endif /* MBEDTLS_SSL_PROTO_DTLS */
3233
3234 size_t rec_hdr_len_offset; /* To be determined */
3235 size_t const rec_hdr_len_len = 2;
3236
3237 /*
3238 * Check minimum lengths for record header.
3239 */
3240
3241#if defined(MBEDTLS_SSL_PROTO_DTLS)
3242 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3243 {
3244 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3245 }
3246 else
3247#endif /* MBEDTLS_SSL_PROTO_DTLS */
3248 {
3249 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3250 }
3251
3252 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3253 {
3254 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3255 (unsigned) len,
3256 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3257 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3258 }
3259
3260 /*
3261 * Parse and validate record content type
3262 */
3263
3264 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003265
3266 /* Check record content type */
3267#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3268 rec->cid_len = 0;
3269
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003270 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003271 ssl->conf->cid_len != 0 &&
3272 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003273 {
3274 /* Shift pointers to account for record header including CID
3275 * struct {
3276 * ContentType special_type = tls12_cid;
3277 * ProtocolVersion version;
3278 * uint16 epoch;
3279 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003280 * opaque cid[cid_length]; // Additional field compared to
3281 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003282 * uint16 length;
3283 * opaque enc_content[DTLSCiphertext.length];
3284 * } DTLSCiphertext;
3285 */
3286
3287 /* So far, we only support static CID lengths
3288 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003289 rec_hdr_cid_len = ssl->conf->cid_len;
3290 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003291
Hanno Beckere5e7e782019-07-11 12:29:35 +01003292 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003293 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003294 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3295 (unsigned) len,
3296 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003297 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003298 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003299
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003300 /* configured CID len is guaranteed at most 255, see
3301 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3302 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003303 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003304 }
3305 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003306#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003307 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003308 if( ssl_check_record_type( rec->type ) )
3309 {
Hanno Becker54229812019-07-12 14:40:00 +01003310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3311 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003312 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3313 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003314 }
3315
Hanno Beckere5e7e782019-07-11 12:29:35 +01003316 /*
3317 * Parse and validate record version
3318 */
3319
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003320 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3321 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003322 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3323 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003324 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003325
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003326 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003327 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3329 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003330 }
3331
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003332 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3335 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003336 }
3337
Hanno Beckere5e7e782019-07-11 12:29:35 +01003338 /*
3339 * Parse/Copy record sequence number.
3340 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003341
Hanno Beckere5e7e782019-07-11 12:29:35 +01003342#if defined(MBEDTLS_SSL_PROTO_DTLS)
3343 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003344 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003345 /* Copy explicit record sequence number from input buffer. */
3346 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3347 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003348 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003349 else
3350#endif /* MBEDTLS_SSL_PROTO_DTLS */
3351 {
3352 /* Copy implicit record sequence number from SSL context structure. */
3353 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3354 }
Paul Bakker40e46942009-01-03 21:51:57 +00003355
Hanno Beckere5e7e782019-07-11 12:29:35 +01003356 /*
3357 * Parse record length.
3358 */
3359
Hanno Beckere5e7e782019-07-11 12:29:35 +01003360 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003361 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3362 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003363 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003364
Paul Elliott9f352112020-12-09 14:55:45 +00003365 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003366 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003367 rec->type,
3368 major_ver, minor_ver, rec->data_len ) );
3369
3370 rec->buf = buf;
3371 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003372
Hanno Beckerd417cc92019-07-26 08:20:27 +01003373 if( rec->data_len == 0 )
3374 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003375
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003376 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003377 * DTLS-related tests.
3378 * Check epoch before checking length constraint because
3379 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3380 * message gets duplicated before the corresponding Finished message,
3381 * the second ChangeCipherSpec should be discarded because it belongs
3382 * to an old epoch, but not because its length is shorter than
3383 * the minimum record length for packets using the new record transform.
3384 * Note that these two kinds of failures are handled differently,
3385 * as an unexpected record is silently skipped but an invalid
3386 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003387 */
3388#if defined(MBEDTLS_SSL_PROTO_DTLS)
3389 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3390 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003391 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003392
Hanno Becker955a5c92019-07-10 17:12:07 +01003393 /* Check that the datagram is large enough to contain a record
3394 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003395 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003396 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003397 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3398 (unsigned) len,
3399 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003400 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3401 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003402
Hanno Becker37cfe732019-07-10 17:20:01 +01003403 /* Records from other, non-matching epochs are silently discarded.
3404 * (The case of same-port Client reconnects must be considered in
3405 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003406 if( rec_epoch != ssl->in_epoch )
3407 {
3408 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003409 "expected %u, received %lu",
3410 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003411
Hanno Becker552f7472019-07-19 10:59:12 +01003412 /* Records from the next epoch are considered for buffering
3413 * (concretely: early Finished messages). */
3414 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003415 {
Hanno Becker552f7472019-07-19 10:59:12 +01003416 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3417 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003418 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003419
Hanno Becker2fddd372019-07-10 14:37:41 +01003420 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003421 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003422#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003423 /* For records from the correct epoch, check whether their
3424 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003425 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3426 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003427 {
3428 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3429 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3430 }
3431#endif
3432 }
3433#endif /* MBEDTLS_SSL_PROTO_DTLS */
3434
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003435 return( 0 );
3436}
Paul Bakker5121ce52009-01-03 21:22:43 +00003437
Paul Bakker5121ce52009-01-03 21:22:43 +00003438
Hanno Becker2fddd372019-07-10 14:37:41 +01003439#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3440static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3441{
3442 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3443
3444 /*
3445 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3446 * access the first byte of record content (handshake type), as we
3447 * have an active transform (possibly iv_len != 0), so use the
3448 * fact that the record header len is 13 instead.
3449 */
3450 if( rec_epoch == 0 &&
3451 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3452 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3453 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3454 ssl->in_left > 13 &&
3455 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3456 {
3457 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3458 "from the same port" ) );
3459 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003460 }
3461
3462 return( 0 );
3463}
Hanno Becker2fddd372019-07-10 14:37:41 +01003464#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003465
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003466/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003467 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003468 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003469static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3470 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003471{
3472 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003475 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003476
Paul Bakker48916f92012-09-16 19:57:18 +00003477 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003478 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003479 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003480
Hanno Beckera18d1322018-01-03 14:27:32 +00003481 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003482 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003483 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003484 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003485
Hanno Beckera0e20d02019-05-15 14:03:01 +01003486#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003487 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3488 ssl->conf->ignore_unexpected_cid
3489 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3490 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003491 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003492 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003493 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003494#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003495
Paul Bakker5121ce52009-01-03 21:22:43 +00003496 return( ret );
3497 }
3498
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003499 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003500 {
3501 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003502 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003503 }
3504
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003505 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003506 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003507
Hanno Beckera0e20d02019-05-15 14:03:01 +01003508#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003509 /* We have already checked the record content type
3510 * in ssl_parse_record_header(), failing or silently
3511 * dropping the record in the case of an unknown type.
3512 *
3513 * Since with the use of CIDs, the record content type
3514 * might change during decryption, re-check the record
3515 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003516 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003517 {
3518 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3519 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3520 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003521#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003522
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003523 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003524 {
3525#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3526 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003527 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003528 {
3529 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3531 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3532 }
3533#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3534
3535 ssl->nb_zero++;
3536
3537 /*
3538 * Three or more empty messages may be a DoS attack
3539 * (excessive CPU consumption).
3540 */
3541 if( ssl->nb_zero > 3 )
3542 {
3543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003544 "messages, possible DoS attack" ) );
3545 /* Treat the records as if they were not properly authenticated,
3546 * thereby failing the connection if we see more than allowed
3547 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003548 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3549 }
3550 }
3551 else
3552 ssl->nb_zero = 0;
3553
3554#if defined(MBEDTLS_SSL_PROTO_DTLS)
3555 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3556 {
3557 ; /* in_ctr read from peer, not maintained internally */
3558 }
3559 else
3560#endif
3561 {
3562 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003563 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003564 if( ++ssl->in_ctr[i - 1] != 0 )
3565 break;
3566
3567 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003568 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003569 {
3570 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3571 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3572 }
3573 }
3574
Paul Bakker5121ce52009-01-03 21:22:43 +00003575 }
3576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003577#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003578 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003579 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003581 }
3582#endif
3583
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003584 /* Check actual (decrypted) record content length against
3585 * configured maximum. */
3586 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3587 {
3588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3589 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3590 }
3591
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003592 return( 0 );
3593}
3594
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003595/*
3596 * Read a record.
3597 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003598 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3599 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3600 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003601 */
Hanno Becker1097b342018-08-15 14:09:41 +01003602
3603/* Helper functions for mbedtls_ssl_read_record(). */
3604static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003605static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3606static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003607
Hanno Becker327c93b2018-08-15 13:56:18 +01003608int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003609 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003610{
Janos Follath865b3eb2019-12-16 11:46:15 +00003611 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003614
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003615 if( ssl->keep_current_message == 0 )
3616 {
3617 do {
Simon Butcher99000142016-10-13 17:21:01 +01003618
Hanno Becker26994592018-08-15 14:14:59 +01003619 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003620 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003621 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003622
Hanno Beckere74d5562018-08-15 14:26:08 +01003623 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003624 {
Hanno Becker40f50842018-08-15 14:48:01 +01003625#if defined(MBEDTLS_SSL_PROTO_DTLS)
3626 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003627
Hanno Becker40f50842018-08-15 14:48:01 +01003628 /* We only check for buffered messages if the
3629 * current datagram is fully consumed. */
3630 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003631 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003632 {
Hanno Becker40f50842018-08-15 14:48:01 +01003633 if( ssl_load_buffered_message( ssl ) == 0 )
3634 have_buffered = 1;
3635 }
3636
3637 if( have_buffered == 0 )
3638#endif /* MBEDTLS_SSL_PROTO_DTLS */
3639 {
3640 ret = ssl_get_next_record( ssl );
3641 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3642 continue;
3643
3644 if( ret != 0 )
3645 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003646 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003647 return( ret );
3648 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003649 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003650 }
3651
3652 ret = mbedtls_ssl_handle_message_type( ssl );
3653
Hanno Becker40f50842018-08-15 14:48:01 +01003654#if defined(MBEDTLS_SSL_PROTO_DTLS)
3655 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3656 {
3657 /* Buffer future message */
3658 ret = ssl_buffer_message( ssl );
3659 if( ret != 0 )
3660 return( ret );
3661
3662 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3663 }
3664#endif /* MBEDTLS_SSL_PROTO_DTLS */
3665
Hanno Becker90333da2017-10-10 11:27:13 +01003666 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3667 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003668
3669 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003670 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003671 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003672 return( ret );
3673 }
3674
Hanno Becker327c93b2018-08-15 13:56:18 +01003675 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003676 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003677 {
3678 mbedtls_ssl_update_handshake_status( ssl );
3679 }
Simon Butcher99000142016-10-13 17:21:01 +01003680 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003681 else
Simon Butcher99000142016-10-13 17:21:01 +01003682 {
Hanno Becker02f59072018-08-15 14:00:24 +01003683 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003684 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003685 }
3686
3687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3688
3689 return( 0 );
3690}
3691
Hanno Becker40f50842018-08-15 14:48:01 +01003692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003693static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003694{
Hanno Becker40f50842018-08-15 14:48:01 +01003695 if( ssl->in_left > ssl->next_record_offset )
3696 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003697
Hanno Becker40f50842018-08-15 14:48:01 +01003698 return( 0 );
3699}
3700
3701static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3702{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003703 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003704 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003705 int ret = 0;
3706
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003707 if( hs == NULL )
3708 return( -1 );
3709
Hanno Beckere00ae372018-08-20 09:39:42 +01003710 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3711
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003712 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3713 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3714 {
3715 /* Check if we have seen a ChangeCipherSpec before.
3716 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003717 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003718 {
3719 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3720 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003721 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003722 }
3723
Hanno Becker39b8bc92018-08-28 17:17:13 +01003724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003725 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3726 ssl->in_msglen = 1;
3727 ssl->in_msg[0] = 1;
3728
3729 /* As long as they are equal, the exact value doesn't matter. */
3730 ssl->in_left = 0;
3731 ssl->next_record_offset = 0;
3732
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003733 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003734 goto exit;
3735 }
Hanno Becker37f95322018-08-16 13:55:32 +01003736
Hanno Beckerb8f50142018-08-28 10:01:34 +01003737#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003738 /* Debug only */
3739 {
3740 unsigned offset;
3741 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3742 {
3743 hs_buf = &hs->buffering.hs[offset];
3744 if( hs_buf->is_valid == 1 )
3745 {
3746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3747 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003748 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003749 }
3750 }
3751 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003752#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003753
3754 /* Check if we have buffered and/or fully reassembled the
3755 * next handshake message. */
3756 hs_buf = &hs->buffering.hs[0];
3757 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3758 {
3759 /* Synthesize a record containing the buffered HS message. */
3760 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3761 ( hs_buf->data[2] << 8 ) |
3762 hs_buf->data[3];
3763
3764 /* Double-check that we haven't accidentally buffered
3765 * a message that doesn't fit into the input buffer. */
3766 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3767 {
3768 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3769 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3770 }
3771
3772 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3773 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3774 hs_buf->data, msg_len + 12 );
3775
3776 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3777 ssl->in_hslen = msg_len + 12;
3778 ssl->in_msglen = msg_len + 12;
3779 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3780
3781 ret = 0;
3782 goto exit;
3783 }
3784 else
3785 {
3786 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3787 hs->in_msg_seq ) );
3788 }
3789
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003790 ret = -1;
3791
3792exit:
3793
3794 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3795 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003796}
3797
Hanno Beckera02b0b42018-08-21 17:20:27 +01003798static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3799 size_t desired )
3800{
3801 int offset;
3802 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003803 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3804 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003805
Hanno Becker01315ea2018-08-21 17:22:17 +01003806 /* Get rid of future records epoch first, if such exist. */
3807 ssl_free_buffered_record( ssl );
3808
3809 /* Check if we have enough space available now. */
3810 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3811 hs->buffering.total_bytes_buffered ) )
3812 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003814 return( 0 );
3815 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003816
Hanno Becker4f432ad2018-08-28 10:02:32 +01003817 /* We don't have enough space to buffer the next expected handshake
3818 * message. Remove buffers used for future messages to gain space,
3819 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003820 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3821 offset >= 0; offset-- )
3822 {
3823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3824 offset ) );
3825
Hanno Beckerb309b922018-08-23 13:18:05 +01003826 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003827
3828 /* Check if we have enough space available now. */
3829 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3830 hs->buffering.total_bytes_buffered ) )
3831 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003832 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003833 return( 0 );
3834 }
3835 }
3836
3837 return( -1 );
3838}
3839
Hanno Becker40f50842018-08-15 14:48:01 +01003840static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3841{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003842 int ret = 0;
3843 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3844
3845 if( hs == NULL )
3846 return( 0 );
3847
3848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3849
3850 switch( ssl->in_msgtype )
3851 {
3852 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003854
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003855 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003856 break;
3857
3858 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003859 {
3860 unsigned recv_msg_seq_offset;
3861 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3862 mbedtls_ssl_hs_buffer *hs_buf;
3863 size_t msg_len = ssl->in_hslen - 12;
3864
3865 /* We should never receive an old handshake
3866 * message - double-check nonetheless. */
3867 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3868 {
3869 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3870 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3871 }
3872
3873 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3874 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3875 {
3876 /* Silently ignore -- message too far in the future */
3877 MBEDTLS_SSL_DEBUG_MSG( 2,
3878 ( "Ignore future HS message with sequence number %u, "
3879 "buffering window %u - %u",
3880 recv_msg_seq, ssl->handshake->in_msg_seq,
3881 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3882
3883 goto exit;
3884 }
3885
3886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3887 recv_msg_seq, recv_msg_seq_offset ) );
3888
3889 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3890
3891 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003892 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003893 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003894 size_t reassembly_buf_sz;
3895
Hanno Becker37f95322018-08-16 13:55:32 +01003896 hs_buf->is_fragmented =
3897 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3898
3899 /* We copy the message back into the input buffer
3900 * after reassembly, so check that it's not too large.
3901 * This is an implementation-specific limitation
3902 * and not one from the standard, hence it is not
3903 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003904 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003905 {
3906 /* Ignore message */
3907 goto exit;
3908 }
3909
Hanno Beckere0b150f2018-08-21 15:51:03 +01003910 /* Check if we have enough space to buffer the message. */
3911 if( hs->buffering.total_bytes_buffered >
3912 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3913 {
3914 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3915 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3916 }
3917
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003918 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3919 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003920
3921 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3922 hs->buffering.total_bytes_buffered ) )
3923 {
3924 if( recv_msg_seq_offset > 0 )
3925 {
3926 /* If we can't buffer a future message because
3927 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003928 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3929 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3930 " (already %" MBEDTLS_PRINTF_SIZET
3931 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003932 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003933 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003934 goto exit;
3935 }
Hanno Beckere1801392018-08-21 16:51:05 +01003936 else
3937 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003938 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3939 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3940 " (already %" MBEDTLS_PRINTF_SIZET
3941 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003942 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003943 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003944 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003945
Hanno Beckera02b0b42018-08-21 17:20:27 +01003946 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003947 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3949 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3950 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3951 " (already %" MBEDTLS_PRINTF_SIZET
3952 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003953 msg_len,
3954 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003955 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003956 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003957 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3958 goto exit;
3959 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003960 }
3961
Paul Elliottd48d5c62021-01-07 14:47:05 +00003962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003963 msg_len ) );
3964
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003965 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3966 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003967 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003968 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003969 goto exit;
3970 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003971 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003972
3973 /* Prepare final header: copy msg_type, length and message_seq,
3974 * then add standardised fragment_offset and fragment_length */
3975 memcpy( hs_buf->data, ssl->in_msg, 6 );
3976 memset( hs_buf->data + 6, 0, 3 );
3977 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3978
3979 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003980
3981 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003982 }
3983 else
3984 {
3985 /* Make sure msg_type and length are consistent */
3986 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3987 {
3988 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3989 /* Ignore */
3990 goto exit;
3991 }
3992 }
3993
Hanno Becker4422bbb2018-08-20 09:40:19 +01003994 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003995 {
3996 size_t frag_len, frag_off;
3997 unsigned char * const msg = hs_buf->data + 12;
3998
3999 /*
4000 * Check and copy current fragment
4001 */
4002
4003 /* Validation of header fields already done in
4004 * mbedtls_ssl_prepare_handshake_record(). */
4005 frag_off = ssl_get_hs_frag_off( ssl );
4006 frag_len = ssl_get_hs_frag_len( ssl );
4007
Paul Elliottd48d5c62021-01-07 14:47:05 +00004008 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4009 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004010 frag_off, frag_len ) );
4011 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4012
4013 if( hs_buf->is_fragmented )
4014 {
4015 unsigned char * const bitmask = msg + msg_len;
4016 ssl_bitmask_set( bitmask, frag_off, frag_len );
4017 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4018 msg_len ) == 0 );
4019 }
4020 else
4021 {
4022 hs_buf->is_complete = 1;
4023 }
4024
4025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4026 hs_buf->is_complete ? "" : "not yet " ) );
4027 }
4028
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004029 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004030 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004031
4032 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004033 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004034 break;
4035 }
4036
4037exit:
4038
4039 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4040 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004041}
4042#endif /* MBEDTLS_SSL_PROTO_DTLS */
4043
Hanno Becker1097b342018-08-15 14:09:41 +01004044static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004045{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004046 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004047 * Consume last content-layer message and potentially
4048 * update in_msglen which keeps track of the contents'
4049 * consumption state.
4050 *
4051 * (1) Handshake messages:
4052 * Remove last handshake message, move content
4053 * and adapt in_msglen.
4054 *
4055 * (2) Alert messages:
4056 * Consume whole record content, in_msglen = 0.
4057 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004058 * (3) Change cipher spec:
4059 * Consume whole record content, in_msglen = 0.
4060 *
4061 * (4) Application data:
4062 * Don't do anything - the record layer provides
4063 * the application data as a stream transport
4064 * and consumes through mbedtls_ssl_read only.
4065 *
4066 */
4067
4068 /* Case (1): Handshake messages */
4069 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004070 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004071 /* Hard assertion to be sure that no application data
4072 * is in flight, as corrupting ssl->in_msglen during
4073 * ssl->in_offt != NULL is fatal. */
4074 if( ssl->in_offt != NULL )
4075 {
4076 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4077 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4078 }
4079
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004080 /*
4081 * Get next Handshake message in the current record
4082 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004083
Hanno Becker4a810fb2017-05-24 16:27:30 +01004084 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004085 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004086 * current handshake content: If DTLS handshake
4087 * fragmentation is used, that's the fragment
4088 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004089 * size here is faulty and should be changed at
4090 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004091 * (2) While it doesn't seem to cause problems, one
4092 * has to be very careful not to assume that in_hslen
4093 * is always <= in_msglen in a sensible communication.
4094 * Again, it's wrong for DTLS handshake fragmentation.
4095 * The following check is therefore mandatory, and
4096 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004097 * Additionally, ssl->in_hslen might be arbitrarily out of
4098 * bounds after handling a DTLS message with an unexpected
4099 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004100 */
4101 if( ssl->in_hslen < ssl->in_msglen )
4102 {
4103 ssl->in_msglen -= ssl->in_hslen;
4104 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4105 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004106
Hanno Becker4a810fb2017-05-24 16:27:30 +01004107 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4108 ssl->in_msg, ssl->in_msglen );
4109 }
4110 else
4111 {
4112 ssl->in_msglen = 0;
4113 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004114
Hanno Becker4a810fb2017-05-24 16:27:30 +01004115 ssl->in_hslen = 0;
4116 }
4117 /* Case (4): Application data */
4118 else if( ssl->in_offt != NULL )
4119 {
4120 return( 0 );
4121 }
4122 /* Everything else (CCS & Alerts) */
4123 else
4124 {
4125 ssl->in_msglen = 0;
4126 }
4127
Hanno Becker1097b342018-08-15 14:09:41 +01004128 return( 0 );
4129}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004130
Hanno Beckere74d5562018-08-15 14:26:08 +01004131static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4132{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004133 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004134 return( 1 );
4135
4136 return( 0 );
4137}
4138
Hanno Becker5f066e72018-08-16 14:56:31 +01004139#if defined(MBEDTLS_SSL_PROTO_DTLS)
4140
4141static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4142{
4143 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4144 if( hs == NULL )
4145 return;
4146
Hanno Becker01315ea2018-08-21 17:22:17 +01004147 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004148 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004149 hs->buffering.total_bytes_buffered -=
4150 hs->buffering.future_record.len;
4151
4152 mbedtls_free( hs->buffering.future_record.data );
4153 hs->buffering.future_record.data = NULL;
4154 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004155}
4156
4157static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4158{
4159 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4160 unsigned char * rec;
4161 size_t rec_len;
4162 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004163#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4164 size_t in_buf_len = ssl->in_buf_len;
4165#else
4166 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4167#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004168 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4169 return( 0 );
4170
4171 if( hs == NULL )
4172 return( 0 );
4173
Hanno Becker5f066e72018-08-16 14:56:31 +01004174 rec = hs->buffering.future_record.data;
4175 rec_len = hs->buffering.future_record.len;
4176 rec_epoch = hs->buffering.future_record.epoch;
4177
4178 if( rec == NULL )
4179 return( 0 );
4180
Hanno Becker4cb782d2018-08-20 11:19:05 +01004181 /* Only consider loading future records if the
4182 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004183 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004184 return( 0 );
4185
Hanno Becker5f066e72018-08-16 14:56:31 +01004186 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4187
4188 if( rec_epoch != ssl->in_epoch )
4189 {
4190 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4191 goto exit;
4192 }
4193
4194 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4195
4196 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004197 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004198 {
4199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4200 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4201 }
4202
4203 memcpy( ssl->in_hdr, rec, rec_len );
4204 ssl->in_left = rec_len;
4205 ssl->next_record_offset = 0;
4206
4207 ssl_free_buffered_record( ssl );
4208
4209exit:
4210 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4211 return( 0 );
4212}
4213
Hanno Becker519f15d2019-07-11 12:43:20 +01004214static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4215 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004216{
4217 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004218
4219 /* Don't buffer future records outside handshakes. */
4220 if( hs == NULL )
4221 return( 0 );
4222
4223 /* Only buffer handshake records (we are only interested
4224 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004225 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004226 return( 0 );
4227
4228 /* Don't buffer more than one future epoch record. */
4229 if( hs->buffering.future_record.data != NULL )
4230 return( 0 );
4231
Hanno Becker01315ea2018-08-21 17:22:17 +01004232 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004233 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004234 hs->buffering.total_bytes_buffered ) )
4235 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004236 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4237 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4238 " (already %" MBEDTLS_PRINTF_SIZET
4239 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004240 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004241 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004242 return( 0 );
4243 }
4244
Hanno Becker5f066e72018-08-16 14:56:31 +01004245 /* Buffer record */
4246 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004247 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004248 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004249
4250 /* ssl_parse_record_header() only considers records
4251 * of the next epoch as candidates for buffering. */
4252 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004253 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004254
4255 hs->buffering.future_record.data =
4256 mbedtls_calloc( 1, hs->buffering.future_record.len );
4257 if( hs->buffering.future_record.data == NULL )
4258 {
4259 /* If we run out of RAM trying to buffer a
4260 * record from the next epoch, just ignore. */
4261 return( 0 );
4262 }
4263
Hanno Becker519f15d2019-07-11 12:43:20 +01004264 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004265
Hanno Becker519f15d2019-07-11 12:43:20 +01004266 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004267 return( 0 );
4268}
4269
4270#endif /* MBEDTLS_SSL_PROTO_DTLS */
4271
Hanno Beckere74d5562018-08-15 14:26:08 +01004272static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004273{
Janos Follath865b3eb2019-12-16 11:46:15 +00004274 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004275 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004276
Hanno Becker5f066e72018-08-16 14:56:31 +01004277#if defined(MBEDTLS_SSL_PROTO_DTLS)
4278 /* We might have buffered a future record; if so,
4279 * and if the epoch matches now, load it.
4280 * On success, this call will set ssl->in_left to
4281 * the length of the buffered record, so that
4282 * the calls to ssl_fetch_input() below will
4283 * essentially be no-ops. */
4284 ret = ssl_load_buffered_record( ssl );
4285 if( ret != 0 )
4286 return( ret );
4287#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004288
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004289 /* Ensure that we have enough space available for the default form
4290 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4291 * with no space for CIDs counted in). */
4292 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4293 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004294 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004295 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004296 return( ret );
4297 }
4298
Hanno Beckere5e7e782019-07-11 12:29:35 +01004299 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4300 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004301 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004302#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004303 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004304 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004305 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4306 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004307 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004308 if( ret != 0 )
4309 return( ret );
4310
4311 /* Fall through to handling of unexpected records */
4312 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4313 }
4314
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004315 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4316 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004317#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004318 /* Reset in pointers to default state for TLS/DTLS records,
4319 * assuming no CID and no offset between record content and
4320 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004321 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004322
Hanno Becker7ae20e02019-07-12 08:33:49 +01004323 /* Setup internal message pointers from record structure. */
4324 ssl->in_msgtype = rec.type;
4325#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4326 ssl->in_len = ssl->in_cid + rec.cid_len;
4327#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4328 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4329 ssl->in_msglen = rec.data_len;
4330
Hanno Becker2fddd372019-07-10 14:37:41 +01004331 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004332 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004333 if( ret != 0 )
4334 return( ret );
4335#endif
4336
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004337 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004338 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004339
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004340 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4341 "(header)" ) );
4342 }
4343 else
4344 {
4345 /* Skip invalid record and the rest of the datagram */
4346 ssl->next_record_offset = 0;
4347 ssl->in_left = 0;
4348
4349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4350 "(header)" ) );
4351 }
4352
4353 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004354 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004355 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004356 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004357#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004358 {
4359 return( ret );
4360 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004361 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004363#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004364 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004365 {
Hanno Beckera8814792019-07-10 15:01:45 +01004366 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004367 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004368 if( ssl->next_record_offset < ssl->in_left )
4369 {
4370 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4371 }
4372 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004373 else
4374#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004375 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004376 /*
4377 * Fetch record contents from underlying transport.
4378 */
Hanno Beckera3175662019-07-11 12:50:29 +01004379 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004380 if( ret != 0 )
4381 {
4382 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4383 return( ret );
4384 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004385
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004386 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004387 }
4388
4389 /*
4390 * Decrypt record contents.
4391 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004392
Hanno Beckerfdf66042019-07-11 13:07:45 +01004393 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004394 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004395#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004396 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004397 {
4398 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004399 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004400 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004401 /* Except when waiting for Finished as a bad mac here
4402 * probably means something went wrong in the handshake
4403 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4404 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4405 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4406 {
4407#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4408 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4409 {
4410 mbedtls_ssl_send_alert_message( ssl,
4411 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4412 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4413 }
4414#endif
4415 return( ret );
4416 }
4417
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004418 if( ssl->conf->badmac_limit != 0 &&
4419 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004420 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004421 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4422 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004423 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004424
Hanno Becker4a810fb2017-05-24 16:27:30 +01004425 /* As above, invalid records cause
4426 * dismissal of the whole datagram. */
4427
4428 ssl->next_record_offset = 0;
4429 ssl->in_left = 0;
4430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004431 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004432 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004433 }
4434
4435 return( ret );
4436 }
4437 else
4438#endif
4439 {
4440 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004441#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4442 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004443 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004444 mbedtls_ssl_send_alert_message( ssl,
4445 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4446 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004447 }
4448#endif
4449 return( ret );
4450 }
4451 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004452
Hanno Becker44d89b22019-07-12 09:40:44 +01004453
4454 /* Reset in pointers to default state for TLS/DTLS records,
4455 * assuming no CID and no offset between record content and
4456 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004457 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004458#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4459 ssl->in_len = ssl->in_cid + rec.cid_len;
4460#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004461 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004462
Hanno Becker8685c822019-07-12 09:37:30 +01004463 /* The record content type may change during decryption,
4464 * so re-read it. */
4465 ssl->in_msgtype = rec.type;
4466 /* Also update the input buffer, because unfortunately
4467 * the server-side ssl_parse_client_hello() reparses the
4468 * record header when receiving a ClientHello initiating
4469 * a renegotiation. */
4470 ssl->in_hdr[0] = rec.type;
4471 ssl->in_msg = rec.buf + rec.data_offset;
4472 ssl->in_msglen = rec.data_len;
4473 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4474 ssl->in_len[1] = (unsigned char)( rec.data_len );
4475
Simon Butcher99000142016-10-13 17:21:01 +01004476 return( 0 );
4477}
4478
4479int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4480{
Janos Follath865b3eb2019-12-16 11:46:15 +00004481 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004482
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004483 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004484 * Handle particular types of records
4485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004486 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004487 {
Simon Butcher99000142016-10-13 17:21:01 +01004488 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4489 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004490 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004491 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004492 }
4493
Hanno Beckere678eaa2018-08-21 14:57:46 +01004494 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004495 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004496 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004497 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004498 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004499 ssl->in_msglen ) );
4500 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004501 }
4502
Hanno Beckere678eaa2018-08-21 14:57:46 +01004503 if( ssl->in_msg[0] != 1 )
4504 {
4505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4506 ssl->in_msg[0] ) );
4507 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4508 }
4509
4510#if defined(MBEDTLS_SSL_PROTO_DTLS)
4511 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4512 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4513 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4514 {
4515 if( ssl->handshake == NULL )
4516 {
4517 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4518 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4519 }
4520
4521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4522 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4523 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004524#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004525 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004526
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004527 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004528 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004529 if( ssl->in_msglen != 2 )
4530 {
4531 /* Note: Standard allows for more than one 2 byte alert
4532 to be packed in a single message, but Mbed TLS doesn't
4533 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004535 ssl->in_msglen ) );
4536 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4537 }
4538
Paul Elliott9f352112020-12-09 14:55:45 +00004539 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004540 ssl->in_msg[0], ssl->in_msg[1] ) );
4541
4542 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004543 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004545 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004546 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004548 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004550 }
4551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004552 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4553 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004554 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004555 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4556 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004557 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004558
4559#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4560 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4561 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4562 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004564 /* Will be handled when trying to parse ServerHello */
4565 return( 0 );
4566 }
4567#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004568 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004569 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004570 }
4571
Hanno Beckerc76c6192017-06-06 10:03:17 +01004572#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004573 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004574 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004575 /* Drop unexpected ApplicationData records,
4576 * except at the beginning of renegotiations */
4577 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4578 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4579#if defined(MBEDTLS_SSL_RENEGOTIATION)
4580 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4581 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004582#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004583 )
4584 {
4585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4586 return( MBEDTLS_ERR_SSL_NON_FATAL );
4587 }
4588
4589 if( ssl->handshake != NULL &&
4590 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4591 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004592 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004593 }
4594 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004595#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004596
Paul Bakker5121ce52009-01-03 21:22:43 +00004597 return( 0 );
4598}
4599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004600int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004601{
irwir6c0da642019-09-26 21:07:41 +03004602 return( mbedtls_ssl_send_alert_message( ssl,
4603 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4604 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004605}
4606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004607int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004608 unsigned char level,
4609 unsigned char message )
4610{
Janos Follath865b3eb2019-12-16 11:46:15 +00004611 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004612
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004613 if( ssl == NULL || ssl->conf == NULL )
4614 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4615
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004616 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004617 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004620 ssl->out_msglen = 2;
4621 ssl->out_msg[0] = level;
4622 ssl->out_msg[1] = message;
4623
Hanno Becker67bc7c32018-08-06 11:33:50 +01004624 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004625 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004627 return( ret );
4628 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004630
4631 return( 0 );
4632}
4633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004635{
Janos Follath865b3eb2019-12-16 11:46:15 +00004636 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004637
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004638 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004641 ssl->out_msglen = 1;
4642 ssl->out_msg[0] = 1;
4643
Paul Bakker5121ce52009-01-03 21:22:43 +00004644 ssl->state++;
4645
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004646 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004647 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004648 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004649 return( ret );
4650 }
4651
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004652 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004653
4654 return( 0 );
4655}
4656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004658{
Janos Follath865b3eb2019-12-16 11:46:15 +00004659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004662
Hanno Becker327c93b2018-08-15 13:56:18 +01004663 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004664 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004666 return( ret );
4667 }
4668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004669 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004670 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004672 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4673 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004674 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004675 }
4676
Hanno Beckere678eaa2018-08-21 14:57:46 +01004677 /* CCS records are only accepted if they have length 1 and content '1',
4678 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004679
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004680 /*
4681 * Switch to our negotiated transform and session parameters for inbound
4682 * data.
4683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004684 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004685 ssl->transform_in = ssl->transform_negotiate;
4686 ssl->session_in = ssl->session_negotiate;
4687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004688#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004689 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004690 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004691#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004692 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004693#endif
4694
4695 /* Increment epoch */
4696 if( ++ssl->in_epoch == 0 )
4697 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004698 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004699 /* This is highly unlikely to happen for legitimate reasons, so
4700 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004701 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004702 }
4703 }
4704 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004706 memset( ssl->in_ctr, 0, 8 );
4707
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004708 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004709
Paul Bakker5121ce52009-01-03 21:22:43 +00004710 ssl->state++;
4711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004712 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004713
4714 return( 0 );
4715}
4716
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004717/* Once ssl->out_hdr as the address of the beginning of the
4718 * next outgoing record is set, deduce the other pointers.
4719 *
4720 * Note: For TLS, we save the implicit record sequence number
4721 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4722 * and the caller has to make sure there's space for this.
4723 */
4724
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004725static size_t ssl_transform_get_explicit_iv_len(
4726 mbedtls_ssl_transform const *transform )
4727{
TRodziewiczef73f012021-05-13 14:53:36 +02004728 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004729 return( 0 );
4730
4731 return( transform->ivlen - transform->fixed_ivlen );
4732}
4733
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004734void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4735 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004736{
4737#if defined(MBEDTLS_SSL_PROTO_DTLS)
4738 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4739 {
4740 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004741#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004742 ssl->out_cid = ssl->out_ctr + 8;
4743 ssl->out_len = ssl->out_cid;
4744 if( transform != NULL )
4745 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004746#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004747 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004748#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004749 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004750 }
4751 else
4752#endif
4753 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004754 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004755#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004756 ssl->out_cid = ssl->out_len;
4757#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004758 ssl->out_iv = ssl->out_hdr + 5;
4759 }
4760
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004761 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004762 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004763 if( transform != NULL )
4764 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004765}
4766
4767/* Once ssl->in_hdr as the address of the beginning of the
4768 * next incoming record is set, deduce the other pointers.
4769 *
4770 * Note: For TLS, we save the implicit record sequence number
4771 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4772 * and the caller has to make sure there's space for this.
4773 */
4774
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004775void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004776{
Hanno Becker79594fd2019-05-08 09:38:41 +01004777 /* This function sets the pointers to match the case
4778 * of unprotected TLS/DTLS records, with both ssl->in_iv
4779 * and ssl->in_msg pointing to the beginning of the record
4780 * content.
4781 *
4782 * When decrypting a protected record, ssl->in_msg
4783 * will be shifted to point to the beginning of the
4784 * record plaintext.
4785 */
4786
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004787#if defined(MBEDTLS_SSL_PROTO_DTLS)
4788 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4789 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004790 /* This sets the header pointers to match records
4791 * without CID. When we receive a record containing
4792 * a CID, the fields are shifted accordingly in
4793 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004794 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004795#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004796 ssl->in_cid = ssl->in_ctr + 8;
4797 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004798#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004799 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004800#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004801 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004802 }
4803 else
4804#endif
4805 {
4806 ssl->in_ctr = ssl->in_hdr - 8;
4807 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004808#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004809 ssl->in_cid = ssl->in_len;
4810#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004811 ssl->in_iv = ssl->in_hdr + 5;
4812 }
4813
Hanno Becker79594fd2019-05-08 09:38:41 +01004814 /* This will be adjusted at record decryption time. */
4815 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004816}
4817
Paul Bakker5121ce52009-01-03 21:22:43 +00004818/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004819 * Setup an SSL context
4820 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004821
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004822void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004823{
4824 /* Set the incoming and outgoing record pointers. */
4825#if defined(MBEDTLS_SSL_PROTO_DTLS)
4826 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4827 {
4828 ssl->out_hdr = ssl->out_buf;
4829 ssl->in_hdr = ssl->in_buf;
4830 }
4831 else
4832#endif /* MBEDTLS_SSL_PROTO_DTLS */
4833 {
Hanno Becker12078f42021-03-02 15:28:41 +00004834 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004835 ssl->out_hdr = ssl->out_buf + 8;
4836 ssl->in_hdr = ssl->in_buf + 8;
4837 }
4838
4839 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004840 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4841 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004842}
4843
Paul Bakker5121ce52009-01-03 21:22:43 +00004844/*
4845 * SSL get accessors
4846 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004847size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004848{
4849 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4850}
4851
Hanno Becker8b170a02017-10-10 11:51:19 +01004852int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4853{
4854 /*
4855 * Case A: We're currently holding back
4856 * a message for further processing.
4857 */
4858
4859 if( ssl->keep_current_message == 1 )
4860 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004861 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004862 return( 1 );
4863 }
4864
4865 /*
4866 * Case B: Further records are pending in the current datagram.
4867 */
4868
4869#if defined(MBEDTLS_SSL_PROTO_DTLS)
4870 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4871 ssl->in_left > ssl->next_record_offset )
4872 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004873 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004874 return( 1 );
4875 }
4876#endif /* MBEDTLS_SSL_PROTO_DTLS */
4877
4878 /*
4879 * Case C: A handshake message is being processed.
4880 */
4881
Hanno Becker8b170a02017-10-10 11:51:19 +01004882 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4883 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004884 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004885 return( 1 );
4886 }
4887
4888 /*
4889 * Case D: An application data message is being processed
4890 */
4891 if( ssl->in_offt != NULL )
4892 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004893 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004894 return( 1 );
4895 }
4896
4897 /*
4898 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004899 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004900 * we implement support for multiple alerts in single records.
4901 */
4902
4903 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4904 return( 0 );
4905}
4906
Paul Bakker43ca69c2011-01-15 17:35:19 +00004907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004908int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004909{
Hanno Becker3136ede2018-08-17 15:28:19 +01004910 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004912 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004913
Hanno Becker5903de42019-05-03 14:46:38 +01004914 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4915
Hanno Becker78640902018-08-13 16:35:15 +01004916 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004917 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004919 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004920 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004921 case MBEDTLS_MODE_GCM:
4922 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004923 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004925 transform_expansion = transform->minlen;
4926 break;
4927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004928 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004929
4930 block_size = mbedtls_cipher_get_block_size(
4931 &transform->cipher_ctx_enc );
4932
Hanno Becker3136ede2018-08-17 15:28:19 +01004933 /* Expansion due to the addition of the MAC. */
4934 transform_expansion += transform->maclen;
4935
4936 /* Expansion due to the addition of CBC padding;
4937 * Theoretically up to 256 bytes, but we never use
4938 * more than the block size of the underlying cipher. */
4939 transform_expansion += block_size;
4940
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004941 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004942 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004943#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004944 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004945#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004946
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004947 break;
4948
4949 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004950 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004951 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004952 }
4953
Hanno Beckera0e20d02019-05-15 14:03:01 +01004954#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004955 if( transform->out_cid_len != 0 )
4956 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004957#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004958
Hanno Becker5903de42019-05-03 14:46:38 +01004959 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004960}
4961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004962#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004963/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004964 * Check record counters and renegotiate if they're above the limit.
4965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004967{
Hanno Beckerdd772292020-02-05 10:38:31 +00004968 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004969 int in_ctr_cmp;
4970 int out_ctr_cmp;
4971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4973 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004974 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004975 {
4976 return( 0 );
4977 }
4978
Andres AG2196c7f2016-12-15 17:01:16 +00004979 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
4980 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01004981 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00004982 ssl->conf->renego_period + ep_len, 8 - ep_len );
4983
4984 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004985 {
4986 return( 0 );
4987 }
4988
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004989 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004990 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004991}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004992#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004993
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004994/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004995 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004996 * may only be sent for the purpose of initiating renegotiations.
4997 *
4998 * This function is introduced as a separate helper since the handling
4999 * of post-handshake handshake messages changes significantly in TLS 1.3,
5000 * and having a helper function allows to distinguish between TLS <= 1.2 and
5001 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5002 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005003static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005004{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005006
5007 /*
5008 * - For client-side, expect SERVER_HELLO_REQUEST.
5009 * - For server-side, expect CLIENT_HELLO.
5010 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5011 */
5012
5013#if defined(MBEDTLS_SSL_CLI_C)
5014 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5015 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5016 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5017 {
5018 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5019
5020 /* With DTLS, drop the packet (probably from last handshake) */
5021#if defined(MBEDTLS_SSL_PROTO_DTLS)
5022 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5023 {
5024 return( 0 );
5025 }
5026#endif
5027 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5028 }
5029#endif /* MBEDTLS_SSL_CLI_C */
5030
5031#if defined(MBEDTLS_SSL_SRV_C)
5032 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5033 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5034 {
5035 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5036
5037 /* With DTLS, drop the packet (probably from last handshake) */
5038#if defined(MBEDTLS_SSL_PROTO_DTLS)
5039 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5040 {
5041 return( 0 );
5042 }
5043#endif
5044 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5045 }
5046#endif /* MBEDTLS_SSL_SRV_C */
5047
5048#if defined(MBEDTLS_SSL_RENEGOTIATION)
5049 /* Determine whether renegotiation attempt should be accepted */
5050 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5051 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5052 ssl->conf->allow_legacy_renegotiation ==
5053 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5054 {
5055 /*
5056 * Accept renegotiation request
5057 */
5058
5059 /* DTLS clients need to know renego is server-initiated */
5060#if defined(MBEDTLS_SSL_PROTO_DTLS)
5061 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5062 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5063 {
5064 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5065 }
5066#endif
5067 ret = mbedtls_ssl_start_renegotiation( ssl );
5068 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5069 ret != 0 )
5070 {
5071 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5072 ret );
5073 return( ret );
5074 }
5075 }
5076 else
5077#endif /* MBEDTLS_SSL_RENEGOTIATION */
5078 {
5079 /*
5080 * Refuse renegotiation
5081 */
5082
5083 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5084
TRodziewicz0f82ec62021-05-12 17:49:18 +02005085#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005086 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5087 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5088 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005089 {
TRodziewicz345165c2021-07-06 13:42:11 +02005090 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005091 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005092#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005093 }
5094
5095 return( 0 );
5096}
5097
Paul Bakker48916f92012-09-16 19:57:18 +00005098/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005099 * Receive application data decrypted from the SSL layer
5100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005101int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005102{
Janos Follath865b3eb2019-12-16 11:46:15 +00005103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005104 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005105
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005106 if( ssl == NULL || ssl->conf == NULL )
5107 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005111#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005112 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005113 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005114 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005115 return( ret );
5116
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005117 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005118 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005119 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005120 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005121 return( ret );
5122 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005123 }
5124#endif
5125
Hanno Becker4a810fb2017-05-24 16:27:30 +01005126 /*
5127 * Check if renegotiation is necessary and/or handshake is
5128 * in process. If yes, perform/continue, and fall through
5129 * if an unexpected packet is received while the client
5130 * is waiting for the ServerHello.
5131 *
5132 * (There is no equivalent to the last condition on
5133 * the server-side as it is not treated as within
5134 * a handshake while waiting for the ClientHello
5135 * after a renegotiation request.)
5136 */
5137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005138#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005139 ret = ssl_check_ctr_renegotiate( ssl );
5140 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5141 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005142 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005143 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005144 return( ret );
5145 }
5146#endif
5147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005148 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005149 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005150 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005151 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5152 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005153 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005155 return( ret );
5156 }
5157 }
5158
Hanno Beckere41158b2017-10-23 13:30:32 +01005159 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005160 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005161 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005162 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005163 if( ssl->f_get_timer != NULL &&
5164 ssl->f_get_timer( ssl->p_timer ) == -1 )
5165 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005166 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005167 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005168
Hanno Becker327c93b2018-08-15 13:56:18 +01005169 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005170 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005171 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5172 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005173
Hanno Becker4a810fb2017-05-24 16:27:30 +01005174 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5175 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005176 }
5177
5178 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005179 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005180 {
5181 /*
5182 * OpenSSL sends empty messages to randomize the IV
5183 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005184 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005185 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005186 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005187 return( 0 );
5188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005189 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005190 return( ret );
5191 }
5192 }
5193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005194 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005195 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005196 ret = ssl_handle_hs_message_post_handshake( ssl );
5197 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005198 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005199 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5200 ret );
5201 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005202 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005203
Hanno Beckerf26cc722021-04-21 07:30:13 +01005204 /* At this point, we don't know whether the renegotiation triggered
5205 * by the post-handshake message has been completed or not. The cases
5206 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005207 * 1) The renegotiation is complete. In this case, no new record
5208 * has been read yet.
5209 * 2) The renegotiation is incomplete because the client received
5210 * an application data record while awaiting the ServerHello.
5211 * 3) The renegotiation is incomplete because the client received
5212 * a non-handshake, non-application data message while awaiting
5213 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005214 *
5215 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005216 * - For 1), the next iteration will read a new record and check
5217 * if it's application data.
5218 * - For 2), the loop condition isn't satisfied as application data
5219 * is present, hence continue is the same as break
5220 * - For 3), the loop condition is satisfied and read_record
5221 * will re-deliver the message that was held back by the client
5222 * when expecting the ServerHello.
5223 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005224
Hanno Becker90333da2017-10-10 11:27:13 +01005225 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005226 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005227#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005228 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005229 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005230 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005231 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005232 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005233 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005234 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005235 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005236 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005237 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005238 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005239 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005240#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005242 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5243 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005244 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005246 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005247 }
5248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005249 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005250 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005251 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5252 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005253 }
5254
5255 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005256
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005257 /* We're going to return something now, cancel timer,
5258 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005259 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005260 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005261
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005262#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005263 /* If we requested renego but received AppData, resend HelloRequest.
5264 * Do it now, after setting in_offt, to avoid taking this branch
5265 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005266#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005267 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005269 {
Hanno Becker786300f2020-02-05 10:46:40 +00005270 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005271 {
Hanno Becker786300f2020-02-05 10:46:40 +00005272 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5273 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005274 return( ret );
5275 }
5276 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005277#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005278#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005279 }
5280
5281 n = ( len < ssl->in_msglen )
5282 ? len : ssl->in_msglen;
5283
5284 memcpy( buf, ssl->in_offt, n );
5285 ssl->in_msglen -= n;
5286
gabor-mezei-arma3214132020-07-15 10:55:00 +02005287 /* Zeroising the plaintext buffer to erase unused application data
5288 from the memory. */
5289 mbedtls_platform_zeroize( ssl->in_offt, n );
5290
Paul Bakker5121ce52009-01-03 21:22:43 +00005291 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005292 {
5293 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005294 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005295 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005296 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005297 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005298 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005299 /* more data available */
5300 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005301 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005303 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005304
Paul Bakker23986e52011-04-24 08:57:21 +00005305 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005306}
5307
5308/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005309 * Send application data to be encrypted by the SSL layer, taking care of max
5310 * fragment length and buffer size.
5311 *
5312 * According to RFC 5246 Section 6.2.1:
5313 *
5314 * Zero-length fragments of Application data MAY be sent as they are
5315 * potentially useful as a traffic analysis countermeasure.
5316 *
5317 * Therefore, it is possible that the input message length is 0 and the
5318 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005319 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005320static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005321 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005322{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005323 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5324 const size_t max_len = (size_t) ret;
5325
5326 if( ret < 0 )
5327 {
5328 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5329 return( ret );
5330 }
5331
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005332 if( len > max_len )
5333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005334#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005335 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005336 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005338 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5339 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005340 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005341 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005342 }
5343 else
5344#endif
5345 len = max_len;
5346 }
Paul Bakker887bd502011-06-08 13:10:54 +00005347
Paul Bakker5121ce52009-01-03 21:22:43 +00005348 if( ssl->out_left != 0 )
5349 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005350 /*
5351 * The user has previously tried to send the data and
5352 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5353 * written. In this case, we expect the high-level write function
5354 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005356 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005357 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005358 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005359 return( ret );
5360 }
5361 }
Paul Bakker887bd502011-06-08 13:10:54 +00005362 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005363 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005364 /*
5365 * The user is trying to send a message the first time, so we need to
5366 * copy the data into the internal buffers and setup the data structure
5367 * to keep track of partial writes
5368 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005369 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005370 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005371 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005372
Hanno Becker67bc7c32018-08-06 11:33:50 +01005373 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005374 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005375 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005376 return( ret );
5377 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005378 }
5379
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005380 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005381}
5382
5383/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005384 * Write application data (public-facing wrapper)
5385 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005386int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005387{
Janos Follath865b3eb2019-12-16 11:46:15 +00005388 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005389
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005390 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005391
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005392 if( ssl == NULL || ssl->conf == NULL )
5393 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5394
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005395#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005396 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5397 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005398 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005399 return( ret );
5400 }
5401#endif
5402
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005403 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005404 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005405 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005406 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005407 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005408 return( ret );
5409 }
5410 }
5411
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005412 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005413
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005414 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005415
5416 return( ret );
5417}
5418
5419/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005420 * Notify the peer that the connection is being closed
5421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005423{
Janos Follath865b3eb2019-12-16 11:46:15 +00005424 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005425
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005426 if( ssl == NULL || ssl->conf == NULL )
5427 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005429 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005430
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005431 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005435 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5437 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5438 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005440 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005441 return( ret );
5442 }
5443 }
5444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005446
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005447 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005448}
5449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005451{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005452 if( transform == NULL )
5453 return;
5454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5456 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005457
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005458#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005459 mbedtls_md_free( &transform->md_ctx_enc );
5460 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005461#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005462
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005463 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005464}
5465
Hanno Becker0271f962018-08-16 13:23:47 +01005466#if defined(MBEDTLS_SSL_PROTO_DTLS)
5467
Hanno Becker533ab5f2020-02-05 10:49:13 +00005468void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005469{
5470 unsigned offset;
5471 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5472
5473 if( hs == NULL )
5474 return;
5475
Hanno Becker283f5ef2018-08-24 09:34:47 +01005476 ssl_free_buffered_record( ssl );
5477
Hanno Becker0271f962018-08-16 13:23:47 +01005478 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005479 ssl_buffering_free_slot( ssl, offset );
5480}
5481
5482static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5483 uint8_t slot )
5484{
5485 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5486 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005487
5488 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5489 return;
5490
Hanno Beckere605b192018-08-21 15:59:07 +01005491 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005492 {
Hanno Beckere605b192018-08-21 15:59:07 +01005493 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005494 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005495 mbedtls_free( hs_buf->data );
5496 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005497 }
5498}
5499
5500#endif /* MBEDTLS_SSL_PROTO_DTLS */
5501
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005502/*
5503 * Convert version numbers to/from wire format
5504 * and, for DTLS, to/from TLS equivalent.
5505 *
5506 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005507 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005508 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005510void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005511 unsigned char ver[2] )
5512{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005513#if defined(MBEDTLS_SSL_PROTO_DTLS)
5514 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005515 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005517 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5518
5519 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5520 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5521 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005522 else
5523#else
5524 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005525#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005526 {
5527 ver[0] = (unsigned char) major;
5528 ver[1] = (unsigned char) minor;
5529 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005530}
5531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005532void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005533 const unsigned char ver[2] )
5534{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005535#if defined(MBEDTLS_SSL_PROTO_DTLS)
5536 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005537 {
5538 *major = 255 - ver[0] + 2;
5539 *minor = 255 - ver[1] + 1;
5540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005541 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005542 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5543 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005544 else
5545#else
5546 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005547#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005548 {
5549 *major = ver[0];
5550 *minor = ver[1];
5551 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005552}
5553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554#endif /* MBEDTLS_SSL_TLS_C */