blob: 94f263d0042e7a1606578377ffac3424fe7e09b0 [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 mask generation for "greater or equal" comparison:
944 * - if x >= y, return all bits 1, that is (size_t) -1
945 * - otherwise, return all bits 0, that is 0
946 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200947 * This function can be used to write constant-time code by replacing branches
948 * with bit operations using masks.
949 *
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_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200954{
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200955 return( ~mbedtls_cf_size_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200956}
957
958/*
959 * Constant-flow boolean "equal" comparison:
960 * return x == y
961 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200962 * This function can be used to write constant-time code by replacing branches
963 * with bit operations - it can be used in conjunction with
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200964 * mbedtls_cf_size_mask().
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200965 *
966 * This function is implemented without using comparison operators, as those
967 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200968 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200969static size_t mbedtls_cf_size_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200970{
971 /* diff = 0 if x == y, non-zero otherwise */
972 const size_t diff = x ^ y;
973
974 /* MSVC has a warning about unary minus on unsigned integer types,
975 * but this is well-defined and precisely what we want to do here. */
976#if defined(_MSC_VER)
977#pragma warning( push )
978#pragma warning( disable : 4146 )
979#endif
980
981 /* diff_msb's most significant bit is equal to x != y */
982 const size_t diff_msb = ( diff | -diff );
983
984#if defined(_MSC_VER)
985#pragma warning( pop )
986#endif
987
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200988 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200989 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
990
991 return( 1 ^ diff1 );
992}
993
994/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200995 * Constant-flow conditional memcpy:
996 * - if c1 == c2, equivalent to memcpy(dst, src, len),
997 * - otherwise, a no-op,
998 * but with execution flow independent of the values of c1 and c2.
999 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001000 * This function is implemented without using comparison operators, as those
1001 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001002 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001003static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
1004 const unsigned char *src,
1005 size_t len,
1006 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001007{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001008 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001009 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
1010 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001011
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001012 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001013 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001014 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001015}
1016
1017/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001018 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001019 *
1020 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1021 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001022 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001023MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001024 mbedtls_md_context_t *ctx,
1025 const unsigned char *add_data, size_t add_data_len,
1026 const unsigned char *data, size_t data_len_secret,
1027 size_t min_data_len, size_t max_data_len,
1028 unsigned char *output )
1029{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001030 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001031 * This function breaks the HMAC abstraction and uses the md_clone()
1032 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001033 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001034 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001035 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001036 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001037 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001038 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1039 * minlen, then cloning the context, and for each byte up to maxlen
1040 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001041 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001042 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001043 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001044 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +02001045 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001046 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001047 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001048 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001049 const unsigned char * const okey = ikey + block_size;
1050 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001051
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001052 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1053 mbedtls_md_context_t aux;
1054 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001056
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001057 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001058
1059#define MD_CHK( func_call ) \
1060 do { \
1061 ret = (func_call); \
1062 if( ret != 0 ) \
1063 goto cleanup; \
1064 } while( 0 )
1065
1066 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001067
1068 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1069 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001070 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1071 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001072
1073 /* For each possible length, compute the hash up to that point */
1074 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001075 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001076 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1077 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001078 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001079 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1080 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001081
1082 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001083 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001084 }
1085
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001086 /* The context needs to finish() before it starts() again */
1087 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1088
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001089 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001090 MD_CHK( mbedtls_md_starts( ctx ) );
1091 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1092 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1093 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001094
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001095 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001096 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001097
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001098#undef MD_CHK
1099
1100cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001101 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001102 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001103}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001104
1105/*
1106 * Constant-flow memcpy from variable position in buffer.
1107 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001108 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001109 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001110MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001111 unsigned char *dst,
1112 const unsigned char *src_base,
1113 size_t offset_secret,
1114 size_t offset_min, size_t offset_max,
1115 size_t len )
1116{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001117 size_t offset;
1118
1119 for( offset = offset_min; offset <= offset_max; offset++ )
1120 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001121 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1122 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001123 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001124}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001125#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001126
Hanno Becker605949f2019-07-12 08:23:59 +01001127int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001128 mbedtls_ssl_transform *transform,
1129 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001130{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001131 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001133 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001134#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001135 size_t padlen = 0, correct = 1;
1136#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001137 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001138 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001139 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001140
Hanno Beckera18d1322018-01-03 14:27:32 +00001141#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001142 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001143 ((void) ssl);
1144#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001146 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001147 if( rec == NULL ||
1148 rec->buf == NULL ||
1149 rec->buf_len < rec->data_offset ||
1150 rec->buf_len - rec->data_offset < rec->data_len )
1151 {
1152 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001154 }
1155
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001156 data = rec->buf + rec->data_offset;
1157 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001158
Hanno Beckera0e20d02019-05-15 14:03:01 +01001159#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001160 /*
1161 * Match record's CID with incoming CID.
1162 */
Hanno Becker938489a2019-05-08 13:02:22 +01001163 if( rec->cid_len != transform->in_cid_len ||
1164 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1165 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001166 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001167 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001168#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001169
Hanno Beckerd086bf02021-03-22 13:01:27 +00001170#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001172 {
1173 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001174 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1175 transform->iv_dec,
1176 transform->ivlen,
1177 data, rec->data_len,
1178 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001179 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001181 return( ret );
1182 }
1183
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001184 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001185 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1187 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001188 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001189 }
Paul Bakker68884e32013-01-07 18:20:04 +01001190 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001191#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001192#if defined(MBEDTLS_GCM_C) || \
1193 defined(MBEDTLS_CCM_C) || \
1194 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001196 mode == MBEDTLS_MODE_CCM ||
1197 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001198 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001199 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001200 unsigned char *dynamic_iv;
1201 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001202
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001203 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001204 * Extract dynamic part of nonce for AEAD decryption.
1205 *
1206 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1207 * part of the IV is prepended to the ciphertext and
1208 * can be chosen freely - in particular, it need not
1209 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001210 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001211 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001212 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001213 {
1214 if( rec->data_len < dynamic_iv_len )
1215 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001216 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1217 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001218 rec->data_len,
1219 dynamic_iv_len ) );
1220 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1221 }
1222 dynamic_iv = data;
1223
1224 data += dynamic_iv_len;
1225 rec->data_offset += dynamic_iv_len;
1226 rec->data_len -= dynamic_iv_len;
1227 }
Hanno Becker17263802020-05-28 07:05:48 +01001228 else
1229 {
1230 dynamic_iv = rec->ctr;
1231 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001232
1233 /* Check that there's space for the authentication tag. */
1234 if( rec->data_len < transform->taglen )
1235 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001236 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1237 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001238 rec->data_len,
1239 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001241 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001242 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001243
Hanno Beckerdf8be222020-05-21 15:30:57 +01001244 /*
1245 * Prepare nonce from dynamic and static parts.
1246 */
Hanno Becker17263802020-05-28 07:05:48 +01001247 ssl_build_record_nonce( iv, sizeof( iv ),
1248 transform->iv_dec,
1249 transform->fixed_ivlen,
1250 dynamic_iv,
1251 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001252
Hanno Beckerdf8be222020-05-21 15:30:57 +01001253 /*
1254 * Build additional data for AEAD encryption.
1255 * This depends on the TLS version.
1256 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001257 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1258 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001259 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001260 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001261
Hanno Beckerd96a6522019-07-10 13:55:25 +01001262 /* Because of the check above, we know that there are
1263 * explicit_iv_len Bytes preceeding data, and taglen
1264 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001265 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001266 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001267
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001268 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001269 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001270 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001271
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001272 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001273 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001274 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001275 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001276 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001277 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001278 data, rec->data_len + transform->taglen, /* src */
1279 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001280 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001281 {
TRodziewicz18efb732021-04-29 23:12:19 +02001282 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1285 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001286
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001287 return( ret );
1288 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001289 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001290
Hanno Beckerd96a6522019-07-10 13:55:25 +01001291 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001292 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001293 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1295 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001296 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001297 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001298 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001300#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001302 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001303 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001304
Paul Bakker5121ce52009-01-03 21:22:43 +00001305 /*
Paul Bakker45829992013-01-03 14:52:21 +01001306 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001308#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001309 /* The ciphertext is prefixed with the CBC IV. */
1310 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001311#endif
Paul Bakker45829992013-01-03 14:52:21 +01001312
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001313 /* Size considerations:
1314 *
1315 * - The CBC cipher text must not be empty and hence
1316 * at least of size transform->ivlen.
1317 *
1318 * Together with the potential IV-prefix, this explains
1319 * the first of the two checks below.
1320 *
1321 * - The record must contain a MAC, either in plain or
1322 * encrypted, depending on whether Encrypt-then-MAC
1323 * is used or not.
1324 * - If it is, the message contains the IV-prefix,
1325 * the CBC ciphertext, and the MAC.
1326 * - If it is not, the padded plaintext, and hence
1327 * the CBC ciphertext, has at least length maclen + 1
1328 * because there is at least the padding length byte.
1329 *
1330 * As the CBC ciphertext is not empty, both cases give the
1331 * lower bound minlen + maclen + 1 on the record size, which
1332 * we test for in the second check below.
1333 */
1334 if( rec->data_len < minlen + transform->ivlen ||
1335 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001336 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001337 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1338 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1339 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001340 "+ 1 ) ( + expl IV )", rec->data_len,
1341 transform->ivlen,
1342 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001343 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001344 }
1345
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001346 /*
1347 * Authenticate before decrypt if enabled
1348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001350 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001351 {
Hanno Becker992b6872017-11-09 18:57:39 +00001352 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001355
Hanno Beckerd96a6522019-07-10 13:55:25 +01001356 /* Update data_len in tandem with add_data.
1357 *
1358 * The subtraction is safe because of the previous check
1359 * data_len >= minlen + maclen + 1.
1360 *
1361 * Afterwards, we know that data + data_len is followed by at
1362 * least maclen Bytes, which justifies the call to
1363 * mbedtls_ssl_safer_memcmp() below.
1364 *
1365 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001366 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001367 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1368 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001369
Hanno Beckerd96a6522019-07-10 13:55:25 +01001370 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001371 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1372 add_data_len );
1373 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1374 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001375 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1376 data, rec->data_len );
1377 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1378 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001379
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001380 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1381 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001382 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001383 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001384
Hanno Beckerd96a6522019-07-10 13:55:25 +01001385 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001386 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1387 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001391 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001392 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001393 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001395
1396 /*
1397 * Check length sanity
1398 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001399
1400 /* We know from above that data_len > minlen >= 0,
1401 * so the following check in particular implies that
1402 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001403 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001404 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001405 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1406 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001407 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001408 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001409 }
1410
TRodziewicz0f82ec62021-05-12 17:49:18 +02001411#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001412 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001413 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001414 */
TRodziewicz345165c2021-07-06 13:42:11 +02001415 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1416 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001417
TRodziewicz345165c2021-07-06 13:42:11 +02001418 data += transform->ivlen;
1419 rec->data_offset += transform->ivlen;
1420 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001422
Hanno Beckerd96a6522019-07-10 13:55:25 +01001423 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1424
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001425 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1426 transform->iv_dec, transform->ivlen,
1427 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001428 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001429 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001430 return( ret );
1431 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001432
Hanno Beckerd96a6522019-07-10 13:55:25 +01001433 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001434 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001435 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1437 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001438 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001439
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001440 /* Safe since data_len >= minlen + maclen + 1, so after having
1441 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001442 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1443 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001444 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001445
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001446 if( auth_done == 1 )
1447 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001448 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001449 rec->data_len,
1450 padlen + 1 );
1451 correct &= mask;
1452 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001453 }
1454 else
Paul Bakker45829992013-01-03 14:52:21 +01001455 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001457 if( rec->data_len < transform->maclen + padlen + 1 )
1458 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1460 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1461 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001462 rec->data_len,
1463 transform->maclen,
1464 padlen + 1 ) );
1465 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001466#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001467
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001468 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001469 rec->data_len,
1470 transform->maclen + padlen + 1 );
1471 correct &= mask;
1472 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001473 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001474
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001475 padlen++;
1476
1477 /* Regardless of the validity of the padding,
1478 * we have data_len >= padlen here. */
1479
TRodziewicz0f82ec62021-05-12 17:49:18 +02001480#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001481 /* The padding check involves a series of up to 256
1482 * consecutive memory reads at the end of the record
1483 * plaintext buffer. In order to hide the length and
1484 * validity of the padding, always perform exactly
1485 * `min(256,plaintext_len)` reads (but take into account
1486 * only the last `padlen` bytes for the padding check). */
1487 size_t pad_count = 0;
1488 volatile unsigned char* const check = data;
1489
1490 /* Index of first padding byte; it has been ensured above
1491 * that the subtraction is safe. */
1492 size_t const padding_idx = rec->data_len - padlen;
1493 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1494 size_t const start_idx = rec->data_len - num_checks;
1495 size_t idx;
1496
1497 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001498 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001499 /* pad_count += (idx >= padding_idx) &&
1500 * (check[idx] == padlen - 1);
1501 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001502 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1503 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1504 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001505 pad_count += mask & equal;
1506 }
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001507 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001509#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001510 if( padlen > 0 && correct == 0 )
1511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001512#endif
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001513 padlen &= mbedtls_cf_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001514
TRodziewicz0f82ec62021-05-12 17:49:18 +02001515#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001516
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001517 /* If the padding was found to be invalid, padlen == 0
1518 * and the subtraction is safe. If the padding was found valid,
1519 * padlen hasn't been changed and the previous assertion
1520 * data_len >= padlen still holds. */
1521 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001522 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001523 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001524#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001525 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1527 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001528 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001529
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001530#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001533#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001534
1535 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001536 * Authenticate if not done yet.
1537 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001538 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001539#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001540 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001541 {
Hanno Becker992b6872017-11-09 18:57:39 +00001542 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001543 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001544
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001545 /* If the initial value of padlen was such that
1546 * data_len < maclen + padlen + 1, then padlen
1547 * got reset to 1, and the initial check
1548 * data_len >= minlen + maclen + 1
1549 * guarantees that at this point we still
1550 * have at least data_len >= maclen.
1551 *
1552 * If the initial value of padlen was such that
1553 * data_len >= maclen + padlen + 1, then we have
1554 * subtracted either padlen + 1 (if the padding was correct)
1555 * or 0 (if the padding was incorrect) since then,
1556 * hence data_len >= maclen in any case.
1557 */
1558 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001559 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1560 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001561
TRodziewicz0f82ec62021-05-12 17:49:18 +02001562#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001563 /*
1564 * The next two sizes are the minimum and maximum values of
1565 * data_len over all padlen values.
1566 *
1567 * They're independent of padlen, since we previously did
1568 * data_len -= padlen.
1569 *
1570 * Note that max_len + maclen is never more than the buffer
1571 * length, as we previously did in_msglen -= maclen too.
1572 */
1573 const size_t max_len = rec->data_len + padlen;
1574 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1575
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001576 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1577 add_data, add_data_len,
1578 data, rec->data_len, min_len, max_len,
1579 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001580 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001581 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001582 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cf_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001583 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001584 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001585
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001586 mbedtls_cf_memcpy_offset( mac_peer, data,
1587 rec->data_len,
1588 min_len, max_len,
1589 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001590#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001591
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001592#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001593 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001594 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001595#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001596
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001597 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001598 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001599 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600#if defined(MBEDTLS_SSL_DEBUG_ALL)
1601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001602#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001603 correct = 0;
1604 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001605 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001606 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001607
1608 /*
1609 * Finally check the correct flag
1610 */
1611 if( correct == 0 )
1612 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001613#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001614
1615 /* Make extra sure authentication was performed, exactly once */
1616 if( auth_done != 1 )
1617 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001618 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1619 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001620 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001621
Hanno Beckerccc13d02020-05-04 12:30:04 +01001622#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1623 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1624 {
1625 /* Remove inner padding and infer true content type. */
1626 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1627 &rec->type );
1628
1629 if( ret != 0 )
1630 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1631 }
1632#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1633
Hanno Beckera0e20d02019-05-15 14:03:01 +01001634#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001635 if( rec->cid_len != 0 )
1636 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001637 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1638 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001639 if( ret != 0 )
1640 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1641 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001642#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001645
1646 return( 0 );
1647}
1648
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001649#undef MAC_NONE
1650#undef MAC_PLAINTEXT
1651#undef MAC_CIPHERTEXT
1652
Paul Bakker5121ce52009-01-03 21:22:43 +00001653/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001654 * Fill the input message buffer by appending data to it.
1655 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001656 *
1657 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1658 * available (from this read and/or a previous one). Otherwise, an error code
1659 * is returned (possibly EOF or WANT_READ).
1660 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001661 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1662 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1663 * since we always read a whole datagram at once.
1664 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001665 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001666 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001669{
Janos Follath865b3eb2019-12-16 11:46:15 +00001670 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001671 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001672#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1673 size_t in_buf_len = ssl->in_buf_len;
1674#else
1675 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1676#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001679
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001680 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001683 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001685 }
1686
Darryl Greenb33cc762019-11-28 14:29:44 +00001687 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1690 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001691 }
1692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001694 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001695 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001696 uint32_t timeout;
1697
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001698 /*
1699 * The point is, we need to always read a full datagram at once, so we
1700 * sometimes read more then requested, and handle the additional data.
1701 * It could be the rest of the current record (while fetching the
1702 * header) and/or some other records in the same datagram.
1703 */
1704
1705 /*
1706 * Move to the next record in the already read datagram if applicable
1707 */
1708 if( ssl->next_record_offset != 0 )
1709 {
1710 if( ssl->in_left < ssl->next_record_offset )
1711 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1713 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001714 }
1715
1716 ssl->in_left -= ssl->next_record_offset;
1717
1718 if( ssl->in_left != 0 )
1719 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001720 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1721 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001722 ssl->next_record_offset ) );
1723 memmove( ssl->in_hdr,
1724 ssl->in_hdr + ssl->next_record_offset,
1725 ssl->in_left );
1726 }
1727
1728 ssl->next_record_offset = 0;
1729 }
1730
Paul Elliottd48d5c62021-01-07 14:47:05 +00001731 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1732 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001733 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001734
1735 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001736 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001737 */
1738 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001739 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001740 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001741 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001742 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001743
1744 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001745 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001746 * are not at the beginning of a new record, the caller did something
1747 * wrong.
1748 */
1749 if( ssl->in_left != 0 )
1750 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1752 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001753 }
1754
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001755 /*
1756 * Don't even try to read if time's out already.
1757 * This avoids by-passing the timer when repeatedly receiving messages
1758 * that will end up being dropped.
1759 */
Hanno Becker7876d122020-02-05 10:39:31 +00001760 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001761 {
1762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001763 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001764 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001765 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001766 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001767 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001770 timeout = ssl->handshake->retransmit_timeout;
1771 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001772 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001773
Paul Elliott9f352112020-12-09 14:55:45 +00001774 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001775
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001776 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001777 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1778 timeout );
1779 else
1780 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001783
1784 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001786 }
1787
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001788 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001789 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001791 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001794 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001795 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001798 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001799 }
1800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001802 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001804 return( ret );
1805 }
1806
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001807 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001808 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001810 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001812 {
Hanno Becker786300f2020-02-05 10:46:40 +00001813 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001814 {
Hanno Becker786300f2020-02-05 10:46:40 +00001815 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1816 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001817 return( ret );
1818 }
1819
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001820 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001821 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001823 }
1824
Paul Bakker5121ce52009-01-03 21:22:43 +00001825 if( ret < 0 )
1826 return( ret );
1827
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001828 ssl->in_left = ret;
1829 }
1830 else
1831#endif
1832 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1834 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001835 ssl->in_left, nb_want ) );
1836
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001837 while( ssl->in_left < nb_want )
1838 {
1839 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001840
Hanno Becker7876d122020-02-05 10:39:31 +00001841 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001842 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1843 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001844 {
1845 if( ssl->f_recv_timeout != NULL )
1846 {
1847 ret = ssl->f_recv_timeout( ssl->p_bio,
1848 ssl->in_hdr + ssl->in_left, len,
1849 ssl->conf->read_timeout );
1850 }
1851 else
1852 {
1853 ret = ssl->f_recv( ssl->p_bio,
1854 ssl->in_hdr + ssl->in_left, len );
1855 }
1856 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001857
Paul Elliottd48d5c62021-01-07 14:47:05 +00001858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1859 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001860 ssl->in_left, nb_want ) );
1861 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001862
1863 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001865
1866 if( ret < 0 )
1867 return( ret );
1868
makise-homuraaf9513b2020-08-24 18:26:27 +03001869 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001870 {
Darryl Green11999bb2018-03-13 15:22:58 +00001871 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001872 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001873 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001874 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1875 }
1876
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001877 ssl->in_left += ret;
1878 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001879 }
1880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001882
1883 return( 0 );
1884}
1885
1886/*
1887 * Flush any data not yet written
1888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001890{
Janos Follath865b3eb2019-12-16 11:46:15 +00001891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001892 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001893
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001895
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001896 if( ssl->f_send == NULL )
1897 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001899 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001901 }
1902
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001903 /* Avoid incrementing counter if data is flushed */
1904 if( ssl->out_left == 0 )
1905 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001907 return( 0 );
1908 }
1909
Paul Bakker5121ce52009-01-03 21:22:43 +00001910 while( ssl->out_left > 0 )
1911 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1913 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001914 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001915
Hanno Becker2b1e3542018-08-06 11:19:13 +01001916 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001917 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001920
1921 if( ret <= 0 )
1922 return( ret );
1923
makise-homuraaf9513b2020-08-24 18:26:27 +03001924 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001925 {
Darryl Green11999bb2018-03-13 15:22:58 +00001926 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001927 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001928 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001929 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1930 }
1931
Paul Bakker5121ce52009-01-03 21:22:43 +00001932 ssl->out_left -= ret;
1933 }
1934
Hanno Becker2b1e3542018-08-06 11:19:13 +01001935#if defined(MBEDTLS_SSL_PROTO_DTLS)
1936 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001937 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001938 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001939 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001940 else
1941#endif
1942 {
1943 ssl->out_hdr = ssl->out_buf + 8;
1944 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001945 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001948
1949 return( 0 );
1950}
1951
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001952/*
1953 * Functions to handle the DTLS retransmission state machine
1954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001956/*
1957 * Append current handshake message to current outgoing flight
1958 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001960{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1963 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1964 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001965
1966 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001967 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001968 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001969 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001971 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001972 }
1973
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001974 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001975 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001976 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1977 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001979 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001980 }
1981
1982 /* Copy current handshake message with headers */
1983 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1984 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001985 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001986 msg->next = NULL;
1987
1988 /* Append to the current flight */
1989 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001990 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001991 else
1992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001994 while( cur->next != NULL )
1995 cur = cur->next;
1996 cur->next = msg;
1997 }
1998
Hanno Becker3b235902018-08-06 09:54:53 +01001999 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002000 return( 0 );
2001}
2002
2003/*
2004 * Free the current flight of handshake messages
2005 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002006void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002007{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 mbedtls_ssl_flight_item *cur = flight;
2009 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002010
2011 while( cur != NULL )
2012 {
2013 next = cur->next;
2014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015 mbedtls_free( cur->p );
2016 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002017
2018 cur = next;
2019 }
2020}
2021
2022/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002023 * Swap transform_out and out_ctr with the alternative ones
2024 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002025static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002026{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002028 unsigned char tmp_out_ctr[8];
2029
2030 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2031 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002033 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002034 }
2035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002037
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002038 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002039 tmp_transform = ssl->transform_out;
2040 ssl->transform_out = ssl->handshake->alt_transform_out;
2041 ssl->handshake->alt_transform_out = tmp_transform;
2042
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002043 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002044 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2045 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002046 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002047
2048 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002049 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002050
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002051 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002052}
2053
2054/*
2055 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002056 */
2057int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2058{
2059 int ret = 0;
2060
2061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2062
2063 ret = mbedtls_ssl_flight_transmit( ssl );
2064
2065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2066
2067 return( ret );
2068}
2069
2070/*
2071 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002072 *
2073 * Need to remember the current message in case flush_output returns
2074 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002075 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002076 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002077int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078{
Janos Follath865b3eb2019-12-16 11:46:15 +00002079 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002083 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002084 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002085
2086 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002087 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002088 ret = ssl_swap_epochs( ssl );
2089 if( ret != 0 )
2090 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002093 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002094
2095 while( ssl->handshake->cur_msg != NULL )
2096 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002097 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002098 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002099
Hanno Beckere1dcb032018-08-17 16:47:58 +01002100 int const is_finished =
2101 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2102 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2103
Hanno Becker04da1892018-08-14 13:22:10 +01002104 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2105 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2106
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002107 /* Swap epochs before sending Finished: we can't do it after
2108 * sending ChangeCipherSpec, in case write returns WANT_READ.
2109 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002110 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002111 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002113 ret = ssl_swap_epochs( ssl );
2114 if( ret != 0 )
2115 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002116 }
2117
Hanno Becker67bc7c32018-08-06 11:33:50 +01002118 ret = ssl_get_remaining_payload_in_datagram( ssl );
2119 if( ret < 0 )
2120 return( ret );
2121 max_frag_len = (size_t) ret;
2122
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002123 /* CCS is copied as is, while HS messages may need fragmentation */
2124 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2125 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002126 if( max_frag_len == 0 )
2127 {
2128 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2129 return( ret );
2130
2131 continue;
2132 }
2133
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002134 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002135 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002136 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002137
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002138 /* Update position inside current message */
2139 ssl->handshake->cur_msg_p += cur->len;
2140 }
2141 else
2142 {
2143 const unsigned char * const p = ssl->handshake->cur_msg_p;
2144 const size_t hs_len = cur->len - 12;
2145 const size_t frag_off = p - ( cur->p + 12 );
2146 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002147 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002148
Hanno Beckere1dcb032018-08-17 16:47:58 +01002149 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002150 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002151 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002152 {
2153 ret = ssl_swap_epochs( ssl );
2154 if( ret != 0 )
2155 return( ret );
2156 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002157
Hanno Becker67bc7c32018-08-06 11:33:50 +01002158 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2159 return( ret );
2160
2161 continue;
2162 }
2163 max_hs_frag_len = max_frag_len - 12;
2164
2165 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2166 max_hs_frag_len : rem_len;
2167
2168 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002169 {
2170 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002171 (unsigned) cur_hs_frag_len,
2172 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002173 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002174
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002175 /* Messages are stored with handshake headers as if not fragmented,
2176 * copy beginning of headers then fill fragmentation fields.
2177 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2178 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002179
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002180 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2181 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2182 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2183
Hanno Becker67bc7c32018-08-06 11:33:50 +01002184 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2185 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2186 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002187
2188 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2189
Hanno Becker3f7b9732018-08-28 09:53:25 +01002190 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002191 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2192 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002193 ssl->out_msgtype = cur->type;
2194
2195 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002196 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002197 }
2198
2199 /* If done with the current message move to the next one if any */
2200 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2201 {
2202 if( cur->next != NULL )
2203 {
2204 ssl->handshake->cur_msg = cur->next;
2205 ssl->handshake->cur_msg_p = cur->next->p + 12;
2206 }
2207 else
2208 {
2209 ssl->handshake->cur_msg = NULL;
2210 ssl->handshake->cur_msg_p = NULL;
2211 }
2212 }
2213
2214 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002215 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002216 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002218 return( ret );
2219 }
2220 }
2221
Hanno Becker67bc7c32018-08-06 11:33:50 +01002222 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2223 return( ret );
2224
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002225 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2227 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002228 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002229 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002231 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002232 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002233
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002234 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235
2236 return( 0 );
2237}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002238
2239/*
2240 * To be called when the last message of an incoming flight is received.
2241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002243{
2244 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002245 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002246 ssl->handshake->flight = NULL;
2247 ssl->handshake->cur_msg = NULL;
2248
2249 /* The next incoming flight will start with this msg_seq */
2250 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2251
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002252 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002253 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002254
Hanno Becker0271f962018-08-16 13:23:47 +01002255 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002256 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002257
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002258 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002259 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2262 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002263 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002265 }
2266 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002268}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002269
2270/*
2271 * To be called when the last message of an outgoing flight is send.
2272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002274{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002275 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002276 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2279 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002280 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002282 }
2283 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002285}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002287
Paul Bakker5121ce52009-01-03 21:22:43 +00002288/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002289 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002290 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002291
2292/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002293 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002294 *
2295 * - fill in handshake headers
2296 * - update handshake checksum
2297 * - DTLS: save message for resending
2298 * - then pass to the record layer
2299 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002300 * DTLS: except for HelloRequest, messages are only queued, and will only be
2301 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002302 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002303 * Inputs:
2304 * - ssl->out_msglen: 4 + actual handshake message len
2305 * (4 is the size of handshake headers for TLS)
2306 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2307 * - ssl->out_msg + 4: the handshake message body
2308 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002309 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002310 * - ssl->out_msglen: the length of the record contents
2311 * (including handshake headers but excluding record headers)
2312 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002314int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002315{
Janos Follath865b3eb2019-12-16 11:46:15 +00002316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002317 const size_t hs_len = ssl->out_msglen - 4;
2318 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002319
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002320 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2321
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002322 /*
2323 * Sanity checks
2324 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002325 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002326 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2327 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2329 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002330 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002331
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002332 /* Whenever we send anything different from a
2333 * HelloRequest we should be in a handshake - double check. */
2334 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2335 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002336 ssl->handshake == NULL )
2337 {
2338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2339 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2340 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002341
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002343 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002344 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002346 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002347 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2348 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002349 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002350#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002351
Hanno Beckerb50a2532018-08-06 11:52:54 +01002352 /* Double-check that we did not exceed the bounds
2353 * of the outgoing record buffer.
2354 * This should never fail as the various message
2355 * writing functions must obey the bounds of the
2356 * outgoing record buffer, but better be safe.
2357 *
2358 * Note: We deliberately do not check for the MTU or MFL here.
2359 */
2360 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2361 {
2362 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002363 "size %" MBEDTLS_PRINTF_SIZET
2364 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002365 ssl->out_msglen,
2366 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002367 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2368 }
2369
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002370 /*
2371 * Fill handshake headers
2372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002374 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002375 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2376 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2377 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002378
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002379 /*
2380 * DTLS has additional fields in the Handshake layer,
2381 * between the length field and the actual payload:
2382 * uint16 message_seq;
2383 * uint24 fragment_offset;
2384 * uint24 fragment_length;
2385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002387 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002388 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002389 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002390 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002391 {
2392 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002393 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002394 hs_len,
2395 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002396 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2397 }
2398
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002399 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002400 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002401
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002402 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002403 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002404 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002405 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2406 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2407 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002408 }
2409 else
2410 {
2411 ssl->out_msg[4] = 0;
2412 ssl->out_msg[5] = 0;
2413 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002414
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002415 /* Handshake hashes are computed without fragmentation,
2416 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002417 memset( ssl->out_msg + 6, 0x00, 3 );
2418 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002419 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002421
Hanno Becker0207e532018-08-28 10:28:28 +01002422 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002423 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2424 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002425 }
2426
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002427 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002429 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002430 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2431 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002432 {
2433 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2434 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002436 return( ret );
2437 }
2438 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002439 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002440#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002441 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002442 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002443 {
2444 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2445 return( ret );
2446 }
2447 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002448
2449 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2450
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002451 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002452}
2453
2454/*
2455 * Record layer functions
2456 */
2457
2458/*
2459 * Write current record.
2460 *
2461 * Uses:
2462 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2463 * - ssl->out_msglen: length of the record content (excl headers)
2464 * - ssl->out_msg: record content
2465 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002466int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002467{
2468 int ret, done = 0;
2469 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002470 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002471
2472 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002473
Paul Bakker05ef8352012-05-08 09:17:57 +00002474 if( !done )
2475 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002476 unsigned i;
2477 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002478#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2479 size_t out_buf_len = ssl->out_buf_len;
2480#else
2481 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2482#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002483 /* Skip writing the record content type to after the encryption,
2484 * as it may change when using the CID extension. */
2485
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002487 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002488
Hanno Becker19859472018-08-06 09:40:20 +01002489 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002490 ssl->out_len[0] = (unsigned char)( len >> 8 );
2491 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002492
Paul Bakker48916f92012-09-16 19:57:18 +00002493 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002494 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002495 mbedtls_record rec;
2496
2497 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002498 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002499 rec.data_len = ssl->out_msglen;
2500 rec.data_offset = ssl->out_msg - rec.buf;
2501
2502 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2503 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2504 ssl->conf->transport, rec.ver );
2505 rec.type = ssl->out_msgtype;
2506
Hanno Beckera0e20d02019-05-15 14:03:01 +01002507#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002508 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002509 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002510#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002511
Hanno Beckera18d1322018-01-03 14:27:32 +00002512 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002513 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002514 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002516 return( ret );
2517 }
2518
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002519 if( rec.data_offset != 0 )
2520 {
2521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2522 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2523 }
2524
Hanno Becker6430faf2019-05-08 11:57:13 +01002525 /* Update the record content type and CID. */
2526 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002527#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002528 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002529#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002530 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002531 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2532 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002533 }
2534
Hanno Becker5903de42019-05-03 14:46:38 +01002535 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002536
2537#if defined(MBEDTLS_SSL_PROTO_DTLS)
2538 /* In case of DTLS, double-check that we don't exceed
2539 * the remaining space in the datagram. */
2540 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2541 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002542 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002543 if( ret < 0 )
2544 return( ret );
2545
2546 if( protected_record_size > (size_t) ret )
2547 {
2548 /* Should never happen */
2549 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2550 }
2551 }
2552#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002553
Hanno Becker6430faf2019-05-08 11:57:13 +01002554 /* Now write the potentially updated record content type. */
2555 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2556
Paul Elliott9f352112020-12-09 14:55:45 +00002557 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002558 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002559 ssl->out_hdr[0], ssl->out_hdr[1],
2560 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002563 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002564
2565 ssl->out_left += protected_record_size;
2566 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002567 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002568
Hanno Beckerdd772292020-02-05 10:38:31 +00002569 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002570 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2571 break;
2572
2573 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002574 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002575 {
2576 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2577 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2578 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002579 }
2580
Hanno Becker67bc7c32018-08-06 11:33:50 +01002581#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002582 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2583 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002584 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002585 size_t remaining;
2586 ret = ssl_get_remaining_payload_in_datagram( ssl );
2587 if( ret < 0 )
2588 {
2589 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2590 ret );
2591 return( ret );
2592 }
2593
2594 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002595 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002596 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002597 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002598 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002599 else
2600 {
Hanno Becker513815a2018-08-20 11:56:09 +01002601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002602 }
2603 }
2604#endif /* MBEDTLS_SSL_PROTO_DTLS */
2605
2606 if( ( flush == SSL_FORCE_FLUSH ) &&
2607 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002608 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002610 return( ret );
2611 }
2612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002614
2615 return( 0 );
2616}
2617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002619
2620static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2621{
2622 if( ssl->in_msglen < ssl->in_hslen ||
2623 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2624 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2625 {
2626 return( 1 );
2627 }
2628 return( 0 );
2629}
Hanno Becker44650b72018-08-16 12:51:11 +01002630
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002631static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002632{
2633 return( ( ssl->in_msg[9] << 16 ) |
2634 ( ssl->in_msg[10] << 8 ) |
2635 ssl->in_msg[11] );
2636}
2637
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002638static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002639{
2640 return( ( ssl->in_msg[6] << 16 ) |
2641 ( ssl->in_msg[7] << 8 ) |
2642 ssl->in_msg[8] );
2643}
2644
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002645static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002646{
2647 uint32_t msg_len, frag_off, frag_len;
2648
2649 msg_len = ssl_get_hs_total_len( ssl );
2650 frag_off = ssl_get_hs_frag_off( ssl );
2651 frag_len = ssl_get_hs_frag_len( ssl );
2652
2653 if( frag_off > msg_len )
2654 return( -1 );
2655
2656 if( frag_len > msg_len - frag_off )
2657 return( -1 );
2658
2659 if( frag_len + 12 > ssl->in_msglen )
2660 return( -1 );
2661
2662 return( 0 );
2663}
2664
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002665/*
2666 * Mark bits in bitmask (used for DTLS HS reassembly)
2667 */
2668static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2669{
2670 unsigned int start_bits, end_bits;
2671
2672 start_bits = 8 - ( offset % 8 );
2673 if( start_bits != 8 )
2674 {
2675 size_t first_byte_idx = offset / 8;
2676
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002677 /* Special case */
2678 if( len <= start_bits )
2679 {
2680 for( ; len != 0; len-- )
2681 mask[first_byte_idx] |= 1 << ( start_bits - len );
2682
2683 /* Avoid potential issues with offset or len becoming invalid */
2684 return;
2685 }
2686
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002687 offset += start_bits; /* Now offset % 8 == 0 */
2688 len -= start_bits;
2689
2690 for( ; start_bits != 0; start_bits-- )
2691 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2692 }
2693
2694 end_bits = len % 8;
2695 if( end_bits != 0 )
2696 {
2697 size_t last_byte_idx = ( offset + len ) / 8;
2698
2699 len -= end_bits; /* Now len % 8 == 0 */
2700
2701 for( ; end_bits != 0; end_bits-- )
2702 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2703 }
2704
2705 memset( mask + offset / 8, 0xFF, len / 8 );
2706}
2707
2708/*
2709 * Check that bitmask is full
2710 */
2711static int ssl_bitmask_check( unsigned char *mask, size_t len )
2712{
2713 size_t i;
2714
2715 for( i = 0; i < len / 8; i++ )
2716 if( mask[i] != 0xFF )
2717 return( -1 );
2718
2719 for( i = 0; i < len % 8; i++ )
2720 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2721 return( -1 );
2722
2723 return( 0 );
2724}
2725
Hanno Becker56e205e2018-08-16 09:06:12 +01002726/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002727static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002728 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002729{
Hanno Becker56e205e2018-08-16 09:06:12 +01002730 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002731
Hanno Becker56e205e2018-08-16 09:06:12 +01002732 alloc_len = 12; /* Handshake header */
2733 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002734
Hanno Beckerd07df862018-08-16 09:14:58 +01002735 if( add_bitmap )
2736 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002737
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002738 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002739}
Hanno Becker56e205e2018-08-16 09:06:12 +01002740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002742
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002743static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002744{
2745 return( ( ssl->in_msg[1] << 16 ) |
2746 ( ssl->in_msg[2] << 8 ) |
2747 ssl->in_msg[3] );
2748}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002749
Simon Butcher99000142016-10-13 17:21:01 +01002750int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002751{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002752 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002753 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002755 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002757 }
2758
Hanno Becker12555c62018-08-16 12:47:53 +01002759 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002762 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002763 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002766 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002767 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002768 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002769 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002770
Hanno Becker44650b72018-08-16 12:51:11 +01002771 if( ssl_check_hs_header( ssl ) != 0 )
2772 {
2773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2774 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2775 }
2776
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002777 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002778 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2779 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2780 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2781 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002782 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002783 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2784 {
2785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2786 recv_msg_seq,
2787 ssl->handshake->in_msg_seq ) );
2788 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2789 }
2790
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002791 /* Retransmit only on last message from previous flight, to avoid
2792 * too many retransmissions.
2793 * Besides, No sane server ever retransmits HelloVerifyRequest */
2794 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002798 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002799 recv_msg_seq,
2800 ssl->handshake->in_flight_start_seq ) );
2801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002805 return( ret );
2806 }
2807 }
2808 else
2809 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002811 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002812 recv_msg_seq,
2813 ssl->handshake->in_msg_seq ) );
2814 }
2815
Hanno Becker90333da2017-10-10 11:27:13 +01002816 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002817 }
2818 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002819
Hanno Becker6d97ef52018-08-16 13:09:04 +01002820 /* Message reassembly is handled alongside buffering of future
2821 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002822 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002823 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002824 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002825 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002827 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002828 }
2829 }
2830 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002832 /* With TLS we don't handle fragmentation (for now) */
2833 if( ssl->in_msglen < ssl->in_hslen )
2834 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2836 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002837 }
2838
Simon Butcher99000142016-10-13 17:21:01 +01002839 return( 0 );
2840}
2841
2842void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2843{
Hanno Becker0271f962018-08-16 13:23:47 +01002844 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002845
Hanno Becker0271f962018-08-16 13:23:47 +01002846 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002847 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002848 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002849 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002850
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002851 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002853 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002854 ssl->handshake != NULL )
2855 {
Hanno Becker0271f962018-08-16 13:23:47 +01002856 unsigned offset;
2857 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002858
Hanno Becker0271f962018-08-16 13:23:47 +01002859 /* Increment handshake sequence number */
2860 hs->in_msg_seq++;
2861
2862 /*
2863 * Clear up handshake buffering and reassembly structure.
2864 */
2865
2866 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002867 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002868
2869 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002870 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2871 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002872 offset++, hs_buf++ )
2873 {
2874 *hs_buf = *(hs_buf + 1);
2875 }
2876
2877 /* Create a fresh last entry */
2878 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002879 }
2880#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002881}
2882
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002883/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002884 * DTLS anti-replay: RFC 6347 4.1.2.6
2885 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002886 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2887 * Bit n is set iff record number in_window_top - n has been seen.
2888 *
2889 * Usually, in_window_top is the last record number seen and the lsb of
2890 * in_window is set. The only exception is the initial state (record number 0
2891 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002894void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002895{
2896 ssl->in_window_top = 0;
2897 ssl->in_window = 0;
2898}
2899
2900static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2901{
2902 return( ( (uint64_t) buf[0] << 40 ) |
2903 ( (uint64_t) buf[1] << 32 ) |
2904 ( (uint64_t) buf[2] << 24 ) |
2905 ( (uint64_t) buf[3] << 16 ) |
2906 ( (uint64_t) buf[4] << 8 ) |
2907 ( (uint64_t) buf[5] ) );
2908}
2909
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002910static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2911{
Janos Follath865b3eb2019-12-16 11:46:15 +00002912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002913 unsigned char *original_in_ctr;
2914
2915 // save original in_ctr
2916 original_in_ctr = ssl->in_ctr;
2917
2918 // use counter from record
2919 ssl->in_ctr = record_in_ctr;
2920
2921 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2922
2923 // restore the counter
2924 ssl->in_ctr = original_in_ctr;
2925
2926 return ret;
2927}
2928
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002929/*
2930 * Return 0 if sequence number is acceptable, -1 otherwise
2931 */
Hanno Becker0183d692019-07-12 08:50:37 +01002932int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002933{
2934 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2935 uint64_t bit;
2936
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002937 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002938 return( 0 );
2939
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002940 if( rec_seqnum > ssl->in_window_top )
2941 return( 0 );
2942
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002943 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002944
2945 if( bit >= 64 )
2946 return( -1 );
2947
2948 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2949 return( -1 );
2950
2951 return( 0 );
2952}
2953
2954/*
2955 * Update replay window on new validated record
2956 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002958{
2959 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2960
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002961 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002962 return;
2963
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002964 if( rec_seqnum > ssl->in_window_top )
2965 {
2966 /* Update window_top and the contents of the window */
2967 uint64_t shift = rec_seqnum - ssl->in_window_top;
2968
2969 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002970 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002971 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002972 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002973 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002974 ssl->in_window |= 1;
2975 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002976
2977 ssl->in_window_top = rec_seqnum;
2978 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002979 else
2980 {
2981 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002982 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002983
2984 if( bit < 64 ) /* Always true, but be extra sure */
2985 ssl->in_window |= (uint64_t) 1 << bit;
2986 }
2987}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002989
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002990#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002991/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002992 * Without any SSL context, check if a datagram looks like a ClientHello with
2993 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002994 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002995 *
2996 * - if cookie is valid, return 0
2997 * - if ClientHello looks superficially valid but cookie is not,
2998 * fill obuf and set olen, then
2999 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3000 * - otherwise return a specific error code
3001 */
3002static int ssl_check_dtls_clihlo_cookie(
3003 mbedtls_ssl_cookie_write_t *f_cookie_write,
3004 mbedtls_ssl_cookie_check_t *f_cookie_check,
3005 void *p_cookie,
3006 const unsigned char *cli_id, size_t cli_id_len,
3007 const unsigned char *in, size_t in_len,
3008 unsigned char *obuf, size_t buf_len, size_t *olen )
3009{
3010 size_t sid_len, cookie_len;
3011 unsigned char *p;
3012
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003013 /*
3014 * Structure of ClientHello with record and handshake headers,
3015 * and expected values. We don't need to check a lot, more checks will be
3016 * done when actually parsing the ClientHello - skipping those checks
3017 * avoids code duplication and does not make cookie forging any easier.
3018 *
3019 * 0-0 ContentType type; copied, must be handshake
3020 * 1-2 ProtocolVersion version; copied
3021 * 3-4 uint16 epoch; copied, must be 0
3022 * 5-10 uint48 sequence_number; copied
3023 * 11-12 uint16 length; (ignored)
3024 *
3025 * 13-13 HandshakeType msg_type; (ignored)
3026 * 14-16 uint24 length; (ignored)
3027 * 17-18 uint16 message_seq; copied
3028 * 19-21 uint24 fragment_offset; copied, must be 0
3029 * 22-24 uint24 fragment_length; (ignored)
3030 *
3031 * 25-26 ProtocolVersion client_version; (ignored)
3032 * 27-58 Random random; (ignored)
3033 * 59-xx SessionID session_id; 1 byte len + sid_len content
3034 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3035 * ...
3036 *
3037 * Minimum length is 61 bytes.
3038 */
3039 if( in_len < 61 ||
3040 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3041 in[3] != 0 || in[4] != 0 ||
3042 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3043 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003044 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003045 }
3046
3047 sid_len = in[59];
3048 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003049 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003050
3051 cookie_len = in[60 + sid_len];
3052 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003053 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003054
3055 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3056 cli_id, cli_id_len ) == 0 )
3057 {
3058 /* Valid cookie */
3059 return( 0 );
3060 }
3061
3062 /*
3063 * If we get here, we've got an invalid cookie, let's prepare HVR.
3064 *
3065 * 0-0 ContentType type; copied
3066 * 1-2 ProtocolVersion version; copied
3067 * 3-4 uint16 epoch; copied
3068 * 5-10 uint48 sequence_number; copied
3069 * 11-12 uint16 length; olen - 13
3070 *
3071 * 13-13 HandshakeType msg_type; hello_verify_request
3072 * 14-16 uint24 length; olen - 25
3073 * 17-18 uint16 message_seq; copied
3074 * 19-21 uint24 fragment_offset; copied
3075 * 22-24 uint24 fragment_length; olen - 25
3076 *
3077 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3078 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3079 *
3080 * Minimum length is 28.
3081 */
3082 if( buf_len < 28 )
3083 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3084
3085 /* Copy most fields and adapt others */
3086 memcpy( obuf, in, 25 );
3087 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3088 obuf[25] = 0xfe;
3089 obuf[26] = 0xff;
3090
3091 /* Generate and write actual cookie */
3092 p = obuf + 28;
3093 if( f_cookie_write( p_cookie,
3094 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3095 {
3096 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3097 }
3098
3099 *olen = p - obuf;
3100
3101 /* Go back and fill length fields */
3102 obuf[27] = (unsigned char)( *olen - 28 );
3103
3104 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3105 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3106 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3107
3108 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3109 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3110
3111 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3112}
3113
3114/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003115 * Handle possible client reconnect with the same UDP quadruplet
3116 * (RFC 6347 Section 4.2.8).
3117 *
3118 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3119 * that looks like a ClientHello.
3120 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003121 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003122 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003123 * - if the input looks like a ClientHello with a valid cookie,
3124 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003125 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003126 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003127 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003128 * This function is called (through ssl_check_client_reconnect()) when an
3129 * unexpected record is found in ssl_get_next_record(), which will discard the
3130 * record if we return 0, and bubble up the return value otherwise (this
3131 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3132 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003133 */
3134static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3135{
Janos Follath865b3eb2019-12-16 11:46:15 +00003136 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003137 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003138
Hanno Becker2fddd372019-07-10 14:37:41 +01003139 if( ssl->conf->f_cookie_write == NULL ||
3140 ssl->conf->f_cookie_check == NULL )
3141 {
3142 /* If we can't use cookies to verify reachability of the peer,
3143 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003144 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3145 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003146 return( 0 );
3147 }
3148
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003149 ret = ssl_check_dtls_clihlo_cookie(
3150 ssl->conf->f_cookie_write,
3151 ssl->conf->f_cookie_check,
3152 ssl->conf->p_cookie,
3153 ssl->cli_id, ssl->cli_id_len,
3154 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003155 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003156
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003157 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3158
3159 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003160 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003161 int send_ret;
3162 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3163 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3164 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003165 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003166 * If the error is permanent we'll catch it later,
3167 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003168 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3169 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3170 (void) send_ret;
3171
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003172 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003173 }
3174
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003175 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003176 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003177 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003178 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003179 {
3180 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3181 return( ret );
3182 }
3183
3184 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003185 }
3186
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003187 return( ret );
3188}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003189#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003190
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003191static int ssl_check_record_type( uint8_t record_type )
3192{
3193 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3194 record_type != MBEDTLS_SSL_MSG_ALERT &&
3195 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3196 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3197 {
3198 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3199 }
3200
3201 return( 0 );
3202}
3203
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003204/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003205 * ContentType type;
3206 * ProtocolVersion version;
3207 * uint16 epoch; // DTLS only
3208 * uint48 sequence_number; // DTLS only
3209 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003210 *
3211 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003212 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003213 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3214 *
3215 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003216 * 1. proceed with the record if this function returns 0
3217 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3218 * 3. return CLIENT_RECONNECT if this function return that value
3219 * 4. drop the whole datagram if this function returns anything else.
3220 * Point 2 is needed when the peer is resending, and we have already received
3221 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003222 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003223static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003224 unsigned char *buf,
3225 size_t len,
3226 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003227{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003228 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003229
Hanno Beckere5e7e782019-07-11 12:29:35 +01003230 size_t const rec_hdr_type_offset = 0;
3231 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003232
Hanno Beckere5e7e782019-07-11 12:29:35 +01003233 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3234 rec_hdr_type_len;
3235 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003236
Hanno Beckere5e7e782019-07-11 12:29:35 +01003237 size_t const rec_hdr_ctr_len = 8;
3238#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003239 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003240 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3241 rec_hdr_version_len;
3242
Hanno Beckera0e20d02019-05-15 14:03:01 +01003243#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003244 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3245 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003246 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003247#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3248#endif /* MBEDTLS_SSL_PROTO_DTLS */
3249
3250 size_t rec_hdr_len_offset; /* To be determined */
3251 size_t const rec_hdr_len_len = 2;
3252
3253 /*
3254 * Check minimum lengths for record header.
3255 */
3256
3257#if defined(MBEDTLS_SSL_PROTO_DTLS)
3258 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3259 {
3260 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3261 }
3262 else
3263#endif /* MBEDTLS_SSL_PROTO_DTLS */
3264 {
3265 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3266 }
3267
3268 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3269 {
3270 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3271 (unsigned) len,
3272 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3273 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3274 }
3275
3276 /*
3277 * Parse and validate record content type
3278 */
3279
3280 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003281
3282 /* Check record content type */
3283#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3284 rec->cid_len = 0;
3285
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003286 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003287 ssl->conf->cid_len != 0 &&
3288 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003289 {
3290 /* Shift pointers to account for record header including CID
3291 * struct {
3292 * ContentType special_type = tls12_cid;
3293 * ProtocolVersion version;
3294 * uint16 epoch;
3295 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003296 * opaque cid[cid_length]; // Additional field compared to
3297 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003298 * uint16 length;
3299 * opaque enc_content[DTLSCiphertext.length];
3300 * } DTLSCiphertext;
3301 */
3302
3303 /* So far, we only support static CID lengths
3304 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003305 rec_hdr_cid_len = ssl->conf->cid_len;
3306 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003307
Hanno Beckere5e7e782019-07-11 12:29:35 +01003308 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003309 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3311 (unsigned) len,
3312 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003313 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003314 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003315
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003316 /* configured CID len is guaranteed at most 255, see
3317 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3318 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003319 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003320 }
3321 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003322#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003323 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003324 if( ssl_check_record_type( rec->type ) )
3325 {
Hanno Becker54229812019-07-12 14:40:00 +01003326 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3327 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003328 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3329 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003330 }
3331
Hanno Beckere5e7e782019-07-11 12:29:35 +01003332 /*
3333 * Parse and validate record version
3334 */
3335
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003336 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3337 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003338 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3339 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003340 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003341
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003342 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003343 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3345 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003346 }
3347
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003348 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003349 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3351 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003352 }
3353
Hanno Beckere5e7e782019-07-11 12:29:35 +01003354 /*
3355 * Parse/Copy record sequence number.
3356 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003357
Hanno Beckere5e7e782019-07-11 12:29:35 +01003358#if defined(MBEDTLS_SSL_PROTO_DTLS)
3359 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003360 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003361 /* Copy explicit record sequence number from input buffer. */
3362 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3363 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003364 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003365 else
3366#endif /* MBEDTLS_SSL_PROTO_DTLS */
3367 {
3368 /* Copy implicit record sequence number from SSL context structure. */
3369 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3370 }
Paul Bakker40e46942009-01-03 21:51:57 +00003371
Hanno Beckere5e7e782019-07-11 12:29:35 +01003372 /*
3373 * Parse record length.
3374 */
3375
Hanno Beckere5e7e782019-07-11 12:29:35 +01003376 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003377 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3378 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003379 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003380
Paul Elliott9f352112020-12-09 14:55:45 +00003381 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003382 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003383 rec->type,
3384 major_ver, minor_ver, rec->data_len ) );
3385
3386 rec->buf = buf;
3387 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003388
Hanno Beckerd417cc92019-07-26 08:20:27 +01003389 if( rec->data_len == 0 )
3390 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003391
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003392 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003393 * DTLS-related tests.
3394 * Check epoch before checking length constraint because
3395 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3396 * message gets duplicated before the corresponding Finished message,
3397 * the second ChangeCipherSpec should be discarded because it belongs
3398 * to an old epoch, but not because its length is shorter than
3399 * the minimum record length for packets using the new record transform.
3400 * Note that these two kinds of failures are handled differently,
3401 * as an unexpected record is silently skipped but an invalid
3402 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003403 */
3404#if defined(MBEDTLS_SSL_PROTO_DTLS)
3405 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3406 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003407 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003408
Hanno Becker955a5c92019-07-10 17:12:07 +01003409 /* Check that the datagram is large enough to contain a record
3410 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003411 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003412 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3414 (unsigned) len,
3415 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003416 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3417 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003418
Hanno Becker37cfe732019-07-10 17:20:01 +01003419 /* Records from other, non-matching epochs are silently discarded.
3420 * (The case of same-port Client reconnects must be considered in
3421 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003422 if( rec_epoch != ssl->in_epoch )
3423 {
3424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003425 "expected %u, received %lu",
3426 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003427
Hanno Becker552f7472019-07-19 10:59:12 +01003428 /* Records from the next epoch are considered for buffering
3429 * (concretely: early Finished messages). */
3430 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003431 {
Hanno Becker552f7472019-07-19 10:59:12 +01003432 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3433 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003434 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003435
Hanno Becker2fddd372019-07-10 14:37:41 +01003436 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003437 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003438#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003439 /* For records from the correct epoch, check whether their
3440 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003441 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3442 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003443 {
3444 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3445 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3446 }
3447#endif
3448 }
3449#endif /* MBEDTLS_SSL_PROTO_DTLS */
3450
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003451 return( 0 );
3452}
Paul Bakker5121ce52009-01-03 21:22:43 +00003453
Paul Bakker5121ce52009-01-03 21:22:43 +00003454
Hanno Becker2fddd372019-07-10 14:37:41 +01003455#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3456static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3457{
3458 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3459
3460 /*
3461 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3462 * access the first byte of record content (handshake type), as we
3463 * have an active transform (possibly iv_len != 0), so use the
3464 * fact that the record header len is 13 instead.
3465 */
3466 if( rec_epoch == 0 &&
3467 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3468 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3469 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3470 ssl->in_left > 13 &&
3471 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3472 {
3473 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3474 "from the same port" ) );
3475 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003476 }
3477
3478 return( 0 );
3479}
Hanno Becker2fddd372019-07-10 14:37:41 +01003480#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003481
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003482/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003483 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003484 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003485static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3486 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003487{
3488 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003489
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003491 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003492
Paul Bakker48916f92012-09-16 19:57:18 +00003493 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003494 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003495 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003496
Hanno Beckera18d1322018-01-03 14:27:32 +00003497 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003498 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003499 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003500 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003501
Hanno Beckera0e20d02019-05-15 14:03:01 +01003502#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003503 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3504 ssl->conf->ignore_unexpected_cid
3505 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3506 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003507 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003508 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003509 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003510#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003511
Paul Bakker5121ce52009-01-03 21:22:43 +00003512 return( ret );
3513 }
3514
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003515 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003516 {
3517 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003518 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003519 }
3520
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003521 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003522 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003523
Hanno Beckera0e20d02019-05-15 14:03:01 +01003524#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003525 /* We have already checked the record content type
3526 * in ssl_parse_record_header(), failing or silently
3527 * dropping the record in the case of an unknown type.
3528 *
3529 * Since with the use of CIDs, the record content type
3530 * might change during decryption, re-check the record
3531 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003532 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003533 {
3534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3535 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3536 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003537#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003538
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003539 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003540 {
3541#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3542 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003543 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003544 {
3545 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3547 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3548 }
3549#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3550
3551 ssl->nb_zero++;
3552
3553 /*
3554 * Three or more empty messages may be a DoS attack
3555 * (excessive CPU consumption).
3556 */
3557 if( ssl->nb_zero > 3 )
3558 {
3559 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003560 "messages, possible DoS attack" ) );
3561 /* Treat the records as if they were not properly authenticated,
3562 * thereby failing the connection if we see more than allowed
3563 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003564 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3565 }
3566 }
3567 else
3568 ssl->nb_zero = 0;
3569
3570#if defined(MBEDTLS_SSL_PROTO_DTLS)
3571 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3572 {
3573 ; /* in_ctr read from peer, not maintained internally */
3574 }
3575 else
3576#endif
3577 {
3578 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003579 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003580 if( ++ssl->in_ctr[i - 1] != 0 )
3581 break;
3582
3583 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003584 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003585 {
3586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3587 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3588 }
3589 }
3590
Paul Bakker5121ce52009-01-03 21:22:43 +00003591 }
3592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003593#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003594 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003595 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003597 }
3598#endif
3599
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003600 /* Check actual (decrypted) record content length against
3601 * configured maximum. */
3602 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3603 {
3604 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3605 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3606 }
3607
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003608 return( 0 );
3609}
3610
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003611/*
3612 * Read a record.
3613 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003614 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3615 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3616 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003617 */
Hanno Becker1097b342018-08-15 14:09:41 +01003618
3619/* Helper functions for mbedtls_ssl_read_record(). */
3620static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003621static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3622static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003623
Hanno Becker327c93b2018-08-15 13:56:18 +01003624int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003625 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003626{
Janos Follath865b3eb2019-12-16 11:46:15 +00003627 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003630
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003631 if( ssl->keep_current_message == 0 )
3632 {
3633 do {
Simon Butcher99000142016-10-13 17:21:01 +01003634
Hanno Becker26994592018-08-15 14:14:59 +01003635 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003636 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003637 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003638
Hanno Beckere74d5562018-08-15 14:26:08 +01003639 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003640 {
Hanno Becker40f50842018-08-15 14:48:01 +01003641#if defined(MBEDTLS_SSL_PROTO_DTLS)
3642 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003643
Hanno Becker40f50842018-08-15 14:48:01 +01003644 /* We only check for buffered messages if the
3645 * current datagram is fully consumed. */
3646 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003647 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003648 {
Hanno Becker40f50842018-08-15 14:48:01 +01003649 if( ssl_load_buffered_message( ssl ) == 0 )
3650 have_buffered = 1;
3651 }
3652
3653 if( have_buffered == 0 )
3654#endif /* MBEDTLS_SSL_PROTO_DTLS */
3655 {
3656 ret = ssl_get_next_record( ssl );
3657 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3658 continue;
3659
3660 if( ret != 0 )
3661 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003662 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003663 return( ret );
3664 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003665 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003666 }
3667
3668 ret = mbedtls_ssl_handle_message_type( ssl );
3669
Hanno Becker40f50842018-08-15 14:48:01 +01003670#if defined(MBEDTLS_SSL_PROTO_DTLS)
3671 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3672 {
3673 /* Buffer future message */
3674 ret = ssl_buffer_message( ssl );
3675 if( ret != 0 )
3676 return( ret );
3677
3678 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3679 }
3680#endif /* MBEDTLS_SSL_PROTO_DTLS */
3681
Hanno Becker90333da2017-10-10 11:27:13 +01003682 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3683 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003684
3685 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003686 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003687 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003688 return( ret );
3689 }
3690
Hanno Becker327c93b2018-08-15 13:56:18 +01003691 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003692 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003693 {
3694 mbedtls_ssl_update_handshake_status( ssl );
3695 }
Simon Butcher99000142016-10-13 17:21:01 +01003696 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003697 else
Simon Butcher99000142016-10-13 17:21:01 +01003698 {
Hanno Becker02f59072018-08-15 14:00:24 +01003699 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003700 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003701 }
3702
3703 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3704
3705 return( 0 );
3706}
3707
Hanno Becker40f50842018-08-15 14:48:01 +01003708#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003709static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003710{
Hanno Becker40f50842018-08-15 14:48:01 +01003711 if( ssl->in_left > ssl->next_record_offset )
3712 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003713
Hanno Becker40f50842018-08-15 14:48:01 +01003714 return( 0 );
3715}
3716
3717static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3718{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003719 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003720 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003721 int ret = 0;
3722
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003723 if( hs == NULL )
3724 return( -1 );
3725
Hanno Beckere00ae372018-08-20 09:39:42 +01003726 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3727
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003728 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3729 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3730 {
3731 /* Check if we have seen a ChangeCipherSpec before.
3732 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003733 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003734 {
3735 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3736 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003737 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003738 }
3739
Hanno Becker39b8bc92018-08-28 17:17:13 +01003740 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003741 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3742 ssl->in_msglen = 1;
3743 ssl->in_msg[0] = 1;
3744
3745 /* As long as they are equal, the exact value doesn't matter. */
3746 ssl->in_left = 0;
3747 ssl->next_record_offset = 0;
3748
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003749 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003750 goto exit;
3751 }
Hanno Becker37f95322018-08-16 13:55:32 +01003752
Hanno Beckerb8f50142018-08-28 10:01:34 +01003753#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003754 /* Debug only */
3755 {
3756 unsigned offset;
3757 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3758 {
3759 hs_buf = &hs->buffering.hs[offset];
3760 if( hs_buf->is_valid == 1 )
3761 {
3762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3763 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003764 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003765 }
3766 }
3767 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003768#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003769
3770 /* Check if we have buffered and/or fully reassembled the
3771 * next handshake message. */
3772 hs_buf = &hs->buffering.hs[0];
3773 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3774 {
3775 /* Synthesize a record containing the buffered HS message. */
3776 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3777 ( hs_buf->data[2] << 8 ) |
3778 hs_buf->data[3];
3779
3780 /* Double-check that we haven't accidentally buffered
3781 * a message that doesn't fit into the input buffer. */
3782 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3783 {
3784 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3785 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3786 }
3787
3788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3789 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3790 hs_buf->data, msg_len + 12 );
3791
3792 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3793 ssl->in_hslen = msg_len + 12;
3794 ssl->in_msglen = msg_len + 12;
3795 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3796
3797 ret = 0;
3798 goto exit;
3799 }
3800 else
3801 {
3802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3803 hs->in_msg_seq ) );
3804 }
3805
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003806 ret = -1;
3807
3808exit:
3809
3810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3811 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003812}
3813
Hanno Beckera02b0b42018-08-21 17:20:27 +01003814static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3815 size_t desired )
3816{
3817 int offset;
3818 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003819 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3820 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003821
Hanno Becker01315ea2018-08-21 17:22:17 +01003822 /* Get rid of future records epoch first, if such exist. */
3823 ssl_free_buffered_record( ssl );
3824
3825 /* Check if we have enough space available now. */
3826 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3827 hs->buffering.total_bytes_buffered ) )
3828 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003829 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003830 return( 0 );
3831 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003832
Hanno Becker4f432ad2018-08-28 10:02:32 +01003833 /* We don't have enough space to buffer the next expected handshake
3834 * message. Remove buffers used for future messages to gain space,
3835 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003836 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3837 offset >= 0; offset-- )
3838 {
3839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3840 offset ) );
3841
Hanno Beckerb309b922018-08-23 13:18:05 +01003842 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003843
3844 /* Check if we have enough space available now. */
3845 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3846 hs->buffering.total_bytes_buffered ) )
3847 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003849 return( 0 );
3850 }
3851 }
3852
3853 return( -1 );
3854}
3855
Hanno Becker40f50842018-08-15 14:48:01 +01003856static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3857{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003858 int ret = 0;
3859 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3860
3861 if( hs == NULL )
3862 return( 0 );
3863
3864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3865
3866 switch( ssl->in_msgtype )
3867 {
3868 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003870
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003871 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003872 break;
3873
3874 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003875 {
3876 unsigned recv_msg_seq_offset;
3877 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3878 mbedtls_ssl_hs_buffer *hs_buf;
3879 size_t msg_len = ssl->in_hslen - 12;
3880
3881 /* We should never receive an old handshake
3882 * message - double-check nonetheless. */
3883 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3884 {
3885 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3886 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3887 }
3888
3889 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3890 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3891 {
3892 /* Silently ignore -- message too far in the future */
3893 MBEDTLS_SSL_DEBUG_MSG( 2,
3894 ( "Ignore future HS message with sequence number %u, "
3895 "buffering window %u - %u",
3896 recv_msg_seq, ssl->handshake->in_msg_seq,
3897 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3898
3899 goto exit;
3900 }
3901
3902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3903 recv_msg_seq, recv_msg_seq_offset ) );
3904
3905 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3906
3907 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003908 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003909 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003910 size_t reassembly_buf_sz;
3911
Hanno Becker37f95322018-08-16 13:55:32 +01003912 hs_buf->is_fragmented =
3913 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3914
3915 /* We copy the message back into the input buffer
3916 * after reassembly, so check that it's not too large.
3917 * This is an implementation-specific limitation
3918 * and not one from the standard, hence it is not
3919 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003920 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003921 {
3922 /* Ignore message */
3923 goto exit;
3924 }
3925
Hanno Beckere0b150f2018-08-21 15:51:03 +01003926 /* Check if we have enough space to buffer the message. */
3927 if( hs->buffering.total_bytes_buffered >
3928 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3929 {
3930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3931 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3932 }
3933
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003934 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3935 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003936
3937 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3938 hs->buffering.total_bytes_buffered ) )
3939 {
3940 if( recv_msg_seq_offset > 0 )
3941 {
3942 /* If we can't buffer a future message because
3943 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003944 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3945 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3946 " (already %" MBEDTLS_PRINTF_SIZET
3947 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003948 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003949 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003950 goto exit;
3951 }
Hanno Beckere1801392018-08-21 16:51:05 +01003952 else
3953 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003954 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3955 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3956 " (already %" MBEDTLS_PRINTF_SIZET
3957 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003958 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003959 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003960 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003961
Hanno Beckera02b0b42018-08-21 17:20:27 +01003962 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003963 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3965 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3966 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3967 " (already %" MBEDTLS_PRINTF_SIZET
3968 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003969 msg_len,
3970 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003971 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003972 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003973 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3974 goto exit;
3975 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003976 }
3977
Paul Elliottd48d5c62021-01-07 14:47:05 +00003978 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003979 msg_len ) );
3980
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003981 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3982 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003983 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003984 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003985 goto exit;
3986 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003987 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003988
3989 /* Prepare final header: copy msg_type, length and message_seq,
3990 * then add standardised fragment_offset and fragment_length */
3991 memcpy( hs_buf->data, ssl->in_msg, 6 );
3992 memset( hs_buf->data + 6, 0, 3 );
3993 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3994
3995 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003996
3997 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003998 }
3999 else
4000 {
4001 /* Make sure msg_type and length are consistent */
4002 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4003 {
4004 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4005 /* Ignore */
4006 goto exit;
4007 }
4008 }
4009
Hanno Becker4422bbb2018-08-20 09:40:19 +01004010 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004011 {
4012 size_t frag_len, frag_off;
4013 unsigned char * const msg = hs_buf->data + 12;
4014
4015 /*
4016 * Check and copy current fragment
4017 */
4018
4019 /* Validation of header fields already done in
4020 * mbedtls_ssl_prepare_handshake_record(). */
4021 frag_off = ssl_get_hs_frag_off( ssl );
4022 frag_len = ssl_get_hs_frag_len( ssl );
4023
Paul Elliottd48d5c62021-01-07 14:47:05 +00004024 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4025 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004026 frag_off, frag_len ) );
4027 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4028
4029 if( hs_buf->is_fragmented )
4030 {
4031 unsigned char * const bitmask = msg + msg_len;
4032 ssl_bitmask_set( bitmask, frag_off, frag_len );
4033 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4034 msg_len ) == 0 );
4035 }
4036 else
4037 {
4038 hs_buf->is_complete = 1;
4039 }
4040
4041 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4042 hs_buf->is_complete ? "" : "not yet " ) );
4043 }
4044
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004045 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004046 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004047
4048 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004049 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004050 break;
4051 }
4052
4053exit:
4054
4055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4056 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004057}
4058#endif /* MBEDTLS_SSL_PROTO_DTLS */
4059
Hanno Becker1097b342018-08-15 14:09:41 +01004060static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004061{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004062 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004063 * Consume last content-layer message and potentially
4064 * update in_msglen which keeps track of the contents'
4065 * consumption state.
4066 *
4067 * (1) Handshake messages:
4068 * Remove last handshake message, move content
4069 * and adapt in_msglen.
4070 *
4071 * (2) Alert messages:
4072 * Consume whole record content, in_msglen = 0.
4073 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004074 * (3) Change cipher spec:
4075 * Consume whole record content, in_msglen = 0.
4076 *
4077 * (4) Application data:
4078 * Don't do anything - the record layer provides
4079 * the application data as a stream transport
4080 * and consumes through mbedtls_ssl_read only.
4081 *
4082 */
4083
4084 /* Case (1): Handshake messages */
4085 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004086 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004087 /* Hard assertion to be sure that no application data
4088 * is in flight, as corrupting ssl->in_msglen during
4089 * ssl->in_offt != NULL is fatal. */
4090 if( ssl->in_offt != NULL )
4091 {
4092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4093 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4094 }
4095
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004096 /*
4097 * Get next Handshake message in the current record
4098 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004099
Hanno Becker4a810fb2017-05-24 16:27:30 +01004100 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004101 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004102 * current handshake content: If DTLS handshake
4103 * fragmentation is used, that's the fragment
4104 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004105 * size here is faulty and should be changed at
4106 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004107 * (2) While it doesn't seem to cause problems, one
4108 * has to be very careful not to assume that in_hslen
4109 * is always <= in_msglen in a sensible communication.
4110 * Again, it's wrong for DTLS handshake fragmentation.
4111 * The following check is therefore mandatory, and
4112 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004113 * Additionally, ssl->in_hslen might be arbitrarily out of
4114 * bounds after handling a DTLS message with an unexpected
4115 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004116 */
4117 if( ssl->in_hslen < ssl->in_msglen )
4118 {
4119 ssl->in_msglen -= ssl->in_hslen;
4120 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4121 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004122
Hanno Becker4a810fb2017-05-24 16:27:30 +01004123 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4124 ssl->in_msg, ssl->in_msglen );
4125 }
4126 else
4127 {
4128 ssl->in_msglen = 0;
4129 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004130
Hanno Becker4a810fb2017-05-24 16:27:30 +01004131 ssl->in_hslen = 0;
4132 }
4133 /* Case (4): Application data */
4134 else if( ssl->in_offt != NULL )
4135 {
4136 return( 0 );
4137 }
4138 /* Everything else (CCS & Alerts) */
4139 else
4140 {
4141 ssl->in_msglen = 0;
4142 }
4143
Hanno Becker1097b342018-08-15 14:09:41 +01004144 return( 0 );
4145}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004146
Hanno Beckere74d5562018-08-15 14:26:08 +01004147static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4148{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004149 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004150 return( 1 );
4151
4152 return( 0 );
4153}
4154
Hanno Becker5f066e72018-08-16 14:56:31 +01004155#if defined(MBEDTLS_SSL_PROTO_DTLS)
4156
4157static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4158{
4159 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4160 if( hs == NULL )
4161 return;
4162
Hanno Becker01315ea2018-08-21 17:22:17 +01004163 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004164 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004165 hs->buffering.total_bytes_buffered -=
4166 hs->buffering.future_record.len;
4167
4168 mbedtls_free( hs->buffering.future_record.data );
4169 hs->buffering.future_record.data = NULL;
4170 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004171}
4172
4173static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4174{
4175 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4176 unsigned char * rec;
4177 size_t rec_len;
4178 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004179#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4180 size_t in_buf_len = ssl->in_buf_len;
4181#else
4182 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4183#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004184 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4185 return( 0 );
4186
4187 if( hs == NULL )
4188 return( 0 );
4189
Hanno Becker5f066e72018-08-16 14:56:31 +01004190 rec = hs->buffering.future_record.data;
4191 rec_len = hs->buffering.future_record.len;
4192 rec_epoch = hs->buffering.future_record.epoch;
4193
4194 if( rec == NULL )
4195 return( 0 );
4196
Hanno Becker4cb782d2018-08-20 11:19:05 +01004197 /* Only consider loading future records if the
4198 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004199 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004200 return( 0 );
4201
Hanno Becker5f066e72018-08-16 14:56:31 +01004202 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4203
4204 if( rec_epoch != ssl->in_epoch )
4205 {
4206 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4207 goto exit;
4208 }
4209
4210 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4211
4212 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004213 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004214 {
4215 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4216 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4217 }
4218
4219 memcpy( ssl->in_hdr, rec, rec_len );
4220 ssl->in_left = rec_len;
4221 ssl->next_record_offset = 0;
4222
4223 ssl_free_buffered_record( ssl );
4224
4225exit:
4226 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4227 return( 0 );
4228}
4229
Hanno Becker519f15d2019-07-11 12:43:20 +01004230static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4231 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004232{
4233 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004234
4235 /* Don't buffer future records outside handshakes. */
4236 if( hs == NULL )
4237 return( 0 );
4238
4239 /* Only buffer handshake records (we are only interested
4240 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004241 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004242 return( 0 );
4243
4244 /* Don't buffer more than one future epoch record. */
4245 if( hs->buffering.future_record.data != NULL )
4246 return( 0 );
4247
Hanno Becker01315ea2018-08-21 17:22:17 +01004248 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004249 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004250 hs->buffering.total_bytes_buffered ) )
4251 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004252 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4253 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4254 " (already %" MBEDTLS_PRINTF_SIZET
4255 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004256 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004257 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004258 return( 0 );
4259 }
4260
Hanno Becker5f066e72018-08-16 14:56:31 +01004261 /* Buffer record */
4262 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004263 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004264 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004265
4266 /* ssl_parse_record_header() only considers records
4267 * of the next epoch as candidates for buffering. */
4268 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004269 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004270
4271 hs->buffering.future_record.data =
4272 mbedtls_calloc( 1, hs->buffering.future_record.len );
4273 if( hs->buffering.future_record.data == NULL )
4274 {
4275 /* If we run out of RAM trying to buffer a
4276 * record from the next epoch, just ignore. */
4277 return( 0 );
4278 }
4279
Hanno Becker519f15d2019-07-11 12:43:20 +01004280 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004281
Hanno Becker519f15d2019-07-11 12:43:20 +01004282 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004283 return( 0 );
4284}
4285
4286#endif /* MBEDTLS_SSL_PROTO_DTLS */
4287
Hanno Beckere74d5562018-08-15 14:26:08 +01004288static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004289{
Janos Follath865b3eb2019-12-16 11:46:15 +00004290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004291 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004292
Hanno Becker5f066e72018-08-16 14:56:31 +01004293#if defined(MBEDTLS_SSL_PROTO_DTLS)
4294 /* We might have buffered a future record; if so,
4295 * and if the epoch matches now, load it.
4296 * On success, this call will set ssl->in_left to
4297 * the length of the buffered record, so that
4298 * the calls to ssl_fetch_input() below will
4299 * essentially be no-ops. */
4300 ret = ssl_load_buffered_record( ssl );
4301 if( ret != 0 )
4302 return( ret );
4303#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004304
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004305 /* Ensure that we have enough space available for the default form
4306 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4307 * with no space for CIDs counted in). */
4308 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4309 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004310 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004311 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004312 return( ret );
4313 }
4314
Hanno Beckere5e7e782019-07-11 12:29:35 +01004315 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4316 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004317 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004318#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004319 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004320 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004321 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4322 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004323 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004324 if( ret != 0 )
4325 return( ret );
4326
4327 /* Fall through to handling of unexpected records */
4328 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4329 }
4330
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004331 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4332 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004333#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004334 /* Reset in pointers to default state for TLS/DTLS records,
4335 * assuming no CID and no offset between record content and
4336 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004337 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004338
Hanno Becker7ae20e02019-07-12 08:33:49 +01004339 /* Setup internal message pointers from record structure. */
4340 ssl->in_msgtype = rec.type;
4341#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4342 ssl->in_len = ssl->in_cid + rec.cid_len;
4343#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4344 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4345 ssl->in_msglen = rec.data_len;
4346
Hanno Becker2fddd372019-07-10 14:37:41 +01004347 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004348 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004349 if( ret != 0 )
4350 return( ret );
4351#endif
4352
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004353 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004354 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004355
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4357 "(header)" ) );
4358 }
4359 else
4360 {
4361 /* Skip invalid record and the rest of the datagram */
4362 ssl->next_record_offset = 0;
4363 ssl->in_left = 0;
4364
4365 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4366 "(header)" ) );
4367 }
4368
4369 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004370 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004371 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004372 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004373#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004374 {
4375 return( ret );
4376 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004377 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004379#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004380 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004381 {
Hanno Beckera8814792019-07-10 15:01:45 +01004382 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004383 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004384 if( ssl->next_record_offset < ssl->in_left )
4385 {
4386 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4387 }
4388 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004389 else
4390#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004391 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004392 /*
4393 * Fetch record contents from underlying transport.
4394 */
Hanno Beckera3175662019-07-11 12:50:29 +01004395 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004396 if( ret != 0 )
4397 {
4398 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4399 return( ret );
4400 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004401
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004402 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004403 }
4404
4405 /*
4406 * Decrypt record contents.
4407 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004408
Hanno Beckerfdf66042019-07-11 13:07:45 +01004409 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004410 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004411#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004412 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004413 {
4414 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004415 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004416 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004417 /* Except when waiting for Finished as a bad mac here
4418 * probably means something went wrong in the handshake
4419 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4420 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4421 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4422 {
4423#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4424 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4425 {
4426 mbedtls_ssl_send_alert_message( ssl,
4427 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4428 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4429 }
4430#endif
4431 return( ret );
4432 }
4433
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004434 if( ssl->conf->badmac_limit != 0 &&
4435 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004436 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004437 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4438 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004439 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004440
Hanno Becker4a810fb2017-05-24 16:27:30 +01004441 /* As above, invalid records cause
4442 * dismissal of the whole datagram. */
4443
4444 ssl->next_record_offset = 0;
4445 ssl->in_left = 0;
4446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004447 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004448 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004449 }
4450
4451 return( ret );
4452 }
4453 else
4454#endif
4455 {
4456 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004457#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4458 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004459 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004460 mbedtls_ssl_send_alert_message( ssl,
4461 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4462 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004463 }
4464#endif
4465 return( ret );
4466 }
4467 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004468
Hanno Becker44d89b22019-07-12 09:40:44 +01004469
4470 /* Reset in pointers to default state for TLS/DTLS records,
4471 * assuming no CID and no offset between record content and
4472 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004473 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004474#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4475 ssl->in_len = ssl->in_cid + rec.cid_len;
4476#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004477 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004478
Hanno Becker8685c822019-07-12 09:37:30 +01004479 /* The record content type may change during decryption,
4480 * so re-read it. */
4481 ssl->in_msgtype = rec.type;
4482 /* Also update the input buffer, because unfortunately
4483 * the server-side ssl_parse_client_hello() reparses the
4484 * record header when receiving a ClientHello initiating
4485 * a renegotiation. */
4486 ssl->in_hdr[0] = rec.type;
4487 ssl->in_msg = rec.buf + rec.data_offset;
4488 ssl->in_msglen = rec.data_len;
4489 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4490 ssl->in_len[1] = (unsigned char)( rec.data_len );
4491
Simon Butcher99000142016-10-13 17:21:01 +01004492 return( 0 );
4493}
4494
4495int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4496{
Janos Follath865b3eb2019-12-16 11:46:15 +00004497 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004498
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004499 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004500 * Handle particular types of records
4501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004502 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004503 {
Simon Butcher99000142016-10-13 17:21:01 +01004504 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4505 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004506 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004507 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004508 }
4509
Hanno Beckere678eaa2018-08-21 14:57:46 +01004510 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004511 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004512 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004513 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004514 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004515 ssl->in_msglen ) );
4516 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004517 }
4518
Hanno Beckere678eaa2018-08-21 14:57:46 +01004519 if( ssl->in_msg[0] != 1 )
4520 {
4521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4522 ssl->in_msg[0] ) );
4523 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4524 }
4525
4526#if defined(MBEDTLS_SSL_PROTO_DTLS)
4527 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4528 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4529 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4530 {
4531 if( ssl->handshake == NULL )
4532 {
4533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4534 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4535 }
4536
4537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4538 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4539 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004540#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004541 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004543 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004544 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004545 if( ssl->in_msglen != 2 )
4546 {
4547 /* Note: Standard allows for more than one 2 byte alert
4548 to be packed in a single message, but Mbed TLS doesn't
4549 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004551 ssl->in_msglen ) );
4552 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4553 }
4554
Paul Elliott9f352112020-12-09 14:55:45 +00004555 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004556 ssl->in_msg[0], ssl->in_msg[1] ) );
4557
4558 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004559 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004562 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004564 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004566 }
4567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4569 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004570 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004571 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4572 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004573 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004574
4575#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4576 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4577 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4578 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004579 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004580 /* Will be handled when trying to parse ServerHello */
4581 return( 0 );
4582 }
4583#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004584 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004585 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004586 }
4587
Hanno Beckerc76c6192017-06-06 10:03:17 +01004588#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004589 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004590 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004591 /* Drop unexpected ApplicationData records,
4592 * except at the beginning of renegotiations */
4593 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4594 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4595#if defined(MBEDTLS_SSL_RENEGOTIATION)
4596 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4597 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004598#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004599 )
4600 {
4601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4602 return( MBEDTLS_ERR_SSL_NON_FATAL );
4603 }
4604
4605 if( ssl->handshake != NULL &&
4606 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4607 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004608 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004609 }
4610 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004611#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004612
Paul Bakker5121ce52009-01-03 21:22:43 +00004613 return( 0 );
4614}
4615
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004616int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004617{
irwir6c0da642019-09-26 21:07:41 +03004618 return( mbedtls_ssl_send_alert_message( ssl,
4619 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4620 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004621}
4622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004623int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004624 unsigned char level,
4625 unsigned char message )
4626{
Janos Follath865b3eb2019-12-16 11:46:15 +00004627 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004628
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004629 if( ssl == NULL || ssl->conf == NULL )
4630 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004633 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004635 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004636 ssl->out_msglen = 2;
4637 ssl->out_msg[0] = level;
4638 ssl->out_msg[1] = message;
4639
Hanno Becker67bc7c32018-08-06 11:33:50 +01004640 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004641 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004642 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004643 return( ret );
4644 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004646
4647 return( 0 );
4648}
4649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004651{
Janos Follath865b3eb2019-12-16 11:46:15 +00004652 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004654 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004655
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004656 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004657 ssl->out_msglen = 1;
4658 ssl->out_msg[0] = 1;
4659
Paul Bakker5121ce52009-01-03 21:22:43 +00004660 ssl->state++;
4661
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004662 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004663 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004664 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004665 return( ret );
4666 }
4667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004668 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004669
4670 return( 0 );
4671}
4672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004673int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004674{
Janos Follath865b3eb2019-12-16 11:46:15 +00004675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004678
Hanno Becker327c93b2018-08-15 13:56:18 +01004679 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004681 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004682 return( ret );
4683 }
4684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004685 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004687 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004688 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4689 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004691 }
4692
Hanno Beckere678eaa2018-08-21 14:57:46 +01004693 /* CCS records are only accepted if they have length 1 and content '1',
4694 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004695
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004696 /*
4697 * Switch to our negotiated transform and session parameters for inbound
4698 * data.
4699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004700 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004701 ssl->transform_in = ssl->transform_negotiate;
4702 ssl->session_in = ssl->session_negotiate;
4703
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004705 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004706 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004707#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004708 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004709#endif
4710
4711 /* Increment epoch */
4712 if( ++ssl->in_epoch == 0 )
4713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004715 /* This is highly unlikely to happen for legitimate reasons, so
4716 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004718 }
4719 }
4720 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004722 memset( ssl->in_ctr, 0, 8 );
4723
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004724 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004725
Paul Bakker5121ce52009-01-03 21:22:43 +00004726 ssl->state++;
4727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004729
4730 return( 0 );
4731}
4732
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004733/* Once ssl->out_hdr as the address of the beginning of the
4734 * next outgoing record is set, deduce the other pointers.
4735 *
4736 * Note: For TLS, we save the implicit record sequence number
4737 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4738 * and the caller has to make sure there's space for this.
4739 */
4740
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004741static size_t ssl_transform_get_explicit_iv_len(
4742 mbedtls_ssl_transform const *transform )
4743{
TRodziewiczef73f012021-05-13 14:53:36 +02004744 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004745 return( 0 );
4746
4747 return( transform->ivlen - transform->fixed_ivlen );
4748}
4749
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004750void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4751 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004752{
4753#if defined(MBEDTLS_SSL_PROTO_DTLS)
4754 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4755 {
4756 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004757#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004758 ssl->out_cid = ssl->out_ctr + 8;
4759 ssl->out_len = ssl->out_cid;
4760 if( transform != NULL )
4761 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004762#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004763 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004764#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004765 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004766 }
4767 else
4768#endif
4769 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004770 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004771#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004772 ssl->out_cid = ssl->out_len;
4773#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004774 ssl->out_iv = ssl->out_hdr + 5;
4775 }
4776
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004777 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004778 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004779 if( transform != NULL )
4780 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004781}
4782
4783/* Once ssl->in_hdr as the address of the beginning of the
4784 * next incoming record is set, deduce the other pointers.
4785 *
4786 * Note: For TLS, we save the implicit record sequence number
4787 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4788 * and the caller has to make sure there's space for this.
4789 */
4790
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004791void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004792{
Hanno Becker79594fd2019-05-08 09:38:41 +01004793 /* This function sets the pointers to match the case
4794 * of unprotected TLS/DTLS records, with both ssl->in_iv
4795 * and ssl->in_msg pointing to the beginning of the record
4796 * content.
4797 *
4798 * When decrypting a protected record, ssl->in_msg
4799 * will be shifted to point to the beginning of the
4800 * record plaintext.
4801 */
4802
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004803#if defined(MBEDTLS_SSL_PROTO_DTLS)
4804 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4805 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004806 /* This sets the header pointers to match records
4807 * without CID. When we receive a record containing
4808 * a CID, the fields are shifted accordingly in
4809 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004810 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004811#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004812 ssl->in_cid = ssl->in_ctr + 8;
4813 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004814#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004815 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004816#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004817 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004818 }
4819 else
4820#endif
4821 {
4822 ssl->in_ctr = ssl->in_hdr - 8;
4823 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004824#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004825 ssl->in_cid = ssl->in_len;
4826#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004827 ssl->in_iv = ssl->in_hdr + 5;
4828 }
4829
Hanno Becker79594fd2019-05-08 09:38:41 +01004830 /* This will be adjusted at record decryption time. */
4831 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004832}
4833
Paul Bakker5121ce52009-01-03 21:22:43 +00004834/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004835 * Setup an SSL context
4836 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004837
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004838void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004839{
4840 /* Set the incoming and outgoing record pointers. */
4841#if defined(MBEDTLS_SSL_PROTO_DTLS)
4842 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4843 {
4844 ssl->out_hdr = ssl->out_buf;
4845 ssl->in_hdr = ssl->in_buf;
4846 }
4847 else
4848#endif /* MBEDTLS_SSL_PROTO_DTLS */
4849 {
Hanno Becker12078f42021-03-02 15:28:41 +00004850 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004851 ssl->out_hdr = ssl->out_buf + 8;
4852 ssl->in_hdr = ssl->in_buf + 8;
4853 }
4854
4855 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004856 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4857 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004858}
4859
Paul Bakker5121ce52009-01-03 21:22:43 +00004860/*
4861 * SSL get accessors
4862 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004863size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004864{
4865 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4866}
4867
Hanno Becker8b170a02017-10-10 11:51:19 +01004868int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4869{
4870 /*
4871 * Case A: We're currently holding back
4872 * a message for further processing.
4873 */
4874
4875 if( ssl->keep_current_message == 1 )
4876 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004877 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004878 return( 1 );
4879 }
4880
4881 /*
4882 * Case B: Further records are pending in the current datagram.
4883 */
4884
4885#if defined(MBEDTLS_SSL_PROTO_DTLS)
4886 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4887 ssl->in_left > ssl->next_record_offset )
4888 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004889 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004890 return( 1 );
4891 }
4892#endif /* MBEDTLS_SSL_PROTO_DTLS */
4893
4894 /*
4895 * Case C: A handshake message is being processed.
4896 */
4897
Hanno Becker8b170a02017-10-10 11:51:19 +01004898 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4899 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004900 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004901 return( 1 );
4902 }
4903
4904 /*
4905 * Case D: An application data message is being processed
4906 */
4907 if( ssl->in_offt != NULL )
4908 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004909 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004910 return( 1 );
4911 }
4912
4913 /*
4914 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004915 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004916 * we implement support for multiple alerts in single records.
4917 */
4918
4919 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4920 return( 0 );
4921}
4922
Paul Bakker43ca69c2011-01-15 17:35:19 +00004923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004925{
Hanno Becker3136ede2018-08-17 15:28:19 +01004926 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004927 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004928 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004929
Hanno Becker5903de42019-05-03 14:46:38 +01004930 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4931
Hanno Becker78640902018-08-13 16:35:15 +01004932 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004933 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004936 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937 case MBEDTLS_MODE_GCM:
4938 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004939 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004940 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004941 transform_expansion = transform->minlen;
4942 break;
4943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004944 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004945
4946 block_size = mbedtls_cipher_get_block_size(
4947 &transform->cipher_ctx_enc );
4948
Hanno Becker3136ede2018-08-17 15:28:19 +01004949 /* Expansion due to the addition of the MAC. */
4950 transform_expansion += transform->maclen;
4951
4952 /* Expansion due to the addition of CBC padding;
4953 * Theoretically up to 256 bytes, but we never use
4954 * more than the block size of the underlying cipher. */
4955 transform_expansion += block_size;
4956
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004957 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004958 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004959#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004960 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004961#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004962
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004963 break;
4964
4965 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004966 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004968 }
4969
Hanno Beckera0e20d02019-05-15 14:03:01 +01004970#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004971 if( transform->out_cid_len != 0 )
4972 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004973#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004974
Hanno Becker5903de42019-05-03 14:46:38 +01004975 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004976}
4977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004978#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004979/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004980 * Check record counters and renegotiate if they're above the limit.
4981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004982static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004983{
Hanno Beckerdd772292020-02-05 10:38:31 +00004984 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004985 int in_ctr_cmp;
4986 int out_ctr_cmp;
4987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004988 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4989 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004990 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004991 {
4992 return( 0 );
4993 }
4994
Andres AG2196c7f2016-12-15 17:01:16 +00004995 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
4996 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01004997 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00004998 ssl->conf->renego_period + ep_len, 8 - ep_len );
4999
5000 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005001 {
5002 return( 0 );
5003 }
5004
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005006 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005007}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005008#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005009
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005010/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005011 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005012 * may only be sent for the purpose of initiating renegotiations.
5013 *
5014 * This function is introduced as a separate helper since the handling
5015 * of post-handshake handshake messages changes significantly in TLS 1.3,
5016 * and having a helper function allows to distinguish between TLS <= 1.2 and
5017 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5018 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005019static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005020{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005021 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005022
5023 /*
5024 * - For client-side, expect SERVER_HELLO_REQUEST.
5025 * - For server-side, expect CLIENT_HELLO.
5026 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5027 */
5028
5029#if defined(MBEDTLS_SSL_CLI_C)
5030 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5031 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5032 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5033 {
5034 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5035
5036 /* With DTLS, drop the packet (probably from last handshake) */
5037#if defined(MBEDTLS_SSL_PROTO_DTLS)
5038 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5039 {
5040 return( 0 );
5041 }
5042#endif
5043 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5044 }
5045#endif /* MBEDTLS_SSL_CLI_C */
5046
5047#if defined(MBEDTLS_SSL_SRV_C)
5048 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5049 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5050 {
5051 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5052
5053 /* With DTLS, drop the packet (probably from last handshake) */
5054#if defined(MBEDTLS_SSL_PROTO_DTLS)
5055 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5056 {
5057 return( 0 );
5058 }
5059#endif
5060 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5061 }
5062#endif /* MBEDTLS_SSL_SRV_C */
5063
5064#if defined(MBEDTLS_SSL_RENEGOTIATION)
5065 /* Determine whether renegotiation attempt should be accepted */
5066 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5067 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5068 ssl->conf->allow_legacy_renegotiation ==
5069 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5070 {
5071 /*
5072 * Accept renegotiation request
5073 */
5074
5075 /* DTLS clients need to know renego is server-initiated */
5076#if defined(MBEDTLS_SSL_PROTO_DTLS)
5077 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5078 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5079 {
5080 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5081 }
5082#endif
5083 ret = mbedtls_ssl_start_renegotiation( ssl );
5084 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5085 ret != 0 )
5086 {
5087 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5088 ret );
5089 return( ret );
5090 }
5091 }
5092 else
5093#endif /* MBEDTLS_SSL_RENEGOTIATION */
5094 {
5095 /*
5096 * Refuse renegotiation
5097 */
5098
5099 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5100
TRodziewicz0f82ec62021-05-12 17:49:18 +02005101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005102 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5103 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5104 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005105 {
TRodziewicz345165c2021-07-06 13:42:11 +02005106 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005107 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005108#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005109 }
5110
5111 return( 0 );
5112}
5113
Paul Bakker48916f92012-09-16 19:57:18 +00005114/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005115 * Receive application data decrypted from the SSL layer
5116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005117int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005118{
Janos Follath865b3eb2019-12-16 11:46:15 +00005119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005120 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005121
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005122 if( ssl == NULL || ssl->conf == NULL )
5123 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5124
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005125 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005127#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005128 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005129 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005130 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005131 return( ret );
5132
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005133 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005134 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005135 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005136 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005137 return( ret );
5138 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005139 }
5140#endif
5141
Hanno Becker4a810fb2017-05-24 16:27:30 +01005142 /*
5143 * Check if renegotiation is necessary and/or handshake is
5144 * in process. If yes, perform/continue, and fall through
5145 * if an unexpected packet is received while the client
5146 * is waiting for the ServerHello.
5147 *
5148 * (There is no equivalent to the last condition on
5149 * the server-side as it is not treated as within
5150 * a handshake while waiting for the ClientHello
5151 * after a renegotiation request.)
5152 */
5153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005155 ret = ssl_check_ctr_renegotiate( ssl );
5156 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5157 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005158 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005159 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005160 return( ret );
5161 }
5162#endif
5163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005164 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005165 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005166 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005167 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5168 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005169 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005170 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005171 return( ret );
5172 }
5173 }
5174
Hanno Beckere41158b2017-10-23 13:30:32 +01005175 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005176 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005177 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005178 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005179 if( ssl->f_get_timer != NULL &&
5180 ssl->f_get_timer( ssl->p_timer ) == -1 )
5181 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005182 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005183 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005184
Hanno Becker327c93b2018-08-15 13:56:18 +01005185 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005186 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005187 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5188 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005189
Hanno Becker4a810fb2017-05-24 16:27:30 +01005190 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5191 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005192 }
5193
5194 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005195 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005196 {
5197 /*
5198 * OpenSSL sends empty messages to randomize the IV
5199 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005200 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005201 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005202 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005203 return( 0 );
5204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005205 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005206 return( ret );
5207 }
5208 }
5209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005210 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005211 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005212 ret = ssl_handle_hs_message_post_handshake( ssl );
5213 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005214 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005215 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5216 ret );
5217 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005218 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005219
Hanno Beckerf26cc722021-04-21 07:30:13 +01005220 /* At this point, we don't know whether the renegotiation triggered
5221 * by the post-handshake message has been completed or not. The cases
5222 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005223 * 1) The renegotiation is complete. In this case, no new record
5224 * has been read yet.
5225 * 2) The renegotiation is incomplete because the client received
5226 * an application data record while awaiting the ServerHello.
5227 * 3) The renegotiation is incomplete because the client received
5228 * a non-handshake, non-application data message while awaiting
5229 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005230 *
5231 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005232 * - For 1), the next iteration will read a new record and check
5233 * if it's application data.
5234 * - For 2), the loop condition isn't satisfied as application data
5235 * is present, hence continue is the same as break
5236 * - For 3), the loop condition is satisfied and read_record
5237 * will re-deliver the message that was held back by the client
5238 * when expecting the ServerHello.
5239 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005240
Hanno Becker90333da2017-10-10 11:27:13 +01005241 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005242 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005243#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005244 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005245 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005246 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005247 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005248 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005249 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005250 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005251 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005252 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005253 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005254 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005255 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005256#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005258 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5259 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005260 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005261 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005262 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005263 }
5264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005265 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5268 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005269 }
5270
5271 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005272
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005273 /* We're going to return something now, cancel timer,
5274 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005275 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005276 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005277
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005278#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005279 /* If we requested renego but received AppData, resend HelloRequest.
5280 * Do it now, after setting in_offt, to avoid taking this branch
5281 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005282#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005283 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005284 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005285 {
Hanno Becker786300f2020-02-05 10:46:40 +00005286 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005287 {
Hanno Becker786300f2020-02-05 10:46:40 +00005288 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5289 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005290 return( ret );
5291 }
5292 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005293#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005294#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005295 }
5296
5297 n = ( len < ssl->in_msglen )
5298 ? len : ssl->in_msglen;
5299
5300 memcpy( buf, ssl->in_offt, n );
5301 ssl->in_msglen -= n;
5302
gabor-mezei-arma3214132020-07-15 10:55:00 +02005303 /* Zeroising the plaintext buffer to erase unused application data
5304 from the memory. */
5305 mbedtls_platform_zeroize( ssl->in_offt, n );
5306
Paul Bakker5121ce52009-01-03 21:22:43 +00005307 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005308 {
5309 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005310 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005311 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005312 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005313 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005314 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005315 /* more data available */
5316 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005317 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005319 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005320
Paul Bakker23986e52011-04-24 08:57:21 +00005321 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005322}
5323
5324/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005325 * Send application data to be encrypted by the SSL layer, taking care of max
5326 * fragment length and buffer size.
5327 *
5328 * According to RFC 5246 Section 6.2.1:
5329 *
5330 * Zero-length fragments of Application data MAY be sent as they are
5331 * potentially useful as a traffic analysis countermeasure.
5332 *
5333 * Therefore, it is possible that the input message length is 0 and the
5334 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005335 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005336static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005337 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005338{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005339 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5340 const size_t max_len = (size_t) ret;
5341
5342 if( ret < 0 )
5343 {
5344 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5345 return( ret );
5346 }
5347
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005348 if( len > max_len )
5349 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005350#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005351 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005352 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005353 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005354 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5355 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005356 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005358 }
5359 else
5360#endif
5361 len = max_len;
5362 }
Paul Bakker887bd502011-06-08 13:10:54 +00005363
Paul Bakker5121ce52009-01-03 21:22:43 +00005364 if( ssl->out_left != 0 )
5365 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005366 /*
5367 * The user has previously tried to send the data and
5368 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5369 * written. In this case, we expect the high-level write function
5370 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005372 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005373 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005374 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005375 return( ret );
5376 }
5377 }
Paul Bakker887bd502011-06-08 13:10:54 +00005378 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005379 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005380 /*
5381 * The user is trying to send a message the first time, so we need to
5382 * copy the data into the internal buffers and setup the data structure
5383 * to keep track of partial writes
5384 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005385 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005387 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005388
Hanno Becker67bc7c32018-08-06 11:33:50 +01005389 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005390 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005392 return( ret );
5393 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005394 }
5395
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005396 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005397}
5398
5399/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005400 * Write application data (public-facing wrapper)
5401 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005402int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005403{
Janos Follath865b3eb2019-12-16 11:46:15 +00005404 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005405
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005406 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005407
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005408 if( ssl == NULL || ssl->conf == NULL )
5409 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5410
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005411#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005412 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5413 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005414 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005415 return( ret );
5416 }
5417#endif
5418
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005419 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005420 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005421 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005422 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005423 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005424 return( ret );
5425 }
5426 }
5427
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005428 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005429
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005430 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005431
5432 return( ret );
5433}
5434
5435/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 * Notify the peer that the connection is being closed
5437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005438int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005439{
Janos Follath865b3eb2019-12-16 11:46:15 +00005440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005441
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005442 if( ssl == NULL || ssl->conf == NULL )
5443 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
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 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005451 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5453 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5454 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005455 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005456 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005457 return( ret );
5458 }
5459 }
5460
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005461 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005462
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005463 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005464}
5465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005467{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005468 if( transform == NULL )
5469 return;
5470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5472 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005473
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005474#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475 mbedtls_md_free( &transform->md_ctx_enc );
5476 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005477#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005478
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005479 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005480}
5481
Hanno Becker0271f962018-08-16 13:23:47 +01005482#if defined(MBEDTLS_SSL_PROTO_DTLS)
5483
Hanno Becker533ab5f2020-02-05 10:49:13 +00005484void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005485{
5486 unsigned offset;
5487 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5488
5489 if( hs == NULL )
5490 return;
5491
Hanno Becker283f5ef2018-08-24 09:34:47 +01005492 ssl_free_buffered_record( ssl );
5493
Hanno Becker0271f962018-08-16 13:23:47 +01005494 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005495 ssl_buffering_free_slot( ssl, offset );
5496}
5497
5498static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5499 uint8_t slot )
5500{
5501 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5502 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005503
5504 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5505 return;
5506
Hanno Beckere605b192018-08-21 15:59:07 +01005507 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005508 {
Hanno Beckere605b192018-08-21 15:59:07 +01005509 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005510 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005511 mbedtls_free( hs_buf->data );
5512 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005513 }
5514}
5515
5516#endif /* MBEDTLS_SSL_PROTO_DTLS */
5517
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005518/*
5519 * Convert version numbers to/from wire format
5520 * and, for DTLS, to/from TLS equivalent.
5521 *
5522 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005523 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005524 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005527 unsigned char ver[2] )
5528{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005529#if defined(MBEDTLS_SSL_PROTO_DTLS)
5530 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005532 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005533 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5534
5535 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5536 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5537 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005538 else
5539#else
5540 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005541#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005542 {
5543 ver[0] = (unsigned char) major;
5544 ver[1] = (unsigned char) minor;
5545 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005546}
5547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005548void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005549 const unsigned char ver[2] )
5550{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005551#if defined(MBEDTLS_SSL_PROTO_DTLS)
5552 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005553 {
5554 *major = 255 - ver[0] + 2;
5555 *minor = 255 - ver[1] + 1;
5556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005557 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005558 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5559 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005560 else
5561#else
5562 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005563#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005564 {
5565 *major = ver[0];
5566 *minor = ver[1];
5567 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005568}
5569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005570#endif /* MBEDTLS_SSL_TLS_C */