blob: 168f1862101d746e32ea0d84f5c6ed4170b502ea [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020043#include "constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020044
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020045#include "ssl_invasive.h"
46
Rich Evans00ab4702015-02-06 13:43:58 +000047#include <string.h>
48
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050049#if defined(MBEDTLS_USE_PSA_CRYPTO)
50#include "mbedtls/psa_util.h"
51#include "psa/crypto.h"
52#endif
53
Janos Follath23bdca02016-10-07 14:47:14 +010054#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000055#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020056#endif
57
Hanno Beckercd9dcda2018-08-28 17:18:56 +010058static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010059
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020060/*
61 * Start a timer.
62 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020063 */
Hanno Becker0f57a652020-02-05 10:37:26 +000064void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020065{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020066 if( ssl->f_set_timer == NULL )
67 return;
68
69 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
70 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020071}
72
73/*
74 * Return -1 is timer is expired, 0 if it isn't.
75 */
Hanno Becker7876d122020-02-05 10:39:31 +000076int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020077{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020078 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020079 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020080
81 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020082 {
83 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020084 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020086
87 return( 0 );
88}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089
TRodziewicz4ca18aa2021-05-20 14:46:20 +020090static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
91 unsigned char *buf,
92 size_t len,
93 mbedtls_record *rec );
94
95int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t buflen )
98{
99 int ret = 0;
100 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
101 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
102
103 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200104 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200105 */
106 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
107 {
108 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
109 goto exit;
110 }
111#if defined(MBEDTLS_SSL_PROTO_DTLS)
112 else
113 {
114 mbedtls_record rec;
115
116 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
117 if( ret != 0 )
118 {
119 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
120 goto exit;
121 }
122
123 if( ssl->transform_in != NULL )
124 {
125 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
126 if( ret != 0 )
127 {
128 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
129 goto exit;
130 }
131 }
132 }
133#endif /* MBEDTLS_SSL_PROTO_DTLS */
134
135exit:
136 /* On success, we have decrypted the buffer in-place, so make
137 * sure we don't leak any plaintext data. */
138 mbedtls_platform_zeroize( buf, buflen );
139
140 /* For the purpose of this API, treat messages with unexpected CID
141 * as well as such from future epochs as unexpected. */
142 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
143 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
144 {
145 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
146 }
147
148 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
149 return( ret );
150}
151
Hanno Becker67bc7c32018-08-06 11:33:50 +0100152#define SSL_DONT_FORCE_FLUSH 0
153#define SSL_FORCE_FLUSH 1
154
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100156
Hanno Beckerd5847772018-08-28 10:09:23 +0100157/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100158static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
159 uint8_t slot );
160static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
162static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
163static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100164static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
165 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100166static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100167
Hanno Becker11682cc2018-08-22 14:41:02 +0100168static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100169{
Hanno Becker89490712020-02-05 10:50:12 +0000170 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000171#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
172 size_t out_buf_len = ssl->out_buf_len;
173#else
174 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
175#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176
Darryl Greenb33cc762019-11-28 14:29:44 +0000177 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100178 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100179
Darryl Greenb33cc762019-11-28 14:29:44 +0000180 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100181}
182
Hanno Becker67bc7c32018-08-06 11:33:50 +0100183static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
184{
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 size_t const bytes_written = ssl->out_left;
186 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100187
188 /* Double-check that the write-index hasn't gone
189 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100190 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100191 {
192 /* Should never happen... */
193 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
194 }
195
196 return( (int) ( mtu - bytes_written ) );
197}
198
199static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
200{
Janos Follath865b3eb2019-12-16 11:46:15 +0000201 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100202 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400203 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100204
205#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400206 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100207
208 if( max_len > mfl )
209 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100210
211 /* By the standard (RFC 6066 Sect. 4), the MFL extension
212 * only limits the maximum record payload size, so in theory
213 * we would be allowed to pack multiple records of payload size
214 * MFL into a single datagram. However, this would mean that there's
215 * no way to explicitly communicate MTU restrictions to the peer.
216 *
217 * The following reduction of max_len makes sure that we never
218 * write datagrams larger than MFL + Record Expansion Overhead.
219 */
220 if( max_len <= ssl->out_left )
221 return( 0 );
222
223 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100224#endif
225
226 ret = ssl_get_remaining_space_in_datagram( ssl );
227 if( ret < 0 )
228 return( ret );
229 remaining = (size_t) ret;
230
231 ret = mbedtls_ssl_get_record_expansion( ssl );
232 if( ret < 0 )
233 return( ret );
234 expansion = (size_t) ret;
235
236 if( remaining <= expansion )
237 return( 0 );
238
239 remaining -= expansion;
240 if( remaining >= max_len )
241 remaining = max_len;
242
243 return( (int) remaining );
244}
245
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200246/*
247 * Double the retransmit timeout value, within the allowed range,
248 * returning -1 if the maximum value has already been reached.
249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200251{
252 uint32_t new_timeout;
253
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200254 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200255 return( -1 );
256
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200257 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
258 * in the following way: after the initial transmission and a first
259 * retransmission, back off to a temporary estimated MTU of 508 bytes.
260 * This value is guaranteed to be deliverable (if not guaranteed to be
261 * delivered) of any compliant IPv4 (and IPv6) network, and should work
262 * on most non-IP stacks too. */
263 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400264 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200265 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
267 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200268
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200269 new_timeout = 2 * ssl->handshake->retransmit_timeout;
270
271 /* Avoid arithmetic overflow and range overflow */
272 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200273 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200274 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200275 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 }
277
278 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000279 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
280 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200281
282 return( 0 );
283}
284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200286{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200287 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000288 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
289 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200290}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200292
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100293/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000294 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200295 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000296
Hanno Beckerccc13d02020-05-04 12:30:04 +0100297#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
298 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100299
300static size_t ssl_compute_padding_length( size_t len,
301 size_t granularity )
302{
303 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
304}
305
Hanno Becker581bc1b2020-05-04 12:20:03 +0100306/* This functions transforms a (D)TLS plaintext fragment and a record content
307 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
308 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
309 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100310 *
311 * struct {
312 * opaque content[DTLSPlaintext.length];
313 * ContentType real_type;
314 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100315 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100316 *
317 * Input:
318 * - `content`: The beginning of the buffer holding the
319 * plaintext to be wrapped.
320 * - `*content_size`: The length of the plaintext in Bytes.
321 * - `max_len`: The number of Bytes available starting from
322 * `content`. This must be `>= *content_size`.
323 * - `rec_type`: The desired record content type.
324 *
325 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100326 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
327 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100328 *
329 * Returns:
330 * - `0` on success.
331 * - A negative error code if `max_len` didn't offer enough space
332 * for the expansion.
333 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100334static int ssl_build_inner_plaintext( unsigned char *content,
335 size_t *content_size,
336 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100337 uint8_t rec_type,
338 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339{
340 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100341
342 /* Write real content type */
343 if( remaining == 0 )
344 return( -1 );
345 content[ len ] = rec_type;
346 len++;
347 remaining--;
348
349 if( remaining < pad )
350 return( -1 );
351 memset( content + len, 0, pad );
352 len += pad;
353 remaining -= pad;
354
355 *content_size = len;
356 return( 0 );
357}
358
Hanno Becker581bc1b2020-05-04 12:20:03 +0100359/* This function parses a (D)TLSInnerPlaintext structure.
360 * See ssl_build_inner_plaintext() for details. */
361static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100362 size_t *content_size,
363 uint8_t *rec_type )
364{
365 size_t remaining = *content_size;
366
367 /* Determine length of padding by skipping zeroes from the back. */
368 do
369 {
370 if( remaining == 0 )
371 return( -1 );
372 remaining--;
373 } while( content[ remaining ] == 0 );
374
375 *content_size = remaining;
376 *rec_type = content[ remaining ];
377
378 return( 0 );
379}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100380#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
381 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100382
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100383/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100384 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000385static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100386 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100387 mbedtls_record *rec,
388 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000389{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100390 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100391 *
392 * additional_data = seq_num + TLSCompressed.type +
393 * TLSCompressed.version + TLSCompressed.length;
394 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100395 * For the CID extension, this is extended as follows
396 * (quoting draft-ietf-tls-dtls-connection-id-05,
397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100398 *
399 * additional_data = seq_num + DTLSPlaintext.type +
400 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100401 * cid +
402 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100403 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100404 *
405 * For TLS 1.3, the record sequence number is dropped from the AAD
406 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100407 */
408
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100409 unsigned char *cur = add_data;
410
411#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
412 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
413#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
414 {
415 ((void) minor_ver);
416 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
417 cur += sizeof( rec->ctr );
418 }
419
420 *cur = rec->type;
421 cur++;
422
423 memcpy( cur, rec->ver, sizeof( rec->ver ) );
424 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100425
Hanno Beckera0e20d02019-05-15 14:03:01 +0100426#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100427 if( rec->cid_len != 0 )
428 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100429 memcpy( cur, rec->cid, rec->cid_len );
430 cur += rec->cid_len;
431
432 *cur = rec->cid_len;
433 cur++;
434
435 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
436 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
437 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100438 }
439 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100440#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100441 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100442 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
443 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
444 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100445 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100446
447 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000448}
449
Hanno Becker67a37db2020-05-28 16:27:07 +0100450#if defined(MBEDTLS_GCM_C) || \
451 defined(MBEDTLS_CCM_C) || \
452 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100453static int ssl_transform_aead_dynamic_iv_is_explicit(
454 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100455{
Hanno Becker17263802020-05-28 07:05:48 +0100456 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100457}
458
Hanno Becker17263802020-05-28 07:05:48 +0100459/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
460 *
461 * Concretely, this occurs in two variants:
462 *
463 * a) Fixed and dynamic IV lengths add up to total IV length, giving
464 * IV = fixed_iv || dynamic_iv
465 *
Hanno Becker15952812020-06-04 13:31:46 +0100466 * This variant is used in TLS 1.2 when used with GCM or CCM.
467 *
Hanno Becker17263802020-05-28 07:05:48 +0100468 * b) Fixed IV lengths matches total IV length, giving
469 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100470 *
471 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
472 *
473 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100474 *
475 * This function has the precondition that
476 *
477 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
478 *
479 * which has to be ensured by the caller. If this precondition
480 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100481 */
482static void ssl_build_record_nonce( unsigned char *dst_iv,
483 size_t dst_iv_len,
484 unsigned char const *fixed_iv,
485 size_t fixed_iv_len,
486 unsigned char const *dynamic_iv,
487 size_t dynamic_iv_len )
488{
489 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100490
491 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100492 memset( dst_iv, 0, dst_iv_len );
493 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100494
Hanno Becker17263802020-05-28 07:05:48 +0100495 dst_iv += dst_iv_len - dynamic_iv_len;
496 for( i = 0; i < dynamic_iv_len; i++ )
497 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100498}
Hanno Becker67a37db2020-05-28 16:27:07 +0100499#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100500
Hanno Beckera18d1322018-01-03 14:27:32 +0000501int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
502 mbedtls_ssl_transform *transform,
503 mbedtls_record *rec,
504 int (*f_rng)(void *, unsigned char *, size_t),
505 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000506{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200507 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100508 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000509 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100510 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100511 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000512 size_t post_avail;
513
514 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000515#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200516 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000517 ((void) ssl);
518#endif
519
520 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200521 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200522#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200523 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000524 ((void) f_rng);
525 ((void) p_rng);
526#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000529
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000530 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100531 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
533 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
534 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100535 if( rec == NULL
536 || rec->buf == NULL
537 || rec->buf_len < rec->data_offset
538 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100540 || rec->cid_len != 0
541#endif
542 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000543 {
544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100546 }
547
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000548 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100549 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000551 data, rec->data_len );
552
553 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
554
555 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
556 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
558 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000559 rec->data_len,
560 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000561 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
562 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100563
Hanno Becker92313402020-05-20 13:58:58 +0100564 /* The following two code paths implement the (D)TLSInnerPlaintext
565 * structure present in TLS 1.3 and DTLS 1.2 + CID.
566 *
567 * See ssl_build_inner_plaintext() for more information.
568 *
569 * Note that this changes `rec->data_len`, and hence
570 * `post_avail` needs to be recalculated afterwards.
571 *
572 * Note also that the two code paths cannot occur simultaneously
573 * since they apply to different versions of the protocol. There
574 * is hence no risk of double-addition of the inner plaintext.
575 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100576#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
577 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
578 {
Hanno Becker13996922020-05-28 16:15:19 +0100579 size_t padding =
580 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200581 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100582 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100583 &rec->data_len,
584 post_avail,
585 rec->type,
586 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100587 {
588 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
589 }
590
591 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
592 }
593#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
594
Hanno Beckera0e20d02019-05-15 14:03:01 +0100595#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100596 /*
597 * Add CID information
598 */
599 rec->cid_len = transform->out_cid_len;
600 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
601 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100602
603 if( rec->cid_len != 0 )
604 {
Hanno Becker13996922020-05-28 16:15:19 +0100605 size_t padding =
606 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200607 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100608 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100609 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100610 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100611 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100612 * Note that this changes `rec->data_len`, and hence
613 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100614 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100615 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616 &rec->data_len,
617 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100618 rec->type,
619 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100620 {
621 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
622 }
623
624 rec->type = MBEDTLS_SSL_MSG_CID;
625 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100626#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100627
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100628 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
629
Paul Bakker5121ce52009-01-03 21:22:43 +0000630 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100631 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000632 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000633#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634 if( mode == MBEDTLS_MODE_STREAM ||
635 ( mode == MBEDTLS_MODE_CBC
636#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000637 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100638#endif
639 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000640 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000641 if( post_avail < transform->maclen )
642 {
643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
644 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
645 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200646#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200647 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000648
TRodziewicz345165c2021-07-06 13:42:11 +0200649 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
650 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000651
TRodziewicz345165c2021-07-06 13:42:11 +0200652 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
653 add_data_len );
654 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
655 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
656 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657
TRodziewicz345165c2021-07-06 13:42:11 +0200658 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200659#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200660
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
662 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200663
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 rec->data_len += transform->maclen;
665 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100666 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200667 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000668#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000669
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200670 /*
671 * Encrypt
672 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000673#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000675 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000677 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000678 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000679 "including %d bytes of padding",
680 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
683 transform->iv_enc, transform->ivlen,
684 data, rec->data_len,
685 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200688 return( ret );
689 }
690
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000691 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
694 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200695 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000696 }
Paul Bakker68884e32013-01-07 18:20:04 +0100697 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000698#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000699
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200700#if defined(MBEDTLS_GCM_C) || \
701 defined(MBEDTLS_CCM_C) || \
702 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200704 mode == MBEDTLS_MODE_CCM ||
705 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000706 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200708 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100709 unsigned char *dynamic_iv;
710 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100711 int dynamic_iv_is_explicit =
712 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000713
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100714 /* Check that there's space for the authentication tag. */
715 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000716 {
717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
718 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
719 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000720
Paul Bakker68884e32013-01-07 18:20:04 +0100721 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100722 * Build nonce for AEAD encryption.
723 *
724 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
725 * part of the IV is prepended to the ciphertext and
726 * can be chosen freely - in particular, it need not
727 * agree with the record sequence number.
728 * However, since ChaChaPoly as well as all AEAD modes
729 * in TLS 1.3 use the record sequence number as the
730 * dynamic part of the nonce, we uniformly use the
731 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100732 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100733 dynamic_iv = rec->ctr;
734 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200735
Hanno Becker17263802020-05-28 07:05:48 +0100736 ssl_build_record_nonce( iv, sizeof( iv ),
737 transform->iv_enc,
738 transform->fixed_ivlen,
739 dynamic_iv,
740 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100741
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100742 /*
743 * Build additional data for AEAD encryption.
744 * This depends on the TLS version.
745 */
746 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
747 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100748
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200749 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100750 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200751 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100752 dynamic_iv,
753 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000754 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100755 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000756 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200757 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000758 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000759
Paul Bakker68884e32013-01-07 18:20:04 +0100760 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200761 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200762 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000763
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100764 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100766 add_data, add_data_len,
767 data, rec->data_len, /* src */
768 data, rec->buf_len - (data - rec->buf), /* dst */
769 &rec->data_len,
770 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200771 {
TRodziewicz18efb732021-04-29 23:12:19 +0200772 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200773 return( ret );
774 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000775 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100776 data + rec->data_len - transform->taglen,
777 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100778 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100780
781 /*
782 * Prefix record content with dynamic IV in case it is explicit.
783 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100784 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100785 {
786 if( rec->data_offset < dynamic_iv_len )
787 {
788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
789 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
790 }
791
792 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
793 rec->data_offset -= dynamic_iv_len;
794 rec->data_len += dynamic_iv_len;
795 }
796
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100797 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000798 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000799 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100800#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200801#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000803 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000804 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000805 size_t padlen, i;
806 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000807
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000808 /* Currently we're always using minimal padding
809 * (up to 255 bytes would be allowed). */
810 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
811 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000812 padlen = 0;
813
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000814 /* Check there's enough space in the buffer for the padding. */
815 if( post_avail < padlen + 1 )
816 {
817 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
818 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
819 }
820
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000822 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000823
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000824 rec->data_len += padlen + 1;
825 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000826
TRodziewicz0f82ec62021-05-12 17:49:18 +0200827#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000828 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200829 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000830 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000831 */
TRodziewicz345165c2021-07-06 13:42:11 +0200832 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000833 {
TRodziewicz345165c2021-07-06 13:42:11 +0200834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000836 }
TRodziewicz345165c2021-07-06 13:42:11 +0200837
838 if( rec->data_offset < transform->ivlen )
839 {
840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
841 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
842 }
843
844 /*
845 * Generate IV
846 */
847 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
848 if( ret != 0 )
849 return( ret );
850
851 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200852#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000853
Paul Elliottd48d5c62021-01-07 14:47:05 +0000854 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
855 "including %" MBEDTLS_PRINTF_SIZET
856 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000857 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200858 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000859
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000860 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
861 transform->iv_enc,
862 transform->ivlen,
863 data, rec->data_len,
864 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200867 return( ret );
868 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200869
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000870 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
873 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200874 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200875
TRodziewicz0f82ec62021-05-12 17:49:18 +0200876 data -= transform->ivlen;
877 rec->data_offset -= transform->ivlen;
878 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100881 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100882 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000883 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
884
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100885 /*
886 * MAC(MAC_write_key, seq_num +
887 * TLSCipherText.type +
888 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100889 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200890 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100891 * ENC(content + padding + padding_length));
892 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893
894 if( post_avail < transform->maclen)
895 {
896 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
897 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
898 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100899
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100900 ssl_extract_add_data_from_record( add_data, &add_data_len,
901 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000904 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100905 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100906
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000907 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100908 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 mbedtls_md_hmac_update( &transform->md_ctx_enc,
910 data, rec->data_len );
911 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
912 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100913
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000914 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100915
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916 rec->data_len += transform->maclen;
917 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100918 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100919 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000921 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200922 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200923#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200924 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
926 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200927 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000928
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100929 /* Make extra sure authentication was performed, exactly once */
930 if( auth_done != 1 )
931 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
933 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100934 }
935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000937
938 return( 0 );
939}
940
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200941#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200942/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200943 * Turn a bit into a mask:
944 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
945 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200946 *
947 * This function can be used to write constant-time code by replacing branches
948 * with bit operations using masks.
949 *
950 * This function is implemented without using comparison operators, as those
951 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200952 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200953static size_t mbedtls_cf_size_mask( size_t bit )
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200954{
955 /* MSVC has a warning about unary minus on unsigned integer types,
956 * but this is well-defined and precisely what we want to do here. */
957#if defined(_MSC_VER)
958#pragma warning( push )
959#pragma warning( disable : 4146 )
960#endif
961 return -bit;
962#if defined(_MSC_VER)
963#pragma warning( pop )
964#endif
965}
966
967/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200968 * Constant-flow mask generation for "less than" comparison:
969 * - if x < y, return all bits 1, that is (size_t) -1
970 * - otherwise, return all bits 0, that is 0
971 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200972 * This function can be used to write constant-time code by replacing branches
973 * with bit operations using masks.
974 *
975 * This function is implemented without using comparison operators, as those
976 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200977 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200978static size_t mbedtls_cf_size_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200979{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200980 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200981 const size_t sub = x - y;
982
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200983 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200984 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
985
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200986 /* mask = (x < y) ? 0xff... : 0x00... */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200987 const size_t mask = mbedtls_cf_size_mask( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200988
989 return( mask );
990}
991
992/*
993 * Constant-flow mask generation for "greater or equal" comparison:
994 * - if x >= y, return all bits 1, that is (size_t) -1
995 * - otherwise, return all bits 0, that is 0
996 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200997 * This function can be used to write constant-time code by replacing branches
998 * with bit operations using masks.
999 *
1000 * This function is implemented without using comparison operators, as those
1001 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001002 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001003static size_t mbedtls_cf_size_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001004{
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001005 return( ~mbedtls_cf_size_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001006}
1007
1008/*
1009 * Constant-flow boolean "equal" comparison:
1010 * return x == y
1011 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001012 * This function can be used to write constant-time code by replacing branches
1013 * with bit operations - it can be used in conjunction with
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001014 * mbedtls_cf_size_mask().
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001015 *
1016 * This function is implemented without using comparison operators, as those
1017 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001018 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001019static size_t mbedtls_cf_size_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001020{
1021 /* diff = 0 if x == y, non-zero otherwise */
1022 const size_t diff = x ^ y;
1023
1024 /* MSVC has a warning about unary minus on unsigned integer types,
1025 * but this is well-defined and precisely what we want to do here. */
1026#if defined(_MSC_VER)
1027#pragma warning( push )
1028#pragma warning( disable : 4146 )
1029#endif
1030
1031 /* diff_msb's most significant bit is equal to x != y */
1032 const size_t diff_msb = ( diff | -diff );
1033
1034#if defined(_MSC_VER)
1035#pragma warning( pop )
1036#endif
1037
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001038 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001039 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1040
1041 return( 1 ^ diff1 );
1042}
1043
1044/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001045 * Constant-flow conditional memcpy:
1046 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1047 * - otherwise, a no-op,
1048 * but with execution flow independent of the values of c1 and c2.
1049 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001050 * This function is implemented without using comparison operators, as those
1051 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001052 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001053static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
1054 const unsigned char *src,
1055 size_t len,
1056 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001057{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001058 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001059 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
1060 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001061
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001062 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001063 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001064 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001065}
1066
1067/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001068 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001069 *
1070 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1071 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001072 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001073MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001074 mbedtls_md_context_t *ctx,
1075 const unsigned char *add_data, size_t add_data_len,
1076 const unsigned char *data, size_t data_len_secret,
1077 size_t min_data_len, size_t max_data_len,
1078 unsigned char *output )
1079{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001080 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001081 * This function breaks the HMAC abstraction and uses the md_clone()
1082 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001083 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001084 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001085 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001086 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001087 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001088 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1089 * minlen, then cloning the context, and for each byte up to maxlen
1090 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001091 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001092 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001093 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001094 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +02001095 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001096 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001097 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001098 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001099 const unsigned char * const okey = ikey + block_size;
1100 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001101
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001102 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1103 mbedtls_md_context_t aux;
1104 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001105 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001106
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001107 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001108
1109#define MD_CHK( func_call ) \
1110 do { \
1111 ret = (func_call); \
1112 if( ret != 0 ) \
1113 goto cleanup; \
1114 } while( 0 )
1115
1116 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117
1118 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1119 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001120 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1121 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001122
1123 /* For each possible length, compute the hash up to that point */
1124 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001125 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001126 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1127 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001128 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001129 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1130 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001131
1132 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001133 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001134 }
1135
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001136 /* The context needs to finish() before it starts() again */
1137 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1138
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001139 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001140 MD_CHK( mbedtls_md_starts( ctx ) );
1141 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1142 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1143 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001144
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001145 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001146 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001147
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001148#undef MD_CHK
1149
1150cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001151 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001152 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001153}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001154
1155/*
1156 * Constant-flow memcpy from variable position in buffer.
1157 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001158 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001159 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001160MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001161 unsigned char *dst,
1162 const unsigned char *src_base,
1163 size_t offset_secret,
1164 size_t offset_min, size_t offset_max,
1165 size_t len )
1166{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001167 size_t offset;
1168
1169 for( offset = offset_min; offset <= offset_max; offset++ )
1170 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001171 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1172 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001173 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001174}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001175#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001176
Hanno Becker605949f2019-07-12 08:23:59 +01001177int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001178 mbedtls_ssl_transform *transform,
1179 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001180{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001181 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001183 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001184#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001185 size_t padlen = 0, correct = 1;
1186#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001187 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001188 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001189 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001190
Hanno Beckera18d1322018-01-03 14:27:32 +00001191#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001192 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001193 ((void) ssl);
1194#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001197 if( rec == NULL ||
1198 rec->buf == NULL ||
1199 rec->buf_len < rec->data_offset ||
1200 rec->buf_len - rec->data_offset < rec->data_len )
1201 {
1202 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001204 }
1205
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001206 data = rec->buf + rec->data_offset;
1207 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001208
Hanno Beckera0e20d02019-05-15 14:03:01 +01001209#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001210 /*
1211 * Match record's CID with incoming CID.
1212 */
Hanno Becker938489a2019-05-08 13:02:22 +01001213 if( rec->cid_len != transform->in_cid_len ||
1214 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1215 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001216 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001217 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001218#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001219
Hanno Beckerd086bf02021-03-22 13:01:27 +00001220#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001222 {
1223 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001224 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1225 transform->iv_dec,
1226 transform->ivlen,
1227 data, rec->data_len,
1228 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001229 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001231 return( ret );
1232 }
1233
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001234 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001235 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001236 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1237 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001238 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001239 }
Paul Bakker68884e32013-01-07 18:20:04 +01001240 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001241#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001242#if defined(MBEDTLS_GCM_C) || \
1243 defined(MBEDTLS_CCM_C) || \
1244 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001246 mode == MBEDTLS_MODE_CCM ||
1247 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001248 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001249 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001250 unsigned char *dynamic_iv;
1251 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001252
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001253 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001254 * Extract dynamic part of nonce for AEAD decryption.
1255 *
1256 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1257 * part of the IV is prepended to the ciphertext and
1258 * can be chosen freely - in particular, it need not
1259 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001260 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001261 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001262 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001263 {
1264 if( rec->data_len < dynamic_iv_len )
1265 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001266 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1267 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001268 rec->data_len,
1269 dynamic_iv_len ) );
1270 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1271 }
1272 dynamic_iv = data;
1273
1274 data += dynamic_iv_len;
1275 rec->data_offset += dynamic_iv_len;
1276 rec->data_len -= dynamic_iv_len;
1277 }
Hanno Becker17263802020-05-28 07:05:48 +01001278 else
1279 {
1280 dynamic_iv = rec->ctr;
1281 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001282
1283 /* Check that there's space for the authentication tag. */
1284 if( rec->data_len < transform->taglen )
1285 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1287 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001288 rec->data_len,
1289 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001291 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001292 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001293
Hanno Beckerdf8be222020-05-21 15:30:57 +01001294 /*
1295 * Prepare nonce from dynamic and static parts.
1296 */
Hanno Becker17263802020-05-28 07:05:48 +01001297 ssl_build_record_nonce( iv, sizeof( iv ),
1298 transform->iv_dec,
1299 transform->fixed_ivlen,
1300 dynamic_iv,
1301 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001302
Hanno Beckerdf8be222020-05-21 15:30:57 +01001303 /*
1304 * Build additional data for AEAD encryption.
1305 * This depends on the TLS version.
1306 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001307 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1308 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001309 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001310 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001311
Hanno Beckerd96a6522019-07-10 13:55:25 +01001312 /* Because of the check above, we know that there are
1313 * explicit_iv_len Bytes preceeding data, and taglen
1314 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001315 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001316 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001317
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001318 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001319 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001320 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001321
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001322 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001323 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001324 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001325 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001326 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001327 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001328 data, rec->data_len + transform->taglen, /* src */
1329 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001330 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001331 {
TRodziewicz18efb732021-04-29 23:12:19 +02001332 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1335 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001336
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001337 return( ret );
1338 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001339 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001340
Hanno Beckerd96a6522019-07-10 13:55:25 +01001341 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001342 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001343 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1345 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001346 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001347 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001348 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001350#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001352 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001353 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001354
Paul Bakker5121ce52009-01-03 21:22:43 +00001355 /*
Paul Bakker45829992013-01-03 14:52:21 +01001356 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001357 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001358#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001359 /* The ciphertext is prefixed with the CBC IV. */
1360 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001361#endif
Paul Bakker45829992013-01-03 14:52:21 +01001362
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001363 /* Size considerations:
1364 *
1365 * - The CBC cipher text must not be empty and hence
1366 * at least of size transform->ivlen.
1367 *
1368 * Together with the potential IV-prefix, this explains
1369 * the first of the two checks below.
1370 *
1371 * - The record must contain a MAC, either in plain or
1372 * encrypted, depending on whether Encrypt-then-MAC
1373 * is used or not.
1374 * - If it is, the message contains the IV-prefix,
1375 * the CBC ciphertext, and the MAC.
1376 * - If it is not, the padded plaintext, and hence
1377 * the CBC ciphertext, has at least length maclen + 1
1378 * because there is at least the padding length byte.
1379 *
1380 * As the CBC ciphertext is not empty, both cases give the
1381 * lower bound minlen + maclen + 1 on the record size, which
1382 * we test for in the second check below.
1383 */
1384 if( rec->data_len < minlen + transform->ivlen ||
1385 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001386 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001387 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1388 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1389 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001390 "+ 1 ) ( + expl IV )", rec->data_len,
1391 transform->ivlen,
1392 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001393 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001394 }
1395
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001396 /*
1397 * Authenticate before decrypt if enabled
1398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001399#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001400 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001401 {
Hanno Becker992b6872017-11-09 18:57:39 +00001402 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001404 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001405
Hanno Beckerd96a6522019-07-10 13:55:25 +01001406 /* Update data_len in tandem with add_data.
1407 *
1408 * The subtraction is safe because of the previous check
1409 * data_len >= minlen + maclen + 1.
1410 *
1411 * Afterwards, we know that data + data_len is followed by at
1412 * least maclen Bytes, which justifies the call to
1413 * mbedtls_ssl_safer_memcmp() below.
1414 *
1415 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001416 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001417 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1418 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001419
Hanno Beckerd96a6522019-07-10 13:55:25 +01001420 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001421 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1422 add_data_len );
1423 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1424 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001425 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1426 data, rec->data_len );
1427 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1428 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001429
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001430 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1431 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001432 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001433 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001434
Hanno Beckerd96a6522019-07-10 13:55:25 +01001435 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001436 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1437 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001438 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001440 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001441 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001442 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001443 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001445
1446 /*
1447 * Check length sanity
1448 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001449
1450 /* We know from above that data_len > minlen >= 0,
1451 * so the following check in particular implies that
1452 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001453 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001454 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001455 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1456 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001457 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001459 }
1460
TRodziewicz0f82ec62021-05-12 17:49:18 +02001461#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001462 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001463 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001464 */
TRodziewicz345165c2021-07-06 13:42:11 +02001465 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1466 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001467
TRodziewicz345165c2021-07-06 13:42:11 +02001468 data += transform->ivlen;
1469 rec->data_offset += transform->ivlen;
1470 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001472
Hanno Beckerd96a6522019-07-10 13:55:25 +01001473 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1474
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001475 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1476 transform->iv_dec, transform->ivlen,
1477 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001478 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001480 return( ret );
1481 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001482
Hanno Beckerd96a6522019-07-10 13:55:25 +01001483 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001485 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1487 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001488 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001489
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001490 /* Safe since data_len >= minlen + maclen + 1, so after having
1491 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001492 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1493 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001495
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001496 if( auth_done == 1 )
1497 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001498 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001499 rec->data_len,
1500 padlen + 1 );
1501 correct &= mask;
1502 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001503 }
1504 else
Paul Bakker45829992013-01-03 14:52:21 +01001505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001507 if( rec->data_len < transform->maclen + padlen + 1 )
1508 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001509 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1510 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1511 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001512 rec->data_len,
1513 transform->maclen,
1514 padlen + 1 ) );
1515 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001516#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001517
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001518 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001519 rec->data_len,
1520 transform->maclen + padlen + 1 );
1521 correct &= mask;
1522 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001523 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001524
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001525 padlen++;
1526
1527 /* Regardless of the validity of the padding,
1528 * we have data_len >= padlen here. */
1529
TRodziewicz0f82ec62021-05-12 17:49:18 +02001530#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001531 /* The padding check involves a series of up to 256
1532 * consecutive memory reads at the end of the record
1533 * plaintext buffer. In order to hide the length and
1534 * validity of the padding, always perform exactly
1535 * `min(256,plaintext_len)` reads (but take into account
1536 * only the last `padlen` bytes for the padding check). */
1537 size_t pad_count = 0;
1538 volatile unsigned char* const check = data;
1539
1540 /* Index of first padding byte; it has been ensured above
1541 * that the subtraction is safe. */
1542 size_t const padding_idx = rec->data_len - padlen;
1543 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1544 size_t const start_idx = rec->data_len - num_checks;
1545 size_t idx;
1546
1547 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001548 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001549 /* pad_count += (idx >= padding_idx) &&
1550 * (check[idx] == padlen - 1);
1551 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001552 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1553 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1554 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001555 pad_count += mask & equal;
1556 }
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001557 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001560 if( padlen > 0 && correct == 0 )
1561 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001562#endif
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001563 padlen &= mbedtls_cf_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001564
TRodziewicz0f82ec62021-05-12 17:49:18 +02001565#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001566
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001567 /* If the padding was found to be invalid, padlen == 0
1568 * and the subtraction is safe. If the padding was found valid,
1569 * padlen hasn't been changed and the previous assertion
1570 * data_len >= padlen still holds. */
1571 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001572 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001573 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001574#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001575 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1577 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001578 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001579
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001580#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001582 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001583#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001584
1585 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001586 * Authenticate if not done yet.
1587 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001588 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001589#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001590 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001591 {
Hanno Becker992b6872017-11-09 18:57:39 +00001592 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001593 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001594
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001595 /* If the initial value of padlen was such that
1596 * data_len < maclen + padlen + 1, then padlen
1597 * got reset to 1, and the initial check
1598 * data_len >= minlen + maclen + 1
1599 * guarantees that at this point we still
1600 * have at least data_len >= maclen.
1601 *
1602 * If the initial value of padlen was such that
1603 * data_len >= maclen + padlen + 1, then we have
1604 * subtracted either padlen + 1 (if the padding was correct)
1605 * or 0 (if the padding was incorrect) since then,
1606 * hence data_len >= maclen in any case.
1607 */
1608 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001609 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1610 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001611
TRodziewicz0f82ec62021-05-12 17:49:18 +02001612#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001613 /*
1614 * The next two sizes are the minimum and maximum values of
1615 * data_len over all padlen values.
1616 *
1617 * They're independent of padlen, since we previously did
1618 * data_len -= padlen.
1619 *
1620 * Note that max_len + maclen is never more than the buffer
1621 * length, as we previously did in_msglen -= maclen too.
1622 */
1623 const size_t max_len = rec->data_len + padlen;
1624 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1625
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001626 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1627 add_data, add_data_len,
1628 data, rec->data_len, min_len, max_len,
1629 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001630 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001631 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001632 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cf_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001633 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001634 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001635
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001636 mbedtls_cf_memcpy_offset( mac_peer, data,
1637 rec->data_len,
1638 min_len, max_len,
1639 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001640#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001641
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001642#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001643 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001644 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001645#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001646
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001647 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001648 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001649 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#if defined(MBEDTLS_SSL_DEBUG_ALL)
1651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001652#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001653 correct = 0;
1654 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001655 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001656 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001657
1658 /*
1659 * Finally check the correct flag
1660 */
1661 if( correct == 0 )
1662 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001663#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001664
1665 /* Make extra sure authentication was performed, exactly once */
1666 if( auth_done != 1 )
1667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1669 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001670 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001671
Hanno Beckerccc13d02020-05-04 12:30:04 +01001672#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1673 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1674 {
1675 /* Remove inner padding and infer true content type. */
1676 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1677 &rec->type );
1678
1679 if( ret != 0 )
1680 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1681 }
1682#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1683
Hanno Beckera0e20d02019-05-15 14:03:01 +01001684#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001685 if( rec->cid_len != 0 )
1686 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001687 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1688 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001689 if( ret != 0 )
1690 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1691 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001692#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001695
1696 return( 0 );
1697}
1698
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001699#undef MAC_NONE
1700#undef MAC_PLAINTEXT
1701#undef MAC_CIPHERTEXT
1702
Paul Bakker5121ce52009-01-03 21:22:43 +00001703/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001704 * Fill the input message buffer by appending data to it.
1705 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001706 *
1707 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1708 * available (from this read and/or a previous one). Otherwise, an error code
1709 * is returned (possibly EOF or WANT_READ).
1710 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001711 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1712 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1713 * since we always read a whole datagram at once.
1714 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001715 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001716 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001719{
Janos Follath865b3eb2019-12-16 11:46:15 +00001720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001721 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001722#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1723 size_t in_buf_len = ssl->in_buf_len;
1724#else
1725 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1726#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001729
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001730 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1731 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001733 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001735 }
1736
Darryl Greenb33cc762019-11-28 14:29:44 +00001737 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001738 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1740 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001741 }
1742
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001744 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001745 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001746 uint32_t timeout;
1747
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001748 /*
1749 * The point is, we need to always read a full datagram at once, so we
1750 * sometimes read more then requested, and handle the additional data.
1751 * It could be the rest of the current record (while fetching the
1752 * header) and/or some other records in the same datagram.
1753 */
1754
1755 /*
1756 * Move to the next record in the already read datagram if applicable
1757 */
1758 if( ssl->next_record_offset != 0 )
1759 {
1760 if( ssl->in_left < ssl->next_record_offset )
1761 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1763 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001764 }
1765
1766 ssl->in_left -= ssl->next_record_offset;
1767
1768 if( ssl->in_left != 0 )
1769 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001770 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1771 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001772 ssl->next_record_offset ) );
1773 memmove( ssl->in_hdr,
1774 ssl->in_hdr + ssl->next_record_offset,
1775 ssl->in_left );
1776 }
1777
1778 ssl->next_record_offset = 0;
1779 }
1780
Paul Elliottd48d5c62021-01-07 14:47:05 +00001781 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1782 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001783 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001784
1785 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001786 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001787 */
1788 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001789 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001791 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001792 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001793
1794 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001795 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001796 * are not at the beginning of a new record, the caller did something
1797 * wrong.
1798 */
1799 if( ssl->in_left != 0 )
1800 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1802 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001803 }
1804
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001805 /*
1806 * Don't even try to read if time's out already.
1807 * This avoids by-passing the timer when repeatedly receiving messages
1808 * that will end up being dropped.
1809 */
Hanno Becker7876d122020-02-05 10:39:31 +00001810 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001811 {
1812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001813 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001814 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001815 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001816 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001817 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001820 timeout = ssl->handshake->retransmit_timeout;
1821 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001822 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001823
Paul Elliott9f352112020-12-09 14:55:45 +00001824 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001825
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001826 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001827 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1828 timeout );
1829 else
1830 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1831
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001833
1834 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001836 }
1837
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001838 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001839 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001841 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001843 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001844 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001845 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1846 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001848 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001849 }
1850
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001852 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001854 return( ret );
1855 }
1856
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001857 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001858 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001859#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001860 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001862 {
Hanno Becker786300f2020-02-05 10:46:40 +00001863 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001864 {
Hanno Becker786300f2020-02-05 10:46:40 +00001865 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1866 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001867 return( ret );
1868 }
1869
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001870 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001871 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001873 }
1874
Paul Bakker5121ce52009-01-03 21:22:43 +00001875 if( ret < 0 )
1876 return( ret );
1877
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001878 ssl->in_left = ret;
1879 }
1880 else
1881#endif
1882 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1884 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001885 ssl->in_left, nb_want ) );
1886
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001887 while( ssl->in_left < nb_want )
1888 {
1889 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001890
Hanno Becker7876d122020-02-05 10:39:31 +00001891 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001892 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1893 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001894 {
1895 if( ssl->f_recv_timeout != NULL )
1896 {
1897 ret = ssl->f_recv_timeout( ssl->p_bio,
1898 ssl->in_hdr + ssl->in_left, len,
1899 ssl->conf->read_timeout );
1900 }
1901 else
1902 {
1903 ret = ssl->f_recv( ssl->p_bio,
1904 ssl->in_hdr + ssl->in_left, len );
1905 }
1906 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001907
Paul Elliottd48d5c62021-01-07 14:47:05 +00001908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1909 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001910 ssl->in_left, nb_want ) );
1911 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001912
1913 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001915
1916 if( ret < 0 )
1917 return( ret );
1918
makise-homuraaf9513b2020-08-24 18:26:27 +03001919 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001920 {
Darryl Green11999bb2018-03-13 15:22:58 +00001921 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001922 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001923 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001924 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1925 }
1926
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001927 ssl->in_left += ret;
1928 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001929 }
1930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001932
1933 return( 0 );
1934}
1935
1936/*
1937 * Flush any data not yet written
1938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001940{
Janos Follath865b3eb2019-12-16 11:46:15 +00001941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001942 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001945
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001946 if( ssl->f_send == NULL )
1947 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001949 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001951 }
1952
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001953 /* Avoid incrementing counter if data is flushed */
1954 if( ssl->out_left == 0 )
1955 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001957 return( 0 );
1958 }
1959
Paul Bakker5121ce52009-01-03 21:22:43 +00001960 while( ssl->out_left > 0 )
1961 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1963 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001964 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001965
Hanno Becker2b1e3542018-08-06 11:19:13 +01001966 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001967 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001970
1971 if( ret <= 0 )
1972 return( ret );
1973
makise-homuraaf9513b2020-08-24 18:26:27 +03001974 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001975 {
Darryl Green11999bb2018-03-13 15:22:58 +00001976 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001977 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001978 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001979 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1980 }
1981
Paul Bakker5121ce52009-01-03 21:22:43 +00001982 ssl->out_left -= ret;
1983 }
1984
Hanno Becker2b1e3542018-08-06 11:19:13 +01001985#if defined(MBEDTLS_SSL_PROTO_DTLS)
1986 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001987 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001988 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001989 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001990 else
1991#endif
1992 {
1993 ssl->out_hdr = ssl->out_buf + 8;
1994 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001995 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001998
1999 return( 0 );
2000}
2001
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002002/*
2003 * Functions to handle the DTLS retransmission state machine
2004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002006/*
2007 * Append current handshake message to current outgoing flight
2008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002010{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002012 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2013 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2014 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002015
2016 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002017 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002018 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002019 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002021 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002022 }
2023
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002024 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002025 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002026 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2027 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002028 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002029 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002030 }
2031
2032 /* Copy current handshake message with headers */
2033 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2034 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002035 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036 msg->next = NULL;
2037
2038 /* Append to the current flight */
2039 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002040 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002041 else
2042 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002044 while( cur->next != NULL )
2045 cur = cur->next;
2046 cur->next = msg;
2047 }
2048
Hanno Becker3b235902018-08-06 09:54:53 +01002049 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002050 return( 0 );
2051}
2052
2053/*
2054 * Free the current flight of handshake messages
2055 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002056void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002057{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 mbedtls_ssl_flight_item *cur = flight;
2059 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002060
2061 while( cur != NULL )
2062 {
2063 next = cur->next;
2064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065 mbedtls_free( cur->p );
2066 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002067
2068 cur = next;
2069 }
2070}
2071
2072/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002073 * Swap transform_out and out_ctr with the alternative ones
2074 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002075static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002076{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002078 unsigned char tmp_out_ctr[8];
2079
2080 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2081 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002083 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002084 }
2085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002087
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002088 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002089 tmp_transform = ssl->transform_out;
2090 ssl->transform_out = ssl->handshake->alt_transform_out;
2091 ssl->handshake->alt_transform_out = tmp_transform;
2092
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002093 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002094 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2095 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002096 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002097
2098 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002099 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002100
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002101 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002102}
2103
2104/*
2105 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002106 */
2107int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2108{
2109 int ret = 0;
2110
2111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2112
2113 ret = mbedtls_ssl_flight_transmit( ssl );
2114
2115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2116
2117 return( ret );
2118}
2119
2120/*
2121 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002122 *
2123 * Need to remember the current message in case flush_output returns
2124 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002125 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002126 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002127int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002128{
Janos Follath865b3eb2019-12-16 11:46:15 +00002129 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002130 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002133 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002135
2136 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002137 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002138 ret = ssl_swap_epochs( ssl );
2139 if( ret != 0 )
2140 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002143 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002144
2145 while( ssl->handshake->cur_msg != NULL )
2146 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002147 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002148 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002149
Hanno Beckere1dcb032018-08-17 16:47:58 +01002150 int const is_finished =
2151 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2152 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2153
Hanno Becker04da1892018-08-14 13:22:10 +01002154 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2155 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2156
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002157 /* Swap epochs before sending Finished: we can't do it after
2158 * sending ChangeCipherSpec, in case write returns WANT_READ.
2159 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002160 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002161 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002163 ret = ssl_swap_epochs( ssl );
2164 if( ret != 0 )
2165 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002166 }
2167
Hanno Becker67bc7c32018-08-06 11:33:50 +01002168 ret = ssl_get_remaining_payload_in_datagram( ssl );
2169 if( ret < 0 )
2170 return( ret );
2171 max_frag_len = (size_t) ret;
2172
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002173 /* CCS is copied as is, while HS messages may need fragmentation */
2174 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2175 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002176 if( max_frag_len == 0 )
2177 {
2178 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2179 return( ret );
2180
2181 continue;
2182 }
2183
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002184 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002185 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002186 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002187
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002188 /* Update position inside current message */
2189 ssl->handshake->cur_msg_p += cur->len;
2190 }
2191 else
2192 {
2193 const unsigned char * const p = ssl->handshake->cur_msg_p;
2194 const size_t hs_len = cur->len - 12;
2195 const size_t frag_off = p - ( cur->p + 12 );
2196 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002197 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002198
Hanno Beckere1dcb032018-08-17 16:47:58 +01002199 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002200 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002201 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002202 {
2203 ret = ssl_swap_epochs( ssl );
2204 if( ret != 0 )
2205 return( ret );
2206 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002207
Hanno Becker67bc7c32018-08-06 11:33:50 +01002208 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2209 return( ret );
2210
2211 continue;
2212 }
2213 max_hs_frag_len = max_frag_len - 12;
2214
2215 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2216 max_hs_frag_len : rem_len;
2217
2218 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002219 {
2220 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002221 (unsigned) cur_hs_frag_len,
2222 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002223 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002224
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002225 /* Messages are stored with handshake headers as if not fragmented,
2226 * copy beginning of headers then fill fragmentation fields.
2227 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2228 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002229
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002230 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2231 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2232 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2233
Hanno Becker67bc7c32018-08-06 11:33:50 +01002234 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2235 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2236 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002237
2238 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2239
Hanno Becker3f7b9732018-08-28 09:53:25 +01002240 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002241 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2242 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002243 ssl->out_msgtype = cur->type;
2244
2245 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002246 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002247 }
2248
2249 /* If done with the current message move to the next one if any */
2250 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2251 {
2252 if( cur->next != NULL )
2253 {
2254 ssl->handshake->cur_msg = cur->next;
2255 ssl->handshake->cur_msg_p = cur->next->p + 12;
2256 }
2257 else
2258 {
2259 ssl->handshake->cur_msg = NULL;
2260 ssl->handshake->cur_msg_p = NULL;
2261 }
2262 }
2263
2264 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002265 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002268 return( ret );
2269 }
2270 }
2271
Hanno Becker67bc7c32018-08-06 11:33:50 +01002272 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2273 return( ret );
2274
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002275 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2277 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002278 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002279 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002281 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002282 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002283
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002284 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002285
2286 return( 0 );
2287}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002288
2289/*
2290 * To be called when the last message of an incoming flight is received.
2291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002293{
2294 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002295 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002296 ssl->handshake->flight = NULL;
2297 ssl->handshake->cur_msg = NULL;
2298
2299 /* The next incoming flight will start with this msg_seq */
2300 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2301
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002302 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002303 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002304
Hanno Becker0271f962018-08-16 13:23:47 +01002305 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002306 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002307
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002308 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002309 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2312 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002313 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002315 }
2316 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002318}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002319
2320/*
2321 * To be called when the last message of an outgoing flight is send.
2322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002324{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002325 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002326 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002328 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2329 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002330 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002331 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002332 }
2333 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002335}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002337
Paul Bakker5121ce52009-01-03 21:22:43 +00002338/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002339 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002340 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002341
2342/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002343 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002344 *
2345 * - fill in handshake headers
2346 * - update handshake checksum
2347 * - DTLS: save message for resending
2348 * - then pass to the record layer
2349 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002350 * DTLS: except for HelloRequest, messages are only queued, and will only be
2351 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002352 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002353 * Inputs:
2354 * - ssl->out_msglen: 4 + actual handshake message len
2355 * (4 is the size of handshake headers for TLS)
2356 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2357 * - ssl->out_msg + 4: the handshake message body
2358 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002359 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002360 * - ssl->out_msglen: the length of the record contents
2361 * (including handshake headers but excluding record headers)
2362 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002363 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002364int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002365{
Janos Follath865b3eb2019-12-16 11:46:15 +00002366 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002367 const size_t hs_len = ssl->out_msglen - 4;
2368 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002369
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002370 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2371
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002372 /*
2373 * Sanity checks
2374 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002375 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002376 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2377 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002378 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2379 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002380 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002381
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002382 /* Whenever we send anything different from a
2383 * HelloRequest we should be in a handshake - double check. */
2384 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2385 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002386 ssl->handshake == NULL )
2387 {
2388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2389 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2390 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002392#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002393 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002394 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002396 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002397 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2398 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002399 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002400#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002401
Hanno Beckerb50a2532018-08-06 11:52:54 +01002402 /* Double-check that we did not exceed the bounds
2403 * of the outgoing record buffer.
2404 * This should never fail as the various message
2405 * writing functions must obey the bounds of the
2406 * outgoing record buffer, but better be safe.
2407 *
2408 * Note: We deliberately do not check for the MTU or MFL here.
2409 */
2410 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2411 {
2412 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002413 "size %" MBEDTLS_PRINTF_SIZET
2414 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002415 ssl->out_msglen,
2416 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002417 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2418 }
2419
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002420 /*
2421 * Fill handshake headers
2422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002425 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2426 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2427 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002428
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002429 /*
2430 * DTLS has additional fields in the Handshake layer,
2431 * between the length field and the actual payload:
2432 * uint16 message_seq;
2433 * uint24 fragment_offset;
2434 * uint24 fragment_length;
2435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002437 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002438 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002439 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002440 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002441 {
2442 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002443 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002444 hs_len,
2445 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002446 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2447 }
2448
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002449 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002450 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002451
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002452 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002453 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002454 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002455 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2456 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2457 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002458 }
2459 else
2460 {
2461 ssl->out_msg[4] = 0;
2462 ssl->out_msg[5] = 0;
2463 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002464
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002465 /* Handshake hashes are computed without fragmentation,
2466 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002467 memset( ssl->out_msg + 6, 0x00, 3 );
2468 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002469 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002471
Hanno Becker0207e532018-08-28 10:28:28 +01002472 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002473 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2474 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002475 }
2476
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002477 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002479 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002480 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2481 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002482 {
2483 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2484 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002486 return( ret );
2487 }
2488 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002489 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002490#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002491 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002492 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002493 {
2494 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2495 return( ret );
2496 }
2497 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002498
2499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2500
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002501 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002502}
2503
2504/*
2505 * Record layer functions
2506 */
2507
2508/*
2509 * Write current record.
2510 *
2511 * Uses:
2512 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2513 * - ssl->out_msglen: length of the record content (excl headers)
2514 * - ssl->out_msg: record content
2515 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002516int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002517{
2518 int ret, done = 0;
2519 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002520 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002521
2522 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002523
Paul Bakker05ef8352012-05-08 09:17:57 +00002524 if( !done )
2525 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002526 unsigned i;
2527 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002528#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2529 size_t out_buf_len = ssl->out_buf_len;
2530#else
2531 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2532#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002533 /* Skip writing the record content type to after the encryption,
2534 * as it may change when using the CID extension. */
2535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002537 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002538
Hanno Becker19859472018-08-06 09:40:20 +01002539 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002540 ssl->out_len[0] = (unsigned char)( len >> 8 );
2541 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002542
Paul Bakker48916f92012-09-16 19:57:18 +00002543 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002544 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002545 mbedtls_record rec;
2546
2547 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002548 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002549 rec.data_len = ssl->out_msglen;
2550 rec.data_offset = ssl->out_msg - rec.buf;
2551
2552 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2553 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2554 ssl->conf->transport, rec.ver );
2555 rec.type = ssl->out_msgtype;
2556
Hanno Beckera0e20d02019-05-15 14:03:01 +01002557#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002558 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002559 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002560#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002561
Hanno Beckera18d1322018-01-03 14:27:32 +00002562 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002563 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002564 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002566 return( ret );
2567 }
2568
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002569 if( rec.data_offset != 0 )
2570 {
2571 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2572 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2573 }
2574
Hanno Becker6430faf2019-05-08 11:57:13 +01002575 /* Update the record content type and CID. */
2576 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002577#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002578 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002579#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002580 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002581 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2582 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002583 }
2584
Hanno Becker5903de42019-05-03 14:46:38 +01002585 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002586
2587#if defined(MBEDTLS_SSL_PROTO_DTLS)
2588 /* In case of DTLS, double-check that we don't exceed
2589 * the remaining space in the datagram. */
2590 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2591 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002592 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002593 if( ret < 0 )
2594 return( ret );
2595
2596 if( protected_record_size > (size_t) ret )
2597 {
2598 /* Should never happen */
2599 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2600 }
2601 }
2602#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002603
Hanno Becker6430faf2019-05-08 11:57:13 +01002604 /* Now write the potentially updated record content type. */
2605 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2606
Paul Elliott9f352112020-12-09 14:55:45 +00002607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002608 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002609 ssl->out_hdr[0], ssl->out_hdr[1],
2610 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002613 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002614
2615 ssl->out_left += protected_record_size;
2616 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002617 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002618
Hanno Beckerdd772292020-02-05 10:38:31 +00002619 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002620 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2621 break;
2622
2623 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002624 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002625 {
2626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2627 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2628 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002629 }
2630
Hanno Becker67bc7c32018-08-06 11:33:50 +01002631#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002632 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2633 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002634 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002635 size_t remaining;
2636 ret = ssl_get_remaining_payload_in_datagram( ssl );
2637 if( ret < 0 )
2638 {
2639 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2640 ret );
2641 return( ret );
2642 }
2643
2644 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002645 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002646 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002647 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002648 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002649 else
2650 {
Hanno Becker513815a2018-08-20 11:56:09 +01002651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002652 }
2653 }
2654#endif /* MBEDTLS_SSL_PROTO_DTLS */
2655
2656 if( ( flush == SSL_FORCE_FLUSH ) &&
2657 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002658 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002660 return( ret );
2661 }
2662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002664
2665 return( 0 );
2666}
2667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002669
2670static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2671{
2672 if( ssl->in_msglen < ssl->in_hslen ||
2673 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2674 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2675 {
2676 return( 1 );
2677 }
2678 return( 0 );
2679}
Hanno Becker44650b72018-08-16 12:51:11 +01002680
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002681static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002682{
2683 return( ( ssl->in_msg[9] << 16 ) |
2684 ( ssl->in_msg[10] << 8 ) |
2685 ssl->in_msg[11] );
2686}
2687
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002688static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002689{
2690 return( ( ssl->in_msg[6] << 16 ) |
2691 ( ssl->in_msg[7] << 8 ) |
2692 ssl->in_msg[8] );
2693}
2694
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002695static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002696{
2697 uint32_t msg_len, frag_off, frag_len;
2698
2699 msg_len = ssl_get_hs_total_len( ssl );
2700 frag_off = ssl_get_hs_frag_off( ssl );
2701 frag_len = ssl_get_hs_frag_len( ssl );
2702
2703 if( frag_off > msg_len )
2704 return( -1 );
2705
2706 if( frag_len > msg_len - frag_off )
2707 return( -1 );
2708
2709 if( frag_len + 12 > ssl->in_msglen )
2710 return( -1 );
2711
2712 return( 0 );
2713}
2714
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002715/*
2716 * Mark bits in bitmask (used for DTLS HS reassembly)
2717 */
2718static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2719{
2720 unsigned int start_bits, end_bits;
2721
2722 start_bits = 8 - ( offset % 8 );
2723 if( start_bits != 8 )
2724 {
2725 size_t first_byte_idx = offset / 8;
2726
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002727 /* Special case */
2728 if( len <= start_bits )
2729 {
2730 for( ; len != 0; len-- )
2731 mask[first_byte_idx] |= 1 << ( start_bits - len );
2732
2733 /* Avoid potential issues with offset or len becoming invalid */
2734 return;
2735 }
2736
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002737 offset += start_bits; /* Now offset % 8 == 0 */
2738 len -= start_bits;
2739
2740 for( ; start_bits != 0; start_bits-- )
2741 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2742 }
2743
2744 end_bits = len % 8;
2745 if( end_bits != 0 )
2746 {
2747 size_t last_byte_idx = ( offset + len ) / 8;
2748
2749 len -= end_bits; /* Now len % 8 == 0 */
2750
2751 for( ; end_bits != 0; end_bits-- )
2752 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2753 }
2754
2755 memset( mask + offset / 8, 0xFF, len / 8 );
2756}
2757
2758/*
2759 * Check that bitmask is full
2760 */
2761static int ssl_bitmask_check( unsigned char *mask, size_t len )
2762{
2763 size_t i;
2764
2765 for( i = 0; i < len / 8; i++ )
2766 if( mask[i] != 0xFF )
2767 return( -1 );
2768
2769 for( i = 0; i < len % 8; i++ )
2770 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2771 return( -1 );
2772
2773 return( 0 );
2774}
2775
Hanno Becker56e205e2018-08-16 09:06:12 +01002776/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002777static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002778 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002779{
Hanno Becker56e205e2018-08-16 09:06:12 +01002780 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002781
Hanno Becker56e205e2018-08-16 09:06:12 +01002782 alloc_len = 12; /* Handshake header */
2783 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002784
Hanno Beckerd07df862018-08-16 09:14:58 +01002785 if( add_bitmap )
2786 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002787
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002788 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002789}
Hanno Becker56e205e2018-08-16 09:06:12 +01002790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002792
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002793static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002794{
2795 return( ( ssl->in_msg[1] << 16 ) |
2796 ( ssl->in_msg[2] << 8 ) |
2797 ssl->in_msg[3] );
2798}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002799
Simon Butcher99000142016-10-13 17:21:01 +01002800int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002801{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002803 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002805 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002807 }
2808
Hanno Becker12555c62018-08-16 12:47:53 +01002809 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002812 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002813 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002816 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002817 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002818 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002819 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002820
Hanno Becker44650b72018-08-16 12:51:11 +01002821 if( ssl_check_hs_header( ssl ) != 0 )
2822 {
2823 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2824 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2825 }
2826
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002827 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002828 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2829 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2830 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2831 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002832 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002833 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2834 {
2835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2836 recv_msg_seq,
2837 ssl->handshake->in_msg_seq ) );
2838 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2839 }
2840
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002841 /* Retransmit only on last message from previous flight, to avoid
2842 * too many retransmissions.
2843 * Besides, No sane server ever retransmits HelloVerifyRequest */
2844 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002846 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002848 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002849 recv_msg_seq,
2850 ssl->handshake->in_flight_start_seq ) );
2851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002853 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002855 return( ret );
2856 }
2857 }
2858 else
2859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002861 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002862 recv_msg_seq,
2863 ssl->handshake->in_msg_seq ) );
2864 }
2865
Hanno Becker90333da2017-10-10 11:27:13 +01002866 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002867 }
2868 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002869
Hanno Becker6d97ef52018-08-16 13:09:04 +01002870 /* Message reassembly is handled alongside buffering of future
2871 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002872 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002873 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002874 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002875 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002877 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002878 }
2879 }
2880 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002882 /* With TLS we don't handle fragmentation (for now) */
2883 if( ssl->in_msglen < ssl->in_hslen )
2884 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2886 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002887 }
2888
Simon Butcher99000142016-10-13 17:21:01 +01002889 return( 0 );
2890}
2891
2892void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2893{
Hanno Becker0271f962018-08-16 13:23:47 +01002894 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002895
Hanno Becker0271f962018-08-16 13:23:47 +01002896 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002897 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002898 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002899 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002900
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002901 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002903 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002904 ssl->handshake != NULL )
2905 {
Hanno Becker0271f962018-08-16 13:23:47 +01002906 unsigned offset;
2907 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002908
Hanno Becker0271f962018-08-16 13:23:47 +01002909 /* Increment handshake sequence number */
2910 hs->in_msg_seq++;
2911
2912 /*
2913 * Clear up handshake buffering and reassembly structure.
2914 */
2915
2916 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002917 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002918
2919 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002920 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2921 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002922 offset++, hs_buf++ )
2923 {
2924 *hs_buf = *(hs_buf + 1);
2925 }
2926
2927 /* Create a fresh last entry */
2928 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002929 }
2930#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002931}
2932
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002933/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002934 * DTLS anti-replay: RFC 6347 4.1.2.6
2935 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002936 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2937 * Bit n is set iff record number in_window_top - n has been seen.
2938 *
2939 * Usually, in_window_top is the last record number seen and the lsb of
2940 * in_window is set. The only exception is the initial state (record number 0
2941 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002942 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002944void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002945{
2946 ssl->in_window_top = 0;
2947 ssl->in_window = 0;
2948}
2949
2950static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2951{
2952 return( ( (uint64_t) buf[0] << 40 ) |
2953 ( (uint64_t) buf[1] << 32 ) |
2954 ( (uint64_t) buf[2] << 24 ) |
2955 ( (uint64_t) buf[3] << 16 ) |
2956 ( (uint64_t) buf[4] << 8 ) |
2957 ( (uint64_t) buf[5] ) );
2958}
2959
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002960static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2961{
Janos Follath865b3eb2019-12-16 11:46:15 +00002962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002963 unsigned char *original_in_ctr;
2964
2965 // save original in_ctr
2966 original_in_ctr = ssl->in_ctr;
2967
2968 // use counter from record
2969 ssl->in_ctr = record_in_ctr;
2970
2971 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2972
2973 // restore the counter
2974 ssl->in_ctr = original_in_ctr;
2975
2976 return ret;
2977}
2978
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002979/*
2980 * Return 0 if sequence number is acceptable, -1 otherwise
2981 */
Hanno Becker0183d692019-07-12 08:50:37 +01002982int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002983{
2984 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2985 uint64_t bit;
2986
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002987 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002988 return( 0 );
2989
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002990 if( rec_seqnum > ssl->in_window_top )
2991 return( 0 );
2992
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002993 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002994
2995 if( bit >= 64 )
2996 return( -1 );
2997
2998 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2999 return( -1 );
3000
3001 return( 0 );
3002}
3003
3004/*
3005 * Update replay window on new validated record
3006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003008{
3009 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3010
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003011 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003012 return;
3013
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003014 if( rec_seqnum > ssl->in_window_top )
3015 {
3016 /* Update window_top and the contents of the window */
3017 uint64_t shift = rec_seqnum - ssl->in_window_top;
3018
3019 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003020 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003021 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003022 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003023 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003024 ssl->in_window |= 1;
3025 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003026
3027 ssl->in_window_top = rec_seqnum;
3028 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003029 else
3030 {
3031 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003032 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003033
3034 if( bit < 64 ) /* Always true, but be extra sure */
3035 ssl->in_window |= (uint64_t) 1 << bit;
3036 }
3037}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003039
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003040#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003041/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003042 * Without any SSL context, check if a datagram looks like a ClientHello with
3043 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003044 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003045 *
3046 * - if cookie is valid, return 0
3047 * - if ClientHello looks superficially valid but cookie is not,
3048 * fill obuf and set olen, then
3049 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3050 * - otherwise return a specific error code
3051 */
3052static int ssl_check_dtls_clihlo_cookie(
3053 mbedtls_ssl_cookie_write_t *f_cookie_write,
3054 mbedtls_ssl_cookie_check_t *f_cookie_check,
3055 void *p_cookie,
3056 const unsigned char *cli_id, size_t cli_id_len,
3057 const unsigned char *in, size_t in_len,
3058 unsigned char *obuf, size_t buf_len, size_t *olen )
3059{
3060 size_t sid_len, cookie_len;
3061 unsigned char *p;
3062
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003063 /*
3064 * Structure of ClientHello with record and handshake headers,
3065 * and expected values. We don't need to check a lot, more checks will be
3066 * done when actually parsing the ClientHello - skipping those checks
3067 * avoids code duplication and does not make cookie forging any easier.
3068 *
3069 * 0-0 ContentType type; copied, must be handshake
3070 * 1-2 ProtocolVersion version; copied
3071 * 3-4 uint16 epoch; copied, must be 0
3072 * 5-10 uint48 sequence_number; copied
3073 * 11-12 uint16 length; (ignored)
3074 *
3075 * 13-13 HandshakeType msg_type; (ignored)
3076 * 14-16 uint24 length; (ignored)
3077 * 17-18 uint16 message_seq; copied
3078 * 19-21 uint24 fragment_offset; copied, must be 0
3079 * 22-24 uint24 fragment_length; (ignored)
3080 *
3081 * 25-26 ProtocolVersion client_version; (ignored)
3082 * 27-58 Random random; (ignored)
3083 * 59-xx SessionID session_id; 1 byte len + sid_len content
3084 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3085 * ...
3086 *
3087 * Minimum length is 61 bytes.
3088 */
3089 if( in_len < 61 ||
3090 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3091 in[3] != 0 || in[4] != 0 ||
3092 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3093 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003094 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003095 }
3096
3097 sid_len = in[59];
3098 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003099 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003100
3101 cookie_len = in[60 + sid_len];
3102 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003103 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003104
3105 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3106 cli_id, cli_id_len ) == 0 )
3107 {
3108 /* Valid cookie */
3109 return( 0 );
3110 }
3111
3112 /*
3113 * If we get here, we've got an invalid cookie, let's prepare HVR.
3114 *
3115 * 0-0 ContentType type; copied
3116 * 1-2 ProtocolVersion version; copied
3117 * 3-4 uint16 epoch; copied
3118 * 5-10 uint48 sequence_number; copied
3119 * 11-12 uint16 length; olen - 13
3120 *
3121 * 13-13 HandshakeType msg_type; hello_verify_request
3122 * 14-16 uint24 length; olen - 25
3123 * 17-18 uint16 message_seq; copied
3124 * 19-21 uint24 fragment_offset; copied
3125 * 22-24 uint24 fragment_length; olen - 25
3126 *
3127 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3128 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3129 *
3130 * Minimum length is 28.
3131 */
3132 if( buf_len < 28 )
3133 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3134
3135 /* Copy most fields and adapt others */
3136 memcpy( obuf, in, 25 );
3137 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3138 obuf[25] = 0xfe;
3139 obuf[26] = 0xff;
3140
3141 /* Generate and write actual cookie */
3142 p = obuf + 28;
3143 if( f_cookie_write( p_cookie,
3144 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3145 {
3146 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3147 }
3148
3149 *olen = p - obuf;
3150
3151 /* Go back and fill length fields */
3152 obuf[27] = (unsigned char)( *olen - 28 );
3153
3154 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3155 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3156 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3157
3158 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3159 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3160
3161 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3162}
3163
3164/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003165 * Handle possible client reconnect with the same UDP quadruplet
3166 * (RFC 6347 Section 4.2.8).
3167 *
3168 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3169 * that looks like a ClientHello.
3170 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003171 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003172 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003173 * - if the input looks like a ClientHello with a valid cookie,
3174 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003175 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003176 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003177 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003178 * This function is called (through ssl_check_client_reconnect()) when an
3179 * unexpected record is found in ssl_get_next_record(), which will discard the
3180 * record if we return 0, and bubble up the return value otherwise (this
3181 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3182 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003183 */
3184static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3185{
Janos Follath865b3eb2019-12-16 11:46:15 +00003186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003187 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003188
Hanno Becker2fddd372019-07-10 14:37:41 +01003189 if( ssl->conf->f_cookie_write == NULL ||
3190 ssl->conf->f_cookie_check == NULL )
3191 {
3192 /* If we can't use cookies to verify reachability of the peer,
3193 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003194 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3195 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003196 return( 0 );
3197 }
3198
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003199 ret = ssl_check_dtls_clihlo_cookie(
3200 ssl->conf->f_cookie_write,
3201 ssl->conf->f_cookie_check,
3202 ssl->conf->p_cookie,
3203 ssl->cli_id, ssl->cli_id_len,
3204 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003205 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003206
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003207 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3208
3209 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003210 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003211 int send_ret;
3212 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3213 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3214 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003215 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003216 * If the error is permanent we'll catch it later,
3217 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003218 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3219 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3220 (void) send_ret;
3221
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003222 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003223 }
3224
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003225 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003226 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003227 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003228 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003229 {
3230 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3231 return( ret );
3232 }
3233
3234 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003235 }
3236
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003237 return( ret );
3238}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003239#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003240
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003241static int ssl_check_record_type( uint8_t record_type )
3242{
3243 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3244 record_type != MBEDTLS_SSL_MSG_ALERT &&
3245 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3246 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3247 {
3248 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3249 }
3250
3251 return( 0 );
3252}
3253
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003254/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003255 * ContentType type;
3256 * ProtocolVersion version;
3257 * uint16 epoch; // DTLS only
3258 * uint48 sequence_number; // DTLS only
3259 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003260 *
3261 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003262 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003263 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3264 *
3265 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003266 * 1. proceed with the record if this function returns 0
3267 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3268 * 3. return CLIENT_RECONNECT if this function return that value
3269 * 4. drop the whole datagram if this function returns anything else.
3270 * Point 2 is needed when the peer is resending, and we have already received
3271 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003272 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003273static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003274 unsigned char *buf,
3275 size_t len,
3276 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003277{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003278 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003279
Hanno Beckere5e7e782019-07-11 12:29:35 +01003280 size_t const rec_hdr_type_offset = 0;
3281 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003282
Hanno Beckere5e7e782019-07-11 12:29:35 +01003283 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3284 rec_hdr_type_len;
3285 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003286
Hanno Beckere5e7e782019-07-11 12:29:35 +01003287 size_t const rec_hdr_ctr_len = 8;
3288#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003289 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003290 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3291 rec_hdr_version_len;
3292
Hanno Beckera0e20d02019-05-15 14:03:01 +01003293#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003294 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3295 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003296 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003297#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3298#endif /* MBEDTLS_SSL_PROTO_DTLS */
3299
3300 size_t rec_hdr_len_offset; /* To be determined */
3301 size_t const rec_hdr_len_len = 2;
3302
3303 /*
3304 * Check minimum lengths for record header.
3305 */
3306
3307#if defined(MBEDTLS_SSL_PROTO_DTLS)
3308 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3309 {
3310 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3311 }
3312 else
3313#endif /* MBEDTLS_SSL_PROTO_DTLS */
3314 {
3315 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3316 }
3317
3318 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3319 {
3320 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3321 (unsigned) len,
3322 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3323 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3324 }
3325
3326 /*
3327 * Parse and validate record content type
3328 */
3329
3330 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003331
3332 /* Check record content type */
3333#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3334 rec->cid_len = 0;
3335
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003336 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003337 ssl->conf->cid_len != 0 &&
3338 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003339 {
3340 /* Shift pointers to account for record header including CID
3341 * struct {
3342 * ContentType special_type = tls12_cid;
3343 * ProtocolVersion version;
3344 * uint16 epoch;
3345 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003346 * opaque cid[cid_length]; // Additional field compared to
3347 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003348 * uint16 length;
3349 * opaque enc_content[DTLSCiphertext.length];
3350 * } DTLSCiphertext;
3351 */
3352
3353 /* So far, we only support static CID lengths
3354 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003355 rec_hdr_cid_len = ssl->conf->cid_len;
3356 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003357
Hanno Beckere5e7e782019-07-11 12:29:35 +01003358 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003359 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003360 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3361 (unsigned) len,
3362 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003363 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003364 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003365
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003366 /* configured CID len is guaranteed at most 255, see
3367 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3368 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003369 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003370 }
3371 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003372#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003373 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003374 if( ssl_check_record_type( rec->type ) )
3375 {
Hanno Becker54229812019-07-12 14:40:00 +01003376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3377 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003378 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3379 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003380 }
3381
Hanno Beckere5e7e782019-07-11 12:29:35 +01003382 /*
3383 * Parse and validate record version
3384 */
3385
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003386 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3387 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003388 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3389 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003390 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003391
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003392 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003393 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3395 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003396 }
3397
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003398 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003399 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3401 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003402 }
3403
Hanno Beckere5e7e782019-07-11 12:29:35 +01003404 /*
3405 * Parse/Copy record sequence number.
3406 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003407
Hanno Beckere5e7e782019-07-11 12:29:35 +01003408#if defined(MBEDTLS_SSL_PROTO_DTLS)
3409 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003410 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003411 /* Copy explicit record sequence number from input buffer. */
3412 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3413 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003414 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003415 else
3416#endif /* MBEDTLS_SSL_PROTO_DTLS */
3417 {
3418 /* Copy implicit record sequence number from SSL context structure. */
3419 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3420 }
Paul Bakker40e46942009-01-03 21:51:57 +00003421
Hanno Beckere5e7e782019-07-11 12:29:35 +01003422 /*
3423 * Parse record length.
3424 */
3425
Hanno Beckere5e7e782019-07-11 12:29:35 +01003426 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003427 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3428 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003429 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003430
Paul Elliott9f352112020-12-09 14:55:45 +00003431 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003432 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003433 rec->type,
3434 major_ver, minor_ver, rec->data_len ) );
3435
3436 rec->buf = buf;
3437 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003438
Hanno Beckerd417cc92019-07-26 08:20:27 +01003439 if( rec->data_len == 0 )
3440 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003441
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003442 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003443 * DTLS-related tests.
3444 * Check epoch before checking length constraint because
3445 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3446 * message gets duplicated before the corresponding Finished message,
3447 * the second ChangeCipherSpec should be discarded because it belongs
3448 * to an old epoch, but not because its length is shorter than
3449 * the minimum record length for packets using the new record transform.
3450 * Note that these two kinds of failures are handled differently,
3451 * as an unexpected record is silently skipped but an invalid
3452 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003453 */
3454#if defined(MBEDTLS_SSL_PROTO_DTLS)
3455 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3456 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003457 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003458
Hanno Becker955a5c92019-07-10 17:12:07 +01003459 /* Check that the datagram is large enough to contain a record
3460 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003461 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003462 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3464 (unsigned) len,
3465 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003466 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3467 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003468
Hanno Becker37cfe732019-07-10 17:20:01 +01003469 /* Records from other, non-matching epochs are silently discarded.
3470 * (The case of same-port Client reconnects must be considered in
3471 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003472 if( rec_epoch != ssl->in_epoch )
3473 {
3474 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003475 "expected %u, received %lu",
3476 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003477
Hanno Becker552f7472019-07-19 10:59:12 +01003478 /* Records from the next epoch are considered for buffering
3479 * (concretely: early Finished messages). */
3480 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003481 {
Hanno Becker552f7472019-07-19 10:59:12 +01003482 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3483 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003484 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003485
Hanno Becker2fddd372019-07-10 14:37:41 +01003486 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003487 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003488#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003489 /* For records from the correct epoch, check whether their
3490 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003491 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3492 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003493 {
3494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3495 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3496 }
3497#endif
3498 }
3499#endif /* MBEDTLS_SSL_PROTO_DTLS */
3500
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003501 return( 0 );
3502}
Paul Bakker5121ce52009-01-03 21:22:43 +00003503
Paul Bakker5121ce52009-01-03 21:22:43 +00003504
Hanno Becker2fddd372019-07-10 14:37:41 +01003505#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3506static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3507{
3508 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3509
3510 /*
3511 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3512 * access the first byte of record content (handshake type), as we
3513 * have an active transform (possibly iv_len != 0), so use the
3514 * fact that the record header len is 13 instead.
3515 */
3516 if( rec_epoch == 0 &&
3517 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3518 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3519 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3520 ssl->in_left > 13 &&
3521 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3522 {
3523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3524 "from the same port" ) );
3525 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003526 }
3527
3528 return( 0 );
3529}
Hanno Becker2fddd372019-07-10 14:37:41 +01003530#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003531
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003532/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003533 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003534 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003535static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3536 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003537{
3538 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003541 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Paul Bakker48916f92012-09-16 19:57:18 +00003543 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003544 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003545 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003546
Hanno Beckera18d1322018-01-03 14:27:32 +00003547 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003548 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003549 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003551
Hanno Beckera0e20d02019-05-15 14:03:01 +01003552#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003553 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3554 ssl->conf->ignore_unexpected_cid
3555 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3556 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003557 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003558 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003559 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003560#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003561
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 return( ret );
3563 }
3564
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003565 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003566 {
3567 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003568 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003569 }
3570
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003571 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003572 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003573
Hanno Beckera0e20d02019-05-15 14:03:01 +01003574#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003575 /* We have already checked the record content type
3576 * in ssl_parse_record_header(), failing or silently
3577 * dropping the record in the case of an unknown type.
3578 *
3579 * Since with the use of CIDs, the record content type
3580 * might change during decryption, re-check the record
3581 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003582 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003583 {
3584 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3585 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3586 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003587#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003588
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003589 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003590 {
3591#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3592 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003593 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003594 {
3595 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3596 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3597 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3598 }
3599#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3600
3601 ssl->nb_zero++;
3602
3603 /*
3604 * Three or more empty messages may be a DoS attack
3605 * (excessive CPU consumption).
3606 */
3607 if( ssl->nb_zero > 3 )
3608 {
3609 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003610 "messages, possible DoS attack" ) );
3611 /* Treat the records as if they were not properly authenticated,
3612 * thereby failing the connection if we see more than allowed
3613 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003614 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3615 }
3616 }
3617 else
3618 ssl->nb_zero = 0;
3619
3620#if defined(MBEDTLS_SSL_PROTO_DTLS)
3621 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3622 {
3623 ; /* in_ctr read from peer, not maintained internally */
3624 }
3625 else
3626#endif
3627 {
3628 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003629 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003630 if( ++ssl->in_ctr[i - 1] != 0 )
3631 break;
3632
3633 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003634 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003635 {
3636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3637 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3638 }
3639 }
3640
Paul Bakker5121ce52009-01-03 21:22:43 +00003641 }
3642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003643#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003644 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003645 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003646 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003647 }
3648#endif
3649
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003650 /* Check actual (decrypted) record content length against
3651 * configured maximum. */
3652 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3653 {
3654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3655 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3656 }
3657
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003658 return( 0 );
3659}
3660
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003661/*
3662 * Read a record.
3663 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003664 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3665 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3666 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003667 */
Hanno Becker1097b342018-08-15 14:09:41 +01003668
3669/* Helper functions for mbedtls_ssl_read_record(). */
3670static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003671static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3672static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003673
Hanno Becker327c93b2018-08-15 13:56:18 +01003674int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003675 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003676{
Janos Follath865b3eb2019-12-16 11:46:15 +00003677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003680
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003681 if( ssl->keep_current_message == 0 )
3682 {
3683 do {
Simon Butcher99000142016-10-13 17:21:01 +01003684
Hanno Becker26994592018-08-15 14:14:59 +01003685 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003686 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003687 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003688
Hanno Beckere74d5562018-08-15 14:26:08 +01003689 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003690 {
Hanno Becker40f50842018-08-15 14:48:01 +01003691#if defined(MBEDTLS_SSL_PROTO_DTLS)
3692 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003693
Hanno Becker40f50842018-08-15 14:48:01 +01003694 /* We only check for buffered messages if the
3695 * current datagram is fully consumed. */
3696 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003697 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003698 {
Hanno Becker40f50842018-08-15 14:48:01 +01003699 if( ssl_load_buffered_message( ssl ) == 0 )
3700 have_buffered = 1;
3701 }
3702
3703 if( have_buffered == 0 )
3704#endif /* MBEDTLS_SSL_PROTO_DTLS */
3705 {
3706 ret = ssl_get_next_record( ssl );
3707 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3708 continue;
3709
3710 if( ret != 0 )
3711 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003712 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003713 return( ret );
3714 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003715 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003716 }
3717
3718 ret = mbedtls_ssl_handle_message_type( ssl );
3719
Hanno Becker40f50842018-08-15 14:48:01 +01003720#if defined(MBEDTLS_SSL_PROTO_DTLS)
3721 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3722 {
3723 /* Buffer future message */
3724 ret = ssl_buffer_message( ssl );
3725 if( ret != 0 )
3726 return( ret );
3727
3728 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3729 }
3730#endif /* MBEDTLS_SSL_PROTO_DTLS */
3731
Hanno Becker90333da2017-10-10 11:27:13 +01003732 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3733 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003734
3735 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003736 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003737 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003738 return( ret );
3739 }
3740
Hanno Becker327c93b2018-08-15 13:56:18 +01003741 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003742 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003743 {
3744 mbedtls_ssl_update_handshake_status( ssl );
3745 }
Simon Butcher99000142016-10-13 17:21:01 +01003746 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003747 else
Simon Butcher99000142016-10-13 17:21:01 +01003748 {
Hanno Becker02f59072018-08-15 14:00:24 +01003749 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003750 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003751 }
3752
3753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3754
3755 return( 0 );
3756}
3757
Hanno Becker40f50842018-08-15 14:48:01 +01003758#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003759static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003760{
Hanno Becker40f50842018-08-15 14:48:01 +01003761 if( ssl->in_left > ssl->next_record_offset )
3762 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003763
Hanno Becker40f50842018-08-15 14:48:01 +01003764 return( 0 );
3765}
3766
3767static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3768{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003769 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003770 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003771 int ret = 0;
3772
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003773 if( hs == NULL )
3774 return( -1 );
3775
Hanno Beckere00ae372018-08-20 09:39:42 +01003776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3777
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003778 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3779 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3780 {
3781 /* Check if we have seen a ChangeCipherSpec before.
3782 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003783 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003784 {
3785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3786 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003787 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003788 }
3789
Hanno Becker39b8bc92018-08-28 17:17:13 +01003790 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003791 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3792 ssl->in_msglen = 1;
3793 ssl->in_msg[0] = 1;
3794
3795 /* As long as they are equal, the exact value doesn't matter. */
3796 ssl->in_left = 0;
3797 ssl->next_record_offset = 0;
3798
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003799 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003800 goto exit;
3801 }
Hanno Becker37f95322018-08-16 13:55:32 +01003802
Hanno Beckerb8f50142018-08-28 10:01:34 +01003803#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003804 /* Debug only */
3805 {
3806 unsigned offset;
3807 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3808 {
3809 hs_buf = &hs->buffering.hs[offset];
3810 if( hs_buf->is_valid == 1 )
3811 {
3812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3813 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003814 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003815 }
3816 }
3817 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003818#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003819
3820 /* Check if we have buffered and/or fully reassembled the
3821 * next handshake message. */
3822 hs_buf = &hs->buffering.hs[0];
3823 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3824 {
3825 /* Synthesize a record containing the buffered HS message. */
3826 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3827 ( hs_buf->data[2] << 8 ) |
3828 hs_buf->data[3];
3829
3830 /* Double-check that we haven't accidentally buffered
3831 * a message that doesn't fit into the input buffer. */
3832 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3833 {
3834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3836 }
3837
3838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3839 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3840 hs_buf->data, msg_len + 12 );
3841
3842 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3843 ssl->in_hslen = msg_len + 12;
3844 ssl->in_msglen = msg_len + 12;
3845 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3846
3847 ret = 0;
3848 goto exit;
3849 }
3850 else
3851 {
3852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3853 hs->in_msg_seq ) );
3854 }
3855
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003856 ret = -1;
3857
3858exit:
3859
3860 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3861 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003862}
3863
Hanno Beckera02b0b42018-08-21 17:20:27 +01003864static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3865 size_t desired )
3866{
3867 int offset;
3868 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3870 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003871
Hanno Becker01315ea2018-08-21 17:22:17 +01003872 /* Get rid of future records epoch first, if such exist. */
3873 ssl_free_buffered_record( ssl );
3874
3875 /* Check if we have enough space available now. */
3876 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3877 hs->buffering.total_bytes_buffered ) )
3878 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003879 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003880 return( 0 );
3881 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003882
Hanno Becker4f432ad2018-08-28 10:02:32 +01003883 /* We don't have enough space to buffer the next expected handshake
3884 * message. Remove buffers used for future messages to gain space,
3885 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003886 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3887 offset >= 0; offset-- )
3888 {
3889 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3890 offset ) );
3891
Hanno Beckerb309b922018-08-23 13:18:05 +01003892 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003893
3894 /* Check if we have enough space available now. */
3895 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3896 hs->buffering.total_bytes_buffered ) )
3897 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003898 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003899 return( 0 );
3900 }
3901 }
3902
3903 return( -1 );
3904}
3905
Hanno Becker40f50842018-08-15 14:48:01 +01003906static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3907{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003908 int ret = 0;
3909 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3910
3911 if( hs == NULL )
3912 return( 0 );
3913
3914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3915
3916 switch( ssl->in_msgtype )
3917 {
3918 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3919 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003920
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003921 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003922 break;
3923
3924 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003925 {
3926 unsigned recv_msg_seq_offset;
3927 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3928 mbedtls_ssl_hs_buffer *hs_buf;
3929 size_t msg_len = ssl->in_hslen - 12;
3930
3931 /* We should never receive an old handshake
3932 * message - double-check nonetheless. */
3933 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3934 {
3935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3936 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3937 }
3938
3939 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3940 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3941 {
3942 /* Silently ignore -- message too far in the future */
3943 MBEDTLS_SSL_DEBUG_MSG( 2,
3944 ( "Ignore future HS message with sequence number %u, "
3945 "buffering window %u - %u",
3946 recv_msg_seq, ssl->handshake->in_msg_seq,
3947 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3948
3949 goto exit;
3950 }
3951
3952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3953 recv_msg_seq, recv_msg_seq_offset ) );
3954
3955 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3956
3957 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003958 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003959 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003960 size_t reassembly_buf_sz;
3961
Hanno Becker37f95322018-08-16 13:55:32 +01003962 hs_buf->is_fragmented =
3963 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3964
3965 /* We copy the message back into the input buffer
3966 * after reassembly, so check that it's not too large.
3967 * This is an implementation-specific limitation
3968 * and not one from the standard, hence it is not
3969 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003970 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003971 {
3972 /* Ignore message */
3973 goto exit;
3974 }
3975
Hanno Beckere0b150f2018-08-21 15:51:03 +01003976 /* Check if we have enough space to buffer the message. */
3977 if( hs->buffering.total_bytes_buffered >
3978 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3979 {
3980 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3981 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3982 }
3983
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003984 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3985 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003986
3987 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3988 hs->buffering.total_bytes_buffered ) )
3989 {
3990 if( recv_msg_seq_offset > 0 )
3991 {
3992 /* If we can't buffer a future message because
3993 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3995 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3996 " (already %" MBEDTLS_PRINTF_SIZET
3997 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003998 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003999 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004000 goto exit;
4001 }
Hanno Beckere1801392018-08-21 16:51:05 +01004002 else
4003 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004004 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4005 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4006 " (already %" MBEDTLS_PRINTF_SIZET
4007 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004008 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004009 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004010 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004011
Hanno Beckera02b0b42018-08-21 17:20:27 +01004012 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004013 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004014 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4015 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4016 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4017 " (already %" MBEDTLS_PRINTF_SIZET
4018 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004019 msg_len,
4020 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004021 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004022 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004023 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4024 goto exit;
4025 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004026 }
4027
Paul Elliottd48d5c62021-01-07 14:47:05 +00004028 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004029 msg_len ) );
4030
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004031 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4032 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004033 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004034 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004035 goto exit;
4036 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004037 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004038
4039 /* Prepare final header: copy msg_type, length and message_seq,
4040 * then add standardised fragment_offset and fragment_length */
4041 memcpy( hs_buf->data, ssl->in_msg, 6 );
4042 memset( hs_buf->data + 6, 0, 3 );
4043 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4044
4045 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004046
4047 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004048 }
4049 else
4050 {
4051 /* Make sure msg_type and length are consistent */
4052 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4053 {
4054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4055 /* Ignore */
4056 goto exit;
4057 }
4058 }
4059
Hanno Becker4422bbb2018-08-20 09:40:19 +01004060 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004061 {
4062 size_t frag_len, frag_off;
4063 unsigned char * const msg = hs_buf->data + 12;
4064
4065 /*
4066 * Check and copy current fragment
4067 */
4068
4069 /* Validation of header fields already done in
4070 * mbedtls_ssl_prepare_handshake_record(). */
4071 frag_off = ssl_get_hs_frag_off( ssl );
4072 frag_len = ssl_get_hs_frag_len( ssl );
4073
Paul Elliottd48d5c62021-01-07 14:47:05 +00004074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4075 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004076 frag_off, frag_len ) );
4077 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4078
4079 if( hs_buf->is_fragmented )
4080 {
4081 unsigned char * const bitmask = msg + msg_len;
4082 ssl_bitmask_set( bitmask, frag_off, frag_len );
4083 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4084 msg_len ) == 0 );
4085 }
4086 else
4087 {
4088 hs_buf->is_complete = 1;
4089 }
4090
4091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4092 hs_buf->is_complete ? "" : "not yet " ) );
4093 }
4094
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004095 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004096 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004097
4098 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004099 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004100 break;
4101 }
4102
4103exit:
4104
4105 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4106 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004107}
4108#endif /* MBEDTLS_SSL_PROTO_DTLS */
4109
Hanno Becker1097b342018-08-15 14:09:41 +01004110static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004111{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004112 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004113 * Consume last content-layer message and potentially
4114 * update in_msglen which keeps track of the contents'
4115 * consumption state.
4116 *
4117 * (1) Handshake messages:
4118 * Remove last handshake message, move content
4119 * and adapt in_msglen.
4120 *
4121 * (2) Alert messages:
4122 * Consume whole record content, in_msglen = 0.
4123 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004124 * (3) Change cipher spec:
4125 * Consume whole record content, in_msglen = 0.
4126 *
4127 * (4) Application data:
4128 * Don't do anything - the record layer provides
4129 * the application data as a stream transport
4130 * and consumes through mbedtls_ssl_read only.
4131 *
4132 */
4133
4134 /* Case (1): Handshake messages */
4135 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004136 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004137 /* Hard assertion to be sure that no application data
4138 * is in flight, as corrupting ssl->in_msglen during
4139 * ssl->in_offt != NULL is fatal. */
4140 if( ssl->in_offt != NULL )
4141 {
4142 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4143 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4144 }
4145
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004146 /*
4147 * Get next Handshake message in the current record
4148 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004149
Hanno Becker4a810fb2017-05-24 16:27:30 +01004150 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004151 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004152 * current handshake content: If DTLS handshake
4153 * fragmentation is used, that's the fragment
4154 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004155 * size here is faulty and should be changed at
4156 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004157 * (2) While it doesn't seem to cause problems, one
4158 * has to be very careful not to assume that in_hslen
4159 * is always <= in_msglen in a sensible communication.
4160 * Again, it's wrong for DTLS handshake fragmentation.
4161 * The following check is therefore mandatory, and
4162 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004163 * Additionally, ssl->in_hslen might be arbitrarily out of
4164 * bounds after handling a DTLS message with an unexpected
4165 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004166 */
4167 if( ssl->in_hslen < ssl->in_msglen )
4168 {
4169 ssl->in_msglen -= ssl->in_hslen;
4170 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4171 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004172
Hanno Becker4a810fb2017-05-24 16:27:30 +01004173 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4174 ssl->in_msg, ssl->in_msglen );
4175 }
4176 else
4177 {
4178 ssl->in_msglen = 0;
4179 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004180
Hanno Becker4a810fb2017-05-24 16:27:30 +01004181 ssl->in_hslen = 0;
4182 }
4183 /* Case (4): Application data */
4184 else if( ssl->in_offt != NULL )
4185 {
4186 return( 0 );
4187 }
4188 /* Everything else (CCS & Alerts) */
4189 else
4190 {
4191 ssl->in_msglen = 0;
4192 }
4193
Hanno Becker1097b342018-08-15 14:09:41 +01004194 return( 0 );
4195}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004196
Hanno Beckere74d5562018-08-15 14:26:08 +01004197static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4198{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004199 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004200 return( 1 );
4201
4202 return( 0 );
4203}
4204
Hanno Becker5f066e72018-08-16 14:56:31 +01004205#if defined(MBEDTLS_SSL_PROTO_DTLS)
4206
4207static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4208{
4209 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4210 if( hs == NULL )
4211 return;
4212
Hanno Becker01315ea2018-08-21 17:22:17 +01004213 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004214 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004215 hs->buffering.total_bytes_buffered -=
4216 hs->buffering.future_record.len;
4217
4218 mbedtls_free( hs->buffering.future_record.data );
4219 hs->buffering.future_record.data = NULL;
4220 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004221}
4222
4223static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4224{
4225 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4226 unsigned char * rec;
4227 size_t rec_len;
4228 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004229#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4230 size_t in_buf_len = ssl->in_buf_len;
4231#else
4232 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4233#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004234 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4235 return( 0 );
4236
4237 if( hs == NULL )
4238 return( 0 );
4239
Hanno Becker5f066e72018-08-16 14:56:31 +01004240 rec = hs->buffering.future_record.data;
4241 rec_len = hs->buffering.future_record.len;
4242 rec_epoch = hs->buffering.future_record.epoch;
4243
4244 if( rec == NULL )
4245 return( 0 );
4246
Hanno Becker4cb782d2018-08-20 11:19:05 +01004247 /* Only consider loading future records if the
4248 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004249 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004250 return( 0 );
4251
Hanno Becker5f066e72018-08-16 14:56:31 +01004252 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4253
4254 if( rec_epoch != ssl->in_epoch )
4255 {
4256 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4257 goto exit;
4258 }
4259
4260 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4261
4262 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004263 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004264 {
4265 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4266 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4267 }
4268
4269 memcpy( ssl->in_hdr, rec, rec_len );
4270 ssl->in_left = rec_len;
4271 ssl->next_record_offset = 0;
4272
4273 ssl_free_buffered_record( ssl );
4274
4275exit:
4276 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4277 return( 0 );
4278}
4279
Hanno Becker519f15d2019-07-11 12:43:20 +01004280static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4281 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004282{
4283 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004284
4285 /* Don't buffer future records outside handshakes. */
4286 if( hs == NULL )
4287 return( 0 );
4288
4289 /* Only buffer handshake records (we are only interested
4290 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004291 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004292 return( 0 );
4293
4294 /* Don't buffer more than one future epoch record. */
4295 if( hs->buffering.future_record.data != NULL )
4296 return( 0 );
4297
Hanno Becker01315ea2018-08-21 17:22:17 +01004298 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004299 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004300 hs->buffering.total_bytes_buffered ) )
4301 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004302 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4303 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4304 " (already %" MBEDTLS_PRINTF_SIZET
4305 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004306 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004307 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004308 return( 0 );
4309 }
4310
Hanno Becker5f066e72018-08-16 14:56:31 +01004311 /* Buffer record */
4312 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004313 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004314 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004315
4316 /* ssl_parse_record_header() only considers records
4317 * of the next epoch as candidates for buffering. */
4318 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004319 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004320
4321 hs->buffering.future_record.data =
4322 mbedtls_calloc( 1, hs->buffering.future_record.len );
4323 if( hs->buffering.future_record.data == NULL )
4324 {
4325 /* If we run out of RAM trying to buffer a
4326 * record from the next epoch, just ignore. */
4327 return( 0 );
4328 }
4329
Hanno Becker519f15d2019-07-11 12:43:20 +01004330 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004331
Hanno Becker519f15d2019-07-11 12:43:20 +01004332 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004333 return( 0 );
4334}
4335
4336#endif /* MBEDTLS_SSL_PROTO_DTLS */
4337
Hanno Beckere74d5562018-08-15 14:26:08 +01004338static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004339{
Janos Follath865b3eb2019-12-16 11:46:15 +00004340 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004341 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004342
Hanno Becker5f066e72018-08-16 14:56:31 +01004343#if defined(MBEDTLS_SSL_PROTO_DTLS)
4344 /* We might have buffered a future record; if so,
4345 * and if the epoch matches now, load it.
4346 * On success, this call will set ssl->in_left to
4347 * the length of the buffered record, so that
4348 * the calls to ssl_fetch_input() below will
4349 * essentially be no-ops. */
4350 ret = ssl_load_buffered_record( ssl );
4351 if( ret != 0 )
4352 return( ret );
4353#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004354
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004355 /* Ensure that we have enough space available for the default form
4356 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4357 * with no space for CIDs counted in). */
4358 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4359 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004361 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004362 return( ret );
4363 }
4364
Hanno Beckere5e7e782019-07-11 12:29:35 +01004365 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4366 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004367 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004368#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004369 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004370 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004371 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4372 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004373 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004374 if( ret != 0 )
4375 return( ret );
4376
4377 /* Fall through to handling of unexpected records */
4378 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4379 }
4380
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004381 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4382 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004383#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004384 /* Reset in pointers to default state for TLS/DTLS records,
4385 * assuming no CID and no offset between record content and
4386 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004387 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004388
Hanno Becker7ae20e02019-07-12 08:33:49 +01004389 /* Setup internal message pointers from record structure. */
4390 ssl->in_msgtype = rec.type;
4391#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4392 ssl->in_len = ssl->in_cid + rec.cid_len;
4393#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4394 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4395 ssl->in_msglen = rec.data_len;
4396
Hanno Becker2fddd372019-07-10 14:37:41 +01004397 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004398 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004399 if( ret != 0 )
4400 return( ret );
4401#endif
4402
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004403 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004404 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004405
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4407 "(header)" ) );
4408 }
4409 else
4410 {
4411 /* Skip invalid record and the rest of the datagram */
4412 ssl->next_record_offset = 0;
4413 ssl->in_left = 0;
4414
4415 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4416 "(header)" ) );
4417 }
4418
4419 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004420 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004421 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004422 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004423#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004424 {
4425 return( ret );
4426 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004427 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004429#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004430 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004431 {
Hanno Beckera8814792019-07-10 15:01:45 +01004432 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004433 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004434 if( ssl->next_record_offset < ssl->in_left )
4435 {
4436 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4437 }
4438 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004439 else
4440#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004441 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004442 /*
4443 * Fetch record contents from underlying transport.
4444 */
Hanno Beckera3175662019-07-11 12:50:29 +01004445 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004446 if( ret != 0 )
4447 {
4448 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4449 return( ret );
4450 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004451
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004452 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004453 }
4454
4455 /*
4456 * Decrypt record contents.
4457 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004458
Hanno Beckerfdf66042019-07-11 13:07:45 +01004459 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004460 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004461#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004462 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004463 {
4464 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004465 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004466 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004467 /* Except when waiting for Finished as a bad mac here
4468 * probably means something went wrong in the handshake
4469 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4470 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4471 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4472 {
4473#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4474 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4475 {
4476 mbedtls_ssl_send_alert_message( ssl,
4477 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4478 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4479 }
4480#endif
4481 return( ret );
4482 }
4483
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004484 if( ssl->conf->badmac_limit != 0 &&
4485 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004487 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4488 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004489 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004490
Hanno Becker4a810fb2017-05-24 16:27:30 +01004491 /* As above, invalid records cause
4492 * dismissal of the whole datagram. */
4493
4494 ssl->next_record_offset = 0;
4495 ssl->in_left = 0;
4496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004497 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004498 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004499 }
4500
4501 return( ret );
4502 }
4503 else
4504#endif
4505 {
4506 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004507#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4508 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004510 mbedtls_ssl_send_alert_message( ssl,
4511 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4512 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004513 }
4514#endif
4515 return( ret );
4516 }
4517 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004518
Hanno Becker44d89b22019-07-12 09:40:44 +01004519
4520 /* Reset in pointers to default state for TLS/DTLS records,
4521 * assuming no CID and no offset between record content and
4522 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004523 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004524#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4525 ssl->in_len = ssl->in_cid + rec.cid_len;
4526#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004527 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004528
Hanno Becker8685c822019-07-12 09:37:30 +01004529 /* The record content type may change during decryption,
4530 * so re-read it. */
4531 ssl->in_msgtype = rec.type;
4532 /* Also update the input buffer, because unfortunately
4533 * the server-side ssl_parse_client_hello() reparses the
4534 * record header when receiving a ClientHello initiating
4535 * a renegotiation. */
4536 ssl->in_hdr[0] = rec.type;
4537 ssl->in_msg = rec.buf + rec.data_offset;
4538 ssl->in_msglen = rec.data_len;
4539 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4540 ssl->in_len[1] = (unsigned char)( rec.data_len );
4541
Simon Butcher99000142016-10-13 17:21:01 +01004542 return( 0 );
4543}
4544
4545int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4546{
Janos Follath865b3eb2019-12-16 11:46:15 +00004547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004548
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004549 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004550 * Handle particular types of records
4551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004552 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004553 {
Simon Butcher99000142016-10-13 17:21:01 +01004554 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4555 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004556 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004557 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004558 }
4559
Hanno Beckere678eaa2018-08-21 14:57:46 +01004560 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004561 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004562 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004563 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004565 ssl->in_msglen ) );
4566 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004567 }
4568
Hanno Beckere678eaa2018-08-21 14:57:46 +01004569 if( ssl->in_msg[0] != 1 )
4570 {
4571 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4572 ssl->in_msg[0] ) );
4573 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4574 }
4575
4576#if defined(MBEDTLS_SSL_PROTO_DTLS)
4577 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4578 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4579 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4580 {
4581 if( ssl->handshake == NULL )
4582 {
4583 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4584 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4585 }
4586
4587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4588 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4589 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004590#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004591 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004593 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004594 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004595 if( ssl->in_msglen != 2 )
4596 {
4597 /* Note: Standard allows for more than one 2 byte alert
4598 to be packed in a single message, but Mbed TLS doesn't
4599 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004600 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004601 ssl->in_msglen ) );
4602 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4603 }
4604
Paul Elliott9f352112020-12-09 14:55:45 +00004605 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004606 ssl->in_msg[0], ssl->in_msg[1] ) );
4607
4608 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004609 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004611 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004612 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004614 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004616 }
4617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004618 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4619 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004620 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004621 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4622 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004623 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004624
4625#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4626 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4627 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4628 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004630 /* Will be handled when trying to parse ServerHello */
4631 return( 0 );
4632 }
4633#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004634 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004635 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004636 }
4637
Hanno Beckerc76c6192017-06-06 10:03:17 +01004638#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004639 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004640 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004641 /* Drop unexpected ApplicationData records,
4642 * except at the beginning of renegotiations */
4643 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4644 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4645#if defined(MBEDTLS_SSL_RENEGOTIATION)
4646 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4647 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004648#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004649 )
4650 {
4651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4652 return( MBEDTLS_ERR_SSL_NON_FATAL );
4653 }
4654
4655 if( ssl->handshake != NULL &&
4656 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4657 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004658 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004659 }
4660 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004661#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004662
Paul Bakker5121ce52009-01-03 21:22:43 +00004663 return( 0 );
4664}
4665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004666int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004667{
irwir6c0da642019-09-26 21:07:41 +03004668 return( mbedtls_ssl_send_alert_message( ssl,
4669 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4670 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004671}
4672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004673int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004674 unsigned char level,
4675 unsigned char message )
4676{
Janos Follath865b3eb2019-12-16 11:46:15 +00004677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004678
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004679 if( ssl == NULL || ssl->conf == NULL )
4680 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004683 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004685 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004686 ssl->out_msglen = 2;
4687 ssl->out_msg[0] = level;
4688 ssl->out_msg[1] = message;
4689
Hanno Becker67bc7c32018-08-06 11:33:50 +01004690 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004692 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004693 return( ret );
4694 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004696
4697 return( 0 );
4698}
4699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004700int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004701{
Janos Follath865b3eb2019-12-16 11:46:15 +00004702 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004703
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004707 ssl->out_msglen = 1;
4708 ssl->out_msg[0] = 1;
4709
Paul Bakker5121ce52009-01-03 21:22:43 +00004710 ssl->state++;
4711
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004712 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004713 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004715 return( ret );
4716 }
4717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004719
4720 return( 0 );
4721}
4722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004724{
Janos Follath865b3eb2019-12-16 11:46:15 +00004725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004727 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004728
Hanno Becker327c93b2018-08-15 13:56:18 +01004729 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004732 return( ret );
4733 }
4734
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004735 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004736 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004737 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004738 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4739 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004740 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004741 }
4742
Hanno Beckere678eaa2018-08-21 14:57:46 +01004743 /* CCS records are only accepted if they have length 1 and content '1',
4744 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004745
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004746 /*
4747 * Switch to our negotiated transform and session parameters for inbound
4748 * data.
4749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004751 ssl->transform_in = ssl->transform_negotiate;
4752 ssl->session_in = ssl->session_negotiate;
4753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004755 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004756 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004757#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004758 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004759#endif
4760
4761 /* Increment epoch */
4762 if( ++ssl->in_epoch == 0 )
4763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004765 /* This is highly unlikely to happen for legitimate reasons, so
4766 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004768 }
4769 }
4770 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004771#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004772 memset( ssl->in_ctr, 0, 8 );
4773
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004774 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004775
Paul Bakker5121ce52009-01-03 21:22:43 +00004776 ssl->state++;
4777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004779
4780 return( 0 );
4781}
4782
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004783/* Once ssl->out_hdr as the address of the beginning of the
4784 * next outgoing record is set, deduce the other pointers.
4785 *
4786 * Note: For TLS, we save the implicit record sequence number
4787 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4788 * and the caller has to make sure there's space for this.
4789 */
4790
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004791static size_t ssl_transform_get_explicit_iv_len(
4792 mbedtls_ssl_transform const *transform )
4793{
TRodziewiczef73f012021-05-13 14:53:36 +02004794 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004795 return( 0 );
4796
4797 return( transform->ivlen - transform->fixed_ivlen );
4798}
4799
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004800void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4801 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004802{
4803#if defined(MBEDTLS_SSL_PROTO_DTLS)
4804 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4805 {
4806 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004807#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004808 ssl->out_cid = ssl->out_ctr + 8;
4809 ssl->out_len = ssl->out_cid;
4810 if( transform != NULL )
4811 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004812#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004813 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004814#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004815 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004816 }
4817 else
4818#endif
4819 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004820 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004821#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004822 ssl->out_cid = ssl->out_len;
4823#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004824 ssl->out_iv = ssl->out_hdr + 5;
4825 }
4826
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004827 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004828 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004829 if( transform != NULL )
4830 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004831}
4832
4833/* Once ssl->in_hdr as the address of the beginning of the
4834 * next incoming record is set, deduce the other pointers.
4835 *
4836 * Note: For TLS, we save the implicit record sequence number
4837 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4838 * and the caller has to make sure there's space for this.
4839 */
4840
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004841void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004842{
Hanno Becker79594fd2019-05-08 09:38:41 +01004843 /* This function sets the pointers to match the case
4844 * of unprotected TLS/DTLS records, with both ssl->in_iv
4845 * and ssl->in_msg pointing to the beginning of the record
4846 * content.
4847 *
4848 * When decrypting a protected record, ssl->in_msg
4849 * will be shifted to point to the beginning of the
4850 * record plaintext.
4851 */
4852
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004853#if defined(MBEDTLS_SSL_PROTO_DTLS)
4854 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4855 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004856 /* This sets the header pointers to match records
4857 * without CID. When we receive a record containing
4858 * a CID, the fields are shifted accordingly in
4859 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004860 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004861#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004862 ssl->in_cid = ssl->in_ctr + 8;
4863 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004864#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004865 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004866#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004867 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004868 }
4869 else
4870#endif
4871 {
4872 ssl->in_ctr = ssl->in_hdr - 8;
4873 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004874#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004875 ssl->in_cid = ssl->in_len;
4876#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004877 ssl->in_iv = ssl->in_hdr + 5;
4878 }
4879
Hanno Becker79594fd2019-05-08 09:38:41 +01004880 /* This will be adjusted at record decryption time. */
4881 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004882}
4883
Paul Bakker5121ce52009-01-03 21:22:43 +00004884/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004885 * Setup an SSL context
4886 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004887
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004888void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004889{
4890 /* Set the incoming and outgoing record pointers. */
4891#if defined(MBEDTLS_SSL_PROTO_DTLS)
4892 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4893 {
4894 ssl->out_hdr = ssl->out_buf;
4895 ssl->in_hdr = ssl->in_buf;
4896 }
4897 else
4898#endif /* MBEDTLS_SSL_PROTO_DTLS */
4899 {
Hanno Becker12078f42021-03-02 15:28:41 +00004900 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004901 ssl->out_hdr = ssl->out_buf + 8;
4902 ssl->in_hdr = ssl->in_buf + 8;
4903 }
4904
4905 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004906 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4907 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004908}
4909
Paul Bakker5121ce52009-01-03 21:22:43 +00004910/*
4911 * SSL get accessors
4912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004914{
4915 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4916}
4917
Hanno Becker8b170a02017-10-10 11:51:19 +01004918int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4919{
4920 /*
4921 * Case A: We're currently holding back
4922 * a message for further processing.
4923 */
4924
4925 if( ssl->keep_current_message == 1 )
4926 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004927 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004928 return( 1 );
4929 }
4930
4931 /*
4932 * Case B: Further records are pending in the current datagram.
4933 */
4934
4935#if defined(MBEDTLS_SSL_PROTO_DTLS)
4936 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4937 ssl->in_left > ssl->next_record_offset )
4938 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004939 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004940 return( 1 );
4941 }
4942#endif /* MBEDTLS_SSL_PROTO_DTLS */
4943
4944 /*
4945 * Case C: A handshake message is being processed.
4946 */
4947
Hanno Becker8b170a02017-10-10 11:51:19 +01004948 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4949 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004950 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004951 return( 1 );
4952 }
4953
4954 /*
4955 * Case D: An application data message is being processed
4956 */
4957 if( ssl->in_offt != NULL )
4958 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004959 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004960 return( 1 );
4961 }
4962
4963 /*
4964 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004965 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004966 * we implement support for multiple alerts in single records.
4967 */
4968
4969 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4970 return( 0 );
4971}
4972
Paul Bakker43ca69c2011-01-15 17:35:19 +00004973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004974int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004975{
Hanno Becker3136ede2018-08-17 15:28:19 +01004976 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004977 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004978 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004979
Hanno Becker5903de42019-05-03 14:46:38 +01004980 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4981
Hanno Becker78640902018-08-13 16:35:15 +01004982 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004983 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004985 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004986 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004987 case MBEDTLS_MODE_GCM:
4988 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004989 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004990 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004991 transform_expansion = transform->minlen;
4992 break;
4993
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004994 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004995
4996 block_size = mbedtls_cipher_get_block_size(
4997 &transform->cipher_ctx_enc );
4998
Hanno Becker3136ede2018-08-17 15:28:19 +01004999 /* Expansion due to the addition of the MAC. */
5000 transform_expansion += transform->maclen;
5001
5002 /* Expansion due to the addition of CBC padding;
5003 * Theoretically up to 256 bytes, but we never use
5004 * more than the block size of the underlying cipher. */
5005 transform_expansion += block_size;
5006
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005007 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005008 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005009#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005010 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005011#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005012
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005013 break;
5014
5015 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005017 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005018 }
5019
Hanno Beckera0e20d02019-05-15 14:03:01 +01005020#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005021 if( transform->out_cid_len != 0 )
5022 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005023#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005024
Hanno Becker5903de42019-05-03 14:46:38 +01005025 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005026}
5027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005028#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005029/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005030 * Check record counters and renegotiate if they're above the limit.
5031 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005032static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005033{
Hanno Beckerdd772292020-02-05 10:38:31 +00005034 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005035 int in_ctr_cmp;
5036 int out_ctr_cmp;
5037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005038 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5039 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005040 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005041 {
5042 return( 0 );
5043 }
5044
Andres AG2196c7f2016-12-15 17:01:16 +00005045 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5046 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005047 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005048 ssl->conf->renego_period + ep_len, 8 - ep_len );
5049
5050 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005051 {
5052 return( 0 );
5053 }
5054
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005055 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005056 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005057}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005058#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005059
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005060/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005061 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005062 * may only be sent for the purpose of initiating renegotiations.
5063 *
5064 * This function is introduced as a separate helper since the handling
5065 * of post-handshake handshake messages changes significantly in TLS 1.3,
5066 * and having a helper function allows to distinguish between TLS <= 1.2 and
5067 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5068 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005069static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005070{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005071 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005072
5073 /*
5074 * - For client-side, expect SERVER_HELLO_REQUEST.
5075 * - For server-side, expect CLIENT_HELLO.
5076 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5077 */
5078
5079#if defined(MBEDTLS_SSL_CLI_C)
5080 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5081 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5082 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5083 {
5084 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5085
5086 /* With DTLS, drop the packet (probably from last handshake) */
5087#if defined(MBEDTLS_SSL_PROTO_DTLS)
5088 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5089 {
5090 return( 0 );
5091 }
5092#endif
5093 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5094 }
5095#endif /* MBEDTLS_SSL_CLI_C */
5096
5097#if defined(MBEDTLS_SSL_SRV_C)
5098 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5099 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5100 {
5101 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5102
5103 /* With DTLS, drop the packet (probably from last handshake) */
5104#if defined(MBEDTLS_SSL_PROTO_DTLS)
5105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5106 {
5107 return( 0 );
5108 }
5109#endif
5110 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5111 }
5112#endif /* MBEDTLS_SSL_SRV_C */
5113
5114#if defined(MBEDTLS_SSL_RENEGOTIATION)
5115 /* Determine whether renegotiation attempt should be accepted */
5116 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5117 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5118 ssl->conf->allow_legacy_renegotiation ==
5119 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5120 {
5121 /*
5122 * Accept renegotiation request
5123 */
5124
5125 /* DTLS clients need to know renego is server-initiated */
5126#if defined(MBEDTLS_SSL_PROTO_DTLS)
5127 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5128 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5129 {
5130 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5131 }
5132#endif
5133 ret = mbedtls_ssl_start_renegotiation( ssl );
5134 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5135 ret != 0 )
5136 {
5137 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5138 ret );
5139 return( ret );
5140 }
5141 }
5142 else
5143#endif /* MBEDTLS_SSL_RENEGOTIATION */
5144 {
5145 /*
5146 * Refuse renegotiation
5147 */
5148
5149 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5150
TRodziewicz0f82ec62021-05-12 17:49:18 +02005151#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005152 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5153 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5154 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005155 {
TRodziewicz345165c2021-07-06 13:42:11 +02005156 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005157 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005158#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005159 }
5160
5161 return( 0 );
5162}
5163
Paul Bakker48916f92012-09-16 19:57:18 +00005164/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005165 * Receive application data decrypted from the SSL layer
5166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005167int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005168{
Janos Follath865b3eb2019-12-16 11:46:15 +00005169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005170 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005171
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005172 if( ssl == NULL || ssl->conf == NULL )
5173 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5174
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005175 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005177#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005178 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005179 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005180 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005181 return( ret );
5182
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005183 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005184 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005185 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005186 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005187 return( ret );
5188 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005189 }
5190#endif
5191
Hanno Becker4a810fb2017-05-24 16:27:30 +01005192 /*
5193 * Check if renegotiation is necessary and/or handshake is
5194 * in process. If yes, perform/continue, and fall through
5195 * if an unexpected packet is received while the client
5196 * is waiting for the ServerHello.
5197 *
5198 * (There is no equivalent to the last condition on
5199 * the server-side as it is not treated as within
5200 * a handshake while waiting for the ClientHello
5201 * after a renegotiation request.)
5202 */
5203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005204#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005205 ret = ssl_check_ctr_renegotiate( ssl );
5206 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5207 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005208 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005209 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005210 return( ret );
5211 }
5212#endif
5213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005214 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005215 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005216 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005217 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5218 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005219 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005220 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005221 return( ret );
5222 }
5223 }
5224
Hanno Beckere41158b2017-10-23 13:30:32 +01005225 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005226 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005227 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005228 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005229 if( ssl->f_get_timer != NULL &&
5230 ssl->f_get_timer( ssl->p_timer ) == -1 )
5231 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005232 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005233 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005234
Hanno Becker327c93b2018-08-15 13:56:18 +01005235 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005236 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005237 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5238 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005239
Hanno Becker4a810fb2017-05-24 16:27:30 +01005240 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5241 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005242 }
5243
5244 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005245 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005246 {
5247 /*
5248 * OpenSSL sends empty messages to randomize the IV
5249 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005250 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005251 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005252 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005253 return( 0 );
5254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005255 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005256 return( ret );
5257 }
5258 }
5259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005260 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005261 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005262 ret = ssl_handle_hs_message_post_handshake( ssl );
5263 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005264 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005265 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5266 ret );
5267 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005268 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005269
Hanno Beckerf26cc722021-04-21 07:30:13 +01005270 /* At this point, we don't know whether the renegotiation triggered
5271 * by the post-handshake message has been completed or not. The cases
5272 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005273 * 1) The renegotiation is complete. In this case, no new record
5274 * has been read yet.
5275 * 2) The renegotiation is incomplete because the client received
5276 * an application data record while awaiting the ServerHello.
5277 * 3) The renegotiation is incomplete because the client received
5278 * a non-handshake, non-application data message while awaiting
5279 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005280 *
5281 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005282 * - For 1), the next iteration will read a new record and check
5283 * if it's application data.
5284 * - For 2), the loop condition isn't satisfied as application data
5285 * is present, hence continue is the same as break
5286 * - For 3), the loop condition is satisfied and read_record
5287 * will re-deliver the message that was held back by the client
5288 * when expecting the ServerHello.
5289 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005290
Hanno Becker90333da2017-10-10 11:27:13 +01005291 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005292 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005293#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005294 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005295 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005296 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005297 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005298 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005299 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005300 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005301 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005302 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005303 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005304 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005305 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005306#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005308 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5309 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005310 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005311 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005312 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005313 }
5314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005315 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005316 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5318 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005319 }
5320
5321 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005322
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005323 /* We're going to return something now, cancel timer,
5324 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005325 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005326 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005327
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005328#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005329 /* If we requested renego but received AppData, resend HelloRequest.
5330 * Do it now, after setting in_offt, to avoid taking this branch
5331 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005332#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005333 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005334 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005335 {
Hanno Becker786300f2020-02-05 10:46:40 +00005336 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005337 {
Hanno Becker786300f2020-02-05 10:46:40 +00005338 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5339 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005340 return( ret );
5341 }
5342 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005344#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005345 }
5346
5347 n = ( len < ssl->in_msglen )
5348 ? len : ssl->in_msglen;
5349
5350 memcpy( buf, ssl->in_offt, n );
5351 ssl->in_msglen -= n;
5352
gabor-mezei-arma3214132020-07-15 10:55:00 +02005353 /* Zeroising the plaintext buffer to erase unused application data
5354 from the memory. */
5355 mbedtls_platform_zeroize( ssl->in_offt, n );
5356
Paul Bakker5121ce52009-01-03 21:22:43 +00005357 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005358 {
5359 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005360 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005361 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005362 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005363 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005364 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005365 /* more data available */
5366 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005367 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005369 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005370
Paul Bakker23986e52011-04-24 08:57:21 +00005371 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005372}
5373
5374/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005375 * Send application data to be encrypted by the SSL layer, taking care of max
5376 * fragment length and buffer size.
5377 *
5378 * According to RFC 5246 Section 6.2.1:
5379 *
5380 * Zero-length fragments of Application data MAY be sent as they are
5381 * potentially useful as a traffic analysis countermeasure.
5382 *
5383 * Therefore, it is possible that the input message length is 0 and the
5384 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005385 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005386static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005387 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005388{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005389 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5390 const size_t max_len = (size_t) ret;
5391
5392 if( ret < 0 )
5393 {
5394 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5395 return( ret );
5396 }
5397
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005398 if( len > max_len )
5399 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005400#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005401 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005404 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5405 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005406 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005407 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005408 }
5409 else
5410#endif
5411 len = max_len;
5412 }
Paul Bakker887bd502011-06-08 13:10:54 +00005413
Paul Bakker5121ce52009-01-03 21:22:43 +00005414 if( ssl->out_left != 0 )
5415 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005416 /*
5417 * The user has previously tried to send the data and
5418 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5419 * written. In this case, we expect the high-level write function
5420 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005423 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005424 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005425 return( ret );
5426 }
5427 }
Paul Bakker887bd502011-06-08 13:10:54 +00005428 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005429 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005430 /*
5431 * The user is trying to send a message the first time, so we need to
5432 * copy the data into the internal buffers and setup the data structure
5433 * to keep track of partial writes
5434 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005435 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005437 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005438
Hanno Becker67bc7c32018-08-06 11:33:50 +01005439 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005440 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005442 return( ret );
5443 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005444 }
5445
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005446 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005447}
5448
5449/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005450 * Write application data (public-facing wrapper)
5451 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005452int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005453{
Janos Follath865b3eb2019-12-16 11:46:15 +00005454 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005455
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005456 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005457
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005458 if( ssl == NULL || ssl->conf == NULL )
5459 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5460
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005461#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005462 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5463 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005464 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005465 return( ret );
5466 }
5467#endif
5468
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005469 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005470 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005471 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005472 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005473 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005474 return( ret );
5475 }
5476 }
5477
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005478 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005479
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005481
5482 return( ret );
5483}
5484
5485/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005486 * Notify the peer that the connection is being closed
5487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005489{
Janos Follath865b3eb2019-12-16 11:46:15 +00005490 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005491
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005492 if( ssl == NULL || ssl->conf == NULL )
5493 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005495 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005496
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005497 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005501 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5503 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5504 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005507 return( ret );
5508 }
5509 }
5510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005512
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005513 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005514}
5515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005517{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005518 if( transform == NULL )
5519 return;
5520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5522 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005523
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005524#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005525 mbedtls_md_free( &transform->md_ctx_enc );
5526 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005527#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005528
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005529 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005530}
5531
Hanno Becker0271f962018-08-16 13:23:47 +01005532#if defined(MBEDTLS_SSL_PROTO_DTLS)
5533
Hanno Becker533ab5f2020-02-05 10:49:13 +00005534void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005535{
5536 unsigned offset;
5537 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5538
5539 if( hs == NULL )
5540 return;
5541
Hanno Becker283f5ef2018-08-24 09:34:47 +01005542 ssl_free_buffered_record( ssl );
5543
Hanno Becker0271f962018-08-16 13:23:47 +01005544 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005545 ssl_buffering_free_slot( ssl, offset );
5546}
5547
5548static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5549 uint8_t slot )
5550{
5551 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5552 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005553
5554 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5555 return;
5556
Hanno Beckere605b192018-08-21 15:59:07 +01005557 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005558 {
Hanno Beckere605b192018-08-21 15:59:07 +01005559 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005560 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005561 mbedtls_free( hs_buf->data );
5562 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005563 }
5564}
5565
5566#endif /* MBEDTLS_SSL_PROTO_DTLS */
5567
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005568/*
5569 * Convert version numbers to/from wire format
5570 * and, for DTLS, to/from TLS equivalent.
5571 *
5572 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005573 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005574 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005577 unsigned char ver[2] )
5578{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005579#if defined(MBEDTLS_SSL_PROTO_DTLS)
5580 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005581 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005583 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5584
5585 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5586 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5587 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005588 else
5589#else
5590 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005591#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005592 {
5593 ver[0] = (unsigned char) major;
5594 ver[1] = (unsigned char) minor;
5595 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005596}
5597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005598void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005599 const unsigned char ver[2] )
5600{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005601#if defined(MBEDTLS_SSL_PROTO_DTLS)
5602 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005603 {
5604 *major = 255 - ver[0] + 2;
5605 *minor = 255 - ver[1] + 1;
5606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005607 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005608 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5609 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005610 else
5611#else
5612 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005613#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005614 {
5615 *major = ver[0];
5616 *minor = ver[1];
5617 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005618}
5619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620#endif /* MBEDTLS_SSL_TLS_C */