blob: fcdd0249bc2267fc7c7e53775616b4364d1cf724 [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"
Paul Bakker0be444a2013-08-27 21:55:01 +020043
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020044#include "ssl_invasive.h"
45
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Hanno Beckerccc13d02020-05-04 12:30:04 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
297 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100298
299static size_t ssl_compute_padding_length( size_t len,
300 size_t granularity )
301{
302 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
303}
304
Hanno Becker581bc1b2020-05-04 12:20:03 +0100305/* This functions transforms a (D)TLS plaintext fragment and a record content
306 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
307 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
308 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100309 *
310 * struct {
311 * opaque content[DTLSPlaintext.length];
312 * ContentType real_type;
313 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100314 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100315 *
316 * Input:
317 * - `content`: The beginning of the buffer holding the
318 * plaintext to be wrapped.
319 * - `*content_size`: The length of the plaintext in Bytes.
320 * - `max_len`: The number of Bytes available starting from
321 * `content`. This must be `>= *content_size`.
322 * - `rec_type`: The desired record content type.
323 *
324 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100325 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
326 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100327 *
328 * Returns:
329 * - `0` on success.
330 * - A negative error code if `max_len` didn't offer enough space
331 * for the expansion.
332 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100333static int ssl_build_inner_plaintext( unsigned char *content,
334 size_t *content_size,
335 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100336 uint8_t rec_type,
337 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338{
339 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100340
341 /* Write real content type */
342 if( remaining == 0 )
343 return( -1 );
344 content[ len ] = rec_type;
345 len++;
346 remaining--;
347
348 if( remaining < pad )
349 return( -1 );
350 memset( content + len, 0, pad );
351 len += pad;
352 remaining -= pad;
353
354 *content_size = len;
355 return( 0 );
356}
357
Hanno Becker581bc1b2020-05-04 12:20:03 +0100358/* This function parses a (D)TLSInnerPlaintext structure.
359 * See ssl_build_inner_plaintext() for details. */
360static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361 size_t *content_size,
362 uint8_t *rec_type )
363{
364 size_t remaining = *content_size;
365
366 /* Determine length of padding by skipping zeroes from the back. */
367 do
368 {
369 if( remaining == 0 )
370 return( -1 );
371 remaining--;
372 } while( content[ remaining ] == 0 );
373
374 *content_size = remaining;
375 *rec_type = content[ remaining ];
376
377 return( 0 );
378}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100379#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
380 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100381
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100382/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100383 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000384static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100385 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100386 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000387 unsigned minor_ver,
388 size_t taglen )
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 Becker79e2d1b2021-03-22 11:42:19 +0000407 * Moreover, the additional data involves the length of the TLS
408 * ciphertext, not the TLS plaintext as in earlier versions.
409 * Quoting RFC 8446 (TLS 1.3):
410 *
411 * additional_data = TLSCiphertext.opaque_type ||
412 * TLSCiphertext.legacy_record_version ||
413 * TLSCiphertext.length
414 *
415 * We pass the tag length to this function in order to compute the
416 * ciphertext length from the inner plaintext length rec->data_len via
417 *
418 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
419 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 */
421
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000423 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100424
425#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000426 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
427 {
428 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
429 * which differs from the length of the TLSInnerPlaintext
430 * by the length of the authentication tag. */
431 ad_len_field += taglen;
432 }
433 else
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
435 {
436 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000437 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
Joe Subbiani6dd73642021-07-19 11:56:54 +0100457 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100458 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100459 }
460 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100461#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100462 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100463 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100465 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466
467 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000468}
469
Hanno Becker67a37db2020-05-28 16:27:07 +0100470#if defined(MBEDTLS_GCM_C) || \
471 defined(MBEDTLS_CCM_C) || \
472 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100473static int ssl_transform_aead_dynamic_iv_is_explicit(
474 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475{
Hanno Becker17263802020-05-28 07:05:48 +0100476 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100477}
478
Hanno Becker17263802020-05-28 07:05:48 +0100479/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
480 *
481 * Concretely, this occurs in two variants:
482 *
483 * a) Fixed and dynamic IV lengths add up to total IV length, giving
484 * IV = fixed_iv || dynamic_iv
485 *
Hanno Becker15952812020-06-04 13:31:46 +0100486 * This variant is used in TLS 1.2 when used with GCM or CCM.
487 *
Hanno Becker17263802020-05-28 07:05:48 +0100488 * b) Fixed IV lengths matches total IV length, giving
489 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100490 *
491 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
492 *
493 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100494 *
495 * This function has the precondition that
496 *
497 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
498 *
499 * which has to be ensured by the caller. If this precondition
500 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100501 */
502static void ssl_build_record_nonce( unsigned char *dst_iv,
503 size_t dst_iv_len,
504 unsigned char const *fixed_iv,
505 size_t fixed_iv_len,
506 unsigned char const *dynamic_iv,
507 size_t dynamic_iv_len )
508{
509 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100510
511 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100512 memset( dst_iv, 0, dst_iv_len );
513 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100514
Hanno Becker17263802020-05-28 07:05:48 +0100515 dst_iv += dst_iv_len - dynamic_iv_len;
516 for( i = 0; i < dynamic_iv_len; i++ )
517 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518}
Hanno Becker67a37db2020-05-28 16:27:07 +0100519#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100520
Hanno Beckera18d1322018-01-03 14:27:32 +0000521int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
522 mbedtls_ssl_transform *transform,
523 mbedtls_record *rec,
524 int (*f_rng)(void *, unsigned char *, size_t),
525 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000526{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
573 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
574
575 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
576 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
578 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000579 rec->data_len,
580 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
582 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100583
Hanno Becker92313402020-05-20 13:58:58 +0100584 /* The following two code paths implement the (D)TLSInnerPlaintext
585 * structure present in TLS 1.3 and DTLS 1.2 + CID.
586 *
587 * See ssl_build_inner_plaintext() for more information.
588 *
589 * Note that this changes `rec->data_len`, and hence
590 * `post_avail` needs to be recalculated afterwards.
591 *
592 * Note also that the two code paths cannot occur simultaneously
593 * since they apply to different versions of the protocol. There
594 * is hence no risk of double-addition of the inner plaintext.
595 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100596#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
597 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
598 {
Hanno Becker13996922020-05-28 16:15:19 +0100599 size_t padding =
600 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200601 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100602 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100603 &rec->data_len,
604 post_avail,
605 rec->type,
606 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100607 {
608 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
609 }
610
611 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
612 }
613#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
614
Hanno Beckera0e20d02019-05-15 14:03:01 +0100615#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100616 /*
617 * Add CID information
618 */
619 rec->cid_len = transform->out_cid_len;
620 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
621 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622
623 if( rec->cid_len != 0 )
624 {
Hanno Becker13996922020-05-28 16:15:19 +0100625 size_t padding =
626 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200627 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100628 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100629 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100630 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100631 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100632 * Note that this changes `rec->data_len`, and hence
633 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100634 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100635 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 &rec->data_len,
637 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100638 rec->type,
639 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100640 {
641 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
642 }
643
644 rec->type = MBEDTLS_SSL_MSG_CID;
645 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100647
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100648 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
649
Paul Bakker5121ce52009-01-03 21:22:43 +0000650 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100651 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000653#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 if( mode == MBEDTLS_MODE_STREAM ||
655 ( mode == MBEDTLS_MODE_CBC
656#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100658#endif
659 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000660 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 if( post_avail < transform->maclen )
662 {
663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
664 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
665 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200667 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000668
TRodziewicz345165c2021-07-06 13:42:11 +0200669 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000670 transform->minor_ver,
671 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000672
TRodziewicz345165c2021-07-06 13:42:11 +0200673 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
674 add_data_len );
675 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
676 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
677 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000678
TRodziewicz345165c2021-07-06 13:42:11 +0200679 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200680#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
683 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200684
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000685 rec->data_len += transform->maclen;
686 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100687 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200688 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000689#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000690
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200691 /*
692 * Encrypt
693 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000694#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000696 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000699 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000700 "including %d bytes of padding",
701 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000702
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000703 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
704 transform->iv_enc, transform->ivlen,
705 data, rec->data_len,
706 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200709 return( ret );
710 }
711
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000712 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
715 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200716 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000717 }
Paul Bakker68884e32013-01-07 18:20:04 +0100718 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000719#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000720
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200721#if defined(MBEDTLS_GCM_C) || \
722 defined(MBEDTLS_CCM_C) || \
723 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200725 mode == MBEDTLS_MODE_CCM ||
726 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000727 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200729 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100730 unsigned char *dynamic_iv;
731 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100732 int dynamic_iv_is_explicit =
733 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000734
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100735 /* Check that there's space for the authentication tag. */
736 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000737 {
738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
739 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
740 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000741
Paul Bakker68884e32013-01-07 18:20:04 +0100742 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100743 * Build nonce for AEAD encryption.
744 *
745 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
746 * part of the IV is prepended to the ciphertext and
747 * can be chosen freely - in particular, it need not
748 * agree with the record sequence number.
749 * However, since ChaChaPoly as well as all AEAD modes
750 * in TLS 1.3 use the record sequence number as the
751 * dynamic part of the nonce, we uniformly use the
752 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100753 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100754 dynamic_iv = rec->ctr;
755 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200756
Hanno Becker17263802020-05-28 07:05:48 +0100757 ssl_build_record_nonce( iv, sizeof( iv ),
758 transform->iv_enc,
759 transform->fixed_ivlen,
760 dynamic_iv,
761 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100762
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100763 /*
764 * Build additional data for AEAD encryption.
765 * This depends on the TLS version.
766 */
767 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000768 transform->minor_ver,
769 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100770
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200771 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100772 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200773 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100774 dynamic_iv,
775 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000776 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100777 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000778 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200779 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000780 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000781
Paul Bakker68884e32013-01-07 18:20:04 +0100782 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200783 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200784 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000785
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100786 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000787 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100788 add_data, add_data_len,
789 data, rec->data_len, /* src */
790 data, rec->buf_len - (data - rec->buf), /* dst */
791 &rec->data_len,
792 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200793 {
TRodziewicz18efb732021-04-29 23:12:19 +0200794 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200795 return( ret );
796 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000797 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100798 data + rec->data_len - transform->taglen,
799 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100800 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000801 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100802
803 /*
804 * Prefix record content with dynamic IV in case it is explicit.
805 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100806 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100807 {
808 if( rec->data_offset < dynamic_iv_len )
809 {
810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
811 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
812 }
813
814 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
815 rec->data_offset -= dynamic_iv_len;
816 rec->data_len += dynamic_iv_len;
817 }
818
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100819 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000820 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100822#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200823#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000825 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000827 size_t padlen, i;
828 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000829
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000830 /* Currently we're always using minimal padding
831 * (up to 255 bytes would be allowed). */
832 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
833 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000834 padlen = 0;
835
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000836 /* Check there's enough space in the buffer for the padding. */
837 if( post_avail < padlen + 1 )
838 {
839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
840 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
841 }
842
Paul Bakker5121ce52009-01-03 21:22:43 +0000843 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000845
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 rec->data_len += padlen + 1;
847 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000848
TRodziewicz0f82ec62021-05-12 17:49:18 +0200849#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000850 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200851 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000852 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000853 */
TRodziewicz345165c2021-07-06 13:42:11 +0200854 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000855 {
TRodziewicz345165c2021-07-06 13:42:11 +0200856 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
857 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000858 }
TRodziewicz345165c2021-07-06 13:42:11 +0200859
860 if( rec->data_offset < transform->ivlen )
861 {
862 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
863 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
864 }
865
866 /*
867 * Generate IV
868 */
869 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
870 if( ret != 0 )
871 return( ret );
872
873 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200874#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000875
Paul Elliottd48d5c62021-01-07 14:47:05 +0000876 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
877 "including %" MBEDTLS_PRINTF_SIZET
878 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000879 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200880 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000881
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000882 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
883 transform->iv_enc,
884 transform->ivlen,
885 data, rec->data_len,
886 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200889 return( ret );
890 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200891
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000892 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200893 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
895 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200896 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200897
TRodziewicz0f82ec62021-05-12 17:49:18 +0200898 data -= transform->ivlen;
899 rec->data_offset -= transform->ivlen;
900 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100903 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100904 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000905 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
906
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100907 /*
908 * MAC(MAC_write_key, seq_num +
909 * TLSCipherText.type +
910 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100911 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200912 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100913 * ENC(content + padding + padding_length));
914 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000915
916 if( post_avail < transform->maclen)
917 {
918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
919 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
920 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100921
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100922 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000923 rec, transform->minor_ver,
924 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000927 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100928 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100929
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000930 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100931 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 mbedtls_md_hmac_update( &transform->md_ctx_enc,
933 data, rec->data_len );
934 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
935 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100936
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100938
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000939 rec->data_len += transform->maclen;
940 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100941 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100942 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000944 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200945 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200946#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200947 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
949 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200950 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000951
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100952 /* Make extra sure authentication was performed, exactly once */
953 if( auth_done != 1 )
954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
956 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100957 }
958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000960
961 return( 0 );
962}
963
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200964#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200965/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200966 * Turn a bit into a mask:
967 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
968 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200969 *
970 * This function can be used to write constant-time code by replacing branches
971 * with bit operations using masks.
972 *
973 * This function is implemented without using comparison operators, as those
974 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200975 */
976static size_t mbedtls_ssl_cf_mask_from_bit( size_t bit )
977{
978 /* MSVC has a warning about unary minus on unsigned integer types,
979 * but this is well-defined and precisely what we want to do here. */
980#if defined(_MSC_VER)
981#pragma warning( push )
982#pragma warning( disable : 4146 )
983#endif
984 return -bit;
985#if defined(_MSC_VER)
986#pragma warning( pop )
987#endif
988}
989
990/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200991 * Constant-flow mask generation for "less than" comparison:
992 * - if x < y, return all bits 1, that is (size_t) -1
993 * - otherwise, return all bits 0, that is 0
994 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200995 * This function can be used to write constant-time code by replacing branches
996 * with bit operations using masks.
997 *
998 * This function is implemented without using comparison operators, as those
999 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001000 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001001static size_t mbedtls_ssl_cf_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001002{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001003 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001004 const size_t sub = x - y;
1005
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001006 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001007 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1008
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001009 /* mask = (x < y) ? 0xff... : 0x00... */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001010 const size_t mask = mbedtls_ssl_cf_mask_from_bit( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001011
1012 return( mask );
1013}
1014
1015/*
1016 * Constant-flow mask generation for "greater or equal" comparison:
1017 * - if x >= y, return all bits 1, that is (size_t) -1
1018 * - otherwise, return all bits 0, that is 0
1019 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001020 * This function can be used to write constant-time code by replacing branches
1021 * with bit operations using masks.
1022 *
1023 * This function is implemented without using comparison operators, as those
1024 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001025 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001026static size_t mbedtls_ssl_cf_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001027{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001028 return( ~mbedtls_ssl_cf_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001029}
1030
1031/*
1032 * Constant-flow boolean "equal" comparison:
1033 * return x == y
1034 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001035 * This function can be used to write constant-time code by replacing branches
1036 * with bit operations - it can be used in conjunction with
1037 * mbedtls_ssl_cf_mask_from_bit().
1038 *
1039 * This function is implemented without using comparison operators, as those
1040 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001041 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001042static size_t mbedtls_ssl_cf_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001043{
1044 /* diff = 0 if x == y, non-zero otherwise */
1045 const size_t diff = x ^ y;
1046
1047 /* MSVC has a warning about unary minus on unsigned integer types,
1048 * but this is well-defined and precisely what we want to do here. */
1049#if defined(_MSC_VER)
1050#pragma warning( push )
1051#pragma warning( disable : 4146 )
1052#endif
1053
1054 /* diff_msb's most significant bit is equal to x != y */
1055 const size_t diff_msb = ( diff | -diff );
1056
1057#if defined(_MSC_VER)
1058#pragma warning( pop )
1059#endif
1060
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001061 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001062 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1063
1064 return( 1 ^ diff1 );
1065}
1066
1067/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001068 * Constant-flow conditional memcpy:
1069 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1070 * - otherwise, a no-op,
1071 * but with execution flow independent of the values of c1 and c2.
1072 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001073 * This function is implemented without using comparison operators, as those
1074 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001075 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001076static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1077 const unsigned char *src,
1078 size_t len,
1079 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001080{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001081 /* mask = c1 == c2 ? 0xff : 0x00 */
1082 const size_t equal = mbedtls_ssl_cf_bool_eq( c1, c2 );
Manuel Pégourié-Gonnard2a59fb42020-08-25 11:51:46 +02001083 const unsigned char mask = (unsigned char) mbedtls_ssl_cf_mask_from_bit( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001084
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001085 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001086 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001087 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001088}
1089
1090/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001091 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001092 *
1093 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1094 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001095 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001096MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001097 mbedtls_md_context_t *ctx,
1098 const unsigned char *add_data, size_t add_data_len,
1099 const unsigned char *data, size_t data_len_secret,
1100 size_t min_data_len, size_t max_data_len,
1101 unsigned char *output )
1102{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001103 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001104 * This function breaks the HMAC abstraction and uses the md_clone()
1105 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001106 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001107 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001108 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001109 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001110 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001111 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1112 * minlen, then cloning the context, and for each byte up to maxlen
1113 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001114 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001115 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001116 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +02001118 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001119 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001120 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001121 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001122 const unsigned char * const okey = ikey + block_size;
1123 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001124
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001125 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1126 mbedtls_md_context_t aux;
1127 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001129
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001130 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001131
1132#define MD_CHK( func_call ) \
1133 do { \
1134 ret = (func_call); \
1135 if( ret != 0 ) \
1136 goto cleanup; \
1137 } while( 0 )
1138
1139 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001140
1141 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1142 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001143 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1144 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001145
1146 /* For each possible length, compute the hash up to that point */
1147 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001148 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001149 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1150 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001151 /* Keep only the correct inner_hash in the output buffer */
1152 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1153 offset, data_len_secret );
1154
1155 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001156 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001157 }
1158
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001159 /* The context needs to finish() before it starts() again */
1160 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1161
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001162 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001163 MD_CHK( mbedtls_md_starts( ctx ) );
1164 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1165 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1166 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001167
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001168 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001169 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001170
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001171#undef MD_CHK
1172
1173cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001174 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001175 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001176}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001177
1178/*
1179 * Constant-flow memcpy from variable position in buffer.
1180 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001181 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001182 */
1183MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1184 unsigned char *dst,
1185 const unsigned char *src_base,
1186 size_t offset_secret,
1187 size_t offset_min, size_t offset_max,
1188 size_t len )
1189{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001190 size_t offset;
1191
1192 for( offset = offset_min; offset <= offset_max; offset++ )
1193 {
1194 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1195 offset, offset_secret );
1196 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001197}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001198#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001199
Hanno Becker605949f2019-07-12 08:23:59 +01001200int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001201 mbedtls_ssl_transform *transform,
1202 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001203{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001204 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001206 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001207#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001208 size_t padlen = 0, correct = 1;
1209#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001210 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001211 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001212 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001213
Hanno Beckera18d1322018-01-03 14:27:32 +00001214#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001215 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216 ((void) ssl);
1217#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001220 if( rec == NULL ||
1221 rec->buf == NULL ||
1222 rec->buf_len < rec->data_offset ||
1223 rec->buf_len - rec->data_offset < rec->data_len )
1224 {
1225 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001227 }
1228
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001229 data = rec->buf + rec->data_offset;
1230 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001231
Hanno Beckera0e20d02019-05-15 14:03:01 +01001232#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001233 /*
1234 * Match record's CID with incoming CID.
1235 */
Hanno Becker938489a2019-05-08 13:02:22 +01001236 if( rec->cid_len != transform->in_cid_len ||
1237 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1238 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001239 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001240 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001241#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001242
Hanno Beckerd086bf02021-03-22 13:01:27 +00001243#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001244 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001245 {
1246 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001247 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1248 transform->iv_dec,
1249 transform->ivlen,
1250 data, rec->data_len,
1251 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001252 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001254 return( ret );
1255 }
1256
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001257 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001258 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1260 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001261 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001262 }
Paul Bakker68884e32013-01-07 18:20:04 +01001263 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001264#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001265#if defined(MBEDTLS_GCM_C) || \
1266 defined(MBEDTLS_CCM_C) || \
1267 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001269 mode == MBEDTLS_MODE_CCM ||
1270 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001271 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001272 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001273 unsigned char *dynamic_iv;
1274 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001275
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001276 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001277 * Extract dynamic part of nonce for AEAD decryption.
1278 *
1279 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1280 * part of the IV is prepended to the ciphertext and
1281 * can be chosen freely - in particular, it need not
1282 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001283 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001284 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001285 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001286 {
1287 if( rec->data_len < dynamic_iv_len )
1288 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1290 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001291 rec->data_len,
1292 dynamic_iv_len ) );
1293 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1294 }
1295 dynamic_iv = data;
1296
1297 data += dynamic_iv_len;
1298 rec->data_offset += dynamic_iv_len;
1299 rec->data_len -= dynamic_iv_len;
1300 }
Hanno Becker17263802020-05-28 07:05:48 +01001301 else
1302 {
1303 dynamic_iv = rec->ctr;
1304 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001305
1306 /* Check that there's space for the authentication tag. */
1307 if( rec->data_len < transform->taglen )
1308 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001309 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1310 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001311 rec->data_len,
1312 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001314 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001315 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001316
Hanno Beckerdf8be222020-05-21 15:30:57 +01001317 /*
1318 * Prepare nonce from dynamic and static parts.
1319 */
Hanno Becker17263802020-05-28 07:05:48 +01001320 ssl_build_record_nonce( iv, sizeof( iv ),
1321 transform->iv_dec,
1322 transform->fixed_ivlen,
1323 dynamic_iv,
1324 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001325
Hanno Beckerdf8be222020-05-21 15:30:57 +01001326 /*
1327 * Build additional data for AEAD encryption.
1328 * This depends on the TLS version.
1329 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001330 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001331 transform->minor_ver,
1332 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001333 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001334 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001335
Hanno Beckerd96a6522019-07-10 13:55:25 +01001336 /* Because of the check above, we know that there are
1337 * explicit_iv_len Bytes preceeding data, and taglen
1338 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001339 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001340 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001341
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001342 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001343 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001344 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001345
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001346 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001347 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001348 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001349 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001350 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001351 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001352 data, rec->data_len + transform->taglen, /* src */
1353 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001354 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001355 {
TRodziewicz18efb732021-04-29 23:12:19 +02001356 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001357
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1359 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001360
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001361 return( ret );
1362 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001363 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001364
Hanno Beckerd96a6522019-07-10 13:55:25 +01001365 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001366 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001367 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1369 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001370 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001371 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001372 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001374#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001376 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001377 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001378
Paul Bakker5121ce52009-01-03 21:22:43 +00001379 /*
Paul Bakker45829992013-01-03 14:52:21 +01001380 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001381 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001383 /* The ciphertext is prefixed with the CBC IV. */
1384 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001385#endif
Paul Bakker45829992013-01-03 14:52:21 +01001386
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001387 /* Size considerations:
1388 *
1389 * - The CBC cipher text must not be empty and hence
1390 * at least of size transform->ivlen.
1391 *
1392 * Together with the potential IV-prefix, this explains
1393 * the first of the two checks below.
1394 *
1395 * - The record must contain a MAC, either in plain or
1396 * encrypted, depending on whether Encrypt-then-MAC
1397 * is used or not.
1398 * - If it is, the message contains the IV-prefix,
1399 * the CBC ciphertext, and the MAC.
1400 * - If it is not, the padded plaintext, and hence
1401 * the CBC ciphertext, has at least length maclen + 1
1402 * because there is at least the padding length byte.
1403 *
1404 * As the CBC ciphertext is not empty, both cases give the
1405 * lower bound minlen + maclen + 1 on the record size, which
1406 * we test for in the second check below.
1407 */
1408 if( rec->data_len < minlen + transform->ivlen ||
1409 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001410 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001411 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1412 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1413 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001414 "+ 1 ) ( + expl IV )", rec->data_len,
1415 transform->ivlen,
1416 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001418 }
1419
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001420 /*
1421 * Authenticate before decrypt if enabled
1422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001425 {
Hanno Becker992b6872017-11-09 18:57:39 +00001426 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001429
Hanno Beckerd96a6522019-07-10 13:55:25 +01001430 /* Update data_len in tandem with add_data.
1431 *
1432 * The subtraction is safe because of the previous check
1433 * data_len >= minlen + maclen + 1.
1434 *
1435 * Afterwards, we know that data + data_len is followed by at
1436 * least maclen Bytes, which justifies the call to
1437 * mbedtls_ssl_safer_memcmp() below.
1438 *
1439 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001440 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001441 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001442 transform->minor_ver,
1443 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001444
Hanno Beckerd96a6522019-07-10 13:55:25 +01001445 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001446 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1447 add_data_len );
1448 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1449 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001450 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1451 data, rec->data_len );
1452 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1453 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001454
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001455 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1456 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001457 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001458 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001459
Hanno Beckerd96a6522019-07-10 13:55:25 +01001460 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1462 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001463 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001466 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001467 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001468 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001470
1471 /*
1472 * Check length sanity
1473 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001474
1475 /* We know from above that data_len > minlen >= 0,
1476 * so the following check in particular implies that
1477 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001478 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001479 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001480 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1481 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001482 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001484 }
1485
TRodziewicz0f82ec62021-05-12 17:49:18 +02001486#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001487 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001488 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001489 */
TRodziewicz345165c2021-07-06 13:42:11 +02001490 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1491 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001492
TRodziewicz345165c2021-07-06 13:42:11 +02001493 data += transform->ivlen;
1494 rec->data_offset += transform->ivlen;
1495 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001496#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001497
Hanno Beckerd96a6522019-07-10 13:55:25 +01001498 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1499
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1501 transform->iv_dec, transform->ivlen,
1502 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001505 return( ret );
1506 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001507
Hanno Beckerd96a6522019-07-10 13:55:25 +01001508 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001509 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1512 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001513 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001514
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001515 /* Safe since data_len >= minlen + maclen + 1, so after having
1516 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001517 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1518 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001520
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 if( auth_done == 1 )
1522 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001523 const size_t mask = mbedtls_ssl_cf_mask_ge(
1524 rec->data_len,
1525 padlen + 1 );
1526 correct &= mask;
1527 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 }
1529 else
Paul Bakker45829992013-01-03 14:52:21 +01001530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 if( rec->data_len < transform->maclen + padlen + 1 )
1533 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1535 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1536 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 rec->data_len,
1538 transform->maclen,
1539 padlen + 1 ) );
1540 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001541#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001542
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001543 const size_t mask = mbedtls_ssl_cf_mask_ge(
1544 rec->data_len,
1545 transform->maclen + padlen + 1 );
1546 correct &= mask;
1547 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001548 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001549
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001550 padlen++;
1551
1552 /* Regardless of the validity of the padding,
1553 * we have data_len >= padlen here. */
1554
TRodziewicz0f82ec62021-05-12 17:49:18 +02001555#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001556 /* The padding check involves a series of up to 256
1557 * consecutive memory reads at the end of the record
1558 * plaintext buffer. In order to hide the length and
1559 * validity of the padding, always perform exactly
1560 * `min(256,plaintext_len)` reads (but take into account
1561 * only the last `padlen` bytes for the padding check). */
1562 size_t pad_count = 0;
1563 volatile unsigned char* const check = data;
1564
1565 /* Index of first padding byte; it has been ensured above
1566 * that the subtraction is safe. */
1567 size_t const padding_idx = rec->data_len - padlen;
1568 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1569 size_t const start_idx = rec->data_len - num_checks;
1570 size_t idx;
1571
1572 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001573 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001574 /* pad_count += (idx >= padding_idx) &&
1575 * (check[idx] == padlen - 1);
1576 */
1577 const size_t mask = mbedtls_ssl_cf_mask_ge( idx, padding_idx );
1578 const size_t equal = mbedtls_ssl_cf_bool_eq( check[idx],
1579 padlen - 1 );
1580 pad_count += mask & equal;
1581 }
1582 correct &= mbedtls_ssl_cf_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001585 if( padlen > 0 && correct == 0 )
1586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001587#endif
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001588 padlen &= mbedtls_ssl_cf_mask_from_bit( correct );
1589
TRodziewicz0f82ec62021-05-12 17:49:18 +02001590#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001591
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001592 /* If the padding was found to be invalid, padlen == 0
1593 * and the subtraction is safe. If the padding was found valid,
1594 * padlen hasn't been changed and the previous assertion
1595 * data_len >= padlen still holds. */
1596 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001598 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001599#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001600 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001603 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001604
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001605#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001607 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001608#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001609
1610 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001611 * Authenticate if not done yet.
1612 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001613 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001614#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001615 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001616 {
Hanno Becker992b6872017-11-09 18:57:39 +00001617 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001618 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001619
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001620 /* If the initial value of padlen was such that
1621 * data_len < maclen + padlen + 1, then padlen
1622 * got reset to 1, and the initial check
1623 * data_len >= minlen + maclen + 1
1624 * guarantees that at this point we still
1625 * have at least data_len >= maclen.
1626 *
1627 * If the initial value of padlen was such that
1628 * data_len >= maclen + padlen + 1, then we have
1629 * subtracted either padlen + 1 (if the padding was correct)
1630 * or 0 (if the padding was incorrect) since then,
1631 * hence data_len >= maclen in any case.
1632 */
1633 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001634 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001635 transform->minor_ver,
1636 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001637
TRodziewicz0f82ec62021-05-12 17:49:18 +02001638#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001639 /*
1640 * The next two sizes are the minimum and maximum values of
1641 * data_len over all padlen values.
1642 *
1643 * They're independent of padlen, since we previously did
1644 * data_len -= padlen.
1645 *
1646 * Note that max_len + maclen is never more than the buffer
1647 * length, as we previously did in_msglen -= maclen too.
1648 */
1649 const size_t max_len = rec->data_len + padlen;
1650 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1651
1652 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1653 add_data, add_data_len,
1654 data, rec->data_len, min_len, max_len,
1655 mac_expect );
1656 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001657 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001658 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1659 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001660 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001661
1662 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1663 rec->data_len,
1664 min_len, max_len,
1665 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001666#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001667
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001668#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001669 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001670 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001671#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001672
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001673 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001674 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001675 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676#if defined(MBEDTLS_SSL_DEBUG_ALL)
1677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001678#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001679 correct = 0;
1680 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001681 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001682 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001683
1684 /*
1685 * Finally check the correct flag
1686 */
1687 if( correct == 0 )
1688 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001689#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001690
1691 /* Make extra sure authentication was performed, exactly once */
1692 if( auth_done != 1 )
1693 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1695 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001696 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001697
Hanno Beckerccc13d02020-05-04 12:30:04 +01001698#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1699 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1700 {
1701 /* Remove inner padding and infer true content type. */
1702 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1703 &rec->type );
1704
1705 if( ret != 0 )
1706 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1707 }
1708#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1709
Hanno Beckera0e20d02019-05-15 14:03:01 +01001710#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001711 if( rec->cid_len != 0 )
1712 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001713 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1714 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001715 if( ret != 0 )
1716 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1717 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001718#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
1722 return( 0 );
1723}
1724
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001725#undef MAC_NONE
1726#undef MAC_PLAINTEXT
1727#undef MAC_CIPHERTEXT
1728
Paul Bakker5121ce52009-01-03 21:22:43 +00001729/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001730 * Fill the input message buffer by appending data to it.
1731 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001732 *
1733 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1734 * available (from this read and/or a previous one). Otherwise, an error code
1735 * is returned (possibly EOF or WANT_READ).
1736 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001737 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1738 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1739 * since we always read a whole datagram at once.
1740 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001741 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001742 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001745{
Janos Follath865b3eb2019-12-16 11:46:15 +00001746 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001747 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001748#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1749 size_t in_buf_len = ssl->in_buf_len;
1750#else
1751 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1752#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001755
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001756 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001759 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001761 }
1762
Darryl Greenb33cc762019-11-28 14:29:44 +00001763 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001764 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1766 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001767 }
1768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001770 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001771 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001772 uint32_t timeout;
1773
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001774 /*
1775 * The point is, we need to always read a full datagram at once, so we
1776 * sometimes read more then requested, and handle the additional data.
1777 * It could be the rest of the current record (while fetching the
1778 * header) and/or some other records in the same datagram.
1779 */
1780
1781 /*
1782 * Move to the next record in the already read datagram if applicable
1783 */
1784 if( ssl->next_record_offset != 0 )
1785 {
1786 if( ssl->in_left < ssl->next_record_offset )
1787 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1789 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001790 }
1791
1792 ssl->in_left -= ssl->next_record_offset;
1793
1794 if( ssl->in_left != 0 )
1795 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001796 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1797 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001798 ssl->next_record_offset ) );
1799 memmove( ssl->in_hdr,
1800 ssl->in_hdr + ssl->next_record_offset,
1801 ssl->in_left );
1802 }
1803
1804 ssl->next_record_offset = 0;
1805 }
1806
Paul Elliottd48d5c62021-01-07 14:47:05 +00001807 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1808 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001809 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001810
1811 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001812 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001813 */
1814 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001815 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001817 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001818 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001819
1820 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001821 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001822 * are not at the beginning of a new record, the caller did something
1823 * wrong.
1824 */
1825 if( ssl->in_left != 0 )
1826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1828 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001829 }
1830
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001831 /*
1832 * Don't even try to read if time's out already.
1833 * This avoids by-passing the timer when repeatedly receiving messages
1834 * that will end up being dropped.
1835 */
Hanno Becker7876d122020-02-05 10:39:31 +00001836 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001837 {
1838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001839 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001840 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001841 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001842 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001843 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001846 timeout = ssl->handshake->retransmit_timeout;
1847 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001848 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001849
Paul Elliott9f352112020-12-09 14:55:45 +00001850 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001851
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001852 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001853 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1854 timeout );
1855 else
1856 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001859
1860 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001862 }
1863
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001864 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001867 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001870 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001871 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1872 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001874 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001875 }
1876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001878 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001880 return( ret );
1881 }
1882
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001883 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001884 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001886 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001888 {
Hanno Becker786300f2020-02-05 10:46:40 +00001889 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001890 {
Hanno Becker786300f2020-02-05 10:46:40 +00001891 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1892 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001893 return( ret );
1894 }
1895
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001896 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001897 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001899 }
1900
Paul Bakker5121ce52009-01-03 21:22:43 +00001901 if( ret < 0 )
1902 return( ret );
1903
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001904 ssl->in_left = ret;
1905 }
1906 else
1907#endif
1908 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001909 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1910 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001911 ssl->in_left, nb_want ) );
1912
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001913 while( ssl->in_left < nb_want )
1914 {
1915 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001916
Hanno Becker7876d122020-02-05 10:39:31 +00001917 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001918 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1919 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001920 {
1921 if( ssl->f_recv_timeout != NULL )
1922 {
1923 ret = ssl->f_recv_timeout( ssl->p_bio,
1924 ssl->in_hdr + ssl->in_left, len,
1925 ssl->conf->read_timeout );
1926 }
1927 else
1928 {
1929 ret = ssl->f_recv( ssl->p_bio,
1930 ssl->in_hdr + ssl->in_left, len );
1931 }
1932 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001933
Paul Elliottd48d5c62021-01-07 14:47:05 +00001934 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1935 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001936 ssl->in_left, nb_want ) );
1937 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001938
1939 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001941
1942 if( ret < 0 )
1943 return( ret );
1944
makise-homuraaf9513b2020-08-24 18:26:27 +03001945 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001946 {
Darryl Green11999bb2018-03-13 15:22:58 +00001947 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001948 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001949 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001950 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1951 }
1952
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001953 ssl->in_left += ret;
1954 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001955 }
1956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001958
1959 return( 0 );
1960}
1961
1962/*
1963 * Flush any data not yet written
1964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001966{
Janos Follath865b3eb2019-12-16 11:46:15 +00001967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001968 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001971
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001972 if( ssl->f_send == NULL )
1973 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001975 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001977 }
1978
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001979 /* Avoid incrementing counter if data is flushed */
1980 if( ssl->out_left == 0 )
1981 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001983 return( 0 );
1984 }
1985
Paul Bakker5121ce52009-01-03 21:22:43 +00001986 while( ssl->out_left > 0 )
1987 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1989 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001990 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001991
Hanno Becker2b1e3542018-08-06 11:19:13 +01001992 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001993 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001996
1997 if( ret <= 0 )
1998 return( ret );
1999
makise-homuraaf9513b2020-08-24 18:26:27 +03002000 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002001 {
Darryl Green11999bb2018-03-13 15:22:58 +00002002 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002003 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002004 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002005 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2006 }
2007
Paul Bakker5121ce52009-01-03 21:22:43 +00002008 ssl->out_left -= ret;
2009 }
2010
Hanno Becker2b1e3542018-08-06 11:19:13 +01002011#if defined(MBEDTLS_SSL_PROTO_DTLS)
2012 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002013 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002014 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002015 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002016 else
2017#endif
2018 {
2019 ssl->out_hdr = ssl->out_buf + 8;
2020 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002021 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002024
2025 return( 0 );
2026}
2027
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002028/*
2029 * Functions to handle the DTLS retransmission state machine
2030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002032/*
2033 * Append current handshake message to current outgoing flight
2034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002038 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2039 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2040 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002041
2042 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002043 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002044 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002045 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002047 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002048 }
2049
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002050 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002051 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002052 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2053 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002055 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002056 }
2057
2058 /* Copy current handshake message with headers */
2059 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2060 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002061 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002062 msg->next = NULL;
2063
2064 /* Append to the current flight */
2065 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002066 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002067 else
2068 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002070 while( cur->next != NULL )
2071 cur = cur->next;
2072 cur->next = msg;
2073 }
2074
Hanno Becker3b235902018-08-06 09:54:53 +01002075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002076 return( 0 );
2077}
2078
2079/*
2080 * Free the current flight of handshake messages
2081 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002082void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002083{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 mbedtls_ssl_flight_item *cur = flight;
2085 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002086
2087 while( cur != NULL )
2088 {
2089 next = cur->next;
2090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 mbedtls_free( cur->p );
2092 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002093
2094 cur = next;
2095 }
2096}
2097
2098/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002099 * Swap transform_out and out_ctr with the alternative ones
2100 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002101static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002102{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002104 unsigned char tmp_out_ctr[8];
2105
2106 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2107 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002109 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002110 }
2111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002113
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002114 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002115 tmp_transform = ssl->transform_out;
2116 ssl->transform_out = ssl->handshake->alt_transform_out;
2117 ssl->handshake->alt_transform_out = tmp_transform;
2118
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002119 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002120 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2121 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002122 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002123
2124 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002125 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002126
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002127 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002128}
2129
2130/*
2131 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002132 */
2133int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2134{
2135 int ret = 0;
2136
2137 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2138
2139 ret = mbedtls_ssl_flight_transmit( ssl );
2140
2141 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2142
2143 return( ret );
2144}
2145
2146/*
2147 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002148 *
2149 * Need to remember the current message in case flush_output returns
2150 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002151 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002152 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002153int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002154{
Janos Follath865b3eb2019-12-16 11:46:15 +00002155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002156 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002159 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002160 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002161
2162 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002163 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002164 ret = ssl_swap_epochs( ssl );
2165 if( ret != 0 )
2166 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002169 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002170
2171 while( ssl->handshake->cur_msg != NULL )
2172 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002173 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002174 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002175
Hanno Beckere1dcb032018-08-17 16:47:58 +01002176 int const is_finished =
2177 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2178 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2179
Hanno Becker04da1892018-08-14 13:22:10 +01002180 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2181 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2182
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002183 /* Swap epochs before sending Finished: we can't do it after
2184 * sending ChangeCipherSpec, in case write returns WANT_READ.
2185 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002186 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002187 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002188 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002189 ret = ssl_swap_epochs( ssl );
2190 if( ret != 0 )
2191 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002192 }
2193
Hanno Becker67bc7c32018-08-06 11:33:50 +01002194 ret = ssl_get_remaining_payload_in_datagram( ssl );
2195 if( ret < 0 )
2196 return( ret );
2197 max_frag_len = (size_t) ret;
2198
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002199 /* CCS is copied as is, while HS messages may need fragmentation */
2200 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2201 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002202 if( max_frag_len == 0 )
2203 {
2204 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2205 return( ret );
2206
2207 continue;
2208 }
2209
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002210 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002211 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002212 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002213
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002214 /* Update position inside current message */
2215 ssl->handshake->cur_msg_p += cur->len;
2216 }
2217 else
2218 {
2219 const unsigned char * const p = ssl->handshake->cur_msg_p;
2220 const size_t hs_len = cur->len - 12;
2221 const size_t frag_off = p - ( cur->p + 12 );
2222 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002223 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002224
Hanno Beckere1dcb032018-08-17 16:47:58 +01002225 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002226 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002227 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002228 {
2229 ret = ssl_swap_epochs( ssl );
2230 if( ret != 0 )
2231 return( ret );
2232 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002233
Hanno Becker67bc7c32018-08-06 11:33:50 +01002234 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2235 return( ret );
2236
2237 continue;
2238 }
2239 max_hs_frag_len = max_frag_len - 12;
2240
2241 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2242 max_hs_frag_len : rem_len;
2243
2244 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002245 {
2246 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002247 (unsigned) cur_hs_frag_len,
2248 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002249 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002250
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002251 /* Messages are stored with handshake headers as if not fragmented,
2252 * copy beginning of headers then fill fragmentation fields.
2253 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2254 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani6f2bb0c2021-06-24 09:06:23 +01002255
Joe Subbiani5ecac212021-06-24 13:00:03 +01002256 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2257 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2258 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002259
Joe Subbiani5ecac212021-06-24 13:00:03 +01002260 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2261 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2262 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002263
2264 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2265
Hanno Becker3f7b9732018-08-28 09:53:25 +01002266 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002267 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2268 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002269 ssl->out_msgtype = cur->type;
2270
2271 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002272 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002273 }
2274
2275 /* If done with the current message move to the next one if any */
2276 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2277 {
2278 if( cur->next != NULL )
2279 {
2280 ssl->handshake->cur_msg = cur->next;
2281 ssl->handshake->cur_msg_p = cur->next->p + 12;
2282 }
2283 else
2284 {
2285 ssl->handshake->cur_msg = NULL;
2286 ssl->handshake->cur_msg_p = NULL;
2287 }
2288 }
2289
2290 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002291 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002292 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002294 return( ret );
2295 }
2296 }
2297
Hanno Becker67bc7c32018-08-06 11:33:50 +01002298 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2299 return( ret );
2300
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002301 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002302 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2303 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002304 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002305 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002307 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002308 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002309
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002310 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002311
2312 return( 0 );
2313}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002314
2315/*
2316 * To be called when the last message of an incoming flight is received.
2317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002319{
2320 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002321 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002322 ssl->handshake->flight = NULL;
2323 ssl->handshake->cur_msg = NULL;
2324
2325 /* The next incoming flight will start with this msg_seq */
2326 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2327
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002328 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002329 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002330
Hanno Becker0271f962018-08-16 13:23:47 +01002331 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002332 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002333
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002334 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002335 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2338 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002339 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002341 }
2342 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002344}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002345
2346/*
2347 * To be called when the last message of an outgoing flight is send.
2348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002350{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002351 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002352 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2355 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002356 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002358 }
2359 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002361}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002363
Paul Bakker5121ce52009-01-03 21:22:43 +00002364/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002365 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002366 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002367
2368/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002369 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002370 *
2371 * - fill in handshake headers
2372 * - update handshake checksum
2373 * - DTLS: save message for resending
2374 * - then pass to the record layer
2375 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002376 * DTLS: except for HelloRequest, messages are only queued, and will only be
2377 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002378 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002379 * Inputs:
2380 * - ssl->out_msglen: 4 + actual handshake message len
2381 * (4 is the size of handshake headers for TLS)
2382 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2383 * - ssl->out_msg + 4: the handshake message body
2384 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002385 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002386 * - ssl->out_msglen: the length of the record contents
2387 * (including handshake headers but excluding record headers)
2388 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002389 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002390int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2391 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002392{
Janos Follath865b3eb2019-12-16 11:46:15 +00002393 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002394 const size_t hs_len = ssl->out_msglen - 4;
2395 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002396
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002397 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2398
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002399 /*
2400 * Sanity checks
2401 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002402 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002403 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2404 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002405 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2406 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002407 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002408
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002409 /* Whenever we send anything different from a
2410 * HelloRequest we should be in a handshake - double check. */
2411 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2412 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002413 ssl->handshake == NULL )
2414 {
2415 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2416 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2417 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002420 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002421 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002422 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002423 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2425 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002426 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002427#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002428
Hanno Beckerb50a2532018-08-06 11:52:54 +01002429 /* Double-check that we did not exceed the bounds
2430 * of the outgoing record buffer.
2431 * This should never fail as the various message
2432 * writing functions must obey the bounds of the
2433 * outgoing record buffer, but better be safe.
2434 *
2435 * Note: We deliberately do not check for the MTU or MFL here.
2436 */
2437 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2438 {
2439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002440 "size %" MBEDTLS_PRINTF_SIZET
2441 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002442 ssl->out_msglen,
2443 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002444 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2445 }
2446
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002447 /*
2448 * Fill handshake headers
2449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002451 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002452 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2453 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2454 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002455
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002456 /*
2457 * DTLS has additional fields in the Handshake layer,
2458 * between the length field and the actual payload:
2459 * uint16 message_seq;
2460 * uint24 fragment_offset;
2461 * uint24 fragment_length;
2462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002464 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002465 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002466 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002467 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002468 {
2469 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002470 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002471 hs_len,
2472 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002473 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2474 }
2475
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002476 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002477 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002478
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002479 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002480 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002481 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002482 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002483 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002484 }
2485 else
2486 {
2487 ssl->out_msg[4] = 0;
2488 ssl->out_msg[5] = 0;
2489 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002490
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002491 /* Handshake hashes are computed without fragmentation,
2492 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002493 memset( ssl->out_msg + 6, 0x00, 3 );
2494 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002495 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002497
Hanno Becker0207e532018-08-28 10:28:28 +01002498 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002499 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002500 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002501 }
2502
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002503 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002505 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002506 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2507 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002508 {
2509 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002512 return( ret );
2513 }
2514 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002515 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002516#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002518 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519 {
2520 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2521 return( ret );
2522 }
2523 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002524
2525 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2526
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002527 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002528}
2529
2530/*
2531 * Record layer functions
2532 */
2533
2534/*
2535 * Write current record.
2536 *
2537 * Uses:
2538 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2539 * - ssl->out_msglen: length of the record content (excl headers)
2540 * - ssl->out_msg: record content
2541 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002542int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002543{
2544 int ret, done = 0;
2545 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002546 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002547
2548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002549
Paul Bakker05ef8352012-05-08 09:17:57 +00002550 if( !done )
2551 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002552 unsigned i;
2553 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002554#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2555 size_t out_buf_len = ssl->out_buf_len;
2556#else
2557 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2558#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002559 /* Skip writing the record content type to after the encryption,
2560 * as it may change when using the CID extension. */
2561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002563 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002564
Hanno Becker19859472018-08-06 09:40:20 +01002565 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002566 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002567
Paul Bakker48916f92012-09-16 19:57:18 +00002568 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002569 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002570 mbedtls_record rec;
2571
2572 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002573 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002574 rec.data_len = ssl->out_msglen;
2575 rec.data_offset = ssl->out_msg - rec.buf;
2576
2577 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2578 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2579 ssl->conf->transport, rec.ver );
2580 rec.type = ssl->out_msgtype;
2581
Hanno Beckera0e20d02019-05-15 14:03:01 +01002582#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002583 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002584 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002585#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002586
Hanno Beckera18d1322018-01-03 14:27:32 +00002587 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002588 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002591 return( ret );
2592 }
2593
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002594 if( rec.data_offset != 0 )
2595 {
2596 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2597 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2598 }
2599
Hanno Becker6430faf2019-05-08 11:57:13 +01002600 /* Update the record content type and CID. */
2601 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002602#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002603 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002604#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002605 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002606 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002607 }
2608
Hanno Becker5903de42019-05-03 14:46:38 +01002609 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002610
2611#if defined(MBEDTLS_SSL_PROTO_DTLS)
2612 /* In case of DTLS, double-check that we don't exceed
2613 * the remaining space in the datagram. */
2614 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2615 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002616 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002617 if( ret < 0 )
2618 return( ret );
2619
2620 if( protected_record_size > (size_t) ret )
2621 {
2622 /* Should never happen */
2623 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2624 }
2625 }
2626#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002627
Hanno Becker6430faf2019-05-08 11:57:13 +01002628 /* Now write the potentially updated record content type. */
2629 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2630
Paul Elliott9f352112020-12-09 14:55:45 +00002631 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002632 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002633 ssl->out_hdr[0], ssl->out_hdr[1],
2634 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002635
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002637 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002638
2639 ssl->out_left += protected_record_size;
2640 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002641 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002642
Hanno Beckerdd772292020-02-05 10:38:31 +00002643 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002644 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2645 break;
2646
2647 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002648 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002649 {
2650 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2651 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2652 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002653 }
2654
Hanno Becker67bc7c32018-08-06 11:33:50 +01002655#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002656 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2657 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002658 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002659 size_t remaining;
2660 ret = ssl_get_remaining_payload_in_datagram( ssl );
2661 if( ret < 0 )
2662 {
2663 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2664 ret );
2665 return( ret );
2666 }
2667
2668 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002669 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002670 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002671 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002672 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002673 else
2674 {
Hanno Becker513815a2018-08-20 11:56:09 +01002675 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002676 }
2677 }
2678#endif /* MBEDTLS_SSL_PROTO_DTLS */
2679
2680 if( ( flush == SSL_FORCE_FLUSH ) &&
2681 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002682 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002684 return( ret );
2685 }
2686
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002688
2689 return( 0 );
2690}
2691
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002693
2694static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2695{
2696 if( ssl->in_msglen < ssl->in_hslen ||
2697 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2698 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2699 {
2700 return( 1 );
2701 }
2702 return( 0 );
2703}
Hanno Becker44650b72018-08-16 12:51:11 +01002704
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002705static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002706{
2707 return( ( ssl->in_msg[9] << 16 ) |
2708 ( ssl->in_msg[10] << 8 ) |
2709 ssl->in_msg[11] );
2710}
2711
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002712static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002713{
2714 return( ( ssl->in_msg[6] << 16 ) |
2715 ( ssl->in_msg[7] << 8 ) |
2716 ssl->in_msg[8] );
2717}
2718
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002719static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002720{
2721 uint32_t msg_len, frag_off, frag_len;
2722
2723 msg_len = ssl_get_hs_total_len( ssl );
2724 frag_off = ssl_get_hs_frag_off( ssl );
2725 frag_len = ssl_get_hs_frag_len( ssl );
2726
2727 if( frag_off > msg_len )
2728 return( -1 );
2729
2730 if( frag_len > msg_len - frag_off )
2731 return( -1 );
2732
2733 if( frag_len + 12 > ssl->in_msglen )
2734 return( -1 );
2735
2736 return( 0 );
2737}
2738
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002739/*
2740 * Mark bits in bitmask (used for DTLS HS reassembly)
2741 */
2742static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2743{
2744 unsigned int start_bits, end_bits;
2745
2746 start_bits = 8 - ( offset % 8 );
2747 if( start_bits != 8 )
2748 {
2749 size_t first_byte_idx = offset / 8;
2750
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002751 /* Special case */
2752 if( len <= start_bits )
2753 {
2754 for( ; len != 0; len-- )
2755 mask[first_byte_idx] |= 1 << ( start_bits - len );
2756
2757 /* Avoid potential issues with offset or len becoming invalid */
2758 return;
2759 }
2760
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002761 offset += start_bits; /* Now offset % 8 == 0 */
2762 len -= start_bits;
2763
2764 for( ; start_bits != 0; start_bits-- )
2765 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2766 }
2767
2768 end_bits = len % 8;
2769 if( end_bits != 0 )
2770 {
2771 size_t last_byte_idx = ( offset + len ) / 8;
2772
2773 len -= end_bits; /* Now len % 8 == 0 */
2774
2775 for( ; end_bits != 0; end_bits-- )
2776 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2777 }
2778
2779 memset( mask + offset / 8, 0xFF, len / 8 );
2780}
2781
2782/*
2783 * Check that bitmask is full
2784 */
2785static int ssl_bitmask_check( unsigned char *mask, size_t len )
2786{
2787 size_t i;
2788
2789 for( i = 0; i < len / 8; i++ )
2790 if( mask[i] != 0xFF )
2791 return( -1 );
2792
2793 for( i = 0; i < len % 8; i++ )
2794 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2795 return( -1 );
2796
2797 return( 0 );
2798}
2799
Hanno Becker56e205e2018-08-16 09:06:12 +01002800/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002801static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002802 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002803{
Hanno Becker56e205e2018-08-16 09:06:12 +01002804 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002805
Hanno Becker56e205e2018-08-16 09:06:12 +01002806 alloc_len = 12; /* Handshake header */
2807 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002808
Hanno Beckerd07df862018-08-16 09:14:58 +01002809 if( add_bitmap )
2810 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002811
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002812 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002813}
Hanno Becker56e205e2018-08-16 09:06:12 +01002814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002816
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002817static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002818{
2819 return( ( ssl->in_msg[1] << 16 ) |
2820 ( ssl->in_msg[2] << 8 ) |
2821 ssl->in_msg[3] );
2822}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002823
Simon Butcher99000142016-10-13 17:21:01 +01002824int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002825{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002827 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002828 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002829 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002831 }
2832
Hanno Becker12555c62018-08-16 12:47:53 +01002833 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002836 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002837 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002840 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002841 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002842 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002843 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002844
Hanno Becker44650b72018-08-16 12:51:11 +01002845 if( ssl_check_hs_header( ssl ) != 0 )
2846 {
2847 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2848 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2849 }
2850
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002851 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002852 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2853 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2854 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2855 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002856 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002857 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2858 {
2859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2860 recv_msg_seq,
2861 ssl->handshake->in_msg_seq ) );
2862 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2863 }
2864
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002865 /* Retransmit only on last message from previous flight, to avoid
2866 * too many retransmissions.
2867 * Besides, No sane server ever retransmits HelloVerifyRequest */
2868 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002870 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002872 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002873 recv_msg_seq,
2874 ssl->handshake->in_flight_start_seq ) );
2875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002877 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002879 return( ret );
2880 }
2881 }
2882 else
2883 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002885 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002886 recv_msg_seq,
2887 ssl->handshake->in_msg_seq ) );
2888 }
2889
Hanno Becker90333da2017-10-10 11:27:13 +01002890 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002891 }
2892 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002893
Hanno Becker6d97ef52018-08-16 13:09:04 +01002894 /* Message reassembly is handled alongside buffering of future
2895 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002896 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002897 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002898 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002899 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002900 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002901 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002902 }
2903 }
2904 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002906 /* With TLS we don't handle fragmentation (for now) */
2907 if( ssl->in_msglen < ssl->in_hslen )
2908 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002909 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2910 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002911 }
2912
Simon Butcher99000142016-10-13 17:21:01 +01002913 return( 0 );
2914}
2915
2916void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2917{
Hanno Becker0271f962018-08-16 13:23:47 +01002918 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002919
Hanno Becker0271f962018-08-16 13:23:47 +01002920 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002921 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002922 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002923 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002924
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002925 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002927 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002928 ssl->handshake != NULL )
2929 {
Hanno Becker0271f962018-08-16 13:23:47 +01002930 unsigned offset;
2931 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002932
Hanno Becker0271f962018-08-16 13:23:47 +01002933 /* Increment handshake sequence number */
2934 hs->in_msg_seq++;
2935
2936 /*
2937 * Clear up handshake buffering and reassembly structure.
2938 */
2939
2940 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002941 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002942
2943 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002944 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2945 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002946 offset++, hs_buf++ )
2947 {
2948 *hs_buf = *(hs_buf + 1);
2949 }
2950
2951 /* Create a fresh last entry */
2952 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002953 }
2954#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002955}
2956
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002957/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002958 * DTLS anti-replay: RFC 6347 4.1.2.6
2959 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002960 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2961 * Bit n is set iff record number in_window_top - n has been seen.
2962 *
2963 * Usually, in_window_top is the last record number seen and the lsb of
2964 * in_window is set. The only exception is the initial state (record number 0
2965 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002968void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002969{
2970 ssl->in_window_top = 0;
2971 ssl->in_window = 0;
2972}
2973
2974static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2975{
2976 return( ( (uint64_t) buf[0] << 40 ) |
2977 ( (uint64_t) buf[1] << 32 ) |
2978 ( (uint64_t) buf[2] << 24 ) |
2979 ( (uint64_t) buf[3] << 16 ) |
2980 ( (uint64_t) buf[4] << 8 ) |
2981 ( (uint64_t) buf[5] ) );
2982}
2983
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002984static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2985{
Janos Follath865b3eb2019-12-16 11:46:15 +00002986 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002987 unsigned char *original_in_ctr;
2988
2989 // save original in_ctr
2990 original_in_ctr = ssl->in_ctr;
2991
2992 // use counter from record
2993 ssl->in_ctr = record_in_ctr;
2994
2995 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2996
2997 // restore the counter
2998 ssl->in_ctr = original_in_ctr;
2999
3000 return ret;
3001}
3002
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003003/*
3004 * Return 0 if sequence number is acceptable, -1 otherwise
3005 */
Hanno Becker0183d692019-07-12 08:50:37 +01003006int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003007{
3008 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3009 uint64_t bit;
3010
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003011 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003012 return( 0 );
3013
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003014 if( rec_seqnum > ssl->in_window_top )
3015 return( 0 );
3016
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003017 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003018
3019 if( bit >= 64 )
3020 return( -1 );
3021
3022 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3023 return( -1 );
3024
3025 return( 0 );
3026}
3027
3028/*
3029 * Update replay window on new validated record
3030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003032{
3033 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3034
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003035 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003036 return;
3037
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003038 if( rec_seqnum > ssl->in_window_top )
3039 {
3040 /* Update window_top and the contents of the window */
3041 uint64_t shift = rec_seqnum - ssl->in_window_top;
3042
3043 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003044 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003045 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003046 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003047 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003048 ssl->in_window |= 1;
3049 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003050
3051 ssl->in_window_top = rec_seqnum;
3052 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003053 else
3054 {
3055 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003056 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003057
3058 if( bit < 64 ) /* Always true, but be extra sure */
3059 ssl->in_window |= (uint64_t) 1 << bit;
3060 }
3061}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003063
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003064#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003065/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003066 * Without any SSL context, check if a datagram looks like a ClientHello with
3067 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003068 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003069 *
3070 * - if cookie is valid, return 0
3071 * - if ClientHello looks superficially valid but cookie is not,
3072 * fill obuf and set olen, then
3073 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3074 * - otherwise return a specific error code
3075 */
3076static int ssl_check_dtls_clihlo_cookie(
3077 mbedtls_ssl_cookie_write_t *f_cookie_write,
3078 mbedtls_ssl_cookie_check_t *f_cookie_check,
3079 void *p_cookie,
3080 const unsigned char *cli_id, size_t cli_id_len,
3081 const unsigned char *in, size_t in_len,
3082 unsigned char *obuf, size_t buf_len, size_t *olen )
3083{
3084 size_t sid_len, cookie_len;
3085 unsigned char *p;
3086
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003087 /*
3088 * Structure of ClientHello with record and handshake headers,
3089 * and expected values. We don't need to check a lot, more checks will be
3090 * done when actually parsing the ClientHello - skipping those checks
3091 * avoids code duplication and does not make cookie forging any easier.
3092 *
3093 * 0-0 ContentType type; copied, must be handshake
3094 * 1-2 ProtocolVersion version; copied
3095 * 3-4 uint16 epoch; copied, must be 0
3096 * 5-10 uint48 sequence_number; copied
3097 * 11-12 uint16 length; (ignored)
3098 *
3099 * 13-13 HandshakeType msg_type; (ignored)
3100 * 14-16 uint24 length; (ignored)
3101 * 17-18 uint16 message_seq; copied
3102 * 19-21 uint24 fragment_offset; copied, must be 0
3103 * 22-24 uint24 fragment_length; (ignored)
3104 *
3105 * 25-26 ProtocolVersion client_version; (ignored)
3106 * 27-58 Random random; (ignored)
3107 * 59-xx SessionID session_id; 1 byte len + sid_len content
3108 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3109 * ...
3110 *
3111 * Minimum length is 61 bytes.
3112 */
3113 if( in_len < 61 ||
3114 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3115 in[3] != 0 || in[4] != 0 ||
3116 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3117 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003118 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003119 }
3120
3121 sid_len = in[59];
3122 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003123 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003124
3125 cookie_len = in[60 + sid_len];
3126 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003127 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003128
3129 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3130 cli_id, cli_id_len ) == 0 )
3131 {
3132 /* Valid cookie */
3133 return( 0 );
3134 }
3135
3136 /*
3137 * If we get here, we've got an invalid cookie, let's prepare HVR.
3138 *
3139 * 0-0 ContentType type; copied
3140 * 1-2 ProtocolVersion version; copied
3141 * 3-4 uint16 epoch; copied
3142 * 5-10 uint48 sequence_number; copied
3143 * 11-12 uint16 length; olen - 13
3144 *
3145 * 13-13 HandshakeType msg_type; hello_verify_request
3146 * 14-16 uint24 length; olen - 25
3147 * 17-18 uint16 message_seq; copied
3148 * 19-21 uint24 fragment_offset; copied
3149 * 22-24 uint24 fragment_length; olen - 25
3150 *
3151 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3152 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3153 *
3154 * Minimum length is 28.
3155 */
3156 if( buf_len < 28 )
3157 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3158
3159 /* Copy most fields and adapt others */
3160 memcpy( obuf, in, 25 );
3161 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3162 obuf[25] = 0xfe;
3163 obuf[26] = 0xff;
3164
3165 /* Generate and write actual cookie */
3166 p = obuf + 28;
3167 if( f_cookie_write( p_cookie,
3168 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3169 {
3170 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3171 }
3172
3173 *olen = p - obuf;
3174
3175 /* Go back and fill length fields */
3176 obuf[27] = (unsigned char)( *olen - 28 );
3177
Joe Subbianifbeb6922021-07-16 14:27:50 +01003178 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3179 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3180 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003181
Joe Subbiani6dd73642021-07-19 11:56:54 +01003182 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003183
3184 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3185}
3186
3187/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003188 * Handle possible client reconnect with the same UDP quadruplet
3189 * (RFC 6347 Section 4.2.8).
3190 *
3191 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3192 * that looks like a ClientHello.
3193 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003194 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003195 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003196 * - if the input looks like a ClientHello with a valid cookie,
3197 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003198 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003199 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003200 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003201 * This function is called (through ssl_check_client_reconnect()) when an
3202 * unexpected record is found in ssl_get_next_record(), which will discard the
3203 * record if we return 0, and bubble up the return value otherwise (this
3204 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3205 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003206 */
3207static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3208{
Janos Follath865b3eb2019-12-16 11:46:15 +00003209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003210 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003211
Hanno Becker2fddd372019-07-10 14:37:41 +01003212 if( ssl->conf->f_cookie_write == NULL ||
3213 ssl->conf->f_cookie_check == NULL )
3214 {
3215 /* If we can't use cookies to verify reachability of the peer,
3216 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003217 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3218 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003219 return( 0 );
3220 }
3221
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003222 ret = ssl_check_dtls_clihlo_cookie(
3223 ssl->conf->f_cookie_write,
3224 ssl->conf->f_cookie_check,
3225 ssl->conf->p_cookie,
3226 ssl->cli_id, ssl->cli_id_len,
3227 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003228 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003229
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003230 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3231
3232 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003233 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003234 int send_ret;
3235 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3236 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3237 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003238 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003239 * If the error is permanent we'll catch it later,
3240 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003241 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3242 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3243 (void) send_ret;
3244
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003245 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003246 }
3247
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003248 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003249 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003250 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003251 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003252 {
3253 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3254 return( ret );
3255 }
3256
3257 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003258 }
3259
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003260 return( ret );
3261}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003262#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003263
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003264static int ssl_check_record_type( uint8_t record_type )
3265{
3266 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3267 record_type != MBEDTLS_SSL_MSG_ALERT &&
3268 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3269 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3270 {
3271 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3272 }
3273
3274 return( 0 );
3275}
3276
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003277/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003278 * ContentType type;
3279 * ProtocolVersion version;
3280 * uint16 epoch; // DTLS only
3281 * uint48 sequence_number; // DTLS only
3282 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003283 *
3284 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003285 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003286 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3287 *
3288 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003289 * 1. proceed with the record if this function returns 0
3290 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3291 * 3. return CLIENT_RECONNECT if this function return that value
3292 * 4. drop the whole datagram if this function returns anything else.
3293 * Point 2 is needed when the peer is resending, and we have already received
3294 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003295 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003296static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003297 unsigned char *buf,
3298 size_t len,
3299 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003300{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003301 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003302
Hanno Beckere5e7e782019-07-11 12:29:35 +01003303 size_t const rec_hdr_type_offset = 0;
3304 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003305
Hanno Beckere5e7e782019-07-11 12:29:35 +01003306 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3307 rec_hdr_type_len;
3308 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003309
Hanno Beckere5e7e782019-07-11 12:29:35 +01003310 size_t const rec_hdr_ctr_len = 8;
3311#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003312 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003313 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3314 rec_hdr_version_len;
3315
Hanno Beckera0e20d02019-05-15 14:03:01 +01003316#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003317 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3318 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003319 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003320#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3321#endif /* MBEDTLS_SSL_PROTO_DTLS */
3322
3323 size_t rec_hdr_len_offset; /* To be determined */
3324 size_t const rec_hdr_len_len = 2;
3325
3326 /*
3327 * Check minimum lengths for record header.
3328 */
3329
3330#if defined(MBEDTLS_SSL_PROTO_DTLS)
3331 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3332 {
3333 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3334 }
3335 else
3336#endif /* MBEDTLS_SSL_PROTO_DTLS */
3337 {
3338 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3339 }
3340
3341 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3342 {
3343 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3344 (unsigned) len,
3345 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3346 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3347 }
3348
3349 /*
3350 * Parse and validate record content type
3351 */
3352
3353 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003354
3355 /* Check record content type */
3356#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3357 rec->cid_len = 0;
3358
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003359 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003360 ssl->conf->cid_len != 0 &&
3361 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003362 {
3363 /* Shift pointers to account for record header including CID
3364 * struct {
3365 * ContentType special_type = tls12_cid;
3366 * ProtocolVersion version;
3367 * uint16 epoch;
3368 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003369 * opaque cid[cid_length]; // Additional field compared to
3370 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003371 * uint16 length;
3372 * opaque enc_content[DTLSCiphertext.length];
3373 * } DTLSCiphertext;
3374 */
3375
3376 /* So far, we only support static CID lengths
3377 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003378 rec_hdr_cid_len = ssl->conf->cid_len;
3379 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003380
Hanno Beckere5e7e782019-07-11 12:29:35 +01003381 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003382 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003383 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3384 (unsigned) len,
3385 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003386 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003387 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003388
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003389 /* configured CID len is guaranteed at most 255, see
3390 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3391 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003392 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003393 }
3394 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003395#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003396 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003397 if( ssl_check_record_type( rec->type ) )
3398 {
Hanno Becker54229812019-07-12 14:40:00 +01003399 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3400 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003401 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3402 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003403 }
3404
Hanno Beckere5e7e782019-07-11 12:29:35 +01003405 /*
3406 * Parse and validate record version
3407 */
3408
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003409 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3410 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003411 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3412 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003413 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003414
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003415 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003416 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3418 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003419 }
3420
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003421 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003422 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3424 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 }
3426
Hanno Beckere5e7e782019-07-11 12:29:35 +01003427 /*
3428 * Parse/Copy record sequence number.
3429 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003430
Hanno Beckere5e7e782019-07-11 12:29:35 +01003431#if defined(MBEDTLS_SSL_PROTO_DTLS)
3432 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003433 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003434 /* Copy explicit record sequence number from input buffer. */
3435 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3436 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003437 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003438 else
3439#endif /* MBEDTLS_SSL_PROTO_DTLS */
3440 {
3441 /* Copy implicit record sequence number from SSL context structure. */
3442 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3443 }
Paul Bakker40e46942009-01-03 21:51:57 +00003444
Hanno Beckere5e7e782019-07-11 12:29:35 +01003445 /*
3446 * Parse record length.
3447 */
3448
Hanno Beckere5e7e782019-07-11 12:29:35 +01003449 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003450 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3451 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003452 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003453
Paul Elliott9f352112020-12-09 14:55:45 +00003454 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003455 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003456 rec->type,
3457 major_ver, minor_ver, rec->data_len ) );
3458
3459 rec->buf = buf;
3460 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003461
Hanno Beckerd417cc92019-07-26 08:20:27 +01003462 if( rec->data_len == 0 )
3463 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003464
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003465 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003466 * DTLS-related tests.
3467 * Check epoch before checking length constraint because
3468 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3469 * message gets duplicated before the corresponding Finished message,
3470 * the second ChangeCipherSpec should be discarded because it belongs
3471 * to an old epoch, but not because its length is shorter than
3472 * the minimum record length for packets using the new record transform.
3473 * Note that these two kinds of failures are handled differently,
3474 * as an unexpected record is silently skipped but an invalid
3475 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003476 */
3477#if defined(MBEDTLS_SSL_PROTO_DTLS)
3478 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3479 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003480 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003481
Hanno Becker955a5c92019-07-10 17:12:07 +01003482 /* Check that the datagram is large enough to contain a record
3483 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003484 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003485 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3487 (unsigned) len,
3488 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003489 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3490 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003491
Hanno Becker37cfe732019-07-10 17:20:01 +01003492 /* Records from other, non-matching epochs are silently discarded.
3493 * (The case of same-port Client reconnects must be considered in
3494 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003495 if( rec_epoch != ssl->in_epoch )
3496 {
3497 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003498 "expected %u, received %lu",
3499 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003500
Hanno Becker552f7472019-07-19 10:59:12 +01003501 /* Records from the next epoch are considered for buffering
3502 * (concretely: early Finished messages). */
3503 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003504 {
Hanno Becker552f7472019-07-19 10:59:12 +01003505 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3506 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003507 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003508
Hanno Becker2fddd372019-07-10 14:37:41 +01003509 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003510 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003511#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003512 /* For records from the correct epoch, check whether their
3513 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003514 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3515 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003516 {
3517 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3518 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3519 }
3520#endif
3521 }
3522#endif /* MBEDTLS_SSL_PROTO_DTLS */
3523
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003524 return( 0 );
3525}
Paul Bakker5121ce52009-01-03 21:22:43 +00003526
Paul Bakker5121ce52009-01-03 21:22:43 +00003527
Hanno Becker2fddd372019-07-10 14:37:41 +01003528#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3529static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3530{
3531 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3532
3533 /*
3534 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3535 * access the first byte of record content (handshake type), as we
3536 * have an active transform (possibly iv_len != 0), so use the
3537 * fact that the record header len is 13 instead.
3538 */
3539 if( rec_epoch == 0 &&
3540 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3541 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3542 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3543 ssl->in_left > 13 &&
3544 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3545 {
3546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3547 "from the same port" ) );
3548 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003549 }
3550
3551 return( 0 );
3552}
Hanno Becker2fddd372019-07-10 14:37:41 +01003553#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003554
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003555/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003556 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003557 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003558static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3559 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003560{
3561 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003564 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003565
Paul Bakker48916f92012-09-16 19:57:18 +00003566 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003567 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003568 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003569
Hanno Beckera18d1322018-01-03 14:27:32 +00003570 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003571 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003572 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003574
Hanno Beckera0e20d02019-05-15 14:03:01 +01003575#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003576 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3577 ssl->conf->ignore_unexpected_cid
3578 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3579 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003580 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003581 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003582 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003583#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003584
Paul Bakker5121ce52009-01-03 21:22:43 +00003585 return( ret );
3586 }
3587
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003588 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003589 {
3590 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003591 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003592 }
3593
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003594 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003595 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003596
Hanno Beckera0e20d02019-05-15 14:03:01 +01003597#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003598 /* We have already checked the record content type
3599 * in ssl_parse_record_header(), failing or silently
3600 * dropping the record in the case of an unknown type.
3601 *
3602 * Since with the use of CIDs, the record content type
3603 * might change during decryption, re-check the record
3604 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003605 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003606 {
3607 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3608 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3609 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003610#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003611
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003612 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003613 {
3614#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3615 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003616 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003617 {
3618 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3620 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3621 }
3622#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3623
3624 ssl->nb_zero++;
3625
3626 /*
3627 * Three or more empty messages may be a DoS attack
3628 * (excessive CPU consumption).
3629 */
3630 if( ssl->nb_zero > 3 )
3631 {
3632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003633 "messages, possible DoS attack" ) );
3634 /* Treat the records as if they were not properly authenticated,
3635 * thereby failing the connection if we see more than allowed
3636 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003637 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3638 }
3639 }
3640 else
3641 ssl->nb_zero = 0;
3642
3643#if defined(MBEDTLS_SSL_PROTO_DTLS)
3644 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3645 {
3646 ; /* in_ctr read from peer, not maintained internally */
3647 }
3648 else
3649#endif
3650 {
3651 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003652 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003653 if( ++ssl->in_ctr[i - 1] != 0 )
3654 break;
3655
3656 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003657 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003658 {
3659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3660 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3661 }
3662 }
3663
Paul Bakker5121ce52009-01-03 21:22:43 +00003664 }
3665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003666#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003667 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003668 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003669 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003670 }
3671#endif
3672
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003673 /* Check actual (decrypted) record content length against
3674 * configured maximum. */
3675 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3676 {
3677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3678 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3679 }
3680
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003681 return( 0 );
3682}
3683
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003684/*
3685 * Read a record.
3686 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003687 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3688 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3689 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003690 */
Hanno Becker1097b342018-08-15 14:09:41 +01003691
3692/* Helper functions for mbedtls_ssl_read_record(). */
3693static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003694static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3695static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003696
Hanno Becker327c93b2018-08-15 13:56:18 +01003697int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003698 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003699{
Janos Follath865b3eb2019-12-16 11:46:15 +00003700 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003703
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003704 if( ssl->keep_current_message == 0 )
3705 {
3706 do {
Simon Butcher99000142016-10-13 17:21:01 +01003707
Hanno Becker26994592018-08-15 14:14:59 +01003708 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003709 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003710 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003711
Hanno Beckere74d5562018-08-15 14:26:08 +01003712 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003713 {
Hanno Becker40f50842018-08-15 14:48:01 +01003714#if defined(MBEDTLS_SSL_PROTO_DTLS)
3715 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003716
Hanno Becker40f50842018-08-15 14:48:01 +01003717 /* We only check for buffered messages if the
3718 * current datagram is fully consumed. */
3719 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003720 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003721 {
Hanno Becker40f50842018-08-15 14:48:01 +01003722 if( ssl_load_buffered_message( ssl ) == 0 )
3723 have_buffered = 1;
3724 }
3725
3726 if( have_buffered == 0 )
3727#endif /* MBEDTLS_SSL_PROTO_DTLS */
3728 {
3729 ret = ssl_get_next_record( ssl );
3730 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3731 continue;
3732
3733 if( ret != 0 )
3734 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003735 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003736 return( ret );
3737 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003738 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003739 }
3740
3741 ret = mbedtls_ssl_handle_message_type( ssl );
3742
Hanno Becker40f50842018-08-15 14:48:01 +01003743#if defined(MBEDTLS_SSL_PROTO_DTLS)
3744 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3745 {
3746 /* Buffer future message */
3747 ret = ssl_buffer_message( ssl );
3748 if( ret != 0 )
3749 return( ret );
3750
3751 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3752 }
3753#endif /* MBEDTLS_SSL_PROTO_DTLS */
3754
Hanno Becker90333da2017-10-10 11:27:13 +01003755 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3756 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003757
3758 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003759 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003760 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003761 return( ret );
3762 }
3763
Hanno Becker327c93b2018-08-15 13:56:18 +01003764 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003765 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003766 {
3767 mbedtls_ssl_update_handshake_status( ssl );
3768 }
Simon Butcher99000142016-10-13 17:21:01 +01003769 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003770 else
Simon Butcher99000142016-10-13 17:21:01 +01003771 {
Hanno Becker02f59072018-08-15 14:00:24 +01003772 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003773 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003774 }
3775
3776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3777
3778 return( 0 );
3779}
3780
Hanno Becker40f50842018-08-15 14:48:01 +01003781#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003782static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003783{
Hanno Becker40f50842018-08-15 14:48:01 +01003784 if( ssl->in_left > ssl->next_record_offset )
3785 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003786
Hanno Becker40f50842018-08-15 14:48:01 +01003787 return( 0 );
3788}
3789
3790static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3791{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003792 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003793 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003794 int ret = 0;
3795
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003796 if( hs == NULL )
3797 return( -1 );
3798
Hanno Beckere00ae372018-08-20 09:39:42 +01003799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3800
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003801 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3802 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3803 {
3804 /* Check if we have seen a ChangeCipherSpec before.
3805 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003806 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003807 {
3808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3809 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003810 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003811 }
3812
Hanno Becker39b8bc92018-08-28 17:17:13 +01003813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003814 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3815 ssl->in_msglen = 1;
3816 ssl->in_msg[0] = 1;
3817
3818 /* As long as they are equal, the exact value doesn't matter. */
3819 ssl->in_left = 0;
3820 ssl->next_record_offset = 0;
3821
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003822 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003823 goto exit;
3824 }
Hanno Becker37f95322018-08-16 13:55:32 +01003825
Hanno Beckerb8f50142018-08-28 10:01:34 +01003826#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003827 /* Debug only */
3828 {
3829 unsigned offset;
3830 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3831 {
3832 hs_buf = &hs->buffering.hs[offset];
3833 if( hs_buf->is_valid == 1 )
3834 {
3835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3836 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003837 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003838 }
3839 }
3840 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003841#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003842
3843 /* Check if we have buffered and/or fully reassembled the
3844 * next handshake message. */
3845 hs_buf = &hs->buffering.hs[0];
3846 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3847 {
3848 /* Synthesize a record containing the buffered HS message. */
3849 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3850 ( hs_buf->data[2] << 8 ) |
3851 hs_buf->data[3];
3852
3853 /* Double-check that we haven't accidentally buffered
3854 * a message that doesn't fit into the input buffer. */
3855 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3856 {
3857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3858 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3859 }
3860
3861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3862 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3863 hs_buf->data, msg_len + 12 );
3864
3865 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3866 ssl->in_hslen = msg_len + 12;
3867 ssl->in_msglen = msg_len + 12;
3868 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3869
3870 ret = 0;
3871 goto exit;
3872 }
3873 else
3874 {
3875 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3876 hs->in_msg_seq ) );
3877 }
3878
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003879 ret = -1;
3880
3881exit:
3882
3883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3884 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003885}
3886
Hanno Beckera02b0b42018-08-21 17:20:27 +01003887static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3888 size_t desired )
3889{
3890 int offset;
3891 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3893 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003894
Hanno Becker01315ea2018-08-21 17:22:17 +01003895 /* Get rid of future records epoch first, if such exist. */
3896 ssl_free_buffered_record( ssl );
3897
3898 /* Check if we have enough space available now. */
3899 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3900 hs->buffering.total_bytes_buffered ) )
3901 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003903 return( 0 );
3904 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003905
Hanno Becker4f432ad2018-08-28 10:02:32 +01003906 /* We don't have enough space to buffer the next expected handshake
3907 * message. Remove buffers used for future messages to gain space,
3908 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003909 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3910 offset >= 0; offset-- )
3911 {
3912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3913 offset ) );
3914
Hanno Beckerb309b922018-08-23 13:18:05 +01003915 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003916
3917 /* Check if we have enough space available now. */
3918 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3919 hs->buffering.total_bytes_buffered ) )
3920 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003922 return( 0 );
3923 }
3924 }
3925
3926 return( -1 );
3927}
3928
Hanno Becker40f50842018-08-15 14:48:01 +01003929static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3930{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003931 int ret = 0;
3932 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3933
3934 if( hs == NULL )
3935 return( 0 );
3936
3937 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3938
3939 switch( ssl->in_msgtype )
3940 {
3941 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003943
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003944 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003945 break;
3946
3947 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003948 {
3949 unsigned recv_msg_seq_offset;
3950 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3951 mbedtls_ssl_hs_buffer *hs_buf;
3952 size_t msg_len = ssl->in_hslen - 12;
3953
3954 /* We should never receive an old handshake
3955 * message - double-check nonetheless. */
3956 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3957 {
3958 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3959 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3960 }
3961
3962 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3963 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3964 {
3965 /* Silently ignore -- message too far in the future */
3966 MBEDTLS_SSL_DEBUG_MSG( 2,
3967 ( "Ignore future HS message with sequence number %u, "
3968 "buffering window %u - %u",
3969 recv_msg_seq, ssl->handshake->in_msg_seq,
3970 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3971
3972 goto exit;
3973 }
3974
3975 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3976 recv_msg_seq, recv_msg_seq_offset ) );
3977
3978 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3979
3980 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003981 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003982 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003983 size_t reassembly_buf_sz;
3984
Hanno Becker37f95322018-08-16 13:55:32 +01003985 hs_buf->is_fragmented =
3986 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3987
3988 /* We copy the message back into the input buffer
3989 * after reassembly, so check that it's not too large.
3990 * This is an implementation-specific limitation
3991 * and not one from the standard, hence it is not
3992 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003993 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003994 {
3995 /* Ignore message */
3996 goto exit;
3997 }
3998
Hanno Beckere0b150f2018-08-21 15:51:03 +01003999 /* Check if we have enough space to buffer the message. */
4000 if( hs->buffering.total_bytes_buffered >
4001 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4002 {
4003 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4004 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4005 }
4006
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004007 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4008 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004009
4010 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4011 hs->buffering.total_bytes_buffered ) )
4012 {
4013 if( recv_msg_seq_offset > 0 )
4014 {
4015 /* If we can't buffer a future message because
4016 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004017 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4018 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4019 " (already %" MBEDTLS_PRINTF_SIZET
4020 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004021 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004022 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004023 goto exit;
4024 }
Hanno Beckere1801392018-08-21 16:51:05 +01004025 else
4026 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004027 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4028 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4029 " (already %" MBEDTLS_PRINTF_SIZET
4030 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004031 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004032 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004033 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004034
Hanno Beckera02b0b42018-08-21 17:20:27 +01004035 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004036 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4038 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4039 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4040 " (already %" MBEDTLS_PRINTF_SIZET
4041 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004042 msg_len,
4043 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004044 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004045 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004046 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4047 goto exit;
4048 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004049 }
4050
Paul Elliottd48d5c62021-01-07 14:47:05 +00004051 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004052 msg_len ) );
4053
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004054 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4055 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004056 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004057 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004058 goto exit;
4059 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004060 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004061
4062 /* Prepare final header: copy msg_type, length and message_seq,
4063 * then add standardised fragment_offset and fragment_length */
4064 memcpy( hs_buf->data, ssl->in_msg, 6 );
4065 memset( hs_buf->data + 6, 0, 3 );
4066 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4067
4068 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004069
4070 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004071 }
4072 else
4073 {
4074 /* Make sure msg_type and length are consistent */
4075 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4076 {
4077 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4078 /* Ignore */
4079 goto exit;
4080 }
4081 }
4082
Hanno Becker4422bbb2018-08-20 09:40:19 +01004083 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004084 {
4085 size_t frag_len, frag_off;
4086 unsigned char * const msg = hs_buf->data + 12;
4087
4088 /*
4089 * Check and copy current fragment
4090 */
4091
4092 /* Validation of header fields already done in
4093 * mbedtls_ssl_prepare_handshake_record(). */
4094 frag_off = ssl_get_hs_frag_off( ssl );
4095 frag_len = ssl_get_hs_frag_len( ssl );
4096
Paul Elliottd48d5c62021-01-07 14:47:05 +00004097 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4098 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004099 frag_off, frag_len ) );
4100 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4101
4102 if( hs_buf->is_fragmented )
4103 {
4104 unsigned char * const bitmask = msg + msg_len;
4105 ssl_bitmask_set( bitmask, frag_off, frag_len );
4106 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4107 msg_len ) == 0 );
4108 }
4109 else
4110 {
4111 hs_buf->is_complete = 1;
4112 }
4113
4114 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4115 hs_buf->is_complete ? "" : "not yet " ) );
4116 }
4117
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004118 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004119 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004120
4121 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004122 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004123 break;
4124 }
4125
4126exit:
4127
4128 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4129 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004130}
4131#endif /* MBEDTLS_SSL_PROTO_DTLS */
4132
Hanno Becker1097b342018-08-15 14:09:41 +01004133static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004134{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004135 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004136 * Consume last content-layer message and potentially
4137 * update in_msglen which keeps track of the contents'
4138 * consumption state.
4139 *
4140 * (1) Handshake messages:
4141 * Remove last handshake message, move content
4142 * and adapt in_msglen.
4143 *
4144 * (2) Alert messages:
4145 * Consume whole record content, in_msglen = 0.
4146 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004147 * (3) Change cipher spec:
4148 * Consume whole record content, in_msglen = 0.
4149 *
4150 * (4) Application data:
4151 * Don't do anything - the record layer provides
4152 * the application data as a stream transport
4153 * and consumes through mbedtls_ssl_read only.
4154 *
4155 */
4156
4157 /* Case (1): Handshake messages */
4158 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004159 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004160 /* Hard assertion to be sure that no application data
4161 * is in flight, as corrupting ssl->in_msglen during
4162 * ssl->in_offt != NULL is fatal. */
4163 if( ssl->in_offt != NULL )
4164 {
4165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4166 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4167 }
4168
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004169 /*
4170 * Get next Handshake message in the current record
4171 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004172
Hanno Becker4a810fb2017-05-24 16:27:30 +01004173 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004174 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004175 * current handshake content: If DTLS handshake
4176 * fragmentation is used, that's the fragment
4177 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004178 * size here is faulty and should be changed at
4179 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004180 * (2) While it doesn't seem to cause problems, one
4181 * has to be very careful not to assume that in_hslen
4182 * is always <= in_msglen in a sensible communication.
4183 * Again, it's wrong for DTLS handshake fragmentation.
4184 * The following check is therefore mandatory, and
4185 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004186 * Additionally, ssl->in_hslen might be arbitrarily out of
4187 * bounds after handling a DTLS message with an unexpected
4188 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004189 */
4190 if( ssl->in_hslen < ssl->in_msglen )
4191 {
4192 ssl->in_msglen -= ssl->in_hslen;
4193 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4194 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004195
Hanno Becker4a810fb2017-05-24 16:27:30 +01004196 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4197 ssl->in_msg, ssl->in_msglen );
4198 }
4199 else
4200 {
4201 ssl->in_msglen = 0;
4202 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004203
Hanno Becker4a810fb2017-05-24 16:27:30 +01004204 ssl->in_hslen = 0;
4205 }
4206 /* Case (4): Application data */
4207 else if( ssl->in_offt != NULL )
4208 {
4209 return( 0 );
4210 }
4211 /* Everything else (CCS & Alerts) */
4212 else
4213 {
4214 ssl->in_msglen = 0;
4215 }
4216
Hanno Becker1097b342018-08-15 14:09:41 +01004217 return( 0 );
4218}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004219
Hanno Beckere74d5562018-08-15 14:26:08 +01004220static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4221{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004222 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004223 return( 1 );
4224
4225 return( 0 );
4226}
4227
Hanno Becker5f066e72018-08-16 14:56:31 +01004228#if defined(MBEDTLS_SSL_PROTO_DTLS)
4229
4230static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4231{
4232 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4233 if( hs == NULL )
4234 return;
4235
Hanno Becker01315ea2018-08-21 17:22:17 +01004236 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004237 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004238 hs->buffering.total_bytes_buffered -=
4239 hs->buffering.future_record.len;
4240
4241 mbedtls_free( hs->buffering.future_record.data );
4242 hs->buffering.future_record.data = NULL;
4243 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004244}
4245
4246static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4247{
4248 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4249 unsigned char * rec;
4250 size_t rec_len;
4251 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004252#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4253 size_t in_buf_len = ssl->in_buf_len;
4254#else
4255 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4256#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004257 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4258 return( 0 );
4259
4260 if( hs == NULL )
4261 return( 0 );
4262
Hanno Becker5f066e72018-08-16 14:56:31 +01004263 rec = hs->buffering.future_record.data;
4264 rec_len = hs->buffering.future_record.len;
4265 rec_epoch = hs->buffering.future_record.epoch;
4266
4267 if( rec == NULL )
4268 return( 0 );
4269
Hanno Becker4cb782d2018-08-20 11:19:05 +01004270 /* Only consider loading future records if the
4271 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004272 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004273 return( 0 );
4274
Hanno Becker5f066e72018-08-16 14:56:31 +01004275 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4276
4277 if( rec_epoch != ssl->in_epoch )
4278 {
4279 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4280 goto exit;
4281 }
4282
4283 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4284
4285 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004286 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004287 {
4288 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4289 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4290 }
4291
4292 memcpy( ssl->in_hdr, rec, rec_len );
4293 ssl->in_left = rec_len;
4294 ssl->next_record_offset = 0;
4295
4296 ssl_free_buffered_record( ssl );
4297
4298exit:
4299 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4300 return( 0 );
4301}
4302
Hanno Becker519f15d2019-07-11 12:43:20 +01004303static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4304 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004305{
4306 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004307
4308 /* Don't buffer future records outside handshakes. */
4309 if( hs == NULL )
4310 return( 0 );
4311
4312 /* Only buffer handshake records (we are only interested
4313 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004314 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004315 return( 0 );
4316
4317 /* Don't buffer more than one future epoch record. */
4318 if( hs->buffering.future_record.data != NULL )
4319 return( 0 );
4320
Hanno Becker01315ea2018-08-21 17:22:17 +01004321 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004322 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004323 hs->buffering.total_bytes_buffered ) )
4324 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004325 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4326 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4327 " (already %" MBEDTLS_PRINTF_SIZET
4328 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004329 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004330 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004331 return( 0 );
4332 }
4333
Hanno Becker5f066e72018-08-16 14:56:31 +01004334 /* Buffer record */
4335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004336 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004337 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004338
4339 /* ssl_parse_record_header() only considers records
4340 * of the next epoch as candidates for buffering. */
4341 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004342 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004343
4344 hs->buffering.future_record.data =
4345 mbedtls_calloc( 1, hs->buffering.future_record.len );
4346 if( hs->buffering.future_record.data == NULL )
4347 {
4348 /* If we run out of RAM trying to buffer a
4349 * record from the next epoch, just ignore. */
4350 return( 0 );
4351 }
4352
Hanno Becker519f15d2019-07-11 12:43:20 +01004353 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004354
Hanno Becker519f15d2019-07-11 12:43:20 +01004355 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004356 return( 0 );
4357}
4358
4359#endif /* MBEDTLS_SSL_PROTO_DTLS */
4360
Hanno Beckere74d5562018-08-15 14:26:08 +01004361static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004362{
Janos Follath865b3eb2019-12-16 11:46:15 +00004363 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004364 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004365
Hanno Becker5f066e72018-08-16 14:56:31 +01004366#if defined(MBEDTLS_SSL_PROTO_DTLS)
4367 /* We might have buffered a future record; if so,
4368 * and if the epoch matches now, load it.
4369 * On success, this call will set ssl->in_left to
4370 * the length of the buffered record, so that
4371 * the calls to ssl_fetch_input() below will
4372 * essentially be no-ops. */
4373 ret = ssl_load_buffered_record( ssl );
4374 if( ret != 0 )
4375 return( ret );
4376#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004377
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004378 /* Ensure that we have enough space available for the default form
4379 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4380 * with no space for CIDs counted in). */
4381 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4382 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004383 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004384 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004385 return( ret );
4386 }
4387
Hanno Beckere5e7e782019-07-11 12:29:35 +01004388 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4389 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004390 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004391#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004392 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004393 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004394 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4395 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004396 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004397 if( ret != 0 )
4398 return( ret );
4399
4400 /* Fall through to handling of unexpected records */
4401 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4402 }
4403
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004404 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4405 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004406#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004407 /* Reset in pointers to default state for TLS/DTLS records,
4408 * assuming no CID and no offset between record content and
4409 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004410 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004411
Hanno Becker7ae20e02019-07-12 08:33:49 +01004412 /* Setup internal message pointers from record structure. */
4413 ssl->in_msgtype = rec.type;
4414#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4415 ssl->in_len = ssl->in_cid + rec.cid_len;
4416#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4417 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4418 ssl->in_msglen = rec.data_len;
4419
Hanno Becker2fddd372019-07-10 14:37:41 +01004420 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004421 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004422 if( ret != 0 )
4423 return( ret );
4424#endif
4425
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004426 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004427 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004428
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004429 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4430 "(header)" ) );
4431 }
4432 else
4433 {
4434 /* Skip invalid record and the rest of the datagram */
4435 ssl->next_record_offset = 0;
4436 ssl->in_left = 0;
4437
4438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4439 "(header)" ) );
4440 }
4441
4442 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004443 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004444 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004445 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004446#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004447 {
4448 return( ret );
4449 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004450 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004452#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004453 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004454 {
Hanno Beckera8814792019-07-10 15:01:45 +01004455 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004456 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004457 if( ssl->next_record_offset < ssl->in_left )
4458 {
4459 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4460 }
4461 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004462 else
4463#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004464 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004465 /*
4466 * Fetch record contents from underlying transport.
4467 */
Hanno Beckera3175662019-07-11 12:50:29 +01004468 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004469 if( ret != 0 )
4470 {
4471 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4472 return( ret );
4473 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004474
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004475 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004476 }
4477
4478 /*
4479 * Decrypt record contents.
4480 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004481
Hanno Beckerfdf66042019-07-11 13:07:45 +01004482 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004483 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004484#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004485 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004486 {
4487 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004488 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004489 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004490 /* Except when waiting for Finished as a bad mac here
4491 * probably means something went wrong in the handshake
4492 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4493 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4494 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4495 {
4496#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4497 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4498 {
4499 mbedtls_ssl_send_alert_message( ssl,
4500 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4501 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4502 }
4503#endif
4504 return( ret );
4505 }
4506
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004507 if( ssl->conf->badmac_limit != 0 &&
4508 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4511 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004512 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004513
Hanno Becker4a810fb2017-05-24 16:27:30 +01004514 /* As above, invalid records cause
4515 * dismissal of the whole datagram. */
4516
4517 ssl->next_record_offset = 0;
4518 ssl->in_left = 0;
4519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004521 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004522 }
4523
4524 return( ret );
4525 }
4526 else
4527#endif
4528 {
4529 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4531 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004532 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533 mbedtls_ssl_send_alert_message( ssl,
4534 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4535 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004536 }
4537#endif
4538 return( ret );
4539 }
4540 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004541
Hanno Becker44d89b22019-07-12 09:40:44 +01004542
4543 /* Reset in pointers to default state for TLS/DTLS records,
4544 * assuming no CID and no offset between record content and
4545 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004546 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004547#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4548 ssl->in_len = ssl->in_cid + rec.cid_len;
4549#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004550 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004551
Hanno Becker8685c822019-07-12 09:37:30 +01004552 /* The record content type may change during decryption,
4553 * so re-read it. */
4554 ssl->in_msgtype = rec.type;
4555 /* Also update the input buffer, because unfortunately
4556 * the server-side ssl_parse_client_hello() reparses the
4557 * record header when receiving a ClientHello initiating
4558 * a renegotiation. */
4559 ssl->in_hdr[0] = rec.type;
4560 ssl->in_msg = rec.buf + rec.data_offset;
4561 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004562 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004563
Simon Butcher99000142016-10-13 17:21:01 +01004564 return( 0 );
4565}
4566
4567int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4568{
Janos Follath865b3eb2019-12-16 11:46:15 +00004569 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004570
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004571 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004572 * Handle particular types of records
4573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004575 {
Simon Butcher99000142016-10-13 17:21:01 +01004576 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4577 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004578 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004579 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004580 }
4581
Hanno Beckere678eaa2018-08-21 14:57:46 +01004582 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004583 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004584 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004585 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004587 ssl->in_msglen ) );
4588 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004589 }
4590
Hanno Beckere678eaa2018-08-21 14:57:46 +01004591 if( ssl->in_msg[0] != 1 )
4592 {
4593 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4594 ssl->in_msg[0] ) );
4595 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4596 }
4597
4598#if defined(MBEDTLS_SSL_PROTO_DTLS)
4599 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4600 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4601 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4602 {
4603 if( ssl->handshake == NULL )
4604 {
4605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4606 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4607 }
4608
4609 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4610 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4611 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004612#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004613 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004614
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004616 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004617 if( ssl->in_msglen != 2 )
4618 {
4619 /* Note: Standard allows for more than one 2 byte alert
4620 to be packed in a single message, but Mbed TLS doesn't
4621 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004622 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004623 ssl->in_msglen ) );
4624 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4625 }
4626
Paul Elliott9f352112020-12-09 14:55:45 +00004627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004628 ssl->in_msg[0], ssl->in_msg[1] ) );
4629
4630 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004631 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004634 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004636 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004638 }
4639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4641 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004642 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004643 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4644 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004645 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004646
4647#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4648 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4649 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4650 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004652 /* Will be handled when trying to parse ServerHello */
4653 return( 0 );
4654 }
4655#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004656 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004657 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004658 }
4659
Hanno Beckerc76c6192017-06-06 10:03:17 +01004660#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004661 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004662 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004663 /* Drop unexpected ApplicationData records,
4664 * except at the beginning of renegotiations */
4665 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4666 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4667#if defined(MBEDTLS_SSL_RENEGOTIATION)
4668 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4669 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004670#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004671 )
4672 {
4673 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4674 return( MBEDTLS_ERR_SSL_NON_FATAL );
4675 }
4676
4677 if( ssl->handshake != NULL &&
4678 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4679 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004680 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004681 }
4682 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004683#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004684
Paul Bakker5121ce52009-01-03 21:22:43 +00004685 return( 0 );
4686}
4687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004688int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004689{
irwir6c0da642019-09-26 21:07:41 +03004690 return( mbedtls_ssl_send_alert_message( ssl,
4691 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4692 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004693}
4694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004696 unsigned char level,
4697 unsigned char message )
4698{
Janos Follath865b3eb2019-12-16 11:46:15 +00004699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004700
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004701 if( ssl == NULL || ssl->conf == NULL )
4702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4703
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004705 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004707 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004708 ssl->out_msglen = 2;
4709 ssl->out_msg[0] = level;
4710 ssl->out_msg[1] = message;
4711
Hanno Becker67bc7c32018-08-06 11:33:50 +01004712 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004715 return( ret );
4716 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004718
4719 return( 0 );
4720}
4721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004722int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004723{
Janos Follath865b3eb2019-12-16 11:46:15 +00004724 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004726 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004729 ssl->out_msglen = 1;
4730 ssl->out_msg[0] = 1;
4731
Paul Bakker5121ce52009-01-03 21:22:43 +00004732 ssl->state++;
4733
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004734 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004735 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004736 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004737 return( ret );
4738 }
4739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004740 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004741
4742 return( 0 );
4743}
4744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004746{
Janos Follath865b3eb2019-12-16 11:46:15 +00004747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004749 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004750
Hanno Becker327c93b2018-08-15 13:56:18 +01004751 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004754 return( ret );
4755 }
4756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004757 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004758 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004760 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4761 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004762 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004763 }
4764
Hanno Beckere678eaa2018-08-21 14:57:46 +01004765 /* CCS records are only accepted if they have length 1 and content '1',
4766 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004767
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004768 /*
4769 * Switch to our negotiated transform and session parameters for inbound
4770 * data.
4771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004772 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004773 ssl->transform_in = ssl->transform_negotiate;
4774 ssl->session_in = ssl->session_negotiate;
4775
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004776#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004777 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004778 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004779#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004780 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004781#endif
4782
4783 /* Increment epoch */
4784 if( ++ssl->in_epoch == 0 )
4785 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004787 /* This is highly unlikely to happen for legitimate reasons, so
4788 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004790 }
4791 }
4792 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004793#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004794 memset( ssl->in_ctr, 0, 8 );
4795
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004796 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004797
Paul Bakker5121ce52009-01-03 21:22:43 +00004798 ssl->state++;
4799
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004801
4802 return( 0 );
4803}
4804
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004805/* Once ssl->out_hdr as the address of the beginning of the
4806 * next outgoing record is set, deduce the other pointers.
4807 *
4808 * Note: For TLS, we save the implicit record sequence number
4809 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4810 * and the caller has to make sure there's space for this.
4811 */
4812
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004813static size_t ssl_transform_get_explicit_iv_len(
4814 mbedtls_ssl_transform const *transform )
4815{
TRodziewiczef73f012021-05-13 14:53:36 +02004816 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004817 return( 0 );
4818
4819 return( transform->ivlen - transform->fixed_ivlen );
4820}
4821
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004822void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4823 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004824{
4825#if defined(MBEDTLS_SSL_PROTO_DTLS)
4826 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4827 {
4828 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004829#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004830 ssl->out_cid = ssl->out_ctr + 8;
4831 ssl->out_len = ssl->out_cid;
4832 if( transform != NULL )
4833 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004834#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004835 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004836#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004837 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004838 }
4839 else
4840#endif
4841 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004842 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004843#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004844 ssl->out_cid = ssl->out_len;
4845#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004846 ssl->out_iv = ssl->out_hdr + 5;
4847 }
4848
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004849 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004850 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004851 if( transform != NULL )
4852 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004853}
4854
4855/* Once ssl->in_hdr as the address of the beginning of the
4856 * next incoming record is set, deduce the other pointers.
4857 *
4858 * Note: For TLS, we save the implicit record sequence number
4859 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4860 * and the caller has to make sure there's space for this.
4861 */
4862
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004863void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004864{
Hanno Becker79594fd2019-05-08 09:38:41 +01004865 /* This function sets the pointers to match the case
4866 * of unprotected TLS/DTLS records, with both ssl->in_iv
4867 * and ssl->in_msg pointing to the beginning of the record
4868 * content.
4869 *
4870 * When decrypting a protected record, ssl->in_msg
4871 * will be shifted to point to the beginning of the
4872 * record plaintext.
4873 */
4874
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004875#if defined(MBEDTLS_SSL_PROTO_DTLS)
4876 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4877 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004878 /* This sets the header pointers to match records
4879 * without CID. When we receive a record containing
4880 * a CID, the fields are shifted accordingly in
4881 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004882 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004883#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004884 ssl->in_cid = ssl->in_ctr + 8;
4885 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004886#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004887 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004888#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004889 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004890 }
4891 else
4892#endif
4893 {
4894 ssl->in_ctr = ssl->in_hdr - 8;
4895 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004896#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004897 ssl->in_cid = ssl->in_len;
4898#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004899 ssl->in_iv = ssl->in_hdr + 5;
4900 }
4901
Hanno Becker79594fd2019-05-08 09:38:41 +01004902 /* This will be adjusted at record decryption time. */
4903 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004904}
4905
Paul Bakker5121ce52009-01-03 21:22:43 +00004906/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004907 * Setup an SSL context
4908 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004909
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004910void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004911{
4912 /* Set the incoming and outgoing record pointers. */
4913#if defined(MBEDTLS_SSL_PROTO_DTLS)
4914 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4915 {
4916 ssl->out_hdr = ssl->out_buf;
4917 ssl->in_hdr = ssl->in_buf;
4918 }
4919 else
4920#endif /* MBEDTLS_SSL_PROTO_DTLS */
4921 {
Hanno Becker12078f42021-03-02 15:28:41 +00004922 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004923 ssl->out_hdr = ssl->out_buf + 8;
4924 ssl->in_hdr = ssl->in_buf + 8;
4925 }
4926
4927 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004928 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4929 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004930}
4931
Paul Bakker5121ce52009-01-03 21:22:43 +00004932/*
4933 * SSL get accessors
4934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004936{
4937 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4938}
4939
Hanno Becker8b170a02017-10-10 11:51:19 +01004940int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4941{
4942 /*
4943 * Case A: We're currently holding back
4944 * a message for further processing.
4945 */
4946
4947 if( ssl->keep_current_message == 1 )
4948 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004949 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004950 return( 1 );
4951 }
4952
4953 /*
4954 * Case B: Further records are pending in the current datagram.
4955 */
4956
4957#if defined(MBEDTLS_SSL_PROTO_DTLS)
4958 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4959 ssl->in_left > ssl->next_record_offset )
4960 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004961 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004962 return( 1 );
4963 }
4964#endif /* MBEDTLS_SSL_PROTO_DTLS */
4965
4966 /*
4967 * Case C: A handshake message is being processed.
4968 */
4969
Hanno Becker8b170a02017-10-10 11:51:19 +01004970 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4971 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004972 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004973 return( 1 );
4974 }
4975
4976 /*
4977 * Case D: An application data message is being processed
4978 */
4979 if( ssl->in_offt != NULL )
4980 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004981 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004982 return( 1 );
4983 }
4984
4985 /*
4986 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004987 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004988 * we implement support for multiple alerts in single records.
4989 */
4990
4991 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4992 return( 0 );
4993}
4994
Paul Bakker43ca69c2011-01-15 17:35:19 +00004995
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004996int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004997{
Hanno Becker3136ede2018-08-17 15:28:19 +01004998 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004999 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005000 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005001
Hanno Becker5903de42019-05-03 14:46:38 +01005002 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5003
Hanno Becker78640902018-08-13 16:35:15 +01005004 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005005 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005008 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005009 case MBEDTLS_MODE_GCM:
5010 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005011 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005012 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005013 transform_expansion = transform->minlen;
5014 break;
5015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005016 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005017
5018 block_size = mbedtls_cipher_get_block_size(
5019 &transform->cipher_ctx_enc );
5020
Hanno Becker3136ede2018-08-17 15:28:19 +01005021 /* Expansion due to the addition of the MAC. */
5022 transform_expansion += transform->maclen;
5023
5024 /* Expansion due to the addition of CBC padding;
5025 * Theoretically up to 256 bytes, but we never use
5026 * more than the block size of the underlying cipher. */
5027 transform_expansion += block_size;
5028
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005029 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005030 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005031#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005032 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005033#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005034
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005035 break;
5036
5037 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005039 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005040 }
5041
Hanno Beckera0e20d02019-05-15 14:03:01 +01005042#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005043 if( transform->out_cid_len != 0 )
5044 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005045#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005046
Hanno Becker5903de42019-05-03 14:46:38 +01005047 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005048}
5049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005050#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005051/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005052 * Check record counters and renegotiate if they're above the limit.
5053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005054static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005055{
Hanno Beckerdd772292020-02-05 10:38:31 +00005056 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005057 int in_ctr_cmp;
5058 int out_ctr_cmp;
5059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5061 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005062 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005063 {
5064 return( 0 );
5065 }
5066
Andres AG2196c7f2016-12-15 17:01:16 +00005067 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5068 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005069 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005070 ssl->conf->renego_period + ep_len, 8 - ep_len );
5071
5072 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005073 {
5074 return( 0 );
5075 }
5076
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005077 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005078 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005079}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005080#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005081
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005082/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005083 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005084 * may only be sent for the purpose of initiating renegotiations.
5085 *
5086 * This function is introduced as a separate helper since the handling
5087 * of post-handshake handshake messages changes significantly in TLS 1.3,
5088 * and having a helper function allows to distinguish between TLS <= 1.2 and
5089 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5090 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005091static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005092{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005093 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005094
5095 /*
5096 * - For client-side, expect SERVER_HELLO_REQUEST.
5097 * - For server-side, expect CLIENT_HELLO.
5098 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5099 */
5100
5101#if defined(MBEDTLS_SSL_CLI_C)
5102 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5103 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5104 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5105 {
5106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5107
5108 /* With DTLS, drop the packet (probably from last handshake) */
5109#if defined(MBEDTLS_SSL_PROTO_DTLS)
5110 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5111 {
5112 return( 0 );
5113 }
5114#endif
5115 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5116 }
5117#endif /* MBEDTLS_SSL_CLI_C */
5118
5119#if defined(MBEDTLS_SSL_SRV_C)
5120 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5121 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5122 {
5123 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5124
5125 /* With DTLS, drop the packet (probably from last handshake) */
5126#if defined(MBEDTLS_SSL_PROTO_DTLS)
5127 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5128 {
5129 return( 0 );
5130 }
5131#endif
5132 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5133 }
5134#endif /* MBEDTLS_SSL_SRV_C */
5135
5136#if defined(MBEDTLS_SSL_RENEGOTIATION)
5137 /* Determine whether renegotiation attempt should be accepted */
5138 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5139 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5140 ssl->conf->allow_legacy_renegotiation ==
5141 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5142 {
5143 /*
5144 * Accept renegotiation request
5145 */
5146
5147 /* DTLS clients need to know renego is server-initiated */
5148#if defined(MBEDTLS_SSL_PROTO_DTLS)
5149 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5150 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5151 {
5152 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5153 }
5154#endif
5155 ret = mbedtls_ssl_start_renegotiation( ssl );
5156 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5157 ret != 0 )
5158 {
5159 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5160 ret );
5161 return( ret );
5162 }
5163 }
5164 else
5165#endif /* MBEDTLS_SSL_RENEGOTIATION */
5166 {
5167 /*
5168 * Refuse renegotiation
5169 */
5170
5171 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5172
TRodziewicz0f82ec62021-05-12 17:49:18 +02005173#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005174 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5175 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5176 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005177 {
TRodziewicz345165c2021-07-06 13:42:11 +02005178 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005179 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005180#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005181 }
5182
5183 return( 0 );
5184}
5185
Paul Bakker48916f92012-09-16 19:57:18 +00005186/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005187 * Receive application data decrypted from the SSL layer
5188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005189int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005190{
Janos Follath865b3eb2019-12-16 11:46:15 +00005191 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005192 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005193
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005194 if( ssl == NULL || ssl->conf == NULL )
5195 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005197 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005200 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005201 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005202 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005203 return( ret );
5204
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005205 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005206 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005207 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005208 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005209 return( ret );
5210 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005211 }
5212#endif
5213
Hanno Becker4a810fb2017-05-24 16:27:30 +01005214 /*
5215 * Check if renegotiation is necessary and/or handshake is
5216 * in process. If yes, perform/continue, and fall through
5217 * if an unexpected packet is received while the client
5218 * is waiting for the ServerHello.
5219 *
5220 * (There is no equivalent to the last condition on
5221 * the server-side as it is not treated as within
5222 * a handshake while waiting for the ClientHello
5223 * after a renegotiation request.)
5224 */
5225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005226#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005227 ret = ssl_check_ctr_renegotiate( ssl );
5228 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5229 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005230 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005231 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005232 return( ret );
5233 }
5234#endif
5235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005236 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005237 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005238 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005239 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5240 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005241 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005242 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005243 return( ret );
5244 }
5245 }
5246
Hanno Beckere41158b2017-10-23 13:30:32 +01005247 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005248 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005249 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005250 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005251 if( ssl->f_get_timer != NULL &&
5252 ssl->f_get_timer( ssl->p_timer ) == -1 )
5253 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005254 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005255 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005256
Hanno Becker327c93b2018-08-15 13:56:18 +01005257 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005258 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005259 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5260 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005261
Hanno Becker4a810fb2017-05-24 16:27:30 +01005262 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5263 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005264 }
5265
5266 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005268 {
5269 /*
5270 * OpenSSL sends empty messages to randomize the IV
5271 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005272 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005273 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005274 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005275 return( 0 );
5276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005277 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005278 return( ret );
5279 }
5280 }
5281
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005282 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005283 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005284 ret = ssl_handle_hs_message_post_handshake( ssl );
5285 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005286 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005287 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5288 ret );
5289 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005290 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005291
Hanno Beckerf26cc722021-04-21 07:30:13 +01005292 /* At this point, we don't know whether the renegotiation triggered
5293 * by the post-handshake message has been completed or not. The cases
5294 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005295 * 1) The renegotiation is complete. In this case, no new record
5296 * has been read yet.
5297 * 2) The renegotiation is incomplete because the client received
5298 * an application data record while awaiting the ServerHello.
5299 * 3) The renegotiation is incomplete because the client received
5300 * a non-handshake, non-application data message while awaiting
5301 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005302 *
5303 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005304 * - For 1), the next iteration will read a new record and check
5305 * if it's application data.
5306 * - For 2), the loop condition isn't satisfied as application data
5307 * is present, hence continue is the same as break
5308 * - For 3), the loop condition is satisfied and read_record
5309 * will re-deliver the message that was held back by the client
5310 * when expecting the ServerHello.
5311 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005312
Hanno Becker90333da2017-10-10 11:27:13 +01005313 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005314 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005315#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005316 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005317 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005318 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005319 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005320 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005321 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005322 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005323 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005324 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005325 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005326 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005327 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005328#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005330 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5331 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005332 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005333 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005334 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005335 }
5336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5340 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005341 }
5342
5343 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005344
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005345 /* We're going to return something now, cancel timer,
5346 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005347 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005348 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005349
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005350#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005351 /* If we requested renego but received AppData, resend HelloRequest.
5352 * Do it now, after setting in_offt, to avoid taking this branch
5353 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005355 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005356 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005357 {
Hanno Becker786300f2020-02-05 10:46:40 +00005358 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005359 {
Hanno Becker786300f2020-02-05 10:46:40 +00005360 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5361 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005362 return( ret );
5363 }
5364 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005365#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005366#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005367 }
5368
5369 n = ( len < ssl->in_msglen )
5370 ? len : ssl->in_msglen;
5371
5372 memcpy( buf, ssl->in_offt, n );
5373 ssl->in_msglen -= n;
5374
gabor-mezei-arma3214132020-07-15 10:55:00 +02005375 /* Zeroising the plaintext buffer to erase unused application data
5376 from the memory. */
5377 mbedtls_platform_zeroize( ssl->in_offt, n );
5378
Paul Bakker5121ce52009-01-03 21:22:43 +00005379 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005380 {
5381 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005382 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005383 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005384 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005385 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005386 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005387 /* more data available */
5388 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005389 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005392
Paul Bakker23986e52011-04-24 08:57:21 +00005393 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005394}
5395
5396/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005397 * Send application data to be encrypted by the SSL layer, taking care of max
5398 * fragment length and buffer size.
5399 *
5400 * According to RFC 5246 Section 6.2.1:
5401 *
5402 * Zero-length fragments of Application data MAY be sent as they are
5403 * potentially useful as a traffic analysis countermeasure.
5404 *
5405 * Therefore, it is possible that the input message length is 0 and the
5406 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005407 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005408static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005409 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005410{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005411 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5412 const size_t max_len = (size_t) ret;
5413
5414 if( ret < 0 )
5415 {
5416 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5417 return( ret );
5418 }
5419
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005420 if( len > max_len )
5421 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005423 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005424 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005426 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5427 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005428 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005429 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005430 }
5431 else
5432#endif
5433 len = max_len;
5434 }
Paul Bakker887bd502011-06-08 13:10:54 +00005435
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 if( ssl->out_left != 0 )
5437 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005438 /*
5439 * The user has previously tried to send the data and
5440 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5441 * written. In this case, we expect the high-level write function
5442 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005444 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005445 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005447 return( ret );
5448 }
5449 }
Paul Bakker887bd502011-06-08 13:10:54 +00005450 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005451 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005452 /*
5453 * The user is trying to send a message the first time, so we need to
5454 * copy the data into the internal buffers and setup the data structure
5455 * to keep track of partial writes
5456 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005457 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005458 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005459 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005460
Hanno Becker67bc7c32018-08-06 11:33:50 +01005461 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005462 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005464 return( ret );
5465 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005466 }
5467
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005468 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005469}
5470
5471/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005472 * Write application data (public-facing wrapper)
5473 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005474int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005475{
Janos Follath865b3eb2019-12-16 11:46:15 +00005476 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005477
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005479
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005480 if( ssl == NULL || ssl->conf == NULL )
5481 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5482
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005483#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005484 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5485 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005486 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005487 return( ret );
5488 }
5489#endif
5490
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005491 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005492 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005493 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005494 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005495 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005496 return( ret );
5497 }
5498 }
5499
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005500 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005501
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005502 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005503
5504 return( ret );
5505}
5506
5507/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005508 * Notify the peer that the connection is being closed
5509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005510int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005511{
Janos Follath865b3eb2019-12-16 11:46:15 +00005512 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005513
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005514 if( ssl == NULL || ssl->conf == NULL )
5515 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005518
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005519 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005520 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005522 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005523 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005524 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5525 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5526 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005527 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005529 return( ret );
5530 }
5531 }
5532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005533 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005534
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005535 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005536}
5537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005538void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005539{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005540 if( transform == NULL )
5541 return;
5542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005543 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5544 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005545
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005546#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547 mbedtls_md_free( &transform->md_ctx_enc );
5548 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005549#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005550
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005551 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005552}
5553
Jerry Yuc7875b52021-09-05 21:05:50 +08005554void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5555 mbedtls_ssl_transform *transform )
5556{
5557 if( ssl->transform_in == transform )
5558 return;
5559
5560 ssl->transform_in = transform;
5561 mbedtls_platform_zeroize( ssl->in_ctr, 8 );
5562}
5563
5564void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5565 mbedtls_ssl_transform *transform )
5566{
5567 ssl->transform_out = transform;
5568 mbedtls_platform_zeroize( ssl->cur_out_ctr, 8 );
5569}
5570
Hanno Becker0271f962018-08-16 13:23:47 +01005571#if defined(MBEDTLS_SSL_PROTO_DTLS)
5572
Hanno Becker533ab5f2020-02-05 10:49:13 +00005573void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005574{
5575 unsigned offset;
5576 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5577
5578 if( hs == NULL )
5579 return;
5580
Hanno Becker283f5ef2018-08-24 09:34:47 +01005581 ssl_free_buffered_record( ssl );
5582
Hanno Becker0271f962018-08-16 13:23:47 +01005583 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005584 ssl_buffering_free_slot( ssl, offset );
5585}
5586
5587static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5588 uint8_t slot )
5589{
5590 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5591 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005592
5593 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5594 return;
5595
Hanno Beckere605b192018-08-21 15:59:07 +01005596 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005597 {
Hanno Beckere605b192018-08-21 15:59:07 +01005598 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005599 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005600 mbedtls_free( hs_buf->data );
5601 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005602 }
5603}
5604
5605#endif /* MBEDTLS_SSL_PROTO_DTLS */
5606
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005607/*
5608 * Convert version numbers to/from wire format
5609 * and, for DTLS, to/from TLS equivalent.
5610 *
5611 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005612 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005613 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005615void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005616 unsigned char ver[2] )
5617{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005618#if defined(MBEDTLS_SSL_PROTO_DTLS)
5619 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005620 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005621 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005622 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5623
5624 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5625 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5626 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005627 else
5628#else
5629 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005630#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005631 {
5632 ver[0] = (unsigned char) major;
5633 ver[1] = (unsigned char) minor;
5634 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005635}
5636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005637void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005638 const unsigned char ver[2] )
5639{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640#if defined(MBEDTLS_SSL_PROTO_DTLS)
5641 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005642 {
5643 *major = 255 - ver[0] + 2;
5644 *minor = 255 - ver[1] + 1;
5645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005646 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005647 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5648 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005649 else
5650#else
5651 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005652#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005653 {
5654 *major = ver[0];
5655 *minor = ver[1];
5656 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005657}
5658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005659#endif /* MBEDTLS_SSL_TLS_C */