blob: 286294f82826d1bcdf4d3e82c675a5443453661a [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
Hanno Beckerccc13d02020-05-04 12:30:04 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
297 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100298
299static size_t ssl_compute_padding_length( size_t len,
300 size_t granularity )
301{
302 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
303}
304
Hanno Becker581bc1b2020-05-04 12:20:03 +0100305/* This functions transforms a (D)TLS plaintext fragment and a record content
306 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
307 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
308 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100309 *
310 * struct {
311 * opaque content[DTLSPlaintext.length];
312 * ContentType real_type;
313 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100314 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100315 *
316 * Input:
317 * - `content`: The beginning of the buffer holding the
318 * plaintext to be wrapped.
319 * - `*content_size`: The length of the plaintext in Bytes.
320 * - `max_len`: The number of Bytes available starting from
321 * `content`. This must be `>= *content_size`.
322 * - `rec_type`: The desired record content type.
323 *
324 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100325 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
326 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100327 *
328 * Returns:
329 * - `0` on success.
330 * - A negative error code if `max_len` didn't offer enough space
331 * for the expansion.
332 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100333static int ssl_build_inner_plaintext( unsigned char *content,
334 size_t *content_size,
335 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100336 uint8_t rec_type,
337 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338{
339 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100340
341 /* Write real content type */
342 if( remaining == 0 )
343 return( -1 );
344 content[ len ] = rec_type;
345 len++;
346 remaining--;
347
348 if( remaining < pad )
349 return( -1 );
350 memset( content + len, 0, pad );
351 len += pad;
352 remaining -= pad;
353
354 *content_size = len;
355 return( 0 );
356}
357
Hanno Becker581bc1b2020-05-04 12:20:03 +0100358/* This function parses a (D)TLSInnerPlaintext structure.
359 * See ssl_build_inner_plaintext() for details. */
360static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361 size_t *content_size,
362 uint8_t *rec_type )
363{
364 size_t remaining = *content_size;
365
366 /* Determine length of padding by skipping zeroes from the back. */
367 do
368 {
369 if( remaining == 0 )
370 return( -1 );
371 remaining--;
372 } while( content[ remaining ] == 0 );
373
374 *content_size = remaining;
375 *rec_type = content[ remaining ];
376
377 return( 0 );
378}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100379#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
380 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100381
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100382/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100383 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000384static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100385 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100386 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000387 unsigned minor_ver,
388 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000389{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100390 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100391 *
392 * additional_data = seq_num + TLSCompressed.type +
393 * TLSCompressed.version + TLSCompressed.length;
394 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100395 * For the CID extension, this is extended as follows
396 * (quoting draft-ietf-tls-dtls-connection-id-05,
397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100398 *
399 * additional_data = seq_num + DTLSPlaintext.type +
400 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100401 * cid +
402 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100403 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100404 *
405 * For TLS 1.3, the record sequence number is dropped from the AAD
406 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000407 * Moreover, the additional data involves the length of the TLS
408 * ciphertext, not the TLS plaintext as in earlier versions.
409 * Quoting RFC 8446 (TLS 1.3):
410 *
411 * additional_data = TLSCiphertext.opaque_type ||
412 * TLSCiphertext.legacy_record_version ||
413 * TLSCiphertext.length
414 *
415 * We pass the tag length to this function in order to compute the
416 * ciphertext length from the inner plaintext length rec->data_len via
417 *
418 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
419 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 */
421
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000423 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100424
425#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000426 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
427 {
428 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
429 * which differs from the length of the TLSInnerPlaintext
430 * by the length of the authentication tag. */
431 ad_len_field += taglen;
432 }
433 else
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
435 {
436 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000437 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
Joe Subbiani6dd73642021-07-19 11:56:54 +0100457 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100458 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100459 }
460 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100461#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100462 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100463 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100465 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466
467 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000468}
469
Hanno Becker67a37db2020-05-28 16:27:07 +0100470#if defined(MBEDTLS_GCM_C) || \
471 defined(MBEDTLS_CCM_C) || \
472 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100473static int ssl_transform_aead_dynamic_iv_is_explicit(
474 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475{
Hanno Becker17263802020-05-28 07:05:48 +0100476 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100477}
478
Hanno Becker17263802020-05-28 07:05:48 +0100479/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
480 *
481 * Concretely, this occurs in two variants:
482 *
483 * a) Fixed and dynamic IV lengths add up to total IV length, giving
484 * IV = fixed_iv || dynamic_iv
485 *
Hanno Becker15952812020-06-04 13:31:46 +0100486 * This variant is used in TLS 1.2 when used with GCM or CCM.
487 *
Hanno Becker17263802020-05-28 07:05:48 +0100488 * b) Fixed IV lengths matches total IV length, giving
489 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100490 *
491 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
492 *
493 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100494 *
495 * This function has the precondition that
496 *
497 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
498 *
499 * which has to be ensured by the caller. If this precondition
500 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100501 */
502static void ssl_build_record_nonce( unsigned char *dst_iv,
503 size_t dst_iv_len,
504 unsigned char const *fixed_iv,
505 size_t fixed_iv_len,
506 unsigned char const *dynamic_iv,
507 size_t dynamic_iv_len )
508{
509 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100510
511 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100512 memset( dst_iv, 0, dst_iv_len );
513 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100514
Hanno Becker17263802020-05-28 07:05:48 +0100515 dst_iv += dst_iv_len - dynamic_iv_len;
516 for( i = 0; i < dynamic_iv_len; i++ )
517 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518}
Hanno Becker67a37db2020-05-28 16:27:07 +0100519#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100520
Hanno Beckera18d1322018-01-03 14:27:32 +0000521int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
522 mbedtls_ssl_transform *transform,
523 mbedtls_record *rec,
524 int (*f_rng)(void *, unsigned char *, size_t),
525 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000526{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
573 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
574
575 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
576 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
578 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000579 rec->data_len,
580 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
582 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100583
Hanno Becker92313402020-05-20 13:58:58 +0100584 /* The following two code paths implement the (D)TLSInnerPlaintext
585 * structure present in TLS 1.3 and DTLS 1.2 + CID.
586 *
587 * See ssl_build_inner_plaintext() for more information.
588 *
589 * Note that this changes `rec->data_len`, and hence
590 * `post_avail` needs to be recalculated afterwards.
591 *
592 * Note also that the two code paths cannot occur simultaneously
593 * since they apply to different versions of the protocol. There
594 * is hence no risk of double-addition of the inner plaintext.
595 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100596#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
597 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
598 {
Hanno Becker13996922020-05-28 16:15:19 +0100599 size_t padding =
600 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200601 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100602 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100603 &rec->data_len,
604 post_avail,
605 rec->type,
606 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100607 {
608 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
609 }
610
611 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
612 }
613#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
614
Hanno Beckera0e20d02019-05-15 14:03:01 +0100615#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100616 /*
617 * Add CID information
618 */
619 rec->cid_len = transform->out_cid_len;
620 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
621 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622
623 if( rec->cid_len != 0 )
624 {
Hanno Becker13996922020-05-28 16:15:19 +0100625 size_t padding =
626 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200627 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100628 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100629 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100630 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100631 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100632 * Note that this changes `rec->data_len`, and hence
633 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100634 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100635 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 &rec->data_len,
637 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100638 rec->type,
639 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100640 {
641 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
642 }
643
644 rec->type = MBEDTLS_SSL_MSG_CID;
645 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100647
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100648 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
649
Paul Bakker5121ce52009-01-03 21:22:43 +0000650 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100651 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000653#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 if( mode == MBEDTLS_MODE_STREAM ||
655 ( mode == MBEDTLS_MODE_CBC
656#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100658#endif
659 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000660 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 if( post_avail < transform->maclen )
662 {
663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
664 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
665 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200667 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000668
TRodziewicz345165c2021-07-06 13:42:11 +0200669 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000670 transform->minor_ver,
671 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000672
TRodziewicz345165c2021-07-06 13:42:11 +0200673 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
674 add_data_len );
675 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
676 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
677 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000678
TRodziewicz345165c2021-07-06 13:42:11 +0200679 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200680#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
683 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200684
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000685 rec->data_len += transform->maclen;
686 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100687 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200688 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000689#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000690
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200691 /*
692 * Encrypt
693 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000694#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000696 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000699 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000700 "including %d bytes of padding",
701 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000702
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000703 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
704 transform->iv_enc, transform->ivlen,
705 data, rec->data_len,
706 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200709 return( ret );
710 }
711
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000712 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
715 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200716 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000717 }
Paul Bakker68884e32013-01-07 18:20:04 +0100718 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000719#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000720
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200721#if defined(MBEDTLS_GCM_C) || \
722 defined(MBEDTLS_CCM_C) || \
723 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200725 mode == MBEDTLS_MODE_CCM ||
726 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000727 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200729 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100730 unsigned char *dynamic_iv;
731 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100732 int dynamic_iv_is_explicit =
733 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000734
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100735 /* Check that there's space for the authentication tag. */
736 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000737 {
738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
739 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
740 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000741
Paul Bakker68884e32013-01-07 18:20:04 +0100742 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100743 * Build nonce for AEAD encryption.
744 *
745 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
746 * part of the IV is prepended to the ciphertext and
747 * can be chosen freely - in particular, it need not
748 * agree with the record sequence number.
749 * However, since ChaChaPoly as well as all AEAD modes
750 * in TLS 1.3 use the record sequence number as the
751 * dynamic part of the nonce, we uniformly use the
752 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100753 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100754 dynamic_iv = rec->ctr;
755 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200756
Hanno Becker17263802020-05-28 07:05:48 +0100757 ssl_build_record_nonce( iv, sizeof( iv ),
758 transform->iv_enc,
759 transform->fixed_ivlen,
760 dynamic_iv,
761 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100762
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100763 /*
764 * Build additional data for AEAD encryption.
765 * This depends on the TLS version.
766 */
767 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000768 transform->minor_ver,
769 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100770
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200771 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100772 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200773 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100774 dynamic_iv,
775 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000776 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100777 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000778 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200779 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000780 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000781
Paul Bakker68884e32013-01-07 18:20:04 +0100782 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200783 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200784 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000785
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100786 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000787 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100788 add_data, add_data_len,
789 data, rec->data_len, /* src */
790 data, rec->buf_len - (data - rec->buf), /* dst */
791 &rec->data_len,
792 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200793 {
TRodziewicz18efb732021-04-29 23:12:19 +0200794 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200795 return( ret );
796 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000797 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100798 data + rec->data_len - transform->taglen,
799 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100800 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000801 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100802
803 /*
804 * Prefix record content with dynamic IV in case it is explicit.
805 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100806 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100807 {
808 if( rec->data_offset < dynamic_iv_len )
809 {
810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
811 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
812 }
813
814 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
815 rec->data_offset -= dynamic_iv_len;
816 rec->data_len += dynamic_iv_len;
817 }
818
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100819 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000820 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100822#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200823#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000825 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000827 size_t padlen, i;
828 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000829
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000830 /* Currently we're always using minimal padding
831 * (up to 255 bytes would be allowed). */
832 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
833 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000834 padlen = 0;
835
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000836 /* Check there's enough space in the buffer for the padding. */
837 if( post_avail < padlen + 1 )
838 {
839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
840 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
841 }
842
Paul Bakker5121ce52009-01-03 21:22:43 +0000843 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000845
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 rec->data_len += padlen + 1;
847 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000848
TRodziewicz0f82ec62021-05-12 17:49:18 +0200849#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000850 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200851 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000852 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000853 */
TRodziewicz345165c2021-07-06 13:42:11 +0200854 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000855 {
TRodziewicz345165c2021-07-06 13:42:11 +0200856 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
857 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000858 }
TRodziewicz345165c2021-07-06 13:42:11 +0200859
860 if( rec->data_offset < transform->ivlen )
861 {
862 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
863 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
864 }
865
866 /*
867 * Generate IV
868 */
869 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
870 if( ret != 0 )
871 return( ret );
872
873 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200874#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000875
Paul Elliottd48d5c62021-01-07 14:47:05 +0000876 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
877 "including %" MBEDTLS_PRINTF_SIZET
878 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000879 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200880 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000881
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000882 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
883 transform->iv_enc,
884 transform->ivlen,
885 data, rec->data_len,
886 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200889 return( ret );
890 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200891
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000892 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200893 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
895 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200896 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200897
TRodziewicz0f82ec62021-05-12 17:49:18 +0200898 data -= transform->ivlen;
899 rec->data_offset -= transform->ivlen;
900 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100903 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100904 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000905 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
906
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100907 /*
908 * MAC(MAC_write_key, seq_num +
909 * TLSCipherText.type +
910 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100911 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200912 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100913 * ENC(content + padding + padding_length));
914 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000915
916 if( post_avail < transform->maclen)
917 {
918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
919 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
920 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100921
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100922 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000923 rec, transform->minor_ver,
924 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000927 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100928 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100929
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000930 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100931 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 mbedtls_md_hmac_update( &transform->md_ctx_enc,
933 data, rec->data_len );
934 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
935 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100936
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100938
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000939 rec->data_len += transform->maclen;
940 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100941 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100942 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000944 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200945 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200946#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200947 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
949 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200950 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000951
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100952 /* Make extra sure authentication was performed, exactly once */
953 if( auth_done != 1 )
954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
956 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100957 }
958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000960
961 return( 0 );
962}
963
Hanno Becker605949f2019-07-12 08:23:59 +0100964int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +0000965 mbedtls_ssl_transform *transform,
966 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +0000967{
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000968 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000970 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000971#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +0100972 size_t padlen = 0, correct = 1;
973#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000974 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100975 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100976 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000977
Hanno Beckera18d1322018-01-03 14:27:32 +0000978#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200979 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000980 ((void) ssl);
981#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000984 if( rec == NULL ||
985 rec->buf == NULL ||
986 rec->buf_len < rec->data_offset ||
987 rec->buf_len - rec->data_offset < rec->data_len )
988 {
989 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100991 }
992
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000993 data = rec->buf + rec->data_offset;
994 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +0000995
Hanno Beckera0e20d02019-05-15 14:03:01 +0100996#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100997 /*
998 * Match record's CID with incoming CID.
999 */
Hanno Becker938489a2019-05-08 13:02:22 +01001000 if( rec->cid_len != transform->in_cid_len ||
1001 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1002 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001003 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001004 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001005#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001006
Hanno Beckerd086bf02021-03-22 13:01:27 +00001007#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001009 {
1010 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001011 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1012 transform->iv_dec,
1013 transform->ivlen,
1014 data, rec->data_len,
1015 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001016 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001018 return( ret );
1019 }
1020
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001021 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001022 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1024 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001025 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 }
Paul Bakker68884e32013-01-07 18:20:04 +01001027 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001028#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001029#if defined(MBEDTLS_GCM_C) || \
1030 defined(MBEDTLS_CCM_C) || \
1031 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001033 mode == MBEDTLS_MODE_CCM ||
1034 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001035 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001036 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001037 unsigned char *dynamic_iv;
1038 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001039
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001040 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001041 * Extract dynamic part of nonce for AEAD decryption.
1042 *
1043 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1044 * part of the IV is prepended to the ciphertext and
1045 * can be chosen freely - in particular, it need not
1046 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001047 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001048 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001049 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001050 {
1051 if( rec->data_len < dynamic_iv_len )
1052 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001053 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1054 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001055 rec->data_len,
1056 dynamic_iv_len ) );
1057 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1058 }
1059 dynamic_iv = data;
1060
1061 data += dynamic_iv_len;
1062 rec->data_offset += dynamic_iv_len;
1063 rec->data_len -= dynamic_iv_len;
1064 }
Hanno Becker17263802020-05-28 07:05:48 +01001065 else
1066 {
1067 dynamic_iv = rec->ctr;
1068 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001069
1070 /* Check that there's space for the authentication tag. */
1071 if( rec->data_len < transform->taglen )
1072 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001073 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1074 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001075 rec->data_len,
1076 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001078 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001079 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001080
Hanno Beckerdf8be222020-05-21 15:30:57 +01001081 /*
1082 * Prepare nonce from dynamic and static parts.
1083 */
Hanno Becker17263802020-05-28 07:05:48 +01001084 ssl_build_record_nonce( iv, sizeof( iv ),
1085 transform->iv_dec,
1086 transform->fixed_ivlen,
1087 dynamic_iv,
1088 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001089
Hanno Beckerdf8be222020-05-21 15:30:57 +01001090 /*
1091 * Build additional data for AEAD encryption.
1092 * This depends on the TLS version.
1093 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001094 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001095 transform->minor_ver,
1096 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001097 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001098 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001099
Hanno Beckerd96a6522019-07-10 13:55:25 +01001100 /* Because of the check above, we know that there are
1101 * explicit_iv_len Bytes preceeding data, and taglen
1102 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001103 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001104 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001105
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001106 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001107 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001108 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001109
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001110 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001111 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001112 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001113 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001114 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001115 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001116 data, rec->data_len + transform->taglen, /* src */
1117 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001118 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001119 {
TRodziewicz18efb732021-04-29 23:12:19 +02001120 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1123 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001124
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001125 return( ret );
1126 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001127 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001128
Hanno Beckerd96a6522019-07-10 13:55:25 +01001129 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001130 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001131 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1133 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001134 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001135 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001136 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001138#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001140 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001141 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001142
Paul Bakker5121ce52009-01-03 21:22:43 +00001143 /*
Paul Bakker45829992013-01-03 14:52:21 +01001144 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001145 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001146#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001147 /* The ciphertext is prefixed with the CBC IV. */
1148 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001149#endif
Paul Bakker45829992013-01-03 14:52:21 +01001150
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001151 /* Size considerations:
1152 *
1153 * - The CBC cipher text must not be empty and hence
1154 * at least of size transform->ivlen.
1155 *
1156 * Together with the potential IV-prefix, this explains
1157 * the first of the two checks below.
1158 *
1159 * - The record must contain a MAC, either in plain or
1160 * encrypted, depending on whether Encrypt-then-MAC
1161 * is used or not.
1162 * - If it is, the message contains the IV-prefix,
1163 * the CBC ciphertext, and the MAC.
1164 * - If it is not, the padded plaintext, and hence
1165 * the CBC ciphertext, has at least length maclen + 1
1166 * because there is at least the padding length byte.
1167 *
1168 * As the CBC ciphertext is not empty, both cases give the
1169 * lower bound minlen + maclen + 1 on the record size, which
1170 * we test for in the second check below.
1171 */
1172 if( rec->data_len < minlen + transform->ivlen ||
1173 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001174 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001175 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1176 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1177 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001178 "+ 1 ) ( + expl IV )", rec->data_len,
1179 transform->ivlen,
1180 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001182 }
1183
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001184 /*
1185 * Authenticate before decrypt if enabled
1186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001188 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001189 {
Hanno Becker992b6872017-11-09 18:57:39 +00001190 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001193
Hanno Beckerd96a6522019-07-10 13:55:25 +01001194 /* Update data_len in tandem with add_data.
1195 *
1196 * The subtraction is safe because of the previous check
1197 * data_len >= minlen + maclen + 1.
1198 *
1199 * Afterwards, we know that data + data_len is followed by at
1200 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001201 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001202 *
1203 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001204 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001205 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001206 transform->minor_ver,
1207 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001208
Hanno Beckerd96a6522019-07-10 13:55:25 +01001209 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001210 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1211 add_data_len );
1212 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1213 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001214 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1215 data, rec->data_len );
1216 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1217 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001218
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001219 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1220 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001221 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001222 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001223
Hanno Beckerd96a6522019-07-10 13:55:25 +01001224 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001225 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001226 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001227 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001228 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001230 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001231 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001232 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001234
1235 /*
1236 * Check length sanity
1237 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001238
1239 /* We know from above that data_len > minlen >= 0,
1240 * so the following check in particular implies that
1241 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001242 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001243 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001244 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1245 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001246 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001248 }
1249
TRodziewicz0f82ec62021-05-12 17:49:18 +02001250#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001251 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001252 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001253 */
TRodziewicz345165c2021-07-06 13:42:11 +02001254 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1255 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001256
TRodziewicz345165c2021-07-06 13:42:11 +02001257 data += transform->ivlen;
1258 rec->data_offset += transform->ivlen;
1259 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001260#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001261
Hanno Beckerd96a6522019-07-10 13:55:25 +01001262 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1263
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001264 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1265 transform->iv_dec, transform->ivlen,
1266 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001267 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001269 return( ret );
1270 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001271
Hanno Beckerd96a6522019-07-10 13:55:25 +01001272 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001273 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001274 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1276 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001277 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001278
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001279 /* Safe since data_len >= minlen + maclen + 1, so after having
1280 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001281 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1282 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001283 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001284
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001285 if( auth_done == 1 )
1286 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001287 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001288 rec->data_len,
1289 padlen + 1 );
1290 correct &= mask;
1291 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001292 }
1293 else
Paul Bakker45829992013-01-03 14:52:21 +01001294 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001296 if( rec->data_len < transform->maclen + padlen + 1 )
1297 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001298 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1299 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1300 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001301 rec->data_len,
1302 transform->maclen,
1303 padlen + 1 ) );
1304 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001305#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001306
Gabor Mezei90437e32021-10-20 11:59:27 +02001307 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001308 rec->data_len,
1309 transform->maclen + padlen + 1 );
1310 correct &= mask;
1311 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001312 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001313
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001314 padlen++;
1315
1316 /* Regardless of the validity of the padding,
1317 * we have data_len >= padlen here. */
1318
TRodziewicz0f82ec62021-05-12 17:49:18 +02001319#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001320 /* The padding check involves a series of up to 256
1321 * consecutive memory reads at the end of the record
1322 * plaintext buffer. In order to hide the length and
1323 * validity of the padding, always perform exactly
1324 * `min(256,plaintext_len)` reads (but take into account
1325 * only the last `padlen` bytes for the padding check). */
1326 size_t pad_count = 0;
1327 volatile unsigned char* const check = data;
1328
1329 /* Index of first padding byte; it has been ensured above
1330 * that the subtraction is safe. */
1331 size_t const padding_idx = rec->data_len - padlen;
1332 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1333 size_t const start_idx = rec->data_len - num_checks;
1334 size_t idx;
1335
1336 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001337 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001338 /* pad_count += (idx >= padding_idx) &&
1339 * (check[idx] == padlen - 1);
1340 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001341 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1342 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001343 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001344 pad_count += mask & equal;
1345 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001346 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001349 if( padlen > 0 && correct == 0 )
1350 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001351#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001352 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001353
TRodziewicz0f82ec62021-05-12 17:49:18 +02001354#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001355
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001356 /* If the padding was found to be invalid, padlen == 0
1357 * and the subtraction is safe. If the padding was found valid,
1358 * padlen hasn't been changed and the previous assertion
1359 * data_len >= padlen still holds. */
1360 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001361 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001362 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001363#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001364 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001365 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1366 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001367 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001368
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001369#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001371 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001372#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001373
1374 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001375 * Authenticate if not done yet.
1376 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001377 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001378#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001379 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001380 {
Hanno Becker992b6872017-11-09 18:57:39 +00001381 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001382 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001383
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001384 /* If the initial value of padlen was such that
1385 * data_len < maclen + padlen + 1, then padlen
1386 * got reset to 1, and the initial check
1387 * data_len >= minlen + maclen + 1
1388 * guarantees that at this point we still
1389 * have at least data_len >= maclen.
1390 *
1391 * If the initial value of padlen was such that
1392 * data_len >= maclen + padlen + 1, then we have
1393 * subtracted either padlen + 1 (if the padding was correct)
1394 * or 0 (if the padding was incorrect) since then,
1395 * hence data_len >= maclen in any case.
1396 */
1397 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001398 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001399 transform->minor_ver,
1400 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001401
TRodziewicz0f82ec62021-05-12 17:49:18 +02001402#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001403 /*
1404 * The next two sizes are the minimum and maximum values of
1405 * data_len over all padlen values.
1406 *
1407 * They're independent of padlen, since we previously did
1408 * data_len -= padlen.
1409 *
1410 * Note that max_len + maclen is never more than the buffer
1411 * length, as we previously did in_msglen -= maclen too.
1412 */
1413 const size_t max_len = rec->data_len + padlen;
1414 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1415
Gabor Mezei90437e32021-10-20 11:59:27 +02001416 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001417 add_data, add_data_len,
1418 data, rec->data_len, min_len, max_len,
1419 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001420 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001421 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001422 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001423 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001424 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001425
Gabor Mezei90437e32021-10-20 11:59:27 +02001426 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001427 rec->data_len,
1428 min_len, max_len,
1429 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001430#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001431
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001432#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001433 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001434 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001435#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001436
Gabor Mezei90437e32021-10-20 11:59:27 +02001437 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001438 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001440#if defined(MBEDTLS_SSL_DEBUG_ALL)
1441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001442#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001443 correct = 0;
1444 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001445 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001446 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001447
1448 /*
1449 * Finally check the correct flag
1450 */
1451 if( correct == 0 )
1452 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001453#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001454
1455 /* Make extra sure authentication was performed, exactly once */
1456 if( auth_done != 1 )
1457 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1459 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001460 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001461
Hanno Beckerccc13d02020-05-04 12:30:04 +01001462#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1463 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1464 {
1465 /* Remove inner padding and infer true content type. */
1466 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1467 &rec->type );
1468
1469 if( ret != 0 )
1470 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1471 }
1472#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1473
Hanno Beckera0e20d02019-05-15 14:03:01 +01001474#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001475 if( rec->cid_len != 0 )
1476 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001477 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1478 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001479 if( ret != 0 )
1480 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1481 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001482#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001485
1486 return( 0 );
1487}
1488
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001489#undef MAC_NONE
1490#undef MAC_PLAINTEXT
1491#undef MAC_CIPHERTEXT
1492
Paul Bakker5121ce52009-01-03 21:22:43 +00001493/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001494 * Fill the input message buffer by appending data to it.
1495 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001496 *
1497 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1498 * available (from this read and/or a previous one). Otherwise, an error code
1499 * is returned (possibly EOF or WANT_READ).
1500 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001501 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1502 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1503 * since we always read a whole datagram at once.
1504 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001505 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001506 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001509{
Janos Follath865b3eb2019-12-16 11:46:15 +00001510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001511 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001512#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1513 size_t in_buf_len = ssl->in_buf_len;
1514#else
1515 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1516#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001517
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001518 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001519
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001520 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1521 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001523 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001525 }
1526
Darryl Greenb33cc762019-11-28 14:29:44 +00001527 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001528 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001529 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1530 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001531 }
1532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001534 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001535 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001536 uint32_t timeout;
1537
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001538 /*
1539 * The point is, we need to always read a full datagram at once, so we
1540 * sometimes read more then requested, and handle the additional data.
1541 * It could be the rest of the current record (while fetching the
1542 * header) and/or some other records in the same datagram.
1543 */
1544
1545 /*
1546 * Move to the next record in the already read datagram if applicable
1547 */
1548 if( ssl->next_record_offset != 0 )
1549 {
1550 if( ssl->in_left < ssl->next_record_offset )
1551 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001554 }
1555
1556 ssl->in_left -= ssl->next_record_offset;
1557
1558 if( ssl->in_left != 0 )
1559 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001560 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1561 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001562 ssl->next_record_offset ) );
1563 memmove( ssl->in_hdr,
1564 ssl->in_hdr + ssl->next_record_offset,
1565 ssl->in_left );
1566 }
1567
1568 ssl->next_record_offset = 0;
1569 }
1570
Paul Elliottd48d5c62021-01-07 14:47:05 +00001571 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1572 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001573 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001574
1575 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001576 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001577 */
1578 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001579 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001581 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001582 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001583
1584 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001585 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001586 * are not at the beginning of a new record, the caller did something
1587 * wrong.
1588 */
1589 if( ssl->in_left != 0 )
1590 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1592 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001593 }
1594
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001595 /*
1596 * Don't even try to read if time's out already.
1597 * This avoids by-passing the timer when repeatedly receiving messages
1598 * that will end up being dropped.
1599 */
Hanno Becker7876d122020-02-05 10:39:31 +00001600 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001601 {
1602 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001603 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001604 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001605 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001606 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001607 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001610 timeout = ssl->handshake->retransmit_timeout;
1611 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001612 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001613
Paul Elliott9f352112020-12-09 14:55:45 +00001614 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001615
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001616 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001617 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1618 timeout );
1619 else
1620 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001623
1624 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001626 }
1627
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001628 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001629 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001630 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001631 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001634 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001635 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001638 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001639 }
1640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001642 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001644 return( ret );
1645 }
1646
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001647 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001648 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001650 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001652 {
Hanno Becker786300f2020-02-05 10:46:40 +00001653 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001654 {
Hanno Becker786300f2020-02-05 10:46:40 +00001655 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1656 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001657 return( ret );
1658 }
1659
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001660 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001661 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001663 }
1664
Paul Bakker5121ce52009-01-03 21:22:43 +00001665 if( ret < 0 )
1666 return( ret );
1667
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001668 ssl->in_left = ret;
1669 }
1670 else
1671#endif
1672 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001673 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1674 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001675 ssl->in_left, nb_want ) );
1676
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001677 while( ssl->in_left < nb_want )
1678 {
1679 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001680
Hanno Becker7876d122020-02-05 10:39:31 +00001681 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001682 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1683 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001684 {
1685 if( ssl->f_recv_timeout != NULL )
1686 {
1687 ret = ssl->f_recv_timeout( ssl->p_bio,
1688 ssl->in_hdr + ssl->in_left, len,
1689 ssl->conf->read_timeout );
1690 }
1691 else
1692 {
1693 ret = ssl->f_recv( ssl->p_bio,
1694 ssl->in_hdr + ssl->in_left, len );
1695 }
1696 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001697
Paul Elliottd48d5c62021-01-07 14:47:05 +00001698 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1699 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001700 ssl->in_left, nb_want ) );
1701 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001702
1703 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001705
1706 if( ret < 0 )
1707 return( ret );
1708
makise-homuraaf9513b2020-08-24 18:26:27 +03001709 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001710 {
Darryl Green11999bb2018-03-13 15:22:58 +00001711 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001712 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001713 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001714 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1715 }
1716
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001717 ssl->in_left += ret;
1718 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001719 }
1720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001722
1723 return( 0 );
1724}
1725
1726/*
1727 * Flush any data not yet written
1728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Janos Follath865b3eb2019-12-16 11:46:15 +00001731 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001732 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001735
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001736 if( ssl->f_send == NULL )
1737 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001739 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001740 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001741 }
1742
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001743 /* Avoid incrementing counter if data is flushed */
1744 if( ssl->out_left == 0 )
1745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001747 return( 0 );
1748 }
1749
Paul Bakker5121ce52009-01-03 21:22:43 +00001750 while( ssl->out_left > 0 )
1751 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001752 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1753 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001754 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001755
Hanno Becker2b1e3542018-08-06 11:19:13 +01001756 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001757 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001758
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001760
1761 if( ret <= 0 )
1762 return( ret );
1763
makise-homuraaf9513b2020-08-24 18:26:27 +03001764 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001765 {
Darryl Green11999bb2018-03-13 15:22:58 +00001766 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001767 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001768 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001769 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1770 }
1771
Paul Bakker5121ce52009-01-03 21:22:43 +00001772 ssl->out_left -= ret;
1773 }
1774
Hanno Becker2b1e3542018-08-06 11:19:13 +01001775#if defined(MBEDTLS_SSL_PROTO_DTLS)
1776 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001777 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001778 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001779 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001780 else
1781#endif
1782 {
1783 ssl->out_hdr = ssl->out_buf + 8;
1784 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001785 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001786
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001788
1789 return( 0 );
1790}
1791
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001792/*
1793 * Functions to handle the DTLS retransmission state machine
1794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001796/*
1797 * Append current handshake message to current outgoing flight
1798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001800{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1803 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1804 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001805
1806 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001807 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001808 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001809 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001811 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001812 }
1813
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001814 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001815 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001816 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1817 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001819 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001820 }
1821
1822 /* Copy current handshake message with headers */
1823 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1824 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001825 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001826 msg->next = NULL;
1827
1828 /* Append to the current flight */
1829 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001830 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001831 else
1832 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001834 while( cur->next != NULL )
1835 cur = cur->next;
1836 cur->next = msg;
1837 }
1838
Hanno Becker3b235902018-08-06 09:54:53 +01001839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001840 return( 0 );
1841}
1842
1843/*
1844 * Free the current flight of handshake messages
1845 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001846void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001847{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848 mbedtls_ssl_flight_item *cur = flight;
1849 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001850
1851 while( cur != NULL )
1852 {
1853 next = cur->next;
1854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001855 mbedtls_free( cur->p );
1856 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001857
1858 cur = next;
1859 }
1860}
1861
1862/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001863 * Swap transform_out and out_ctr with the alternative ones
1864 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001865static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001866{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001867 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08001868 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001869
1870 if( ssl->transform_out == ssl->handshake->alt_transform_out )
1871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001873 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001874 }
1875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001877
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001878 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001879 tmp_transform = ssl->transform_out;
1880 ssl->transform_out = ssl->handshake->alt_transform_out;
1881 ssl->handshake->alt_transform_out = tmp_transform;
1882
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001883 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08001884 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
1885 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
1886 sizeof( ssl->cur_out_ctr ) );
1887 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
1888 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001889
1890 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001891 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001892
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001893 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001894}
1895
1896/*
1897 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001898 */
1899int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
1900{
1901 int ret = 0;
1902
1903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
1904
1905 ret = mbedtls_ssl_flight_transmit( ssl );
1906
1907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
1908
1909 return( ret );
1910}
1911
1912/*
1913 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001914 *
1915 * Need to remember the current message in case flush_output returns
1916 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001917 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001918 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001919int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001920{
Janos Follath865b3eb2019-12-16 11:46:15 +00001921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001922 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001925 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001927
1928 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001929 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001930 ret = ssl_swap_epochs( ssl );
1931 if( ret != 0 )
1932 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001935 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001936
1937 while( ssl->handshake->cur_msg != NULL )
1938 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001939 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001940 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001941
Hanno Beckere1dcb032018-08-17 16:47:58 +01001942 int const is_finished =
1943 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
1944 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
1945
Hanno Becker04da1892018-08-14 13:22:10 +01001946 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
1947 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
1948
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001949 /* Swap epochs before sending Finished: we can't do it after
1950 * sending ChangeCipherSpec, in case write returns WANT_READ.
1951 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01001952 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001953 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001954 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001955 ret = ssl_swap_epochs( ssl );
1956 if( ret != 0 )
1957 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001958 }
1959
Hanno Becker67bc7c32018-08-06 11:33:50 +01001960 ret = ssl_get_remaining_payload_in_datagram( ssl );
1961 if( ret < 0 )
1962 return( ret );
1963 max_frag_len = (size_t) ret;
1964
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001965 /* CCS is copied as is, while HS messages may need fragmentation */
1966 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
1967 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001968 if( max_frag_len == 0 )
1969 {
1970 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
1971 return( ret );
1972
1973 continue;
1974 }
1975
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001976 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01001977 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001978 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001979
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001980 /* Update position inside current message */
1981 ssl->handshake->cur_msg_p += cur->len;
1982 }
1983 else
1984 {
1985 const unsigned char * const p = ssl->handshake->cur_msg_p;
1986 const size_t hs_len = cur->len - 12;
1987 const size_t frag_off = p - ( cur->p + 12 );
1988 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001989 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001990
Hanno Beckere1dcb032018-08-17 16:47:58 +01001991 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02001992 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01001993 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001994 {
1995 ret = ssl_swap_epochs( ssl );
1996 if( ret != 0 )
1997 return( ret );
1998 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001999
Hanno Becker67bc7c32018-08-06 11:33:50 +01002000 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2001 return( ret );
2002
2003 continue;
2004 }
2005 max_hs_frag_len = max_frag_len - 12;
2006
2007 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2008 max_hs_frag_len : rem_len;
2009
2010 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002011 {
2012 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002013 (unsigned) cur_hs_frag_len,
2014 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002015 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002016
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002017 /* Messages are stored with handshake headers as if not fragmented,
2018 * copy beginning of headers then fill fragmentation fields.
2019 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2020 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002021
Joe Subbiani5ecac212021-06-24 13:00:03 +01002022 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2023 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2024 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002025
Joe Subbiani5ecac212021-06-24 13:00:03 +01002026 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2027 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2028 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002029
2030 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2031
Hanno Becker3f7b9732018-08-28 09:53:25 +01002032 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002033 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2034 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002035 ssl->out_msgtype = cur->type;
2036
2037 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002038 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002039 }
2040
2041 /* If done with the current message move to the next one if any */
2042 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2043 {
2044 if( cur->next != NULL )
2045 {
2046 ssl->handshake->cur_msg = cur->next;
2047 ssl->handshake->cur_msg_p = cur->next->p + 12;
2048 }
2049 else
2050 {
2051 ssl->handshake->cur_msg = NULL;
2052 ssl->handshake->cur_msg_p = NULL;
2053 }
2054 }
2055
2056 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002057 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002058 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002059 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002060 return( ret );
2061 }
2062 }
2063
Hanno Becker67bc7c32018-08-06 11:33:50 +01002064 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2065 return( ret );
2066
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002067 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2069 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002070 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002071 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002073 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002074 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002075
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002076 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002077
2078 return( 0 );
2079}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002080
2081/*
2082 * To be called when the last message of an incoming flight is received.
2083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002085{
2086 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002087 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002088 ssl->handshake->flight = NULL;
2089 ssl->handshake->cur_msg = NULL;
2090
2091 /* The next incoming flight will start with this msg_seq */
2092 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2093
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002094 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002095 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002096
Hanno Becker0271f962018-08-16 13:23:47 +01002097 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002098 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002099
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002100 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002101 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2104 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002105 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002106 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002107 }
2108 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002110}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002111
2112/*
2113 * To be called when the last message of an outgoing flight is send.
2114 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002115void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002116{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002117 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002118 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2121 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002122 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002124 }
2125 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002127}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002129
Paul Bakker5121ce52009-01-03 21:22:43 +00002130/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002131 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002132 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002133
2134/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002135 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002136 *
2137 * - fill in handshake headers
2138 * - update handshake checksum
2139 * - DTLS: save message for resending
2140 * - then pass to the record layer
2141 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002142 * DTLS: except for HelloRequest, messages are only queued, and will only be
2143 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002144 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002145 * Inputs:
2146 * - ssl->out_msglen: 4 + actual handshake message len
2147 * (4 is the size of handshake headers for TLS)
2148 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2149 * - ssl->out_msg + 4: the handshake message body
2150 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002151 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002152 * - ssl->out_msglen: the length of the record contents
2153 * (including handshake headers but excluding record headers)
2154 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002155 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002156int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2157 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002158{
Janos Follath865b3eb2019-12-16 11:46:15 +00002159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002160 const size_t hs_len = ssl->out_msglen - 4;
2161 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002162
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002163 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2164
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002165 /*
2166 * Sanity checks
2167 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002168 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002169 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2170 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002171 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2172 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002173 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002174
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002175 /* Whenever we send anything different from a
2176 * HelloRequest we should be in a handshake - double check. */
2177 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2178 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002179 ssl->handshake == NULL )
2180 {
2181 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2182 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2183 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002186 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002187 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002189 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2191 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002192 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002194
Hanno Beckerb50a2532018-08-06 11:52:54 +01002195 /* Double-check that we did not exceed the bounds
2196 * of the outgoing record buffer.
2197 * This should never fail as the various message
2198 * writing functions must obey the bounds of the
2199 * outgoing record buffer, but better be safe.
2200 *
2201 * Note: We deliberately do not check for the MTU or MFL here.
2202 */
2203 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2204 {
2205 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002206 "size %" MBEDTLS_PRINTF_SIZET
2207 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002208 ssl->out_msglen,
2209 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002210 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2211 }
2212
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002213 /*
2214 * Fill handshake headers
2215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002217 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002218 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2219 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2220 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002221
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002222 /*
2223 * DTLS has additional fields in the Handshake layer,
2224 * between the length field and the actual payload:
2225 * uint16 message_seq;
2226 * uint24 fragment_offset;
2227 * uint24 fragment_length;
2228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002230 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002231 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002232 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002233 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002234 {
2235 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002236 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002237 hs_len,
2238 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002239 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2240 }
2241
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002242 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002243 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002244
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002245 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002246 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002247 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002248 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002249 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002250 }
2251 else
2252 {
2253 ssl->out_msg[4] = 0;
2254 ssl->out_msg[5] = 0;
2255 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002256
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002257 /* Handshake hashes are computed without fragmentation,
2258 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002259 memset( ssl->out_msg + 6, 0x00, 3 );
2260 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002261 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002263
Hanno Becker0207e532018-08-28 10:28:28 +01002264 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002265 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002266 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002267 }
2268
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002269 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002271 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002272 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2273 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002274 {
2275 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2276 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002278 return( ret );
2279 }
2280 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002281 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002282#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002283 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002284 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002285 {
2286 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2287 return( ret );
2288 }
2289 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002290
2291 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2292
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002293 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002294}
2295
2296/*
2297 * Record layer functions
2298 */
2299
2300/*
2301 * Write current record.
2302 *
2303 * Uses:
2304 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2305 * - ssl->out_msglen: length of the record content (excl headers)
2306 * - ssl->out_msg: record content
2307 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002308int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002309{
2310 int ret, done = 0;
2311 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002312 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002313
2314 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002315
Paul Bakker05ef8352012-05-08 09:17:57 +00002316 if( !done )
2317 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002318 unsigned i;
2319 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002320#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2321 size_t out_buf_len = ssl->out_buf_len;
2322#else
2323 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2324#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002325 /* Skip writing the record content type to after the encryption,
2326 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002327 int minor_ver = ssl->minor_ver;
2328#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002329 /* TLS 1.3 still uses the TLS 1.2 version identifier
2330 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002331 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2332 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
2333#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
2334 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2335 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002336
Jerry Yuae0b2e22021-10-08 15:21:19 +08002337 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002338 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002339
Paul Bakker48916f92012-09-16 19:57:18 +00002340 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002341 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002342 mbedtls_record rec;
2343
2344 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002345 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002346 rec.data_len = ssl->out_msglen;
2347 rec.data_offset = ssl->out_msg - rec.buf;
2348
Jerry Yud96a5c22021-09-29 17:46:51 +08002349 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002350 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002351 ssl->conf->transport, rec.ver );
2352 rec.type = ssl->out_msgtype;
2353
Hanno Beckera0e20d02019-05-15 14:03:01 +01002354#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002355 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002356 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002357#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002358
Hanno Beckera18d1322018-01-03 14:27:32 +00002359 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002360 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002361 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002363 return( ret );
2364 }
2365
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002366 if( rec.data_offset != 0 )
2367 {
2368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2369 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2370 }
2371
Hanno Becker6430faf2019-05-08 11:57:13 +01002372 /* Update the record content type and CID. */
2373 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002374#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002375 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002376#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002377 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002378 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002379 }
2380
Hanno Becker5903de42019-05-03 14:46:38 +01002381 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002382
2383#if defined(MBEDTLS_SSL_PROTO_DTLS)
2384 /* In case of DTLS, double-check that we don't exceed
2385 * the remaining space in the datagram. */
2386 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2387 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002388 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002389 if( ret < 0 )
2390 return( ret );
2391
2392 if( protected_record_size > (size_t) ret )
2393 {
2394 /* Should never happen */
2395 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2396 }
2397 }
2398#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002399
Hanno Becker6430faf2019-05-08 11:57:13 +01002400 /* Now write the potentially updated record content type. */
2401 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2402
Paul Elliott9f352112020-12-09 14:55:45 +00002403 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002404 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002405 ssl->out_hdr[0], ssl->out_hdr[1],
2406 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002409 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002410
2411 ssl->out_left += protected_record_size;
2412 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002413 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002414
Hanno Beckerdd772292020-02-05 10:38:31 +00002415 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002416 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2417 break;
2418
2419 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002420 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002421 {
2422 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2423 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2424 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002425 }
2426
Hanno Becker67bc7c32018-08-06 11:33:50 +01002427#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002428 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2429 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002430 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002431 size_t remaining;
2432 ret = ssl_get_remaining_payload_in_datagram( ssl );
2433 if( ret < 0 )
2434 {
2435 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2436 ret );
2437 return( ret );
2438 }
2439
2440 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002441 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002442 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002443 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002444 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002445 else
2446 {
Hanno Becker513815a2018-08-20 11:56:09 +01002447 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002448 }
2449 }
2450#endif /* MBEDTLS_SSL_PROTO_DTLS */
2451
2452 if( ( flush == SSL_FORCE_FLUSH ) &&
2453 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002454 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002456 return( ret );
2457 }
2458
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002460
2461 return( 0 );
2462}
2463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002465
2466static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2467{
2468 if( ssl->in_msglen < ssl->in_hslen ||
2469 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2470 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2471 {
2472 return( 1 );
2473 }
2474 return( 0 );
2475}
Hanno Becker44650b72018-08-16 12:51:11 +01002476
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002477static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002478{
2479 return( ( ssl->in_msg[9] << 16 ) |
2480 ( ssl->in_msg[10] << 8 ) |
2481 ssl->in_msg[11] );
2482}
2483
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002484static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002485{
2486 return( ( ssl->in_msg[6] << 16 ) |
2487 ( ssl->in_msg[7] << 8 ) |
2488 ssl->in_msg[8] );
2489}
2490
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002491static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002492{
2493 uint32_t msg_len, frag_off, frag_len;
2494
2495 msg_len = ssl_get_hs_total_len( ssl );
2496 frag_off = ssl_get_hs_frag_off( ssl );
2497 frag_len = ssl_get_hs_frag_len( ssl );
2498
2499 if( frag_off > msg_len )
2500 return( -1 );
2501
2502 if( frag_len > msg_len - frag_off )
2503 return( -1 );
2504
2505 if( frag_len + 12 > ssl->in_msglen )
2506 return( -1 );
2507
2508 return( 0 );
2509}
2510
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002511/*
2512 * Mark bits in bitmask (used for DTLS HS reassembly)
2513 */
2514static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2515{
2516 unsigned int start_bits, end_bits;
2517
2518 start_bits = 8 - ( offset % 8 );
2519 if( start_bits != 8 )
2520 {
2521 size_t first_byte_idx = offset / 8;
2522
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002523 /* Special case */
2524 if( len <= start_bits )
2525 {
2526 for( ; len != 0; len-- )
2527 mask[first_byte_idx] |= 1 << ( start_bits - len );
2528
2529 /* Avoid potential issues with offset or len becoming invalid */
2530 return;
2531 }
2532
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002533 offset += start_bits; /* Now offset % 8 == 0 */
2534 len -= start_bits;
2535
2536 for( ; start_bits != 0; start_bits-- )
2537 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2538 }
2539
2540 end_bits = len % 8;
2541 if( end_bits != 0 )
2542 {
2543 size_t last_byte_idx = ( offset + len ) / 8;
2544
2545 len -= end_bits; /* Now len % 8 == 0 */
2546
2547 for( ; end_bits != 0; end_bits-- )
2548 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2549 }
2550
2551 memset( mask + offset / 8, 0xFF, len / 8 );
2552}
2553
2554/*
2555 * Check that bitmask is full
2556 */
2557static int ssl_bitmask_check( unsigned char *mask, size_t len )
2558{
2559 size_t i;
2560
2561 for( i = 0; i < len / 8; i++ )
2562 if( mask[i] != 0xFF )
2563 return( -1 );
2564
2565 for( i = 0; i < len % 8; i++ )
2566 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2567 return( -1 );
2568
2569 return( 0 );
2570}
2571
Hanno Becker56e205e2018-08-16 09:06:12 +01002572/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002573static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002574 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002575{
Hanno Becker56e205e2018-08-16 09:06:12 +01002576 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002577
Hanno Becker56e205e2018-08-16 09:06:12 +01002578 alloc_len = 12; /* Handshake header */
2579 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002580
Hanno Beckerd07df862018-08-16 09:14:58 +01002581 if( add_bitmap )
2582 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002583
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002584 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002585}
Hanno Becker56e205e2018-08-16 09:06:12 +01002586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002588
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002589static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002590{
2591 return( ( ssl->in_msg[1] << 16 ) |
2592 ( ssl->in_msg[2] << 8 ) |
2593 ssl->in_msg[3] );
2594}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002595
Simon Butcher99000142016-10-13 17:21:01 +01002596int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002597{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002599 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002600 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002601 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002603 }
2604
Hanno Becker12555c62018-08-16 12:47:53 +01002605 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002608 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002609 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002610
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002612 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002613 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002614 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002615 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002616
Hanno Becker44650b72018-08-16 12:51:11 +01002617 if( ssl_check_hs_header( ssl ) != 0 )
2618 {
2619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2620 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2621 }
2622
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002623 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002624 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2625 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2626 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2627 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002628 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002629 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2630 {
2631 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2632 recv_msg_seq,
2633 ssl->handshake->in_msg_seq ) );
2634 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2635 }
2636
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002637 /* Retransmit only on last message from previous flight, to avoid
2638 * too many retransmissions.
2639 * Besides, No sane server ever retransmits HelloVerifyRequest */
2640 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002642 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002644 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002645 recv_msg_seq,
2646 ssl->handshake->in_flight_start_seq ) );
2647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002649 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002650 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002651 return( ret );
2652 }
2653 }
2654 else
2655 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002657 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002658 recv_msg_seq,
2659 ssl->handshake->in_msg_seq ) );
2660 }
2661
Hanno Becker90333da2017-10-10 11:27:13 +01002662 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002663 }
2664 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002665
Hanno Becker6d97ef52018-08-16 13:09:04 +01002666 /* Message reassembly is handled alongside buffering of future
2667 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002668 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002669 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002670 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002671 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002673 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002674 }
2675 }
2676 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002678 /* With TLS we don't handle fragmentation (for now) */
2679 if( ssl->in_msglen < ssl->in_hslen )
2680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2682 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002683 }
2684
Simon Butcher99000142016-10-13 17:21:01 +01002685 return( 0 );
2686}
2687
2688void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2689{
Hanno Becker0271f962018-08-16 13:23:47 +01002690 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002691
Hanno Becker0271f962018-08-16 13:23:47 +01002692 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002693 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002694 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002695 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002696
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002697 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002699 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002700 ssl->handshake != NULL )
2701 {
Hanno Becker0271f962018-08-16 13:23:47 +01002702 unsigned offset;
2703 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002704
Hanno Becker0271f962018-08-16 13:23:47 +01002705 /* Increment handshake sequence number */
2706 hs->in_msg_seq++;
2707
2708 /*
2709 * Clear up handshake buffering and reassembly structure.
2710 */
2711
2712 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002713 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002714
2715 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002716 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2717 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002718 offset++, hs_buf++ )
2719 {
2720 *hs_buf = *(hs_buf + 1);
2721 }
2722
2723 /* Create a fresh last entry */
2724 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002725 }
2726#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002727}
2728
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002729/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002730 * DTLS anti-replay: RFC 6347 4.1.2.6
2731 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002732 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2733 * Bit n is set iff record number in_window_top - n has been seen.
2734 *
2735 * Usually, in_window_top is the last record number seen and the lsb of
2736 * in_window is set. The only exception is the initial state (record number 0
2737 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002740void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002741{
2742 ssl->in_window_top = 0;
2743 ssl->in_window = 0;
2744}
2745
2746static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2747{
2748 return( ( (uint64_t) buf[0] << 40 ) |
2749 ( (uint64_t) buf[1] << 32 ) |
2750 ( (uint64_t) buf[2] << 24 ) |
2751 ( (uint64_t) buf[3] << 16 ) |
2752 ( (uint64_t) buf[4] << 8 ) |
2753 ( (uint64_t) buf[5] ) );
2754}
2755
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002756static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2757{
Janos Follath865b3eb2019-12-16 11:46:15 +00002758 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002759 unsigned char *original_in_ctr;
2760
2761 // save original in_ctr
2762 original_in_ctr = ssl->in_ctr;
2763
2764 // use counter from record
2765 ssl->in_ctr = record_in_ctr;
2766
2767 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2768
2769 // restore the counter
2770 ssl->in_ctr = original_in_ctr;
2771
2772 return ret;
2773}
2774
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002775/*
2776 * Return 0 if sequence number is acceptable, -1 otherwise
2777 */
Hanno Becker0183d692019-07-12 08:50:37 +01002778int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002779{
2780 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2781 uint64_t bit;
2782
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002783 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002784 return( 0 );
2785
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002786 if( rec_seqnum > ssl->in_window_top )
2787 return( 0 );
2788
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002789 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002790
2791 if( bit >= 64 )
2792 return( -1 );
2793
2794 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2795 return( -1 );
2796
2797 return( 0 );
2798}
2799
2800/*
2801 * Update replay window on new validated record
2802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002804{
2805 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2806
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002807 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002808 return;
2809
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002810 if( rec_seqnum > ssl->in_window_top )
2811 {
2812 /* Update window_top and the contents of the window */
2813 uint64_t shift = rec_seqnum - ssl->in_window_top;
2814
2815 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002816 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002817 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002818 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002819 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002820 ssl->in_window |= 1;
2821 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002822
2823 ssl->in_window_top = rec_seqnum;
2824 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002825 else
2826 {
2827 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002828 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002829
2830 if( bit < 64 ) /* Always true, but be extra sure */
2831 ssl->in_window |= (uint64_t) 1 << bit;
2832 }
2833}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002835
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002836#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002837/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002838 * Without any SSL context, check if a datagram looks like a ClientHello with
2839 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002840 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002841 *
2842 * - if cookie is valid, return 0
2843 * - if ClientHello looks superficially valid but cookie is not,
2844 * fill obuf and set olen, then
2845 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2846 * - otherwise return a specific error code
2847 */
2848static int ssl_check_dtls_clihlo_cookie(
2849 mbedtls_ssl_cookie_write_t *f_cookie_write,
2850 mbedtls_ssl_cookie_check_t *f_cookie_check,
2851 void *p_cookie,
2852 const unsigned char *cli_id, size_t cli_id_len,
2853 const unsigned char *in, size_t in_len,
2854 unsigned char *obuf, size_t buf_len, size_t *olen )
2855{
2856 size_t sid_len, cookie_len;
2857 unsigned char *p;
2858
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002859 /*
2860 * Structure of ClientHello with record and handshake headers,
2861 * and expected values. We don't need to check a lot, more checks will be
2862 * done when actually parsing the ClientHello - skipping those checks
2863 * avoids code duplication and does not make cookie forging any easier.
2864 *
2865 * 0-0 ContentType type; copied, must be handshake
2866 * 1-2 ProtocolVersion version; copied
2867 * 3-4 uint16 epoch; copied, must be 0
2868 * 5-10 uint48 sequence_number; copied
2869 * 11-12 uint16 length; (ignored)
2870 *
2871 * 13-13 HandshakeType msg_type; (ignored)
2872 * 14-16 uint24 length; (ignored)
2873 * 17-18 uint16 message_seq; copied
2874 * 19-21 uint24 fragment_offset; copied, must be 0
2875 * 22-24 uint24 fragment_length; (ignored)
2876 *
2877 * 25-26 ProtocolVersion client_version; (ignored)
2878 * 27-58 Random random; (ignored)
2879 * 59-xx SessionID session_id; 1 byte len + sid_len content
2880 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
2881 * ...
2882 *
2883 * Minimum length is 61 bytes.
2884 */
2885 if( in_len < 61 ||
2886 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
2887 in[3] != 0 || in[4] != 0 ||
2888 in[19] != 0 || in[20] != 0 || in[21] != 0 )
2889 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01002890 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002891 }
2892
2893 sid_len = in[59];
2894 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002895 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002896
2897 cookie_len = in[60 + sid_len];
2898 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002899 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002900
2901 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
2902 cli_id, cli_id_len ) == 0 )
2903 {
2904 /* Valid cookie */
2905 return( 0 );
2906 }
2907
2908 /*
2909 * If we get here, we've got an invalid cookie, let's prepare HVR.
2910 *
2911 * 0-0 ContentType type; copied
2912 * 1-2 ProtocolVersion version; copied
2913 * 3-4 uint16 epoch; copied
2914 * 5-10 uint48 sequence_number; copied
2915 * 11-12 uint16 length; olen - 13
2916 *
2917 * 13-13 HandshakeType msg_type; hello_verify_request
2918 * 14-16 uint24 length; olen - 25
2919 * 17-18 uint16 message_seq; copied
2920 * 19-21 uint24 fragment_offset; copied
2921 * 22-24 uint24 fragment_length; olen - 25
2922 *
2923 * 25-26 ProtocolVersion server_version; 0xfe 0xff
2924 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
2925 *
2926 * Minimum length is 28.
2927 */
2928 if( buf_len < 28 )
2929 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
2930
2931 /* Copy most fields and adapt others */
2932 memcpy( obuf, in, 25 );
2933 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
2934 obuf[25] = 0xfe;
2935 obuf[26] = 0xff;
2936
2937 /* Generate and write actual cookie */
2938 p = obuf + 28;
2939 if( f_cookie_write( p_cookie,
2940 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
2941 {
2942 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2943 }
2944
2945 *olen = p - obuf;
2946
2947 /* Go back and fill length fields */
2948 obuf[27] = (unsigned char)( *olen - 28 );
2949
Joe Subbianifbeb6922021-07-16 14:27:50 +01002950 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
2951 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
2952 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002953
Joe Subbiani6dd73642021-07-19 11:56:54 +01002954 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002955
2956 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
2957}
2958
2959/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002960 * Handle possible client reconnect with the same UDP quadruplet
2961 * (RFC 6347 Section 4.2.8).
2962 *
2963 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
2964 * that looks like a ClientHello.
2965 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002966 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002967 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002968 * - if the input looks like a ClientHello with a valid cookie,
2969 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02002970 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002971 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002972 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002973 * This function is called (through ssl_check_client_reconnect()) when an
2974 * unexpected record is found in ssl_get_next_record(), which will discard the
2975 * record if we return 0, and bubble up the return value otherwise (this
2976 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
2977 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002978 */
2979static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
2980{
Janos Follath865b3eb2019-12-16 11:46:15 +00002981 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002982 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002983
Hanno Becker2fddd372019-07-10 14:37:41 +01002984 if( ssl->conf->f_cookie_write == NULL ||
2985 ssl->conf->f_cookie_check == NULL )
2986 {
2987 /* If we can't use cookies to verify reachability of the peer,
2988 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02002989 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
2990 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01002991 return( 0 );
2992 }
2993
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002994 ret = ssl_check_dtls_clihlo_cookie(
2995 ssl->conf->f_cookie_write,
2996 ssl->conf->f_cookie_check,
2997 ssl->conf->p_cookie,
2998 ssl->cli_id, ssl->cli_id_len,
2999 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003000 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003001
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003002 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3003
3004 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003005 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003006 int send_ret;
3007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3008 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3009 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003010 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003011 * If the error is permanent we'll catch it later,
3012 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003013 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3014 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3015 (void) send_ret;
3016
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003017 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003018 }
3019
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003020 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003021 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003022 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003023 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003024 {
3025 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3026 return( ret );
3027 }
3028
3029 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003030 }
3031
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003032 return( ret );
3033}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003034#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003035
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003036static int ssl_check_record_type( uint8_t record_type )
3037{
3038 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3039 record_type != MBEDTLS_SSL_MSG_ALERT &&
3040 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3041 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3042 {
3043 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3044 }
3045
3046 return( 0 );
3047}
3048
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003049/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003050 * ContentType type;
3051 * ProtocolVersion version;
3052 * uint16 epoch; // DTLS only
3053 * uint48 sequence_number; // DTLS only
3054 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003055 *
3056 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003057 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003058 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3059 *
3060 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003061 * 1. proceed with the record if this function returns 0
3062 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3063 * 3. return CLIENT_RECONNECT if this function return that value
3064 * 4. drop the whole datagram if this function returns anything else.
3065 * Point 2 is needed when the peer is resending, and we have already received
3066 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003067 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003068static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003069 unsigned char *buf,
3070 size_t len,
3071 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003072{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003073 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003074
Hanno Beckere5e7e782019-07-11 12:29:35 +01003075 size_t const rec_hdr_type_offset = 0;
3076 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003077
Hanno Beckere5e7e782019-07-11 12:29:35 +01003078 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3079 rec_hdr_type_len;
3080 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003081
Hanno Beckere5e7e782019-07-11 12:29:35 +01003082 size_t const rec_hdr_ctr_len = 8;
3083#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003084 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003085 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3086 rec_hdr_version_len;
3087
Hanno Beckera0e20d02019-05-15 14:03:01 +01003088#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003089 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3090 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003091 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003092#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3093#endif /* MBEDTLS_SSL_PROTO_DTLS */
3094
3095 size_t rec_hdr_len_offset; /* To be determined */
3096 size_t const rec_hdr_len_len = 2;
3097
3098 /*
3099 * Check minimum lengths for record header.
3100 */
3101
3102#if defined(MBEDTLS_SSL_PROTO_DTLS)
3103 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3104 {
3105 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3106 }
3107 else
3108#endif /* MBEDTLS_SSL_PROTO_DTLS */
3109 {
3110 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3111 }
3112
3113 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3114 {
3115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3116 (unsigned) len,
3117 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3118 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3119 }
3120
3121 /*
3122 * Parse and validate record content type
3123 */
3124
3125 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003126
3127 /* Check record content type */
3128#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3129 rec->cid_len = 0;
3130
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003131 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003132 ssl->conf->cid_len != 0 &&
3133 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003134 {
3135 /* Shift pointers to account for record header including CID
3136 * struct {
3137 * ContentType special_type = tls12_cid;
3138 * ProtocolVersion version;
3139 * uint16 epoch;
3140 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003141 * opaque cid[cid_length]; // Additional field compared to
3142 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003143 * uint16 length;
3144 * opaque enc_content[DTLSCiphertext.length];
3145 * } DTLSCiphertext;
3146 */
3147
3148 /* So far, we only support static CID lengths
3149 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003150 rec_hdr_cid_len = ssl->conf->cid_len;
3151 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003152
Hanno Beckere5e7e782019-07-11 12:29:35 +01003153 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003154 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3156 (unsigned) len,
3157 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003158 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003159 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003160
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003161 /* configured CID len is guaranteed at most 255, see
3162 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3163 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003164 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003165 }
3166 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003167#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003168 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003169 if( ssl_check_record_type( rec->type ) )
3170 {
Hanno Becker54229812019-07-12 14:40:00 +01003171 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3172 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003173 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3174 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003175 }
3176
Hanno Beckere5e7e782019-07-11 12:29:35 +01003177 /*
3178 * Parse and validate record version
3179 */
3180
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003181 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3182 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003183 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3184 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003185 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003186
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003187 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003188 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3190 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003191 }
3192
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003193 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003194 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3196 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003197 }
3198
Hanno Beckere5e7e782019-07-11 12:29:35 +01003199 /*
3200 * Parse/Copy record sequence number.
3201 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003202
Hanno Beckere5e7e782019-07-11 12:29:35 +01003203#if defined(MBEDTLS_SSL_PROTO_DTLS)
3204 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003205 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003206 /* Copy explicit record sequence number from input buffer. */
3207 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3208 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003209 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003210 else
3211#endif /* MBEDTLS_SSL_PROTO_DTLS */
3212 {
3213 /* Copy implicit record sequence number from SSL context structure. */
3214 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3215 }
Paul Bakker40e46942009-01-03 21:51:57 +00003216
Hanno Beckere5e7e782019-07-11 12:29:35 +01003217 /*
3218 * Parse record length.
3219 */
3220
Hanno Beckere5e7e782019-07-11 12:29:35 +01003221 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003222 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3223 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003224 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003225
Paul Elliott9f352112020-12-09 14:55:45 +00003226 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003227 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003228 rec->type,
3229 major_ver, minor_ver, rec->data_len ) );
3230
3231 rec->buf = buf;
3232 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003233
Hanno Beckerd417cc92019-07-26 08:20:27 +01003234 if( rec->data_len == 0 )
3235 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003236
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003237 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003238 * DTLS-related tests.
3239 * Check epoch before checking length constraint because
3240 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3241 * message gets duplicated before the corresponding Finished message,
3242 * the second ChangeCipherSpec should be discarded because it belongs
3243 * to an old epoch, but not because its length is shorter than
3244 * the minimum record length for packets using the new record transform.
3245 * Note that these two kinds of failures are handled differently,
3246 * as an unexpected record is silently skipped but an invalid
3247 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003248 */
3249#if defined(MBEDTLS_SSL_PROTO_DTLS)
3250 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3251 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003252 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003253
Hanno Becker955a5c92019-07-10 17:12:07 +01003254 /* Check that the datagram is large enough to contain a record
3255 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003256 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003257 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003258 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3259 (unsigned) len,
3260 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003261 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3262 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003263
Hanno Becker37cfe732019-07-10 17:20:01 +01003264 /* Records from other, non-matching epochs are silently discarded.
3265 * (The case of same-port Client reconnects must be considered in
3266 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003267 if( rec_epoch != ssl->in_epoch )
3268 {
3269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003270 "expected %u, received %lu",
3271 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003272
Hanno Becker552f7472019-07-19 10:59:12 +01003273 /* Records from the next epoch are considered for buffering
3274 * (concretely: early Finished messages). */
3275 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003276 {
Hanno Becker552f7472019-07-19 10:59:12 +01003277 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3278 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003279 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003280
Hanno Becker2fddd372019-07-10 14:37:41 +01003281 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003282 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003283#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003284 /* For records from the correct epoch, check whether their
3285 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003286 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3287 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003288 {
3289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3290 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3291 }
3292#endif
3293 }
3294#endif /* MBEDTLS_SSL_PROTO_DTLS */
3295
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003296 return( 0 );
3297}
Paul Bakker5121ce52009-01-03 21:22:43 +00003298
Paul Bakker5121ce52009-01-03 21:22:43 +00003299
Hanno Becker2fddd372019-07-10 14:37:41 +01003300#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3301static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3302{
3303 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3304
3305 /*
3306 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3307 * access the first byte of record content (handshake type), as we
3308 * have an active transform (possibly iv_len != 0), so use the
3309 * fact that the record header len is 13 instead.
3310 */
3311 if( rec_epoch == 0 &&
3312 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3313 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3314 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3315 ssl->in_left > 13 &&
3316 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3317 {
3318 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3319 "from the same port" ) );
3320 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003321 }
3322
3323 return( 0 );
3324}
Hanno Becker2fddd372019-07-10 14:37:41 +01003325#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003326
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003327/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003328 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003329 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003330static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3331 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003332{
3333 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003334
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003336 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003337
Paul Bakker48916f92012-09-16 19:57:18 +00003338 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003339 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003340 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003341
Hanno Beckera18d1322018-01-03 14:27:32 +00003342 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003343 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003346
Hanno Beckera0e20d02019-05-15 14:03:01 +01003347#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003348 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3349 ssl->conf->ignore_unexpected_cid
3350 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3351 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003352 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003353 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003354 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003355#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003356
Paul Bakker5121ce52009-01-03 21:22:43 +00003357 return( ret );
3358 }
3359
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003360 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003361 {
3362 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003363 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003364 }
3365
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003366 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003367 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003368
Hanno Beckera0e20d02019-05-15 14:03:01 +01003369#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003370 /* We have already checked the record content type
3371 * in ssl_parse_record_header(), failing or silently
3372 * dropping the record in the case of an unknown type.
3373 *
3374 * Since with the use of CIDs, the record content type
3375 * might change during decryption, re-check the record
3376 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003377 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003378 {
3379 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3380 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3381 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003382#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003383
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003384 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003385 {
3386#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3387 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003388 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003389 {
3390 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3391 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3392 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3393 }
3394#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3395
3396 ssl->nb_zero++;
3397
3398 /*
3399 * Three or more empty messages may be a DoS attack
3400 * (excessive CPU consumption).
3401 */
3402 if( ssl->nb_zero > 3 )
3403 {
3404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003405 "messages, possible DoS attack" ) );
3406 /* Treat the records as if they were not properly authenticated,
3407 * thereby failing the connection if we see more than allowed
3408 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003409 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3410 }
3411 }
3412 else
3413 ssl->nb_zero = 0;
3414
3415#if defined(MBEDTLS_SSL_PROTO_DTLS)
3416 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3417 {
3418 ; /* in_ctr read from peer, not maintained internally */
3419 }
3420 else
3421#endif
3422 {
3423 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003424 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3425 i > mbedtls_ssl_ep_len( ssl ); i-- )
3426 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003427 if( ++ssl->in_ctr[i - 1] != 0 )
3428 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003429 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003430
3431 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003432 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003433 {
3434 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3435 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3436 }
3437 }
3438
Paul Bakker5121ce52009-01-03 21:22:43 +00003439 }
3440
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003442 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003443 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003445 }
3446#endif
3447
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003448 /* Check actual (decrypted) record content length against
3449 * configured maximum. */
3450 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3451 {
3452 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3453 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3454 }
3455
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003456 return( 0 );
3457}
3458
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003459/*
3460 * Read a record.
3461 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003462 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3463 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3464 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003465 */
Hanno Becker1097b342018-08-15 14:09:41 +01003466
3467/* Helper functions for mbedtls_ssl_read_record(). */
3468static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003469static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3470static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003471
Hanno Becker327c93b2018-08-15 13:56:18 +01003472int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003473 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003474{
Janos Follath865b3eb2019-12-16 11:46:15 +00003475 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003478
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003479 if( ssl->keep_current_message == 0 )
3480 {
3481 do {
Simon Butcher99000142016-10-13 17:21:01 +01003482
Hanno Becker26994592018-08-15 14:14:59 +01003483 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003484 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003485 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003486
Hanno Beckere74d5562018-08-15 14:26:08 +01003487 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003488 {
Hanno Becker40f50842018-08-15 14:48:01 +01003489#if defined(MBEDTLS_SSL_PROTO_DTLS)
3490 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003491
Hanno Becker40f50842018-08-15 14:48:01 +01003492 /* We only check for buffered messages if the
3493 * current datagram is fully consumed. */
3494 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003495 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003496 {
Hanno Becker40f50842018-08-15 14:48:01 +01003497 if( ssl_load_buffered_message( ssl ) == 0 )
3498 have_buffered = 1;
3499 }
3500
3501 if( have_buffered == 0 )
3502#endif /* MBEDTLS_SSL_PROTO_DTLS */
3503 {
3504 ret = ssl_get_next_record( ssl );
3505 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3506 continue;
3507
3508 if( ret != 0 )
3509 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003510 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003511 return( ret );
3512 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003513 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003514 }
3515
3516 ret = mbedtls_ssl_handle_message_type( ssl );
3517
Hanno Becker40f50842018-08-15 14:48:01 +01003518#if defined(MBEDTLS_SSL_PROTO_DTLS)
3519 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3520 {
3521 /* Buffer future message */
3522 ret = ssl_buffer_message( ssl );
3523 if( ret != 0 )
3524 return( ret );
3525
3526 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3527 }
3528#endif /* MBEDTLS_SSL_PROTO_DTLS */
3529
Hanno Becker90333da2017-10-10 11:27:13 +01003530 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3531 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003532
3533 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003534 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003535 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003536 return( ret );
3537 }
3538
Hanno Becker327c93b2018-08-15 13:56:18 +01003539 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003540 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003541 {
3542 mbedtls_ssl_update_handshake_status( ssl );
3543 }
Simon Butcher99000142016-10-13 17:21:01 +01003544 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003545 else
Simon Butcher99000142016-10-13 17:21:01 +01003546 {
Hanno Becker02f59072018-08-15 14:00:24 +01003547 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003548 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003549 }
3550
3551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3552
3553 return( 0 );
3554}
3555
Hanno Becker40f50842018-08-15 14:48:01 +01003556#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003557static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003558{
Hanno Becker40f50842018-08-15 14:48:01 +01003559 if( ssl->in_left > ssl->next_record_offset )
3560 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003561
Hanno Becker40f50842018-08-15 14:48:01 +01003562 return( 0 );
3563}
3564
3565static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3566{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003567 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003568 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003569 int ret = 0;
3570
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003571 if( hs == NULL )
3572 return( -1 );
3573
Hanno Beckere00ae372018-08-20 09:39:42 +01003574 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3575
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003576 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3577 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3578 {
3579 /* Check if we have seen a ChangeCipherSpec before.
3580 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003581 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003582 {
3583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3584 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003585 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003586 }
3587
Hanno Becker39b8bc92018-08-28 17:17:13 +01003588 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003589 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3590 ssl->in_msglen = 1;
3591 ssl->in_msg[0] = 1;
3592
3593 /* As long as they are equal, the exact value doesn't matter. */
3594 ssl->in_left = 0;
3595 ssl->next_record_offset = 0;
3596
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003597 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003598 goto exit;
3599 }
Hanno Becker37f95322018-08-16 13:55:32 +01003600
Hanno Beckerb8f50142018-08-28 10:01:34 +01003601#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003602 /* Debug only */
3603 {
3604 unsigned offset;
3605 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3606 {
3607 hs_buf = &hs->buffering.hs[offset];
3608 if( hs_buf->is_valid == 1 )
3609 {
3610 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3611 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003612 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003613 }
3614 }
3615 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003616#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003617
3618 /* Check if we have buffered and/or fully reassembled the
3619 * next handshake message. */
3620 hs_buf = &hs->buffering.hs[0];
3621 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3622 {
3623 /* Synthesize a record containing the buffered HS message. */
3624 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3625 ( hs_buf->data[2] << 8 ) |
3626 hs_buf->data[3];
3627
3628 /* Double-check that we haven't accidentally buffered
3629 * a message that doesn't fit into the input buffer. */
3630 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3631 {
3632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3633 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3634 }
3635
3636 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3637 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3638 hs_buf->data, msg_len + 12 );
3639
3640 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3641 ssl->in_hslen = msg_len + 12;
3642 ssl->in_msglen = msg_len + 12;
3643 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3644
3645 ret = 0;
3646 goto exit;
3647 }
3648 else
3649 {
3650 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3651 hs->in_msg_seq ) );
3652 }
3653
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003654 ret = -1;
3655
3656exit:
3657
3658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3659 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003660}
3661
Hanno Beckera02b0b42018-08-21 17:20:27 +01003662static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3663 size_t desired )
3664{
3665 int offset;
3666 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003667 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3668 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003669
Hanno Becker01315ea2018-08-21 17:22:17 +01003670 /* Get rid of future records epoch first, if such exist. */
3671 ssl_free_buffered_record( ssl );
3672
3673 /* Check if we have enough space available now. */
3674 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3675 hs->buffering.total_bytes_buffered ) )
3676 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003678 return( 0 );
3679 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003680
Hanno Becker4f432ad2018-08-28 10:02:32 +01003681 /* We don't have enough space to buffer the next expected handshake
3682 * message. Remove buffers used for future messages to gain space,
3683 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003684 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3685 offset >= 0; offset-- )
3686 {
3687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3688 offset ) );
3689
Hanno Beckerb309b922018-08-23 13:18:05 +01003690 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003691
3692 /* Check if we have enough space available now. */
3693 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3694 hs->buffering.total_bytes_buffered ) )
3695 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003697 return( 0 );
3698 }
3699 }
3700
3701 return( -1 );
3702}
3703
Hanno Becker40f50842018-08-15 14:48:01 +01003704static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3705{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003706 int ret = 0;
3707 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3708
3709 if( hs == NULL )
3710 return( 0 );
3711
3712 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3713
3714 switch( ssl->in_msgtype )
3715 {
3716 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3717 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003718
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003719 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003720 break;
3721
3722 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003723 {
3724 unsigned recv_msg_seq_offset;
3725 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3726 mbedtls_ssl_hs_buffer *hs_buf;
3727 size_t msg_len = ssl->in_hslen - 12;
3728
3729 /* We should never receive an old handshake
3730 * message - double-check nonetheless. */
3731 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3732 {
3733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3734 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3735 }
3736
3737 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3738 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3739 {
3740 /* Silently ignore -- message too far in the future */
3741 MBEDTLS_SSL_DEBUG_MSG( 2,
3742 ( "Ignore future HS message with sequence number %u, "
3743 "buffering window %u - %u",
3744 recv_msg_seq, ssl->handshake->in_msg_seq,
3745 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3746
3747 goto exit;
3748 }
3749
3750 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3751 recv_msg_seq, recv_msg_seq_offset ) );
3752
3753 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3754
3755 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003756 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003757 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003758 size_t reassembly_buf_sz;
3759
Hanno Becker37f95322018-08-16 13:55:32 +01003760 hs_buf->is_fragmented =
3761 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3762
3763 /* We copy the message back into the input buffer
3764 * after reassembly, so check that it's not too large.
3765 * This is an implementation-specific limitation
3766 * and not one from the standard, hence it is not
3767 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003768 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003769 {
3770 /* Ignore message */
3771 goto exit;
3772 }
3773
Hanno Beckere0b150f2018-08-21 15:51:03 +01003774 /* Check if we have enough space to buffer the message. */
3775 if( hs->buffering.total_bytes_buffered >
3776 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3777 {
3778 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3779 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3780 }
3781
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003782 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3783 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003784
3785 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3786 hs->buffering.total_bytes_buffered ) )
3787 {
3788 if( recv_msg_seq_offset > 0 )
3789 {
3790 /* If we can't buffer a future message because
3791 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003792 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3793 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3794 " (already %" MBEDTLS_PRINTF_SIZET
3795 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003796 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003797 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003798 goto exit;
3799 }
Hanno Beckere1801392018-08-21 16:51:05 +01003800 else
3801 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3803 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3804 " (already %" MBEDTLS_PRINTF_SIZET
3805 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003806 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003807 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003808 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003809
Hanno Beckera02b0b42018-08-21 17:20:27 +01003810 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003811 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3813 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3814 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3815 " (already %" MBEDTLS_PRINTF_SIZET
3816 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003817 msg_len,
3818 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003819 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003820 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003821 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3822 goto exit;
3823 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003824 }
3825
Paul Elliottd48d5c62021-01-07 14:47:05 +00003826 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003827 msg_len ) );
3828
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003829 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3830 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003831 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003832 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003833 goto exit;
3834 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003835 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003836
3837 /* Prepare final header: copy msg_type, length and message_seq,
3838 * then add standardised fragment_offset and fragment_length */
3839 memcpy( hs_buf->data, ssl->in_msg, 6 );
3840 memset( hs_buf->data + 6, 0, 3 );
3841 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3842
3843 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003844
3845 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003846 }
3847 else
3848 {
3849 /* Make sure msg_type and length are consistent */
3850 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3851 {
3852 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3853 /* Ignore */
3854 goto exit;
3855 }
3856 }
3857
Hanno Becker4422bbb2018-08-20 09:40:19 +01003858 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003859 {
3860 size_t frag_len, frag_off;
3861 unsigned char * const msg = hs_buf->data + 12;
3862
3863 /*
3864 * Check and copy current fragment
3865 */
3866
3867 /* Validation of header fields already done in
3868 * mbedtls_ssl_prepare_handshake_record(). */
3869 frag_off = ssl_get_hs_frag_off( ssl );
3870 frag_len = ssl_get_hs_frag_len( ssl );
3871
Paul Elliottd48d5c62021-01-07 14:47:05 +00003872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
3873 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01003874 frag_off, frag_len ) );
3875 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
3876
3877 if( hs_buf->is_fragmented )
3878 {
3879 unsigned char * const bitmask = msg + msg_len;
3880 ssl_bitmask_set( bitmask, frag_off, frag_len );
3881 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
3882 msg_len ) == 0 );
3883 }
3884 else
3885 {
3886 hs_buf->is_complete = 1;
3887 }
3888
3889 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
3890 hs_buf->is_complete ? "" : "not yet " ) );
3891 }
3892
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003893 break;
Hanno Becker37f95322018-08-16 13:55:32 +01003894 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003895
3896 default:
Hanno Becker360bef32018-08-28 10:04:33 +01003897 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003898 break;
3899 }
3900
3901exit:
3902
3903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
3904 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003905}
3906#endif /* MBEDTLS_SSL_PROTO_DTLS */
3907
Hanno Becker1097b342018-08-15 14:09:41 +01003908static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003909{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003910 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01003911 * Consume last content-layer message and potentially
3912 * update in_msglen which keeps track of the contents'
3913 * consumption state.
3914 *
3915 * (1) Handshake messages:
3916 * Remove last handshake message, move content
3917 * and adapt in_msglen.
3918 *
3919 * (2) Alert messages:
3920 * Consume whole record content, in_msglen = 0.
3921 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01003922 * (3) Change cipher spec:
3923 * Consume whole record content, in_msglen = 0.
3924 *
3925 * (4) Application data:
3926 * Don't do anything - the record layer provides
3927 * the application data as a stream transport
3928 * and consumes through mbedtls_ssl_read only.
3929 *
3930 */
3931
3932 /* Case (1): Handshake messages */
3933 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003934 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003935 /* Hard assertion to be sure that no application data
3936 * is in flight, as corrupting ssl->in_msglen during
3937 * ssl->in_offt != NULL is fatal. */
3938 if( ssl->in_offt != NULL )
3939 {
3940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3941 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3942 }
3943
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003944 /*
3945 * Get next Handshake message in the current record
3946 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003947
Hanno Becker4a810fb2017-05-24 16:27:30 +01003948 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01003949 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01003950 * current handshake content: If DTLS handshake
3951 * fragmentation is used, that's the fragment
3952 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01003953 * size here is faulty and should be changed at
3954 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003955 * (2) While it doesn't seem to cause problems, one
3956 * has to be very careful not to assume that in_hslen
3957 * is always <= in_msglen in a sensible communication.
3958 * Again, it's wrong for DTLS handshake fragmentation.
3959 * The following check is therefore mandatory, and
3960 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003961 * Additionally, ssl->in_hslen might be arbitrarily out of
3962 * bounds after handling a DTLS message with an unexpected
3963 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003964 */
3965 if( ssl->in_hslen < ssl->in_msglen )
3966 {
3967 ssl->in_msglen -= ssl->in_hslen;
3968 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
3969 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003970
Hanno Becker4a810fb2017-05-24 16:27:30 +01003971 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
3972 ssl->in_msg, ssl->in_msglen );
3973 }
3974 else
3975 {
3976 ssl->in_msglen = 0;
3977 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02003978
Hanno Becker4a810fb2017-05-24 16:27:30 +01003979 ssl->in_hslen = 0;
3980 }
3981 /* Case (4): Application data */
3982 else if( ssl->in_offt != NULL )
3983 {
3984 return( 0 );
3985 }
3986 /* Everything else (CCS & Alerts) */
3987 else
3988 {
3989 ssl->in_msglen = 0;
3990 }
3991
Hanno Becker1097b342018-08-15 14:09:41 +01003992 return( 0 );
3993}
Hanno Becker4a810fb2017-05-24 16:27:30 +01003994
Hanno Beckere74d5562018-08-15 14:26:08 +01003995static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
3996{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003997 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003998 return( 1 );
3999
4000 return( 0 );
4001}
4002
Hanno Becker5f066e72018-08-16 14:56:31 +01004003#if defined(MBEDTLS_SSL_PROTO_DTLS)
4004
4005static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4006{
4007 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4008 if( hs == NULL )
4009 return;
4010
Hanno Becker01315ea2018-08-21 17:22:17 +01004011 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004012 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004013 hs->buffering.total_bytes_buffered -=
4014 hs->buffering.future_record.len;
4015
4016 mbedtls_free( hs->buffering.future_record.data );
4017 hs->buffering.future_record.data = NULL;
4018 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004019}
4020
4021static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4022{
4023 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4024 unsigned char * rec;
4025 size_t rec_len;
4026 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004027#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4028 size_t in_buf_len = ssl->in_buf_len;
4029#else
4030 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4031#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004032 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4033 return( 0 );
4034
4035 if( hs == NULL )
4036 return( 0 );
4037
Hanno Becker5f066e72018-08-16 14:56:31 +01004038 rec = hs->buffering.future_record.data;
4039 rec_len = hs->buffering.future_record.len;
4040 rec_epoch = hs->buffering.future_record.epoch;
4041
4042 if( rec == NULL )
4043 return( 0 );
4044
Hanno Becker4cb782d2018-08-20 11:19:05 +01004045 /* Only consider loading future records if the
4046 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004047 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004048 return( 0 );
4049
Hanno Becker5f066e72018-08-16 14:56:31 +01004050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4051
4052 if( rec_epoch != ssl->in_epoch )
4053 {
4054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4055 goto exit;
4056 }
4057
4058 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4059
4060 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004061 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004062 {
4063 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4064 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4065 }
4066
4067 memcpy( ssl->in_hdr, rec, rec_len );
4068 ssl->in_left = rec_len;
4069 ssl->next_record_offset = 0;
4070
4071 ssl_free_buffered_record( ssl );
4072
4073exit:
4074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4075 return( 0 );
4076}
4077
Hanno Becker519f15d2019-07-11 12:43:20 +01004078static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4079 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004080{
4081 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004082
4083 /* Don't buffer future records outside handshakes. */
4084 if( hs == NULL )
4085 return( 0 );
4086
4087 /* Only buffer handshake records (we are only interested
4088 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004089 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004090 return( 0 );
4091
4092 /* Don't buffer more than one future epoch record. */
4093 if( hs->buffering.future_record.data != NULL )
4094 return( 0 );
4095
Hanno Becker01315ea2018-08-21 17:22:17 +01004096 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004097 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004098 hs->buffering.total_bytes_buffered ) )
4099 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4101 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4102 " (already %" MBEDTLS_PRINTF_SIZET
4103 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004104 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004105 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004106 return( 0 );
4107 }
4108
Hanno Becker5f066e72018-08-16 14:56:31 +01004109 /* Buffer record */
4110 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004111 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004112 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004113
4114 /* ssl_parse_record_header() only considers records
4115 * of the next epoch as candidates for buffering. */
4116 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004117 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004118
4119 hs->buffering.future_record.data =
4120 mbedtls_calloc( 1, hs->buffering.future_record.len );
4121 if( hs->buffering.future_record.data == NULL )
4122 {
4123 /* If we run out of RAM trying to buffer a
4124 * record from the next epoch, just ignore. */
4125 return( 0 );
4126 }
4127
Hanno Becker519f15d2019-07-11 12:43:20 +01004128 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004129
Hanno Becker519f15d2019-07-11 12:43:20 +01004130 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004131 return( 0 );
4132}
4133
4134#endif /* MBEDTLS_SSL_PROTO_DTLS */
4135
Hanno Beckere74d5562018-08-15 14:26:08 +01004136static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004137{
Janos Follath865b3eb2019-12-16 11:46:15 +00004138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004139 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004140
Hanno Becker5f066e72018-08-16 14:56:31 +01004141#if defined(MBEDTLS_SSL_PROTO_DTLS)
4142 /* We might have buffered a future record; if so,
4143 * and if the epoch matches now, load it.
4144 * On success, this call will set ssl->in_left to
4145 * the length of the buffered record, so that
4146 * the calls to ssl_fetch_input() below will
4147 * essentially be no-ops. */
4148 ret = ssl_load_buffered_record( ssl );
4149 if( ret != 0 )
4150 return( ret );
4151#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004152
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004153 /* Ensure that we have enough space available for the default form
4154 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4155 * with no space for CIDs counted in). */
4156 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4157 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004158 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004159 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004160 return( ret );
4161 }
4162
Hanno Beckere5e7e782019-07-11 12:29:35 +01004163 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4164 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004165 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004166#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004167 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004168 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004169 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4170 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004171 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004172 if( ret != 0 )
4173 return( ret );
4174
4175 /* Fall through to handling of unexpected records */
4176 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4177 }
4178
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004179 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4180 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004181#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004182 /* Reset in pointers to default state for TLS/DTLS records,
4183 * assuming no CID and no offset between record content and
4184 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004185 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004186
Hanno Becker7ae20e02019-07-12 08:33:49 +01004187 /* Setup internal message pointers from record structure. */
4188 ssl->in_msgtype = rec.type;
4189#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4190 ssl->in_len = ssl->in_cid + rec.cid_len;
4191#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4192 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4193 ssl->in_msglen = rec.data_len;
4194
Hanno Becker2fddd372019-07-10 14:37:41 +01004195 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004196 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004197 if( ret != 0 )
4198 return( ret );
4199#endif
4200
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004201 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004202 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004203
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004204 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4205 "(header)" ) );
4206 }
4207 else
4208 {
4209 /* Skip invalid record and the rest of the datagram */
4210 ssl->next_record_offset = 0;
4211 ssl->in_left = 0;
4212
4213 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4214 "(header)" ) );
4215 }
4216
4217 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004218 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004219 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004220 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004221#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004222 {
4223 return( ret );
4224 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004225 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004227#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004228 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004229 {
Hanno Beckera8814792019-07-10 15:01:45 +01004230 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004231 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004232 if( ssl->next_record_offset < ssl->in_left )
4233 {
4234 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4235 }
4236 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004237 else
4238#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004239 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004240 /*
4241 * Fetch record contents from underlying transport.
4242 */
Hanno Beckera3175662019-07-11 12:50:29 +01004243 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004244 if( ret != 0 )
4245 {
4246 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4247 return( ret );
4248 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004249
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004250 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004251 }
4252
4253 /*
4254 * Decrypt record contents.
4255 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004256
Hanno Beckerfdf66042019-07-11 13:07:45 +01004257 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004258 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004259#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004260 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004261 {
4262 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004263 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004264 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004265 /* Except when waiting for Finished as a bad mac here
4266 * probably means something went wrong in the handshake
4267 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4268 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4269 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4270 {
4271#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4272 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4273 {
4274 mbedtls_ssl_send_alert_message( ssl,
4275 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4276 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4277 }
4278#endif
4279 return( ret );
4280 }
4281
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004282 if( ssl->conf->badmac_limit != 0 &&
4283 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004284 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004285 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4286 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004287 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004288
Hanno Becker4a810fb2017-05-24 16:27:30 +01004289 /* As above, invalid records cause
4290 * dismissal of the whole datagram. */
4291
4292 ssl->next_record_offset = 0;
4293 ssl->in_left = 0;
4294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004295 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004296 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004297 }
4298
4299 return( ret );
4300 }
4301 else
4302#endif
4303 {
4304 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004305#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4306 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004307 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004308 mbedtls_ssl_send_alert_message( ssl,
4309 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4310 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004311 }
4312#endif
4313 return( ret );
4314 }
4315 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004316
Hanno Becker44d89b22019-07-12 09:40:44 +01004317
4318 /* Reset in pointers to default state for TLS/DTLS records,
4319 * assuming no CID and no offset between record content and
4320 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004321 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004322#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4323 ssl->in_len = ssl->in_cid + rec.cid_len;
4324#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004325 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004326
Hanno Becker8685c822019-07-12 09:37:30 +01004327 /* The record content type may change during decryption,
4328 * so re-read it. */
4329 ssl->in_msgtype = rec.type;
4330 /* Also update the input buffer, because unfortunately
4331 * the server-side ssl_parse_client_hello() reparses the
4332 * record header when receiving a ClientHello initiating
4333 * a renegotiation. */
4334 ssl->in_hdr[0] = rec.type;
4335 ssl->in_msg = rec.buf + rec.data_offset;
4336 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004337 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004338
Simon Butcher99000142016-10-13 17:21:01 +01004339 return( 0 );
4340}
4341
4342int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4343{
Janos Follath865b3eb2019-12-16 11:46:15 +00004344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004345
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004346 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004347 * Handle particular types of records
4348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004349 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004350 {
Simon Butcher99000142016-10-13 17:21:01 +01004351 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4352 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004353 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004354 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004355 }
4356
Hanno Beckere678eaa2018-08-21 14:57:46 +01004357 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004358 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004359 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004360 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004361 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004362 ssl->in_msglen ) );
4363 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004364 }
4365
Hanno Beckere678eaa2018-08-21 14:57:46 +01004366 if( ssl->in_msg[0] != 1 )
4367 {
4368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4369 ssl->in_msg[0] ) );
4370 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4371 }
4372
4373#if defined(MBEDTLS_SSL_PROTO_DTLS)
4374 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4375 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4376 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4377 {
4378 if( ssl->handshake == NULL )
4379 {
4380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4381 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4382 }
4383
4384 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4385 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4386 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004387#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004388 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004390 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004391 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004392 if( ssl->in_msglen != 2 )
4393 {
4394 /* Note: Standard allows for more than one 2 byte alert
4395 to be packed in a single message, but Mbed TLS doesn't
4396 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004397 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004398 ssl->in_msglen ) );
4399 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4400 }
4401
Paul Elliott9f352112020-12-09 14:55:45 +00004402 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004403 ssl->in_msg[0], ssl->in_msg[1] ) );
4404
4405 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004406 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004408 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004410 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004411 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004412 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004413 }
4414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004415 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4416 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004417 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004418 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4419 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004420 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004421
4422#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4423 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4424 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4425 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004426 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004427 /* Will be handled when trying to parse ServerHello */
4428 return( 0 );
4429 }
4430#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004431 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004432 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004433 }
4434
Hanno Beckerc76c6192017-06-06 10:03:17 +01004435#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004436 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004437 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004438 /* Drop unexpected ApplicationData records,
4439 * except at the beginning of renegotiations */
4440 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4441 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4442#if defined(MBEDTLS_SSL_RENEGOTIATION)
4443 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4444 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004445#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004446 )
4447 {
4448 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4449 return( MBEDTLS_ERR_SSL_NON_FATAL );
4450 }
4451
4452 if( ssl->handshake != NULL &&
4453 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4454 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004455 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004456 }
4457 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004458#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004459
Paul Bakker5121ce52009-01-03 21:22:43 +00004460 return( 0 );
4461}
4462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004463int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004464{
irwir6c0da642019-09-26 21:07:41 +03004465 return( mbedtls_ssl_send_alert_message( ssl,
4466 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4467 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004468}
4469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004470int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004471 unsigned char level,
4472 unsigned char message )
4473{
Janos Follath865b3eb2019-12-16 11:46:15 +00004474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004475
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004476 if( ssl == NULL || ssl->conf == NULL )
4477 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004479 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004480 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004482 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004483 ssl->out_msglen = 2;
4484 ssl->out_msg[0] = level;
4485 ssl->out_msg[1] = message;
4486
Hanno Becker67bc7c32018-08-06 11:33:50 +01004487 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004488 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004489 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004490 return( ret );
4491 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004493
4494 return( 0 );
4495}
4496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004497int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004498{
Janos Follath865b3eb2019-12-16 11:46:15 +00004499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004501 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004503 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004504 ssl->out_msglen = 1;
4505 ssl->out_msg[0] = 1;
4506
Paul Bakker5121ce52009-01-03 21:22:43 +00004507 ssl->state++;
4508
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004509 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004510 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004511 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004512 return( ret );
4513 }
4514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004515 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004516
4517 return( 0 );
4518}
4519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004521{
Janos Follath865b3eb2019-12-16 11:46:15 +00004522 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004524 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004525
Hanno Becker327c93b2018-08-15 13:56:18 +01004526 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004527 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004528 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004529 return( ret );
4530 }
4531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004532 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004533 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004535 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4536 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004537 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004538 }
4539
Hanno Beckere678eaa2018-08-21 14:57:46 +01004540 /* CCS records are only accepted if they have length 1 and content '1',
4541 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004542
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004543 /*
4544 * Switch to our negotiated transform and session parameters for inbound
4545 * data.
4546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004548 ssl->transform_in = ssl->transform_negotiate;
4549 ssl->session_in = ssl->session_negotiate;
4550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004551#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004552 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004553 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004554#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004555 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004556#endif
4557
4558 /* Increment epoch */
4559 if( ++ssl->in_epoch == 0 )
4560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004562 /* This is highly unlikely to happen for legitimate reasons, so
4563 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004565 }
4566 }
4567 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004569 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004570
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004571 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004572
Paul Bakker5121ce52009-01-03 21:22:43 +00004573 ssl->state++;
4574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004576
4577 return( 0 );
4578}
4579
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004580/* Once ssl->out_hdr as the address of the beginning of the
4581 * next outgoing record is set, deduce the other pointers.
4582 *
4583 * Note: For TLS, we save the implicit record sequence number
4584 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4585 * and the caller has to make sure there's space for this.
4586 */
4587
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004588static size_t ssl_transform_get_explicit_iv_len(
4589 mbedtls_ssl_transform const *transform )
4590{
TRodziewiczef73f012021-05-13 14:53:36 +02004591 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004592 return( 0 );
4593
4594 return( transform->ivlen - transform->fixed_ivlen );
4595}
4596
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004597void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4598 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004599{
4600#if defined(MBEDTLS_SSL_PROTO_DTLS)
4601 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4602 {
4603 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004604#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004605 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004606 ssl->out_len = ssl->out_cid;
4607 if( transform != NULL )
4608 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004609#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004610 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004611#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004612 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004613 }
4614 else
4615#endif
4616 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004617 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004618#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004619 ssl->out_cid = ssl->out_len;
4620#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004621 ssl->out_iv = ssl->out_hdr + 5;
4622 }
4623
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004624 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004625 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004626 if( transform != NULL )
4627 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004628}
4629
4630/* Once ssl->in_hdr as the address of the beginning of the
4631 * next incoming record is set, deduce the other pointers.
4632 *
4633 * Note: For TLS, we save the implicit record sequence number
4634 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4635 * and the caller has to make sure there's space for this.
4636 */
4637
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004638void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004639{
Hanno Becker79594fd2019-05-08 09:38:41 +01004640 /* This function sets the pointers to match the case
4641 * of unprotected TLS/DTLS records, with both ssl->in_iv
4642 * and ssl->in_msg pointing to the beginning of the record
4643 * content.
4644 *
4645 * When decrypting a protected record, ssl->in_msg
4646 * will be shifted to point to the beginning of the
4647 * record plaintext.
4648 */
4649
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004650#if defined(MBEDTLS_SSL_PROTO_DTLS)
4651 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4652 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004653 /* This sets the header pointers to match records
4654 * without CID. When we receive a record containing
4655 * a CID, the fields are shifted accordingly in
4656 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004657 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004658#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004659 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004660 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004661#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004662 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004663#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004664 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004665 }
4666 else
4667#endif
4668 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004669 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004670 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004671#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004672 ssl->in_cid = ssl->in_len;
4673#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004674 ssl->in_iv = ssl->in_hdr + 5;
4675 }
4676
Hanno Becker79594fd2019-05-08 09:38:41 +01004677 /* This will be adjusted at record decryption time. */
4678 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004679}
4680
Paul Bakker5121ce52009-01-03 21:22:43 +00004681/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004682 * Setup an SSL context
4683 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004684
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004685void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004686{
4687 /* Set the incoming and outgoing record pointers. */
4688#if defined(MBEDTLS_SSL_PROTO_DTLS)
4689 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4690 {
4691 ssl->out_hdr = ssl->out_buf;
4692 ssl->in_hdr = ssl->in_buf;
4693 }
4694 else
4695#endif /* MBEDTLS_SSL_PROTO_DTLS */
4696 {
Hanno Becker12078f42021-03-02 15:28:41 +00004697 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004698 ssl->out_hdr = ssl->out_buf + 8;
4699 ssl->in_hdr = ssl->in_buf + 8;
4700 }
4701
4702 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004703 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4704 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004705}
4706
Paul Bakker5121ce52009-01-03 21:22:43 +00004707/*
4708 * SSL get accessors
4709 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004711{
4712 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4713}
4714
Hanno Becker8b170a02017-10-10 11:51:19 +01004715int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4716{
4717 /*
4718 * Case A: We're currently holding back
4719 * a message for further processing.
4720 */
4721
4722 if( ssl->keep_current_message == 1 )
4723 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004724 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004725 return( 1 );
4726 }
4727
4728 /*
4729 * Case B: Further records are pending in the current datagram.
4730 */
4731
4732#if defined(MBEDTLS_SSL_PROTO_DTLS)
4733 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4734 ssl->in_left > ssl->next_record_offset )
4735 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004736 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004737 return( 1 );
4738 }
4739#endif /* MBEDTLS_SSL_PROTO_DTLS */
4740
4741 /*
4742 * Case C: A handshake message is being processed.
4743 */
4744
Hanno Becker8b170a02017-10-10 11:51:19 +01004745 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4746 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004747 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004748 return( 1 );
4749 }
4750
4751 /*
4752 * Case D: An application data message is being processed
4753 */
4754 if( ssl->in_offt != NULL )
4755 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004756 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004757 return( 1 );
4758 }
4759
4760 /*
4761 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004762 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004763 * we implement support for multiple alerts in single records.
4764 */
4765
4766 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4767 return( 0 );
4768}
4769
Paul Bakker43ca69c2011-01-15 17:35:19 +00004770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004771int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004772{
Hanno Becker3136ede2018-08-17 15:28:19 +01004773 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004774 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004775 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004776
Hanno Becker5903de42019-05-03 14:46:38 +01004777 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4778
Hanno Becker78640902018-08-13 16:35:15 +01004779 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004780 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004782 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784 case MBEDTLS_MODE_GCM:
4785 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004786 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004787 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004788 transform_expansion = transform->minlen;
4789 break;
4790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004791 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004792
4793 block_size = mbedtls_cipher_get_block_size(
4794 &transform->cipher_ctx_enc );
4795
Hanno Becker3136ede2018-08-17 15:28:19 +01004796 /* Expansion due to the addition of the MAC. */
4797 transform_expansion += transform->maclen;
4798
4799 /* Expansion due to the addition of CBC padding;
4800 * Theoretically up to 256 bytes, but we never use
4801 * more than the block size of the underlying cipher. */
4802 transform_expansion += block_size;
4803
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004804 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004805 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004806#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004807 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004808#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004809
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004810 break;
4811
4812 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004813 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004815 }
4816
Hanno Beckera0e20d02019-05-15 14:03:01 +01004817#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004818 if( transform->out_cid_len != 0 )
4819 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004820#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004821
Hanno Becker5903de42019-05-03 14:46:38 +01004822 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004823}
4824
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004825#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004826/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004827 * Check record counters and renegotiate if they're above the limit.
4828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004829static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004830{
Hanno Beckerdd772292020-02-05 10:38:31 +00004831 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004832 int in_ctr_cmp;
4833 int out_ctr_cmp;
4834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4836 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004837 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004838 {
4839 return( 0 );
4840 }
4841
Andres AG2196c7f2016-12-15 17:01:16 +00004842 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08004843 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08004844 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004845 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
4846 &ssl->conf->renego_period[ep_len],
4847 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00004848
4849 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004850 {
4851 return( 0 );
4852 }
4853
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004854 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004855 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004856}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004858
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004859/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004860 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004861 * may only be sent for the purpose of initiating renegotiations.
4862 *
4863 * This function is introduced as a separate helper since the handling
4864 * of post-handshake handshake messages changes significantly in TLS 1.3,
4865 * and having a helper function allows to distinguish between TLS <= 1.2 and
4866 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
4867 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00004868static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004869{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01004870 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004871
4872 /*
4873 * - For client-side, expect SERVER_HELLO_REQUEST.
4874 * - For server-side, expect CLIENT_HELLO.
4875 * - Fail (TLS) or silently drop record (DTLS) in other cases.
4876 */
4877
4878#if defined(MBEDTLS_SSL_CLI_C)
4879 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4880 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
4881 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
4882 {
4883 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
4884
4885 /* With DTLS, drop the packet (probably from last handshake) */
4886#if defined(MBEDTLS_SSL_PROTO_DTLS)
4887 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4888 {
4889 return( 0 );
4890 }
4891#endif
4892 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4893 }
4894#endif /* MBEDTLS_SSL_CLI_C */
4895
4896#if defined(MBEDTLS_SSL_SRV_C)
4897 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4898 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
4899 {
4900 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
4901
4902 /* With DTLS, drop the packet (probably from last handshake) */
4903#if defined(MBEDTLS_SSL_PROTO_DTLS)
4904 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4905 {
4906 return( 0 );
4907 }
4908#endif
4909 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4910 }
4911#endif /* MBEDTLS_SSL_SRV_C */
4912
4913#if defined(MBEDTLS_SSL_RENEGOTIATION)
4914 /* Determine whether renegotiation attempt should be accepted */
4915 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
4916 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
4917 ssl->conf->allow_legacy_renegotiation ==
4918 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
4919 {
4920 /*
4921 * Accept renegotiation request
4922 */
4923
4924 /* DTLS clients need to know renego is server-initiated */
4925#if defined(MBEDTLS_SSL_PROTO_DTLS)
4926 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4927 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
4928 {
4929 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
4930 }
4931#endif
4932 ret = mbedtls_ssl_start_renegotiation( ssl );
4933 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
4934 ret != 0 )
4935 {
4936 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
4937 ret );
4938 return( ret );
4939 }
4940 }
4941 else
4942#endif /* MBEDTLS_SSL_RENEGOTIATION */
4943 {
4944 /*
4945 * Refuse renegotiation
4946 */
4947
4948 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
4949
TRodziewicz0f82ec62021-05-12 17:49:18 +02004950#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004951 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
4952 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
4953 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004954 {
TRodziewicz345165c2021-07-06 13:42:11 +02004955 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004956 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02004957#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004958 }
4959
4960 return( 0 );
4961}
4962
Paul Bakker48916f92012-09-16 19:57:18 +00004963/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004964 * Receive application data decrypted from the SSL layer
4965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00004967{
Janos Follath865b3eb2019-12-16 11:46:15 +00004968 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00004969 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00004970
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004971 if( ssl == NULL || ssl->conf == NULL )
4972 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004975
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004976#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004977 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004978 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004979 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004980 return( ret );
4981
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02004982 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004983 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02004984 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02004985 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02004986 return( ret );
4987 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004988 }
4989#endif
4990
Hanno Becker4a810fb2017-05-24 16:27:30 +01004991 /*
4992 * Check if renegotiation is necessary and/or handshake is
4993 * in process. If yes, perform/continue, and fall through
4994 * if an unexpected packet is received while the client
4995 * is waiting for the ServerHello.
4996 *
4997 * (There is no equivalent to the last condition on
4998 * the server-side as it is not treated as within
4999 * a handshake while waiting for the ClientHello
5000 * after a renegotiation request.)
5001 */
5002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005003#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005004 ret = ssl_check_ctr_renegotiate( ssl );
5005 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5006 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005007 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005008 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005009 return( ret );
5010 }
5011#endif
5012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005013 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005016 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5017 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005018 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005019 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005020 return( ret );
5021 }
5022 }
5023
Hanno Beckere41158b2017-10-23 13:30:32 +01005024 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005025 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005026 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005027 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005028 if( ssl->f_get_timer != NULL &&
5029 ssl->f_get_timer( ssl->p_timer ) == -1 )
5030 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005031 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005032 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005033
Hanno Becker327c93b2018-08-15 13:56:18 +01005034 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005035 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005036 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5037 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005038
Hanno Becker4a810fb2017-05-24 16:27:30 +01005039 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5040 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005041 }
5042
5043 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005044 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005045 {
5046 /*
5047 * OpenSSL sends empty messages to randomize the IV
5048 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005049 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005050 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005051 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005052 return( 0 );
5053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005054 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005055 return( ret );
5056 }
5057 }
5058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005060 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005061 ret = ssl_handle_hs_message_post_handshake( ssl );
5062 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005063 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005064 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5065 ret );
5066 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005067 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005068
Hanno Beckerf26cc722021-04-21 07:30:13 +01005069 /* At this point, we don't know whether the renegotiation triggered
5070 * by the post-handshake message has been completed or not. The cases
5071 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005072 * 1) The renegotiation is complete. In this case, no new record
5073 * has been read yet.
5074 * 2) The renegotiation is incomplete because the client received
5075 * an application data record while awaiting the ServerHello.
5076 * 3) The renegotiation is incomplete because the client received
5077 * a non-handshake, non-application data message while awaiting
5078 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005079 *
5080 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005081 * - For 1), the next iteration will read a new record and check
5082 * if it's application data.
5083 * - For 2), the loop condition isn't satisfied as application data
5084 * is present, hence continue is the same as break
5085 * - For 3), the loop condition is satisfied and read_record
5086 * will re-deliver the message that was held back by the client
5087 * when expecting the ServerHello.
5088 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005089
Hanno Becker90333da2017-10-10 11:27:13 +01005090 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005091 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005092#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005093 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005094 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005095 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005096 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005097 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005098 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005099 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005100 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005101 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005102 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005103 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005104 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005107 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5108 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005109 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005111 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005112 }
5113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005114 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005115 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005116 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5117 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005118 }
5119
5120 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005121
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005122 /* We're going to return something now, cancel timer,
5123 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005124 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005125 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005126
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005127#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005128 /* If we requested renego but received AppData, resend HelloRequest.
5129 * Do it now, after setting in_offt, to avoid taking this branch
5130 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005131#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005132 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005133 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005134 {
Hanno Becker786300f2020-02-05 10:46:40 +00005135 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005136 {
Hanno Becker786300f2020-02-05 10:46:40 +00005137 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5138 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005139 return( ret );
5140 }
5141 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005142#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005143#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005144 }
5145
5146 n = ( len < ssl->in_msglen )
5147 ? len : ssl->in_msglen;
5148
5149 memcpy( buf, ssl->in_offt, n );
5150 ssl->in_msglen -= n;
5151
gabor-mezei-arma3214132020-07-15 10:55:00 +02005152 /* Zeroising the plaintext buffer to erase unused application data
5153 from the memory. */
5154 mbedtls_platform_zeroize( ssl->in_offt, n );
5155
Paul Bakker5121ce52009-01-03 21:22:43 +00005156 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005157 {
5158 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005159 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005160 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005161 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005162 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005163 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005164 /* more data available */
5165 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005166 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005168 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005169
Paul Bakker23986e52011-04-24 08:57:21 +00005170 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005171}
5172
5173/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005174 * Send application data to be encrypted by the SSL layer, taking care of max
5175 * fragment length and buffer size.
5176 *
5177 * According to RFC 5246 Section 6.2.1:
5178 *
5179 * Zero-length fragments of Application data MAY be sent as they are
5180 * potentially useful as a traffic analysis countermeasure.
5181 *
5182 * Therefore, it is possible that the input message length is 0 and the
5183 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005184 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005185static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005186 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005187{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005188 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5189 const size_t max_len = (size_t) ret;
5190
5191 if( ret < 0 )
5192 {
5193 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5194 return( ret );
5195 }
5196
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005197 if( len > max_len )
5198 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005200 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005201 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005202 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005203 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5204 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005205 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005206 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005207 }
5208 else
5209#endif
5210 len = max_len;
5211 }
Paul Bakker887bd502011-06-08 13:10:54 +00005212
Paul Bakker5121ce52009-01-03 21:22:43 +00005213 if( ssl->out_left != 0 )
5214 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005215 /*
5216 * The user has previously tried to send the data and
5217 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5218 * written. In this case, we expect the high-level write function
5219 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005221 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005222 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005223 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005224 return( ret );
5225 }
5226 }
Paul Bakker887bd502011-06-08 13:10:54 +00005227 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005228 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005229 /*
5230 * The user is trying to send a message the first time, so we need to
5231 * copy the data into the internal buffers and setup the data structure
5232 * to keep track of partial writes
5233 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005234 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005235 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005236 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005237
Hanno Becker67bc7c32018-08-06 11:33:50 +01005238 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005239 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005240 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005241 return( ret );
5242 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005243 }
5244
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005245 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005246}
5247
5248/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005249 * Write application data (public-facing wrapper)
5250 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005251int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005252{
Janos Follath865b3eb2019-12-16 11:46:15 +00005253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005254
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005255 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005256
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005257 if( ssl == NULL || ssl->conf == NULL )
5258 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5259
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005260#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005261 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5262 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005263 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005264 return( ret );
5265 }
5266#endif
5267
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005268 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005269 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005270 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005271 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005272 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005273 return( ret );
5274 }
5275 }
5276
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005277 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005278
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005279 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005280
5281 return( ret );
5282}
5283
5284/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005285 * Notify the peer that the connection is being closed
5286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005287int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005288{
Janos Follath865b3eb2019-12-16 11:46:15 +00005289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005290
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005291 if( ssl == NULL || ssl->conf == NULL )
5292 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5293
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005294 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005295
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005296 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005297 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005299 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005300 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005301 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5302 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5303 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005304 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005305 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005306 return( ret );
5307 }
5308 }
5309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005310 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005311
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005312 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005313}
5314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005315void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005316{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005317 if( transform == NULL )
5318 return;
5319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005320 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5321 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005322
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005323#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005324 mbedtls_md_free( &transform->md_ctx_enc );
5325 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005326#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005327
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005328 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005329}
5330
Jerry Yuc7875b52021-09-05 21:05:50 +08005331void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5332 mbedtls_ssl_transform *transform )
5333{
Jerry Yuc7875b52021-09-05 21:05:50 +08005334 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005335 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005336}
5337
5338void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5339 mbedtls_ssl_transform *transform )
5340{
5341 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005342 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005343}
5344
Hanno Becker0271f962018-08-16 13:23:47 +01005345#if defined(MBEDTLS_SSL_PROTO_DTLS)
5346
Hanno Becker533ab5f2020-02-05 10:49:13 +00005347void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005348{
5349 unsigned offset;
5350 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5351
5352 if( hs == NULL )
5353 return;
5354
Hanno Becker283f5ef2018-08-24 09:34:47 +01005355 ssl_free_buffered_record( ssl );
5356
Hanno Becker0271f962018-08-16 13:23:47 +01005357 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005358 ssl_buffering_free_slot( ssl, offset );
5359}
5360
5361static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5362 uint8_t slot )
5363{
5364 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5365 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005366
5367 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5368 return;
5369
Hanno Beckere605b192018-08-21 15:59:07 +01005370 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005371 {
Hanno Beckere605b192018-08-21 15:59:07 +01005372 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005373 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005374 mbedtls_free( hs_buf->data );
5375 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005376 }
5377}
5378
5379#endif /* MBEDTLS_SSL_PROTO_DTLS */
5380
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005381/*
5382 * Convert version numbers to/from wire format
5383 * and, for DTLS, to/from TLS equivalent.
5384 *
5385 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005386 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005387 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005389void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005390 unsigned char ver[2] )
5391{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005392#if defined(MBEDTLS_SSL_PROTO_DTLS)
5393 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005394 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005396 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5397
5398 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5399 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5400 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005401 else
5402#else
5403 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005404#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005405 {
5406 ver[0] = (unsigned char) major;
5407 ver[1] = (unsigned char) minor;
5408 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005409}
5410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005411void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005412 const unsigned char ver[2] )
5413{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005414#if defined(MBEDTLS_SSL_PROTO_DTLS)
5415 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005416 {
5417 *major = 255 - ver[0] + 2;
5418 *minor = 255 - ver[1] + 1;
5419
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005420 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005421 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5422 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005423 else
5424#else
5425 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005426#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005427 {
5428 *major = ver[0];
5429 *minor = ver[1];
5430 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005431}
5432
Jerry Yue7047812021-09-13 19:26:39 +08005433/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005434 * Send pending fatal alert.
5435 * 0, No alert message.
5436 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5437 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005438 */
5439int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5440{
5441 int ret;
5442
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005443 /* No pending alert, return success*/
5444 if( ssl->send_alert == 0 )
5445 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005446
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005447 ret = mbedtls_ssl_send_alert_message( ssl,
5448 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5449 ssl->alert_type );
5450
Jerry Yu3bf1f972021-09-22 21:37:18 +08005451 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5452 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005453 */
5454 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5455 {
5456 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005457 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005458
5459 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005460 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005461
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005462 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005463}
5464
Jerry Yu394ece62021-09-14 22:17:21 +08005465/*
5466 * Set pending fatal alert flag.
5467 */
5468void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5469 unsigned char alert_type,
5470 int alert_reason )
5471{
5472 ssl->send_alert = 1;
5473 ssl->alert_type = alert_type;
5474 ssl->alert_reason = alert_reason;
5475}
5476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477#endif /* MBEDTLS_SSL_TLS_C */