blob: fcd63ac86e35ced93fcb61ece28af88e9a7fd6f8 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020043#include "constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020044
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020045#include "ssl_invasive.h"
46
Rich Evans00ab4702015-02-06 13:43:58 +000047#include <string.h>
48
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050049#if defined(MBEDTLS_USE_PSA_CRYPTO)
50#include "mbedtls/psa_util.h"
51#include "psa/crypto.h"
52#endif
53
Janos Follath23bdca02016-10-07 14:47:14 +010054#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000055#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020056#endif
57
Hanno Beckercd9dcda2018-08-28 17:18:56 +010058static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010059
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020060/*
61 * Start a timer.
62 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020063 */
Hanno Becker0f57a652020-02-05 10:37:26 +000064void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020065{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020066 if( ssl->f_set_timer == NULL )
67 return;
68
69 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
70 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020071}
72
73/*
74 * Return -1 is timer is expired, 0 if it isn't.
75 */
Hanno Becker7876d122020-02-05 10:39:31 +000076int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020077{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020078 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020079 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020080
81 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020082 {
83 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020084 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020086
87 return( 0 );
88}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089
TRodziewicz4ca18aa2021-05-20 14:46:20 +020090static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
91 unsigned char *buf,
92 size_t len,
93 mbedtls_record *rec );
94
95int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t buflen )
98{
99 int ret = 0;
100 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
101 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
102
103 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200104 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200105 */
106 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
107 {
108 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
109 goto exit;
110 }
111#if defined(MBEDTLS_SSL_PROTO_DTLS)
112 else
113 {
114 mbedtls_record rec;
115
116 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
117 if( ret != 0 )
118 {
119 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
120 goto exit;
121 }
122
123 if( ssl->transform_in != NULL )
124 {
125 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
126 if( ret != 0 )
127 {
128 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
129 goto exit;
130 }
131 }
132 }
133#endif /* MBEDTLS_SSL_PROTO_DTLS */
134
135exit:
136 /* On success, we have decrypted the buffer in-place, so make
137 * sure we don't leak any plaintext data. */
138 mbedtls_platform_zeroize( buf, buflen );
139
140 /* For the purpose of this API, treat messages with unexpected CID
141 * as well as such from future epochs as unexpected. */
142 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
143 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
144 {
145 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
146 }
147
148 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
149 return( ret );
150}
151
Hanno Becker67bc7c32018-08-06 11:33:50 +0100152#define SSL_DONT_FORCE_FLUSH 0
153#define SSL_FORCE_FLUSH 1
154
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100156
Hanno Beckerd5847772018-08-28 10:09:23 +0100157/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100158static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
159 uint8_t slot );
160static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
162static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
163static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100164static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
165 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100166static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100167
Hanno Becker11682cc2018-08-22 14:41:02 +0100168static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100169{
Hanno Becker89490712020-02-05 10:50:12 +0000170 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000171#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
172 size_t out_buf_len = ssl->out_buf_len;
173#else
174 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
175#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176
Darryl Greenb33cc762019-11-28 14:29:44 +0000177 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100178 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100179
Darryl Greenb33cc762019-11-28 14:29:44 +0000180 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100181}
182
Hanno Becker67bc7c32018-08-06 11:33:50 +0100183static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
184{
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 size_t const bytes_written = ssl->out_left;
186 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100187
188 /* Double-check that the write-index hasn't gone
189 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100190 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100191 {
192 /* Should never happen... */
193 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
194 }
195
196 return( (int) ( mtu - bytes_written ) );
197}
198
199static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
200{
Janos Follath865b3eb2019-12-16 11:46:15 +0000201 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100202 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400203 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100204
205#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400206 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100207
208 if( max_len > mfl )
209 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100210
211 /* By the standard (RFC 6066 Sect. 4), the MFL extension
212 * only limits the maximum record payload size, so in theory
213 * we would be allowed to pack multiple records of payload size
214 * MFL into a single datagram. However, this would mean that there's
215 * no way to explicitly communicate MTU restrictions to the peer.
216 *
217 * The following reduction of max_len makes sure that we never
218 * write datagrams larger than MFL + Record Expansion Overhead.
219 */
220 if( max_len <= ssl->out_left )
221 return( 0 );
222
223 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100224#endif
225
226 ret = ssl_get_remaining_space_in_datagram( ssl );
227 if( ret < 0 )
228 return( ret );
229 remaining = (size_t) ret;
230
231 ret = mbedtls_ssl_get_record_expansion( ssl );
232 if( ret < 0 )
233 return( ret );
234 expansion = (size_t) ret;
235
236 if( remaining <= expansion )
237 return( 0 );
238
239 remaining -= expansion;
240 if( remaining >= max_len )
241 remaining = max_len;
242
243 return( (int) remaining );
244}
245
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200246/*
247 * Double the retransmit timeout value, within the allowed range,
248 * returning -1 if the maximum value has already been reached.
249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200251{
252 uint32_t new_timeout;
253
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200254 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200255 return( -1 );
256
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200257 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
258 * in the following way: after the initial transmission and a first
259 * retransmission, back off to a temporary estimated MTU of 508 bytes.
260 * This value is guaranteed to be deliverable (if not guaranteed to be
261 * delivered) of any compliant IPv4 (and IPv6) network, and should work
262 * on most non-IP stacks too. */
263 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400264 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200265 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
267 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200268
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200269 new_timeout = 2 * ssl->handshake->retransmit_timeout;
270
271 /* Avoid arithmetic overflow and range overflow */
272 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200273 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200274 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200275 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 }
277
278 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000279 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
280 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200281
282 return( 0 );
283}
284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200286{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200287 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000288 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
289 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200290}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200292
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100293/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000294 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200295 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000296
Hanno Beckerccc13d02020-05-04 12:30:04 +0100297#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
298 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100299
300static size_t ssl_compute_padding_length( size_t len,
301 size_t granularity )
302{
303 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
304}
305
Hanno Becker581bc1b2020-05-04 12:20:03 +0100306/* This functions transforms a (D)TLS plaintext fragment and a record content
307 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
308 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
309 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100310 *
311 * struct {
312 * opaque content[DTLSPlaintext.length];
313 * ContentType real_type;
314 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100315 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100316 *
317 * Input:
318 * - `content`: The beginning of the buffer holding the
319 * plaintext to be wrapped.
320 * - `*content_size`: The length of the plaintext in Bytes.
321 * - `max_len`: The number of Bytes available starting from
322 * `content`. This must be `>= *content_size`.
323 * - `rec_type`: The desired record content type.
324 *
325 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100326 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
327 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100328 *
329 * Returns:
330 * - `0` on success.
331 * - A negative error code if `max_len` didn't offer enough space
332 * for the expansion.
333 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100334static int ssl_build_inner_plaintext( unsigned char *content,
335 size_t *content_size,
336 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100337 uint8_t rec_type,
338 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339{
340 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100341
342 /* Write real content type */
343 if( remaining == 0 )
344 return( -1 );
345 content[ len ] = rec_type;
346 len++;
347 remaining--;
348
349 if( remaining < pad )
350 return( -1 );
351 memset( content + len, 0, pad );
352 len += pad;
353 remaining -= pad;
354
355 *content_size = len;
356 return( 0 );
357}
358
Hanno Becker581bc1b2020-05-04 12:20:03 +0100359/* This function parses a (D)TLSInnerPlaintext structure.
360 * See ssl_build_inner_plaintext() for details. */
361static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100362 size_t *content_size,
363 uint8_t *rec_type )
364{
365 size_t remaining = *content_size;
366
367 /* Determine length of padding by skipping zeroes from the back. */
368 do
369 {
370 if( remaining == 0 )
371 return( -1 );
372 remaining--;
373 } while( content[ remaining ] == 0 );
374
375 *content_size = remaining;
376 *rec_type = content[ remaining ];
377
378 return( 0 );
379}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100380#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
381 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100382
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100383/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100384 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000385static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100386 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100387 mbedtls_record *rec,
388 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000389{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100390 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100391 *
392 * additional_data = seq_num + TLSCompressed.type +
393 * TLSCompressed.version + TLSCompressed.length;
394 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100395 * For the CID extension, this is extended as follows
396 * (quoting draft-ietf-tls-dtls-connection-id-05,
397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100398 *
399 * additional_data = seq_num + DTLSPlaintext.type +
400 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100401 * cid +
402 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100403 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100404 *
405 * For TLS 1.3, the record sequence number is dropped from the AAD
406 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100407 */
408
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100409 unsigned char *cur = add_data;
410
411#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
412 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
413#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
414 {
415 ((void) minor_ver);
416 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
417 cur += sizeof( rec->ctr );
418 }
419
420 *cur = rec->type;
421 cur++;
422
423 memcpy( cur, rec->ver, sizeof( rec->ver ) );
424 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100425
Hanno Beckera0e20d02019-05-15 14:03:01 +0100426#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100427 if( rec->cid_len != 0 )
428 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100429 memcpy( cur, rec->cid, rec->cid_len );
430 cur += rec->cid_len;
431
432 *cur = rec->cid_len;
433 cur++;
434
435 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
436 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
437 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100438 }
439 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100440#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100441 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100442 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
443 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
444 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100445 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100446
447 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000448}
449
Hanno Becker67a37db2020-05-28 16:27:07 +0100450#if defined(MBEDTLS_GCM_C) || \
451 defined(MBEDTLS_CCM_C) || \
452 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100453static int ssl_transform_aead_dynamic_iv_is_explicit(
454 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100455{
Hanno Becker17263802020-05-28 07:05:48 +0100456 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100457}
458
Hanno Becker17263802020-05-28 07:05:48 +0100459/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
460 *
461 * Concretely, this occurs in two variants:
462 *
463 * a) Fixed and dynamic IV lengths add up to total IV length, giving
464 * IV = fixed_iv || dynamic_iv
465 *
Hanno Becker15952812020-06-04 13:31:46 +0100466 * This variant is used in TLS 1.2 when used with GCM or CCM.
467 *
Hanno Becker17263802020-05-28 07:05:48 +0100468 * b) Fixed IV lengths matches total IV length, giving
469 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100470 *
471 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
472 *
473 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100474 *
475 * This function has the precondition that
476 *
477 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
478 *
479 * which has to be ensured by the caller. If this precondition
480 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100481 */
482static void ssl_build_record_nonce( unsigned char *dst_iv,
483 size_t dst_iv_len,
484 unsigned char const *fixed_iv,
485 size_t fixed_iv_len,
486 unsigned char const *dynamic_iv,
487 size_t dynamic_iv_len )
488{
489 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100490
491 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100492 memset( dst_iv, 0, dst_iv_len );
493 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100494
Hanno Becker17263802020-05-28 07:05:48 +0100495 dst_iv += dst_iv_len - dynamic_iv_len;
496 for( i = 0; i < dynamic_iv_len; i++ )
497 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100498}
Hanno Becker67a37db2020-05-28 16:27:07 +0100499#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100500
Hanno Beckera18d1322018-01-03 14:27:32 +0000501int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
502 mbedtls_ssl_transform *transform,
503 mbedtls_record *rec,
504 int (*f_rng)(void *, unsigned char *, size_t),
505 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000506{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200507 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100508 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000509 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100510 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100511 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000512 size_t post_avail;
513
514 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000515#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200516 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000517 ((void) ssl);
518#endif
519
520 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200521 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200522#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200523 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000524 ((void) f_rng);
525 ((void) p_rng);
526#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000529
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000530 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100531 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
533 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
534 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100535 if( rec == NULL
536 || rec->buf == NULL
537 || rec->buf_len < rec->data_offset
538 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100540 || rec->cid_len != 0
541#endif
542 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000543 {
544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100546 }
547
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000548 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100549 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000551 data, rec->data_len );
552
553 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
554
555 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
556 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
558 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000559 rec->data_len,
560 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000561 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
562 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100563
Hanno Becker92313402020-05-20 13:58:58 +0100564 /* The following two code paths implement the (D)TLSInnerPlaintext
565 * structure present in TLS 1.3 and DTLS 1.2 + CID.
566 *
567 * See ssl_build_inner_plaintext() for more information.
568 *
569 * Note that this changes `rec->data_len`, and hence
570 * `post_avail` needs to be recalculated afterwards.
571 *
572 * Note also that the two code paths cannot occur simultaneously
573 * since they apply to different versions of the protocol. There
574 * is hence no risk of double-addition of the inner plaintext.
575 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100576#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
577 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
578 {
Hanno Becker13996922020-05-28 16:15:19 +0100579 size_t padding =
580 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200581 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100582 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100583 &rec->data_len,
584 post_avail,
585 rec->type,
586 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100587 {
588 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
589 }
590
591 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
592 }
593#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
594
Hanno Beckera0e20d02019-05-15 14:03:01 +0100595#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100596 /*
597 * Add CID information
598 */
599 rec->cid_len = transform->out_cid_len;
600 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
601 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100602
603 if( rec->cid_len != 0 )
604 {
Hanno Becker13996922020-05-28 16:15:19 +0100605 size_t padding =
606 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200607 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100608 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100609 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100610 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100611 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100612 * Note that this changes `rec->data_len`, and hence
613 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100614 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100615 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616 &rec->data_len,
617 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100618 rec->type,
619 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100620 {
621 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
622 }
623
624 rec->type = MBEDTLS_SSL_MSG_CID;
625 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100626#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100627
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100628 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
629
Paul Bakker5121ce52009-01-03 21:22:43 +0000630 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100631 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000632 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000633#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634 if( mode == MBEDTLS_MODE_STREAM ||
635 ( mode == MBEDTLS_MODE_CBC
636#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000637 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100638#endif
639 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000640 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000641 if( post_avail < transform->maclen )
642 {
643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
644 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
645 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200646#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200647 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000648
TRodziewicz345165c2021-07-06 13:42:11 +0200649 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
650 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000651
TRodziewicz345165c2021-07-06 13:42:11 +0200652 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
653 add_data_len );
654 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
655 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
656 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657
TRodziewicz345165c2021-07-06 13:42:11 +0200658 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200659#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200660
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
662 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200663
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 rec->data_len += transform->maclen;
665 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100666 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200667 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000668#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000669
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200670 /*
671 * Encrypt
672 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000673#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000675 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000677 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000678 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000679 "including %d bytes of padding",
680 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
683 transform->iv_enc, transform->ivlen,
684 data, rec->data_len,
685 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200688 return( ret );
689 }
690
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000691 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
694 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200695 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000696 }
Paul Bakker68884e32013-01-07 18:20:04 +0100697 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000698#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000699
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200700#if defined(MBEDTLS_GCM_C) || \
701 defined(MBEDTLS_CCM_C) || \
702 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200704 mode == MBEDTLS_MODE_CCM ||
705 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000706 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200708 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100709 unsigned char *dynamic_iv;
710 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100711 int dynamic_iv_is_explicit =
712 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000713
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100714 /* Check that there's space for the authentication tag. */
715 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000716 {
717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
718 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
719 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000720
Paul Bakker68884e32013-01-07 18:20:04 +0100721 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100722 * Build nonce for AEAD encryption.
723 *
724 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
725 * part of the IV is prepended to the ciphertext and
726 * can be chosen freely - in particular, it need not
727 * agree with the record sequence number.
728 * However, since ChaChaPoly as well as all AEAD modes
729 * in TLS 1.3 use the record sequence number as the
730 * dynamic part of the nonce, we uniformly use the
731 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100732 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100733 dynamic_iv = rec->ctr;
734 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200735
Hanno Becker17263802020-05-28 07:05:48 +0100736 ssl_build_record_nonce( iv, sizeof( iv ),
737 transform->iv_enc,
738 transform->fixed_ivlen,
739 dynamic_iv,
740 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100741
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100742 /*
743 * Build additional data for AEAD encryption.
744 * This depends on the TLS version.
745 */
746 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
747 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100748
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200749 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100750 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200751 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100752 dynamic_iv,
753 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000754 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100755 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000756 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200757 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000758 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000759
Paul Bakker68884e32013-01-07 18:20:04 +0100760 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200761 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200762 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000763
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100764 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100766 add_data, add_data_len,
767 data, rec->data_len, /* src */
768 data, rec->buf_len - (data - rec->buf), /* dst */
769 &rec->data_len,
770 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200771 {
TRodziewicz18efb732021-04-29 23:12:19 +0200772 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200773 return( ret );
774 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000775 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100776 data + rec->data_len - transform->taglen,
777 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100778 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100780
781 /*
782 * Prefix record content with dynamic IV in case it is explicit.
783 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100784 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100785 {
786 if( rec->data_offset < dynamic_iv_len )
787 {
788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
789 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
790 }
791
792 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
793 rec->data_offset -= dynamic_iv_len;
794 rec->data_len += dynamic_iv_len;
795 }
796
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100797 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000798 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000799 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100800#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200801#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000803 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000804 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000805 size_t padlen, i;
806 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000807
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000808 /* Currently we're always using minimal padding
809 * (up to 255 bytes would be allowed). */
810 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
811 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000812 padlen = 0;
813
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000814 /* Check there's enough space in the buffer for the padding. */
815 if( post_avail < padlen + 1 )
816 {
817 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
818 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
819 }
820
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000822 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000823
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000824 rec->data_len += padlen + 1;
825 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000826
TRodziewicz0f82ec62021-05-12 17:49:18 +0200827#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000828 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200829 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000830 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000831 */
TRodziewicz345165c2021-07-06 13:42:11 +0200832 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000833 {
TRodziewicz345165c2021-07-06 13:42:11 +0200834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000836 }
TRodziewicz345165c2021-07-06 13:42:11 +0200837
838 if( rec->data_offset < transform->ivlen )
839 {
840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
841 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
842 }
843
844 /*
845 * Generate IV
846 */
847 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
848 if( ret != 0 )
849 return( ret );
850
851 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200852#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000853
Paul Elliottd48d5c62021-01-07 14:47:05 +0000854 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
855 "including %" MBEDTLS_PRINTF_SIZET
856 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000857 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200858 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000859
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000860 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
861 transform->iv_enc,
862 transform->ivlen,
863 data, rec->data_len,
864 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200867 return( ret );
868 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200869
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000870 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
873 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200874 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200875
TRodziewicz0f82ec62021-05-12 17:49:18 +0200876 data -= transform->ivlen;
877 rec->data_offset -= transform->ivlen;
878 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100881 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100882 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000883 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
884
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100885 /*
886 * MAC(MAC_write_key, seq_num +
887 * TLSCipherText.type +
888 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100889 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200890 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100891 * ENC(content + padding + padding_length));
892 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893
894 if( post_avail < transform->maclen)
895 {
896 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
897 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
898 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100899
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100900 ssl_extract_add_data_from_record( add_data, &add_data_len,
901 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000904 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100905 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100906
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000907 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100908 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 mbedtls_md_hmac_update( &transform->md_ctx_enc,
910 data, rec->data_len );
911 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
912 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100913
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000914 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100915
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916 rec->data_len += transform->maclen;
917 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100918 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100919 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000921 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200922 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200923#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200924 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
926 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200927 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000928
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100929 /* Make extra sure authentication was performed, exactly once */
930 if( auth_done != 1 )
931 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
933 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100934 }
935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000937
938 return( 0 );
939}
940
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200941#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200942
943/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200944 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200945 *
946 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
947 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200948 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +0200949MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200950 mbedtls_md_context_t *ctx,
951 const unsigned char *add_data, size_t add_data_len,
952 const unsigned char *data, size_t data_len_secret,
953 size_t min_data_len, size_t max_data_len,
954 unsigned char *output )
955{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200956 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200957 * This function breaks the HMAC abstraction and uses the md_clone()
958 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200959 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200960 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +0200961 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200962 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200963 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200964 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
965 * minlen, then cloning the context, and for each byte up to maxlen
966 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200967 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200968 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200969 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200970 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +0200971 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +0200972 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200973 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +0200974 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200975 const unsigned char * const okey = ikey + block_size;
976 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200977
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200978 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
979 mbedtls_md_context_t aux;
980 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +0200981 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200982
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200983 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +0200984
985#define MD_CHK( func_call ) \
986 do { \
987 ret = (func_call); \
988 if( ret != 0 ) \
989 goto cleanup; \
990 } while( 0 )
991
992 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200993
994 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
995 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +0200996 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
997 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +0200998
999 /* For each possible length, compute the hash up to that point */
1000 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001001 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001002 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1003 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001004 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001005 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1006 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001007
1008 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001009 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001010 }
1011
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001012 /* The context needs to finish() before it starts() again */
1013 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1014
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001015 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001016 MD_CHK( mbedtls_md_starts( ctx ) );
1017 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1018 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1019 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001020
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001021 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001022 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001023
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001024#undef MD_CHK
1025
1026cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001027 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001028 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001029}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001030#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001031
Hanno Becker605949f2019-07-12 08:23:59 +01001032int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001033 mbedtls_ssl_transform *transform,
1034 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001035{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001036 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001038 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001039#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001040 size_t padlen = 0, correct = 1;
1041#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001042 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001043 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001044 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001045
Hanno Beckera18d1322018-01-03 14:27:32 +00001046#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001047 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001048 ((void) ssl);
1049#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001052 if( rec == NULL ||
1053 rec->buf == NULL ||
1054 rec->buf_len < rec->data_offset ||
1055 rec->buf_len - rec->data_offset < rec->data_len )
1056 {
1057 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001059 }
1060
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001061 data = rec->buf + rec->data_offset;
1062 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001063
Hanno Beckera0e20d02019-05-15 14:03:01 +01001064#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001065 /*
1066 * Match record's CID with incoming CID.
1067 */
Hanno Becker938489a2019-05-08 13:02:22 +01001068 if( rec->cid_len != transform->in_cid_len ||
1069 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1070 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001071 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001072 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001073#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001074
Hanno Beckerd086bf02021-03-22 13:01:27 +00001075#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001077 {
1078 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001079 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1080 transform->iv_dec,
1081 transform->ivlen,
1082 data, rec->data_len,
1083 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001084 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001086 return( ret );
1087 }
1088
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001089 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001090 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1092 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001093 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001094 }
Paul Bakker68884e32013-01-07 18:20:04 +01001095 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001096#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001097#if defined(MBEDTLS_GCM_C) || \
1098 defined(MBEDTLS_CCM_C) || \
1099 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001101 mode == MBEDTLS_MODE_CCM ||
1102 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001103 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001104 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001105 unsigned char *dynamic_iv;
1106 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001107
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001108 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001109 * Extract dynamic part of nonce for AEAD decryption.
1110 *
1111 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1112 * part of the IV is prepended to the ciphertext and
1113 * can be chosen freely - in particular, it need not
1114 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001115 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001116 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001117 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001118 {
1119 if( rec->data_len < dynamic_iv_len )
1120 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001121 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1122 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001123 rec->data_len,
1124 dynamic_iv_len ) );
1125 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1126 }
1127 dynamic_iv = data;
1128
1129 data += dynamic_iv_len;
1130 rec->data_offset += dynamic_iv_len;
1131 rec->data_len -= dynamic_iv_len;
1132 }
Hanno Becker17263802020-05-28 07:05:48 +01001133 else
1134 {
1135 dynamic_iv = rec->ctr;
1136 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001137
1138 /* Check that there's space for the authentication tag. */
1139 if( rec->data_len < transform->taglen )
1140 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001141 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1142 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001143 rec->data_len,
1144 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001146 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001147 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001148
Hanno Beckerdf8be222020-05-21 15:30:57 +01001149 /*
1150 * Prepare nonce from dynamic and static parts.
1151 */
Hanno Becker17263802020-05-28 07:05:48 +01001152 ssl_build_record_nonce( iv, sizeof( iv ),
1153 transform->iv_dec,
1154 transform->fixed_ivlen,
1155 dynamic_iv,
1156 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001157
Hanno Beckerdf8be222020-05-21 15:30:57 +01001158 /*
1159 * Build additional data for AEAD encryption.
1160 * This depends on the TLS version.
1161 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001162 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1163 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001164 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001165 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001166
Hanno Beckerd96a6522019-07-10 13:55:25 +01001167 /* Because of the check above, we know that there are
1168 * explicit_iv_len Bytes preceeding data, and taglen
1169 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001170 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001171 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001172
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001173 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001174 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001175 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001176
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001177 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001178 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001179 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001180 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001181 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001182 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001183 data, rec->data_len + transform->taglen, /* src */
1184 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001185 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001186 {
TRodziewicz18efb732021-04-29 23:12:19 +02001187 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1190 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001191
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001192 return( ret );
1193 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001194 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001195
Hanno Beckerd96a6522019-07-10 13:55:25 +01001196 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001197 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001198 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1200 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001201 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001202 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001203 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001205#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001207 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001208 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001209
Paul Bakker5121ce52009-01-03 21:22:43 +00001210 /*
Paul Bakker45829992013-01-03 14:52:21 +01001211 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001212 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001213#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001214 /* The ciphertext is prefixed with the CBC IV. */
1215 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001216#endif
Paul Bakker45829992013-01-03 14:52:21 +01001217
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001218 /* Size considerations:
1219 *
1220 * - The CBC cipher text must not be empty and hence
1221 * at least of size transform->ivlen.
1222 *
1223 * Together with the potential IV-prefix, this explains
1224 * the first of the two checks below.
1225 *
1226 * - The record must contain a MAC, either in plain or
1227 * encrypted, depending on whether Encrypt-then-MAC
1228 * is used or not.
1229 * - If it is, the message contains the IV-prefix,
1230 * the CBC ciphertext, and the MAC.
1231 * - If it is not, the padded plaintext, and hence
1232 * the CBC ciphertext, has at least length maclen + 1
1233 * because there is at least the padding length byte.
1234 *
1235 * As the CBC ciphertext is not empty, both cases give the
1236 * lower bound minlen + maclen + 1 on the record size, which
1237 * we test for in the second check below.
1238 */
1239 if( rec->data_len < minlen + transform->ivlen ||
1240 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001241 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1243 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1244 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001245 "+ 1 ) ( + expl IV )", rec->data_len,
1246 transform->ivlen,
1247 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001249 }
1250
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001251 /*
1252 * Authenticate before decrypt if enabled
1253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001255 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001256 {
Hanno Becker992b6872017-11-09 18:57:39 +00001257 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001260
Hanno Beckerd96a6522019-07-10 13:55:25 +01001261 /* Update data_len in tandem with add_data.
1262 *
1263 * The subtraction is safe because of the previous check
1264 * data_len >= minlen + maclen + 1.
1265 *
1266 * Afterwards, we know that data + data_len is followed by at
1267 * least maclen Bytes, which justifies the call to
1268 * mbedtls_ssl_safer_memcmp() below.
1269 *
1270 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001271 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001272 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1273 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001274
Hanno Beckerd96a6522019-07-10 13:55:25 +01001275 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001276 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1277 add_data_len );
1278 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1279 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001280 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1281 data, rec->data_len );
1282 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1283 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001284
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001285 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1286 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001287 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001288 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001289
Hanno Beckerd96a6522019-07-10 13:55:25 +01001290 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001291 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1292 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001293 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001296 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001297 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001298 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001300
1301 /*
1302 * Check length sanity
1303 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001304
1305 /* We know from above that data_len > minlen >= 0,
1306 * so the following check in particular implies that
1307 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001308 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001309 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1311 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001312 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001314 }
1315
TRodziewicz0f82ec62021-05-12 17:49:18 +02001316#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001317 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001318 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001319 */
TRodziewicz345165c2021-07-06 13:42:11 +02001320 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1321 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001322
TRodziewicz345165c2021-07-06 13:42:11 +02001323 data += transform->ivlen;
1324 rec->data_offset += transform->ivlen;
1325 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001326#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001327
Hanno Beckerd96a6522019-07-10 13:55:25 +01001328 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1329
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001330 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1331 transform->iv_dec, transform->ivlen,
1332 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001335 return( ret );
1336 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001337
Hanno Beckerd96a6522019-07-10 13:55:25 +01001338 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001339 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001340 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1342 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001343 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001344
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001345 /* Safe since data_len >= minlen + maclen + 1, so after having
1346 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001347 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1348 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001349 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001350
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001351 if( auth_done == 1 )
1352 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001353 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001354 rec->data_len,
1355 padlen + 1 );
1356 correct &= mask;
1357 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001358 }
1359 else
Paul Bakker45829992013-01-03 14:52:21 +01001360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001362 if( rec->data_len < transform->maclen + padlen + 1 )
1363 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1365 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1366 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001367 rec->data_len,
1368 transform->maclen,
1369 padlen + 1 ) );
1370 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001371#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001372
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001373 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001374 rec->data_len,
1375 transform->maclen + padlen + 1 );
1376 correct &= mask;
1377 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001378 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001379
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001380 padlen++;
1381
1382 /* Regardless of the validity of the padding,
1383 * we have data_len >= padlen here. */
1384
TRodziewicz0f82ec62021-05-12 17:49:18 +02001385#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001386 /* The padding check involves a series of up to 256
1387 * consecutive memory reads at the end of the record
1388 * plaintext buffer. In order to hide the length and
1389 * validity of the padding, always perform exactly
1390 * `min(256,plaintext_len)` reads (but take into account
1391 * only the last `padlen` bytes for the padding check). */
1392 size_t pad_count = 0;
1393 volatile unsigned char* const check = data;
1394
1395 /* Index of first padding byte; it has been ensured above
1396 * that the subtraction is safe. */
1397 size_t const padding_idx = rec->data_len - padlen;
1398 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1399 size_t const start_idx = rec->data_len - num_checks;
1400 size_t idx;
1401
1402 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001403 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001404 /* pad_count += (idx >= padding_idx) &&
1405 * (check[idx] == padlen - 1);
1406 */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001407 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1408 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1409 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001410 pad_count += mask & equal;
1411 }
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001412 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001413
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001415 if( padlen > 0 && correct == 0 )
1416 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001417#endif
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001418 padlen &= mbedtls_cf_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001419
TRodziewicz0f82ec62021-05-12 17:49:18 +02001420#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001421
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001422 /* If the padding was found to be invalid, padlen == 0
1423 * and the subtraction is safe. If the padding was found valid,
1424 * padlen hasn't been changed and the previous assertion
1425 * data_len >= padlen still holds. */
1426 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001427 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001428 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001429#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001430 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1432 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001433 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001434
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001435#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001437 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001438#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001439
1440 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001441 * Authenticate if not done yet.
1442 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001443 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001444#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001445 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001446 {
Hanno Becker992b6872017-11-09 18:57:39 +00001447 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001448 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001449
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001450 /* If the initial value of padlen was such that
1451 * data_len < maclen + padlen + 1, then padlen
1452 * got reset to 1, and the initial check
1453 * data_len >= minlen + maclen + 1
1454 * guarantees that at this point we still
1455 * have at least data_len >= maclen.
1456 *
1457 * If the initial value of padlen was such that
1458 * data_len >= maclen + padlen + 1, then we have
1459 * subtracted either padlen + 1 (if the padding was correct)
1460 * or 0 (if the padding was incorrect) since then,
1461 * hence data_len >= maclen in any case.
1462 */
1463 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001464 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1465 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001466
TRodziewicz0f82ec62021-05-12 17:49:18 +02001467#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001468 /*
1469 * The next two sizes are the minimum and maximum values of
1470 * data_len over all padlen values.
1471 *
1472 * They're independent of padlen, since we previously did
1473 * data_len -= padlen.
1474 *
1475 * Note that max_len + maclen is never more than the buffer
1476 * length, as we previously did in_msglen -= maclen too.
1477 */
1478 const size_t max_len = rec->data_len + padlen;
1479 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1480
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001481 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1482 add_data, add_data_len,
1483 data, rec->data_len, min_len, max_len,
1484 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001485 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001486 {
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001487 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cf_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001488 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001489 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001490
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001491 mbedtls_cf_memcpy_offset( mac_peer, data,
1492 rec->data_len,
1493 min_len, max_len,
1494 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001495#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001496
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001497#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001498 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001499 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001500#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001501
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001502 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001503 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001504 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505#if defined(MBEDTLS_SSL_DEBUG_ALL)
1506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001507#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001508 correct = 0;
1509 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001510 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001511 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001512
1513 /*
1514 * Finally check the correct flag
1515 */
1516 if( correct == 0 )
1517 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001518#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001519
1520 /* Make extra sure authentication was performed, exactly once */
1521 if( auth_done != 1 )
1522 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1524 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001525 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001526
Hanno Beckerccc13d02020-05-04 12:30:04 +01001527#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1528 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1529 {
1530 /* Remove inner padding and infer true content type. */
1531 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1532 &rec->type );
1533
1534 if( ret != 0 )
1535 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1536 }
1537#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1538
Hanno Beckera0e20d02019-05-15 14:03:01 +01001539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001540 if( rec->cid_len != 0 )
1541 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001542 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1543 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001544 if( ret != 0 )
1545 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1546 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001547#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001550
1551 return( 0 );
1552}
1553
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001554#undef MAC_NONE
1555#undef MAC_PLAINTEXT
1556#undef MAC_CIPHERTEXT
1557
Paul Bakker5121ce52009-01-03 21:22:43 +00001558/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001559 * Fill the input message buffer by appending data to it.
1560 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001561 *
1562 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1563 * available (from this read and/or a previous one). Otherwise, an error code
1564 * is returned (possibly EOF or WANT_READ).
1565 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001566 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1567 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1568 * since we always read a whole datagram at once.
1569 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001570 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001571 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001574{
Janos Follath865b3eb2019-12-16 11:46:15 +00001575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001576 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001577#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1578 size_t in_buf_len = ssl->in_buf_len;
1579#else
1580 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1581#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001584
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001585 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1586 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001588 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001590 }
1591
Darryl Greenb33cc762019-11-28 14:29:44 +00001592 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001593 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1595 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001596 }
1597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001599 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001600 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001601 uint32_t timeout;
1602
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001603 /*
1604 * The point is, we need to always read a full datagram at once, so we
1605 * sometimes read more then requested, and handle the additional data.
1606 * It could be the rest of the current record (while fetching the
1607 * header) and/or some other records in the same datagram.
1608 */
1609
1610 /*
1611 * Move to the next record in the already read datagram if applicable
1612 */
1613 if( ssl->next_record_offset != 0 )
1614 {
1615 if( ssl->in_left < ssl->next_record_offset )
1616 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1618 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001619 }
1620
1621 ssl->in_left -= ssl->next_record_offset;
1622
1623 if( ssl->in_left != 0 )
1624 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001625 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1626 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001627 ssl->next_record_offset ) );
1628 memmove( ssl->in_hdr,
1629 ssl->in_hdr + ssl->next_record_offset,
1630 ssl->in_left );
1631 }
1632
1633 ssl->next_record_offset = 0;
1634 }
1635
Paul Elliottd48d5c62021-01-07 14:47:05 +00001636 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1637 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001638 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001639
1640 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001641 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001642 */
1643 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001644 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001646 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001647 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001648
1649 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001650 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001651 * are not at the beginning of a new record, the caller did something
1652 * wrong.
1653 */
1654 if( ssl->in_left != 0 )
1655 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1657 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001658 }
1659
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001660 /*
1661 * Don't even try to read if time's out already.
1662 * This avoids by-passing the timer when repeatedly receiving messages
1663 * that will end up being dropped.
1664 */
Hanno Becker7876d122020-02-05 10:39:31 +00001665 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001666 {
1667 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001668 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001669 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001670 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001671 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001672 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001674 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001675 timeout = ssl->handshake->retransmit_timeout;
1676 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001677 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001678
Paul Elliott9f352112020-12-09 14:55:45 +00001679 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001680
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001681 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001682 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1683 timeout );
1684 else
1685 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1686
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001688
1689 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001691 }
1692
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001693 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001694 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001695 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001696 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001698 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001699 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001700 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1701 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001703 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001704 }
1705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001709 return( ret );
1710 }
1711
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001712 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001713 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001715 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001717 {
Hanno Becker786300f2020-02-05 10:46:40 +00001718 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001719 {
Hanno Becker786300f2020-02-05 10:46:40 +00001720 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1721 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001722 return( ret );
1723 }
1724
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001725 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001726 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001728 }
1729
Paul Bakker5121ce52009-01-03 21:22:43 +00001730 if( ret < 0 )
1731 return( ret );
1732
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001733 ssl->in_left = ret;
1734 }
1735 else
1736#endif
1737 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001738 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1739 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001740 ssl->in_left, nb_want ) );
1741
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001742 while( ssl->in_left < nb_want )
1743 {
1744 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001745
Hanno Becker7876d122020-02-05 10:39:31 +00001746 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001747 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1748 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001749 {
1750 if( ssl->f_recv_timeout != NULL )
1751 {
1752 ret = ssl->f_recv_timeout( ssl->p_bio,
1753 ssl->in_hdr + ssl->in_left, len,
1754 ssl->conf->read_timeout );
1755 }
1756 else
1757 {
1758 ret = ssl->f_recv( ssl->p_bio,
1759 ssl->in_hdr + ssl->in_left, len );
1760 }
1761 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001762
Paul Elliottd48d5c62021-01-07 14:47:05 +00001763 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1764 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001765 ssl->in_left, nb_want ) );
1766 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001767
1768 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001770
1771 if( ret < 0 )
1772 return( ret );
1773
makise-homuraaf9513b2020-08-24 18:26:27 +03001774 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001775 {
Darryl Green11999bb2018-03-13 15:22:58 +00001776 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001777 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001778 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001779 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1780 }
1781
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001782 ssl->in_left += ret;
1783 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001784 }
1785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001787
1788 return( 0 );
1789}
1790
1791/*
1792 * Flush any data not yet written
1793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001795{
Janos Follath865b3eb2019-12-16 11:46:15 +00001796 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001797 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001800
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001801 if( ssl->f_send == NULL )
1802 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001804 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001806 }
1807
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001808 /* Avoid incrementing counter if data is flushed */
1809 if( ssl->out_left == 0 )
1810 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001812 return( 0 );
1813 }
1814
Paul Bakker5121ce52009-01-03 21:22:43 +00001815 while( ssl->out_left > 0 )
1816 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1818 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001819 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001820
Hanno Becker2b1e3542018-08-06 11:19:13 +01001821 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001822 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001823
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001825
1826 if( ret <= 0 )
1827 return( ret );
1828
makise-homuraaf9513b2020-08-24 18:26:27 +03001829 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001830 {
Darryl Green11999bb2018-03-13 15:22:58 +00001831 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001832 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001833 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001834 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1835 }
1836
Paul Bakker5121ce52009-01-03 21:22:43 +00001837 ssl->out_left -= ret;
1838 }
1839
Hanno Becker2b1e3542018-08-06 11:19:13 +01001840#if defined(MBEDTLS_SSL_PROTO_DTLS)
1841 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001842 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001843 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001844 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001845 else
1846#endif
1847 {
1848 ssl->out_hdr = ssl->out_buf + 8;
1849 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001850 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001853
1854 return( 0 );
1855}
1856
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001857/*
1858 * Functions to handle the DTLS retransmission state machine
1859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001861/*
1862 * Append current handshake message to current outgoing flight
1863 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001865{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001867 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1868 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1869 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001870
1871 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001872 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001873 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001874 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001876 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001877 }
1878
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001879 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001880 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001881 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1882 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001884 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001885 }
1886
1887 /* Copy current handshake message with headers */
1888 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1889 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001890 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001891 msg->next = NULL;
1892
1893 /* Append to the current flight */
1894 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001895 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001896 else
1897 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001899 while( cur->next != NULL )
1900 cur = cur->next;
1901 cur->next = msg;
1902 }
1903
Hanno Becker3b235902018-08-06 09:54:53 +01001904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001905 return( 0 );
1906}
1907
1908/*
1909 * Free the current flight of handshake messages
1910 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001911void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001912{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 mbedtls_ssl_flight_item *cur = flight;
1914 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001915
1916 while( cur != NULL )
1917 {
1918 next = cur->next;
1919
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 mbedtls_free( cur->p );
1921 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001922
1923 cur = next;
1924 }
1925}
1926
1927/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001928 * Swap transform_out and out_ctr with the alternative ones
1929 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001930static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001931{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001933 unsigned char tmp_out_ctr[8];
1934
1935 if( ssl->transform_out == ssl->handshake->alt_transform_out )
1936 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001938 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001939 }
1940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001942
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001943 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001944 tmp_transform = ssl->transform_out;
1945 ssl->transform_out = ssl->handshake->alt_transform_out;
1946 ssl->handshake->alt_transform_out = tmp_transform;
1947
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001948 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01001949 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
1950 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001951 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001952
1953 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001954 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001955
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001956 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001957}
1958
1959/*
1960 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001961 */
1962int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
1963{
1964 int ret = 0;
1965
1966 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
1967
1968 ret = mbedtls_ssl_flight_transmit( ssl );
1969
1970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
1971
1972 return( ret );
1973}
1974
1975/*
1976 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001977 *
1978 * Need to remember the current message in case flush_output returns
1979 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001980 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001981 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001982int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001983{
Janos Follath865b3eb2019-12-16 11:46:15 +00001984 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001988 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001990
1991 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001992 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001993 ret = ssl_swap_epochs( ssl );
1994 if( ret != 0 )
1995 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001998 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001999
2000 while( ssl->handshake->cur_msg != NULL )
2001 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002002 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002003 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002004
Hanno Beckere1dcb032018-08-17 16:47:58 +01002005 int const is_finished =
2006 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2007 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2008
Hanno Becker04da1892018-08-14 13:22:10 +01002009 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2010 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2011
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002012 /* Swap epochs before sending Finished: we can't do it after
2013 * sending ChangeCipherSpec, in case write returns WANT_READ.
2014 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002015 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002016 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002017 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002018 ret = ssl_swap_epochs( ssl );
2019 if( ret != 0 )
2020 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002021 }
2022
Hanno Becker67bc7c32018-08-06 11:33:50 +01002023 ret = ssl_get_remaining_payload_in_datagram( ssl );
2024 if( ret < 0 )
2025 return( ret );
2026 max_frag_len = (size_t) ret;
2027
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002028 /* CCS is copied as is, while HS messages may need fragmentation */
2029 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2030 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002031 if( max_frag_len == 0 )
2032 {
2033 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2034 return( ret );
2035
2036 continue;
2037 }
2038
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002039 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002040 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002041 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002042
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002043 /* Update position inside current message */
2044 ssl->handshake->cur_msg_p += cur->len;
2045 }
2046 else
2047 {
2048 const unsigned char * const p = ssl->handshake->cur_msg_p;
2049 const size_t hs_len = cur->len - 12;
2050 const size_t frag_off = p - ( cur->p + 12 );
2051 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002052 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002053
Hanno Beckere1dcb032018-08-17 16:47:58 +01002054 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002055 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002056 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002057 {
2058 ret = ssl_swap_epochs( ssl );
2059 if( ret != 0 )
2060 return( ret );
2061 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002062
Hanno Becker67bc7c32018-08-06 11:33:50 +01002063 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2064 return( ret );
2065
2066 continue;
2067 }
2068 max_hs_frag_len = max_frag_len - 12;
2069
2070 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2071 max_hs_frag_len : rem_len;
2072
2073 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002074 {
2075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002076 (unsigned) cur_hs_frag_len,
2077 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002078 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002079
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002080 /* Messages are stored with handshake headers as if not fragmented,
2081 * copy beginning of headers then fill fragmentation fields.
2082 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2083 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002084
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002085 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2086 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2087 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2088
Hanno Becker67bc7c32018-08-06 11:33:50 +01002089 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2090 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2091 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002092
2093 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2094
Hanno Becker3f7b9732018-08-28 09:53:25 +01002095 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002096 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2097 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002098 ssl->out_msgtype = cur->type;
2099
2100 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002101 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002102 }
2103
2104 /* If done with the current message move to the next one if any */
2105 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2106 {
2107 if( cur->next != NULL )
2108 {
2109 ssl->handshake->cur_msg = cur->next;
2110 ssl->handshake->cur_msg_p = cur->next->p + 12;
2111 }
2112 else
2113 {
2114 ssl->handshake->cur_msg = NULL;
2115 ssl->handshake->cur_msg_p = NULL;
2116 }
2117 }
2118
2119 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002120 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002121 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002123 return( ret );
2124 }
2125 }
2126
Hanno Becker67bc7c32018-08-06 11:33:50 +01002127 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2128 return( ret );
2129
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002130 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002131 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2132 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002133 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002134 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002136 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002137 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002138
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002140
2141 return( 0 );
2142}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002143
2144/*
2145 * To be called when the last message of an incoming flight is received.
2146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002147void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002148{
2149 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002150 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002151 ssl->handshake->flight = NULL;
2152 ssl->handshake->cur_msg = NULL;
2153
2154 /* The next incoming flight will start with this msg_seq */
2155 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2156
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002157 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002158 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002159
Hanno Becker0271f962018-08-16 13:23:47 +01002160 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002161 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002162
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002163 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002164 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2167 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002168 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002170 }
2171 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002173}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002174
2175/*
2176 * To be called when the last message of an outgoing flight is send.
2177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002179{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002180 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002181 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2184 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002185 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002187 }
2188 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002190}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002192
Paul Bakker5121ce52009-01-03 21:22:43 +00002193/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002194 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002195 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002196
2197/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002198 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002199 *
2200 * - fill in handshake headers
2201 * - update handshake checksum
2202 * - DTLS: save message for resending
2203 * - then pass to the record layer
2204 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002205 * DTLS: except for HelloRequest, messages are only queued, and will only be
2206 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002207 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002208 * Inputs:
2209 * - ssl->out_msglen: 4 + actual handshake message len
2210 * (4 is the size of handshake headers for TLS)
2211 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2212 * - ssl->out_msg + 4: the handshake message body
2213 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002214 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002215 * - ssl->out_msglen: the length of the record contents
2216 * (including handshake headers but excluding record headers)
2217 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002218 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002219int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002220{
Janos Follath865b3eb2019-12-16 11:46:15 +00002221 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002222 const size_t hs_len = ssl->out_msglen - 4;
2223 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002224
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002225 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2226
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002227 /*
2228 * Sanity checks
2229 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002230 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002231 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2232 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002233 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2234 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002235 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002236
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002237 /* Whenever we send anything different from a
2238 * HelloRequest we should be in a handshake - double check. */
2239 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2240 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002241 ssl->handshake == NULL )
2242 {
2243 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2244 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2245 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002248 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002249 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002251 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002252 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2253 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002255#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002256
Hanno Beckerb50a2532018-08-06 11:52:54 +01002257 /* Double-check that we did not exceed the bounds
2258 * of the outgoing record buffer.
2259 * This should never fail as the various message
2260 * writing functions must obey the bounds of the
2261 * outgoing record buffer, but better be safe.
2262 *
2263 * Note: We deliberately do not check for the MTU or MFL here.
2264 */
2265 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2266 {
2267 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002268 "size %" MBEDTLS_PRINTF_SIZET
2269 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002270 ssl->out_msglen,
2271 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002272 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2273 }
2274
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002275 /*
2276 * Fill handshake headers
2277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002279 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002280 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2281 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2282 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002283
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002284 /*
2285 * DTLS has additional fields in the Handshake layer,
2286 * between the length field and the actual payload:
2287 * uint16 message_seq;
2288 * uint24 fragment_offset;
2289 * uint24 fragment_length;
2290 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002291#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002292 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002293 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002294 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002295 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002296 {
2297 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002298 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002299 hs_len,
2300 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002301 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2302 }
2303
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002304 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002305 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002306
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002307 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002308 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002309 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002310 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2311 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2312 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002313 }
2314 else
2315 {
2316 ssl->out_msg[4] = 0;
2317 ssl->out_msg[5] = 0;
2318 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002319
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002320 /* Handshake hashes are computed without fragmentation,
2321 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002322 memset( ssl->out_msg + 6, 0x00, 3 );
2323 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002324 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002326
Hanno Becker0207e532018-08-28 10:28:28 +01002327 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002328 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2329 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002330 }
2331
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002332 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002333#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002334 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002335 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2336 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002337 {
2338 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2339 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002341 return( ret );
2342 }
2343 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002344 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002345#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002346 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002347 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002348 {
2349 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2350 return( ret );
2351 }
2352 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002353
2354 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2355
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002356 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002357}
2358
2359/*
2360 * Record layer functions
2361 */
2362
2363/*
2364 * Write current record.
2365 *
2366 * Uses:
2367 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2368 * - ssl->out_msglen: length of the record content (excl headers)
2369 * - ssl->out_msg: record content
2370 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002371int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002372{
2373 int ret, done = 0;
2374 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002375 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002376
2377 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002378
Paul Bakker05ef8352012-05-08 09:17:57 +00002379 if( !done )
2380 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002381 unsigned i;
2382 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002383#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2384 size_t out_buf_len = ssl->out_buf_len;
2385#else
2386 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2387#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002388 /* Skip writing the record content type to after the encryption,
2389 * as it may change when using the CID extension. */
2390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002392 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002393
Hanno Becker19859472018-08-06 09:40:20 +01002394 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002395 ssl->out_len[0] = (unsigned char)( len >> 8 );
2396 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002397
Paul Bakker48916f92012-09-16 19:57:18 +00002398 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002399 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002400 mbedtls_record rec;
2401
2402 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002403 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002404 rec.data_len = ssl->out_msglen;
2405 rec.data_offset = ssl->out_msg - rec.buf;
2406
2407 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2408 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2409 ssl->conf->transport, rec.ver );
2410 rec.type = ssl->out_msgtype;
2411
Hanno Beckera0e20d02019-05-15 14:03:01 +01002412#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002413 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002414 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002415#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002416
Hanno Beckera18d1322018-01-03 14:27:32 +00002417 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002418 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002419 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002421 return( ret );
2422 }
2423
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002424 if( rec.data_offset != 0 )
2425 {
2426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2427 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2428 }
2429
Hanno Becker6430faf2019-05-08 11:57:13 +01002430 /* Update the record content type and CID. */
2431 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002432#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002433 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002434#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002435 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002436 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2437 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002438 }
2439
Hanno Becker5903de42019-05-03 14:46:38 +01002440 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002441
2442#if defined(MBEDTLS_SSL_PROTO_DTLS)
2443 /* In case of DTLS, double-check that we don't exceed
2444 * the remaining space in the datagram. */
2445 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2446 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002447 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002448 if( ret < 0 )
2449 return( ret );
2450
2451 if( protected_record_size > (size_t) ret )
2452 {
2453 /* Should never happen */
2454 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2455 }
2456 }
2457#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002458
Hanno Becker6430faf2019-05-08 11:57:13 +01002459 /* Now write the potentially updated record content type. */
2460 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2461
Paul Elliott9f352112020-12-09 14:55:45 +00002462 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002463 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002464 ssl->out_hdr[0], ssl->out_hdr[1],
2465 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002468 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002469
2470 ssl->out_left += protected_record_size;
2471 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002472 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002473
Hanno Beckerdd772292020-02-05 10:38:31 +00002474 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002475 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2476 break;
2477
2478 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002479 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002480 {
2481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2482 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2483 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002484 }
2485
Hanno Becker67bc7c32018-08-06 11:33:50 +01002486#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002487 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2488 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002489 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002490 size_t remaining;
2491 ret = ssl_get_remaining_payload_in_datagram( ssl );
2492 if( ret < 0 )
2493 {
2494 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2495 ret );
2496 return( ret );
2497 }
2498
2499 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002500 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002501 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002502 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002503 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002504 else
2505 {
Hanno Becker513815a2018-08-20 11:56:09 +01002506 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002507 }
2508 }
2509#endif /* MBEDTLS_SSL_PROTO_DTLS */
2510
2511 if( ( flush == SSL_FORCE_FLUSH ) &&
2512 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002513 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002515 return( ret );
2516 }
2517
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002519
2520 return( 0 );
2521}
2522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002524
2525static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2526{
2527 if( ssl->in_msglen < ssl->in_hslen ||
2528 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2529 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2530 {
2531 return( 1 );
2532 }
2533 return( 0 );
2534}
Hanno Becker44650b72018-08-16 12:51:11 +01002535
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002536static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002537{
2538 return( ( ssl->in_msg[9] << 16 ) |
2539 ( ssl->in_msg[10] << 8 ) |
2540 ssl->in_msg[11] );
2541}
2542
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002543static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002544{
2545 return( ( ssl->in_msg[6] << 16 ) |
2546 ( ssl->in_msg[7] << 8 ) |
2547 ssl->in_msg[8] );
2548}
2549
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002550static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002551{
2552 uint32_t msg_len, frag_off, frag_len;
2553
2554 msg_len = ssl_get_hs_total_len( ssl );
2555 frag_off = ssl_get_hs_frag_off( ssl );
2556 frag_len = ssl_get_hs_frag_len( ssl );
2557
2558 if( frag_off > msg_len )
2559 return( -1 );
2560
2561 if( frag_len > msg_len - frag_off )
2562 return( -1 );
2563
2564 if( frag_len + 12 > ssl->in_msglen )
2565 return( -1 );
2566
2567 return( 0 );
2568}
2569
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002570/*
2571 * Mark bits in bitmask (used for DTLS HS reassembly)
2572 */
2573static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2574{
2575 unsigned int start_bits, end_bits;
2576
2577 start_bits = 8 - ( offset % 8 );
2578 if( start_bits != 8 )
2579 {
2580 size_t first_byte_idx = offset / 8;
2581
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002582 /* Special case */
2583 if( len <= start_bits )
2584 {
2585 for( ; len != 0; len-- )
2586 mask[first_byte_idx] |= 1 << ( start_bits - len );
2587
2588 /* Avoid potential issues with offset or len becoming invalid */
2589 return;
2590 }
2591
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002592 offset += start_bits; /* Now offset % 8 == 0 */
2593 len -= start_bits;
2594
2595 for( ; start_bits != 0; start_bits-- )
2596 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2597 }
2598
2599 end_bits = len % 8;
2600 if( end_bits != 0 )
2601 {
2602 size_t last_byte_idx = ( offset + len ) / 8;
2603
2604 len -= end_bits; /* Now len % 8 == 0 */
2605
2606 for( ; end_bits != 0; end_bits-- )
2607 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2608 }
2609
2610 memset( mask + offset / 8, 0xFF, len / 8 );
2611}
2612
2613/*
2614 * Check that bitmask is full
2615 */
2616static int ssl_bitmask_check( unsigned char *mask, size_t len )
2617{
2618 size_t i;
2619
2620 for( i = 0; i < len / 8; i++ )
2621 if( mask[i] != 0xFF )
2622 return( -1 );
2623
2624 for( i = 0; i < len % 8; i++ )
2625 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2626 return( -1 );
2627
2628 return( 0 );
2629}
2630
Hanno Becker56e205e2018-08-16 09:06:12 +01002631/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002632static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002633 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002634{
Hanno Becker56e205e2018-08-16 09:06:12 +01002635 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002636
Hanno Becker56e205e2018-08-16 09:06:12 +01002637 alloc_len = 12; /* Handshake header */
2638 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002639
Hanno Beckerd07df862018-08-16 09:14:58 +01002640 if( add_bitmap )
2641 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002642
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002643 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002644}
Hanno Becker56e205e2018-08-16 09:06:12 +01002645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002647
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002648static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002649{
2650 return( ( ssl->in_msg[1] << 16 ) |
2651 ( ssl->in_msg[2] << 8 ) |
2652 ssl->in_msg[3] );
2653}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002654
Simon Butcher99000142016-10-13 17:21:01 +01002655int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002656{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002658 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002660 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002662 }
2663
Hanno Becker12555c62018-08-16 12:47:53 +01002664 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002667 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002668 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002671 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002672 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002674 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002675
Hanno Becker44650b72018-08-16 12:51:11 +01002676 if( ssl_check_hs_header( ssl ) != 0 )
2677 {
2678 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2679 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2680 }
2681
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002682 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002683 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2684 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2685 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2686 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002687 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002688 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2689 {
2690 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2691 recv_msg_seq,
2692 ssl->handshake->in_msg_seq ) );
2693 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2694 }
2695
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002696 /* Retransmit only on last message from previous flight, to avoid
2697 * too many retransmissions.
2698 * Besides, No sane server ever retransmits HelloVerifyRequest */
2699 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002701 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002703 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002704 recv_msg_seq,
2705 ssl->handshake->in_flight_start_seq ) );
2706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002708 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002710 return( ret );
2711 }
2712 }
2713 else
2714 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002716 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002717 recv_msg_seq,
2718 ssl->handshake->in_msg_seq ) );
2719 }
2720
Hanno Becker90333da2017-10-10 11:27:13 +01002721 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002722 }
2723 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002724
Hanno Becker6d97ef52018-08-16 13:09:04 +01002725 /* Message reassembly is handled alongside buffering of future
2726 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002727 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002728 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002729 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002732 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002733 }
2734 }
2735 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002737 /* With TLS we don't handle fragmentation (for now) */
2738 if( ssl->in_msglen < ssl->in_hslen )
2739 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2741 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002742 }
2743
Simon Butcher99000142016-10-13 17:21:01 +01002744 return( 0 );
2745}
2746
2747void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2748{
Hanno Becker0271f962018-08-16 13:23:47 +01002749 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002750
Hanno Becker0271f962018-08-16 13:23:47 +01002751 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002752 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002753 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002754 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002755
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002756 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002758 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002759 ssl->handshake != NULL )
2760 {
Hanno Becker0271f962018-08-16 13:23:47 +01002761 unsigned offset;
2762 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002763
Hanno Becker0271f962018-08-16 13:23:47 +01002764 /* Increment handshake sequence number */
2765 hs->in_msg_seq++;
2766
2767 /*
2768 * Clear up handshake buffering and reassembly structure.
2769 */
2770
2771 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002772 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002773
2774 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002775 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2776 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002777 offset++, hs_buf++ )
2778 {
2779 *hs_buf = *(hs_buf + 1);
2780 }
2781
2782 /* Create a fresh last entry */
2783 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002784 }
2785#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002786}
2787
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002788/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002789 * DTLS anti-replay: RFC 6347 4.1.2.6
2790 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002791 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2792 * Bit n is set iff record number in_window_top - n has been seen.
2793 *
2794 * Usually, in_window_top is the last record number seen and the lsb of
2795 * in_window is set. The only exception is the initial state (record number 0
2796 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002799void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002800{
2801 ssl->in_window_top = 0;
2802 ssl->in_window = 0;
2803}
2804
2805static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2806{
2807 return( ( (uint64_t) buf[0] << 40 ) |
2808 ( (uint64_t) buf[1] << 32 ) |
2809 ( (uint64_t) buf[2] << 24 ) |
2810 ( (uint64_t) buf[3] << 16 ) |
2811 ( (uint64_t) buf[4] << 8 ) |
2812 ( (uint64_t) buf[5] ) );
2813}
2814
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002815static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2816{
Janos Follath865b3eb2019-12-16 11:46:15 +00002817 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002818 unsigned char *original_in_ctr;
2819
2820 // save original in_ctr
2821 original_in_ctr = ssl->in_ctr;
2822
2823 // use counter from record
2824 ssl->in_ctr = record_in_ctr;
2825
2826 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2827
2828 // restore the counter
2829 ssl->in_ctr = original_in_ctr;
2830
2831 return ret;
2832}
2833
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002834/*
2835 * Return 0 if sequence number is acceptable, -1 otherwise
2836 */
Hanno Becker0183d692019-07-12 08:50:37 +01002837int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002838{
2839 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2840 uint64_t bit;
2841
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002842 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002843 return( 0 );
2844
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002845 if( rec_seqnum > ssl->in_window_top )
2846 return( 0 );
2847
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002848 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002849
2850 if( bit >= 64 )
2851 return( -1 );
2852
2853 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2854 return( -1 );
2855
2856 return( 0 );
2857}
2858
2859/*
2860 * Update replay window on new validated record
2861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002863{
2864 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2865
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002866 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002867 return;
2868
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002869 if( rec_seqnum > ssl->in_window_top )
2870 {
2871 /* Update window_top and the contents of the window */
2872 uint64_t shift = rec_seqnum - ssl->in_window_top;
2873
2874 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002875 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002876 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002877 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002878 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002879 ssl->in_window |= 1;
2880 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002881
2882 ssl->in_window_top = rec_seqnum;
2883 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002884 else
2885 {
2886 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002887 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002888
2889 if( bit < 64 ) /* Always true, but be extra sure */
2890 ssl->in_window |= (uint64_t) 1 << bit;
2891 }
2892}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002894
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002895#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002896/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002897 * Without any SSL context, check if a datagram looks like a ClientHello with
2898 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002899 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002900 *
2901 * - if cookie is valid, return 0
2902 * - if ClientHello looks superficially valid but cookie is not,
2903 * fill obuf and set olen, then
2904 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2905 * - otherwise return a specific error code
2906 */
2907static int ssl_check_dtls_clihlo_cookie(
2908 mbedtls_ssl_cookie_write_t *f_cookie_write,
2909 mbedtls_ssl_cookie_check_t *f_cookie_check,
2910 void *p_cookie,
2911 const unsigned char *cli_id, size_t cli_id_len,
2912 const unsigned char *in, size_t in_len,
2913 unsigned char *obuf, size_t buf_len, size_t *olen )
2914{
2915 size_t sid_len, cookie_len;
2916 unsigned char *p;
2917
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002918 /*
2919 * Structure of ClientHello with record and handshake headers,
2920 * and expected values. We don't need to check a lot, more checks will be
2921 * done when actually parsing the ClientHello - skipping those checks
2922 * avoids code duplication and does not make cookie forging any easier.
2923 *
2924 * 0-0 ContentType type; copied, must be handshake
2925 * 1-2 ProtocolVersion version; copied
2926 * 3-4 uint16 epoch; copied, must be 0
2927 * 5-10 uint48 sequence_number; copied
2928 * 11-12 uint16 length; (ignored)
2929 *
2930 * 13-13 HandshakeType msg_type; (ignored)
2931 * 14-16 uint24 length; (ignored)
2932 * 17-18 uint16 message_seq; copied
2933 * 19-21 uint24 fragment_offset; copied, must be 0
2934 * 22-24 uint24 fragment_length; (ignored)
2935 *
2936 * 25-26 ProtocolVersion client_version; (ignored)
2937 * 27-58 Random random; (ignored)
2938 * 59-xx SessionID session_id; 1 byte len + sid_len content
2939 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
2940 * ...
2941 *
2942 * Minimum length is 61 bytes.
2943 */
2944 if( in_len < 61 ||
2945 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
2946 in[3] != 0 || in[4] != 0 ||
2947 in[19] != 0 || in[20] != 0 || in[21] != 0 )
2948 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01002949 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002950 }
2951
2952 sid_len = in[59];
2953 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002954 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002955
2956 cookie_len = in[60 + sid_len];
2957 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002958 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002959
2960 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
2961 cli_id, cli_id_len ) == 0 )
2962 {
2963 /* Valid cookie */
2964 return( 0 );
2965 }
2966
2967 /*
2968 * If we get here, we've got an invalid cookie, let's prepare HVR.
2969 *
2970 * 0-0 ContentType type; copied
2971 * 1-2 ProtocolVersion version; copied
2972 * 3-4 uint16 epoch; copied
2973 * 5-10 uint48 sequence_number; copied
2974 * 11-12 uint16 length; olen - 13
2975 *
2976 * 13-13 HandshakeType msg_type; hello_verify_request
2977 * 14-16 uint24 length; olen - 25
2978 * 17-18 uint16 message_seq; copied
2979 * 19-21 uint24 fragment_offset; copied
2980 * 22-24 uint24 fragment_length; olen - 25
2981 *
2982 * 25-26 ProtocolVersion server_version; 0xfe 0xff
2983 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
2984 *
2985 * Minimum length is 28.
2986 */
2987 if( buf_len < 28 )
2988 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
2989
2990 /* Copy most fields and adapt others */
2991 memcpy( obuf, in, 25 );
2992 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
2993 obuf[25] = 0xfe;
2994 obuf[26] = 0xff;
2995
2996 /* Generate and write actual cookie */
2997 p = obuf + 28;
2998 if( f_cookie_write( p_cookie,
2999 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3000 {
3001 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3002 }
3003
3004 *olen = p - obuf;
3005
3006 /* Go back and fill length fields */
3007 obuf[27] = (unsigned char)( *olen - 28 );
3008
3009 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3010 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3011 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3012
3013 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3014 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3015
3016 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3017}
3018
3019/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003020 * Handle possible client reconnect with the same UDP quadruplet
3021 * (RFC 6347 Section 4.2.8).
3022 *
3023 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3024 * that looks like a ClientHello.
3025 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003026 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003027 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003028 * - if the input looks like a ClientHello with a valid cookie,
3029 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003030 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003031 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003032 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003033 * This function is called (through ssl_check_client_reconnect()) when an
3034 * unexpected record is found in ssl_get_next_record(), which will discard the
3035 * record if we return 0, and bubble up the return value otherwise (this
3036 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3037 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003038 */
3039static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3040{
Janos Follath865b3eb2019-12-16 11:46:15 +00003041 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003042 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003043
Hanno Becker2fddd372019-07-10 14:37:41 +01003044 if( ssl->conf->f_cookie_write == NULL ||
3045 ssl->conf->f_cookie_check == NULL )
3046 {
3047 /* If we can't use cookies to verify reachability of the peer,
3048 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003049 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3050 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003051 return( 0 );
3052 }
3053
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003054 ret = ssl_check_dtls_clihlo_cookie(
3055 ssl->conf->f_cookie_write,
3056 ssl->conf->f_cookie_check,
3057 ssl->conf->p_cookie,
3058 ssl->cli_id, ssl->cli_id_len,
3059 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003060 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003061
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003062 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3063
3064 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003065 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003066 int send_ret;
3067 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3068 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3069 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003070 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003071 * If the error is permanent we'll catch it later,
3072 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003073 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3074 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3075 (void) send_ret;
3076
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003077 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003078 }
3079
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003080 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003081 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003082 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003083 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003084 {
3085 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3086 return( ret );
3087 }
3088
3089 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003090 }
3091
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003092 return( ret );
3093}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003094#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003095
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003096static int ssl_check_record_type( uint8_t record_type )
3097{
3098 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3099 record_type != MBEDTLS_SSL_MSG_ALERT &&
3100 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3101 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3102 {
3103 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3104 }
3105
3106 return( 0 );
3107}
3108
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003109/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003110 * ContentType type;
3111 * ProtocolVersion version;
3112 * uint16 epoch; // DTLS only
3113 * uint48 sequence_number; // DTLS only
3114 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003115 *
3116 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003117 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003118 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3119 *
3120 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003121 * 1. proceed with the record if this function returns 0
3122 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3123 * 3. return CLIENT_RECONNECT if this function return that value
3124 * 4. drop the whole datagram if this function returns anything else.
3125 * Point 2 is needed when the peer is resending, and we have already received
3126 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003127 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003128static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003129 unsigned char *buf,
3130 size_t len,
3131 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003132{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003133 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003134
Hanno Beckere5e7e782019-07-11 12:29:35 +01003135 size_t const rec_hdr_type_offset = 0;
3136 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003137
Hanno Beckere5e7e782019-07-11 12:29:35 +01003138 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3139 rec_hdr_type_len;
3140 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003141
Hanno Beckere5e7e782019-07-11 12:29:35 +01003142 size_t const rec_hdr_ctr_len = 8;
3143#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003144 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003145 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3146 rec_hdr_version_len;
3147
Hanno Beckera0e20d02019-05-15 14:03:01 +01003148#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003149 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3150 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003151 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003152#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3153#endif /* MBEDTLS_SSL_PROTO_DTLS */
3154
3155 size_t rec_hdr_len_offset; /* To be determined */
3156 size_t const rec_hdr_len_len = 2;
3157
3158 /*
3159 * Check minimum lengths for record header.
3160 */
3161
3162#if defined(MBEDTLS_SSL_PROTO_DTLS)
3163 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3164 {
3165 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3166 }
3167 else
3168#endif /* MBEDTLS_SSL_PROTO_DTLS */
3169 {
3170 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3171 }
3172
3173 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3174 {
3175 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3176 (unsigned) len,
3177 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3178 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3179 }
3180
3181 /*
3182 * Parse and validate record content type
3183 */
3184
3185 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003186
3187 /* Check record content type */
3188#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3189 rec->cid_len = 0;
3190
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003191 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003192 ssl->conf->cid_len != 0 &&
3193 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003194 {
3195 /* Shift pointers to account for record header including CID
3196 * struct {
3197 * ContentType special_type = tls12_cid;
3198 * ProtocolVersion version;
3199 * uint16 epoch;
3200 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003201 * opaque cid[cid_length]; // Additional field compared to
3202 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003203 * uint16 length;
3204 * opaque enc_content[DTLSCiphertext.length];
3205 * } DTLSCiphertext;
3206 */
3207
3208 /* So far, we only support static CID lengths
3209 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003210 rec_hdr_cid_len = ssl->conf->cid_len;
3211 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003212
Hanno Beckere5e7e782019-07-11 12:29:35 +01003213 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003214 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003215 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3216 (unsigned) len,
3217 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003218 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003219 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003220
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003221 /* configured CID len is guaranteed at most 255, see
3222 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3223 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003224 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003225 }
3226 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003227#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003228 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003229 if( ssl_check_record_type( rec->type ) )
3230 {
Hanno Becker54229812019-07-12 14:40:00 +01003231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3232 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003233 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3234 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003235 }
3236
Hanno Beckere5e7e782019-07-11 12:29:35 +01003237 /*
3238 * Parse and validate record version
3239 */
3240
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003241 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3242 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003243 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3244 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003245 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003246
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003247 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003248 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3250 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 }
3252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003253 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003254 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3256 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003257 }
3258
Hanno Beckere5e7e782019-07-11 12:29:35 +01003259 /*
3260 * Parse/Copy record sequence number.
3261 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003262
Hanno Beckere5e7e782019-07-11 12:29:35 +01003263#if defined(MBEDTLS_SSL_PROTO_DTLS)
3264 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003265 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003266 /* Copy explicit record sequence number from input buffer. */
3267 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3268 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003269 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003270 else
3271#endif /* MBEDTLS_SSL_PROTO_DTLS */
3272 {
3273 /* Copy implicit record sequence number from SSL context structure. */
3274 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3275 }
Paul Bakker40e46942009-01-03 21:51:57 +00003276
Hanno Beckere5e7e782019-07-11 12:29:35 +01003277 /*
3278 * Parse record length.
3279 */
3280
Hanno Beckere5e7e782019-07-11 12:29:35 +01003281 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003282 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3283 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003284 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003285
Paul Elliott9f352112020-12-09 14:55:45 +00003286 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003287 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003288 rec->type,
3289 major_ver, minor_ver, rec->data_len ) );
3290
3291 rec->buf = buf;
3292 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003293
Hanno Beckerd417cc92019-07-26 08:20:27 +01003294 if( rec->data_len == 0 )
3295 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003296
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003297 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003298 * DTLS-related tests.
3299 * Check epoch before checking length constraint because
3300 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3301 * message gets duplicated before the corresponding Finished message,
3302 * the second ChangeCipherSpec should be discarded because it belongs
3303 * to an old epoch, but not because its length is shorter than
3304 * the minimum record length for packets using the new record transform.
3305 * Note that these two kinds of failures are handled differently,
3306 * as an unexpected record is silently skipped but an invalid
3307 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003308 */
3309#if defined(MBEDTLS_SSL_PROTO_DTLS)
3310 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3311 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003312 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003313
Hanno Becker955a5c92019-07-10 17:12:07 +01003314 /* Check that the datagram is large enough to contain a record
3315 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003316 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003317 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003318 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3319 (unsigned) len,
3320 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003321 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3322 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003323
Hanno Becker37cfe732019-07-10 17:20:01 +01003324 /* Records from other, non-matching epochs are silently discarded.
3325 * (The case of same-port Client reconnects must be considered in
3326 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003327 if( rec_epoch != ssl->in_epoch )
3328 {
3329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003330 "expected %u, received %lu",
3331 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003332
Hanno Becker552f7472019-07-19 10:59:12 +01003333 /* Records from the next epoch are considered for buffering
3334 * (concretely: early Finished messages). */
3335 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003336 {
Hanno Becker552f7472019-07-19 10:59:12 +01003337 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3338 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003339 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003340
Hanno Becker2fddd372019-07-10 14:37:41 +01003341 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003342 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003343#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003344 /* For records from the correct epoch, check whether their
3345 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003346 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3347 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003348 {
3349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3350 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3351 }
3352#endif
3353 }
3354#endif /* MBEDTLS_SSL_PROTO_DTLS */
3355
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003356 return( 0 );
3357}
Paul Bakker5121ce52009-01-03 21:22:43 +00003358
Paul Bakker5121ce52009-01-03 21:22:43 +00003359
Hanno Becker2fddd372019-07-10 14:37:41 +01003360#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3361static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3362{
3363 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3364
3365 /*
3366 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3367 * access the first byte of record content (handshake type), as we
3368 * have an active transform (possibly iv_len != 0), so use the
3369 * fact that the record header len is 13 instead.
3370 */
3371 if( rec_epoch == 0 &&
3372 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3373 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3374 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3375 ssl->in_left > 13 &&
3376 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3377 {
3378 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3379 "from the same port" ) );
3380 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003381 }
3382
3383 return( 0 );
3384}
Hanno Becker2fddd372019-07-10 14:37:41 +01003385#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003386
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003387/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003388 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003389 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003390static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3391 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003392{
3393 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003396 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003397
Paul Bakker48916f92012-09-16 19:57:18 +00003398 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003399 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003400 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003401
Hanno Beckera18d1322018-01-03 14:27:32 +00003402 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003403 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003404 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003406
Hanno Beckera0e20d02019-05-15 14:03:01 +01003407#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003408 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3409 ssl->conf->ignore_unexpected_cid
3410 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3411 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003412 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003413 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003414 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003415#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003416
Paul Bakker5121ce52009-01-03 21:22:43 +00003417 return( ret );
3418 }
3419
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003420 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003421 {
3422 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003423 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003424 }
3425
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003426 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003427 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003428
Hanno Beckera0e20d02019-05-15 14:03:01 +01003429#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003430 /* We have already checked the record content type
3431 * in ssl_parse_record_header(), failing or silently
3432 * dropping the record in the case of an unknown type.
3433 *
3434 * Since with the use of CIDs, the record content type
3435 * might change during decryption, re-check the record
3436 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003437 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003438 {
3439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3440 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3441 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003442#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003443
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003444 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003445 {
3446#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3447 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003448 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003449 {
3450 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3451 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3452 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3453 }
3454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3455
3456 ssl->nb_zero++;
3457
3458 /*
3459 * Three or more empty messages may be a DoS attack
3460 * (excessive CPU consumption).
3461 */
3462 if( ssl->nb_zero > 3 )
3463 {
3464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003465 "messages, possible DoS attack" ) );
3466 /* Treat the records as if they were not properly authenticated,
3467 * thereby failing the connection if we see more than allowed
3468 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003469 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3470 }
3471 }
3472 else
3473 ssl->nb_zero = 0;
3474
3475#if defined(MBEDTLS_SSL_PROTO_DTLS)
3476 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3477 {
3478 ; /* in_ctr read from peer, not maintained internally */
3479 }
3480 else
3481#endif
3482 {
3483 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003484 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003485 if( ++ssl->in_ctr[i - 1] != 0 )
3486 break;
3487
3488 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003489 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003490 {
3491 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3492 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3493 }
3494 }
3495
Paul Bakker5121ce52009-01-03 21:22:43 +00003496 }
3497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003499 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003500 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003502 }
3503#endif
3504
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003505 /* Check actual (decrypted) record content length against
3506 * configured maximum. */
3507 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3508 {
3509 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3510 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3511 }
3512
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003513 return( 0 );
3514}
3515
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003516/*
3517 * Read a record.
3518 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003519 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3520 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3521 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003522 */
Hanno Becker1097b342018-08-15 14:09:41 +01003523
3524/* Helper functions for mbedtls_ssl_read_record(). */
3525static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003526static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3527static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003528
Hanno Becker327c93b2018-08-15 13:56:18 +01003529int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003530 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003531{
Janos Follath865b3eb2019-12-16 11:46:15 +00003532 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003533
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003535
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003536 if( ssl->keep_current_message == 0 )
3537 {
3538 do {
Simon Butcher99000142016-10-13 17:21:01 +01003539
Hanno Becker26994592018-08-15 14:14:59 +01003540 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003541 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003542 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003543
Hanno Beckere74d5562018-08-15 14:26:08 +01003544 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003545 {
Hanno Becker40f50842018-08-15 14:48:01 +01003546#if defined(MBEDTLS_SSL_PROTO_DTLS)
3547 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003548
Hanno Becker40f50842018-08-15 14:48:01 +01003549 /* We only check for buffered messages if the
3550 * current datagram is fully consumed. */
3551 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003552 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003553 {
Hanno Becker40f50842018-08-15 14:48:01 +01003554 if( ssl_load_buffered_message( ssl ) == 0 )
3555 have_buffered = 1;
3556 }
3557
3558 if( have_buffered == 0 )
3559#endif /* MBEDTLS_SSL_PROTO_DTLS */
3560 {
3561 ret = ssl_get_next_record( ssl );
3562 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3563 continue;
3564
3565 if( ret != 0 )
3566 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003567 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003568 return( ret );
3569 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003570 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003571 }
3572
3573 ret = mbedtls_ssl_handle_message_type( ssl );
3574
Hanno Becker40f50842018-08-15 14:48:01 +01003575#if defined(MBEDTLS_SSL_PROTO_DTLS)
3576 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3577 {
3578 /* Buffer future message */
3579 ret = ssl_buffer_message( ssl );
3580 if( ret != 0 )
3581 return( ret );
3582
3583 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3584 }
3585#endif /* MBEDTLS_SSL_PROTO_DTLS */
3586
Hanno Becker90333da2017-10-10 11:27:13 +01003587 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3588 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003589
3590 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003591 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003592 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003593 return( ret );
3594 }
3595
Hanno Becker327c93b2018-08-15 13:56:18 +01003596 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003597 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003598 {
3599 mbedtls_ssl_update_handshake_status( ssl );
3600 }
Simon Butcher99000142016-10-13 17:21:01 +01003601 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003602 else
Simon Butcher99000142016-10-13 17:21:01 +01003603 {
Hanno Becker02f59072018-08-15 14:00:24 +01003604 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003605 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003606 }
3607
3608 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3609
3610 return( 0 );
3611}
3612
Hanno Becker40f50842018-08-15 14:48:01 +01003613#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003614static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003615{
Hanno Becker40f50842018-08-15 14:48:01 +01003616 if( ssl->in_left > ssl->next_record_offset )
3617 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003618
Hanno Becker40f50842018-08-15 14:48:01 +01003619 return( 0 );
3620}
3621
3622static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3623{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003624 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003625 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003626 int ret = 0;
3627
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003628 if( hs == NULL )
3629 return( -1 );
3630
Hanno Beckere00ae372018-08-20 09:39:42 +01003631 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3632
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003633 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3634 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3635 {
3636 /* Check if we have seen a ChangeCipherSpec before.
3637 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003638 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003639 {
3640 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3641 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003642 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003643 }
3644
Hanno Becker39b8bc92018-08-28 17:17:13 +01003645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003646 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3647 ssl->in_msglen = 1;
3648 ssl->in_msg[0] = 1;
3649
3650 /* As long as they are equal, the exact value doesn't matter. */
3651 ssl->in_left = 0;
3652 ssl->next_record_offset = 0;
3653
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003654 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003655 goto exit;
3656 }
Hanno Becker37f95322018-08-16 13:55:32 +01003657
Hanno Beckerb8f50142018-08-28 10:01:34 +01003658#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003659 /* Debug only */
3660 {
3661 unsigned offset;
3662 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3663 {
3664 hs_buf = &hs->buffering.hs[offset];
3665 if( hs_buf->is_valid == 1 )
3666 {
3667 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3668 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003669 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003670 }
3671 }
3672 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003673#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003674
3675 /* Check if we have buffered and/or fully reassembled the
3676 * next handshake message. */
3677 hs_buf = &hs->buffering.hs[0];
3678 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3679 {
3680 /* Synthesize a record containing the buffered HS message. */
3681 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3682 ( hs_buf->data[2] << 8 ) |
3683 hs_buf->data[3];
3684
3685 /* Double-check that we haven't accidentally buffered
3686 * a message that doesn't fit into the input buffer. */
3687 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3688 {
3689 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3690 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3691 }
3692
3693 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3694 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3695 hs_buf->data, msg_len + 12 );
3696
3697 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3698 ssl->in_hslen = msg_len + 12;
3699 ssl->in_msglen = msg_len + 12;
3700 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3701
3702 ret = 0;
3703 goto exit;
3704 }
3705 else
3706 {
3707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3708 hs->in_msg_seq ) );
3709 }
3710
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003711 ret = -1;
3712
3713exit:
3714
3715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3716 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003717}
3718
Hanno Beckera02b0b42018-08-21 17:20:27 +01003719static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3720 size_t desired )
3721{
3722 int offset;
3723 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3725 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003726
Hanno Becker01315ea2018-08-21 17:22:17 +01003727 /* Get rid of future records epoch first, if such exist. */
3728 ssl_free_buffered_record( ssl );
3729
3730 /* Check if we have enough space available now. */
3731 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3732 hs->buffering.total_bytes_buffered ) )
3733 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003734 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003735 return( 0 );
3736 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003737
Hanno Becker4f432ad2018-08-28 10:02:32 +01003738 /* We don't have enough space to buffer the next expected handshake
3739 * message. Remove buffers used for future messages to gain space,
3740 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003741 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3742 offset >= 0; offset-- )
3743 {
3744 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3745 offset ) );
3746
Hanno Beckerb309b922018-08-23 13:18:05 +01003747 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003748
3749 /* Check if we have enough space available now. */
3750 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3751 hs->buffering.total_bytes_buffered ) )
3752 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003754 return( 0 );
3755 }
3756 }
3757
3758 return( -1 );
3759}
3760
Hanno Becker40f50842018-08-15 14:48:01 +01003761static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3762{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003763 int ret = 0;
3764 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3765
3766 if( hs == NULL )
3767 return( 0 );
3768
3769 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3770
3771 switch( ssl->in_msgtype )
3772 {
3773 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3774 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003775
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003776 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003777 break;
3778
3779 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003780 {
3781 unsigned recv_msg_seq_offset;
3782 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3783 mbedtls_ssl_hs_buffer *hs_buf;
3784 size_t msg_len = ssl->in_hslen - 12;
3785
3786 /* We should never receive an old handshake
3787 * message - double-check nonetheless. */
3788 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3789 {
3790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3791 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3792 }
3793
3794 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3795 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3796 {
3797 /* Silently ignore -- message too far in the future */
3798 MBEDTLS_SSL_DEBUG_MSG( 2,
3799 ( "Ignore future HS message with sequence number %u, "
3800 "buffering window %u - %u",
3801 recv_msg_seq, ssl->handshake->in_msg_seq,
3802 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3803
3804 goto exit;
3805 }
3806
3807 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3808 recv_msg_seq, recv_msg_seq_offset ) );
3809
3810 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3811
3812 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003813 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003814 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003815 size_t reassembly_buf_sz;
3816
Hanno Becker37f95322018-08-16 13:55:32 +01003817 hs_buf->is_fragmented =
3818 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3819
3820 /* We copy the message back into the input buffer
3821 * after reassembly, so check that it's not too large.
3822 * This is an implementation-specific limitation
3823 * and not one from the standard, hence it is not
3824 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003825 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003826 {
3827 /* Ignore message */
3828 goto exit;
3829 }
3830
Hanno Beckere0b150f2018-08-21 15:51:03 +01003831 /* Check if we have enough space to buffer the message. */
3832 if( hs->buffering.total_bytes_buffered >
3833 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3834 {
3835 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3836 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3837 }
3838
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003839 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3840 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003841
3842 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3843 hs->buffering.total_bytes_buffered ) )
3844 {
3845 if( recv_msg_seq_offset > 0 )
3846 {
3847 /* If we can't buffer a future message because
3848 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003849 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3850 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3851 " (already %" MBEDTLS_PRINTF_SIZET
3852 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003853 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003854 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003855 goto exit;
3856 }
Hanno Beckere1801392018-08-21 16:51:05 +01003857 else
3858 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3860 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3861 " (already %" MBEDTLS_PRINTF_SIZET
3862 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003863 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003864 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003865 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003866
Hanno Beckera02b0b42018-08-21 17:20:27 +01003867 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003868 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3870 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3871 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3872 " (already %" MBEDTLS_PRINTF_SIZET
3873 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003874 msg_len,
3875 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003876 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003877 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003878 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3879 goto exit;
3880 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003881 }
3882
Paul Elliottd48d5c62021-01-07 14:47:05 +00003883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003884 msg_len ) );
3885
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003886 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3887 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003888 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003889 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003890 goto exit;
3891 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003892 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003893
3894 /* Prepare final header: copy msg_type, length and message_seq,
3895 * then add standardised fragment_offset and fragment_length */
3896 memcpy( hs_buf->data, ssl->in_msg, 6 );
3897 memset( hs_buf->data + 6, 0, 3 );
3898 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3899
3900 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003901
3902 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003903 }
3904 else
3905 {
3906 /* Make sure msg_type and length are consistent */
3907 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3908 {
3909 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3910 /* Ignore */
3911 goto exit;
3912 }
3913 }
3914
Hanno Becker4422bbb2018-08-20 09:40:19 +01003915 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003916 {
3917 size_t frag_len, frag_off;
3918 unsigned char * const msg = hs_buf->data + 12;
3919
3920 /*
3921 * Check and copy current fragment
3922 */
3923
3924 /* Validation of header fields already done in
3925 * mbedtls_ssl_prepare_handshake_record(). */
3926 frag_off = ssl_get_hs_frag_off( ssl );
3927 frag_len = ssl_get_hs_frag_len( ssl );
3928
Paul Elliottd48d5c62021-01-07 14:47:05 +00003929 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
3930 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01003931 frag_off, frag_len ) );
3932 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
3933
3934 if( hs_buf->is_fragmented )
3935 {
3936 unsigned char * const bitmask = msg + msg_len;
3937 ssl_bitmask_set( bitmask, frag_off, frag_len );
3938 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
3939 msg_len ) == 0 );
3940 }
3941 else
3942 {
3943 hs_buf->is_complete = 1;
3944 }
3945
3946 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
3947 hs_buf->is_complete ? "" : "not yet " ) );
3948 }
3949
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003950 break;
Hanno Becker37f95322018-08-16 13:55:32 +01003951 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003952
3953 default:
Hanno Becker360bef32018-08-28 10:04:33 +01003954 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003955 break;
3956 }
3957
3958exit:
3959
3960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
3961 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003962}
3963#endif /* MBEDTLS_SSL_PROTO_DTLS */
3964
Hanno Becker1097b342018-08-15 14:09:41 +01003965static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003966{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003967 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01003968 * Consume last content-layer message and potentially
3969 * update in_msglen which keeps track of the contents'
3970 * consumption state.
3971 *
3972 * (1) Handshake messages:
3973 * Remove last handshake message, move content
3974 * and adapt in_msglen.
3975 *
3976 * (2) Alert messages:
3977 * Consume whole record content, in_msglen = 0.
3978 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01003979 * (3) Change cipher spec:
3980 * Consume whole record content, in_msglen = 0.
3981 *
3982 * (4) Application data:
3983 * Don't do anything - the record layer provides
3984 * the application data as a stream transport
3985 * and consumes through mbedtls_ssl_read only.
3986 *
3987 */
3988
3989 /* Case (1): Handshake messages */
3990 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003991 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003992 /* Hard assertion to be sure that no application data
3993 * is in flight, as corrupting ssl->in_msglen during
3994 * ssl->in_offt != NULL is fatal. */
3995 if( ssl->in_offt != NULL )
3996 {
3997 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3998 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3999 }
4000
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004001 /*
4002 * Get next Handshake message in the current record
4003 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004004
Hanno Becker4a810fb2017-05-24 16:27:30 +01004005 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004006 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004007 * current handshake content: If DTLS handshake
4008 * fragmentation is used, that's the fragment
4009 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004010 * size here is faulty and should be changed at
4011 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004012 * (2) While it doesn't seem to cause problems, one
4013 * has to be very careful not to assume that in_hslen
4014 * is always <= in_msglen in a sensible communication.
4015 * Again, it's wrong for DTLS handshake fragmentation.
4016 * The following check is therefore mandatory, and
4017 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004018 * Additionally, ssl->in_hslen might be arbitrarily out of
4019 * bounds after handling a DTLS message with an unexpected
4020 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004021 */
4022 if( ssl->in_hslen < ssl->in_msglen )
4023 {
4024 ssl->in_msglen -= ssl->in_hslen;
4025 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4026 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004027
Hanno Becker4a810fb2017-05-24 16:27:30 +01004028 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4029 ssl->in_msg, ssl->in_msglen );
4030 }
4031 else
4032 {
4033 ssl->in_msglen = 0;
4034 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004035
Hanno Becker4a810fb2017-05-24 16:27:30 +01004036 ssl->in_hslen = 0;
4037 }
4038 /* Case (4): Application data */
4039 else if( ssl->in_offt != NULL )
4040 {
4041 return( 0 );
4042 }
4043 /* Everything else (CCS & Alerts) */
4044 else
4045 {
4046 ssl->in_msglen = 0;
4047 }
4048
Hanno Becker1097b342018-08-15 14:09:41 +01004049 return( 0 );
4050}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004051
Hanno Beckere74d5562018-08-15 14:26:08 +01004052static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4053{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004054 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004055 return( 1 );
4056
4057 return( 0 );
4058}
4059
Hanno Becker5f066e72018-08-16 14:56:31 +01004060#if defined(MBEDTLS_SSL_PROTO_DTLS)
4061
4062static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4063{
4064 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4065 if( hs == NULL )
4066 return;
4067
Hanno Becker01315ea2018-08-21 17:22:17 +01004068 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004069 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004070 hs->buffering.total_bytes_buffered -=
4071 hs->buffering.future_record.len;
4072
4073 mbedtls_free( hs->buffering.future_record.data );
4074 hs->buffering.future_record.data = NULL;
4075 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004076}
4077
4078static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4079{
4080 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4081 unsigned char * rec;
4082 size_t rec_len;
4083 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004084#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4085 size_t in_buf_len = ssl->in_buf_len;
4086#else
4087 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4088#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4090 return( 0 );
4091
4092 if( hs == NULL )
4093 return( 0 );
4094
Hanno Becker5f066e72018-08-16 14:56:31 +01004095 rec = hs->buffering.future_record.data;
4096 rec_len = hs->buffering.future_record.len;
4097 rec_epoch = hs->buffering.future_record.epoch;
4098
4099 if( rec == NULL )
4100 return( 0 );
4101
Hanno Becker4cb782d2018-08-20 11:19:05 +01004102 /* Only consider loading future records if the
4103 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004104 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004105 return( 0 );
4106
Hanno Becker5f066e72018-08-16 14:56:31 +01004107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4108
4109 if( rec_epoch != ssl->in_epoch )
4110 {
4111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4112 goto exit;
4113 }
4114
4115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4116
4117 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004118 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004119 {
4120 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4121 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4122 }
4123
4124 memcpy( ssl->in_hdr, rec, rec_len );
4125 ssl->in_left = rec_len;
4126 ssl->next_record_offset = 0;
4127
4128 ssl_free_buffered_record( ssl );
4129
4130exit:
4131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4132 return( 0 );
4133}
4134
Hanno Becker519f15d2019-07-11 12:43:20 +01004135static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4136 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004137{
4138 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004139
4140 /* Don't buffer future records outside handshakes. */
4141 if( hs == NULL )
4142 return( 0 );
4143
4144 /* Only buffer handshake records (we are only interested
4145 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004146 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004147 return( 0 );
4148
4149 /* Don't buffer more than one future epoch record. */
4150 if( hs->buffering.future_record.data != NULL )
4151 return( 0 );
4152
Hanno Becker01315ea2018-08-21 17:22:17 +01004153 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004154 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004155 hs->buffering.total_bytes_buffered ) )
4156 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004157 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4158 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4159 " (already %" MBEDTLS_PRINTF_SIZET
4160 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004161 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004162 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004163 return( 0 );
4164 }
4165
Hanno Becker5f066e72018-08-16 14:56:31 +01004166 /* Buffer record */
4167 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004168 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004169 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004170
4171 /* ssl_parse_record_header() only considers records
4172 * of the next epoch as candidates for buffering. */
4173 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004174 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004175
4176 hs->buffering.future_record.data =
4177 mbedtls_calloc( 1, hs->buffering.future_record.len );
4178 if( hs->buffering.future_record.data == NULL )
4179 {
4180 /* If we run out of RAM trying to buffer a
4181 * record from the next epoch, just ignore. */
4182 return( 0 );
4183 }
4184
Hanno Becker519f15d2019-07-11 12:43:20 +01004185 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004186
Hanno Becker519f15d2019-07-11 12:43:20 +01004187 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004188 return( 0 );
4189}
4190
4191#endif /* MBEDTLS_SSL_PROTO_DTLS */
4192
Hanno Beckere74d5562018-08-15 14:26:08 +01004193static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004194{
Janos Follath865b3eb2019-12-16 11:46:15 +00004195 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004196 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004197
Hanno Becker5f066e72018-08-16 14:56:31 +01004198#if defined(MBEDTLS_SSL_PROTO_DTLS)
4199 /* We might have buffered a future record; if so,
4200 * and if the epoch matches now, load it.
4201 * On success, this call will set ssl->in_left to
4202 * the length of the buffered record, so that
4203 * the calls to ssl_fetch_input() below will
4204 * essentially be no-ops. */
4205 ret = ssl_load_buffered_record( ssl );
4206 if( ret != 0 )
4207 return( ret );
4208#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004209
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004210 /* Ensure that we have enough space available for the default form
4211 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4212 * with no space for CIDs counted in). */
4213 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4214 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004215 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004216 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004217 return( ret );
4218 }
4219
Hanno Beckere5e7e782019-07-11 12:29:35 +01004220 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4221 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004222 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004223#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004224 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004225 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004226 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4227 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004228 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004229 if( ret != 0 )
4230 return( ret );
4231
4232 /* Fall through to handling of unexpected records */
4233 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4234 }
4235
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004236 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4237 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004238#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004239 /* Reset in pointers to default state for TLS/DTLS records,
4240 * assuming no CID and no offset between record content and
4241 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004242 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004243
Hanno Becker7ae20e02019-07-12 08:33:49 +01004244 /* Setup internal message pointers from record structure. */
4245 ssl->in_msgtype = rec.type;
4246#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4247 ssl->in_len = ssl->in_cid + rec.cid_len;
4248#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4249 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4250 ssl->in_msglen = rec.data_len;
4251
Hanno Becker2fddd372019-07-10 14:37:41 +01004252 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004253 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004254 if( ret != 0 )
4255 return( ret );
4256#endif
4257
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004258 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004259 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004260
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004261 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4262 "(header)" ) );
4263 }
4264 else
4265 {
4266 /* Skip invalid record and the rest of the datagram */
4267 ssl->next_record_offset = 0;
4268 ssl->in_left = 0;
4269
4270 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4271 "(header)" ) );
4272 }
4273
4274 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004275 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004276 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004277 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004278#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004279 {
4280 return( ret );
4281 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004282 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004284#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004285 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004286 {
Hanno Beckera8814792019-07-10 15:01:45 +01004287 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004288 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004289 if( ssl->next_record_offset < ssl->in_left )
4290 {
4291 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4292 }
4293 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004294 else
4295#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004296 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004297 /*
4298 * Fetch record contents from underlying transport.
4299 */
Hanno Beckera3175662019-07-11 12:50:29 +01004300 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004301 if( ret != 0 )
4302 {
4303 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4304 return( ret );
4305 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004306
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004307 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004308 }
4309
4310 /*
4311 * Decrypt record contents.
4312 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004313
Hanno Beckerfdf66042019-07-11 13:07:45 +01004314 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004315 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004316#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004317 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004318 {
4319 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004320 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004321 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004322 /* Except when waiting for Finished as a bad mac here
4323 * probably means something went wrong in the handshake
4324 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4325 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4326 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4327 {
4328#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4329 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4330 {
4331 mbedtls_ssl_send_alert_message( ssl,
4332 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4333 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4334 }
4335#endif
4336 return( ret );
4337 }
4338
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004339 if( ssl->conf->badmac_limit != 0 &&
4340 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004341 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4343 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004344 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004345
Hanno Becker4a810fb2017-05-24 16:27:30 +01004346 /* As above, invalid records cause
4347 * dismissal of the whole datagram. */
4348
4349 ssl->next_record_offset = 0;
4350 ssl->in_left = 0;
4351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004353 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004354 }
4355
4356 return( ret );
4357 }
4358 else
4359#endif
4360 {
4361 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004362#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4363 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004364 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004365 mbedtls_ssl_send_alert_message( ssl,
4366 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4367 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004368 }
4369#endif
4370 return( ret );
4371 }
4372 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004373
Hanno Becker44d89b22019-07-12 09:40:44 +01004374
4375 /* Reset in pointers to default state for TLS/DTLS records,
4376 * assuming no CID and no offset between record content and
4377 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004378 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004379#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4380 ssl->in_len = ssl->in_cid + rec.cid_len;
4381#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004382 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004383
Hanno Becker8685c822019-07-12 09:37:30 +01004384 /* The record content type may change during decryption,
4385 * so re-read it. */
4386 ssl->in_msgtype = rec.type;
4387 /* Also update the input buffer, because unfortunately
4388 * the server-side ssl_parse_client_hello() reparses the
4389 * record header when receiving a ClientHello initiating
4390 * a renegotiation. */
4391 ssl->in_hdr[0] = rec.type;
4392 ssl->in_msg = rec.buf + rec.data_offset;
4393 ssl->in_msglen = rec.data_len;
4394 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4395 ssl->in_len[1] = (unsigned char)( rec.data_len );
4396
Simon Butcher99000142016-10-13 17:21:01 +01004397 return( 0 );
4398}
4399
4400int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4401{
Janos Follath865b3eb2019-12-16 11:46:15 +00004402 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004403
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004404 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004405 * Handle particular types of records
4406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004407 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004408 {
Simon Butcher99000142016-10-13 17:21:01 +01004409 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4410 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004411 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004412 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004413 }
4414
Hanno Beckere678eaa2018-08-21 14:57:46 +01004415 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004416 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004417 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004418 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004419 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004420 ssl->in_msglen ) );
4421 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004422 }
4423
Hanno Beckere678eaa2018-08-21 14:57:46 +01004424 if( ssl->in_msg[0] != 1 )
4425 {
4426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4427 ssl->in_msg[0] ) );
4428 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4429 }
4430
4431#if defined(MBEDTLS_SSL_PROTO_DTLS)
4432 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4433 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4434 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4435 {
4436 if( ssl->handshake == NULL )
4437 {
4438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4439 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4440 }
4441
4442 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4443 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4444 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004445#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004446 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004448 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004449 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004450 if( ssl->in_msglen != 2 )
4451 {
4452 /* Note: Standard allows for more than one 2 byte alert
4453 to be packed in a single message, but Mbed TLS doesn't
4454 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004455 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004456 ssl->in_msglen ) );
4457 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4458 }
4459
Paul Elliott9f352112020-12-09 14:55:45 +00004460 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004461 ssl->in_msg[0], ssl->in_msg[1] ) );
4462
4463 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004464 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004466 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004467 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004468 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004469 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004470 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004471 }
4472
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004473 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4474 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004475 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004476 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4477 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004478 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004479
4480#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4481 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4482 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4483 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004485 /* Will be handled when trying to parse ServerHello */
4486 return( 0 );
4487 }
4488#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004489 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004490 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004491 }
4492
Hanno Beckerc76c6192017-06-06 10:03:17 +01004493#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004494 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004495 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004496 /* Drop unexpected ApplicationData records,
4497 * except at the beginning of renegotiations */
4498 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4499 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4500#if defined(MBEDTLS_SSL_RENEGOTIATION)
4501 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4502 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004503#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004504 )
4505 {
4506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4507 return( MBEDTLS_ERR_SSL_NON_FATAL );
4508 }
4509
4510 if( ssl->handshake != NULL &&
4511 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4512 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004513 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004514 }
4515 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004516#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004517
Paul Bakker5121ce52009-01-03 21:22:43 +00004518 return( 0 );
4519}
4520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004521int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004522{
irwir6c0da642019-09-26 21:07:41 +03004523 return( mbedtls_ssl_send_alert_message( ssl,
4524 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4525 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004526}
4527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004528int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004529 unsigned char level,
4530 unsigned char message )
4531{
Janos Follath865b3eb2019-12-16 11:46:15 +00004532 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004533
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004534 if( ssl == NULL || ssl->conf == NULL )
4535 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4536
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004538 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004541 ssl->out_msglen = 2;
4542 ssl->out_msg[0] = level;
4543 ssl->out_msg[1] = message;
4544
Hanno Becker67bc7c32018-08-06 11:33:50 +01004545 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004546 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004548 return( ret );
4549 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004550 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004551
4552 return( 0 );
4553}
4554
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004555int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004556{
Janos Follath865b3eb2019-12-16 11:46:15 +00004557 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004560
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004562 ssl->out_msglen = 1;
4563 ssl->out_msg[0] = 1;
4564
Paul Bakker5121ce52009-01-03 21:22:43 +00004565 ssl->state++;
4566
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004567 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004568 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004569 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004570 return( ret );
4571 }
4572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004573 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004574
4575 return( 0 );
4576}
4577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004579{
Janos Follath865b3eb2019-12-16 11:46:15 +00004580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004582 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004583
Hanno Becker327c93b2018-08-15 13:56:18 +01004584 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004585 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004586 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004587 return( ret );
4588 }
4589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004590 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004591 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004592 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004593 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4594 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004596 }
4597
Hanno Beckere678eaa2018-08-21 14:57:46 +01004598 /* CCS records are only accepted if they have length 1 and content '1',
4599 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004600
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004601 /*
4602 * Switch to our negotiated transform and session parameters for inbound
4603 * data.
4604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004605 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004606 ssl->transform_in = ssl->transform_negotiate;
4607 ssl->session_in = ssl->session_negotiate;
4608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004610 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004611 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004612#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004613 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004614#endif
4615
4616 /* Increment epoch */
4617 if( ++ssl->in_epoch == 0 )
4618 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004620 /* This is highly unlikely to happen for legitimate reasons, so
4621 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004622 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004623 }
4624 }
4625 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004627 memset( ssl->in_ctr, 0, 8 );
4628
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004629 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004630
Paul Bakker5121ce52009-01-03 21:22:43 +00004631 ssl->state++;
4632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004634
4635 return( 0 );
4636}
4637
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004638/* Once ssl->out_hdr as the address of the beginning of the
4639 * next outgoing record is set, deduce the other pointers.
4640 *
4641 * Note: For TLS, we save the implicit record sequence number
4642 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4643 * and the caller has to make sure there's space for this.
4644 */
4645
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004646static size_t ssl_transform_get_explicit_iv_len(
4647 mbedtls_ssl_transform const *transform )
4648{
TRodziewiczef73f012021-05-13 14:53:36 +02004649 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004650 return( 0 );
4651
4652 return( transform->ivlen - transform->fixed_ivlen );
4653}
4654
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004655void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4656 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004657{
4658#if defined(MBEDTLS_SSL_PROTO_DTLS)
4659 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4660 {
4661 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004662#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004663 ssl->out_cid = ssl->out_ctr + 8;
4664 ssl->out_len = ssl->out_cid;
4665 if( transform != NULL )
4666 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004667#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004668 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004669#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004670 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004671 }
4672 else
4673#endif
4674 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004675 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004676#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004677 ssl->out_cid = ssl->out_len;
4678#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004679 ssl->out_iv = ssl->out_hdr + 5;
4680 }
4681
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004682 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004683 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004684 if( transform != NULL )
4685 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004686}
4687
4688/* Once ssl->in_hdr as the address of the beginning of the
4689 * next incoming record is set, deduce the other pointers.
4690 *
4691 * Note: For TLS, we save the implicit record sequence number
4692 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4693 * and the caller has to make sure there's space for this.
4694 */
4695
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004696void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004697{
Hanno Becker79594fd2019-05-08 09:38:41 +01004698 /* This function sets the pointers to match the case
4699 * of unprotected TLS/DTLS records, with both ssl->in_iv
4700 * and ssl->in_msg pointing to the beginning of the record
4701 * content.
4702 *
4703 * When decrypting a protected record, ssl->in_msg
4704 * will be shifted to point to the beginning of the
4705 * record plaintext.
4706 */
4707
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004708#if defined(MBEDTLS_SSL_PROTO_DTLS)
4709 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4710 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004711 /* This sets the header pointers to match records
4712 * without CID. When we receive a record containing
4713 * a CID, the fields are shifted accordingly in
4714 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004715 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004716#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004717 ssl->in_cid = ssl->in_ctr + 8;
4718 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004719#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004720 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004721#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004722 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004723 }
4724 else
4725#endif
4726 {
4727 ssl->in_ctr = ssl->in_hdr - 8;
4728 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004729#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004730 ssl->in_cid = ssl->in_len;
4731#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004732 ssl->in_iv = ssl->in_hdr + 5;
4733 }
4734
Hanno Becker79594fd2019-05-08 09:38:41 +01004735 /* This will be adjusted at record decryption time. */
4736 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004737}
4738
Paul Bakker5121ce52009-01-03 21:22:43 +00004739/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004740 * Setup an SSL context
4741 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004742
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004743void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004744{
4745 /* Set the incoming and outgoing record pointers. */
4746#if defined(MBEDTLS_SSL_PROTO_DTLS)
4747 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4748 {
4749 ssl->out_hdr = ssl->out_buf;
4750 ssl->in_hdr = ssl->in_buf;
4751 }
4752 else
4753#endif /* MBEDTLS_SSL_PROTO_DTLS */
4754 {
Hanno Becker12078f42021-03-02 15:28:41 +00004755 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004756 ssl->out_hdr = ssl->out_buf + 8;
4757 ssl->in_hdr = ssl->in_buf + 8;
4758 }
4759
4760 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004761 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4762 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004763}
4764
Paul Bakker5121ce52009-01-03 21:22:43 +00004765/*
4766 * SSL get accessors
4767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004768size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004769{
4770 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4771}
4772
Hanno Becker8b170a02017-10-10 11:51:19 +01004773int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4774{
4775 /*
4776 * Case A: We're currently holding back
4777 * a message for further processing.
4778 */
4779
4780 if( ssl->keep_current_message == 1 )
4781 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004782 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004783 return( 1 );
4784 }
4785
4786 /*
4787 * Case B: Further records are pending in the current datagram.
4788 */
4789
4790#if defined(MBEDTLS_SSL_PROTO_DTLS)
4791 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4792 ssl->in_left > ssl->next_record_offset )
4793 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004794 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004795 return( 1 );
4796 }
4797#endif /* MBEDTLS_SSL_PROTO_DTLS */
4798
4799 /*
4800 * Case C: A handshake message is being processed.
4801 */
4802
Hanno Becker8b170a02017-10-10 11:51:19 +01004803 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4804 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004805 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004806 return( 1 );
4807 }
4808
4809 /*
4810 * Case D: An application data message is being processed
4811 */
4812 if( ssl->in_offt != NULL )
4813 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004814 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004815 return( 1 );
4816 }
4817
4818 /*
4819 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004820 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004821 * we implement support for multiple alerts in single records.
4822 */
4823
4824 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4825 return( 0 );
4826}
4827
Paul Bakker43ca69c2011-01-15 17:35:19 +00004828
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004829int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004830{
Hanno Becker3136ede2018-08-17 15:28:19 +01004831 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004832 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004833 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004834
Hanno Becker5903de42019-05-03 14:46:38 +01004835 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4836
Hanno Becker78640902018-08-13 16:35:15 +01004837 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004838 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004840 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004841 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004842 case MBEDTLS_MODE_GCM:
4843 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004844 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004845 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004846 transform_expansion = transform->minlen;
4847 break;
4848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004849 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004850
4851 block_size = mbedtls_cipher_get_block_size(
4852 &transform->cipher_ctx_enc );
4853
Hanno Becker3136ede2018-08-17 15:28:19 +01004854 /* Expansion due to the addition of the MAC. */
4855 transform_expansion += transform->maclen;
4856
4857 /* Expansion due to the addition of CBC padding;
4858 * Theoretically up to 256 bytes, but we never use
4859 * more than the block size of the underlying cipher. */
4860 transform_expansion += block_size;
4861
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004862 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004863 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004864#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004865 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004866#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004867
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004868 break;
4869
4870 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004871 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004872 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004873 }
4874
Hanno Beckera0e20d02019-05-15 14:03:01 +01004875#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004876 if( transform->out_cid_len != 0 )
4877 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004878#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004879
Hanno Becker5903de42019-05-03 14:46:38 +01004880 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004881}
4882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004883#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004884/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004885 * Check record counters and renegotiate if they're above the limit.
4886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004887static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004888{
Hanno Beckerdd772292020-02-05 10:38:31 +00004889 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004890 int in_ctr_cmp;
4891 int out_ctr_cmp;
4892
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004893 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4894 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004895 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004896 {
4897 return( 0 );
4898 }
4899
Andres AG2196c7f2016-12-15 17:01:16 +00004900 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
4901 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01004902 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00004903 ssl->conf->renego_period + ep_len, 8 - ep_len );
4904
4905 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004906 {
4907 return( 0 );
4908 }
4909
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004910 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004912}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004914
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004915/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004916 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004917 * may only be sent for the purpose of initiating renegotiations.
4918 *
4919 * This function is introduced as a separate helper since the handling
4920 * of post-handshake handshake messages changes significantly in TLS 1.3,
4921 * and having a helper function allows to distinguish between TLS <= 1.2 and
4922 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
4923 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00004924static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004925{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01004926 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004927
4928 /*
4929 * - For client-side, expect SERVER_HELLO_REQUEST.
4930 * - For server-side, expect CLIENT_HELLO.
4931 * - Fail (TLS) or silently drop record (DTLS) in other cases.
4932 */
4933
4934#if defined(MBEDTLS_SSL_CLI_C)
4935 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4936 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
4937 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
4938 {
4939 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
4940
4941 /* With DTLS, drop the packet (probably from last handshake) */
4942#if defined(MBEDTLS_SSL_PROTO_DTLS)
4943 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4944 {
4945 return( 0 );
4946 }
4947#endif
4948 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4949 }
4950#endif /* MBEDTLS_SSL_CLI_C */
4951
4952#if defined(MBEDTLS_SSL_SRV_C)
4953 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4954 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
4955 {
4956 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
4957
4958 /* With DTLS, drop the packet (probably from last handshake) */
4959#if defined(MBEDTLS_SSL_PROTO_DTLS)
4960 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4961 {
4962 return( 0 );
4963 }
4964#endif
4965 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4966 }
4967#endif /* MBEDTLS_SSL_SRV_C */
4968
4969#if defined(MBEDTLS_SSL_RENEGOTIATION)
4970 /* Determine whether renegotiation attempt should be accepted */
4971 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
4972 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
4973 ssl->conf->allow_legacy_renegotiation ==
4974 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
4975 {
4976 /*
4977 * Accept renegotiation request
4978 */
4979
4980 /* DTLS clients need to know renego is server-initiated */
4981#if defined(MBEDTLS_SSL_PROTO_DTLS)
4982 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4983 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
4984 {
4985 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
4986 }
4987#endif
4988 ret = mbedtls_ssl_start_renegotiation( ssl );
4989 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
4990 ret != 0 )
4991 {
4992 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
4993 ret );
4994 return( ret );
4995 }
4996 }
4997 else
4998#endif /* MBEDTLS_SSL_RENEGOTIATION */
4999 {
5000 /*
5001 * Refuse renegotiation
5002 */
5003
5004 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5005
TRodziewicz0f82ec62021-05-12 17:49:18 +02005006#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005007 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5008 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5009 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005010 {
TRodziewicz345165c2021-07-06 13:42:11 +02005011 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005012 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005013#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005014 }
5015
5016 return( 0 );
5017}
5018
Paul Bakker48916f92012-09-16 19:57:18 +00005019/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005020 * Receive application data decrypted from the SSL layer
5021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005022int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005023{
Janos Follath865b3eb2019-12-16 11:46:15 +00005024 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005025 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005026
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005027 if( ssl == NULL || ssl->conf == NULL )
5028 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005032#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005033 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005034 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005035 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005036 return( ret );
5037
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005038 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005039 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005040 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005041 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005042 return( ret );
5043 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005044 }
5045#endif
5046
Hanno Becker4a810fb2017-05-24 16:27:30 +01005047 /*
5048 * Check if renegotiation is necessary and/or handshake is
5049 * in process. If yes, perform/continue, and fall through
5050 * if an unexpected packet is received while the client
5051 * is waiting for the ServerHello.
5052 *
5053 * (There is no equivalent to the last condition on
5054 * the server-side as it is not treated as within
5055 * a handshake while waiting for the ClientHello
5056 * after a renegotiation request.)
5057 */
5058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005060 ret = ssl_check_ctr_renegotiate( ssl );
5061 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5062 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005063 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005064 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005065 return( ret );
5066 }
5067#endif
5068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005069 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005070 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005072 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5073 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005074 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005075 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005076 return( ret );
5077 }
5078 }
5079
Hanno Beckere41158b2017-10-23 13:30:32 +01005080 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005081 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005082 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005083 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005084 if( ssl->f_get_timer != NULL &&
5085 ssl->f_get_timer( ssl->p_timer ) == -1 )
5086 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005087 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005088 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005089
Hanno Becker327c93b2018-08-15 13:56:18 +01005090 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005091 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005092 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5093 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005094
Hanno Becker4a810fb2017-05-24 16:27:30 +01005095 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5096 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005097 }
5098
5099 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005100 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005101 {
5102 /*
5103 * OpenSSL sends empty messages to randomize the IV
5104 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005105 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005106 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005107 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005108 return( 0 );
5109
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005111 return( ret );
5112 }
5113 }
5114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005115 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005116 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005117 ret = ssl_handle_hs_message_post_handshake( ssl );
5118 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005119 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005120 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5121 ret );
5122 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005123 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005124
Hanno Beckerf26cc722021-04-21 07:30:13 +01005125 /* At this point, we don't know whether the renegotiation triggered
5126 * by the post-handshake message has been completed or not. The cases
5127 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005128 * 1) The renegotiation is complete. In this case, no new record
5129 * has been read yet.
5130 * 2) The renegotiation is incomplete because the client received
5131 * an application data record while awaiting the ServerHello.
5132 * 3) The renegotiation is incomplete because the client received
5133 * a non-handshake, non-application data message while awaiting
5134 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005135 *
5136 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005137 * - For 1), the next iteration will read a new record and check
5138 * if it's application data.
5139 * - For 2), the loop condition isn't satisfied as application data
5140 * is present, hence continue is the same as break
5141 * - For 3), the loop condition is satisfied and read_record
5142 * will re-deliver the message that was held back by the client
5143 * when expecting the ServerHello.
5144 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005145
Hanno Becker90333da2017-10-10 11:27:13 +01005146 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005147 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005148#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005149 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005150 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005151 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005152 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005153 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005154 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005156 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005157 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005158 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005159 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005160 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005161#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005163 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5164 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005165 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005166 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005167 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005168 }
5169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005170 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005171 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005172 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5173 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005174 }
5175
5176 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005177
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005178 /* We're going to return something now, cancel timer,
5179 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005180 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005181 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005182
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005183#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005184 /* If we requested renego but received AppData, resend HelloRequest.
5185 * Do it now, after setting in_offt, to avoid taking this branch
5186 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005187#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005188 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005189 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005190 {
Hanno Becker786300f2020-02-05 10:46:40 +00005191 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005192 {
Hanno Becker786300f2020-02-05 10:46:40 +00005193 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5194 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005195 return( ret );
5196 }
5197 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005198#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005199#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005200 }
5201
5202 n = ( len < ssl->in_msglen )
5203 ? len : ssl->in_msglen;
5204
5205 memcpy( buf, ssl->in_offt, n );
5206 ssl->in_msglen -= n;
5207
gabor-mezei-arma3214132020-07-15 10:55:00 +02005208 /* Zeroising the plaintext buffer to erase unused application data
5209 from the memory. */
5210 mbedtls_platform_zeroize( ssl->in_offt, n );
5211
Paul Bakker5121ce52009-01-03 21:22:43 +00005212 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005213 {
5214 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005215 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005216 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005217 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005218 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005219 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005220 /* more data available */
5221 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005222 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005224 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005225
Paul Bakker23986e52011-04-24 08:57:21 +00005226 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005227}
5228
5229/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005230 * Send application data to be encrypted by the SSL layer, taking care of max
5231 * fragment length and buffer size.
5232 *
5233 * According to RFC 5246 Section 6.2.1:
5234 *
5235 * Zero-length fragments of Application data MAY be sent as they are
5236 * potentially useful as a traffic analysis countermeasure.
5237 *
5238 * Therefore, it is possible that the input message length is 0 and the
5239 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005240 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005241static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005242 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005243{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005244 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5245 const size_t max_len = (size_t) ret;
5246
5247 if( ret < 0 )
5248 {
5249 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5250 return( ret );
5251 }
5252
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005253 if( len > max_len )
5254 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005255#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005256 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005257 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005258 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005259 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5260 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005261 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005262 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005263 }
5264 else
5265#endif
5266 len = max_len;
5267 }
Paul Bakker887bd502011-06-08 13:10:54 +00005268
Paul Bakker5121ce52009-01-03 21:22:43 +00005269 if( ssl->out_left != 0 )
5270 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005271 /*
5272 * The user has previously tried to send the data and
5273 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5274 * written. In this case, we expect the high-level write function
5275 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005277 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005278 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005279 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005280 return( ret );
5281 }
5282 }
Paul Bakker887bd502011-06-08 13:10:54 +00005283 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005284 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005285 /*
5286 * The user is trying to send a message the first time, so we need to
5287 * copy the data into the internal buffers and setup the data structure
5288 * to keep track of partial writes
5289 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005290 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005291 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005292 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005293
Hanno Becker67bc7c32018-08-06 11:33:50 +01005294 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005295 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005296 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005297 return( ret );
5298 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005299 }
5300
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005301 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005302}
5303
5304/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005305 * Write application data (public-facing wrapper)
5306 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005307int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005308{
Janos Follath865b3eb2019-12-16 11:46:15 +00005309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005310
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005311 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005312
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005313 if( ssl == NULL || ssl->conf == NULL )
5314 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5315
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005316#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005317 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5318 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005319 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005320 return( ret );
5321 }
5322#endif
5323
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005324 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005325 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005326 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005327 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005328 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005329 return( ret );
5330 }
5331 }
5332
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005333 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005334
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005336
5337 return( ret );
5338}
5339
5340/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005341 * Notify the peer that the connection is being closed
5342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005344{
Janos Follath865b3eb2019-12-16 11:46:15 +00005345 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005346
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005347 if( ssl == NULL || ssl->conf == NULL )
5348 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005350 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005351
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005352 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005353 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005355 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005356 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5358 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5359 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005362 return( ret );
5363 }
5364 }
5365
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005366 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005367
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005368 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005369}
5370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005372{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005373 if( transform == NULL )
5374 return;
5375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005376 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5377 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005378
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005379#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005380 mbedtls_md_free( &transform->md_ctx_enc );
5381 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005382#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005383
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005384 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005385}
5386
Hanno Becker0271f962018-08-16 13:23:47 +01005387#if defined(MBEDTLS_SSL_PROTO_DTLS)
5388
Hanno Becker533ab5f2020-02-05 10:49:13 +00005389void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005390{
5391 unsigned offset;
5392 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5393
5394 if( hs == NULL )
5395 return;
5396
Hanno Becker283f5ef2018-08-24 09:34:47 +01005397 ssl_free_buffered_record( ssl );
5398
Hanno Becker0271f962018-08-16 13:23:47 +01005399 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005400 ssl_buffering_free_slot( ssl, offset );
5401}
5402
5403static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5404 uint8_t slot )
5405{
5406 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5407 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005408
5409 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5410 return;
5411
Hanno Beckere605b192018-08-21 15:59:07 +01005412 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005413 {
Hanno Beckere605b192018-08-21 15:59:07 +01005414 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005415 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005416 mbedtls_free( hs_buf->data );
5417 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005418 }
5419}
5420
5421#endif /* MBEDTLS_SSL_PROTO_DTLS */
5422
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005423/*
5424 * Convert version numbers to/from wire format
5425 * and, for DTLS, to/from TLS equivalent.
5426 *
5427 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005428 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005429 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005432 unsigned char ver[2] )
5433{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434#if defined(MBEDTLS_SSL_PROTO_DTLS)
5435 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005436 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005438 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5439
5440 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5441 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5442 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005443 else
5444#else
5445 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005446#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005447 {
5448 ver[0] = (unsigned char) major;
5449 ver[1] = (unsigned char) minor;
5450 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005451}
5452
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005453void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005454 const unsigned char ver[2] )
5455{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005456#if defined(MBEDTLS_SSL_PROTO_DTLS)
5457 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005458 {
5459 *major = 255 - ver[0] + 2;
5460 *minor = 255 - ver[1] + 1;
5461
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005463 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5464 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005465 else
5466#else
5467 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005468#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005469 {
5470 *major = ver[0];
5471 *minor = ver[1];
5472 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005473}
5474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475#endif /* MBEDTLS_SSL_TLS_C */