blob: 301e50e3451f893ee52f8a6dd5a8add93bd72d85 [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é-Gonnard2ddec432020-08-24 12:49:23 +0200942
943/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200944 * Constant-flow conditional memcpy:
945 * - if c1 == c2, equivalent to memcpy(dst, src, len),
946 * - otherwise, a no-op,
947 * but with execution flow independent of the values of c1 and c2.
948 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200949 * This function is implemented without using comparison operators, as those
950 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200951 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200952static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
953 const unsigned char *src,
954 size_t len,
955 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200956{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200957 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200958 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
959 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200960
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200961 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200962 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200963 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200964}
965
966/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200967 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200968 *
969 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
970 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200971 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200972MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200973 mbedtls_md_context_t *ctx,
974 const unsigned char *add_data, size_t add_data_len,
975 const unsigned char *data, size_t data_len_secret,
976 size_t min_data_len, size_t max_data_len,
977 unsigned char *output )
978{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200979 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200980 * This function breaks the HMAC abstraction and uses the md_clone()
981 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200982 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200983 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +0200984 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200985 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200986 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200987 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
988 * minlen, then cloning the context, and for each byte up to maxlen
989 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200990 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200991 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200992 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200993 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +0200994 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +0200995 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200996 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +0200997 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200998 const unsigned char * const okey = ikey + block_size;
999 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001000
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001001 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1002 mbedtls_md_context_t aux;
1003 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001005
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001006 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001007
1008#define MD_CHK( func_call ) \
1009 do { \
1010 ret = (func_call); \
1011 if( ret != 0 ) \
1012 goto cleanup; \
1013 } while( 0 )
1014
1015 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001016
1017 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1018 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001019 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1020 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001021
1022 /* For each possible length, compute the hash up to that point */
1023 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001024 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001025 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1026 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001027 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001028 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1029 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001030
1031 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001032 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001033 }
1034
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001035 /* The context needs to finish() before it starts() again */
1036 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1037
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001038 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001039 MD_CHK( mbedtls_md_starts( ctx ) );
1040 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1041 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1042 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001043
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001044 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001045 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001046
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001047#undef MD_CHK
1048
1049cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001050 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001051 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001052}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001053
1054/*
1055 * Constant-flow memcpy from variable position in buffer.
1056 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001057 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001058 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001059MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001060 unsigned char *dst,
1061 const unsigned char *src_base,
1062 size_t offset_secret,
1063 size_t offset_min, size_t offset_max,
1064 size_t len )
1065{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001066 size_t offset;
1067
1068 for( offset = offset_min; offset <= offset_max; offset++ )
1069 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001070 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1071 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001072 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001073}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001074#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001075
Hanno Becker605949f2019-07-12 08:23:59 +01001076int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001077 mbedtls_ssl_transform *transform,
1078 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001079{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001080 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001082 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001083#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001084 size_t padlen = 0, correct = 1;
1085#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001086 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001087 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001088 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001089
Hanno Beckera18d1322018-01-03 14:27:32 +00001090#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001091 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001092 ((void) ssl);
1093#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001094
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001096 if( rec == NULL ||
1097 rec->buf == NULL ||
1098 rec->buf_len < rec->data_offset ||
1099 rec->buf_len - rec->data_offset < rec->data_len )
1100 {
1101 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001103 }
1104
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001105 data = rec->buf + rec->data_offset;
1106 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001107
Hanno Beckera0e20d02019-05-15 14:03:01 +01001108#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001109 /*
1110 * Match record's CID with incoming CID.
1111 */
Hanno Becker938489a2019-05-08 13:02:22 +01001112 if( rec->cid_len != transform->in_cid_len ||
1113 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1114 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001115 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001116 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001117#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001118
Hanno Beckerd086bf02021-03-22 13:01:27 +00001119#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001121 {
1122 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001123 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1124 transform->iv_dec,
1125 transform->ivlen,
1126 data, rec->data_len,
1127 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001128 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001130 return( ret );
1131 }
1132
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001133 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001134 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1136 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001137 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001138 }
Paul Bakker68884e32013-01-07 18:20:04 +01001139 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001140#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001141#if defined(MBEDTLS_GCM_C) || \
1142 defined(MBEDTLS_CCM_C) || \
1143 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001145 mode == MBEDTLS_MODE_CCM ||
1146 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001147 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001148 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001149 unsigned char *dynamic_iv;
1150 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001151
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001152 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001153 * Extract dynamic part of nonce for AEAD decryption.
1154 *
1155 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1156 * part of the IV is prepended to the ciphertext and
1157 * can be chosen freely - in particular, it need not
1158 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001159 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001160 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001161 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001162 {
1163 if( rec->data_len < dynamic_iv_len )
1164 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1166 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001167 rec->data_len,
1168 dynamic_iv_len ) );
1169 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1170 }
1171 dynamic_iv = data;
1172
1173 data += dynamic_iv_len;
1174 rec->data_offset += dynamic_iv_len;
1175 rec->data_len -= dynamic_iv_len;
1176 }
Hanno Becker17263802020-05-28 07:05:48 +01001177 else
1178 {
1179 dynamic_iv = rec->ctr;
1180 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001181
1182 /* Check that there's space for the authentication tag. */
1183 if( rec->data_len < transform->taglen )
1184 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001185 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1186 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001187 rec->data_len,
1188 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001190 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001191 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001192
Hanno Beckerdf8be222020-05-21 15:30:57 +01001193 /*
1194 * Prepare nonce from dynamic and static parts.
1195 */
Hanno Becker17263802020-05-28 07:05:48 +01001196 ssl_build_record_nonce( iv, sizeof( iv ),
1197 transform->iv_dec,
1198 transform->fixed_ivlen,
1199 dynamic_iv,
1200 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001201
Hanno Beckerdf8be222020-05-21 15:30:57 +01001202 /*
1203 * Build additional data for AEAD encryption.
1204 * This depends on the TLS version.
1205 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001206 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1207 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001208 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001209 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001210
Hanno Beckerd96a6522019-07-10 13:55:25 +01001211 /* Because of the check above, we know that there are
1212 * explicit_iv_len Bytes preceeding data, and taglen
1213 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001214 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001215 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001217 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001218 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001219 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001220
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001221 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001222 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001223 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001224 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001225 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001226 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001227 data, rec->data_len + transform->taglen, /* src */
1228 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001229 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001230 {
TRodziewicz18efb732021-04-29 23:12:19 +02001231 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1234 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001235
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001236 return( ret );
1237 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001238 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001239
Hanno Beckerd96a6522019-07-10 13:55:25 +01001240 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001241 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001242 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1244 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001245 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001246 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001247 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001249#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001250 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001251 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001252 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001253
Paul Bakker5121ce52009-01-03 21:22:43 +00001254 /*
Paul Bakker45829992013-01-03 14:52:21 +01001255 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001256 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001257#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001258 /* The ciphertext is prefixed with the CBC IV. */
1259 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001260#endif
Paul Bakker45829992013-01-03 14:52:21 +01001261
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001262 /* Size considerations:
1263 *
1264 * - The CBC cipher text must not be empty and hence
1265 * at least of size transform->ivlen.
1266 *
1267 * Together with the potential IV-prefix, this explains
1268 * the first of the two checks below.
1269 *
1270 * - The record must contain a MAC, either in plain or
1271 * encrypted, depending on whether Encrypt-then-MAC
1272 * is used or not.
1273 * - If it is, the message contains the IV-prefix,
1274 * the CBC ciphertext, and the MAC.
1275 * - If it is not, the padded plaintext, and hence
1276 * the CBC ciphertext, has at least length maclen + 1
1277 * because there is at least the padding length byte.
1278 *
1279 * As the CBC ciphertext is not empty, both cases give the
1280 * lower bound minlen + maclen + 1 on the record size, which
1281 * we test for in the second check below.
1282 */
1283 if( rec->data_len < minlen + transform->ivlen ||
1284 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001285 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1287 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1288 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001289 "+ 1 ) ( + expl IV )", rec->data_len,
1290 transform->ivlen,
1291 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001293 }
1294
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001295 /*
1296 * Authenticate before decrypt if enabled
1297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001298#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001299 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001300 {
Hanno Becker992b6872017-11-09 18:57:39 +00001301 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001304
Hanno Beckerd96a6522019-07-10 13:55:25 +01001305 /* Update data_len in tandem with add_data.
1306 *
1307 * The subtraction is safe because of the previous check
1308 * data_len >= minlen + maclen + 1.
1309 *
1310 * Afterwards, we know that data + data_len is followed by at
1311 * least maclen Bytes, which justifies the call to
1312 * mbedtls_ssl_safer_memcmp() below.
1313 *
1314 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001315 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001316 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1317 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001318
Hanno Beckerd96a6522019-07-10 13:55:25 +01001319 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001320 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1321 add_data_len );
1322 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1323 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1325 data, rec->data_len );
1326 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1327 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001328
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001329 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1330 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001331 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001332 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001333
Hanno Beckerd96a6522019-07-10 13:55:25 +01001334 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001335 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1336 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001337 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001340 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001341 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001342 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001343#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001344
1345 /*
1346 * Check length sanity
1347 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001348
1349 /* We know from above that data_len > minlen >= 0,
1350 * so the following check in particular implies that
1351 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001352 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001353 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001354 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1355 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001356 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001358 }
1359
TRodziewicz0f82ec62021-05-12 17:49:18 +02001360#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001361 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001362 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001363 */
TRodziewicz345165c2021-07-06 13:42:11 +02001364 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1365 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001366
TRodziewicz345165c2021-07-06 13:42:11 +02001367 data += transform->ivlen;
1368 rec->data_offset += transform->ivlen;
1369 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001370#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001371
Hanno Beckerd96a6522019-07-10 13:55:25 +01001372 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1373
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001374 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1375 transform->iv_dec, transform->ivlen,
1376 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001377 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001378 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001379 return( ret );
1380 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001381
Hanno Beckerd96a6522019-07-10 13:55:25 +01001382 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001383 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001384 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1386 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001387 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001388
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001389 /* Safe since data_len >= minlen + maclen + 1, so after having
1390 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001391 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1392 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001393 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001394
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001395 if( auth_done == 1 )
1396 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001397 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001398 rec->data_len,
1399 padlen + 1 );
1400 correct &= mask;
1401 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001402 }
1403 else
Paul Bakker45829992013-01-03 14:52:21 +01001404 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001405#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001406 if( rec->data_len < transform->maclen + padlen + 1 )
1407 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001408 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1409 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1410 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001411 rec->data_len,
1412 transform->maclen,
1413 padlen + 1 ) );
1414 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001415#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001416
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001417 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001418 rec->data_len,
1419 transform->maclen + padlen + 1 );
1420 correct &= mask;
1421 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001422 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001423
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 padlen++;
1425
1426 /* Regardless of the validity of the padding,
1427 * we have data_len >= padlen here. */
1428
TRodziewicz0f82ec62021-05-12 17:49:18 +02001429#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001430 /* The padding check involves a series of up to 256
1431 * consecutive memory reads at the end of the record
1432 * plaintext buffer. In order to hide the length and
1433 * validity of the padding, always perform exactly
1434 * `min(256,plaintext_len)` reads (but take into account
1435 * only the last `padlen` bytes for the padding check). */
1436 size_t pad_count = 0;
1437 volatile unsigned char* const check = data;
1438
1439 /* Index of first padding byte; it has been ensured above
1440 * that the subtraction is safe. */
1441 size_t const padding_idx = rec->data_len - padlen;
1442 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1443 size_t const start_idx = rec->data_len - num_checks;
1444 size_t idx;
1445
1446 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001447 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001448 /* pad_count += (idx >= padding_idx) &&
1449 * (check[idx] == padlen - 1);
1450 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001451 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1452 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1453 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001454 pad_count += mask & equal;
1455 }
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001456 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001457
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001459 if( padlen > 0 && correct == 0 )
1460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001461#endif
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001462 padlen &= mbedtls_cf_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001463
TRodziewicz0f82ec62021-05-12 17:49:18 +02001464#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001465
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001466 /* If the padding was found to be invalid, padlen == 0
1467 * and the subtraction is safe. If the padding was found valid,
1468 * padlen hasn't been changed and the previous assertion
1469 * data_len >= padlen still holds. */
1470 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001472 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001473#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001474 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1476 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001477 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001478
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001479#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001481 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001482#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001483
1484 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001485 * Authenticate if not done yet.
1486 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001487 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001488#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001489 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001490 {
Hanno Becker992b6872017-11-09 18:57:39 +00001491 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001492 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001493
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 /* If the initial value of padlen was such that
1495 * data_len < maclen + padlen + 1, then padlen
1496 * got reset to 1, and the initial check
1497 * data_len >= minlen + maclen + 1
1498 * guarantees that at this point we still
1499 * have at least data_len >= maclen.
1500 *
1501 * If the initial value of padlen was such that
1502 * data_len >= maclen + padlen + 1, then we have
1503 * subtracted either padlen + 1 (if the padding was correct)
1504 * or 0 (if the padding was incorrect) since then,
1505 * hence data_len >= maclen in any case.
1506 */
1507 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001508 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1509 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001510
TRodziewicz0f82ec62021-05-12 17:49:18 +02001511#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001512 /*
1513 * The next two sizes are the minimum and maximum values of
1514 * data_len over all padlen values.
1515 *
1516 * They're independent of padlen, since we previously did
1517 * data_len -= padlen.
1518 *
1519 * Note that max_len + maclen is never more than the buffer
1520 * length, as we previously did in_msglen -= maclen too.
1521 */
1522 const size_t max_len = rec->data_len + padlen;
1523 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1524
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001525 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1526 add_data, add_data_len,
1527 data, rec->data_len, min_len, max_len,
1528 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001529 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001530 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001531 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cf_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001532 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001533 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001534
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001535 mbedtls_cf_memcpy_offset( mac_peer, data,
1536 rec->data_len,
1537 min_len, max_len,
1538 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001539#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001540
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001541#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001542 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001543 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001544#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001545
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001546 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001547 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001548 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549#if defined(MBEDTLS_SSL_DEBUG_ALL)
1550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001551#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001552 correct = 0;
1553 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001554 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001555 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001556
1557 /*
1558 * Finally check the correct flag
1559 */
1560 if( correct == 0 )
1561 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001562#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001563
1564 /* Make extra sure authentication was performed, exactly once */
1565 if( auth_done != 1 )
1566 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1568 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001569 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001570
Hanno Beckerccc13d02020-05-04 12:30:04 +01001571#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1572 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1573 {
1574 /* Remove inner padding and infer true content type. */
1575 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1576 &rec->type );
1577
1578 if( ret != 0 )
1579 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1580 }
1581#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1582
Hanno Beckera0e20d02019-05-15 14:03:01 +01001583#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001584 if( rec->cid_len != 0 )
1585 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001586 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1587 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001588 if( ret != 0 )
1589 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1590 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001591#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001593 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001594
1595 return( 0 );
1596}
1597
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001598#undef MAC_NONE
1599#undef MAC_PLAINTEXT
1600#undef MAC_CIPHERTEXT
1601
Paul Bakker5121ce52009-01-03 21:22:43 +00001602/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001603 * Fill the input message buffer by appending data to it.
1604 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001605 *
1606 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1607 * available (from this read and/or a previous one). Otherwise, an error code
1608 * is returned (possibly EOF or WANT_READ).
1609 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001610 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1611 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1612 * since we always read a whole datagram at once.
1613 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001614 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001615 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001618{
Janos Follath865b3eb2019-12-16 11:46:15 +00001619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001620 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001621#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1622 size_t in_buf_len = ssl->in_buf_len;
1623#else
1624 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1625#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001628
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001629 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1630 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001632 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001634 }
1635
Darryl Greenb33cc762019-11-28 14:29:44 +00001636 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001637 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001638 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1639 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001640 }
1641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001643 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001644 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001645 uint32_t timeout;
1646
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001647 /*
1648 * The point is, we need to always read a full datagram at once, so we
1649 * sometimes read more then requested, and handle the additional data.
1650 * It could be the rest of the current record (while fetching the
1651 * header) and/or some other records in the same datagram.
1652 */
1653
1654 /*
1655 * Move to the next record in the already read datagram if applicable
1656 */
1657 if( ssl->next_record_offset != 0 )
1658 {
1659 if( ssl->in_left < ssl->next_record_offset )
1660 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1662 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001663 }
1664
1665 ssl->in_left -= ssl->next_record_offset;
1666
1667 if( ssl->in_left != 0 )
1668 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001669 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1670 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001671 ssl->next_record_offset ) );
1672 memmove( ssl->in_hdr,
1673 ssl->in_hdr + ssl->next_record_offset,
1674 ssl->in_left );
1675 }
1676
1677 ssl->next_record_offset = 0;
1678 }
1679
Paul Elliottd48d5c62021-01-07 14:47:05 +00001680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1681 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001682 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001683
1684 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001685 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001686 */
1687 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001690 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001691 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001692
1693 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001694 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001695 * are not at the beginning of a new record, the caller did something
1696 * wrong.
1697 */
1698 if( ssl->in_left != 0 )
1699 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1701 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001702 }
1703
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001704 /*
1705 * Don't even try to read if time's out already.
1706 * This avoids by-passing the timer when repeatedly receiving messages
1707 * that will end up being dropped.
1708 */
Hanno Becker7876d122020-02-05 10:39:31 +00001709 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001710 {
1711 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001712 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001713 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001714 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001715 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001716 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001719 timeout = ssl->handshake->retransmit_timeout;
1720 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001721 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001722
Paul Elliott9f352112020-12-09 14:55:45 +00001723 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001724
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001725 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001726 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1727 timeout );
1728 else
1729 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001732
1733 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001735 }
1736
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001737 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001738 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001740 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001743 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001744 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001747 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001748 }
1749
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001751 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001753 return( ret );
1754 }
1755
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001756 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001757 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001759 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001761 {
Hanno Becker786300f2020-02-05 10:46:40 +00001762 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001763 {
Hanno Becker786300f2020-02-05 10:46:40 +00001764 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1765 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001766 return( ret );
1767 }
1768
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001769 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001770 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001772 }
1773
Paul Bakker5121ce52009-01-03 21:22:43 +00001774 if( ret < 0 )
1775 return( ret );
1776
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001777 ssl->in_left = ret;
1778 }
1779 else
1780#endif
1781 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001782 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1783 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001784 ssl->in_left, nb_want ) );
1785
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001786 while( ssl->in_left < nb_want )
1787 {
1788 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001789
Hanno Becker7876d122020-02-05 10:39:31 +00001790 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001791 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1792 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001793 {
1794 if( ssl->f_recv_timeout != NULL )
1795 {
1796 ret = ssl->f_recv_timeout( ssl->p_bio,
1797 ssl->in_hdr + ssl->in_left, len,
1798 ssl->conf->read_timeout );
1799 }
1800 else
1801 {
1802 ret = ssl->f_recv( ssl->p_bio,
1803 ssl->in_hdr + ssl->in_left, len );
1804 }
1805 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001806
Paul Elliottd48d5c62021-01-07 14:47:05 +00001807 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1808 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001809 ssl->in_left, nb_want ) );
1810 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001811
1812 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001814
1815 if( ret < 0 )
1816 return( ret );
1817
makise-homuraaf9513b2020-08-24 18:26:27 +03001818 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001819 {
Darryl Green11999bb2018-03-13 15:22:58 +00001820 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001821 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001822 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001823 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1824 }
1825
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001826 ssl->in_left += ret;
1827 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001828 }
1829
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001831
1832 return( 0 );
1833}
1834
1835/*
1836 * Flush any data not yet written
1837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001838int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001839{
Janos Follath865b3eb2019-12-16 11:46:15 +00001840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001841 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001843 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001844
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001845 if( ssl->f_send == NULL )
1846 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001848 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001850 }
1851
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001852 /* Avoid incrementing counter if data is flushed */
1853 if( ssl->out_left == 0 )
1854 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001855 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001856 return( 0 );
1857 }
1858
Paul Bakker5121ce52009-01-03 21:22:43 +00001859 while( ssl->out_left > 0 )
1860 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1862 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001863 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001864
Hanno Becker2b1e3542018-08-06 11:19:13 +01001865 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001866 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001869
1870 if( ret <= 0 )
1871 return( ret );
1872
makise-homuraaf9513b2020-08-24 18:26:27 +03001873 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001874 {
Darryl Green11999bb2018-03-13 15:22:58 +00001875 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001876 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001877 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001878 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1879 }
1880
Paul Bakker5121ce52009-01-03 21:22:43 +00001881 ssl->out_left -= ret;
1882 }
1883
Hanno Becker2b1e3542018-08-06 11:19:13 +01001884#if defined(MBEDTLS_SSL_PROTO_DTLS)
1885 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001886 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001887 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001888 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001889 else
1890#endif
1891 {
1892 ssl->out_hdr = ssl->out_buf + 8;
1893 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001894 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001897
1898 return( 0 );
1899}
1900
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001901/*
1902 * Functions to handle the DTLS retransmission state machine
1903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001905/*
1906 * Append current handshake message to current outgoing flight
1907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001909{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001911 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1912 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1913 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001914
1915 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001916 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001917 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001920 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001921 }
1922
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001923 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001924 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1926 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001928 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001929 }
1930
1931 /* Copy current handshake message with headers */
1932 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1933 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001934 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001935 msg->next = NULL;
1936
1937 /* Append to the current flight */
1938 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001939 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001940 else
1941 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001943 while( cur->next != NULL )
1944 cur = cur->next;
1945 cur->next = msg;
1946 }
1947
Hanno Becker3b235902018-08-06 09:54:53 +01001948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001949 return( 0 );
1950}
1951
1952/*
1953 * Free the current flight of handshake messages
1954 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001955void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001956{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 mbedtls_ssl_flight_item *cur = flight;
1958 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001959
1960 while( cur != NULL )
1961 {
1962 next = cur->next;
1963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 mbedtls_free( cur->p );
1965 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001966
1967 cur = next;
1968 }
1969}
1970
1971/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001972 * Swap transform_out and out_ctr with the alternative ones
1973 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001974static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001975{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001977 unsigned char tmp_out_ctr[8];
1978
1979 if( ssl->transform_out == ssl->handshake->alt_transform_out )
1980 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001982 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001983 }
1984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001986
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001987 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001988 tmp_transform = ssl->transform_out;
1989 ssl->transform_out = ssl->handshake->alt_transform_out;
1990 ssl->handshake->alt_transform_out = tmp_transform;
1991
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001992 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01001993 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
1994 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001995 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001996
1997 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001998 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001999
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002000 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002001}
2002
2003/*
2004 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002005 */
2006int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2007{
2008 int ret = 0;
2009
2010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2011
2012 ret = mbedtls_ssl_flight_transmit( ssl );
2013
2014 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2015
2016 return( ret );
2017}
2018
2019/*
2020 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002021 *
2022 * Need to remember the current message in case flush_output returns
2023 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002024 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002025 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002026int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002027{
Janos Follath865b3eb2019-12-16 11:46:15 +00002028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002029 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002032 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002033 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002034
2035 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002036 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002037 ret = ssl_swap_epochs( ssl );
2038 if( ret != 0 )
2039 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002042 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002043
2044 while( ssl->handshake->cur_msg != NULL )
2045 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002046 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002047 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002048
Hanno Beckere1dcb032018-08-17 16:47:58 +01002049 int const is_finished =
2050 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2051 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2052
Hanno Becker04da1892018-08-14 13:22:10 +01002053 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2054 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2055
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002056 /* Swap epochs before sending Finished: we can't do it after
2057 * sending ChangeCipherSpec, in case write returns WANT_READ.
2058 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002059 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002060 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002062 ret = ssl_swap_epochs( ssl );
2063 if( ret != 0 )
2064 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002065 }
2066
Hanno Becker67bc7c32018-08-06 11:33:50 +01002067 ret = ssl_get_remaining_payload_in_datagram( ssl );
2068 if( ret < 0 )
2069 return( ret );
2070 max_frag_len = (size_t) ret;
2071
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002072 /* CCS is copied as is, while HS messages may need fragmentation */
2073 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2074 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002075 if( max_frag_len == 0 )
2076 {
2077 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2078 return( ret );
2079
2080 continue;
2081 }
2082
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002083 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002084 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002085 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002086
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002087 /* Update position inside current message */
2088 ssl->handshake->cur_msg_p += cur->len;
2089 }
2090 else
2091 {
2092 const unsigned char * const p = ssl->handshake->cur_msg_p;
2093 const size_t hs_len = cur->len - 12;
2094 const size_t frag_off = p - ( cur->p + 12 );
2095 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002096 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002097
Hanno Beckere1dcb032018-08-17 16:47:58 +01002098 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002099 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002100 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002101 {
2102 ret = ssl_swap_epochs( ssl );
2103 if( ret != 0 )
2104 return( ret );
2105 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002106
Hanno Becker67bc7c32018-08-06 11:33:50 +01002107 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2108 return( ret );
2109
2110 continue;
2111 }
2112 max_hs_frag_len = max_frag_len - 12;
2113
2114 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2115 max_hs_frag_len : rem_len;
2116
2117 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002118 {
2119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002120 (unsigned) cur_hs_frag_len,
2121 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002122 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002123
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002124 /* Messages are stored with handshake headers as if not fragmented,
2125 * copy beginning of headers then fill fragmentation fields.
2126 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2127 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002128
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002129 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2130 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2131 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2132
Hanno Becker67bc7c32018-08-06 11:33:50 +01002133 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2134 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2135 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002136
2137 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2138
Hanno Becker3f7b9732018-08-28 09:53:25 +01002139 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002140 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2141 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002142 ssl->out_msgtype = cur->type;
2143
2144 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002145 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002146 }
2147
2148 /* If done with the current message move to the next one if any */
2149 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2150 {
2151 if( cur->next != NULL )
2152 {
2153 ssl->handshake->cur_msg = cur->next;
2154 ssl->handshake->cur_msg_p = cur->next->p + 12;
2155 }
2156 else
2157 {
2158 ssl->handshake->cur_msg = NULL;
2159 ssl->handshake->cur_msg_p = NULL;
2160 }
2161 }
2162
2163 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002164 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002165 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002167 return( ret );
2168 }
2169 }
2170
Hanno Becker67bc7c32018-08-06 11:33:50 +01002171 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2172 return( ret );
2173
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002174 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2176 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002177 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002178 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002180 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002181 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002182
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002183 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002184
2185 return( 0 );
2186}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002187
2188/*
2189 * To be called when the last message of an incoming flight is received.
2190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002192{
2193 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002194 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002195 ssl->handshake->flight = NULL;
2196 ssl->handshake->cur_msg = NULL;
2197
2198 /* The next incoming flight will start with this msg_seq */
2199 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2200
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002201 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002202 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002203
Hanno Becker0271f962018-08-16 13:23:47 +01002204 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002205 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002206
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002207 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002208 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2211 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002212 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002214 }
2215 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002217}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002218
2219/*
2220 * To be called when the last message of an outgoing flight is send.
2221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002223{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002224 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002225 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2228 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002229 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002231 }
2232 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002234}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002235#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002236
Paul Bakker5121ce52009-01-03 21:22:43 +00002237/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002238 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002239 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002240
2241/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002242 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002243 *
2244 * - fill in handshake headers
2245 * - update handshake checksum
2246 * - DTLS: save message for resending
2247 * - then pass to the record layer
2248 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002249 * DTLS: except for HelloRequest, messages are only queued, and will only be
2250 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002251 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002252 * Inputs:
2253 * - ssl->out_msglen: 4 + actual handshake message len
2254 * (4 is the size of handshake headers for TLS)
2255 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2256 * - ssl->out_msg + 4: the handshake message body
2257 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002258 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002259 * - ssl->out_msglen: the length of the record contents
2260 * (including handshake headers but excluding record headers)
2261 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002262 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002263int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002264{
Janos Follath865b3eb2019-12-16 11:46:15 +00002265 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002266 const size_t hs_len = ssl->out_msglen - 4;
2267 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002268
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002269 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2270
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002271 /*
2272 * Sanity checks
2273 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002274 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002275 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2276 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2278 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002279 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002280
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002281 /* Whenever we send anything different from a
2282 * HelloRequest we should be in a handshake - double check. */
2283 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2284 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002285 ssl->handshake == NULL )
2286 {
2287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2288 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002290
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002291#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002292 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002293 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002294 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002295 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002296 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2297 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002298 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002299#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002300
Hanno Beckerb50a2532018-08-06 11:52:54 +01002301 /* Double-check that we did not exceed the bounds
2302 * of the outgoing record buffer.
2303 * This should never fail as the various message
2304 * writing functions must obey the bounds of the
2305 * outgoing record buffer, but better be safe.
2306 *
2307 * Note: We deliberately do not check for the MTU or MFL here.
2308 */
2309 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2310 {
2311 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002312 "size %" MBEDTLS_PRINTF_SIZET
2313 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002314 ssl->out_msglen,
2315 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002316 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2317 }
2318
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002319 /*
2320 * Fill handshake headers
2321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002323 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002324 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2325 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2326 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002327
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002328 /*
2329 * DTLS has additional fields in the Handshake layer,
2330 * between the length field and the actual payload:
2331 * uint16 message_seq;
2332 * uint24 fragment_offset;
2333 * uint24 fragment_length;
2334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002336 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002337 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002338 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002339 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002340 {
2341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002342 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002343 hs_len,
2344 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002345 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2346 }
2347
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002348 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002349 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002350
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002351 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002352 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002353 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002354 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2355 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2356 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002357 }
2358 else
2359 {
2360 ssl->out_msg[4] = 0;
2361 ssl->out_msg[5] = 0;
2362 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002363
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002364 /* Handshake hashes are computed without fragmentation,
2365 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002366 memset( ssl->out_msg + 6, 0x00, 3 );
2367 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002368 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002370
Hanno Becker0207e532018-08-28 10:28:28 +01002371 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002372 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2373 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002374 }
2375
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002376 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002378 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002379 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2380 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002381 {
2382 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2383 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002385 return( ret );
2386 }
2387 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002388 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002389#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002390 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002391 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002392 {
2393 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2394 return( ret );
2395 }
2396 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002397
2398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2399
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002400 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002401}
2402
2403/*
2404 * Record layer functions
2405 */
2406
2407/*
2408 * Write current record.
2409 *
2410 * Uses:
2411 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2412 * - ssl->out_msglen: length of the record content (excl headers)
2413 * - ssl->out_msg: record content
2414 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002415int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002416{
2417 int ret, done = 0;
2418 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002419 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002420
2421 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002422
Paul Bakker05ef8352012-05-08 09:17:57 +00002423 if( !done )
2424 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002425 unsigned i;
2426 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002427#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2428 size_t out_buf_len = ssl->out_buf_len;
2429#else
2430 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2431#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002432 /* Skip writing the record content type to after the encryption,
2433 * as it may change when using the CID extension. */
2434
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002436 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002437
Hanno Becker19859472018-08-06 09:40:20 +01002438 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002439 ssl->out_len[0] = (unsigned char)( len >> 8 );
2440 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002441
Paul Bakker48916f92012-09-16 19:57:18 +00002442 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002443 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002444 mbedtls_record rec;
2445
2446 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002447 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002448 rec.data_len = ssl->out_msglen;
2449 rec.data_offset = ssl->out_msg - rec.buf;
2450
2451 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2452 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2453 ssl->conf->transport, rec.ver );
2454 rec.type = ssl->out_msgtype;
2455
Hanno Beckera0e20d02019-05-15 14:03:01 +01002456#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002457 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002458 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002460
Hanno Beckera18d1322018-01-03 14:27:32 +00002461 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002462 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002463 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002465 return( ret );
2466 }
2467
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002468 if( rec.data_offset != 0 )
2469 {
2470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2471 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2472 }
2473
Hanno Becker6430faf2019-05-08 11:57:13 +01002474 /* Update the record content type and CID. */
2475 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002476#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002477 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002478#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002479 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002480 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2481 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002482 }
2483
Hanno Becker5903de42019-05-03 14:46:38 +01002484 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002485
2486#if defined(MBEDTLS_SSL_PROTO_DTLS)
2487 /* In case of DTLS, double-check that we don't exceed
2488 * the remaining space in the datagram. */
2489 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2490 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002491 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002492 if( ret < 0 )
2493 return( ret );
2494
2495 if( protected_record_size > (size_t) ret )
2496 {
2497 /* Should never happen */
2498 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2499 }
2500 }
2501#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002502
Hanno Becker6430faf2019-05-08 11:57:13 +01002503 /* Now write the potentially updated record content type. */
2504 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2505
Paul Elliott9f352112020-12-09 14:55:45 +00002506 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002507 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002508 ssl->out_hdr[0], ssl->out_hdr[1],
2509 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002512 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002513
2514 ssl->out_left += protected_record_size;
2515 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002516 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002517
Hanno Beckerdd772292020-02-05 10:38:31 +00002518 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002519 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2520 break;
2521
2522 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002523 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002524 {
2525 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2526 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2527 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002528 }
2529
Hanno Becker67bc7c32018-08-06 11:33:50 +01002530#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002531 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2532 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002533 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002534 size_t remaining;
2535 ret = ssl_get_remaining_payload_in_datagram( ssl );
2536 if( ret < 0 )
2537 {
2538 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2539 ret );
2540 return( ret );
2541 }
2542
2543 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002544 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002545 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002546 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002547 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002548 else
2549 {
Hanno Becker513815a2018-08-20 11:56:09 +01002550 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002551 }
2552 }
2553#endif /* MBEDTLS_SSL_PROTO_DTLS */
2554
2555 if( ( flush == SSL_FORCE_FLUSH ) &&
2556 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002557 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 return( ret );
2560 }
2561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002563
2564 return( 0 );
2565}
2566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002568
2569static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2570{
2571 if( ssl->in_msglen < ssl->in_hslen ||
2572 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2573 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2574 {
2575 return( 1 );
2576 }
2577 return( 0 );
2578}
Hanno Becker44650b72018-08-16 12:51:11 +01002579
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002580static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002581{
2582 return( ( ssl->in_msg[9] << 16 ) |
2583 ( ssl->in_msg[10] << 8 ) |
2584 ssl->in_msg[11] );
2585}
2586
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002587static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002588{
2589 return( ( ssl->in_msg[6] << 16 ) |
2590 ( ssl->in_msg[7] << 8 ) |
2591 ssl->in_msg[8] );
2592}
2593
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002594static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002595{
2596 uint32_t msg_len, frag_off, frag_len;
2597
2598 msg_len = ssl_get_hs_total_len( ssl );
2599 frag_off = ssl_get_hs_frag_off( ssl );
2600 frag_len = ssl_get_hs_frag_len( ssl );
2601
2602 if( frag_off > msg_len )
2603 return( -1 );
2604
2605 if( frag_len > msg_len - frag_off )
2606 return( -1 );
2607
2608 if( frag_len + 12 > ssl->in_msglen )
2609 return( -1 );
2610
2611 return( 0 );
2612}
2613
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002614/*
2615 * Mark bits in bitmask (used for DTLS HS reassembly)
2616 */
2617static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2618{
2619 unsigned int start_bits, end_bits;
2620
2621 start_bits = 8 - ( offset % 8 );
2622 if( start_bits != 8 )
2623 {
2624 size_t first_byte_idx = offset / 8;
2625
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002626 /* Special case */
2627 if( len <= start_bits )
2628 {
2629 for( ; len != 0; len-- )
2630 mask[first_byte_idx] |= 1 << ( start_bits - len );
2631
2632 /* Avoid potential issues with offset or len becoming invalid */
2633 return;
2634 }
2635
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002636 offset += start_bits; /* Now offset % 8 == 0 */
2637 len -= start_bits;
2638
2639 for( ; start_bits != 0; start_bits-- )
2640 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2641 }
2642
2643 end_bits = len % 8;
2644 if( end_bits != 0 )
2645 {
2646 size_t last_byte_idx = ( offset + len ) / 8;
2647
2648 len -= end_bits; /* Now len % 8 == 0 */
2649
2650 for( ; end_bits != 0; end_bits-- )
2651 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2652 }
2653
2654 memset( mask + offset / 8, 0xFF, len / 8 );
2655}
2656
2657/*
2658 * Check that bitmask is full
2659 */
2660static int ssl_bitmask_check( unsigned char *mask, size_t len )
2661{
2662 size_t i;
2663
2664 for( i = 0; i < len / 8; i++ )
2665 if( mask[i] != 0xFF )
2666 return( -1 );
2667
2668 for( i = 0; i < len % 8; i++ )
2669 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2670 return( -1 );
2671
2672 return( 0 );
2673}
2674
Hanno Becker56e205e2018-08-16 09:06:12 +01002675/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002676static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002677 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002678{
Hanno Becker56e205e2018-08-16 09:06:12 +01002679 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002680
Hanno Becker56e205e2018-08-16 09:06:12 +01002681 alloc_len = 12; /* Handshake header */
2682 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002683
Hanno Beckerd07df862018-08-16 09:14:58 +01002684 if( add_bitmap )
2685 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002686
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002687 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002688}
Hanno Becker56e205e2018-08-16 09:06:12 +01002689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002691
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002692static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002693{
2694 return( ( ssl->in_msg[1] << 16 ) |
2695 ( ssl->in_msg[2] << 8 ) |
2696 ssl->in_msg[3] );
2697}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002698
Simon Butcher99000142016-10-13 17:21:01 +01002699int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002700{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002702 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002703 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002704 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002706 }
2707
Hanno Becker12555c62018-08-16 12:47:53 +01002708 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002711 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002712 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002715 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002716 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002717 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002718 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002719
Hanno Becker44650b72018-08-16 12:51:11 +01002720 if( ssl_check_hs_header( ssl ) != 0 )
2721 {
2722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2723 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2724 }
2725
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002726 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002727 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2728 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2729 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2730 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002731 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002732 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2733 {
2734 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2735 recv_msg_seq,
2736 ssl->handshake->in_msg_seq ) );
2737 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2738 }
2739
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002740 /* Retransmit only on last message from previous flight, to avoid
2741 * too many retransmissions.
2742 * Besides, No sane server ever retransmits HelloVerifyRequest */
2743 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002747 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002748 recv_msg_seq,
2749 ssl->handshake->in_flight_start_seq ) );
2750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002754 return( ret );
2755 }
2756 }
2757 else
2758 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002760 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002761 recv_msg_seq,
2762 ssl->handshake->in_msg_seq ) );
2763 }
2764
Hanno Becker90333da2017-10-10 11:27:13 +01002765 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002766 }
2767 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002768
Hanno Becker6d97ef52018-08-16 13:09:04 +01002769 /* Message reassembly is handled alongside buffering of future
2770 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002771 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002772 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002773 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002776 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002777 }
2778 }
2779 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002781 /* With TLS we don't handle fragmentation (for now) */
2782 if( ssl->in_msglen < ssl->in_hslen )
2783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2785 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002786 }
2787
Simon Butcher99000142016-10-13 17:21:01 +01002788 return( 0 );
2789}
2790
2791void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2792{
Hanno Becker0271f962018-08-16 13:23:47 +01002793 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002794
Hanno Becker0271f962018-08-16 13:23:47 +01002795 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002796 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002797 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002798 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002799
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002800 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002802 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002803 ssl->handshake != NULL )
2804 {
Hanno Becker0271f962018-08-16 13:23:47 +01002805 unsigned offset;
2806 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002807
Hanno Becker0271f962018-08-16 13:23:47 +01002808 /* Increment handshake sequence number */
2809 hs->in_msg_seq++;
2810
2811 /*
2812 * Clear up handshake buffering and reassembly structure.
2813 */
2814
2815 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002816 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002817
2818 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002819 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2820 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002821 offset++, hs_buf++ )
2822 {
2823 *hs_buf = *(hs_buf + 1);
2824 }
2825
2826 /* Create a fresh last entry */
2827 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002828 }
2829#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002830}
2831
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002832/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002833 * DTLS anti-replay: RFC 6347 4.1.2.6
2834 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002835 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2836 * Bit n is set iff record number in_window_top - n has been seen.
2837 *
2838 * Usually, in_window_top is the last record number seen and the lsb of
2839 * in_window is set. The only exception is the initial state (record number 0
2840 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002843void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002844{
2845 ssl->in_window_top = 0;
2846 ssl->in_window = 0;
2847}
2848
2849static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2850{
2851 return( ( (uint64_t) buf[0] << 40 ) |
2852 ( (uint64_t) buf[1] << 32 ) |
2853 ( (uint64_t) buf[2] << 24 ) |
2854 ( (uint64_t) buf[3] << 16 ) |
2855 ( (uint64_t) buf[4] << 8 ) |
2856 ( (uint64_t) buf[5] ) );
2857}
2858
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002859static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2860{
Janos Follath865b3eb2019-12-16 11:46:15 +00002861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002862 unsigned char *original_in_ctr;
2863
2864 // save original in_ctr
2865 original_in_ctr = ssl->in_ctr;
2866
2867 // use counter from record
2868 ssl->in_ctr = record_in_ctr;
2869
2870 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2871
2872 // restore the counter
2873 ssl->in_ctr = original_in_ctr;
2874
2875 return ret;
2876}
2877
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002878/*
2879 * Return 0 if sequence number is acceptable, -1 otherwise
2880 */
Hanno Becker0183d692019-07-12 08:50:37 +01002881int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002882{
2883 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2884 uint64_t bit;
2885
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002886 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002887 return( 0 );
2888
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002889 if( rec_seqnum > ssl->in_window_top )
2890 return( 0 );
2891
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002892 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002893
2894 if( bit >= 64 )
2895 return( -1 );
2896
2897 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2898 return( -1 );
2899
2900 return( 0 );
2901}
2902
2903/*
2904 * Update replay window on new validated record
2905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002907{
2908 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2909
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002910 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002911 return;
2912
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002913 if( rec_seqnum > ssl->in_window_top )
2914 {
2915 /* Update window_top and the contents of the window */
2916 uint64_t shift = rec_seqnum - ssl->in_window_top;
2917
2918 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002919 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002920 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002921 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002922 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002923 ssl->in_window |= 1;
2924 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002925
2926 ssl->in_window_top = rec_seqnum;
2927 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002928 else
2929 {
2930 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002931 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002932
2933 if( bit < 64 ) /* Always true, but be extra sure */
2934 ssl->in_window |= (uint64_t) 1 << bit;
2935 }
2936}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002938
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002939#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002940/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002941 * Without any SSL context, check if a datagram looks like a ClientHello with
2942 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002943 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002944 *
2945 * - if cookie is valid, return 0
2946 * - if ClientHello looks superficially valid but cookie is not,
2947 * fill obuf and set olen, then
2948 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2949 * - otherwise return a specific error code
2950 */
2951static int ssl_check_dtls_clihlo_cookie(
2952 mbedtls_ssl_cookie_write_t *f_cookie_write,
2953 mbedtls_ssl_cookie_check_t *f_cookie_check,
2954 void *p_cookie,
2955 const unsigned char *cli_id, size_t cli_id_len,
2956 const unsigned char *in, size_t in_len,
2957 unsigned char *obuf, size_t buf_len, size_t *olen )
2958{
2959 size_t sid_len, cookie_len;
2960 unsigned char *p;
2961
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002962 /*
2963 * Structure of ClientHello with record and handshake headers,
2964 * and expected values. We don't need to check a lot, more checks will be
2965 * done when actually parsing the ClientHello - skipping those checks
2966 * avoids code duplication and does not make cookie forging any easier.
2967 *
2968 * 0-0 ContentType type; copied, must be handshake
2969 * 1-2 ProtocolVersion version; copied
2970 * 3-4 uint16 epoch; copied, must be 0
2971 * 5-10 uint48 sequence_number; copied
2972 * 11-12 uint16 length; (ignored)
2973 *
2974 * 13-13 HandshakeType msg_type; (ignored)
2975 * 14-16 uint24 length; (ignored)
2976 * 17-18 uint16 message_seq; copied
2977 * 19-21 uint24 fragment_offset; copied, must be 0
2978 * 22-24 uint24 fragment_length; (ignored)
2979 *
2980 * 25-26 ProtocolVersion client_version; (ignored)
2981 * 27-58 Random random; (ignored)
2982 * 59-xx SessionID session_id; 1 byte len + sid_len content
2983 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
2984 * ...
2985 *
2986 * Minimum length is 61 bytes.
2987 */
2988 if( in_len < 61 ||
2989 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
2990 in[3] != 0 || in[4] != 0 ||
2991 in[19] != 0 || in[20] != 0 || in[21] != 0 )
2992 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01002993 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002994 }
2995
2996 sid_len = in[59];
2997 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002998 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002999
3000 cookie_len = in[60 + sid_len];
3001 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003002 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003003
3004 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3005 cli_id, cli_id_len ) == 0 )
3006 {
3007 /* Valid cookie */
3008 return( 0 );
3009 }
3010
3011 /*
3012 * If we get here, we've got an invalid cookie, let's prepare HVR.
3013 *
3014 * 0-0 ContentType type; copied
3015 * 1-2 ProtocolVersion version; copied
3016 * 3-4 uint16 epoch; copied
3017 * 5-10 uint48 sequence_number; copied
3018 * 11-12 uint16 length; olen - 13
3019 *
3020 * 13-13 HandshakeType msg_type; hello_verify_request
3021 * 14-16 uint24 length; olen - 25
3022 * 17-18 uint16 message_seq; copied
3023 * 19-21 uint24 fragment_offset; copied
3024 * 22-24 uint24 fragment_length; olen - 25
3025 *
3026 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3027 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3028 *
3029 * Minimum length is 28.
3030 */
3031 if( buf_len < 28 )
3032 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3033
3034 /* Copy most fields and adapt others */
3035 memcpy( obuf, in, 25 );
3036 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3037 obuf[25] = 0xfe;
3038 obuf[26] = 0xff;
3039
3040 /* Generate and write actual cookie */
3041 p = obuf + 28;
3042 if( f_cookie_write( p_cookie,
3043 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3044 {
3045 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3046 }
3047
3048 *olen = p - obuf;
3049
3050 /* Go back and fill length fields */
3051 obuf[27] = (unsigned char)( *olen - 28 );
3052
3053 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3054 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3055 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3056
3057 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3058 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3059
3060 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3061}
3062
3063/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003064 * Handle possible client reconnect with the same UDP quadruplet
3065 * (RFC 6347 Section 4.2.8).
3066 *
3067 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3068 * that looks like a ClientHello.
3069 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003070 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003071 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003072 * - if the input looks like a ClientHello with a valid cookie,
3073 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003074 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003075 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003076 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003077 * This function is called (through ssl_check_client_reconnect()) when an
3078 * unexpected record is found in ssl_get_next_record(), which will discard the
3079 * record if we return 0, and bubble up the return value otherwise (this
3080 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3081 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003082 */
3083static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3084{
Janos Follath865b3eb2019-12-16 11:46:15 +00003085 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003086 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003087
Hanno Becker2fddd372019-07-10 14:37:41 +01003088 if( ssl->conf->f_cookie_write == NULL ||
3089 ssl->conf->f_cookie_check == NULL )
3090 {
3091 /* If we can't use cookies to verify reachability of the peer,
3092 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003093 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3094 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003095 return( 0 );
3096 }
3097
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003098 ret = ssl_check_dtls_clihlo_cookie(
3099 ssl->conf->f_cookie_write,
3100 ssl->conf->f_cookie_check,
3101 ssl->conf->p_cookie,
3102 ssl->cli_id, ssl->cli_id_len,
3103 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003104 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003105
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003106 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3107
3108 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003109 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003110 int send_ret;
3111 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3112 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3113 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003114 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003115 * If the error is permanent we'll catch it later,
3116 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003117 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3118 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3119 (void) send_ret;
3120
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003121 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003122 }
3123
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003124 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003125 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003126 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003127 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003128 {
3129 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3130 return( ret );
3131 }
3132
3133 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003134 }
3135
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003136 return( ret );
3137}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003138#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003139
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003140static int ssl_check_record_type( uint8_t record_type )
3141{
3142 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3143 record_type != MBEDTLS_SSL_MSG_ALERT &&
3144 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3145 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3146 {
3147 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3148 }
3149
3150 return( 0 );
3151}
3152
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003153/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003154 * ContentType type;
3155 * ProtocolVersion version;
3156 * uint16 epoch; // DTLS only
3157 * uint48 sequence_number; // DTLS only
3158 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003159 *
3160 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003161 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003162 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3163 *
3164 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003165 * 1. proceed with the record if this function returns 0
3166 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3167 * 3. return CLIENT_RECONNECT if this function return that value
3168 * 4. drop the whole datagram if this function returns anything else.
3169 * Point 2 is needed when the peer is resending, and we have already received
3170 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003171 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003172static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003173 unsigned char *buf,
3174 size_t len,
3175 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003176{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003177 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003178
Hanno Beckere5e7e782019-07-11 12:29:35 +01003179 size_t const rec_hdr_type_offset = 0;
3180 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003181
Hanno Beckere5e7e782019-07-11 12:29:35 +01003182 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3183 rec_hdr_type_len;
3184 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003185
Hanno Beckere5e7e782019-07-11 12:29:35 +01003186 size_t const rec_hdr_ctr_len = 8;
3187#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003188 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003189 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3190 rec_hdr_version_len;
3191
Hanno Beckera0e20d02019-05-15 14:03:01 +01003192#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003193 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3194 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003195 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3197#endif /* MBEDTLS_SSL_PROTO_DTLS */
3198
3199 size_t rec_hdr_len_offset; /* To be determined */
3200 size_t const rec_hdr_len_len = 2;
3201
3202 /*
3203 * Check minimum lengths for record header.
3204 */
3205
3206#if defined(MBEDTLS_SSL_PROTO_DTLS)
3207 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3208 {
3209 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3210 }
3211 else
3212#endif /* MBEDTLS_SSL_PROTO_DTLS */
3213 {
3214 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3215 }
3216
3217 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3218 {
3219 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3220 (unsigned) len,
3221 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3222 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3223 }
3224
3225 /*
3226 * Parse and validate record content type
3227 */
3228
3229 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003230
3231 /* Check record content type */
3232#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3233 rec->cid_len = 0;
3234
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003235 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003236 ssl->conf->cid_len != 0 &&
3237 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003238 {
3239 /* Shift pointers to account for record header including CID
3240 * struct {
3241 * ContentType special_type = tls12_cid;
3242 * ProtocolVersion version;
3243 * uint16 epoch;
3244 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003245 * opaque cid[cid_length]; // Additional field compared to
3246 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003247 * uint16 length;
3248 * opaque enc_content[DTLSCiphertext.length];
3249 * } DTLSCiphertext;
3250 */
3251
3252 /* So far, we only support static CID lengths
3253 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003254 rec_hdr_cid_len = ssl->conf->cid_len;
3255 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003256
Hanno Beckere5e7e782019-07-11 12:29:35 +01003257 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003258 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3260 (unsigned) len,
3261 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003262 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003263 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003264
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003265 /* configured CID len is guaranteed at most 255, see
3266 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3267 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003268 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003269 }
3270 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003271#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003272 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003273 if( ssl_check_record_type( rec->type ) )
3274 {
Hanno Becker54229812019-07-12 14:40:00 +01003275 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3276 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003277 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3278 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003279 }
3280
Hanno Beckere5e7e782019-07-11 12:29:35 +01003281 /*
3282 * Parse and validate record version
3283 */
3284
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003285 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3286 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003287 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3288 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003289 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003290
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003291 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003292 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3294 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003295 }
3296
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003297 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003298 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3300 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003301 }
3302
Hanno Beckere5e7e782019-07-11 12:29:35 +01003303 /*
3304 * Parse/Copy record sequence number.
3305 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003306
Hanno Beckere5e7e782019-07-11 12:29:35 +01003307#if defined(MBEDTLS_SSL_PROTO_DTLS)
3308 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003309 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003310 /* Copy explicit record sequence number from input buffer. */
3311 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3312 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003313 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003314 else
3315#endif /* MBEDTLS_SSL_PROTO_DTLS */
3316 {
3317 /* Copy implicit record sequence number from SSL context structure. */
3318 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3319 }
Paul Bakker40e46942009-01-03 21:51:57 +00003320
Hanno Beckere5e7e782019-07-11 12:29:35 +01003321 /*
3322 * Parse record length.
3323 */
3324
Hanno Beckere5e7e782019-07-11 12:29:35 +01003325 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003326 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3327 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003328 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003329
Paul Elliott9f352112020-12-09 14:55:45 +00003330 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003331 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003332 rec->type,
3333 major_ver, minor_ver, rec->data_len ) );
3334
3335 rec->buf = buf;
3336 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003337
Hanno Beckerd417cc92019-07-26 08:20:27 +01003338 if( rec->data_len == 0 )
3339 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003340
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003341 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003342 * DTLS-related tests.
3343 * Check epoch before checking length constraint because
3344 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3345 * message gets duplicated before the corresponding Finished message,
3346 * the second ChangeCipherSpec should be discarded because it belongs
3347 * to an old epoch, but not because its length is shorter than
3348 * the minimum record length for packets using the new record transform.
3349 * Note that these two kinds of failures are handled differently,
3350 * as an unexpected record is silently skipped but an invalid
3351 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003352 */
3353#if defined(MBEDTLS_SSL_PROTO_DTLS)
3354 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3355 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003356 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003357
Hanno Becker955a5c92019-07-10 17:12:07 +01003358 /* Check that the datagram is large enough to contain a record
3359 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003360 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003361 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003362 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3363 (unsigned) len,
3364 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003365 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3366 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003367
Hanno Becker37cfe732019-07-10 17:20:01 +01003368 /* Records from other, non-matching epochs are silently discarded.
3369 * (The case of same-port Client reconnects must be considered in
3370 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003371 if( rec_epoch != ssl->in_epoch )
3372 {
3373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003374 "expected %u, received %lu",
3375 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003376
Hanno Becker552f7472019-07-19 10:59:12 +01003377 /* Records from the next epoch are considered for buffering
3378 * (concretely: early Finished messages). */
3379 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003380 {
Hanno Becker552f7472019-07-19 10:59:12 +01003381 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3382 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003383 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003384
Hanno Becker2fddd372019-07-10 14:37:41 +01003385 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003386 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003387#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003388 /* For records from the correct epoch, check whether their
3389 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003390 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3391 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003392 {
3393 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3394 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3395 }
3396#endif
3397 }
3398#endif /* MBEDTLS_SSL_PROTO_DTLS */
3399
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003400 return( 0 );
3401}
Paul Bakker5121ce52009-01-03 21:22:43 +00003402
Paul Bakker5121ce52009-01-03 21:22:43 +00003403
Hanno Becker2fddd372019-07-10 14:37:41 +01003404#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3405static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3406{
3407 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3408
3409 /*
3410 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3411 * access the first byte of record content (handshake type), as we
3412 * have an active transform (possibly iv_len != 0), so use the
3413 * fact that the record header len is 13 instead.
3414 */
3415 if( rec_epoch == 0 &&
3416 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3417 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3418 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3419 ssl->in_left > 13 &&
3420 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3421 {
3422 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3423 "from the same port" ) );
3424 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 }
3426
3427 return( 0 );
3428}
Hanno Becker2fddd372019-07-10 14:37:41 +01003429#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003430
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003431/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003432 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003433 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003434static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3435 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003436{
3437 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003438
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003440 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003441
Paul Bakker48916f92012-09-16 19:57:18 +00003442 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003443 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003444 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003445
Hanno Beckera18d1322018-01-03 14:27:32 +00003446 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003447 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003448 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003450
Hanno Beckera0e20d02019-05-15 14:03:01 +01003451#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003452 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3453 ssl->conf->ignore_unexpected_cid
3454 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3455 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003456 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003457 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003458 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003460
Paul Bakker5121ce52009-01-03 21:22:43 +00003461 return( ret );
3462 }
3463
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003464 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003465 {
3466 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003467 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003468 }
3469
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003470 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003471 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003472
Hanno Beckera0e20d02019-05-15 14:03:01 +01003473#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003474 /* We have already checked the record content type
3475 * in ssl_parse_record_header(), failing or silently
3476 * dropping the record in the case of an unknown type.
3477 *
3478 * Since with the use of CIDs, the record content type
3479 * might change during decryption, re-check the record
3480 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003481 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003482 {
3483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3484 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3485 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003486#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003487
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003488 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003489 {
3490#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3491 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003492 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003493 {
3494 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3496 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3497 }
3498#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3499
3500 ssl->nb_zero++;
3501
3502 /*
3503 * Three or more empty messages may be a DoS attack
3504 * (excessive CPU consumption).
3505 */
3506 if( ssl->nb_zero > 3 )
3507 {
3508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003509 "messages, possible DoS attack" ) );
3510 /* Treat the records as if they were not properly authenticated,
3511 * thereby failing the connection if we see more than allowed
3512 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003513 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3514 }
3515 }
3516 else
3517 ssl->nb_zero = 0;
3518
3519#if defined(MBEDTLS_SSL_PROTO_DTLS)
3520 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3521 {
3522 ; /* in_ctr read from peer, not maintained internally */
3523 }
3524 else
3525#endif
3526 {
3527 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003528 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003529 if( ++ssl->in_ctr[i - 1] != 0 )
3530 break;
3531
3532 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003533 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003534 {
3535 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3536 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3537 }
3538 }
3539
Paul Bakker5121ce52009-01-03 21:22:43 +00003540 }
3541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003543 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003544 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003546 }
3547#endif
3548
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003549 /* Check actual (decrypted) record content length against
3550 * configured maximum. */
3551 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3552 {
3553 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3554 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3555 }
3556
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003557 return( 0 );
3558}
3559
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003560/*
3561 * Read a record.
3562 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003563 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3564 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3565 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003566 */
Hanno Becker1097b342018-08-15 14:09:41 +01003567
3568/* Helper functions for mbedtls_ssl_read_record(). */
3569static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003570static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3571static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003572
Hanno Becker327c93b2018-08-15 13:56:18 +01003573int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003574 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003575{
Janos Follath865b3eb2019-12-16 11:46:15 +00003576 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003579
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003580 if( ssl->keep_current_message == 0 )
3581 {
3582 do {
Simon Butcher99000142016-10-13 17:21:01 +01003583
Hanno Becker26994592018-08-15 14:14:59 +01003584 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003585 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003586 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003587
Hanno Beckere74d5562018-08-15 14:26:08 +01003588 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003589 {
Hanno Becker40f50842018-08-15 14:48:01 +01003590#if defined(MBEDTLS_SSL_PROTO_DTLS)
3591 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003592
Hanno Becker40f50842018-08-15 14:48:01 +01003593 /* We only check for buffered messages if the
3594 * current datagram is fully consumed. */
3595 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003596 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003597 {
Hanno Becker40f50842018-08-15 14:48:01 +01003598 if( ssl_load_buffered_message( ssl ) == 0 )
3599 have_buffered = 1;
3600 }
3601
3602 if( have_buffered == 0 )
3603#endif /* MBEDTLS_SSL_PROTO_DTLS */
3604 {
3605 ret = ssl_get_next_record( ssl );
3606 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3607 continue;
3608
3609 if( ret != 0 )
3610 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003611 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003612 return( ret );
3613 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003614 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003615 }
3616
3617 ret = mbedtls_ssl_handle_message_type( ssl );
3618
Hanno Becker40f50842018-08-15 14:48:01 +01003619#if defined(MBEDTLS_SSL_PROTO_DTLS)
3620 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3621 {
3622 /* Buffer future message */
3623 ret = ssl_buffer_message( ssl );
3624 if( ret != 0 )
3625 return( ret );
3626
3627 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3628 }
3629#endif /* MBEDTLS_SSL_PROTO_DTLS */
3630
Hanno Becker90333da2017-10-10 11:27:13 +01003631 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3632 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003633
3634 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003635 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003636 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003637 return( ret );
3638 }
3639
Hanno Becker327c93b2018-08-15 13:56:18 +01003640 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003641 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003642 {
3643 mbedtls_ssl_update_handshake_status( ssl );
3644 }
Simon Butcher99000142016-10-13 17:21:01 +01003645 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003646 else
Simon Butcher99000142016-10-13 17:21:01 +01003647 {
Hanno Becker02f59072018-08-15 14:00:24 +01003648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003649 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003650 }
3651
3652 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3653
3654 return( 0 );
3655}
3656
Hanno Becker40f50842018-08-15 14:48:01 +01003657#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003658static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003659{
Hanno Becker40f50842018-08-15 14:48:01 +01003660 if( ssl->in_left > ssl->next_record_offset )
3661 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003662
Hanno Becker40f50842018-08-15 14:48:01 +01003663 return( 0 );
3664}
3665
3666static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3667{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003668 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003669 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003670 int ret = 0;
3671
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003672 if( hs == NULL )
3673 return( -1 );
3674
Hanno Beckere00ae372018-08-20 09:39:42 +01003675 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3676
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003677 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3678 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3679 {
3680 /* Check if we have seen a ChangeCipherSpec before.
3681 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003682 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003683 {
3684 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3685 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003686 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003687 }
3688
Hanno Becker39b8bc92018-08-28 17:17:13 +01003689 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003690 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3691 ssl->in_msglen = 1;
3692 ssl->in_msg[0] = 1;
3693
3694 /* As long as they are equal, the exact value doesn't matter. */
3695 ssl->in_left = 0;
3696 ssl->next_record_offset = 0;
3697
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003698 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003699 goto exit;
3700 }
Hanno Becker37f95322018-08-16 13:55:32 +01003701
Hanno Beckerb8f50142018-08-28 10:01:34 +01003702#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003703 /* Debug only */
3704 {
3705 unsigned offset;
3706 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3707 {
3708 hs_buf = &hs->buffering.hs[offset];
3709 if( hs_buf->is_valid == 1 )
3710 {
3711 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3712 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003713 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003714 }
3715 }
3716 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003717#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003718
3719 /* Check if we have buffered and/or fully reassembled the
3720 * next handshake message. */
3721 hs_buf = &hs->buffering.hs[0];
3722 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3723 {
3724 /* Synthesize a record containing the buffered HS message. */
3725 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3726 ( hs_buf->data[2] << 8 ) |
3727 hs_buf->data[3];
3728
3729 /* Double-check that we haven't accidentally buffered
3730 * a message that doesn't fit into the input buffer. */
3731 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3732 {
3733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3734 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3735 }
3736
3737 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3738 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3739 hs_buf->data, msg_len + 12 );
3740
3741 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3742 ssl->in_hslen = msg_len + 12;
3743 ssl->in_msglen = msg_len + 12;
3744 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3745
3746 ret = 0;
3747 goto exit;
3748 }
3749 else
3750 {
3751 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3752 hs->in_msg_seq ) );
3753 }
3754
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003755 ret = -1;
3756
3757exit:
3758
3759 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3760 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003761}
3762
Hanno Beckera02b0b42018-08-21 17:20:27 +01003763static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3764 size_t desired )
3765{
3766 int offset;
3767 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003768 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3769 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003770
Hanno Becker01315ea2018-08-21 17:22:17 +01003771 /* Get rid of future records epoch first, if such exist. */
3772 ssl_free_buffered_record( ssl );
3773
3774 /* Check if we have enough space available now. */
3775 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3776 hs->buffering.total_bytes_buffered ) )
3777 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003779 return( 0 );
3780 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003781
Hanno Becker4f432ad2018-08-28 10:02:32 +01003782 /* We don't have enough space to buffer the next expected handshake
3783 * message. Remove buffers used for future messages to gain space,
3784 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003785 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3786 offset >= 0; offset-- )
3787 {
3788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3789 offset ) );
3790
Hanno Beckerb309b922018-08-23 13:18:05 +01003791 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003792
3793 /* Check if we have enough space available now. */
3794 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3795 hs->buffering.total_bytes_buffered ) )
3796 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003798 return( 0 );
3799 }
3800 }
3801
3802 return( -1 );
3803}
3804
Hanno Becker40f50842018-08-15 14:48:01 +01003805static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3806{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003807 int ret = 0;
3808 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3809
3810 if( hs == NULL )
3811 return( 0 );
3812
3813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3814
3815 switch( ssl->in_msgtype )
3816 {
3817 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003819
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003820 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003821 break;
3822
3823 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003824 {
3825 unsigned recv_msg_seq_offset;
3826 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3827 mbedtls_ssl_hs_buffer *hs_buf;
3828 size_t msg_len = ssl->in_hslen - 12;
3829
3830 /* We should never receive an old handshake
3831 * message - double-check nonetheless. */
3832 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3833 {
3834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3836 }
3837
3838 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3839 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3840 {
3841 /* Silently ignore -- message too far in the future */
3842 MBEDTLS_SSL_DEBUG_MSG( 2,
3843 ( "Ignore future HS message with sequence number %u, "
3844 "buffering window %u - %u",
3845 recv_msg_seq, ssl->handshake->in_msg_seq,
3846 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3847
3848 goto exit;
3849 }
3850
3851 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3852 recv_msg_seq, recv_msg_seq_offset ) );
3853
3854 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3855
3856 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003857 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003858 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003859 size_t reassembly_buf_sz;
3860
Hanno Becker37f95322018-08-16 13:55:32 +01003861 hs_buf->is_fragmented =
3862 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3863
3864 /* We copy the message back into the input buffer
3865 * after reassembly, so check that it's not too large.
3866 * This is an implementation-specific limitation
3867 * and not one from the standard, hence it is not
3868 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003869 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003870 {
3871 /* Ignore message */
3872 goto exit;
3873 }
3874
Hanno Beckere0b150f2018-08-21 15:51:03 +01003875 /* Check if we have enough space to buffer the message. */
3876 if( hs->buffering.total_bytes_buffered >
3877 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3878 {
3879 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3880 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3881 }
3882
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003883 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3884 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003885
3886 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3887 hs->buffering.total_bytes_buffered ) )
3888 {
3889 if( recv_msg_seq_offset > 0 )
3890 {
3891 /* If we can't buffer a future message because
3892 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3894 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3895 " (already %" MBEDTLS_PRINTF_SIZET
3896 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003897 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003898 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003899 goto exit;
3900 }
Hanno Beckere1801392018-08-21 16:51:05 +01003901 else
3902 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3904 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3905 " (already %" MBEDTLS_PRINTF_SIZET
3906 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003907 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003908 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003909 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003910
Hanno Beckera02b0b42018-08-21 17:20:27 +01003911 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003912 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003913 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3914 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3915 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3916 " (already %" MBEDTLS_PRINTF_SIZET
3917 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003918 msg_len,
3919 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003920 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003921 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003922 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3923 goto exit;
3924 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003925 }
3926
Paul Elliottd48d5c62021-01-07 14:47:05 +00003927 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003928 msg_len ) );
3929
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003930 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3931 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003932 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003933 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003934 goto exit;
3935 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003936 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003937
3938 /* Prepare final header: copy msg_type, length and message_seq,
3939 * then add standardised fragment_offset and fragment_length */
3940 memcpy( hs_buf->data, ssl->in_msg, 6 );
3941 memset( hs_buf->data + 6, 0, 3 );
3942 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3943
3944 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003945
3946 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003947 }
3948 else
3949 {
3950 /* Make sure msg_type and length are consistent */
3951 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3952 {
3953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3954 /* Ignore */
3955 goto exit;
3956 }
3957 }
3958
Hanno Becker4422bbb2018-08-20 09:40:19 +01003959 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003960 {
3961 size_t frag_len, frag_off;
3962 unsigned char * const msg = hs_buf->data + 12;
3963
3964 /*
3965 * Check and copy current fragment
3966 */
3967
3968 /* Validation of header fields already done in
3969 * mbedtls_ssl_prepare_handshake_record(). */
3970 frag_off = ssl_get_hs_frag_off( ssl );
3971 frag_len = ssl_get_hs_frag_len( ssl );
3972
Paul Elliottd48d5c62021-01-07 14:47:05 +00003973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
3974 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01003975 frag_off, frag_len ) );
3976 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
3977
3978 if( hs_buf->is_fragmented )
3979 {
3980 unsigned char * const bitmask = msg + msg_len;
3981 ssl_bitmask_set( bitmask, frag_off, frag_len );
3982 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
3983 msg_len ) == 0 );
3984 }
3985 else
3986 {
3987 hs_buf->is_complete = 1;
3988 }
3989
3990 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
3991 hs_buf->is_complete ? "" : "not yet " ) );
3992 }
3993
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003994 break;
Hanno Becker37f95322018-08-16 13:55:32 +01003995 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003996
3997 default:
Hanno Becker360bef32018-08-28 10:04:33 +01003998 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003999 break;
4000 }
4001
4002exit:
4003
4004 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4005 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004006}
4007#endif /* MBEDTLS_SSL_PROTO_DTLS */
4008
Hanno Becker1097b342018-08-15 14:09:41 +01004009static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004010{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004011 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004012 * Consume last content-layer message and potentially
4013 * update in_msglen which keeps track of the contents'
4014 * consumption state.
4015 *
4016 * (1) Handshake messages:
4017 * Remove last handshake message, move content
4018 * and adapt in_msglen.
4019 *
4020 * (2) Alert messages:
4021 * Consume whole record content, in_msglen = 0.
4022 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004023 * (3) Change cipher spec:
4024 * Consume whole record content, in_msglen = 0.
4025 *
4026 * (4) Application data:
4027 * Don't do anything - the record layer provides
4028 * the application data as a stream transport
4029 * and consumes through mbedtls_ssl_read only.
4030 *
4031 */
4032
4033 /* Case (1): Handshake messages */
4034 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004035 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004036 /* Hard assertion to be sure that no application data
4037 * is in flight, as corrupting ssl->in_msglen during
4038 * ssl->in_offt != NULL is fatal. */
4039 if( ssl->in_offt != NULL )
4040 {
4041 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4042 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4043 }
4044
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004045 /*
4046 * Get next Handshake message in the current record
4047 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004048
Hanno Becker4a810fb2017-05-24 16:27:30 +01004049 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004050 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004051 * current handshake content: If DTLS handshake
4052 * fragmentation is used, that's the fragment
4053 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004054 * size here is faulty and should be changed at
4055 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004056 * (2) While it doesn't seem to cause problems, one
4057 * has to be very careful not to assume that in_hslen
4058 * is always <= in_msglen in a sensible communication.
4059 * Again, it's wrong for DTLS handshake fragmentation.
4060 * The following check is therefore mandatory, and
4061 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004062 * Additionally, ssl->in_hslen might be arbitrarily out of
4063 * bounds after handling a DTLS message with an unexpected
4064 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004065 */
4066 if( ssl->in_hslen < ssl->in_msglen )
4067 {
4068 ssl->in_msglen -= ssl->in_hslen;
4069 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4070 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004071
Hanno Becker4a810fb2017-05-24 16:27:30 +01004072 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4073 ssl->in_msg, ssl->in_msglen );
4074 }
4075 else
4076 {
4077 ssl->in_msglen = 0;
4078 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004079
Hanno Becker4a810fb2017-05-24 16:27:30 +01004080 ssl->in_hslen = 0;
4081 }
4082 /* Case (4): Application data */
4083 else if( ssl->in_offt != NULL )
4084 {
4085 return( 0 );
4086 }
4087 /* Everything else (CCS & Alerts) */
4088 else
4089 {
4090 ssl->in_msglen = 0;
4091 }
4092
Hanno Becker1097b342018-08-15 14:09:41 +01004093 return( 0 );
4094}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004095
Hanno Beckere74d5562018-08-15 14:26:08 +01004096static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4097{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004098 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004099 return( 1 );
4100
4101 return( 0 );
4102}
4103
Hanno Becker5f066e72018-08-16 14:56:31 +01004104#if defined(MBEDTLS_SSL_PROTO_DTLS)
4105
4106static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4107{
4108 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4109 if( hs == NULL )
4110 return;
4111
Hanno Becker01315ea2018-08-21 17:22:17 +01004112 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004113 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004114 hs->buffering.total_bytes_buffered -=
4115 hs->buffering.future_record.len;
4116
4117 mbedtls_free( hs->buffering.future_record.data );
4118 hs->buffering.future_record.data = NULL;
4119 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004120}
4121
4122static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4123{
4124 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4125 unsigned char * rec;
4126 size_t rec_len;
4127 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004128#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4129 size_t in_buf_len = ssl->in_buf_len;
4130#else
4131 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4132#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004133 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4134 return( 0 );
4135
4136 if( hs == NULL )
4137 return( 0 );
4138
Hanno Becker5f066e72018-08-16 14:56:31 +01004139 rec = hs->buffering.future_record.data;
4140 rec_len = hs->buffering.future_record.len;
4141 rec_epoch = hs->buffering.future_record.epoch;
4142
4143 if( rec == NULL )
4144 return( 0 );
4145
Hanno Becker4cb782d2018-08-20 11:19:05 +01004146 /* Only consider loading future records if the
4147 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004148 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004149 return( 0 );
4150
Hanno Becker5f066e72018-08-16 14:56:31 +01004151 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4152
4153 if( rec_epoch != ssl->in_epoch )
4154 {
4155 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4156 goto exit;
4157 }
4158
4159 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4160
4161 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004162 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004163 {
4164 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4165 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4166 }
4167
4168 memcpy( ssl->in_hdr, rec, rec_len );
4169 ssl->in_left = rec_len;
4170 ssl->next_record_offset = 0;
4171
4172 ssl_free_buffered_record( ssl );
4173
4174exit:
4175 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4176 return( 0 );
4177}
4178
Hanno Becker519f15d2019-07-11 12:43:20 +01004179static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4180 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004181{
4182 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004183
4184 /* Don't buffer future records outside handshakes. */
4185 if( hs == NULL )
4186 return( 0 );
4187
4188 /* Only buffer handshake records (we are only interested
4189 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004190 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004191 return( 0 );
4192
4193 /* Don't buffer more than one future epoch record. */
4194 if( hs->buffering.future_record.data != NULL )
4195 return( 0 );
4196
Hanno Becker01315ea2018-08-21 17:22:17 +01004197 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004198 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004199 hs->buffering.total_bytes_buffered ) )
4200 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4202 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4203 " (already %" MBEDTLS_PRINTF_SIZET
4204 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004205 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004206 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004207 return( 0 );
4208 }
4209
Hanno Becker5f066e72018-08-16 14:56:31 +01004210 /* Buffer record */
4211 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004212 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004213 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004214
4215 /* ssl_parse_record_header() only considers records
4216 * of the next epoch as candidates for buffering. */
4217 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004218 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004219
4220 hs->buffering.future_record.data =
4221 mbedtls_calloc( 1, hs->buffering.future_record.len );
4222 if( hs->buffering.future_record.data == NULL )
4223 {
4224 /* If we run out of RAM trying to buffer a
4225 * record from the next epoch, just ignore. */
4226 return( 0 );
4227 }
4228
Hanno Becker519f15d2019-07-11 12:43:20 +01004229 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004230
Hanno Becker519f15d2019-07-11 12:43:20 +01004231 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004232 return( 0 );
4233}
4234
4235#endif /* MBEDTLS_SSL_PROTO_DTLS */
4236
Hanno Beckere74d5562018-08-15 14:26:08 +01004237static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004238{
Janos Follath865b3eb2019-12-16 11:46:15 +00004239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004240 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004241
Hanno Becker5f066e72018-08-16 14:56:31 +01004242#if defined(MBEDTLS_SSL_PROTO_DTLS)
4243 /* We might have buffered a future record; if so,
4244 * and if the epoch matches now, load it.
4245 * On success, this call will set ssl->in_left to
4246 * the length of the buffered record, so that
4247 * the calls to ssl_fetch_input() below will
4248 * essentially be no-ops. */
4249 ret = ssl_load_buffered_record( ssl );
4250 if( ret != 0 )
4251 return( ret );
4252#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004253
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004254 /* Ensure that we have enough space available for the default form
4255 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4256 * with no space for CIDs counted in). */
4257 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4258 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004259 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004260 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004261 return( ret );
4262 }
4263
Hanno Beckere5e7e782019-07-11 12:29:35 +01004264 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4265 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004267#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004268 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004269 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004270 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4271 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004272 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004273 if( ret != 0 )
4274 return( ret );
4275
4276 /* Fall through to handling of unexpected records */
4277 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4278 }
4279
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004280 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4281 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004282#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004283 /* Reset in pointers to default state for TLS/DTLS records,
4284 * assuming no CID and no offset between record content and
4285 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004286 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004287
Hanno Becker7ae20e02019-07-12 08:33:49 +01004288 /* Setup internal message pointers from record structure. */
4289 ssl->in_msgtype = rec.type;
4290#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4291 ssl->in_len = ssl->in_cid + rec.cid_len;
4292#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4293 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4294 ssl->in_msglen = rec.data_len;
4295
Hanno Becker2fddd372019-07-10 14:37:41 +01004296 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004297 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004298 if( ret != 0 )
4299 return( ret );
4300#endif
4301
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004302 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004303 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004304
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004305 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4306 "(header)" ) );
4307 }
4308 else
4309 {
4310 /* Skip invalid record and the rest of the datagram */
4311 ssl->next_record_offset = 0;
4312 ssl->in_left = 0;
4313
4314 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4315 "(header)" ) );
4316 }
4317
4318 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004319 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004320 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004321 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004322#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004323 {
4324 return( ret );
4325 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004326 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004328#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004329 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004330 {
Hanno Beckera8814792019-07-10 15:01:45 +01004331 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004332 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004333 if( ssl->next_record_offset < ssl->in_left )
4334 {
4335 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4336 }
4337 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004338 else
4339#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004340 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004341 /*
4342 * Fetch record contents from underlying transport.
4343 */
Hanno Beckera3175662019-07-11 12:50:29 +01004344 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004345 if( ret != 0 )
4346 {
4347 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4348 return( ret );
4349 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004350
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004351 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004352 }
4353
4354 /*
4355 * Decrypt record contents.
4356 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004357
Hanno Beckerfdf66042019-07-11 13:07:45 +01004358 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004360#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004361 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004362 {
4363 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004364 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004365 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004366 /* Except when waiting for Finished as a bad mac here
4367 * probably means something went wrong in the handshake
4368 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4369 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4370 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4371 {
4372#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4373 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4374 {
4375 mbedtls_ssl_send_alert_message( ssl,
4376 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4377 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4378 }
4379#endif
4380 return( ret );
4381 }
4382
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004383 if( ssl->conf->badmac_limit != 0 &&
4384 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004385 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004386 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4387 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004388 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004389
Hanno Becker4a810fb2017-05-24 16:27:30 +01004390 /* As above, invalid records cause
4391 * dismissal of the whole datagram. */
4392
4393 ssl->next_record_offset = 0;
4394 ssl->in_left = 0;
4395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004397 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004398 }
4399
4400 return( ret );
4401 }
4402 else
4403#endif
4404 {
4405 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004406#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4407 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004408 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004409 mbedtls_ssl_send_alert_message( ssl,
4410 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4411 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004412 }
4413#endif
4414 return( ret );
4415 }
4416 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004417
Hanno Becker44d89b22019-07-12 09:40:44 +01004418
4419 /* Reset in pointers to default state for TLS/DTLS records,
4420 * assuming no CID and no offset between record content and
4421 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004422 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004423#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4424 ssl->in_len = ssl->in_cid + rec.cid_len;
4425#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004426 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004427
Hanno Becker8685c822019-07-12 09:37:30 +01004428 /* The record content type may change during decryption,
4429 * so re-read it. */
4430 ssl->in_msgtype = rec.type;
4431 /* Also update the input buffer, because unfortunately
4432 * the server-side ssl_parse_client_hello() reparses the
4433 * record header when receiving a ClientHello initiating
4434 * a renegotiation. */
4435 ssl->in_hdr[0] = rec.type;
4436 ssl->in_msg = rec.buf + rec.data_offset;
4437 ssl->in_msglen = rec.data_len;
4438 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4439 ssl->in_len[1] = (unsigned char)( rec.data_len );
4440
Simon Butcher99000142016-10-13 17:21:01 +01004441 return( 0 );
4442}
4443
4444int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4445{
Janos Follath865b3eb2019-12-16 11:46:15 +00004446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004447
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004448 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004449 * Handle particular types of records
4450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004451 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004452 {
Simon Butcher99000142016-10-13 17:21:01 +01004453 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4454 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004455 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004456 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004457 }
4458
Hanno Beckere678eaa2018-08-21 14:57:46 +01004459 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004460 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004461 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004462 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004464 ssl->in_msglen ) );
4465 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004466 }
4467
Hanno Beckere678eaa2018-08-21 14:57:46 +01004468 if( ssl->in_msg[0] != 1 )
4469 {
4470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4471 ssl->in_msg[0] ) );
4472 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4473 }
4474
4475#if defined(MBEDTLS_SSL_PROTO_DTLS)
4476 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4477 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4478 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4479 {
4480 if( ssl->handshake == NULL )
4481 {
4482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4483 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4484 }
4485
4486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4487 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4488 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004489#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004490 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004492 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004493 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004494 if( ssl->in_msglen != 2 )
4495 {
4496 /* Note: Standard allows for more than one 2 byte alert
4497 to be packed in a single message, but Mbed TLS doesn't
4498 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004500 ssl->in_msglen ) );
4501 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4502 }
4503
Paul Elliott9f352112020-12-09 14:55:45 +00004504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004505 ssl->in_msg[0], ssl->in_msg[1] ) );
4506
4507 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004508 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004510 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004511 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004512 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004513 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004514 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004515 }
4516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004517 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4518 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4521 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004522 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004523
4524#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4525 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4526 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4527 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004529 /* Will be handled when trying to parse ServerHello */
4530 return( 0 );
4531 }
4532#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004533 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004534 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004535 }
4536
Hanno Beckerc76c6192017-06-06 10:03:17 +01004537#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004538 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004539 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004540 /* Drop unexpected ApplicationData records,
4541 * except at the beginning of renegotiations */
4542 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4543 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4544#if defined(MBEDTLS_SSL_RENEGOTIATION)
4545 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4546 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004547#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004548 )
4549 {
4550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4551 return( MBEDTLS_ERR_SSL_NON_FATAL );
4552 }
4553
4554 if( ssl->handshake != NULL &&
4555 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4556 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004557 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004558 }
4559 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004560#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004561
Paul Bakker5121ce52009-01-03 21:22:43 +00004562 return( 0 );
4563}
4564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004566{
irwir6c0da642019-09-26 21:07:41 +03004567 return( mbedtls_ssl_send_alert_message( ssl,
4568 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4569 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004570}
4571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004572int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004573 unsigned char level,
4574 unsigned char message )
4575{
Janos Follath865b3eb2019-12-16 11:46:15 +00004576 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004577
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004578 if( ssl == NULL || ssl->conf == NULL )
4579 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004582 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004584 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004585 ssl->out_msglen = 2;
4586 ssl->out_msg[0] = level;
4587 ssl->out_msg[1] = message;
4588
Hanno Becker67bc7c32018-08-06 11:33:50 +01004589 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004590 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004592 return( ret );
4593 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004594 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004595
4596 return( 0 );
4597}
4598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004599int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004600{
Janos Follath865b3eb2019-12-16 11:46:15 +00004601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004603 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004605 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004606 ssl->out_msglen = 1;
4607 ssl->out_msg[0] = 1;
4608
Paul Bakker5121ce52009-01-03 21:22:43 +00004609 ssl->state++;
4610
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004611 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004612 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004613 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004614 return( ret );
4615 }
4616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004618
4619 return( 0 );
4620}
4621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004622int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004623{
Janos Follath865b3eb2019-12-16 11:46:15 +00004624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004627
Hanno Becker327c93b2018-08-15 13:56:18 +01004628 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004629 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004630 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004631 return( ret );
4632 }
4633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004635 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004637 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4638 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004639 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004640 }
4641
Hanno Beckere678eaa2018-08-21 14:57:46 +01004642 /* CCS records are only accepted if they have length 1 and content '1',
4643 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004644
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004645 /*
4646 * Switch to our negotiated transform and session parameters for inbound
4647 * data.
4648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004649 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004650 ssl->transform_in = ssl->transform_negotiate;
4651 ssl->session_in = ssl->session_negotiate;
4652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004653#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004654 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004655 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004656#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004657 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004658#endif
4659
4660 /* Increment epoch */
4661 if( ++ssl->in_epoch == 0 )
4662 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004664 /* This is highly unlikely to happen for legitimate reasons, so
4665 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004666 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004667 }
4668 }
4669 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004671 memset( ssl->in_ctr, 0, 8 );
4672
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004673 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004674
Paul Bakker5121ce52009-01-03 21:22:43 +00004675 ssl->state++;
4676
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
4679 return( 0 );
4680}
4681
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004682/* Once ssl->out_hdr as the address of the beginning of the
4683 * next outgoing record is set, deduce the other pointers.
4684 *
4685 * Note: For TLS, we save the implicit record sequence number
4686 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4687 * and the caller has to make sure there's space for this.
4688 */
4689
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004690static size_t ssl_transform_get_explicit_iv_len(
4691 mbedtls_ssl_transform const *transform )
4692{
TRodziewiczef73f012021-05-13 14:53:36 +02004693 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004694 return( 0 );
4695
4696 return( transform->ivlen - transform->fixed_ivlen );
4697}
4698
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004699void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4700 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004701{
4702#if defined(MBEDTLS_SSL_PROTO_DTLS)
4703 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4704 {
4705 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004706#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004707 ssl->out_cid = ssl->out_ctr + 8;
4708 ssl->out_len = ssl->out_cid;
4709 if( transform != NULL )
4710 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004711#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004712 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004713#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004714 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004715 }
4716 else
4717#endif
4718 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004719 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004720#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004721 ssl->out_cid = ssl->out_len;
4722#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004723 ssl->out_iv = ssl->out_hdr + 5;
4724 }
4725
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004726 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004727 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004728 if( transform != NULL )
4729 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004730}
4731
4732/* Once ssl->in_hdr as the address of the beginning of the
4733 * next incoming record is set, deduce the other pointers.
4734 *
4735 * Note: For TLS, we save the implicit record sequence number
4736 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4737 * and the caller has to make sure there's space for this.
4738 */
4739
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004740void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004741{
Hanno Becker79594fd2019-05-08 09:38:41 +01004742 /* This function sets the pointers to match the case
4743 * of unprotected TLS/DTLS records, with both ssl->in_iv
4744 * and ssl->in_msg pointing to the beginning of the record
4745 * content.
4746 *
4747 * When decrypting a protected record, ssl->in_msg
4748 * will be shifted to point to the beginning of the
4749 * record plaintext.
4750 */
4751
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004752#if defined(MBEDTLS_SSL_PROTO_DTLS)
4753 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4754 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004755 /* This sets the header pointers to match records
4756 * without CID. When we receive a record containing
4757 * a CID, the fields are shifted accordingly in
4758 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004759 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004760#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004761 ssl->in_cid = ssl->in_ctr + 8;
4762 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004763#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004764 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004765#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004766 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004767 }
4768 else
4769#endif
4770 {
4771 ssl->in_ctr = ssl->in_hdr - 8;
4772 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004773#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004774 ssl->in_cid = ssl->in_len;
4775#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004776 ssl->in_iv = ssl->in_hdr + 5;
4777 }
4778
Hanno Becker79594fd2019-05-08 09:38:41 +01004779 /* This will be adjusted at record decryption time. */
4780 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004781}
4782
Paul Bakker5121ce52009-01-03 21:22:43 +00004783/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004784 * Setup an SSL context
4785 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004786
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004787void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004788{
4789 /* Set the incoming and outgoing record pointers. */
4790#if defined(MBEDTLS_SSL_PROTO_DTLS)
4791 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4792 {
4793 ssl->out_hdr = ssl->out_buf;
4794 ssl->in_hdr = ssl->in_buf;
4795 }
4796 else
4797#endif /* MBEDTLS_SSL_PROTO_DTLS */
4798 {
Hanno Becker12078f42021-03-02 15:28:41 +00004799 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004800 ssl->out_hdr = ssl->out_buf + 8;
4801 ssl->in_hdr = ssl->in_buf + 8;
4802 }
4803
4804 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004805 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4806 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004807}
4808
Paul Bakker5121ce52009-01-03 21:22:43 +00004809/*
4810 * SSL get accessors
4811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004812size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004813{
4814 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4815}
4816
Hanno Becker8b170a02017-10-10 11:51:19 +01004817int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4818{
4819 /*
4820 * Case A: We're currently holding back
4821 * a message for further processing.
4822 */
4823
4824 if( ssl->keep_current_message == 1 )
4825 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004826 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004827 return( 1 );
4828 }
4829
4830 /*
4831 * Case B: Further records are pending in the current datagram.
4832 */
4833
4834#if defined(MBEDTLS_SSL_PROTO_DTLS)
4835 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4836 ssl->in_left > ssl->next_record_offset )
4837 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004838 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004839 return( 1 );
4840 }
4841#endif /* MBEDTLS_SSL_PROTO_DTLS */
4842
4843 /*
4844 * Case C: A handshake message is being processed.
4845 */
4846
Hanno Becker8b170a02017-10-10 11:51:19 +01004847 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4848 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004849 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004850 return( 1 );
4851 }
4852
4853 /*
4854 * Case D: An application data message is being processed
4855 */
4856 if( ssl->in_offt != NULL )
4857 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004858 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004859 return( 1 );
4860 }
4861
4862 /*
4863 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004864 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004865 * we implement support for multiple alerts in single records.
4866 */
4867
4868 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4869 return( 0 );
4870}
4871
Paul Bakker43ca69c2011-01-15 17:35:19 +00004872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004874{
Hanno Becker3136ede2018-08-17 15:28:19 +01004875 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004876 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004877 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004878
Hanno Becker5903de42019-05-03 14:46:38 +01004879 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4880
Hanno Becker78640902018-08-13 16:35:15 +01004881 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004882 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004884 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004885 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004886 case MBEDTLS_MODE_GCM:
4887 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004888 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004889 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004890 transform_expansion = transform->minlen;
4891 break;
4892
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004893 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004894
4895 block_size = mbedtls_cipher_get_block_size(
4896 &transform->cipher_ctx_enc );
4897
Hanno Becker3136ede2018-08-17 15:28:19 +01004898 /* Expansion due to the addition of the MAC. */
4899 transform_expansion += transform->maclen;
4900
4901 /* Expansion due to the addition of CBC padding;
4902 * Theoretically up to 256 bytes, but we never use
4903 * more than the block size of the underlying cipher. */
4904 transform_expansion += block_size;
4905
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004906 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004907 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004908#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004909 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004910#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004911
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004912 break;
4913
4914 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004916 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004917 }
4918
Hanno Beckera0e20d02019-05-15 14:03:01 +01004919#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004920 if( transform->out_cid_len != 0 )
4921 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004922#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004923
Hanno Becker5903de42019-05-03 14:46:38 +01004924 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004925}
4926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004927#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004928/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004929 * Check record counters and renegotiate if they're above the limit.
4930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004931static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004932{
Hanno Beckerdd772292020-02-05 10:38:31 +00004933 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004934 int in_ctr_cmp;
4935 int out_ctr_cmp;
4936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4938 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004939 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004940 {
4941 return( 0 );
4942 }
4943
Andres AG2196c7f2016-12-15 17:01:16 +00004944 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
4945 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01004946 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00004947 ssl->conf->renego_period + ep_len, 8 - ep_len );
4948
4949 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004950 {
4951 return( 0 );
4952 }
4953
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004956}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004957#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004958
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004959/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004960 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004961 * may only be sent for the purpose of initiating renegotiations.
4962 *
4963 * This function is introduced as a separate helper since the handling
4964 * of post-handshake handshake messages changes significantly in TLS 1.3,
4965 * and having a helper function allows to distinguish between TLS <= 1.2 and
4966 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
4967 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00004968static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004969{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01004970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004971
4972 /*
4973 * - For client-side, expect SERVER_HELLO_REQUEST.
4974 * - For server-side, expect CLIENT_HELLO.
4975 * - Fail (TLS) or silently drop record (DTLS) in other cases.
4976 */
4977
4978#if defined(MBEDTLS_SSL_CLI_C)
4979 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4980 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
4981 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
4982 {
4983 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
4984
4985 /* With DTLS, drop the packet (probably from last handshake) */
4986#if defined(MBEDTLS_SSL_PROTO_DTLS)
4987 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4988 {
4989 return( 0 );
4990 }
4991#endif
4992 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4993 }
4994#endif /* MBEDTLS_SSL_CLI_C */
4995
4996#if defined(MBEDTLS_SSL_SRV_C)
4997 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4998 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
4999 {
5000 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5001
5002 /* With DTLS, drop the packet (probably from last handshake) */
5003#if defined(MBEDTLS_SSL_PROTO_DTLS)
5004 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5005 {
5006 return( 0 );
5007 }
5008#endif
5009 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5010 }
5011#endif /* MBEDTLS_SSL_SRV_C */
5012
5013#if defined(MBEDTLS_SSL_RENEGOTIATION)
5014 /* Determine whether renegotiation attempt should be accepted */
5015 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5016 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5017 ssl->conf->allow_legacy_renegotiation ==
5018 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5019 {
5020 /*
5021 * Accept renegotiation request
5022 */
5023
5024 /* DTLS clients need to know renego is server-initiated */
5025#if defined(MBEDTLS_SSL_PROTO_DTLS)
5026 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5027 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5028 {
5029 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5030 }
5031#endif
5032 ret = mbedtls_ssl_start_renegotiation( ssl );
5033 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5034 ret != 0 )
5035 {
5036 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5037 ret );
5038 return( ret );
5039 }
5040 }
5041 else
5042#endif /* MBEDTLS_SSL_RENEGOTIATION */
5043 {
5044 /*
5045 * Refuse renegotiation
5046 */
5047
5048 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5049
TRodziewicz0f82ec62021-05-12 17:49:18 +02005050#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005051 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5052 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5053 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005054 {
TRodziewicz345165c2021-07-06 13:42:11 +02005055 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005056 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005057#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005058 }
5059
5060 return( 0 );
5061}
5062
Paul Bakker48916f92012-09-16 19:57:18 +00005063/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005064 * Receive application data decrypted from the SSL layer
5065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005066int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005067{
Janos Follath865b3eb2019-12-16 11:46:15 +00005068 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005069 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005070
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005071 if( ssl == NULL || ssl->conf == NULL )
5072 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005076#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005077 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005078 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005079 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005080 return( ret );
5081
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005082 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005083 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005084 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005085 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005086 return( ret );
5087 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005088 }
5089#endif
5090
Hanno Becker4a810fb2017-05-24 16:27:30 +01005091 /*
5092 * Check if renegotiation is necessary and/or handshake is
5093 * in process. If yes, perform/continue, and fall through
5094 * if an unexpected packet is received while the client
5095 * is waiting for the ServerHello.
5096 *
5097 * (There is no equivalent to the last condition on
5098 * the server-side as it is not treated as within
5099 * a handshake while waiting for the ClientHello
5100 * after a renegotiation request.)
5101 */
5102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005103#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005104 ret = ssl_check_ctr_renegotiate( ssl );
5105 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5106 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005107 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005108 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005109 return( ret );
5110 }
5111#endif
5112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005113 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005114 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005115 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005116 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5117 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005118 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005119 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005120 return( ret );
5121 }
5122 }
5123
Hanno Beckere41158b2017-10-23 13:30:32 +01005124 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005125 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005126 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005127 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005128 if( ssl->f_get_timer != NULL &&
5129 ssl->f_get_timer( ssl->p_timer ) == -1 )
5130 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005131 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005132 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005133
Hanno Becker327c93b2018-08-15 13:56:18 +01005134 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005135 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005136 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5137 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005138
Hanno Becker4a810fb2017-05-24 16:27:30 +01005139 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5140 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005141 }
5142
5143 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005144 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005145 {
5146 /*
5147 * OpenSSL sends empty messages to randomize the IV
5148 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005149 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005150 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005151 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005152 return( 0 );
5153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005155 return( ret );
5156 }
5157 }
5158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005159 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005160 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005161 ret = ssl_handle_hs_message_post_handshake( ssl );
5162 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005163 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005164 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5165 ret );
5166 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005167 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005168
Hanno Beckerf26cc722021-04-21 07:30:13 +01005169 /* At this point, we don't know whether the renegotiation triggered
5170 * by the post-handshake message has been completed or not. The cases
5171 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005172 * 1) The renegotiation is complete. In this case, no new record
5173 * has been read yet.
5174 * 2) The renegotiation is incomplete because the client received
5175 * an application data record while awaiting the ServerHello.
5176 * 3) The renegotiation is incomplete because the client received
5177 * a non-handshake, non-application data message while awaiting
5178 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005179 *
5180 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005181 * - For 1), the next iteration will read a new record and check
5182 * if it's application data.
5183 * - For 2), the loop condition isn't satisfied as application data
5184 * is present, hence continue is the same as break
5185 * - For 3), the loop condition is satisfied and read_record
5186 * will re-deliver the message that was held back by the client
5187 * when expecting the ServerHello.
5188 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005189
Hanno Becker90333da2017-10-10 11:27:13 +01005190 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005191 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005192#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005193 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005194 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005195 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005196 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005197 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005198 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005200 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005201 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005202 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005203 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005204 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005205#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005207 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5208 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005209 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005210 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005211 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005212 }
5213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005214 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005215 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005216 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5217 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005218 }
5219
5220 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005221
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005222 /* We're going to return something now, cancel timer,
5223 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005224 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005225 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005226
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005227#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005228 /* If we requested renego but received AppData, resend HelloRequest.
5229 * Do it now, after setting in_offt, to avoid taking this branch
5230 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005231#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005232 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005233 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005234 {
Hanno Becker786300f2020-02-05 10:46:40 +00005235 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005236 {
Hanno Becker786300f2020-02-05 10:46:40 +00005237 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5238 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005239 return( ret );
5240 }
5241 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005242#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005243#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005244 }
5245
5246 n = ( len < ssl->in_msglen )
5247 ? len : ssl->in_msglen;
5248
5249 memcpy( buf, ssl->in_offt, n );
5250 ssl->in_msglen -= n;
5251
gabor-mezei-arma3214132020-07-15 10:55:00 +02005252 /* Zeroising the plaintext buffer to erase unused application data
5253 from the memory. */
5254 mbedtls_platform_zeroize( ssl->in_offt, n );
5255
Paul Bakker5121ce52009-01-03 21:22:43 +00005256 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005257 {
5258 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005259 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005260 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005261 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005262 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005263 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005264 /* more data available */
5265 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005266 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005269
Paul Bakker23986e52011-04-24 08:57:21 +00005270 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005271}
5272
5273/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005274 * Send application data to be encrypted by the SSL layer, taking care of max
5275 * fragment length and buffer size.
5276 *
5277 * According to RFC 5246 Section 6.2.1:
5278 *
5279 * Zero-length fragments of Application data MAY be sent as they are
5280 * potentially useful as a traffic analysis countermeasure.
5281 *
5282 * Therefore, it is possible that the input message length is 0 and the
5283 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005284 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005285static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005286 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005287{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005288 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5289 const size_t max_len = (size_t) ret;
5290
5291 if( ret < 0 )
5292 {
5293 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5294 return( ret );
5295 }
5296
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005297 if( len > max_len )
5298 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005299#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005300 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005301 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005302 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005303 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5304 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005305 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005306 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005307 }
5308 else
5309#endif
5310 len = max_len;
5311 }
Paul Bakker887bd502011-06-08 13:10:54 +00005312
Paul Bakker5121ce52009-01-03 21:22:43 +00005313 if( ssl->out_left != 0 )
5314 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005315 /*
5316 * The user has previously tried to send the data and
5317 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5318 * written. In this case, we expect the high-level write function
5319 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005321 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005322 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005323 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005324 return( ret );
5325 }
5326 }
Paul Bakker887bd502011-06-08 13:10:54 +00005327 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005328 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005329 /*
5330 * The user is trying to send a message the first time, so we need to
5331 * copy the data into the internal buffers and setup the data structure
5332 * to keep track of partial writes
5333 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005334 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005335 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005336 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005337
Hanno Becker67bc7c32018-08-06 11:33:50 +01005338 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005339 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005340 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005341 return( ret );
5342 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005343 }
5344
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005345 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005346}
5347
5348/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005349 * Write application data (public-facing wrapper)
5350 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005351int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005352{
Janos Follath865b3eb2019-12-16 11:46:15 +00005353 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005354
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005356
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005357 if( ssl == NULL || ssl->conf == NULL )
5358 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5359
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005360#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005361 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5362 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005363 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005364 return( ret );
5365 }
5366#endif
5367
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005368 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005369 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005370 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005371 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005372 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005373 return( ret );
5374 }
5375 }
5376
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005377 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005378
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005379 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005380
5381 return( ret );
5382}
5383
5384/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005385 * Notify the peer that the connection is being closed
5386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005387int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005388{
Janos Follath865b3eb2019-12-16 11:46:15 +00005389 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005390
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005391 if( ssl == NULL || ssl->conf == NULL )
5392 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005395
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005396 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005397 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005400 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005401 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5402 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5403 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005404 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005405 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005406 return( ret );
5407 }
5408 }
5409
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005411
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005412 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005413}
5414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005415void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005416{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005417 if( transform == NULL )
5418 return;
5419
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005420 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5421 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005422
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005423#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005424 mbedtls_md_free( &transform->md_ctx_enc );
5425 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005426#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005427
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005428 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005429}
5430
Hanno Becker0271f962018-08-16 13:23:47 +01005431#if defined(MBEDTLS_SSL_PROTO_DTLS)
5432
Hanno Becker533ab5f2020-02-05 10:49:13 +00005433void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005434{
5435 unsigned offset;
5436 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5437
5438 if( hs == NULL )
5439 return;
5440
Hanno Becker283f5ef2018-08-24 09:34:47 +01005441 ssl_free_buffered_record( ssl );
5442
Hanno Becker0271f962018-08-16 13:23:47 +01005443 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005444 ssl_buffering_free_slot( ssl, offset );
5445}
5446
5447static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5448 uint8_t slot )
5449{
5450 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5451 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005452
5453 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5454 return;
5455
Hanno Beckere605b192018-08-21 15:59:07 +01005456 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005457 {
Hanno Beckere605b192018-08-21 15:59:07 +01005458 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005459 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005460 mbedtls_free( hs_buf->data );
5461 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005462 }
5463}
5464
5465#endif /* MBEDTLS_SSL_PROTO_DTLS */
5466
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005467/*
5468 * Convert version numbers to/from wire format
5469 * and, for DTLS, to/from TLS equivalent.
5470 *
5471 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005472 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005473 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005476 unsigned char ver[2] )
5477{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005478#if defined(MBEDTLS_SSL_PROTO_DTLS)
5479 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005480 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005482 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5483
5484 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5485 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5486 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005487 else
5488#else
5489 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005490#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005491 {
5492 ver[0] = (unsigned char) major;
5493 ver[1] = (unsigned char) minor;
5494 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005495}
5496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005498 const unsigned char ver[2] )
5499{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500#if defined(MBEDTLS_SSL_PROTO_DTLS)
5501 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005502 {
5503 *major = 255 - ver[0] + 2;
5504 *minor = 255 - ver[1] + 1;
5505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005507 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5508 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005509 else
5510#else
5511 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005512#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005513 {
5514 *major = ver[0];
5515 *minor = ver[1];
5516 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005517}
5518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519#endif /* MBEDTLS_SSL_TLS_C */