blob: 7c523ee4ac9b053589220d1d9812f71b57e032a9 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
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
Ronald Cron6f135e12021-12-08 16:57:54 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100297
298static size_t ssl_compute_padding_length( size_t len,
299 size_t granularity )
300{
301 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
302}
303
Hanno Becker581bc1b2020-05-04 12:20:03 +0100304/* This functions transforms a (D)TLS plaintext fragment and a record content
305 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
306 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
307 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100308 *
309 * struct {
310 * opaque content[DTLSPlaintext.length];
311 * ContentType real_type;
312 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100313 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100314 *
315 * Input:
316 * - `content`: The beginning of the buffer holding the
317 * plaintext to be wrapped.
318 * - `*content_size`: The length of the plaintext in Bytes.
319 * - `max_len`: The number of Bytes available starting from
320 * `content`. This must be `>= *content_size`.
321 * - `rec_type`: The desired record content type.
322 *
323 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100324 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
325 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100326 *
327 * Returns:
328 * - `0` on success.
329 * - A negative error code if `max_len` didn't offer enough space
330 * for the expansion.
331 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100332static int ssl_build_inner_plaintext( unsigned char *content,
333 size_t *content_size,
334 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100335 uint8_t rec_type,
336 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100337{
338 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339
340 /* Write real content type */
341 if( remaining == 0 )
342 return( -1 );
343 content[ len ] = rec_type;
344 len++;
345 remaining--;
346
347 if( remaining < pad )
348 return( -1 );
349 memset( content + len, 0, pad );
350 len += pad;
351 remaining -= pad;
352
353 *content_size = len;
354 return( 0 );
355}
356
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357/* This function parses a (D)TLSInnerPlaintext structure.
358 * See ssl_build_inner_plaintext() for details. */
359static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100360 size_t *content_size,
361 uint8_t *rec_type )
362{
363 size_t remaining = *content_size;
364
365 /* Determine length of padding by skipping zeroes from the back. */
366 do
367 {
368 if( remaining == 0 )
369 return( -1 );
370 remaining--;
371 } while( content[ remaining ] == 0 );
372
373 *content_size = remaining;
374 *rec_type = content[ remaining ];
375
376 return( 0 );
377}
Ronald Cron6f135e12021-12-08 16:57:54 +0100378#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100379
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100380/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100381 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000382static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100383 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100384 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000385 unsigned minor_ver,
386 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000387{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100388 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100389 *
390 * additional_data = seq_num + TLSCompressed.type +
391 * TLSCompressed.version + TLSCompressed.length;
392 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100393 * For the CID extension, this is extended as follows
394 * (quoting draft-ietf-tls-dtls-connection-id-05,
395 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100396 *
397 * additional_data = seq_num + DTLSPlaintext.type +
398 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100399 * cid +
400 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100401 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100402 *
403 * For TLS 1.3, the record sequence number is dropped from the AAD
404 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000405 * Moreover, the additional data involves the length of the TLS
406 * ciphertext, not the TLS plaintext as in earlier versions.
407 * Quoting RFC 8446 (TLS 1.3):
408 *
409 * additional_data = TLSCiphertext.opaque_type ||
410 * TLSCiphertext.legacy_record_version ||
411 * TLSCiphertext.length
412 *
413 * We pass the tag length to this function in order to compute the
414 * ciphertext length from the inner plaintext length rec->data_len via
415 *
416 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
417 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100418 */
419
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100420 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000421 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422
Ronald Cron6f135e12021-12-08 16:57:54 +0100423#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000424 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
425 {
426 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
427 * which differs from the length of the TLSInnerPlaintext
428 * by the length of the authentication tag. */
429 ad_len_field += taglen;
430 }
431 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100432#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100433 {
434 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000435 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100436 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
437 cur += sizeof( rec->ctr );
438 }
439
440 *cur = rec->type;
441 cur++;
442
443 memcpy( cur, rec->ver, sizeof( rec->ver ) );
444 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100445
Hanno Beckera0e20d02019-05-15 14:03:01 +0100446#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100447 if( rec->cid_len != 0 )
448 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100449 memcpy( cur, rec->cid, rec->cid_len );
450 cur += rec->cid_len;
451
452 *cur = rec->cid_len;
453 cur++;
454
Joe Subbiani6dd73642021-07-19 11:56:54 +0100455 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100456 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100457 }
458 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100461 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100462 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464
465 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000466}
467
Hanno Becker67a37db2020-05-28 16:27:07 +0100468#if defined(MBEDTLS_GCM_C) || \
469 defined(MBEDTLS_CCM_C) || \
470 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100471static int ssl_transform_aead_dynamic_iv_is_explicit(
472 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100473{
Hanno Becker17263802020-05-28 07:05:48 +0100474 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475}
476
Hanno Becker17263802020-05-28 07:05:48 +0100477/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
478 *
479 * Concretely, this occurs in two variants:
480 *
481 * a) Fixed and dynamic IV lengths add up to total IV length, giving
482 * IV = fixed_iv || dynamic_iv
483 *
Hanno Becker15952812020-06-04 13:31:46 +0100484 * This variant is used in TLS 1.2 when used with GCM or CCM.
485 *
Hanno Becker17263802020-05-28 07:05:48 +0100486 * b) Fixed IV lengths matches total IV length, giving
487 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100488 *
489 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
490 *
491 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100492 *
493 * This function has the precondition that
494 *
495 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
496 *
497 * which has to be ensured by the caller. If this precondition
498 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100499 */
500static void ssl_build_record_nonce( unsigned char *dst_iv,
501 size_t dst_iv_len,
502 unsigned char const *fixed_iv,
503 size_t fixed_iv_len,
504 unsigned char const *dynamic_iv,
505 size_t dynamic_iv_len )
506{
507 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100508
509 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100510 memset( dst_iv, 0, dst_iv_len );
511 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100512
Hanno Becker17263802020-05-28 07:05:48 +0100513 dst_iv += dst_iv_len - dynamic_iv_len;
514 for( i = 0; i < dynamic_iv_len; i++ )
515 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100516}
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518
Hanno Beckera18d1322018-01-03 14:27:32 +0000519int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
520 mbedtls_ssl_transform *transform,
521 mbedtls_record *rec,
522 int (*f_rng)(void *, unsigned char *, size_t),
523 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000524{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100526 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000527 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100528 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100529 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000530 size_t post_avail;
531
532 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000533#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200534 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000535 ((void) ssl);
536#endif
537
538 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200539 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200540#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000542 ((void) f_rng);
543 ((void) p_rng);
544#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000548 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100549 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
552 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100553 if( rec == NULL
554 || rec->buf == NULL
555 || rec->buf_len < rec->data_offset
556 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100557#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100558 || rec->cid_len != 0
559#endif
560 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000561 {
562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100564 }
565
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000566 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100567 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200568 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000569 data, rec->data_len );
570
571 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
572
573 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
574 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
576 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000577 rec->data_len,
578 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000579 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
580 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100581
Hanno Becker92313402020-05-20 13:58:58 +0100582 /* The following two code paths implement the (D)TLSInnerPlaintext
583 * structure present in TLS 1.3 and DTLS 1.2 + CID.
584 *
585 * See ssl_build_inner_plaintext() for more information.
586 *
587 * Note that this changes `rec->data_len`, and hence
588 * `post_avail` needs to be recalculated afterwards.
589 *
590 * Note also that the two code paths cannot occur simultaneously
591 * since they apply to different versions of the protocol. There
592 * is hence no risk of double-addition of the inner plaintext.
593 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100594#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +0100595 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
596 {
Hanno Becker13996922020-05-28 16:15:19 +0100597 size_t padding =
598 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200599 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100600 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100601 &rec->data_len,
602 post_avail,
603 rec->type,
604 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100605 {
606 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
607 }
608
609 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
610 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100611#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100612
Hanno Beckera0e20d02019-05-15 14:03:01 +0100613#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100614 /*
615 * Add CID information
616 */
617 rec->cid_len = transform->out_cid_len;
618 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
619 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100620
621 if( rec->cid_len != 0 )
622 {
Hanno Becker13996922020-05-28 16:15:19 +0100623 size_t padding =
624 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200625 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100626 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100627 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100628 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100629 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100630 * Note that this changes `rec->data_len`, and hence
631 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100632 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100633 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100634 &rec->data_len,
635 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100636 rec->type,
637 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100638 {
639 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
640 }
641
642 rec->type = MBEDTLS_SSL_MSG_CID;
643 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100644#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100645
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100646 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
647
Paul Bakker5121ce52009-01-03 21:22:43 +0000648 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100649 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000650 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000651#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 if( mode == MBEDTLS_MODE_STREAM ||
653 ( mode == MBEDTLS_MODE_CBC
654#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000655 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100656#endif
657 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000658 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000659 if( post_avail < transform->maclen )
660 {
661 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
662 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
663 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200664#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200665 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000666
TRodziewicz345165c2021-07-06 13:42:11 +0200667 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000668 transform->minor_ver,
669 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000670
TRodziewicz345165c2021-07-06 13:42:11 +0200671 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
672 add_data_len );
673 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
674 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
675 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000676
TRodziewicz345165c2021-07-06 13:42:11 +0200677 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200678#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200679
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000680 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
681 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200682
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000683 rec->data_len += transform->maclen;
684 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100685 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200686 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000687#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000688
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200689 /*
690 * Encrypt
691 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000692#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000694 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000696 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000697 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 "including %d bytes of padding",
699 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000700
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000701 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
702 transform->iv_enc, transform->ivlen,
703 data, rec->data_len,
704 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200705 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200707 return( ret );
708 }
709
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000710 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200711 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
713 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200714 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000715 }
Paul Bakker68884e32013-01-07 18:20:04 +0100716 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000717#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000718
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200719#if defined(MBEDTLS_GCM_C) || \
720 defined(MBEDTLS_CCM_C) || \
721 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200723 mode == MBEDTLS_MODE_CCM ||
724 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000725 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200727 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100728 unsigned char *dynamic_iv;
729 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100730 int dynamic_iv_is_explicit =
731 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000732
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100733 /* Check that there's space for the authentication tag. */
734 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000735 {
736 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
737 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
738 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000739
Paul Bakker68884e32013-01-07 18:20:04 +0100740 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100741 * Build nonce for AEAD encryption.
742 *
743 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
744 * part of the IV is prepended to the ciphertext and
745 * can be chosen freely - in particular, it need not
746 * agree with the record sequence number.
747 * However, since ChaChaPoly as well as all AEAD modes
748 * in TLS 1.3 use the record sequence number as the
749 * dynamic part of the nonce, we uniformly use the
750 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100751 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100752 dynamic_iv = rec->ctr;
753 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200754
Hanno Becker17263802020-05-28 07:05:48 +0100755 ssl_build_record_nonce( iv, sizeof( iv ),
756 transform->iv_enc,
757 transform->fixed_ivlen,
758 dynamic_iv,
759 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100760
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100761 /*
762 * Build additional data for AEAD encryption.
763 * This depends on the TLS version.
764 */
765 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000766 transform->minor_ver,
767 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100768
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200769 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100770 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200771 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100772 dynamic_iv,
773 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000774 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100775 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000776 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200777 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000778 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000779
Paul Bakker68884e32013-01-07 18:20:04 +0100780 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200781 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200782 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000783
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100784 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000785 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100786 add_data, add_data_len,
787 data, rec->data_len, /* src */
788 data, rec->buf_len - (data - rec->buf), /* dst */
789 &rec->data_len,
790 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200791 {
TRodziewicz18efb732021-04-29 23:12:19 +0200792 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200793 return( ret );
794 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000795 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100796 data + rec->data_len - transform->taglen,
797 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100798 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000799 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100800
801 /*
802 * Prefix record content with dynamic IV in case it is explicit.
803 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100804 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100805 {
806 if( rec->data_offset < dynamic_iv_len )
807 {
808 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
809 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
810 }
811
812 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
813 rec->data_offset -= dynamic_iv_len;
814 rec->data_len += dynamic_iv_len;
815 }
816
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100817 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000818 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000819 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100820#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200821#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200822 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000823 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000824 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000825 size_t padlen, i;
826 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000827
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828 /* Currently we're always using minimal padding
829 * (up to 255 bytes would be allowed). */
830 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
831 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000832 padlen = 0;
833
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000834 /* Check there's enough space in the buffer for the padding. */
835 if( post_avail < padlen + 1 )
836 {
837 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
838 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
839 }
840
Paul Bakker5121ce52009-01-03 21:22:43 +0000841 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000842 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000843
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 rec->data_len += padlen + 1;
845 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000846
TRodziewicz0f82ec62021-05-12 17:49:18 +0200847#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000848 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200849 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000850 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000851 */
TRodziewicz345165c2021-07-06 13:42:11 +0200852 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000853 {
TRodziewicz345165c2021-07-06 13:42:11 +0200854 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
855 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000856 }
TRodziewicz345165c2021-07-06 13:42:11 +0200857
858 if( rec->data_offset < transform->ivlen )
859 {
860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
861 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
862 }
863
864 /*
865 * Generate IV
866 */
867 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
868 if( ret != 0 )
869 return( ret );
870
871 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200872#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000873
Paul Elliottd48d5c62021-01-07 14:47:05 +0000874 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
875 "including %" MBEDTLS_PRINTF_SIZET
876 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000877 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200878 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000879
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000880 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
881 transform->iv_enc,
882 transform->ivlen,
883 data, rec->data_len,
884 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200885 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200887 return( ret );
888 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200889
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000890 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200891 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
893 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200894 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200895
TRodziewicz0f82ec62021-05-12 17:49:18 +0200896 data -= transform->ivlen;
897 rec->data_offset -= transform->ivlen;
898 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100899
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100901 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100902 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000903 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
904
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100905 /*
906 * MAC(MAC_write_key, seq_num +
907 * TLSCipherText.type +
908 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100909 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200910 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100911 * ENC(content + padding + padding_length));
912 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000913
914 if( post_avail < transform->maclen)
915 {
916 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
917 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
918 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100919
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100920 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000921 rec, transform->minor_ver,
922 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000925 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100926 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100927
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000928 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100929 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000930 mbedtls_md_hmac_update( &transform->md_ctx_enc,
931 data, rec->data_len );
932 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
933 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100934
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000935 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100936
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 rec->data_len += transform->maclen;
938 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100939 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100940 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000942 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200943 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200944#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200945 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
947 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200948 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000949
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100950 /* Make extra sure authentication was performed, exactly once */
951 if( auth_done != 1 )
952 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
954 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100955 }
956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000958
959 return( 0 );
960}
961
Hanno Becker605949f2019-07-12 08:23:59 +0100962int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +0000963 mbedtls_ssl_transform *transform,
964 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +0000965{
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000966 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000968 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000969#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +0100970 size_t padlen = 0, correct = 1;
971#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000972 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100973 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100974 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000975
Hanno Beckera18d1322018-01-03 14:27:32 +0000976#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200977 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000978 ((void) ssl);
979#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000982 if( rec == NULL ||
983 rec->buf == NULL ||
984 rec->buf_len < rec->data_offset ||
985 rec->buf_len - rec->data_offset < rec->data_len )
986 {
987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100989 }
990
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000991 data = rec->buf + rec->data_offset;
992 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +0000993
Hanno Beckera0e20d02019-05-15 14:03:01 +0100994#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100995 /*
996 * Match record's CID with incoming CID.
997 */
Hanno Becker938489a2019-05-08 13:02:22 +0100998 if( rec->cid_len != transform->in_cid_len ||
999 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1000 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001001 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001002 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001003#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001004
Hanno Beckerd086bf02021-03-22 13:01:27 +00001005#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001007 {
1008 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001009 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1010 transform->iv_dec,
1011 transform->ivlen,
1012 data, rec->data_len,
1013 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001016 return( ret );
1017 }
1018
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001019 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001020 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1022 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001023 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001024 }
Paul Bakker68884e32013-01-07 18:20:04 +01001025 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001026#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001027#if defined(MBEDTLS_GCM_C) || \
1028 defined(MBEDTLS_CCM_C) || \
1029 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001031 mode == MBEDTLS_MODE_CCM ||
1032 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001033 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001034 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001035 unsigned char *dynamic_iv;
1036 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001037
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001038 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001039 * Extract dynamic part of nonce for AEAD decryption.
1040 *
1041 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1042 * part of the IV is prepended to the ciphertext and
1043 * can be chosen freely - in particular, it need not
1044 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001045 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001046 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001047 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001048 {
1049 if( rec->data_len < dynamic_iv_len )
1050 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001051 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1052 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001053 rec->data_len,
1054 dynamic_iv_len ) );
1055 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1056 }
1057 dynamic_iv = data;
1058
1059 data += dynamic_iv_len;
1060 rec->data_offset += dynamic_iv_len;
1061 rec->data_len -= dynamic_iv_len;
1062 }
Hanno Becker17263802020-05-28 07:05:48 +01001063 else
1064 {
1065 dynamic_iv = rec->ctr;
1066 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001067
1068 /* Check that there's space for the authentication tag. */
1069 if( rec->data_len < transform->taglen )
1070 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001071 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1072 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001073 rec->data_len,
1074 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001076 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001077 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001078
Hanno Beckerdf8be222020-05-21 15:30:57 +01001079 /*
1080 * Prepare nonce from dynamic and static parts.
1081 */
Hanno Becker17263802020-05-28 07:05:48 +01001082 ssl_build_record_nonce( iv, sizeof( iv ),
1083 transform->iv_dec,
1084 transform->fixed_ivlen,
1085 dynamic_iv,
1086 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001087
Hanno Beckerdf8be222020-05-21 15:30:57 +01001088 /*
1089 * Build additional data for AEAD encryption.
1090 * This depends on the TLS version.
1091 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001092 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001093 transform->minor_ver,
1094 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001095 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001096 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001097
Hanno Beckerd96a6522019-07-10 13:55:25 +01001098 /* Because of the check above, we know that there are
1099 * explicit_iv_len Bytes preceeding data, and taglen
1100 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001101 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001102 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001103
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001104 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001105 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001106 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001107
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001108 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001109 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001110 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001111 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001112 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001113 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001114 data, rec->data_len + transform->taglen, /* src */
1115 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001116 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001117 {
TRodziewicz18efb732021-04-29 23:12:19 +02001118 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1121 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001122
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001123 return( ret );
1124 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001125 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001126
Hanno Beckerd96a6522019-07-10 13:55:25 +01001127 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001128 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001129 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1131 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001132 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001133 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001134 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001136#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001138 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001139 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001140
Paul Bakker5121ce52009-01-03 21:22:43 +00001141 /*
Paul Bakker45829992013-01-03 14:52:21 +01001142 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001143 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001144#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001145 /* The ciphertext is prefixed with the CBC IV. */
1146 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001147#endif
Paul Bakker45829992013-01-03 14:52:21 +01001148
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001149 /* Size considerations:
1150 *
1151 * - The CBC cipher text must not be empty and hence
1152 * at least of size transform->ivlen.
1153 *
1154 * Together with the potential IV-prefix, this explains
1155 * the first of the two checks below.
1156 *
1157 * - The record must contain a MAC, either in plain or
1158 * encrypted, depending on whether Encrypt-then-MAC
1159 * is used or not.
1160 * - If it is, the message contains the IV-prefix,
1161 * the CBC ciphertext, and the MAC.
1162 * - If it is not, the padded plaintext, and hence
1163 * the CBC ciphertext, has at least length maclen + 1
1164 * because there is at least the padding length byte.
1165 *
1166 * As the CBC ciphertext is not empty, both cases give the
1167 * lower bound minlen + maclen + 1 on the record size, which
1168 * we test for in the second check below.
1169 */
1170 if( rec->data_len < minlen + transform->ivlen ||
1171 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001172 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001173 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1174 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1175 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001176 "+ 1 ) ( + expl IV )", rec->data_len,
1177 transform->ivlen,
1178 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001180 }
1181
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001182 /*
1183 * Authenticate before decrypt if enabled
1184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001186 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001187 {
Hanno Becker992b6872017-11-09 18:57:39 +00001188 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001191
Hanno Beckerd96a6522019-07-10 13:55:25 +01001192 /* Update data_len in tandem with add_data.
1193 *
1194 * The subtraction is safe because of the previous check
1195 * data_len >= minlen + maclen + 1.
1196 *
1197 * Afterwards, we know that data + data_len is followed by at
1198 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001199 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001200 *
1201 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001202 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001203 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001204 transform->minor_ver,
1205 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001206
Hanno Beckerd96a6522019-07-10 13:55:25 +01001207 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001208 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1209 add_data_len );
1210 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1211 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001212 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1213 data, rec->data_len );
1214 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1215 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001216
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001217 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1218 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001219 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001220 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001221
Hanno Beckerd96a6522019-07-10 13:55:25 +01001222 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001223 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001224 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001225 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001227 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001228 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001229 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001230 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001232
1233 /*
1234 * Check length sanity
1235 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001236
1237 /* We know from above that data_len > minlen >= 0,
1238 * so the following check in particular implies that
1239 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001240 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001241 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1243 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001244 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001246 }
1247
TRodziewicz0f82ec62021-05-12 17:49:18 +02001248#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001249 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001250 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001251 */
TRodziewicz345165c2021-07-06 13:42:11 +02001252 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1253 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001254
TRodziewicz345165c2021-07-06 13:42:11 +02001255 data += transform->ivlen;
1256 rec->data_offset += transform->ivlen;
1257 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001259
Hanno Beckerd96a6522019-07-10 13:55:25 +01001260 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1261
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001262 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1263 transform->iv_dec, transform->ivlen,
1264 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001265 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001267 return( ret );
1268 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001269
Hanno Beckerd96a6522019-07-10 13:55:25 +01001270 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001271 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001272 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1274 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001275 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001276
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001277 /* Safe since data_len >= minlen + maclen + 1, so after having
1278 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001279 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1280 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001281 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001282
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001283 if( auth_done == 1 )
1284 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001285 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001286 rec->data_len,
1287 padlen + 1 );
1288 correct &= mask;
1289 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001290 }
1291 else
Paul Bakker45829992013-01-03 14:52:21 +01001292 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001294 if( rec->data_len < transform->maclen + padlen + 1 )
1295 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001296 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1297 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1298 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001299 rec->data_len,
1300 transform->maclen,
1301 padlen + 1 ) );
1302 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001303#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001304
Gabor Mezei90437e32021-10-20 11:59:27 +02001305 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001306 rec->data_len,
1307 transform->maclen + padlen + 1 );
1308 correct &= mask;
1309 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001310 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001311
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001312 padlen++;
1313
1314 /* Regardless of the validity of the padding,
1315 * we have data_len >= padlen here. */
1316
TRodziewicz0f82ec62021-05-12 17:49:18 +02001317#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001318 /* The padding check involves a series of up to 256
1319 * consecutive memory reads at the end of the record
1320 * plaintext buffer. In order to hide the length and
1321 * validity of the padding, always perform exactly
1322 * `min(256,plaintext_len)` reads (but take into account
1323 * only the last `padlen` bytes for the padding check). */
1324 size_t pad_count = 0;
1325 volatile unsigned char* const check = data;
1326
1327 /* Index of first padding byte; it has been ensured above
1328 * that the subtraction is safe. */
1329 size_t const padding_idx = rec->data_len - padlen;
1330 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1331 size_t const start_idx = rec->data_len - num_checks;
1332 size_t idx;
1333
1334 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001335 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001336 /* pad_count += (idx >= padding_idx) &&
1337 * (check[idx] == padlen - 1);
1338 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001339 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1340 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001341 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001342 pad_count += mask & equal;
1343 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001344 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001347 if( padlen > 0 && correct == 0 )
1348 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001349#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001350 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001351
TRodziewicz0f82ec62021-05-12 17:49:18 +02001352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001353
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001354 /* If the padding was found to be invalid, padlen == 0
1355 * and the subtraction is safe. If the padding was found valid,
1356 * padlen hasn't been changed and the previous assertion
1357 * data_len >= padlen still holds. */
1358 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001359 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001360 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001361#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001362 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1364 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001365 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001366
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001367#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001369 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001370#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001371
1372 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001373 * Authenticate if not done yet.
1374 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001375 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001376#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001377 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001378 {
Hanno Becker992b6872017-11-09 18:57:39 +00001379 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001380 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001381
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001382 /* If the initial value of padlen was such that
1383 * data_len < maclen + padlen + 1, then padlen
1384 * got reset to 1, and the initial check
1385 * data_len >= minlen + maclen + 1
1386 * guarantees that at this point we still
1387 * have at least data_len >= maclen.
1388 *
1389 * If the initial value of padlen was such that
1390 * data_len >= maclen + padlen + 1, then we have
1391 * subtracted either padlen + 1 (if the padding was correct)
1392 * or 0 (if the padding was incorrect) since then,
1393 * hence data_len >= maclen in any case.
1394 */
1395 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001396 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001397 transform->minor_ver,
1398 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001399
TRodziewicz0f82ec62021-05-12 17:49:18 +02001400#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001401 /*
1402 * The next two sizes are the minimum and maximum values of
1403 * data_len over all padlen values.
1404 *
1405 * They're independent of padlen, since we previously did
1406 * data_len -= padlen.
1407 *
1408 * Note that max_len + maclen is never more than the buffer
1409 * length, as we previously did in_msglen -= maclen too.
1410 */
1411 const size_t max_len = rec->data_len + padlen;
1412 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1413
Gabor Mezei90437e32021-10-20 11:59:27 +02001414 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001415 add_data, add_data_len,
1416 data, rec->data_len, min_len, max_len,
1417 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001418 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001419 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001420 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001421 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001422 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001423
Gabor Mezei90437e32021-10-20 11:59:27 +02001424 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001425 rec->data_len,
1426 min_len, max_len,
1427 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001428#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001430#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001431 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001432 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001433#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001434
Gabor Mezei90437e32021-10-20 11:59:27 +02001435 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001436 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001437 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#if defined(MBEDTLS_SSL_DEBUG_ALL)
1439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001440#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001441 correct = 0;
1442 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001443 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001444 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001445
1446 /*
1447 * Finally check the correct flag
1448 */
1449 if( correct == 0 )
1450 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001451#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001452
1453 /* Make extra sure authentication was performed, exactly once */
1454 if( auth_done != 1 )
1455 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1457 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001458 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001459
Ronald Cron6f135e12021-12-08 16:57:54 +01001460#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001461 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1462 {
1463 /* Remove inner padding and infer true content type. */
1464 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1465 &rec->type );
1466
1467 if( ret != 0 )
1468 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1469 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001470#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001471
Hanno Beckera0e20d02019-05-15 14:03:01 +01001472#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001473 if( rec->cid_len != 0 )
1474 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001475 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1476 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001477 if( ret != 0 )
1478 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1479 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001480#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001483
1484 return( 0 );
1485}
1486
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001487#undef MAC_NONE
1488#undef MAC_PLAINTEXT
1489#undef MAC_CIPHERTEXT
1490
Paul Bakker5121ce52009-01-03 21:22:43 +00001491/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001492 * Fill the input message buffer by appending data to it.
1493 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001494 *
1495 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1496 * available (from this read and/or a previous one). Otherwise, an error code
1497 * is returned (possibly EOF or WANT_READ).
1498 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001499 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1500 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1501 * since we always read a whole datagram at once.
1502 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001503 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001504 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001507{
Janos Follath865b3eb2019-12-16 11:46:15 +00001508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001509 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001510#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1511 size_t in_buf_len = ssl->in_buf_len;
1512#else
1513 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1514#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001517
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001518 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001521 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001523 }
1524
Darryl Greenb33cc762019-11-28 14:29:44 +00001525 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001526 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1528 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001529 }
1530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001532 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001533 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001534 uint32_t timeout;
1535
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001536 /*
1537 * The point is, we need to always read a full datagram at once, so we
1538 * sometimes read more then requested, and handle the additional data.
1539 * It could be the rest of the current record (while fetching the
1540 * header) and/or some other records in the same datagram.
1541 */
1542
1543 /*
1544 * Move to the next record in the already read datagram if applicable
1545 */
1546 if( ssl->next_record_offset != 0 )
1547 {
1548 if( ssl->in_left < ssl->next_record_offset )
1549 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001552 }
1553
1554 ssl->in_left -= ssl->next_record_offset;
1555
1556 if( ssl->in_left != 0 )
1557 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001558 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1559 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001560 ssl->next_record_offset ) );
1561 memmove( ssl->in_hdr,
1562 ssl->in_hdr + ssl->next_record_offset,
1563 ssl->in_left );
1564 }
1565
1566 ssl->next_record_offset = 0;
1567 }
1568
Paul Elliottd48d5c62021-01-07 14:47:05 +00001569 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1570 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001571 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001572
1573 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001574 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001575 */
1576 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001577 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001579 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001580 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001581
1582 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001583 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001584 * are not at the beginning of a new record, the caller did something
1585 * wrong.
1586 */
1587 if( ssl->in_left != 0 )
1588 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1590 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001591 }
1592
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001593 /*
1594 * Don't even try to read if time's out already.
1595 * This avoids by-passing the timer when repeatedly receiving messages
1596 * that will end up being dropped.
1597 */
Hanno Becker7876d122020-02-05 10:39:31 +00001598 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001599 {
1600 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001601 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001602 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001603 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001604 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001605 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001607 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001608 timeout = ssl->handshake->retransmit_timeout;
1609 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001610 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001611
Paul Elliott9f352112020-12-09 14:55:45 +00001612 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001613
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001614 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001615 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1616 timeout );
1617 else
1618 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001621
1622 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001624 }
1625
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001626 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001627 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001629 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001632 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001633 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1634 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001636 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001637 }
1638
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001640 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001642 return( ret );
1643 }
1644
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001645 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001646 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001648 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001650 {
Hanno Becker786300f2020-02-05 10:46:40 +00001651 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001652 {
Hanno Becker786300f2020-02-05 10:46:40 +00001653 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1654 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001655 return( ret );
1656 }
1657
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001658 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001659 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001661 }
1662
Paul Bakker5121ce52009-01-03 21:22:43 +00001663 if( ret < 0 )
1664 return( ret );
1665
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001666 ssl->in_left = ret;
1667 }
1668 else
1669#endif
1670 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001671 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1672 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001673 ssl->in_left, nb_want ) );
1674
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001675 while( ssl->in_left < nb_want )
1676 {
1677 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001678
Hanno Becker7876d122020-02-05 10:39:31 +00001679 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001680 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1681 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001682 {
1683 if( ssl->f_recv_timeout != NULL )
1684 {
1685 ret = ssl->f_recv_timeout( ssl->p_bio,
1686 ssl->in_hdr + ssl->in_left, len,
1687 ssl->conf->read_timeout );
1688 }
1689 else
1690 {
1691 ret = ssl->f_recv( ssl->p_bio,
1692 ssl->in_hdr + ssl->in_left, len );
1693 }
1694 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001695
Paul Elliottd48d5c62021-01-07 14:47:05 +00001696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1697 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001698 ssl->in_left, nb_want ) );
1699 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001700
1701 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001703
1704 if( ret < 0 )
1705 return( ret );
1706
makise-homuraaf9513b2020-08-24 18:26:27 +03001707 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001708 {
Darryl Green11999bb2018-03-13 15:22:58 +00001709 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001710 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001711 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001712 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1713 }
1714
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001715 ssl->in_left += ret;
1716 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001717 }
1718
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001720
1721 return( 0 );
1722}
1723
1724/*
1725 * Flush any data not yet written
1726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001728{
Janos Follath865b3eb2019-12-16 11:46:15 +00001729 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001730 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001733
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001734 if( ssl->f_send == NULL )
1735 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001737 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001739 }
1740
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001741 /* Avoid incrementing counter if data is flushed */
1742 if( ssl->out_left == 0 )
1743 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001745 return( 0 );
1746 }
1747
Paul Bakker5121ce52009-01-03 21:22:43 +00001748 while( ssl->out_left > 0 )
1749 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001750 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1751 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001752 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001753
Hanno Becker2b1e3542018-08-06 11:19:13 +01001754 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001755 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
1759 if( ret <= 0 )
1760 return( ret );
1761
makise-homuraaf9513b2020-08-24 18:26:27 +03001762 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001763 {
Darryl Green11999bb2018-03-13 15:22:58 +00001764 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001765 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001766 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001767 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1768 }
1769
Paul Bakker5121ce52009-01-03 21:22:43 +00001770 ssl->out_left -= ret;
1771 }
1772
Hanno Becker2b1e3542018-08-06 11:19:13 +01001773#if defined(MBEDTLS_SSL_PROTO_DTLS)
1774 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001775 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001776 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001777 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001778 else
1779#endif
1780 {
1781 ssl->out_hdr = ssl->out_buf + 8;
1782 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001783 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001786
1787 return( 0 );
1788}
1789
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001790/*
1791 * Functions to handle the DTLS retransmission state machine
1792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001794/*
1795 * Append current handshake message to current outgoing flight
1796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001798{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1801 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1802 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001803
1804 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001805 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001806 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001807 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001809 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001810 }
1811
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001812 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001813 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001814 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1815 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001817 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001818 }
1819
1820 /* Copy current handshake message with headers */
1821 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1822 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001823 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001824 msg->next = NULL;
1825
1826 /* Append to the current flight */
1827 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001828 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001829 else
1830 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001832 while( cur->next != NULL )
1833 cur = cur->next;
1834 cur->next = msg;
1835 }
1836
Hanno Becker3b235902018-08-06 09:54:53 +01001837 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001838 return( 0 );
1839}
1840
1841/*
1842 * Free the current flight of handshake messages
1843 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001844void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001845{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 mbedtls_ssl_flight_item *cur = flight;
1847 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001848
1849 while( cur != NULL )
1850 {
1851 next = cur->next;
1852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 mbedtls_free( cur->p );
1854 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001855
1856 cur = next;
1857 }
1858}
1859
1860/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001861 * Swap transform_out and out_ctr with the alternative ones
1862 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001863static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001864{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08001866 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001867
1868 if( ssl->transform_out == ssl->handshake->alt_transform_out )
1869 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001871 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001872 }
1873
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001875
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001876 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001877 tmp_transform = ssl->transform_out;
1878 ssl->transform_out = ssl->handshake->alt_transform_out;
1879 ssl->handshake->alt_transform_out = tmp_transform;
1880
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001881 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08001882 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
1883 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
1884 sizeof( ssl->cur_out_ctr ) );
1885 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
1886 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001887
1888 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001889 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001890
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001891 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001892}
1893
1894/*
1895 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001896 */
1897int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
1898{
1899 int ret = 0;
1900
1901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
1902
1903 ret = mbedtls_ssl_flight_transmit( ssl );
1904
1905 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
1906
1907 return( ret );
1908}
1909
1910/*
1911 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001912 *
1913 * Need to remember the current message in case flush_output returns
1914 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001915 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001916 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001917int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001918{
Janos Follath865b3eb2019-12-16 11:46:15 +00001919 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001920 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001921
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001923 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001925
1926 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001927 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001928 ret = ssl_swap_epochs( ssl );
1929 if( ret != 0 )
1930 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001933 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001934
1935 while( ssl->handshake->cur_msg != NULL )
1936 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001937 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001938 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001939
Hanno Beckere1dcb032018-08-17 16:47:58 +01001940 int const is_finished =
1941 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
1942 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
1943
Hanno Becker04da1892018-08-14 13:22:10 +01001944 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
1945 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
1946
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001947 /* Swap epochs before sending Finished: we can't do it after
1948 * sending ChangeCipherSpec, in case write returns WANT_READ.
1949 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01001950 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001951 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001953 ret = ssl_swap_epochs( ssl );
1954 if( ret != 0 )
1955 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001956 }
1957
Hanno Becker67bc7c32018-08-06 11:33:50 +01001958 ret = ssl_get_remaining_payload_in_datagram( ssl );
1959 if( ret < 0 )
1960 return( ret );
1961 max_frag_len = (size_t) ret;
1962
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001963 /* CCS is copied as is, while HS messages may need fragmentation */
1964 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
1965 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001966 if( max_frag_len == 0 )
1967 {
1968 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
1969 return( ret );
1970
1971 continue;
1972 }
1973
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001974 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01001975 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001976 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001977
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001978 /* Update position inside current message */
1979 ssl->handshake->cur_msg_p += cur->len;
1980 }
1981 else
1982 {
1983 const unsigned char * const p = ssl->handshake->cur_msg_p;
1984 const size_t hs_len = cur->len - 12;
1985 const size_t frag_off = p - ( cur->p + 12 );
1986 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001987 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001988
Hanno Beckere1dcb032018-08-17 16:47:58 +01001989 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02001990 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01001991 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001992 {
1993 ret = ssl_swap_epochs( ssl );
1994 if( ret != 0 )
1995 return( ret );
1996 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001997
Hanno Becker67bc7c32018-08-06 11:33:50 +01001998 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
1999 return( ret );
2000
2001 continue;
2002 }
2003 max_hs_frag_len = max_frag_len - 12;
2004
2005 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2006 max_hs_frag_len : rem_len;
2007
2008 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002009 {
2010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002011 (unsigned) cur_hs_frag_len,
2012 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002013 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002014
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002015 /* Messages are stored with handshake headers as if not fragmented,
2016 * copy beginning of headers then fill fragmentation fields.
2017 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2018 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002019
Joe Subbiani5ecac212021-06-24 13:00:03 +01002020 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2021 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2022 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002023
Joe Subbiani5ecac212021-06-24 13:00:03 +01002024 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2025 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2026 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002027
2028 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2029
Hanno Becker3f7b9732018-08-28 09:53:25 +01002030 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002031 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2032 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002033 ssl->out_msgtype = cur->type;
2034
2035 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002036 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002037 }
2038
2039 /* If done with the current message move to the next one if any */
2040 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2041 {
2042 if( cur->next != NULL )
2043 {
2044 ssl->handshake->cur_msg = cur->next;
2045 ssl->handshake->cur_msg_p = cur->next->p + 12;
2046 }
2047 else
2048 {
2049 ssl->handshake->cur_msg = NULL;
2050 ssl->handshake->cur_msg_p = NULL;
2051 }
2052 }
2053
2054 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002055 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002056 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002058 return( ret );
2059 }
2060 }
2061
Hanno Becker67bc7c32018-08-06 11:33:50 +01002062 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2063 return( ret );
2064
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002065 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2067 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002068 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002069 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002071 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002072 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002073
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002075
2076 return( 0 );
2077}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002078
2079/*
2080 * To be called when the last message of an incoming flight is received.
2081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002083{
2084 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002085 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002086 ssl->handshake->flight = NULL;
2087 ssl->handshake->cur_msg = NULL;
2088
2089 /* The next incoming flight will start with this msg_seq */
2090 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2091
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002092 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002093 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002094
Hanno Becker0271f962018-08-16 13:23:47 +01002095 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002096 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002097
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002098 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002099 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2102 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002103 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002105 }
2106 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002108}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002109
2110/*
2111 * To be called when the last message of an outgoing flight is send.
2112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002114{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002115 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002116 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2119 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002120 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002122 }
2123 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002125}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002127
Paul Bakker5121ce52009-01-03 21:22:43 +00002128/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002129 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002130 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002131
2132/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002133 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002134 *
2135 * - fill in handshake headers
2136 * - update handshake checksum
2137 * - DTLS: save message for resending
2138 * - then pass to the record layer
2139 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002140 * DTLS: except for HelloRequest, messages are only queued, and will only be
2141 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002142 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002143 * Inputs:
2144 * - ssl->out_msglen: 4 + actual handshake message len
2145 * (4 is the size of handshake headers for TLS)
2146 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2147 * - ssl->out_msg + 4: the handshake message body
2148 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002149 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002150 * - ssl->out_msglen: the length of the record contents
2151 * (including handshake headers but excluding record headers)
2152 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002153 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002154int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2155 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002156{
Janos Follath865b3eb2019-12-16 11:46:15 +00002157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002158 const size_t hs_len = ssl->out_msglen - 4;
2159 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002160
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002161 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2162
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002163 /*
2164 * Sanity checks
2165 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002166 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002167 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2168 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002169 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2170 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002171 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002172
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002173 /* Whenever we send anything different from a
2174 * HelloRequest we should be in a handshake - double check. */
2175 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2176 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002177 ssl->handshake == NULL )
2178 {
2179 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2180 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2181 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002184 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002185 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002187 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002188 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2189 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002191#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002192
Hanno Beckerb50a2532018-08-06 11:52:54 +01002193 /* Double-check that we did not exceed the bounds
2194 * of the outgoing record buffer.
2195 * This should never fail as the various message
2196 * writing functions must obey the bounds of the
2197 * outgoing record buffer, but better be safe.
2198 *
2199 * Note: We deliberately do not check for the MTU or MFL here.
2200 */
2201 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2202 {
2203 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002204 "size %" MBEDTLS_PRINTF_SIZET
2205 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002206 ssl->out_msglen,
2207 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002208 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2209 }
2210
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002211 /*
2212 * Fill handshake headers
2213 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002214 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002215 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002216 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2217 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2218 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002219
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002220 /*
2221 * DTLS has additional fields in the Handshake layer,
2222 * between the length field and the actual payload:
2223 * uint16 message_seq;
2224 * uint24 fragment_offset;
2225 * uint24 fragment_length;
2226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002228 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002229 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002230 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002231 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002232 {
2233 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002234 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002235 hs_len,
2236 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002237 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2238 }
2239
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002240 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002241 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002242
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002243 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002244 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002245 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002246 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002247 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002248 }
2249 else
2250 {
2251 ssl->out_msg[4] = 0;
2252 ssl->out_msg[5] = 0;
2253 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002254
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002255 /* Handshake hashes are computed without fragmentation,
2256 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002257 memset( ssl->out_msg + 6, 0x00, 3 );
2258 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002259 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002261
Hanno Becker0207e532018-08-28 10:28:28 +01002262 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002263 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002264 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002265 }
2266
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002267 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002269 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002270 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2271 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002272 {
2273 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2274 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002275 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002276 return( ret );
2277 }
2278 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002279 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002280#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002281 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002282 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002283 {
2284 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2285 return( ret );
2286 }
2287 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002288
2289 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2290
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002291 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002292}
2293
2294/*
2295 * Record layer functions
2296 */
2297
2298/*
2299 * Write current record.
2300 *
2301 * Uses:
2302 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2303 * - ssl->out_msglen: length of the record content (excl headers)
2304 * - ssl->out_msg: record content
2305 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002306int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002307{
2308 int ret, done = 0;
2309 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002310 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002311
2312 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313
Paul Bakker05ef8352012-05-08 09:17:57 +00002314 if( !done )
2315 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002316 unsigned i;
2317 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002318#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2319 size_t out_buf_len = ssl->out_buf_len;
2320#else
2321 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2322#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002323 /* Skip writing the record content type to after the encryption,
2324 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002325 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002326#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002327 /* TLS 1.3 still uses the TLS 1.2 version identifier
2328 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002329 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2330 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002331#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002332 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2333 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002334
Jerry Yuae0b2e22021-10-08 15:21:19 +08002335 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002336 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002337
Paul Bakker48916f92012-09-16 19:57:18 +00002338 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002339 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002340 mbedtls_record rec;
2341
2342 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002343 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002344 rec.data_len = ssl->out_msglen;
2345 rec.data_offset = ssl->out_msg - rec.buf;
2346
Jerry Yud96a5c22021-09-29 17:46:51 +08002347 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002348 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002349 ssl->conf->transport, rec.ver );
2350 rec.type = ssl->out_msgtype;
2351
Hanno Beckera0e20d02019-05-15 14:03:01 +01002352#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002353 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002354 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002355#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002356
Hanno Beckera18d1322018-01-03 14:27:32 +00002357 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002358 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002361 return( ret );
2362 }
2363
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002364 if( rec.data_offset != 0 )
2365 {
2366 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2367 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2368 }
2369
Hanno Becker6430faf2019-05-08 11:57:13 +01002370 /* Update the record content type and CID. */
2371 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002372#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002373 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002374#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002375 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002376 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002377 }
2378
Hanno Becker5903de42019-05-03 14:46:38 +01002379 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002380
2381#if defined(MBEDTLS_SSL_PROTO_DTLS)
2382 /* In case of DTLS, double-check that we don't exceed
2383 * the remaining space in the datagram. */
2384 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2385 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002386 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002387 if( ret < 0 )
2388 return( ret );
2389
2390 if( protected_record_size > (size_t) ret )
2391 {
2392 /* Should never happen */
2393 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2394 }
2395 }
2396#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002397
Hanno Becker6430faf2019-05-08 11:57:13 +01002398 /* Now write the potentially updated record content type. */
2399 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2400
Paul Elliott9f352112020-12-09 14:55:45 +00002401 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002402 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002403 ssl->out_hdr[0], ssl->out_hdr[1],
2404 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002407 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002408
2409 ssl->out_left += protected_record_size;
2410 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002411 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002412
Hanno Beckerdd772292020-02-05 10:38:31 +00002413 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002414 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2415 break;
2416
2417 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002418 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002419 {
2420 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2421 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2422 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002423 }
2424
Hanno Becker67bc7c32018-08-06 11:33:50 +01002425#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002426 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2427 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002428 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002429 size_t remaining;
2430 ret = ssl_get_remaining_payload_in_datagram( ssl );
2431 if( ret < 0 )
2432 {
2433 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2434 ret );
2435 return( ret );
2436 }
2437
2438 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002439 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002440 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002441 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002442 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002443 else
2444 {
Hanno Becker513815a2018-08-20 11:56:09 +01002445 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002446 }
2447 }
2448#endif /* MBEDTLS_SSL_PROTO_DTLS */
2449
2450 if( ( flush == SSL_FORCE_FLUSH ) &&
2451 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002452 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002453 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002454 return( ret );
2455 }
2456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002458
2459 return( 0 );
2460}
2461
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002463
2464static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2465{
2466 if( ssl->in_msglen < ssl->in_hslen ||
2467 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2468 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2469 {
2470 return( 1 );
2471 }
2472 return( 0 );
2473}
Hanno Becker44650b72018-08-16 12:51:11 +01002474
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002475static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002476{
2477 return( ( ssl->in_msg[9] << 16 ) |
2478 ( ssl->in_msg[10] << 8 ) |
2479 ssl->in_msg[11] );
2480}
2481
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002482static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002483{
2484 return( ( ssl->in_msg[6] << 16 ) |
2485 ( ssl->in_msg[7] << 8 ) |
2486 ssl->in_msg[8] );
2487}
2488
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002489static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002490{
2491 uint32_t msg_len, frag_off, frag_len;
2492
2493 msg_len = ssl_get_hs_total_len( ssl );
2494 frag_off = ssl_get_hs_frag_off( ssl );
2495 frag_len = ssl_get_hs_frag_len( ssl );
2496
2497 if( frag_off > msg_len )
2498 return( -1 );
2499
2500 if( frag_len > msg_len - frag_off )
2501 return( -1 );
2502
2503 if( frag_len + 12 > ssl->in_msglen )
2504 return( -1 );
2505
2506 return( 0 );
2507}
2508
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002509/*
2510 * Mark bits in bitmask (used for DTLS HS reassembly)
2511 */
2512static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2513{
2514 unsigned int start_bits, end_bits;
2515
2516 start_bits = 8 - ( offset % 8 );
2517 if( start_bits != 8 )
2518 {
2519 size_t first_byte_idx = offset / 8;
2520
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002521 /* Special case */
2522 if( len <= start_bits )
2523 {
2524 for( ; len != 0; len-- )
2525 mask[first_byte_idx] |= 1 << ( start_bits - len );
2526
2527 /* Avoid potential issues with offset or len becoming invalid */
2528 return;
2529 }
2530
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002531 offset += start_bits; /* Now offset % 8 == 0 */
2532 len -= start_bits;
2533
2534 for( ; start_bits != 0; start_bits-- )
2535 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2536 }
2537
2538 end_bits = len % 8;
2539 if( end_bits != 0 )
2540 {
2541 size_t last_byte_idx = ( offset + len ) / 8;
2542
2543 len -= end_bits; /* Now len % 8 == 0 */
2544
2545 for( ; end_bits != 0; end_bits-- )
2546 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2547 }
2548
2549 memset( mask + offset / 8, 0xFF, len / 8 );
2550}
2551
2552/*
2553 * Check that bitmask is full
2554 */
2555static int ssl_bitmask_check( unsigned char *mask, size_t len )
2556{
2557 size_t i;
2558
2559 for( i = 0; i < len / 8; i++ )
2560 if( mask[i] != 0xFF )
2561 return( -1 );
2562
2563 for( i = 0; i < len % 8; i++ )
2564 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2565 return( -1 );
2566
2567 return( 0 );
2568}
2569
Hanno Becker56e205e2018-08-16 09:06:12 +01002570/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002571static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002572 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002573{
Hanno Becker56e205e2018-08-16 09:06:12 +01002574 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002575
Hanno Becker56e205e2018-08-16 09:06:12 +01002576 alloc_len = 12; /* Handshake header */
2577 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002578
Hanno Beckerd07df862018-08-16 09:14:58 +01002579 if( add_bitmap )
2580 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002581
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002582 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002583}
Hanno Becker56e205e2018-08-16 09:06:12 +01002584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002586
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002587static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002588{
2589 return( ( ssl->in_msg[1] << 16 ) |
2590 ( ssl->in_msg[2] << 8 ) |
2591 ssl->in_msg[3] );
2592}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002593
Simon Butcher99000142016-10-13 17:21:01 +01002594int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002595{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002597 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002598 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002599 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002601 }
2602
Hanno Becker12555c62018-08-16 12:47:53 +01002603 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002606 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002607 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002610 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002611 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002612 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002613 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002614
Hanno Becker44650b72018-08-16 12:51:11 +01002615 if( ssl_check_hs_header( ssl ) != 0 )
2616 {
2617 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2618 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2619 }
2620
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002621 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002622 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2623 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2624 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2625 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002626 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002627 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2628 {
2629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2630 recv_msg_seq,
2631 ssl->handshake->in_msg_seq ) );
2632 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2633 }
2634
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002635 /* Retransmit only on last message from previous flight, to avoid
2636 * too many retransmissions.
2637 * Besides, No sane server ever retransmits HelloVerifyRequest */
2638 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002640 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002642 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002643 recv_msg_seq,
2644 ssl->handshake->in_flight_start_seq ) );
2645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002647 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002649 return( ret );
2650 }
2651 }
2652 else
2653 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002655 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002656 recv_msg_seq,
2657 ssl->handshake->in_msg_seq ) );
2658 }
2659
Hanno Becker90333da2017-10-10 11:27:13 +01002660 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002661 }
2662 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002663
Hanno Becker6d97ef52018-08-16 13:09:04 +01002664 /* Message reassembly is handled alongside buffering of future
2665 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002666 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002667 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002668 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002669 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002671 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002672 }
2673 }
2674 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002676 /* With TLS we don't handle fragmentation (for now) */
2677 if( ssl->in_msglen < ssl->in_hslen )
2678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2680 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002681 }
2682
Simon Butcher99000142016-10-13 17:21:01 +01002683 return( 0 );
2684}
2685
2686void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2687{
Hanno Becker0271f962018-08-16 13:23:47 +01002688 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002689
Hanno Becker0271f962018-08-16 13:23:47 +01002690 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002691 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002692 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002693 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002694
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002695 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002697 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002698 ssl->handshake != NULL )
2699 {
Hanno Becker0271f962018-08-16 13:23:47 +01002700 unsigned offset;
2701 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002702
Hanno Becker0271f962018-08-16 13:23:47 +01002703 /* Increment handshake sequence number */
2704 hs->in_msg_seq++;
2705
2706 /*
2707 * Clear up handshake buffering and reassembly structure.
2708 */
2709
2710 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002711 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002712
2713 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002714 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2715 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002716 offset++, hs_buf++ )
2717 {
2718 *hs_buf = *(hs_buf + 1);
2719 }
2720
2721 /* Create a fresh last entry */
2722 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002723 }
2724#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002725}
2726
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002727/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002728 * DTLS anti-replay: RFC 6347 4.1.2.6
2729 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002730 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2731 * Bit n is set iff record number in_window_top - n has been seen.
2732 *
2733 * Usually, in_window_top is the last record number seen and the lsb of
2734 * in_window is set. The only exception is the initial state (record number 0
2735 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002738void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002739{
2740 ssl->in_window_top = 0;
2741 ssl->in_window = 0;
2742}
2743
2744static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2745{
2746 return( ( (uint64_t) buf[0] << 40 ) |
2747 ( (uint64_t) buf[1] << 32 ) |
2748 ( (uint64_t) buf[2] << 24 ) |
2749 ( (uint64_t) buf[3] << 16 ) |
2750 ( (uint64_t) buf[4] << 8 ) |
2751 ( (uint64_t) buf[5] ) );
2752}
2753
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002754static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2755{
Janos Follath865b3eb2019-12-16 11:46:15 +00002756 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002757 unsigned char *original_in_ctr;
2758
2759 // save original in_ctr
2760 original_in_ctr = ssl->in_ctr;
2761
2762 // use counter from record
2763 ssl->in_ctr = record_in_ctr;
2764
2765 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2766
2767 // restore the counter
2768 ssl->in_ctr = original_in_ctr;
2769
2770 return ret;
2771}
2772
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002773/*
2774 * Return 0 if sequence number is acceptable, -1 otherwise
2775 */
Hanno Becker0183d692019-07-12 08:50:37 +01002776int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002777{
2778 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2779 uint64_t bit;
2780
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002781 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002782 return( 0 );
2783
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002784 if( rec_seqnum > ssl->in_window_top )
2785 return( 0 );
2786
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002787 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002788
2789 if( bit >= 64 )
2790 return( -1 );
2791
2792 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2793 return( -1 );
2794
2795 return( 0 );
2796}
2797
2798/*
2799 * Update replay window on new validated record
2800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002802{
2803 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2804
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002805 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002806 return;
2807
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002808 if( rec_seqnum > ssl->in_window_top )
2809 {
2810 /* Update window_top and the contents of the window */
2811 uint64_t shift = rec_seqnum - ssl->in_window_top;
2812
2813 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002814 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002815 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002816 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002817 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002818 ssl->in_window |= 1;
2819 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002820
2821 ssl->in_window_top = rec_seqnum;
2822 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002823 else
2824 {
2825 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002826 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002827
2828 if( bit < 64 ) /* Always true, but be extra sure */
2829 ssl->in_window |= (uint64_t) 1 << bit;
2830 }
2831}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002833
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002834#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002835/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002836 * Without any SSL context, check if a datagram looks like a ClientHello with
2837 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002838 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002839 *
2840 * - if cookie is valid, return 0
2841 * - if ClientHello looks superficially valid but cookie is not,
2842 * fill obuf and set olen, then
2843 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2844 * - otherwise return a specific error code
2845 */
2846static int ssl_check_dtls_clihlo_cookie(
2847 mbedtls_ssl_cookie_write_t *f_cookie_write,
2848 mbedtls_ssl_cookie_check_t *f_cookie_check,
2849 void *p_cookie,
2850 const unsigned char *cli_id, size_t cli_id_len,
2851 const unsigned char *in, size_t in_len,
2852 unsigned char *obuf, size_t buf_len, size_t *olen )
2853{
2854 size_t sid_len, cookie_len;
2855 unsigned char *p;
2856
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002857 /*
2858 * Structure of ClientHello with record and handshake headers,
2859 * and expected values. We don't need to check a lot, more checks will be
2860 * done when actually parsing the ClientHello - skipping those checks
2861 * avoids code duplication and does not make cookie forging any easier.
2862 *
2863 * 0-0 ContentType type; copied, must be handshake
2864 * 1-2 ProtocolVersion version; copied
2865 * 3-4 uint16 epoch; copied, must be 0
2866 * 5-10 uint48 sequence_number; copied
2867 * 11-12 uint16 length; (ignored)
2868 *
2869 * 13-13 HandshakeType msg_type; (ignored)
2870 * 14-16 uint24 length; (ignored)
2871 * 17-18 uint16 message_seq; copied
2872 * 19-21 uint24 fragment_offset; copied, must be 0
2873 * 22-24 uint24 fragment_length; (ignored)
2874 *
2875 * 25-26 ProtocolVersion client_version; (ignored)
2876 * 27-58 Random random; (ignored)
2877 * 59-xx SessionID session_id; 1 byte len + sid_len content
2878 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
2879 * ...
2880 *
2881 * Minimum length is 61 bytes.
2882 */
2883 if( in_len < 61 ||
2884 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
2885 in[3] != 0 || in[4] != 0 ||
2886 in[19] != 0 || in[20] != 0 || in[21] != 0 )
2887 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01002888 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002889 }
2890
2891 sid_len = in[59];
2892 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002893 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002894
2895 cookie_len = in[60 + sid_len];
2896 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002897 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002898
2899 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
2900 cli_id, cli_id_len ) == 0 )
2901 {
2902 /* Valid cookie */
2903 return( 0 );
2904 }
2905
2906 /*
2907 * If we get here, we've got an invalid cookie, let's prepare HVR.
2908 *
2909 * 0-0 ContentType type; copied
2910 * 1-2 ProtocolVersion version; copied
2911 * 3-4 uint16 epoch; copied
2912 * 5-10 uint48 sequence_number; copied
2913 * 11-12 uint16 length; olen - 13
2914 *
2915 * 13-13 HandshakeType msg_type; hello_verify_request
2916 * 14-16 uint24 length; olen - 25
2917 * 17-18 uint16 message_seq; copied
2918 * 19-21 uint24 fragment_offset; copied
2919 * 22-24 uint24 fragment_length; olen - 25
2920 *
2921 * 25-26 ProtocolVersion server_version; 0xfe 0xff
2922 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
2923 *
2924 * Minimum length is 28.
2925 */
2926 if( buf_len < 28 )
2927 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
2928
2929 /* Copy most fields and adapt others */
2930 memcpy( obuf, in, 25 );
2931 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
2932 obuf[25] = 0xfe;
2933 obuf[26] = 0xff;
2934
2935 /* Generate and write actual cookie */
2936 p = obuf + 28;
2937 if( f_cookie_write( p_cookie,
2938 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
2939 {
2940 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2941 }
2942
2943 *olen = p - obuf;
2944
2945 /* Go back and fill length fields */
2946 obuf[27] = (unsigned char)( *olen - 28 );
2947
Joe Subbianifbeb6922021-07-16 14:27:50 +01002948 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
2949 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
2950 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002951
Joe Subbiani6dd73642021-07-19 11:56:54 +01002952 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002953
2954 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
2955}
2956
2957/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002958 * Handle possible client reconnect with the same UDP quadruplet
2959 * (RFC 6347 Section 4.2.8).
2960 *
2961 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
2962 * that looks like a ClientHello.
2963 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002964 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002965 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002966 * - if the input looks like a ClientHello with a valid cookie,
2967 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02002968 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002969 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002970 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002971 * This function is called (through ssl_check_client_reconnect()) when an
2972 * unexpected record is found in ssl_get_next_record(), which will discard the
2973 * record if we return 0, and bubble up the return value otherwise (this
2974 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
2975 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002976 */
2977static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
2978{
Janos Follath865b3eb2019-12-16 11:46:15 +00002979 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002980 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002981
Hanno Becker2fddd372019-07-10 14:37:41 +01002982 if( ssl->conf->f_cookie_write == NULL ||
2983 ssl->conf->f_cookie_check == NULL )
2984 {
2985 /* If we can't use cookies to verify reachability of the peer,
2986 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02002987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
2988 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01002989 return( 0 );
2990 }
2991
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002992 ret = ssl_check_dtls_clihlo_cookie(
2993 ssl->conf->f_cookie_write,
2994 ssl->conf->f_cookie_check,
2995 ssl->conf->p_cookie,
2996 ssl->cli_id, ssl->cli_id_len,
2997 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10002998 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002999
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003000 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3001
3002 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003003 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003004 int send_ret;
3005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3006 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3007 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003008 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003009 * If the error is permanent we'll catch it later,
3010 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003011 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3012 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3013 (void) send_ret;
3014
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003015 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003016 }
3017
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003018 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003019 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003020 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003021 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003022 {
3023 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3024 return( ret );
3025 }
3026
3027 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003028 }
3029
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003030 return( ret );
3031}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003032#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003033
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003034static int ssl_check_record_type( uint8_t record_type )
3035{
3036 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3037 record_type != MBEDTLS_SSL_MSG_ALERT &&
3038 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3039 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3040 {
3041 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3042 }
3043
3044 return( 0 );
3045}
3046
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003047/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003048 * ContentType type;
3049 * ProtocolVersion version;
3050 * uint16 epoch; // DTLS only
3051 * uint48 sequence_number; // DTLS only
3052 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003053 *
3054 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003055 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003056 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3057 *
3058 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003059 * 1. proceed with the record if this function returns 0
3060 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3061 * 3. return CLIENT_RECONNECT if this function return that value
3062 * 4. drop the whole datagram if this function returns anything else.
3063 * Point 2 is needed when the peer is resending, and we have already received
3064 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003065 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003066static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003067 unsigned char *buf,
3068 size_t len,
3069 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003070{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003071 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003072
Hanno Beckere5e7e782019-07-11 12:29:35 +01003073 size_t const rec_hdr_type_offset = 0;
3074 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003075
Hanno Beckere5e7e782019-07-11 12:29:35 +01003076 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3077 rec_hdr_type_len;
3078 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003079
Hanno Beckere5e7e782019-07-11 12:29:35 +01003080 size_t const rec_hdr_ctr_len = 8;
3081#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003082 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003083 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3084 rec_hdr_version_len;
3085
Hanno Beckera0e20d02019-05-15 14:03:01 +01003086#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003087 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3088 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003089 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003090#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3091#endif /* MBEDTLS_SSL_PROTO_DTLS */
3092
3093 size_t rec_hdr_len_offset; /* To be determined */
3094 size_t const rec_hdr_len_len = 2;
3095
3096 /*
3097 * Check minimum lengths for record header.
3098 */
3099
3100#if defined(MBEDTLS_SSL_PROTO_DTLS)
3101 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3102 {
3103 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3104 }
3105 else
3106#endif /* MBEDTLS_SSL_PROTO_DTLS */
3107 {
3108 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3109 }
3110
3111 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3112 {
3113 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3114 (unsigned) len,
3115 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3116 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3117 }
3118
3119 /*
3120 * Parse and validate record content type
3121 */
3122
3123 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003124
3125 /* Check record content type */
3126#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3127 rec->cid_len = 0;
3128
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003129 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003130 ssl->conf->cid_len != 0 &&
3131 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003132 {
3133 /* Shift pointers to account for record header including CID
3134 * struct {
3135 * ContentType special_type = tls12_cid;
3136 * ProtocolVersion version;
3137 * uint16 epoch;
3138 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003139 * opaque cid[cid_length]; // Additional field compared to
3140 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003141 * uint16 length;
3142 * opaque enc_content[DTLSCiphertext.length];
3143 * } DTLSCiphertext;
3144 */
3145
3146 /* So far, we only support static CID lengths
3147 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003148 rec_hdr_cid_len = ssl->conf->cid_len;
3149 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003150
Hanno Beckere5e7e782019-07-11 12:29:35 +01003151 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003152 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003153 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3154 (unsigned) len,
3155 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003156 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003157 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003158
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003159 /* configured CID len is guaranteed at most 255, see
3160 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3161 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003162 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003163 }
3164 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003165#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003166 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003167 if( ssl_check_record_type( rec->type ) )
3168 {
Hanno Becker54229812019-07-12 14:40:00 +01003169 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3170 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003171 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3172 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003173 }
3174
Hanno Beckere5e7e782019-07-11 12:29:35 +01003175 /*
3176 * Parse and validate record version
3177 */
3178
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003179 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3180 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003181 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3182 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003183 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003184
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003185 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003186 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3188 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003189 }
3190
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003191 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003192 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3194 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003195 }
3196
Hanno Beckere5e7e782019-07-11 12:29:35 +01003197 /*
3198 * Parse/Copy record sequence number.
3199 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003200
Hanno Beckere5e7e782019-07-11 12:29:35 +01003201#if defined(MBEDTLS_SSL_PROTO_DTLS)
3202 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003203 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003204 /* Copy explicit record sequence number from input buffer. */
3205 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3206 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003207 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003208 else
3209#endif /* MBEDTLS_SSL_PROTO_DTLS */
3210 {
3211 /* Copy implicit record sequence number from SSL context structure. */
3212 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3213 }
Paul Bakker40e46942009-01-03 21:51:57 +00003214
Hanno Beckere5e7e782019-07-11 12:29:35 +01003215 /*
3216 * Parse record length.
3217 */
3218
Hanno Beckere5e7e782019-07-11 12:29:35 +01003219 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003220 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3221 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003222 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003223
Paul Elliott9f352112020-12-09 14:55:45 +00003224 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003225 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003226 rec->type,
3227 major_ver, minor_ver, rec->data_len ) );
3228
3229 rec->buf = buf;
3230 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003231
Hanno Beckerd417cc92019-07-26 08:20:27 +01003232 if( rec->data_len == 0 )
3233 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003234
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003235 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003236 * DTLS-related tests.
3237 * Check epoch before checking length constraint because
3238 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3239 * message gets duplicated before the corresponding Finished message,
3240 * the second ChangeCipherSpec should be discarded because it belongs
3241 * to an old epoch, but not because its length is shorter than
3242 * the minimum record length for packets using the new record transform.
3243 * Note that these two kinds of failures are handled differently,
3244 * as an unexpected record is silently skipped but an invalid
3245 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003246 */
3247#if defined(MBEDTLS_SSL_PROTO_DTLS)
3248 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3249 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003250 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003251
Hanno Becker955a5c92019-07-10 17:12:07 +01003252 /* Check that the datagram is large enough to contain a record
3253 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003254 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003255 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003256 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3257 (unsigned) len,
3258 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003259 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3260 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003261
Hanno Becker37cfe732019-07-10 17:20:01 +01003262 /* Records from other, non-matching epochs are silently discarded.
3263 * (The case of same-port Client reconnects must be considered in
3264 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003265 if( rec_epoch != ssl->in_epoch )
3266 {
3267 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003268 "expected %u, received %lu",
3269 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003270
Hanno Becker552f7472019-07-19 10:59:12 +01003271 /* Records from the next epoch are considered for buffering
3272 * (concretely: early Finished messages). */
3273 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003274 {
Hanno Becker552f7472019-07-19 10:59:12 +01003275 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3276 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003277 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003278
Hanno Becker2fddd372019-07-10 14:37:41 +01003279 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003280 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003281#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003282 /* For records from the correct epoch, check whether their
3283 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003284 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3285 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003286 {
3287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3288 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3289 }
3290#endif
3291 }
3292#endif /* MBEDTLS_SSL_PROTO_DTLS */
3293
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003294 return( 0 );
3295}
Paul Bakker5121ce52009-01-03 21:22:43 +00003296
Paul Bakker5121ce52009-01-03 21:22:43 +00003297
Hanno Becker2fddd372019-07-10 14:37:41 +01003298#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3299static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3300{
3301 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3302
3303 /*
3304 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3305 * access the first byte of record content (handshake type), as we
3306 * have an active transform (possibly iv_len != 0), so use the
3307 * fact that the record header len is 13 instead.
3308 */
3309 if( rec_epoch == 0 &&
3310 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3311 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3312 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3313 ssl->in_left > 13 &&
3314 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3315 {
3316 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3317 "from the same port" ) );
3318 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003319 }
3320
3321 return( 0 );
3322}
Hanno Becker2fddd372019-07-10 14:37:41 +01003323#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003324
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003325/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003326 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003327 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003328static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3329 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003330{
3331 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003334 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003335
Ronald Cron7e38cba2021-11-24 12:43:39 +01003336 /*
3337 * In TLS 1.3, always treat ChangeCipherSpec records
3338 * as unencrypted. The only thing we do with them is
3339 * check the length and content and ignore them.
3340 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003341#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003342 if( ssl->transform_in != NULL &&
3343 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3344 {
3345 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3346 done = 1;
3347 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003348#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003349
Paul Bakker48916f92012-09-16 19:57:18 +00003350 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003351 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003352 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003353
Hanno Beckera18d1322018-01-03 14:27:32 +00003354 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003355 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003356 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003358
Hanno Beckera0e20d02019-05-15 14:03:01 +01003359#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003360 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3361 ssl->conf->ignore_unexpected_cid
3362 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3363 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003364 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003365 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003366 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003367#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003368
Paul Bakker5121ce52009-01-03 21:22:43 +00003369 return( ret );
3370 }
3371
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003372 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003373 {
3374 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003375 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003376 }
3377
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003378 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003379 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003380
Hanno Beckera0e20d02019-05-15 14:03:01 +01003381#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003382 /* We have already checked the record content type
3383 * in ssl_parse_record_header(), failing or silently
3384 * dropping the record in the case of an unknown type.
3385 *
3386 * Since with the use of CIDs, the record content type
3387 * might change during decryption, re-check the record
3388 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003389 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003390 {
3391 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3392 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3393 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003394#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003395
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003396 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003397 {
3398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3399 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003400 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003401 {
3402 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3403 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3404 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3405 }
3406#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3407
3408 ssl->nb_zero++;
3409
3410 /*
3411 * Three or more empty messages may be a DoS attack
3412 * (excessive CPU consumption).
3413 */
3414 if( ssl->nb_zero > 3 )
3415 {
3416 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003417 "messages, possible DoS attack" ) );
3418 /* Treat the records as if they were not properly authenticated,
3419 * thereby failing the connection if we see more than allowed
3420 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003421 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3422 }
3423 }
3424 else
3425 ssl->nb_zero = 0;
3426
3427#if defined(MBEDTLS_SSL_PROTO_DTLS)
3428 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3429 {
3430 ; /* in_ctr read from peer, not maintained internally */
3431 }
3432 else
3433#endif
3434 {
3435 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003436 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3437 i > mbedtls_ssl_ep_len( ssl ); i-- )
3438 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003439 if( ++ssl->in_ctr[i - 1] != 0 )
3440 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003441 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003442
3443 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003444 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003445 {
3446 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3447 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3448 }
3449 }
3450
Paul Bakker5121ce52009-01-03 21:22:43 +00003451 }
3452
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003454 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003455 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003457 }
3458#endif
3459
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003460 /* Check actual (decrypted) record content length against
3461 * configured maximum. */
3462 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3463 {
3464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3465 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3466 }
3467
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003468 return( 0 );
3469}
3470
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003471/*
3472 * Read a record.
3473 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003474 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3475 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3476 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003477 */
Hanno Becker1097b342018-08-15 14:09:41 +01003478
3479/* Helper functions for mbedtls_ssl_read_record(). */
3480static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003481static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3482static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003483
Hanno Becker327c93b2018-08-15 13:56:18 +01003484int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003485 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003486{
Janos Follath865b3eb2019-12-16 11:46:15 +00003487 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003488
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003490
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003491 if( ssl->keep_current_message == 0 )
3492 {
3493 do {
Simon Butcher99000142016-10-13 17:21:01 +01003494
Hanno Becker26994592018-08-15 14:14:59 +01003495 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003496 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003497 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003498
Hanno Beckere74d5562018-08-15 14:26:08 +01003499 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003500 {
Hanno Becker40f50842018-08-15 14:48:01 +01003501#if defined(MBEDTLS_SSL_PROTO_DTLS)
3502 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003503
Hanno Becker40f50842018-08-15 14:48:01 +01003504 /* We only check for buffered messages if the
3505 * current datagram is fully consumed. */
3506 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003507 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003508 {
Hanno Becker40f50842018-08-15 14:48:01 +01003509 if( ssl_load_buffered_message( ssl ) == 0 )
3510 have_buffered = 1;
3511 }
3512
3513 if( have_buffered == 0 )
3514#endif /* MBEDTLS_SSL_PROTO_DTLS */
3515 {
3516 ret = ssl_get_next_record( ssl );
3517 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3518 continue;
3519
3520 if( ret != 0 )
3521 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003522 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003523 return( ret );
3524 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003525 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003526 }
3527
3528 ret = mbedtls_ssl_handle_message_type( ssl );
3529
Hanno Becker40f50842018-08-15 14:48:01 +01003530#if defined(MBEDTLS_SSL_PROTO_DTLS)
3531 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3532 {
3533 /* Buffer future message */
3534 ret = ssl_buffer_message( ssl );
3535 if( ret != 0 )
3536 return( ret );
3537
3538 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3539 }
3540#endif /* MBEDTLS_SSL_PROTO_DTLS */
3541
Hanno Becker90333da2017-10-10 11:27:13 +01003542 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3543 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003544
3545 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003546 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003547 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003548 return( ret );
3549 }
3550
Hanno Becker327c93b2018-08-15 13:56:18 +01003551 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003552 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003553 {
3554 mbedtls_ssl_update_handshake_status( ssl );
3555 }
Simon Butcher99000142016-10-13 17:21:01 +01003556 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003557 else
Simon Butcher99000142016-10-13 17:21:01 +01003558 {
Hanno Becker02f59072018-08-15 14:00:24 +01003559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003560 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003561 }
3562
3563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3564
3565 return( 0 );
3566}
3567
Hanno Becker40f50842018-08-15 14:48:01 +01003568#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003569static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003570{
Hanno Becker40f50842018-08-15 14:48:01 +01003571 if( ssl->in_left > ssl->next_record_offset )
3572 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003573
Hanno Becker40f50842018-08-15 14:48:01 +01003574 return( 0 );
3575}
3576
3577static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3578{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003579 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003580 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003581 int ret = 0;
3582
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003583 if( hs == NULL )
3584 return( -1 );
3585
Hanno Beckere00ae372018-08-20 09:39:42 +01003586 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3587
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003588 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3589 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3590 {
3591 /* Check if we have seen a ChangeCipherSpec before.
3592 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003593 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003594 {
3595 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3596 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003597 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003598 }
3599
Hanno Becker39b8bc92018-08-28 17:17:13 +01003600 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003601 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3602 ssl->in_msglen = 1;
3603 ssl->in_msg[0] = 1;
3604
3605 /* As long as they are equal, the exact value doesn't matter. */
3606 ssl->in_left = 0;
3607 ssl->next_record_offset = 0;
3608
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003609 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003610 goto exit;
3611 }
Hanno Becker37f95322018-08-16 13:55:32 +01003612
Hanno Beckerb8f50142018-08-28 10:01:34 +01003613#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003614 /* Debug only */
3615 {
3616 unsigned offset;
3617 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3618 {
3619 hs_buf = &hs->buffering.hs[offset];
3620 if( hs_buf->is_valid == 1 )
3621 {
3622 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3623 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003624 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003625 }
3626 }
3627 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003628#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003629
3630 /* Check if we have buffered and/or fully reassembled the
3631 * next handshake message. */
3632 hs_buf = &hs->buffering.hs[0];
3633 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3634 {
3635 /* Synthesize a record containing the buffered HS message. */
3636 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3637 ( hs_buf->data[2] << 8 ) |
3638 hs_buf->data[3];
3639
3640 /* Double-check that we haven't accidentally buffered
3641 * a message that doesn't fit into the input buffer. */
3642 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3643 {
3644 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3645 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3646 }
3647
3648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3649 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3650 hs_buf->data, msg_len + 12 );
3651
3652 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3653 ssl->in_hslen = msg_len + 12;
3654 ssl->in_msglen = msg_len + 12;
3655 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3656
3657 ret = 0;
3658 goto exit;
3659 }
3660 else
3661 {
3662 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3663 hs->in_msg_seq ) );
3664 }
3665
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003666 ret = -1;
3667
3668exit:
3669
3670 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3671 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003672}
3673
Hanno Beckera02b0b42018-08-21 17:20:27 +01003674static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3675 size_t desired )
3676{
3677 int offset;
3678 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3680 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003681
Hanno Becker01315ea2018-08-21 17:22:17 +01003682 /* Get rid of future records epoch first, if such exist. */
3683 ssl_free_buffered_record( ssl );
3684
3685 /* Check if we have enough space available now. */
3686 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3687 hs->buffering.total_bytes_buffered ) )
3688 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003689 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003690 return( 0 );
3691 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003692
Hanno Becker4f432ad2018-08-28 10:02:32 +01003693 /* We don't have enough space to buffer the next expected handshake
3694 * message. Remove buffers used for future messages to gain space,
3695 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003696 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3697 offset >= 0; offset-- )
3698 {
3699 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3700 offset ) );
3701
Hanno Beckerb309b922018-08-23 13:18:05 +01003702 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003703
3704 /* Check if we have enough space available now. */
3705 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3706 hs->buffering.total_bytes_buffered ) )
3707 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003708 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003709 return( 0 );
3710 }
3711 }
3712
3713 return( -1 );
3714}
3715
Hanno Becker40f50842018-08-15 14:48:01 +01003716static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3717{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003718 int ret = 0;
3719 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3720
3721 if( hs == NULL )
3722 return( 0 );
3723
3724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3725
3726 switch( ssl->in_msgtype )
3727 {
3728 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003730
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003731 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003732 break;
3733
3734 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003735 {
3736 unsigned recv_msg_seq_offset;
3737 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3738 mbedtls_ssl_hs_buffer *hs_buf;
3739 size_t msg_len = ssl->in_hslen - 12;
3740
3741 /* We should never receive an old handshake
3742 * message - double-check nonetheless. */
3743 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3744 {
3745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3746 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3747 }
3748
3749 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3750 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3751 {
3752 /* Silently ignore -- message too far in the future */
3753 MBEDTLS_SSL_DEBUG_MSG( 2,
3754 ( "Ignore future HS message with sequence number %u, "
3755 "buffering window %u - %u",
3756 recv_msg_seq, ssl->handshake->in_msg_seq,
3757 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3758
3759 goto exit;
3760 }
3761
3762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3763 recv_msg_seq, recv_msg_seq_offset ) );
3764
3765 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3766
3767 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003768 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003769 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003770 size_t reassembly_buf_sz;
3771
Hanno Becker37f95322018-08-16 13:55:32 +01003772 hs_buf->is_fragmented =
3773 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3774
3775 /* We copy the message back into the input buffer
3776 * after reassembly, so check that it's not too large.
3777 * This is an implementation-specific limitation
3778 * and not one from the standard, hence it is not
3779 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003780 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003781 {
3782 /* Ignore message */
3783 goto exit;
3784 }
3785
Hanno Beckere0b150f2018-08-21 15:51:03 +01003786 /* Check if we have enough space to buffer the message. */
3787 if( hs->buffering.total_bytes_buffered >
3788 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3789 {
3790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3791 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3792 }
3793
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003794 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3795 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003796
3797 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3798 hs->buffering.total_bytes_buffered ) )
3799 {
3800 if( recv_msg_seq_offset > 0 )
3801 {
3802 /* If we can't buffer a future message because
3803 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3805 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3806 " (already %" MBEDTLS_PRINTF_SIZET
3807 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003808 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003809 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003810 goto exit;
3811 }
Hanno Beckere1801392018-08-21 16:51:05 +01003812 else
3813 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003814 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3815 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3816 " (already %" MBEDTLS_PRINTF_SIZET
3817 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003818 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003819 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003820 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003821
Hanno Beckera02b0b42018-08-21 17:20:27 +01003822 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003823 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003824 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3825 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3826 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3827 " (already %" MBEDTLS_PRINTF_SIZET
3828 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003829 msg_len,
3830 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003831 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003832 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003833 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3834 goto exit;
3835 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003836 }
3837
Paul Elliottd48d5c62021-01-07 14:47:05 +00003838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003839 msg_len ) );
3840
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003841 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3842 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003843 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003844 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003845 goto exit;
3846 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003847 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003848
3849 /* Prepare final header: copy msg_type, length and message_seq,
3850 * then add standardised fragment_offset and fragment_length */
3851 memcpy( hs_buf->data, ssl->in_msg, 6 );
3852 memset( hs_buf->data + 6, 0, 3 );
3853 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3854
3855 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003856
3857 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003858 }
3859 else
3860 {
3861 /* Make sure msg_type and length are consistent */
3862 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3863 {
3864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3865 /* Ignore */
3866 goto exit;
3867 }
3868 }
3869
Hanno Becker4422bbb2018-08-20 09:40:19 +01003870 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003871 {
3872 size_t frag_len, frag_off;
3873 unsigned char * const msg = hs_buf->data + 12;
3874
3875 /*
3876 * Check and copy current fragment
3877 */
3878
3879 /* Validation of header fields already done in
3880 * mbedtls_ssl_prepare_handshake_record(). */
3881 frag_off = ssl_get_hs_frag_off( ssl );
3882 frag_len = ssl_get_hs_frag_len( ssl );
3883
Paul Elliottd48d5c62021-01-07 14:47:05 +00003884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
3885 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01003886 frag_off, frag_len ) );
3887 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
3888
3889 if( hs_buf->is_fragmented )
3890 {
3891 unsigned char * const bitmask = msg + msg_len;
3892 ssl_bitmask_set( bitmask, frag_off, frag_len );
3893 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
3894 msg_len ) == 0 );
3895 }
3896 else
3897 {
3898 hs_buf->is_complete = 1;
3899 }
3900
3901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
3902 hs_buf->is_complete ? "" : "not yet " ) );
3903 }
3904
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003905 break;
Hanno Becker37f95322018-08-16 13:55:32 +01003906 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003907
3908 default:
Hanno Becker360bef32018-08-28 10:04:33 +01003909 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003910 break;
3911 }
3912
3913exit:
3914
3915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
3916 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003917}
3918#endif /* MBEDTLS_SSL_PROTO_DTLS */
3919
Hanno Becker1097b342018-08-15 14:09:41 +01003920static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003921{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003922 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01003923 * Consume last content-layer message and potentially
3924 * update in_msglen which keeps track of the contents'
3925 * consumption state.
3926 *
3927 * (1) Handshake messages:
3928 * Remove last handshake message, move content
3929 * and adapt in_msglen.
3930 *
3931 * (2) Alert messages:
3932 * Consume whole record content, in_msglen = 0.
3933 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01003934 * (3) Change cipher spec:
3935 * Consume whole record content, in_msglen = 0.
3936 *
3937 * (4) Application data:
3938 * Don't do anything - the record layer provides
3939 * the application data as a stream transport
3940 * and consumes through mbedtls_ssl_read only.
3941 *
3942 */
3943
3944 /* Case (1): Handshake messages */
3945 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003946 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003947 /* Hard assertion to be sure that no application data
3948 * is in flight, as corrupting ssl->in_msglen during
3949 * ssl->in_offt != NULL is fatal. */
3950 if( ssl->in_offt != NULL )
3951 {
3952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3953 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3954 }
3955
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003956 /*
3957 * Get next Handshake message in the current record
3958 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003959
Hanno Becker4a810fb2017-05-24 16:27:30 +01003960 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01003961 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01003962 * current handshake content: If DTLS handshake
3963 * fragmentation is used, that's the fragment
3964 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01003965 * size here is faulty and should be changed at
3966 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003967 * (2) While it doesn't seem to cause problems, one
3968 * has to be very careful not to assume that in_hslen
3969 * is always <= in_msglen in a sensible communication.
3970 * Again, it's wrong for DTLS handshake fragmentation.
3971 * The following check is therefore mandatory, and
3972 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003973 * Additionally, ssl->in_hslen might be arbitrarily out of
3974 * bounds after handling a DTLS message with an unexpected
3975 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003976 */
3977 if( ssl->in_hslen < ssl->in_msglen )
3978 {
3979 ssl->in_msglen -= ssl->in_hslen;
3980 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
3981 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003982
Hanno Becker4a810fb2017-05-24 16:27:30 +01003983 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
3984 ssl->in_msg, ssl->in_msglen );
3985 }
3986 else
3987 {
3988 ssl->in_msglen = 0;
3989 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02003990
Hanno Becker4a810fb2017-05-24 16:27:30 +01003991 ssl->in_hslen = 0;
3992 }
3993 /* Case (4): Application data */
3994 else if( ssl->in_offt != NULL )
3995 {
3996 return( 0 );
3997 }
3998 /* Everything else (CCS & Alerts) */
3999 else
4000 {
4001 ssl->in_msglen = 0;
4002 }
4003
Hanno Becker1097b342018-08-15 14:09:41 +01004004 return( 0 );
4005}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004006
Hanno Beckere74d5562018-08-15 14:26:08 +01004007static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4008{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004009 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004010 return( 1 );
4011
4012 return( 0 );
4013}
4014
Hanno Becker5f066e72018-08-16 14:56:31 +01004015#if defined(MBEDTLS_SSL_PROTO_DTLS)
4016
4017static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4018{
4019 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4020 if( hs == NULL )
4021 return;
4022
Hanno Becker01315ea2018-08-21 17:22:17 +01004023 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004024 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004025 hs->buffering.total_bytes_buffered -=
4026 hs->buffering.future_record.len;
4027
4028 mbedtls_free( hs->buffering.future_record.data );
4029 hs->buffering.future_record.data = NULL;
4030 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004031}
4032
4033static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4034{
4035 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4036 unsigned char * rec;
4037 size_t rec_len;
4038 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004039#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4040 size_t in_buf_len = ssl->in_buf_len;
4041#else
4042 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4043#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004044 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4045 return( 0 );
4046
4047 if( hs == NULL )
4048 return( 0 );
4049
Hanno Becker5f066e72018-08-16 14:56:31 +01004050 rec = hs->buffering.future_record.data;
4051 rec_len = hs->buffering.future_record.len;
4052 rec_epoch = hs->buffering.future_record.epoch;
4053
4054 if( rec == NULL )
4055 return( 0 );
4056
Hanno Becker4cb782d2018-08-20 11:19:05 +01004057 /* Only consider loading future records if the
4058 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004059 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004060 return( 0 );
4061
Hanno Becker5f066e72018-08-16 14:56:31 +01004062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4063
4064 if( rec_epoch != ssl->in_epoch )
4065 {
4066 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4067 goto exit;
4068 }
4069
4070 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4071
4072 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004073 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004074 {
4075 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4076 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4077 }
4078
4079 memcpy( ssl->in_hdr, rec, rec_len );
4080 ssl->in_left = rec_len;
4081 ssl->next_record_offset = 0;
4082
4083 ssl_free_buffered_record( ssl );
4084
4085exit:
4086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4087 return( 0 );
4088}
4089
Hanno Becker519f15d2019-07-11 12:43:20 +01004090static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4091 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004092{
4093 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004094
4095 /* Don't buffer future records outside handshakes. */
4096 if( hs == NULL )
4097 return( 0 );
4098
4099 /* Only buffer handshake records (we are only interested
4100 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004101 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004102 return( 0 );
4103
4104 /* Don't buffer more than one future epoch record. */
4105 if( hs->buffering.future_record.data != NULL )
4106 return( 0 );
4107
Hanno Becker01315ea2018-08-21 17:22:17 +01004108 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004109 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004110 hs->buffering.total_bytes_buffered ) )
4111 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4113 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4114 " (already %" MBEDTLS_PRINTF_SIZET
4115 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004116 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004117 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004118 return( 0 );
4119 }
4120
Hanno Becker5f066e72018-08-16 14:56:31 +01004121 /* Buffer record */
4122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004123 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004124 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004125
4126 /* ssl_parse_record_header() only considers records
4127 * of the next epoch as candidates for buffering. */
4128 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004129 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004130
4131 hs->buffering.future_record.data =
4132 mbedtls_calloc( 1, hs->buffering.future_record.len );
4133 if( hs->buffering.future_record.data == NULL )
4134 {
4135 /* If we run out of RAM trying to buffer a
4136 * record from the next epoch, just ignore. */
4137 return( 0 );
4138 }
4139
Hanno Becker519f15d2019-07-11 12:43:20 +01004140 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004141
Hanno Becker519f15d2019-07-11 12:43:20 +01004142 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004143 return( 0 );
4144}
4145
4146#endif /* MBEDTLS_SSL_PROTO_DTLS */
4147
Hanno Beckere74d5562018-08-15 14:26:08 +01004148static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004149{
Janos Follath865b3eb2019-12-16 11:46:15 +00004150 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004151 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004152
Hanno Becker5f066e72018-08-16 14:56:31 +01004153#if defined(MBEDTLS_SSL_PROTO_DTLS)
4154 /* We might have buffered a future record; if so,
4155 * and if the epoch matches now, load it.
4156 * On success, this call will set ssl->in_left to
4157 * the length of the buffered record, so that
4158 * the calls to ssl_fetch_input() below will
4159 * essentially be no-ops. */
4160 ret = ssl_load_buffered_record( ssl );
4161 if( ret != 0 )
4162 return( ret );
4163#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004164
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004165 /* Ensure that we have enough space available for the default form
4166 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4167 * with no space for CIDs counted in). */
4168 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4169 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004170 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004171 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004172 return( ret );
4173 }
4174
Hanno Beckere5e7e782019-07-11 12:29:35 +01004175 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4176 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004177 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004178#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004179 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004180 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004181 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4182 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004183 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004184 if( ret != 0 )
4185 return( ret );
4186
4187 /* Fall through to handling of unexpected records */
4188 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4189 }
4190
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004191 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4192 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004193#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004194 /* Reset in pointers to default state for TLS/DTLS records,
4195 * assuming no CID and no offset between record content and
4196 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004197 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004198
Hanno Becker7ae20e02019-07-12 08:33:49 +01004199 /* Setup internal message pointers from record structure. */
4200 ssl->in_msgtype = rec.type;
4201#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4202 ssl->in_len = ssl->in_cid + rec.cid_len;
4203#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4204 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4205 ssl->in_msglen = rec.data_len;
4206
Hanno Becker2fddd372019-07-10 14:37:41 +01004207 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004208 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004209 if( ret != 0 )
4210 return( ret );
4211#endif
4212
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004213 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004214 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004215
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004216 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4217 "(header)" ) );
4218 }
4219 else
4220 {
4221 /* Skip invalid record and the rest of the datagram */
4222 ssl->next_record_offset = 0;
4223 ssl->in_left = 0;
4224
4225 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4226 "(header)" ) );
4227 }
4228
4229 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004230 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004231 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004232 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004233#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004234 {
4235 return( ret );
4236 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004237 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004239#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004240 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004241 {
Hanno Beckera8814792019-07-10 15:01:45 +01004242 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004243 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004244 if( ssl->next_record_offset < ssl->in_left )
4245 {
4246 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4247 }
4248 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004249 else
4250#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004251 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004252 /*
4253 * Fetch record contents from underlying transport.
4254 */
Hanno Beckera3175662019-07-11 12:50:29 +01004255 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004256 if( ret != 0 )
4257 {
4258 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4259 return( ret );
4260 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004261
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004262 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004263 }
4264
4265 /*
4266 * Decrypt record contents.
4267 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004268
Hanno Beckerfdf66042019-07-11 13:07:45 +01004269 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004270 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004271#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004272 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004273 {
4274 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004275 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004276 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004277 /* Except when waiting for Finished as a bad mac here
4278 * probably means something went wrong in the handshake
4279 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4280 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4281 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4282 {
4283#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4284 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4285 {
4286 mbedtls_ssl_send_alert_message( ssl,
4287 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4288 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4289 }
4290#endif
4291 return( ret );
4292 }
4293
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004294 if( ssl->conf->badmac_limit != 0 &&
4295 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004296 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004297 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4298 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004299 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004300
Hanno Becker4a810fb2017-05-24 16:27:30 +01004301 /* As above, invalid records cause
4302 * dismissal of the whole datagram. */
4303
4304 ssl->next_record_offset = 0;
4305 ssl->in_left = 0;
4306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004307 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004308 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004309 }
4310
4311 return( ret );
4312 }
4313 else
4314#endif
4315 {
4316 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004317#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4318 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004319 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004320 mbedtls_ssl_send_alert_message( ssl,
4321 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4322 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004323 }
4324#endif
4325 return( ret );
4326 }
4327 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004328
Hanno Becker44d89b22019-07-12 09:40:44 +01004329
4330 /* Reset in pointers to default state for TLS/DTLS records,
4331 * assuming no CID and no offset between record content and
4332 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004333 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004334#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4335 ssl->in_len = ssl->in_cid + rec.cid_len;
4336#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004337 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004338
Hanno Becker8685c822019-07-12 09:37:30 +01004339 /* The record content type may change during decryption,
4340 * so re-read it. */
4341 ssl->in_msgtype = rec.type;
4342 /* Also update the input buffer, because unfortunately
4343 * the server-side ssl_parse_client_hello() reparses the
4344 * record header when receiving a ClientHello initiating
4345 * a renegotiation. */
4346 ssl->in_hdr[0] = rec.type;
4347 ssl->in_msg = rec.buf + rec.data_offset;
4348 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004349 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004350
Simon Butcher99000142016-10-13 17:21:01 +01004351 return( 0 );
4352}
4353
4354int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4355{
Janos Follath865b3eb2019-12-16 11:46:15 +00004356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004357
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004358 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004359 * Handle particular types of records
4360 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004361 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004362 {
Simon Butcher99000142016-10-13 17:21:01 +01004363 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4364 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004365 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004366 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004367 }
4368
Hanno Beckere678eaa2018-08-21 14:57:46 +01004369 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004370 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004371 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004372 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004374 ssl->in_msglen ) );
4375 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004376 }
4377
Hanno Beckere678eaa2018-08-21 14:57:46 +01004378 if( ssl->in_msg[0] != 1 )
4379 {
4380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4381 ssl->in_msg[0] ) );
4382 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4383 }
4384
4385#if defined(MBEDTLS_SSL_PROTO_DTLS)
4386 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4387 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4388 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4389 {
4390 if( ssl->handshake == NULL )
4391 {
4392 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4393 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4394 }
4395
4396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4397 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4398 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004399#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004400
Ronald Cron6f135e12021-12-08 16:57:54 +01004401#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004402 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4403 {
4404#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4405 MBEDTLS_SSL_DEBUG_MSG( 1,
4406 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4407 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4408#else
4409 MBEDTLS_SSL_DEBUG_MSG( 1,
4410 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4411 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4412#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4413 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004414#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004415 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004417 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004418 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004419 if( ssl->in_msglen != 2 )
4420 {
4421 /* Note: Standard allows for more than one 2 byte alert
4422 to be packed in a single message, but Mbed TLS doesn't
4423 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004425 ssl->in_msglen ) );
4426 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4427 }
4428
Paul Elliott9f352112020-12-09 14:55:45 +00004429 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004430 ssl->in_msg[0], ssl->in_msg[1] ) );
4431
4432 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004433 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004435 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004436 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004437 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004438 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004439 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004440 }
4441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004442 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4443 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004444 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004445 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4446 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004447 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004448
4449#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4450 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4451 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4452 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004453 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004454 /* Will be handled when trying to parse ServerHello */
4455 return( 0 );
4456 }
4457#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004458 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004459 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004460 }
4461
Hanno Beckerc76c6192017-06-06 10:03:17 +01004462#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004463 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004464 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004465 /* Drop unexpected ApplicationData records,
4466 * except at the beginning of renegotiations */
4467 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4468 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4469#if defined(MBEDTLS_SSL_RENEGOTIATION)
4470 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4471 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004472#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004473 )
4474 {
4475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4476 return( MBEDTLS_ERR_SSL_NON_FATAL );
4477 }
4478
4479 if( ssl->handshake != NULL &&
4480 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4481 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004482 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004483 }
4484 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004485#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004486
Paul Bakker5121ce52009-01-03 21:22:43 +00004487 return( 0 );
4488}
4489
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004490int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004491{
irwir6c0da642019-09-26 21:07:41 +03004492 return( mbedtls_ssl_send_alert_message( ssl,
4493 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4494 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004495}
4496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004497int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004498 unsigned char level,
4499 unsigned char message )
4500{
Janos Follath865b3eb2019-12-16 11:46:15 +00004501 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004502
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004503 if( ssl == NULL || ssl->conf == NULL )
4504 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004506 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004507 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004509 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004510 ssl->out_msglen = 2;
4511 ssl->out_msg[0] = level;
4512 ssl->out_msg[1] = message;
4513
Hanno Becker67bc7c32018-08-06 11:33:50 +01004514 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004515 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004516 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004517 return( ret );
4518 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004519 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004520
4521 return( 0 );
4522}
4523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004524int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004525{
Janos Follath865b3eb2019-12-16 11:46:15 +00004526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004531 ssl->out_msglen = 1;
4532 ssl->out_msg[0] = 1;
4533
Paul Bakker5121ce52009-01-03 21:22:43 +00004534 ssl->state++;
4535
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004536 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004537 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004538 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004539 return( ret );
4540 }
4541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004543
4544 return( 0 );
4545}
4546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004548{
Janos Follath865b3eb2019-12-16 11:46:15 +00004549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004552
Hanno Becker327c93b2018-08-15 13:56:18 +01004553 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004554 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004555 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004556 return( ret );
4557 }
4558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004559 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004562 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4563 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004565 }
4566
Hanno Beckere678eaa2018-08-21 14:57:46 +01004567 /* CCS records are only accepted if they have length 1 and content '1',
4568 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004569
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004570 /*
4571 * Switch to our negotiated transform and session parameters for inbound
4572 * data.
4573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004574 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004575 ssl->transform_in = ssl->transform_negotiate;
4576 ssl->session_in = ssl->session_negotiate;
4577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004579 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004582 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004583#endif
4584
4585 /* Increment epoch */
4586 if( ++ssl->in_epoch == 0 )
4587 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004589 /* This is highly unlikely to happen for legitimate reasons, so
4590 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004592 }
4593 }
4594 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004596 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004597
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004598 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004599
Paul Bakker5121ce52009-01-03 21:22:43 +00004600 ssl->state++;
4601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004602 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004603
4604 return( 0 );
4605}
4606
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004607/* Once ssl->out_hdr as the address of the beginning of the
4608 * next outgoing record is set, deduce the other pointers.
4609 *
4610 * Note: For TLS, we save the implicit record sequence number
4611 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4612 * and the caller has to make sure there's space for this.
4613 */
4614
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004615static size_t ssl_transform_get_explicit_iv_len(
4616 mbedtls_ssl_transform const *transform )
4617{
TRodziewiczef73f012021-05-13 14:53:36 +02004618 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004619 return( 0 );
4620
4621 return( transform->ivlen - transform->fixed_ivlen );
4622}
4623
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004624void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4625 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004626{
4627#if defined(MBEDTLS_SSL_PROTO_DTLS)
4628 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4629 {
4630 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004631#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004632 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004633 ssl->out_len = ssl->out_cid;
4634 if( transform != NULL )
4635 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004636#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004637 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004638#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004639 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004640 }
4641 else
4642#endif
4643 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004644 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004645#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004646 ssl->out_cid = ssl->out_len;
4647#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004648 ssl->out_iv = ssl->out_hdr + 5;
4649 }
4650
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004651 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004652 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004653 if( transform != NULL )
4654 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004655}
4656
4657/* Once ssl->in_hdr as the address of the beginning of the
4658 * next incoming record is set, deduce the other pointers.
4659 *
4660 * Note: For TLS, we save the implicit record sequence number
4661 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4662 * and the caller has to make sure there's space for this.
4663 */
4664
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004665void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004666{
Hanno Becker79594fd2019-05-08 09:38:41 +01004667 /* This function sets the pointers to match the case
4668 * of unprotected TLS/DTLS records, with both ssl->in_iv
4669 * and ssl->in_msg pointing to the beginning of the record
4670 * content.
4671 *
4672 * When decrypting a protected record, ssl->in_msg
4673 * will be shifted to point to the beginning of the
4674 * record plaintext.
4675 */
4676
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004677#if defined(MBEDTLS_SSL_PROTO_DTLS)
4678 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4679 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004680 /* This sets the header pointers to match records
4681 * without CID. When we receive a record containing
4682 * a CID, the fields are shifted accordingly in
4683 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004684 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004685#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004686 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004687 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004688#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004689 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004690#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004691 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004692 }
4693 else
4694#endif
4695 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004696 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004697 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004698#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004699 ssl->in_cid = ssl->in_len;
4700#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004701 ssl->in_iv = ssl->in_hdr + 5;
4702 }
4703
Hanno Becker79594fd2019-05-08 09:38:41 +01004704 /* This will be adjusted at record decryption time. */
4705 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004706}
4707
Paul Bakker5121ce52009-01-03 21:22:43 +00004708/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004709 * Setup an SSL context
4710 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004711
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004712void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004713{
4714 /* Set the incoming and outgoing record pointers. */
4715#if defined(MBEDTLS_SSL_PROTO_DTLS)
4716 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4717 {
4718 ssl->out_hdr = ssl->out_buf;
4719 ssl->in_hdr = ssl->in_buf;
4720 }
4721 else
4722#endif /* MBEDTLS_SSL_PROTO_DTLS */
4723 {
Hanno Becker12078f42021-03-02 15:28:41 +00004724 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004725 ssl->out_hdr = ssl->out_buf + 8;
4726 ssl->in_hdr = ssl->in_buf + 8;
4727 }
4728
4729 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004730 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4731 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004732}
4733
Paul Bakker5121ce52009-01-03 21:22:43 +00004734/*
4735 * SSL get accessors
4736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004737size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004738{
4739 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4740}
4741
Hanno Becker8b170a02017-10-10 11:51:19 +01004742int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4743{
4744 /*
4745 * Case A: We're currently holding back
4746 * a message for further processing.
4747 */
4748
4749 if( ssl->keep_current_message == 1 )
4750 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004751 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004752 return( 1 );
4753 }
4754
4755 /*
4756 * Case B: Further records are pending in the current datagram.
4757 */
4758
4759#if defined(MBEDTLS_SSL_PROTO_DTLS)
4760 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4761 ssl->in_left > ssl->next_record_offset )
4762 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004763 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004764 return( 1 );
4765 }
4766#endif /* MBEDTLS_SSL_PROTO_DTLS */
4767
4768 /*
4769 * Case C: A handshake message is being processed.
4770 */
4771
Hanno Becker8b170a02017-10-10 11:51:19 +01004772 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4773 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004774 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004775 return( 1 );
4776 }
4777
4778 /*
4779 * Case D: An application data message is being processed
4780 */
4781 if( ssl->in_offt != NULL )
4782 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004783 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004784 return( 1 );
4785 }
4786
4787 /*
4788 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004789 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004790 * we implement support for multiple alerts in single records.
4791 */
4792
4793 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4794 return( 0 );
4795}
4796
Paul Bakker43ca69c2011-01-15 17:35:19 +00004797
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004799{
Hanno Becker3136ede2018-08-17 15:28:19 +01004800 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004801 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004802 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004803
Hanno Becker5903de42019-05-03 14:46:38 +01004804 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4805
Hanno Becker78640902018-08-13 16:35:15 +01004806 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004807 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004809 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004810 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811 case MBEDTLS_MODE_GCM:
4812 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004813 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004815 transform_expansion = transform->minlen;
4816 break;
4817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004819
4820 block_size = mbedtls_cipher_get_block_size(
4821 &transform->cipher_ctx_enc );
4822
Hanno Becker3136ede2018-08-17 15:28:19 +01004823 /* Expansion due to the addition of the MAC. */
4824 transform_expansion += transform->maclen;
4825
4826 /* Expansion due to the addition of CBC padding;
4827 * Theoretically up to 256 bytes, but we never use
4828 * more than the block size of the underlying cipher. */
4829 transform_expansion += block_size;
4830
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004831 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004832 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004833#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004834 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004835#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004836
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004837 break;
4838
4839 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004841 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004842 }
4843
Hanno Beckera0e20d02019-05-15 14:03:01 +01004844#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004845 if( transform->out_cid_len != 0 )
4846 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004847#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004848
Hanno Becker5903de42019-05-03 14:46:38 +01004849 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004850}
4851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004852#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004853/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004854 * Check record counters and renegotiate if they're above the limit.
4855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004856static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004857{
Hanno Beckerdd772292020-02-05 10:38:31 +00004858 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004859 int in_ctr_cmp;
4860 int out_ctr_cmp;
4861
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004862 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4863 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004864 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004865 {
4866 return( 0 );
4867 }
4868
Andres AG2196c7f2016-12-15 17:01:16 +00004869 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08004870 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08004871 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004872 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
4873 &ssl->conf->renego_period[ep_len],
4874 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00004875
4876 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004877 {
4878 return( 0 );
4879 }
4880
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004881 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004882 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004883}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004884#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004885
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004886/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004887 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004888 * may only be sent for the purpose of initiating renegotiations.
4889 *
4890 * This function is introduced as a separate helper since the handling
4891 * of post-handshake handshake messages changes significantly in TLS 1.3,
4892 * and having a helper function allows to distinguish between TLS <= 1.2 and
4893 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
4894 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00004895static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004896{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01004897 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004898
4899 /*
4900 * - For client-side, expect SERVER_HELLO_REQUEST.
4901 * - For server-side, expect CLIENT_HELLO.
4902 * - Fail (TLS) or silently drop record (DTLS) in other cases.
4903 */
4904
4905#if defined(MBEDTLS_SSL_CLI_C)
4906 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4907 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
4908 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
4909 {
4910 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
4911
4912 /* With DTLS, drop the packet (probably from last handshake) */
4913#if defined(MBEDTLS_SSL_PROTO_DTLS)
4914 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4915 {
4916 return( 0 );
4917 }
4918#endif
4919 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4920 }
4921#endif /* MBEDTLS_SSL_CLI_C */
4922
4923#if defined(MBEDTLS_SSL_SRV_C)
4924 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4925 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
4926 {
4927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
4928
4929 /* With DTLS, drop the packet (probably from last handshake) */
4930#if defined(MBEDTLS_SSL_PROTO_DTLS)
4931 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4932 {
4933 return( 0 );
4934 }
4935#endif
4936 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4937 }
4938#endif /* MBEDTLS_SSL_SRV_C */
4939
4940#if defined(MBEDTLS_SSL_RENEGOTIATION)
4941 /* Determine whether renegotiation attempt should be accepted */
4942 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
4943 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
4944 ssl->conf->allow_legacy_renegotiation ==
4945 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
4946 {
4947 /*
4948 * Accept renegotiation request
4949 */
4950
4951 /* DTLS clients need to know renego is server-initiated */
4952#if defined(MBEDTLS_SSL_PROTO_DTLS)
4953 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4954 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
4955 {
4956 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
4957 }
4958#endif
4959 ret = mbedtls_ssl_start_renegotiation( ssl );
4960 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
4961 ret != 0 )
4962 {
4963 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
4964 ret );
4965 return( ret );
4966 }
4967 }
4968 else
4969#endif /* MBEDTLS_SSL_RENEGOTIATION */
4970 {
4971 /*
4972 * Refuse renegotiation
4973 */
4974
4975 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
4976
TRodziewicz0f82ec62021-05-12 17:49:18 +02004977#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004978 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
4979 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
4980 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004981 {
TRodziewicz345165c2021-07-06 13:42:11 +02004982 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004983 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02004984#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004985 }
4986
4987 return( 0 );
4988}
4989
Paul Bakker48916f92012-09-16 19:57:18 +00004990/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004991 * Receive application data decrypted from the SSL layer
4992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004993int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00004994{
Janos Follath865b3eb2019-12-16 11:46:15 +00004995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00004996 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00004997
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004998 if( ssl == NULL || ssl->conf == NULL )
4999 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005003#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005004 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005005 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005006 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005007 return( ret );
5008
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005009 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005011 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005012 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005013 return( ret );
5014 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005015 }
5016#endif
5017
Hanno Becker4a810fb2017-05-24 16:27:30 +01005018 /*
5019 * Check if renegotiation is necessary and/or handshake is
5020 * in process. If yes, perform/continue, and fall through
5021 * if an unexpected packet is received while the client
5022 * is waiting for the ServerHello.
5023 *
5024 * (There is no equivalent to the last condition on
5025 * the server-side as it is not treated as within
5026 * a handshake while waiting for the ClientHello
5027 * after a renegotiation request.)
5028 */
5029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005030#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005031 ret = ssl_check_ctr_renegotiate( ssl );
5032 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5033 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005034 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005035 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005036 return( ret );
5037 }
5038#endif
5039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005040 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005041 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005042 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005043 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5044 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005045 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005046 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005047 return( ret );
5048 }
5049 }
5050
Hanno Beckere41158b2017-10-23 13:30:32 +01005051 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005052 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005053 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005054 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005055 if( ssl->f_get_timer != NULL &&
5056 ssl->f_get_timer( ssl->p_timer ) == -1 )
5057 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005058 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005059 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005060
Hanno Becker327c93b2018-08-15 13:56:18 +01005061 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005062 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005063 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5064 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005065
Hanno Becker4a810fb2017-05-24 16:27:30 +01005066 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5067 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005068 }
5069
5070 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005072 {
5073 /*
5074 * OpenSSL sends empty messages to randomize the IV
5075 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005076 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005078 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005079 return( 0 );
5080
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005081 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005082 return( ret );
5083 }
5084 }
5085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005086 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005087 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005088 ret = ssl_handle_hs_message_post_handshake( ssl );
5089 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005090 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005091 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5092 ret );
5093 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005094 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005095
Hanno Beckerf26cc722021-04-21 07:30:13 +01005096 /* At this point, we don't know whether the renegotiation triggered
5097 * by the post-handshake message has been completed or not. The cases
5098 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005099 * 1) The renegotiation is complete. In this case, no new record
5100 * has been read yet.
5101 * 2) The renegotiation is incomplete because the client received
5102 * an application data record while awaiting the ServerHello.
5103 * 3) The renegotiation is incomplete because the client received
5104 * a non-handshake, non-application data message while awaiting
5105 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005106 *
5107 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005108 * - For 1), the next iteration will read a new record and check
5109 * if it's application data.
5110 * - For 2), the loop condition isn't satisfied as application data
5111 * is present, hence continue is the same as break
5112 * - For 3), the loop condition is satisfied and read_record
5113 * will re-deliver the message that was held back by the client
5114 * when expecting the ServerHello.
5115 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005116
Hanno Becker90333da2017-10-10 11:27:13 +01005117 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005118 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005119#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005120 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005121 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005122 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005123 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005124 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005125 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005126 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005127 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005128 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005129 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005130 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005131 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005132#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005134 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5135 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005136 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005138 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005139 }
5140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005141 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005142 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5144 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005145 }
5146
5147 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005148
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005149 /* We're going to return something now, cancel timer,
5150 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005151 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005152 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005155 /* If we requested renego but received AppData, resend HelloRequest.
5156 * Do it now, after setting in_offt, to avoid taking this branch
5157 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005158#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005159 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005160 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005161 {
Hanno Becker786300f2020-02-05 10:46:40 +00005162 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005163 {
Hanno Becker786300f2020-02-05 10:46:40 +00005164 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5165 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005166 return( ret );
5167 }
5168 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005169#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005170#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005171 }
5172
5173 n = ( len < ssl->in_msglen )
5174 ? len : ssl->in_msglen;
5175
5176 memcpy( buf, ssl->in_offt, n );
5177 ssl->in_msglen -= n;
5178
gabor-mezei-arma3214132020-07-15 10:55:00 +02005179 /* Zeroising the plaintext buffer to erase unused application data
5180 from the memory. */
5181 mbedtls_platform_zeroize( ssl->in_offt, n );
5182
Paul Bakker5121ce52009-01-03 21:22:43 +00005183 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005184 {
5185 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005186 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005187 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005188 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005189 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005190 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005191 /* more data available */
5192 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005193 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005196
Paul Bakker23986e52011-04-24 08:57:21 +00005197 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005198}
5199
5200/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005201 * Send application data to be encrypted by the SSL layer, taking care of max
5202 * fragment length and buffer size.
5203 *
5204 * According to RFC 5246 Section 6.2.1:
5205 *
5206 * Zero-length fragments of Application data MAY be sent as they are
5207 * potentially useful as a traffic analysis countermeasure.
5208 *
5209 * Therefore, it is possible that the input message length is 0 and the
5210 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005211 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005212static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005213 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005214{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005215 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5216 const size_t max_len = (size_t) ret;
5217
5218 if( ret < 0 )
5219 {
5220 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5221 return( ret );
5222 }
5223
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005224 if( len > max_len )
5225 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005226#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005227 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005228 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005229 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005230 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5231 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005232 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005233 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005234 }
5235 else
5236#endif
5237 len = max_len;
5238 }
Paul Bakker887bd502011-06-08 13:10:54 +00005239
Paul Bakker5121ce52009-01-03 21:22:43 +00005240 if( ssl->out_left != 0 )
5241 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005242 /*
5243 * The user has previously tried to send the data and
5244 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5245 * written. In this case, we expect the high-level write function
5246 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005248 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005249 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005250 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005251 return( ret );
5252 }
5253 }
Paul Bakker887bd502011-06-08 13:10:54 +00005254 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005255 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005256 /*
5257 * The user is trying to send a message the first time, so we need to
5258 * copy the data into the internal buffers and setup the data structure
5259 * to keep track of partial writes
5260 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005261 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005262 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005263 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005264
Hanno Becker67bc7c32018-08-06 11:33:50 +01005265 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005268 return( ret );
5269 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005270 }
5271
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005272 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005273}
5274
5275/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005276 * Write application data (public-facing wrapper)
5277 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005278int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005279{
Janos Follath865b3eb2019-12-16 11:46:15 +00005280 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005281
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005283
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005284 if( ssl == NULL || ssl->conf == NULL )
5285 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5286
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005287#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005288 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5289 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005290 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005291 return( ret );
5292 }
5293#endif
5294
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005295 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005296 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005297 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005298 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005299 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005300 return( ret );
5301 }
5302 }
5303
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005304 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005305
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005306 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005307
5308 return( ret );
5309}
5310
5311/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005312 * Notify the peer that the connection is being closed
5313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005314int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005315{
Janos Follath865b3eb2019-12-16 11:46:15 +00005316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005317
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005318 if( ssl == NULL || ssl->conf == NULL )
5319 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005322
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005323 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005324 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005326 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005327 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005328 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5329 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5330 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005331 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005332 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005333 return( ret );
5334 }
5335 }
5336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005338
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005339 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005340}
5341
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005342void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005343{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005344 if( transform == NULL )
5345 return;
5346
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005347 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5348 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005349
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005350#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005351 mbedtls_md_free( &transform->md_ctx_enc );
5352 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005353#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005354
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005355 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005356}
5357
Jerry Yuc7875b52021-09-05 21:05:50 +08005358void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5359 mbedtls_ssl_transform *transform )
5360{
Jerry Yuc7875b52021-09-05 21:05:50 +08005361 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005362 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005363}
5364
5365void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5366 mbedtls_ssl_transform *transform )
5367{
5368 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005369 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005370}
5371
Hanno Becker0271f962018-08-16 13:23:47 +01005372#if defined(MBEDTLS_SSL_PROTO_DTLS)
5373
Hanno Becker533ab5f2020-02-05 10:49:13 +00005374void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005375{
5376 unsigned offset;
5377 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5378
5379 if( hs == NULL )
5380 return;
5381
Hanno Becker283f5ef2018-08-24 09:34:47 +01005382 ssl_free_buffered_record( ssl );
5383
Hanno Becker0271f962018-08-16 13:23:47 +01005384 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005385 ssl_buffering_free_slot( ssl, offset );
5386}
5387
5388static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5389 uint8_t slot )
5390{
5391 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5392 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005393
5394 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5395 return;
5396
Hanno Beckere605b192018-08-21 15:59:07 +01005397 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005398 {
Hanno Beckere605b192018-08-21 15:59:07 +01005399 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005400 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005401 mbedtls_free( hs_buf->data );
5402 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005403 }
5404}
5405
5406#endif /* MBEDTLS_SSL_PROTO_DTLS */
5407
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005408/*
5409 * Convert version numbers to/from wire format
5410 * and, for DTLS, to/from TLS equivalent.
5411 *
5412 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005413 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005414 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005417 unsigned char ver[2] )
5418{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005419#if defined(MBEDTLS_SSL_PROTO_DTLS)
5420 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005421 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005423 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5424
5425 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5426 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5427 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005428 else
5429#else
5430 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005431#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005432 {
5433 ver[0] = (unsigned char) major;
5434 ver[1] = (unsigned char) minor;
5435 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005436}
5437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005438void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005439 const unsigned char ver[2] )
5440{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441#if defined(MBEDTLS_SSL_PROTO_DTLS)
5442 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005443 {
5444 *major = 255 - ver[0] + 2;
5445 *minor = 255 - ver[1] + 1;
5446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005448 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5449 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005450 else
5451#else
5452 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005453#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005454 {
5455 *major = ver[0];
5456 *minor = ver[1];
5457 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005458}
5459
Jerry Yue7047812021-09-13 19:26:39 +08005460/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005461 * Send pending fatal alert.
5462 * 0, No alert message.
5463 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5464 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005465 */
5466int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5467{
5468 int ret;
5469
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005470 /* No pending alert, return success*/
5471 if( ssl->send_alert == 0 )
5472 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005473
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005474 ret = mbedtls_ssl_send_alert_message( ssl,
5475 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5476 ssl->alert_type );
5477
Jerry Yu3bf1f972021-09-22 21:37:18 +08005478 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5479 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005480 */
5481 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5482 {
5483 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005484 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005485
5486 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005487 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005488
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005489 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005490}
5491
Jerry Yu394ece62021-09-14 22:17:21 +08005492/*
5493 * Set pending fatal alert flag.
5494 */
5495void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5496 unsigned char alert_type,
5497 int alert_reason )
5498{
5499 ssl->send_alert = 1;
5500 ssl->alert_type = alert_type;
5501 ssl->alert_reason = alert_reason;
5502}
5503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005504#endif /* MBEDTLS_SSL_TLS_C */