blob: e41455c6c57bf8371f30bbfc5799f2966c824278 [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];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100668 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker992b6872017-11-09 18:57:39 +0000669
TRodziewicz345165c2021-07-06 13:42:11 +0200670 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000671 transform->minor_ver,
672 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000673
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100674 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
675 add_data_len );
676 if( ret != 0 )
677 goto hmac_failed_etm_disabled;
678 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
679 if( ret != 0 )
680 goto hmac_failed_etm_disabled;
681 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
682 if( ret != 0 )
683 goto hmac_failed_etm_disabled;
684 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
685 if( ret != 0 )
686 goto hmac_failed_etm_disabled;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000687
TRodziewicz345165c2021-07-06 13:42:11 +0200688 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200689#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200690
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000691 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
692 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200693
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000694 rec->data_len += transform->maclen;
695 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100696 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100697
698 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100699 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100700 if( ret != 0 )
701 {
702 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
703 return( ret );
704 }
Paul Bakker577e0062013-08-28 11:57:20 +0200705 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000706#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000707
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200708 /*
709 * Encrypt
710 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000711#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000713 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000714 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000715 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000716 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000717 "including %d bytes of padding",
718 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000719
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000720 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
721 transform->iv_enc, transform->ivlen,
722 data, rec->data_len,
723 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200724 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200726 return( ret );
727 }
728
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000729 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200730 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200731 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
732 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200733 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000734 }
Paul Bakker68884e32013-01-07 18:20:04 +0100735 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000736#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000737
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200738#if defined(MBEDTLS_GCM_C) || \
739 defined(MBEDTLS_CCM_C) || \
740 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200742 mode == MBEDTLS_MODE_CCM ||
743 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000744 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000745 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200746 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100747 unsigned char *dynamic_iv;
748 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100749 int dynamic_iv_is_explicit =
750 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000751
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100752 /* Check that there's space for the authentication tag. */
753 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000754 {
755 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
756 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
757 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000758
Paul Bakker68884e32013-01-07 18:20:04 +0100759 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100760 * Build nonce for AEAD encryption.
761 *
762 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
763 * part of the IV is prepended to the ciphertext and
764 * can be chosen freely - in particular, it need not
765 * agree with the record sequence number.
766 * However, since ChaChaPoly as well as all AEAD modes
767 * in TLS 1.3 use the record sequence number as the
768 * dynamic part of the nonce, we uniformly use the
769 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100770 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100771 dynamic_iv = rec->ctr;
772 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200773
Hanno Becker17263802020-05-28 07:05:48 +0100774 ssl_build_record_nonce( iv, sizeof( iv ),
775 transform->iv_enc,
776 transform->fixed_ivlen,
777 dynamic_iv,
778 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100779
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100780 /*
781 * Build additional data for AEAD encryption.
782 * This depends on the TLS version.
783 */
784 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000785 transform->minor_ver,
786 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100787
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200788 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100789 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200790 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100791 dynamic_iv,
792 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000793 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100794 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000795 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200796 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000797 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000798
Paul Bakker68884e32013-01-07 18:20:04 +0100799 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200800 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200801 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000802
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100803 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100805 add_data, add_data_len,
806 data, rec->data_len, /* src */
807 data, rec->buf_len - (data - rec->buf), /* dst */
808 &rec->data_len,
809 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200810 {
TRodziewicz18efb732021-04-29 23:12:19 +0200811 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200812 return( ret );
813 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000814 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100815 data + rec->data_len - transform->taglen,
816 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100817 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000818 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100819
820 /*
821 * Prefix record content with dynamic IV in case it is explicit.
822 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100823 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100824 {
825 if( rec->data_offset < dynamic_iv_len )
826 {
827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
828 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
829 }
830
831 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
832 rec->data_offset -= dynamic_iv_len;
833 rec->data_len += dynamic_iv_len;
834 }
835
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100836 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000837 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000838 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100839#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200840#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000842 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 size_t padlen, i;
845 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000846
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000847 /* Currently we're always using minimal padding
848 * (up to 255 bytes would be allowed). */
849 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
850 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000851 padlen = 0;
852
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 /* Check there's enough space in the buffer for the padding. */
854 if( post_avail < padlen + 1 )
855 {
856 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
857 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
858 }
859
Paul Bakker5121ce52009-01-03 21:22:43 +0000860 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000861 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000862
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 rec->data_len += padlen + 1;
864 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000865
TRodziewicz0f82ec62021-05-12 17:49:18 +0200866#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000867 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200868 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000869 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000870 */
TRodziewicz345165c2021-07-06 13:42:11 +0200871 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000872 {
TRodziewicz345165c2021-07-06 13:42:11 +0200873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
874 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000875 }
TRodziewicz345165c2021-07-06 13:42:11 +0200876
877 if( rec->data_offset < transform->ivlen )
878 {
879 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
880 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
881 }
882
883 /*
884 * Generate IV
885 */
886 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
887 if( ret != 0 )
888 return( ret );
889
890 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200891#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000892
Paul Elliottd48d5c62021-01-07 14:47:05 +0000893 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
894 "including %" MBEDTLS_PRINTF_SIZET
895 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200897 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000898
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000899 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
900 transform->iv_enc,
901 transform->ivlen,
902 data, rec->data_len,
903 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200904 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200906 return( ret );
907 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200908
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200910 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
912 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200913 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200914
TRodziewicz0f82ec62021-05-12 17:49:18 +0200915 data -= transform->ivlen;
916 rec->data_offset -= transform->ivlen;
917 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100920 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100921 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000922 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
923
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100924 /*
925 * MAC(MAC_write_key, seq_num +
926 * TLSCipherText.type +
927 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100928 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200929 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100930 * ENC(content + padding + padding_length));
931 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932
933 if( post_avail < transform->maclen)
934 {
935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
936 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
937 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100938
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100939 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000940 rec, transform->minor_ver,
941 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000944 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100945 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100946
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100947 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
948 add_data_len );
949 if( ret != 0 )
950 goto hmac_failed_etm_enabled;
951 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
952 data, rec->data_len );
953 if( ret != 0 )
954 goto hmac_failed_etm_enabled;
955 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
956 if( ret != 0 )
957 goto hmac_failed_etm_enabled;
958 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
959 if( ret != 0 )
960 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100961
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000962 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100963
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000964 rec->data_len += transform->maclen;
965 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100966 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100967
968 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100969 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100970 if( ret != 0 )
971 {
972 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
973 return( ret );
974 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100975 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000977 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200978 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200979#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200980 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
982 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200983 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000984
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100985 /* Make extra sure authentication was performed, exactly once */
986 if( auth_done != 1 )
987 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
989 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100990 }
991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000993
994 return( 0 );
995}
996
Hanno Becker605949f2019-07-12 08:23:59 +0100997int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +0000998 mbedtls_ssl_transform *transform,
999 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001000{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001001 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001003 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001004#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001005 size_t padlen = 0, correct = 1;
1006#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001007 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001008 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001009 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001010
Hanno Beckera18d1322018-01-03 14:27:32 +00001011#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001012 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001013 ((void) ssl);
1014#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001017 if( rec == NULL ||
1018 rec->buf == NULL ||
1019 rec->buf_len < rec->data_offset ||
1020 rec->buf_len - rec->data_offset < rec->data_len )
1021 {
1022 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001024 }
1025
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001026 data = rec->buf + rec->data_offset;
1027 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001028
Hanno Beckera0e20d02019-05-15 14:03:01 +01001029#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001030 /*
1031 * Match record's CID with incoming CID.
1032 */
Hanno Becker938489a2019-05-08 13:02:22 +01001033 if( rec->cid_len != transform->in_cid_len ||
1034 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1035 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001036 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001037 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001038#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001039
Hanno Beckerd086bf02021-03-22 13:01:27 +00001040#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001042 {
1043 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001044 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1045 transform->iv_dec,
1046 transform->ivlen,
1047 data, rec->data_len,
1048 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001049 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001051 return( ret );
1052 }
1053
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001054 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001055 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1057 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001058 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001059 }
Paul Bakker68884e32013-01-07 18:20:04 +01001060 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001061#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001062#if defined(MBEDTLS_GCM_C) || \
1063 defined(MBEDTLS_CCM_C) || \
1064 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001066 mode == MBEDTLS_MODE_CCM ||
1067 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001068 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001069 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001070 unsigned char *dynamic_iv;
1071 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001072
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001073 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001074 * Extract dynamic part of nonce for AEAD decryption.
1075 *
1076 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1077 * part of the IV is prepended to the ciphertext and
1078 * can be chosen freely - in particular, it need not
1079 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001080 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001081 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001082 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001083 {
1084 if( rec->data_len < dynamic_iv_len )
1085 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001086 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1087 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001088 rec->data_len,
1089 dynamic_iv_len ) );
1090 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1091 }
1092 dynamic_iv = data;
1093
1094 data += dynamic_iv_len;
1095 rec->data_offset += dynamic_iv_len;
1096 rec->data_len -= dynamic_iv_len;
1097 }
Hanno Becker17263802020-05-28 07:05:48 +01001098 else
1099 {
1100 dynamic_iv = rec->ctr;
1101 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001102
1103 /* Check that there's space for the authentication tag. */
1104 if( rec->data_len < transform->taglen )
1105 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1107 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001108 rec->data_len,
1109 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001111 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001112 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001113
Hanno Beckerdf8be222020-05-21 15:30:57 +01001114 /*
1115 * Prepare nonce from dynamic and static parts.
1116 */
Hanno Becker17263802020-05-28 07:05:48 +01001117 ssl_build_record_nonce( iv, sizeof( iv ),
1118 transform->iv_dec,
1119 transform->fixed_ivlen,
1120 dynamic_iv,
1121 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001122
Hanno Beckerdf8be222020-05-21 15:30:57 +01001123 /*
1124 * Build additional data for AEAD encryption.
1125 * This depends on the TLS version.
1126 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001127 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001128 transform->minor_ver,
1129 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001130 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001131 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001132
Hanno Beckerd96a6522019-07-10 13:55:25 +01001133 /* Because of the check above, we know that there are
1134 * explicit_iv_len Bytes preceeding data, and taglen
1135 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001136 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001137 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001138
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001139 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001140 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001141 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001142
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001143 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001144 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001145 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001146 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001147 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001148 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001149 data, rec->data_len + transform->taglen, /* src */
1150 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001151 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001152 {
TRodziewicz18efb732021-04-29 23:12:19 +02001153 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1156 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001157
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001158 return( ret );
1159 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001160 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001161
Hanno Beckerd96a6522019-07-10 13:55:25 +01001162 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001163 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001164 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1166 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001167 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001168 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001169 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001171#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001173 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001174 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001175
Paul Bakker5121ce52009-01-03 21:22:43 +00001176 /*
Paul Bakker45829992013-01-03 14:52:21 +01001177 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001178 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001179#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001180 /* The ciphertext is prefixed with the CBC IV. */
1181 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001182#endif
Paul Bakker45829992013-01-03 14:52:21 +01001183
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001184 /* Size considerations:
1185 *
1186 * - The CBC cipher text must not be empty and hence
1187 * at least of size transform->ivlen.
1188 *
1189 * Together with the potential IV-prefix, this explains
1190 * the first of the two checks below.
1191 *
1192 * - The record must contain a MAC, either in plain or
1193 * encrypted, depending on whether Encrypt-then-MAC
1194 * is used or not.
1195 * - If it is, the message contains the IV-prefix,
1196 * the CBC ciphertext, and the MAC.
1197 * - If it is not, the padded plaintext, and hence
1198 * the CBC ciphertext, has at least length maclen + 1
1199 * because there is at least the padding length byte.
1200 *
1201 * As the CBC ciphertext is not empty, both cases give the
1202 * lower bound minlen + maclen + 1 on the record size, which
1203 * we test for in the second check below.
1204 */
1205 if( rec->data_len < minlen + transform->ivlen ||
1206 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001207 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001208 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1209 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1210 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001211 "+ 1 ) ( + expl IV )", rec->data_len,
1212 transform->ivlen,
1213 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001215 }
1216
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001217 /*
1218 * Authenticate before decrypt if enabled
1219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001221 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001222 {
Hanno Becker992b6872017-11-09 18:57:39 +00001223 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001226
Hanno Beckerd96a6522019-07-10 13:55:25 +01001227 /* Update data_len in tandem with add_data.
1228 *
1229 * The subtraction is safe because of the previous check
1230 * data_len >= minlen + maclen + 1.
1231 *
1232 * Afterwards, we know that data + data_len is followed by at
1233 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001234 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001235 *
1236 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001237 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001238 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001239 transform->minor_ver,
1240 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001241
Hanno Beckerd96a6522019-07-10 13:55:25 +01001242 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001243 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1244 add_data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001245 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1246 add_data_len );
1247 if( ret != 0 )
1248 goto hmac_failed_etm_enabled;
1249 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001250 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001251 if( ret != 0 )
1252 goto hmac_failed_etm_enabled;
1253 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1254 if( ret != 0 )
1255 goto hmac_failed_etm_enabled;
1256 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1257 if( ret != 0 )
1258 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001259
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001260 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1261 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001262 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001263 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001264
Hanno Beckerd96a6522019-07-10 13:55:25 +01001265 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001266 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001267 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001268 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001270 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1271 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001272 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001273 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001274
1275 hmac_failed_etm_enabled:
1276 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1277 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001278 {
1279 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1280 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001281 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001282 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001283 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001285
1286 /*
1287 * Check length sanity
1288 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001289
1290 /* We know from above that data_len > minlen >= 0,
1291 * so the following check in particular implies that
1292 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001293 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001294 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001295 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1296 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001297 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001298 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001299 }
1300
TRodziewicz0f82ec62021-05-12 17:49:18 +02001301#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001302 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001303 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001304 */
TRodziewicz345165c2021-07-06 13:42:11 +02001305 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1306 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001307
TRodziewicz345165c2021-07-06 13:42:11 +02001308 data += transform->ivlen;
1309 rec->data_offset += transform->ivlen;
1310 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001311#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001312
Hanno Beckerd96a6522019-07-10 13:55:25 +01001313 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1314
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001315 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1316 transform->iv_dec, transform->ivlen,
1317 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001318 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001320 return( ret );
1321 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001322
Hanno Beckerd96a6522019-07-10 13:55:25 +01001323 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001325 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1327 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001328 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001329
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001330 /* Safe since data_len >= minlen + maclen + 1, so after having
1331 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001332 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1333 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001334 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001335
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001336 if( auth_done == 1 )
1337 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001338 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001339 rec->data_len,
1340 padlen + 1 );
1341 correct &= mask;
1342 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001343 }
1344 else
Paul Bakker45829992013-01-03 14:52:21 +01001345 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001347 if( rec->data_len < transform->maclen + padlen + 1 )
1348 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1350 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1351 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001352 rec->data_len,
1353 transform->maclen,
1354 padlen + 1 ) );
1355 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001356#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001357
Gabor Mezei90437e32021-10-20 11:59:27 +02001358 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001359 rec->data_len,
1360 transform->maclen + padlen + 1 );
1361 correct &= mask;
1362 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001363 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001364
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001365 padlen++;
1366
1367 /* Regardless of the validity of the padding,
1368 * we have data_len >= padlen here. */
1369
TRodziewicz0f82ec62021-05-12 17:49:18 +02001370#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001371 /* The padding check involves a series of up to 256
1372 * consecutive memory reads at the end of the record
1373 * plaintext buffer. In order to hide the length and
1374 * validity of the padding, always perform exactly
1375 * `min(256,plaintext_len)` reads (but take into account
1376 * only the last `padlen` bytes for the padding check). */
1377 size_t pad_count = 0;
1378 volatile unsigned char* const check = data;
1379
1380 /* Index of first padding byte; it has been ensured above
1381 * that the subtraction is safe. */
1382 size_t const padding_idx = rec->data_len - padlen;
1383 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1384 size_t const start_idx = rec->data_len - num_checks;
1385 size_t idx;
1386
1387 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001388 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001389 /* pad_count += (idx >= padding_idx) &&
1390 * (check[idx] == padlen - 1);
1391 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001392 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1393 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001394 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001395 pad_count += mask & equal;
1396 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001397 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001399#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001400 if( padlen > 0 && correct == 0 )
1401 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001402#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001403 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001404
TRodziewicz0f82ec62021-05-12 17:49:18 +02001405#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001406
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001407 /* If the padding was found to be invalid, padlen == 0
1408 * and the subtraction is safe. If the padding was found valid,
1409 * padlen hasn't been changed and the previous assertion
1410 * data_len >= padlen still holds. */
1411 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001412 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001413 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001415 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1417 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001418 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001419
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001420#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001422 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001423#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001424
1425 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001426 * Authenticate if not done yet.
1427 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001428 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001429#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001430 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001431 {
Hanno Becker992b6872017-11-09 18:57:39 +00001432 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001433 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001434
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001435 /* If the initial value of padlen was such that
1436 * data_len < maclen + padlen + 1, then padlen
1437 * got reset to 1, and the initial check
1438 * data_len >= minlen + maclen + 1
1439 * guarantees that at this point we still
1440 * have at least data_len >= maclen.
1441 *
1442 * If the initial value of padlen was such that
1443 * data_len >= maclen + padlen + 1, then we have
1444 * subtracted either padlen + 1 (if the padding was correct)
1445 * or 0 (if the padding was incorrect) since then,
1446 * hence data_len >= maclen in any case.
1447 */
1448 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001449 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001450 transform->minor_ver,
1451 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001452
TRodziewicz0f82ec62021-05-12 17:49:18 +02001453#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001454 /*
1455 * The next two sizes are the minimum and maximum values of
1456 * data_len over all padlen values.
1457 *
1458 * They're independent of padlen, since we previously did
1459 * data_len -= padlen.
1460 *
1461 * Note that max_len + maclen is never more than the buffer
1462 * length, as we previously did in_msglen -= maclen too.
1463 */
1464 const size_t max_len = rec->data_len + padlen;
1465 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1466
Gabor Mezei90437e32021-10-20 11:59:27 +02001467 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001468 add_data, add_data_len,
1469 data, rec->data_len, min_len, max_len,
1470 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001471 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001472 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001473 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001474 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001475 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001476
Gabor Mezei90437e32021-10-20 11:59:27 +02001477 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001478 rec->data_len,
1479 min_len, max_len,
1480 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001481#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001482
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001483#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001485 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001486#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001487
Gabor Mezei90437e32021-10-20 11:59:27 +02001488 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001489 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001490 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491#if defined(MBEDTLS_SSL_DEBUG_ALL)
1492 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001493#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001494 correct = 0;
1495 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001496 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001497
1498 hmac_failed_etm_disabled:
1499 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1500 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1501 if( ret != 0 )
1502 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001503 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001504
1505 /*
1506 * Finally check the correct flag
1507 */
1508 if( correct == 0 )
1509 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001510#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001511
1512 /* Make extra sure authentication was performed, exactly once */
1513 if( auth_done != 1 )
1514 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1516 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001517 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001518
Hanno Beckerccc13d02020-05-04 12:30:04 +01001519#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1520 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1521 {
1522 /* Remove inner padding and infer true content type. */
1523 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1524 &rec->type );
1525
1526 if( ret != 0 )
1527 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1528 }
1529#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1530
Hanno Beckera0e20d02019-05-15 14:03:01 +01001531#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001532 if( rec->cid_len != 0 )
1533 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001534 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1535 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001536 if( ret != 0 )
1537 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1538 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001539#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001542
1543 return( 0 );
1544}
1545
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001546#undef MAC_NONE
1547#undef MAC_PLAINTEXT
1548#undef MAC_CIPHERTEXT
1549
Paul Bakker5121ce52009-01-03 21:22:43 +00001550/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001551 * Fill the input message buffer by appending data to it.
1552 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001553 *
1554 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1555 * available (from this read and/or a previous one). Otherwise, an error code
1556 * is returned (possibly EOF or WANT_READ).
1557 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001558 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1559 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1560 * since we always read a whole datagram at once.
1561 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001562 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001563 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001566{
Janos Follath865b3eb2019-12-16 11:46:15 +00001567 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001568 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001569#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1570 size_t in_buf_len = ssl->in_buf_len;
1571#else
1572 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1573#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001576
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001577 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1578 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001580 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001582 }
1583
Darryl Greenb33cc762019-11-28 14:29:44 +00001584 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001585 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1587 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001588 }
1589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001591 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001592 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001593 uint32_t timeout;
1594
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001595 /*
1596 * The point is, we need to always read a full datagram at once, so we
1597 * sometimes read more then requested, and handle the additional data.
1598 * It could be the rest of the current record (while fetching the
1599 * header) and/or some other records in the same datagram.
1600 */
1601
1602 /*
1603 * Move to the next record in the already read datagram if applicable
1604 */
1605 if( ssl->next_record_offset != 0 )
1606 {
1607 if( ssl->in_left < ssl->next_record_offset )
1608 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1610 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001611 }
1612
1613 ssl->in_left -= ssl->next_record_offset;
1614
1615 if( ssl->in_left != 0 )
1616 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1618 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001619 ssl->next_record_offset ) );
1620 memmove( ssl->in_hdr,
1621 ssl->in_hdr + ssl->next_record_offset,
1622 ssl->in_left );
1623 }
1624
1625 ssl->next_record_offset = 0;
1626 }
1627
Paul Elliottd48d5c62021-01-07 14:47:05 +00001628 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1629 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001630 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001631
1632 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001633 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001634 */
1635 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001638 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001639 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001640
1641 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001642 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001643 * are not at the beginning of a new record, the caller did something
1644 * wrong.
1645 */
1646 if( ssl->in_left != 0 )
1647 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1649 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001650 }
1651
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001652 /*
1653 * Don't even try to read if time's out already.
1654 * This avoids by-passing the timer when repeatedly receiving messages
1655 * that will end up being dropped.
1656 */
Hanno Becker7876d122020-02-05 10:39:31 +00001657 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001658 {
1659 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001660 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001661 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001662 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001663 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001664 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001667 timeout = ssl->handshake->retransmit_timeout;
1668 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001669 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001670
Paul Elliott9f352112020-12-09 14:55:45 +00001671 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001672
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001673 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001674 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1675 timeout );
1676 else
1677 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001680
1681 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001683 }
1684
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001685 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001688 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001691 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001692 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1693 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001695 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001696 }
1697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001698 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001699 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001701 return( ret );
1702 }
1703
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001704 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001705 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001707 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001709 {
Hanno Becker786300f2020-02-05 10:46:40 +00001710 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001711 {
Hanno Becker786300f2020-02-05 10:46:40 +00001712 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1713 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001714 return( ret );
1715 }
1716
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001717 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001718 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001720 }
1721
Paul Bakker5121ce52009-01-03 21:22:43 +00001722 if( ret < 0 )
1723 return( ret );
1724
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001725 ssl->in_left = ret;
1726 }
1727 else
1728#endif
1729 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001730 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1731 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001732 ssl->in_left, nb_want ) );
1733
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001734 while( ssl->in_left < nb_want )
1735 {
1736 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001737
Hanno Becker7876d122020-02-05 10:39:31 +00001738 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001739 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1740 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001741 {
1742 if( ssl->f_recv_timeout != NULL )
1743 {
1744 ret = ssl->f_recv_timeout( ssl->p_bio,
1745 ssl->in_hdr + ssl->in_left, len,
1746 ssl->conf->read_timeout );
1747 }
1748 else
1749 {
1750 ret = ssl->f_recv( ssl->p_bio,
1751 ssl->in_hdr + ssl->in_left, len );
1752 }
1753 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001754
Paul Elliottd48d5c62021-01-07 14:47:05 +00001755 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1756 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001757 ssl->in_left, nb_want ) );
1758 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001759
1760 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001762
1763 if( ret < 0 )
1764 return( ret );
1765
makise-homuraaf9513b2020-08-24 18:26:27 +03001766 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001767 {
Darryl Green11999bb2018-03-13 15:22:58 +00001768 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001769 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001770 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001771 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1772 }
1773
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001774 ssl->in_left += ret;
1775 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001776 }
1777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001779
1780 return( 0 );
1781}
1782
1783/*
1784 * Flush any data not yet written
1785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001787{
Janos Follath865b3eb2019-12-16 11:46:15 +00001788 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001789 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001792
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001793 if( ssl->f_send == NULL )
1794 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001796 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001798 }
1799
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001800 /* Avoid incrementing counter if data is flushed */
1801 if( ssl->out_left == 0 )
1802 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001804 return( 0 );
1805 }
1806
Paul Bakker5121ce52009-01-03 21:22:43 +00001807 while( ssl->out_left > 0 )
1808 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1810 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001811 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001812
Hanno Becker2b1e3542018-08-06 11:19:13 +01001813 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001814 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001817
1818 if( ret <= 0 )
1819 return( ret );
1820
makise-homuraaf9513b2020-08-24 18:26:27 +03001821 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001822 {
Darryl Green11999bb2018-03-13 15:22:58 +00001823 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001824 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001825 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001826 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1827 }
1828
Paul Bakker5121ce52009-01-03 21:22:43 +00001829 ssl->out_left -= ret;
1830 }
1831
Hanno Becker2b1e3542018-08-06 11:19:13 +01001832#if defined(MBEDTLS_SSL_PROTO_DTLS)
1833 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001834 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001835 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001836 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001837 else
1838#endif
1839 {
1840 ssl->out_hdr = ssl->out_buf + 8;
1841 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001842 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001845
1846 return( 0 );
1847}
1848
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001849/*
1850 * Functions to handle the DTLS retransmission state machine
1851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001852#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001853/*
1854 * Append current handshake message to current outgoing flight
1855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001857{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1860 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1861 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001862
1863 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001864 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001865 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001866 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001867 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001868 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001869 }
1870
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001871 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001872 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1874 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001876 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001877 }
1878
1879 /* Copy current handshake message with headers */
1880 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1881 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001882 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001883 msg->next = NULL;
1884
1885 /* Append to the current flight */
1886 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001887 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001888 else
1889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001891 while( cur->next != NULL )
1892 cur = cur->next;
1893 cur->next = msg;
1894 }
1895
Hanno Becker3b235902018-08-06 09:54:53 +01001896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001897 return( 0 );
1898}
1899
1900/*
1901 * Free the current flight of handshake messages
1902 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001903void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001904{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 mbedtls_ssl_flight_item *cur = flight;
1906 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001907
1908 while( cur != NULL )
1909 {
1910 next = cur->next;
1911
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 mbedtls_free( cur->p );
1913 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001914
1915 cur = next;
1916 }
1917}
1918
1919/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001920 * Swap transform_out and out_ctr with the alternative ones
1921 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001922static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001923{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08001925 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001926
1927 if( ssl->transform_out == ssl->handshake->alt_transform_out )
1928 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001930 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001931 }
1932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001934
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001935 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001936 tmp_transform = ssl->transform_out;
1937 ssl->transform_out = ssl->handshake->alt_transform_out;
1938 ssl->handshake->alt_transform_out = tmp_transform;
1939
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001940 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08001941 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
1942 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
1943 sizeof( ssl->cur_out_ctr ) );
1944 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
1945 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001946
1947 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001948 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001949
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001950 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001951}
1952
1953/*
1954 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001955 */
1956int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
1957{
1958 int ret = 0;
1959
1960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
1961
1962 ret = mbedtls_ssl_flight_transmit( ssl );
1963
1964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
1965
1966 return( ret );
1967}
1968
1969/*
1970 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001971 *
1972 * Need to remember the current message in case flush_output returns
1973 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001974 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001975 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001976int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001977{
Janos Follath865b3eb2019-12-16 11:46:15 +00001978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001979 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001982 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001984
1985 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001986 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001987 ret = ssl_swap_epochs( ssl );
1988 if( ret != 0 )
1989 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001992 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001993
1994 while( ssl->handshake->cur_msg != NULL )
1995 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001996 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001997 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001998
Hanno Beckere1dcb032018-08-17 16:47:58 +01001999 int const is_finished =
2000 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2001 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2002
Hanno Becker04da1892018-08-14 13:22:10 +01002003 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2004 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2005
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002006 /* Swap epochs before sending Finished: we can't do it after
2007 * sending ChangeCipherSpec, in case write returns WANT_READ.
2008 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002009 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002010 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002011 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002012 ret = ssl_swap_epochs( ssl );
2013 if( ret != 0 )
2014 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002015 }
2016
Hanno Becker67bc7c32018-08-06 11:33:50 +01002017 ret = ssl_get_remaining_payload_in_datagram( ssl );
2018 if( ret < 0 )
2019 return( ret );
2020 max_frag_len = (size_t) ret;
2021
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002022 /* CCS is copied as is, while HS messages may need fragmentation */
2023 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2024 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002025 if( max_frag_len == 0 )
2026 {
2027 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2028 return( ret );
2029
2030 continue;
2031 }
2032
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002033 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002034 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002035 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002037 /* Update position inside current message */
2038 ssl->handshake->cur_msg_p += cur->len;
2039 }
2040 else
2041 {
2042 const unsigned char * const p = ssl->handshake->cur_msg_p;
2043 const size_t hs_len = cur->len - 12;
2044 const size_t frag_off = p - ( cur->p + 12 );
2045 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002046 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002047
Hanno Beckere1dcb032018-08-17 16:47:58 +01002048 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002049 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002050 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002051 {
2052 ret = ssl_swap_epochs( ssl );
2053 if( ret != 0 )
2054 return( ret );
2055 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002056
Hanno Becker67bc7c32018-08-06 11:33:50 +01002057 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2058 return( ret );
2059
2060 continue;
2061 }
2062 max_hs_frag_len = max_frag_len - 12;
2063
2064 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2065 max_hs_frag_len : rem_len;
2066
2067 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002068 {
2069 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002070 (unsigned) cur_hs_frag_len,
2071 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002072 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002073
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002074 /* Messages are stored with handshake headers as if not fragmented,
2075 * copy beginning of headers then fill fragmentation fields.
2076 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2077 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078
Joe Subbiani5ecac212021-06-24 13:00:03 +01002079 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2080 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2081 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002082
Joe Subbiani5ecac212021-06-24 13:00:03 +01002083 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2084 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2085 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002086
2087 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2088
Hanno Becker3f7b9732018-08-28 09:53:25 +01002089 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002090 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2091 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002092 ssl->out_msgtype = cur->type;
2093
2094 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002095 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002096 }
2097
2098 /* If done with the current message move to the next one if any */
2099 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2100 {
2101 if( cur->next != NULL )
2102 {
2103 ssl->handshake->cur_msg = cur->next;
2104 ssl->handshake->cur_msg_p = cur->next->p + 12;
2105 }
2106 else
2107 {
2108 ssl->handshake->cur_msg = NULL;
2109 ssl->handshake->cur_msg_p = NULL;
2110 }
2111 }
2112
2113 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002114 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002115 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002117 return( ret );
2118 }
2119 }
2120
Hanno Becker67bc7c32018-08-06 11:33:50 +01002121 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2122 return( ret );
2123
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002124 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2126 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002127 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002128 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002130 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002131 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002132
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002134
2135 return( 0 );
2136}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002137
2138/*
2139 * To be called when the last message of an incoming flight is received.
2140 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002142{
2143 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002144 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002145 ssl->handshake->flight = NULL;
2146 ssl->handshake->cur_msg = NULL;
2147
2148 /* The next incoming flight will start with this msg_seq */
2149 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2150
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002151 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002152 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002153
Hanno Becker0271f962018-08-16 13:23:47 +01002154 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002155 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002156
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002157 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002158 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2161 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002162 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002164 }
2165 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002167}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002168
2169/*
2170 * To be called when the last message of an outgoing flight is send.
2171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002173{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002174 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002175 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2178 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002179 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002181 }
2182 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002184}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002186
Paul Bakker5121ce52009-01-03 21:22:43 +00002187/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002188 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002189 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190
2191/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002192 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002193 *
2194 * - fill in handshake headers
2195 * - update handshake checksum
2196 * - DTLS: save message for resending
2197 * - then pass to the record layer
2198 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002199 * DTLS: except for HelloRequest, messages are only queued, and will only be
2200 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002201 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002202 * Inputs:
2203 * - ssl->out_msglen: 4 + actual handshake message len
2204 * (4 is the size of handshake headers for TLS)
2205 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2206 * - ssl->out_msg + 4: the handshake message body
2207 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002208 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002209 * - ssl->out_msglen: the length of the record contents
2210 * (including handshake headers but excluding record headers)
2211 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002212 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002213int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2214 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002215{
Janos Follath865b3eb2019-12-16 11:46:15 +00002216 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002217 const size_t hs_len = ssl->out_msglen - 4;
2218 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002219
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002220 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2221
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002222 /*
2223 * Sanity checks
2224 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002225 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002226 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2227 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002228 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2229 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002230 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002231
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002232 /* Whenever we send anything different from a
2233 * HelloRequest we should be in a handshake - double check. */
2234 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2235 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002236 ssl->handshake == NULL )
2237 {
2238 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2239 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2240 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002243 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002244 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002246 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002247 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2248 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002249 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002250#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002251
Hanno Beckerb50a2532018-08-06 11:52:54 +01002252 /* Double-check that we did not exceed the bounds
2253 * of the outgoing record buffer.
2254 * This should never fail as the various message
2255 * writing functions must obey the bounds of the
2256 * outgoing record buffer, but better be safe.
2257 *
2258 * Note: We deliberately do not check for the MTU or MFL here.
2259 */
2260 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2261 {
2262 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002263 "size %" MBEDTLS_PRINTF_SIZET
2264 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002265 ssl->out_msglen,
2266 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002267 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2268 }
2269
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002270 /*
2271 * Fill handshake headers
2272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002274 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002275 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2276 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2277 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002278
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002279 /*
2280 * DTLS has additional fields in the Handshake layer,
2281 * between the length field and the actual payload:
2282 * uint16 message_seq;
2283 * uint24 fragment_offset;
2284 * uint24 fragment_length;
2285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002287 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002288 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002289 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002290 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002291 {
2292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002293 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002294 hs_len,
2295 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002296 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2297 }
2298
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002299 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002300 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002301
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002302 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002303 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002304 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002305 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002306 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002307 }
2308 else
2309 {
2310 ssl->out_msg[4] = 0;
2311 ssl->out_msg[5] = 0;
2312 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002313
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002314 /* Handshake hashes are computed without fragmentation,
2315 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002316 memset( ssl->out_msg + 6, 0x00, 3 );
2317 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002318 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002320
Hanno Becker0207e532018-08-28 10:28:28 +01002321 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002322 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002323 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002324 }
2325
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002326 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002328 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002329 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2330 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002331 {
2332 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002335 return( ret );
2336 }
2337 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002338 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002339#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002340 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002341 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002342 {
2343 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2344 return( ret );
2345 }
2346 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002347
2348 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2349
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002350 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002351}
2352
2353/*
2354 * Record layer functions
2355 */
2356
2357/*
2358 * Write current record.
2359 *
2360 * Uses:
2361 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2362 * - ssl->out_msglen: length of the record content (excl headers)
2363 * - ssl->out_msg: record content
2364 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002365int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002366{
2367 int ret, done = 0;
2368 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002369 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002370
2371 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002372
Paul Bakker05ef8352012-05-08 09:17:57 +00002373 if( !done )
2374 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002375 unsigned i;
2376 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002377#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2378 size_t out_buf_len = ssl->out_buf_len;
2379#else
2380 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2381#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002382 /* Skip writing the record content type to after the encryption,
2383 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002384 int minor_ver = ssl->minor_ver;
2385#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002386 /* TLS 1.3 still uses the TLS 1.2 version identifier
2387 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002388 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2389 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
2390#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
2391 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2392 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002393
Jerry Yuae0b2e22021-10-08 15:21:19 +08002394 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002395 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002396
Paul Bakker48916f92012-09-16 19:57:18 +00002397 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002398 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002399 mbedtls_record rec;
2400
2401 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002402 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002403 rec.data_len = ssl->out_msglen;
2404 rec.data_offset = ssl->out_msg - rec.buf;
2405
Jerry Yud96a5c22021-09-29 17:46:51 +08002406 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002407 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002408 ssl->conf->transport, rec.ver );
2409 rec.type = ssl->out_msgtype;
2410
Hanno Beckera0e20d02019-05-15 14:03:01 +01002411#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002412 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002413 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002414#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002415
Hanno Beckera18d1322018-01-03 14:27:32 +00002416 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002417 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002418 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002420 return( ret );
2421 }
2422
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002423 if( rec.data_offset != 0 )
2424 {
2425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2426 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2427 }
2428
Hanno Becker6430faf2019-05-08 11:57:13 +01002429 /* Update the record content type and CID. */
2430 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002431#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002432 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002433#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002434 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002435 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002436 }
2437
Hanno Becker5903de42019-05-03 14:46:38 +01002438 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002439
2440#if defined(MBEDTLS_SSL_PROTO_DTLS)
2441 /* In case of DTLS, double-check that we don't exceed
2442 * the remaining space in the datagram. */
2443 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2444 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002445 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002446 if( ret < 0 )
2447 return( ret );
2448
2449 if( protected_record_size > (size_t) ret )
2450 {
2451 /* Should never happen */
2452 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2453 }
2454 }
2455#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002456
Hanno Becker6430faf2019-05-08 11:57:13 +01002457 /* Now write the potentially updated record content type. */
2458 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2459
Paul Elliott9f352112020-12-09 14:55:45 +00002460 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002461 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002462 ssl->out_hdr[0], ssl->out_hdr[1],
2463 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002464
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002465 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002466 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002467
2468 ssl->out_left += protected_record_size;
2469 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002470 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002471
Hanno Beckerdd772292020-02-05 10:38:31 +00002472 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002473 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2474 break;
2475
2476 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002477 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002478 {
2479 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2480 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2481 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002482 }
2483
Hanno Becker67bc7c32018-08-06 11:33:50 +01002484#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002485 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2486 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002487 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002488 size_t remaining;
2489 ret = ssl_get_remaining_payload_in_datagram( ssl );
2490 if( ret < 0 )
2491 {
2492 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2493 ret );
2494 return( ret );
2495 }
2496
2497 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002498 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002499 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002500 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002501 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002502 else
2503 {
Hanno Becker513815a2018-08-20 11:56:09 +01002504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002505 }
2506 }
2507#endif /* MBEDTLS_SSL_PROTO_DTLS */
2508
2509 if( ( flush == SSL_FORCE_FLUSH ) &&
2510 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002511 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002513 return( ret );
2514 }
2515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002517
2518 return( 0 );
2519}
2520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002522
2523static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2524{
2525 if( ssl->in_msglen < ssl->in_hslen ||
2526 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2527 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2528 {
2529 return( 1 );
2530 }
2531 return( 0 );
2532}
Hanno Becker44650b72018-08-16 12:51:11 +01002533
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002534static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002535{
2536 return( ( ssl->in_msg[9] << 16 ) |
2537 ( ssl->in_msg[10] << 8 ) |
2538 ssl->in_msg[11] );
2539}
2540
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002541static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002542{
2543 return( ( ssl->in_msg[6] << 16 ) |
2544 ( ssl->in_msg[7] << 8 ) |
2545 ssl->in_msg[8] );
2546}
2547
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002548static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002549{
2550 uint32_t msg_len, frag_off, frag_len;
2551
2552 msg_len = ssl_get_hs_total_len( ssl );
2553 frag_off = ssl_get_hs_frag_off( ssl );
2554 frag_len = ssl_get_hs_frag_len( ssl );
2555
2556 if( frag_off > msg_len )
2557 return( -1 );
2558
2559 if( frag_len > msg_len - frag_off )
2560 return( -1 );
2561
2562 if( frag_len + 12 > ssl->in_msglen )
2563 return( -1 );
2564
2565 return( 0 );
2566}
2567
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002568/*
2569 * Mark bits in bitmask (used for DTLS HS reassembly)
2570 */
2571static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2572{
2573 unsigned int start_bits, end_bits;
2574
2575 start_bits = 8 - ( offset % 8 );
2576 if( start_bits != 8 )
2577 {
2578 size_t first_byte_idx = offset / 8;
2579
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002580 /* Special case */
2581 if( len <= start_bits )
2582 {
2583 for( ; len != 0; len-- )
2584 mask[first_byte_idx] |= 1 << ( start_bits - len );
2585
2586 /* Avoid potential issues with offset or len becoming invalid */
2587 return;
2588 }
2589
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002590 offset += start_bits; /* Now offset % 8 == 0 */
2591 len -= start_bits;
2592
2593 for( ; start_bits != 0; start_bits-- )
2594 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2595 }
2596
2597 end_bits = len % 8;
2598 if( end_bits != 0 )
2599 {
2600 size_t last_byte_idx = ( offset + len ) / 8;
2601
2602 len -= end_bits; /* Now len % 8 == 0 */
2603
2604 for( ; end_bits != 0; end_bits-- )
2605 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2606 }
2607
2608 memset( mask + offset / 8, 0xFF, len / 8 );
2609}
2610
2611/*
2612 * Check that bitmask is full
2613 */
2614static int ssl_bitmask_check( unsigned char *mask, size_t len )
2615{
2616 size_t i;
2617
2618 for( i = 0; i < len / 8; i++ )
2619 if( mask[i] != 0xFF )
2620 return( -1 );
2621
2622 for( i = 0; i < len % 8; i++ )
2623 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2624 return( -1 );
2625
2626 return( 0 );
2627}
2628
Hanno Becker56e205e2018-08-16 09:06:12 +01002629/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002630static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002631 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002632{
Hanno Becker56e205e2018-08-16 09:06:12 +01002633 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002634
Hanno Becker56e205e2018-08-16 09:06:12 +01002635 alloc_len = 12; /* Handshake header */
2636 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002637
Hanno Beckerd07df862018-08-16 09:14:58 +01002638 if( add_bitmap )
2639 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002640
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002641 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002642}
Hanno Becker56e205e2018-08-16 09:06:12 +01002643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002645
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002646static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002647{
2648 return( ( ssl->in_msg[1] << 16 ) |
2649 ( ssl->in_msg[2] << 8 ) |
2650 ssl->in_msg[3] );
2651}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002652
Simon Butcher99000142016-10-13 17:21:01 +01002653int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002654{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002656 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002658 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002660 }
2661
Hanno Becker12555c62018-08-16 12:47:53 +01002662 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002665 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002666 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002669 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002670 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002672 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002673
Hanno Becker44650b72018-08-16 12:51:11 +01002674 if( ssl_check_hs_header( ssl ) != 0 )
2675 {
2676 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2677 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2678 }
2679
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002680 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002681 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2682 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2683 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2684 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002685 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002686 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2687 {
2688 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2689 recv_msg_seq,
2690 ssl->handshake->in_msg_seq ) );
2691 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2692 }
2693
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002694 /* Retransmit only on last message from previous flight, to avoid
2695 * too many retransmissions.
2696 * Besides, No sane server ever retransmits HelloVerifyRequest */
2697 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002699 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002701 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002702 recv_msg_seq,
2703 ssl->handshake->in_flight_start_seq ) );
2704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002706 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002708 return( ret );
2709 }
2710 }
2711 else
2712 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002714 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002715 recv_msg_seq,
2716 ssl->handshake->in_msg_seq ) );
2717 }
2718
Hanno Becker90333da2017-10-10 11:27:13 +01002719 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002720 }
2721 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002722
Hanno Becker6d97ef52018-08-16 13:09:04 +01002723 /* Message reassembly is handled alongside buffering of future
2724 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002725 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002726 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002727 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002728 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002730 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002731 }
2732 }
2733 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002735 /* With TLS we don't handle fragmentation (for now) */
2736 if( ssl->in_msglen < ssl->in_hslen )
2737 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2739 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002740 }
2741
Simon Butcher99000142016-10-13 17:21:01 +01002742 return( 0 );
2743}
2744
2745void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2746{
Hanno Becker0271f962018-08-16 13:23:47 +01002747 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002748
Hanno Becker0271f962018-08-16 13:23:47 +01002749 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002750 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002751 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002752 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002753
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002754 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002756 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002757 ssl->handshake != NULL )
2758 {
Hanno Becker0271f962018-08-16 13:23:47 +01002759 unsigned offset;
2760 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002761
Hanno Becker0271f962018-08-16 13:23:47 +01002762 /* Increment handshake sequence number */
2763 hs->in_msg_seq++;
2764
2765 /*
2766 * Clear up handshake buffering and reassembly structure.
2767 */
2768
2769 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002770 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002771
2772 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002773 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2774 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002775 offset++, hs_buf++ )
2776 {
2777 *hs_buf = *(hs_buf + 1);
2778 }
2779
2780 /* Create a fresh last entry */
2781 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002782 }
2783#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002784}
2785
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002786/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002787 * DTLS anti-replay: RFC 6347 4.1.2.6
2788 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002789 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2790 * Bit n is set iff record number in_window_top - n has been seen.
2791 *
2792 * Usually, in_window_top is the last record number seen and the lsb of
2793 * in_window is set. The only exception is the initial state (record number 0
2794 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002797void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002798{
2799 ssl->in_window_top = 0;
2800 ssl->in_window = 0;
2801}
2802
2803static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2804{
2805 return( ( (uint64_t) buf[0] << 40 ) |
2806 ( (uint64_t) buf[1] << 32 ) |
2807 ( (uint64_t) buf[2] << 24 ) |
2808 ( (uint64_t) buf[3] << 16 ) |
2809 ( (uint64_t) buf[4] << 8 ) |
2810 ( (uint64_t) buf[5] ) );
2811}
2812
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002813static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2814{
Janos Follath865b3eb2019-12-16 11:46:15 +00002815 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002816 unsigned char *original_in_ctr;
2817
2818 // save original in_ctr
2819 original_in_ctr = ssl->in_ctr;
2820
2821 // use counter from record
2822 ssl->in_ctr = record_in_ctr;
2823
2824 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2825
2826 // restore the counter
2827 ssl->in_ctr = original_in_ctr;
2828
2829 return ret;
2830}
2831
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002832/*
2833 * Return 0 if sequence number is acceptable, -1 otherwise
2834 */
Hanno Becker0183d692019-07-12 08:50:37 +01002835int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002836{
2837 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2838 uint64_t bit;
2839
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002840 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002841 return( 0 );
2842
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002843 if( rec_seqnum > ssl->in_window_top )
2844 return( 0 );
2845
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002846 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002847
2848 if( bit >= 64 )
2849 return( -1 );
2850
2851 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2852 return( -1 );
2853
2854 return( 0 );
2855}
2856
2857/*
2858 * Update replay window on new validated record
2859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002861{
2862 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2863
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002864 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002865 return;
2866
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002867 if( rec_seqnum > ssl->in_window_top )
2868 {
2869 /* Update window_top and the contents of the window */
2870 uint64_t shift = rec_seqnum - ssl->in_window_top;
2871
2872 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002873 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002874 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002875 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002876 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002877 ssl->in_window |= 1;
2878 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002879
2880 ssl->in_window_top = rec_seqnum;
2881 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002882 else
2883 {
2884 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002885 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002886
2887 if( bit < 64 ) /* Always true, but be extra sure */
2888 ssl->in_window |= (uint64_t) 1 << bit;
2889 }
2890}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002892
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002893#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002894/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002895 * Without any SSL context, check if a datagram looks like a ClientHello with
2896 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002897 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002898 *
2899 * - if cookie is valid, return 0
2900 * - if ClientHello looks superficially valid but cookie is not,
2901 * fill obuf and set olen, then
2902 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2903 * - otherwise return a specific error code
2904 */
2905static int ssl_check_dtls_clihlo_cookie(
2906 mbedtls_ssl_cookie_write_t *f_cookie_write,
2907 mbedtls_ssl_cookie_check_t *f_cookie_check,
2908 void *p_cookie,
2909 const unsigned char *cli_id, size_t cli_id_len,
2910 const unsigned char *in, size_t in_len,
2911 unsigned char *obuf, size_t buf_len, size_t *olen )
2912{
2913 size_t sid_len, cookie_len;
2914 unsigned char *p;
2915
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002916 /*
2917 * Structure of ClientHello with record and handshake headers,
2918 * and expected values. We don't need to check a lot, more checks will be
2919 * done when actually parsing the ClientHello - skipping those checks
2920 * avoids code duplication and does not make cookie forging any easier.
2921 *
2922 * 0-0 ContentType type; copied, must be handshake
2923 * 1-2 ProtocolVersion version; copied
2924 * 3-4 uint16 epoch; copied, must be 0
2925 * 5-10 uint48 sequence_number; copied
2926 * 11-12 uint16 length; (ignored)
2927 *
2928 * 13-13 HandshakeType msg_type; (ignored)
2929 * 14-16 uint24 length; (ignored)
2930 * 17-18 uint16 message_seq; copied
2931 * 19-21 uint24 fragment_offset; copied, must be 0
2932 * 22-24 uint24 fragment_length; (ignored)
2933 *
2934 * 25-26 ProtocolVersion client_version; (ignored)
2935 * 27-58 Random random; (ignored)
2936 * 59-xx SessionID session_id; 1 byte len + sid_len content
2937 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
2938 * ...
2939 *
2940 * Minimum length is 61 bytes.
2941 */
2942 if( in_len < 61 ||
2943 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
2944 in[3] != 0 || in[4] != 0 ||
2945 in[19] != 0 || in[20] != 0 || in[21] != 0 )
2946 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01002947 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002948 }
2949
2950 sid_len = in[59];
2951 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002952 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002953
2954 cookie_len = in[60 + sid_len];
2955 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002956 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002957
2958 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
2959 cli_id, cli_id_len ) == 0 )
2960 {
2961 /* Valid cookie */
2962 return( 0 );
2963 }
2964
2965 /*
2966 * If we get here, we've got an invalid cookie, let's prepare HVR.
2967 *
2968 * 0-0 ContentType type; copied
2969 * 1-2 ProtocolVersion version; copied
2970 * 3-4 uint16 epoch; copied
2971 * 5-10 uint48 sequence_number; copied
2972 * 11-12 uint16 length; olen - 13
2973 *
2974 * 13-13 HandshakeType msg_type; hello_verify_request
2975 * 14-16 uint24 length; olen - 25
2976 * 17-18 uint16 message_seq; copied
2977 * 19-21 uint24 fragment_offset; copied
2978 * 22-24 uint24 fragment_length; olen - 25
2979 *
2980 * 25-26 ProtocolVersion server_version; 0xfe 0xff
2981 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
2982 *
2983 * Minimum length is 28.
2984 */
2985 if( buf_len < 28 )
2986 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
2987
2988 /* Copy most fields and adapt others */
2989 memcpy( obuf, in, 25 );
2990 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
2991 obuf[25] = 0xfe;
2992 obuf[26] = 0xff;
2993
2994 /* Generate and write actual cookie */
2995 p = obuf + 28;
2996 if( f_cookie_write( p_cookie,
2997 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
2998 {
2999 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3000 }
3001
3002 *olen = p - obuf;
3003
3004 /* Go back and fill length fields */
3005 obuf[27] = (unsigned char)( *olen - 28 );
3006
Joe Subbianifbeb6922021-07-16 14:27:50 +01003007 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3008 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3009 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003010
Joe Subbiani6dd73642021-07-19 11:56:54 +01003011 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003012
3013 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3014}
3015
3016/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003017 * Handle possible client reconnect with the same UDP quadruplet
3018 * (RFC 6347 Section 4.2.8).
3019 *
3020 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3021 * that looks like a ClientHello.
3022 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003023 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003024 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003025 * - if the input looks like a ClientHello with a valid cookie,
3026 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003027 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003028 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003029 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003030 * This function is called (through ssl_check_client_reconnect()) when an
3031 * unexpected record is found in ssl_get_next_record(), which will discard the
3032 * record if we return 0, and bubble up the return value otherwise (this
3033 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3034 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003035 */
3036static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3037{
Janos Follath865b3eb2019-12-16 11:46:15 +00003038 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003039 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003040
Hanno Becker2fddd372019-07-10 14:37:41 +01003041 if( ssl->conf->f_cookie_write == NULL ||
3042 ssl->conf->f_cookie_check == NULL )
3043 {
3044 /* If we can't use cookies to verify reachability of the peer,
3045 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003046 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3047 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003048 return( 0 );
3049 }
3050
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003051 ret = ssl_check_dtls_clihlo_cookie(
3052 ssl->conf->f_cookie_write,
3053 ssl->conf->f_cookie_check,
3054 ssl->conf->p_cookie,
3055 ssl->cli_id, ssl->cli_id_len,
3056 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003057 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003058
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003059 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3060
3061 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003062 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003063 int send_ret;
3064 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3065 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3066 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003067 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003068 * If the error is permanent we'll catch it later,
3069 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003070 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3071 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3072 (void) send_ret;
3073
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003074 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003075 }
3076
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003077 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003078 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003079 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003080 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003081 {
3082 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3083 return( ret );
3084 }
3085
3086 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003087 }
3088
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003089 return( ret );
3090}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003091#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003092
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003093static int ssl_check_record_type( uint8_t record_type )
3094{
3095 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3096 record_type != MBEDTLS_SSL_MSG_ALERT &&
3097 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3098 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3099 {
3100 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3101 }
3102
3103 return( 0 );
3104}
3105
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003106/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003107 * ContentType type;
3108 * ProtocolVersion version;
3109 * uint16 epoch; // DTLS only
3110 * uint48 sequence_number; // DTLS only
3111 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003112 *
3113 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003114 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003115 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3116 *
3117 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003118 * 1. proceed with the record if this function returns 0
3119 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3120 * 3. return CLIENT_RECONNECT if this function return that value
3121 * 4. drop the whole datagram if this function returns anything else.
3122 * Point 2 is needed when the peer is resending, and we have already received
3123 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003124 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003125static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003126 unsigned char *buf,
3127 size_t len,
3128 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003129{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003130 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003131
Hanno Beckere5e7e782019-07-11 12:29:35 +01003132 size_t const rec_hdr_type_offset = 0;
3133 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003134
Hanno Beckere5e7e782019-07-11 12:29:35 +01003135 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3136 rec_hdr_type_len;
3137 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003138
Hanno Beckere5e7e782019-07-11 12:29:35 +01003139 size_t const rec_hdr_ctr_len = 8;
3140#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003141 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003142 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3143 rec_hdr_version_len;
3144
Hanno Beckera0e20d02019-05-15 14:03:01 +01003145#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003146 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3147 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003148 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003149#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3150#endif /* MBEDTLS_SSL_PROTO_DTLS */
3151
3152 size_t rec_hdr_len_offset; /* To be determined */
3153 size_t const rec_hdr_len_len = 2;
3154
3155 /*
3156 * Check minimum lengths for record header.
3157 */
3158
3159#if defined(MBEDTLS_SSL_PROTO_DTLS)
3160 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3161 {
3162 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3163 }
3164 else
3165#endif /* MBEDTLS_SSL_PROTO_DTLS */
3166 {
3167 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3168 }
3169
3170 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3171 {
3172 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3173 (unsigned) len,
3174 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3175 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3176 }
3177
3178 /*
3179 * Parse and validate record content type
3180 */
3181
3182 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003183
3184 /* Check record content type */
3185#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3186 rec->cid_len = 0;
3187
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003188 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003189 ssl->conf->cid_len != 0 &&
3190 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003191 {
3192 /* Shift pointers to account for record header including CID
3193 * struct {
3194 * ContentType special_type = tls12_cid;
3195 * ProtocolVersion version;
3196 * uint16 epoch;
3197 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003198 * opaque cid[cid_length]; // Additional field compared to
3199 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003200 * uint16 length;
3201 * opaque enc_content[DTLSCiphertext.length];
3202 * } DTLSCiphertext;
3203 */
3204
3205 /* So far, we only support static CID lengths
3206 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003207 rec_hdr_cid_len = ssl->conf->cid_len;
3208 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003209
Hanno Beckere5e7e782019-07-11 12:29:35 +01003210 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003211 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003212 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3213 (unsigned) len,
3214 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003215 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003216 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003217
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003218 /* configured CID len is guaranteed at most 255, see
3219 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3220 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003221 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003222 }
3223 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003224#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003225 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003226 if( ssl_check_record_type( rec->type ) )
3227 {
Hanno Becker54229812019-07-12 14:40:00 +01003228 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3229 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003230 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3231 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003232 }
3233
Hanno Beckere5e7e782019-07-11 12:29:35 +01003234 /*
3235 * Parse and validate record version
3236 */
3237
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003238 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3239 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003240 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3241 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003242 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003243
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003244 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003245 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3247 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003248 }
3249
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003250 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3253 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003254 }
3255
Hanno Beckere5e7e782019-07-11 12:29:35 +01003256 /*
3257 * Parse/Copy record sequence number.
3258 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003259
Hanno Beckere5e7e782019-07-11 12:29:35 +01003260#if defined(MBEDTLS_SSL_PROTO_DTLS)
3261 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003262 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003263 /* Copy explicit record sequence number from input buffer. */
3264 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3265 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003266 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003267 else
3268#endif /* MBEDTLS_SSL_PROTO_DTLS */
3269 {
3270 /* Copy implicit record sequence number from SSL context structure. */
3271 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3272 }
Paul Bakker40e46942009-01-03 21:51:57 +00003273
Hanno Beckere5e7e782019-07-11 12:29:35 +01003274 /*
3275 * Parse record length.
3276 */
3277
Hanno Beckere5e7e782019-07-11 12:29:35 +01003278 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003279 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3280 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003281 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003282
Paul Elliott9f352112020-12-09 14:55:45 +00003283 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003284 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003285 rec->type,
3286 major_ver, minor_ver, rec->data_len ) );
3287
3288 rec->buf = buf;
3289 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003290
Hanno Beckerd417cc92019-07-26 08:20:27 +01003291 if( rec->data_len == 0 )
3292 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003293
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003294 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003295 * DTLS-related tests.
3296 * Check epoch before checking length constraint because
3297 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3298 * message gets duplicated before the corresponding Finished message,
3299 * the second ChangeCipherSpec should be discarded because it belongs
3300 * to an old epoch, but not because its length is shorter than
3301 * the minimum record length for packets using the new record transform.
3302 * Note that these two kinds of failures are handled differently,
3303 * as an unexpected record is silently skipped but an invalid
3304 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003305 */
3306#if defined(MBEDTLS_SSL_PROTO_DTLS)
3307 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3308 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003309 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003310
Hanno Becker955a5c92019-07-10 17:12:07 +01003311 /* Check that the datagram is large enough to contain a record
3312 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003313 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003314 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003315 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3316 (unsigned) len,
3317 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003318 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3319 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003320
Hanno Becker37cfe732019-07-10 17:20:01 +01003321 /* Records from other, non-matching epochs are silently discarded.
3322 * (The case of same-port Client reconnects must be considered in
3323 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003324 if( rec_epoch != ssl->in_epoch )
3325 {
3326 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003327 "expected %u, received %lu",
3328 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003329
Hanno Becker552f7472019-07-19 10:59:12 +01003330 /* Records from the next epoch are considered for buffering
3331 * (concretely: early Finished messages). */
3332 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003333 {
Hanno Becker552f7472019-07-19 10:59:12 +01003334 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3335 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003336 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003337
Hanno Becker2fddd372019-07-10 14:37:41 +01003338 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003339 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003340#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003341 /* For records from the correct epoch, check whether their
3342 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003343 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3344 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003345 {
3346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3347 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3348 }
3349#endif
3350 }
3351#endif /* MBEDTLS_SSL_PROTO_DTLS */
3352
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003353 return( 0 );
3354}
Paul Bakker5121ce52009-01-03 21:22:43 +00003355
Paul Bakker5121ce52009-01-03 21:22:43 +00003356
Hanno Becker2fddd372019-07-10 14:37:41 +01003357#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3358static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3359{
3360 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3361
3362 /*
3363 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3364 * access the first byte of record content (handshake type), as we
3365 * have an active transform (possibly iv_len != 0), so use the
3366 * fact that the record header len is 13 instead.
3367 */
3368 if( rec_epoch == 0 &&
3369 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3370 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3371 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3372 ssl->in_left > 13 &&
3373 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3374 {
3375 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3376 "from the same port" ) );
3377 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003378 }
3379
3380 return( 0 );
3381}
Hanno Becker2fddd372019-07-10 14:37:41 +01003382#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003383
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003384/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003385 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003386 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003387static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3388 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003389{
3390 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003393 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003394
Ronald Cron7e38cba2021-11-24 12:43:39 +01003395 /*
3396 * In TLS 1.3, always treat ChangeCipherSpec records
3397 * as unencrypted. The only thing we do with them is
3398 * check the length and content and ignore them.
3399 */
3400#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
3401 if( ssl->transform_in != NULL &&
3402 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3403 {
3404 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3405 done = 1;
3406 }
3407#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
3408
Paul Bakker48916f92012-09-16 19:57:18 +00003409 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003410 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003411 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003412
Hanno Beckera18d1322018-01-03 14:27:32 +00003413 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003414 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003415 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003417
Hanno Beckera0e20d02019-05-15 14:03:01 +01003418#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003419 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3420 ssl->conf->ignore_unexpected_cid
3421 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3422 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003423 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003424 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003425 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003426#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003427
Paul Bakker5121ce52009-01-03 21:22:43 +00003428 return( ret );
3429 }
3430
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003431 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003432 {
3433 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003434 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003435 }
3436
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003437 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003438 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003439
Hanno Beckera0e20d02019-05-15 14:03:01 +01003440#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003441 /* We have already checked the record content type
3442 * in ssl_parse_record_header(), failing or silently
3443 * dropping the record in the case of an unknown type.
3444 *
3445 * Since with the use of CIDs, the record content type
3446 * might change during decryption, re-check the record
3447 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003448 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003449 {
3450 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3451 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3452 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003453#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003454
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003455 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003456 {
3457#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3458 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003459 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003460 {
3461 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3463 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3464 }
3465#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3466
3467 ssl->nb_zero++;
3468
3469 /*
3470 * Three or more empty messages may be a DoS attack
3471 * (excessive CPU consumption).
3472 */
3473 if( ssl->nb_zero > 3 )
3474 {
3475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003476 "messages, possible DoS attack" ) );
3477 /* Treat the records as if they were not properly authenticated,
3478 * thereby failing the connection if we see more than allowed
3479 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003480 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3481 }
3482 }
3483 else
3484 ssl->nb_zero = 0;
3485
3486#if defined(MBEDTLS_SSL_PROTO_DTLS)
3487 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3488 {
3489 ; /* in_ctr read from peer, not maintained internally */
3490 }
3491 else
3492#endif
3493 {
3494 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003495 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3496 i > mbedtls_ssl_ep_len( ssl ); i-- )
3497 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003498 if( ++ssl->in_ctr[i - 1] != 0 )
3499 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003500 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003501
3502 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003503 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003504 {
3505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3506 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3507 }
3508 }
3509
Paul Bakker5121ce52009-01-03 21:22:43 +00003510 }
3511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003513 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003514 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003516 }
3517#endif
3518
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003519 /* Check actual (decrypted) record content length against
3520 * configured maximum. */
3521 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3522 {
3523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3524 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3525 }
3526
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003527 return( 0 );
3528}
3529
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003530/*
3531 * Read a record.
3532 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003533 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3534 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3535 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003536 */
Hanno Becker1097b342018-08-15 14:09:41 +01003537
3538/* Helper functions for mbedtls_ssl_read_record(). */
3539static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003540static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3541static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003542
Hanno Becker327c93b2018-08-15 13:56:18 +01003543int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003544 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003545{
Janos Follath865b3eb2019-12-16 11:46:15 +00003546 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003549
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003550 if( ssl->keep_current_message == 0 )
3551 {
3552 do {
Simon Butcher99000142016-10-13 17:21:01 +01003553
Hanno Becker26994592018-08-15 14:14:59 +01003554 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003555 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003556 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003557
Hanno Beckere74d5562018-08-15 14:26:08 +01003558 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003559 {
Hanno Becker40f50842018-08-15 14:48:01 +01003560#if defined(MBEDTLS_SSL_PROTO_DTLS)
3561 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003562
Hanno Becker40f50842018-08-15 14:48:01 +01003563 /* We only check for buffered messages if the
3564 * current datagram is fully consumed. */
3565 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003566 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003567 {
Hanno Becker40f50842018-08-15 14:48:01 +01003568 if( ssl_load_buffered_message( ssl ) == 0 )
3569 have_buffered = 1;
3570 }
3571
3572 if( have_buffered == 0 )
3573#endif /* MBEDTLS_SSL_PROTO_DTLS */
3574 {
3575 ret = ssl_get_next_record( ssl );
3576 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3577 continue;
3578
3579 if( ret != 0 )
3580 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003581 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003582 return( ret );
3583 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003584 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003585 }
3586
3587 ret = mbedtls_ssl_handle_message_type( ssl );
3588
Hanno Becker40f50842018-08-15 14:48:01 +01003589#if defined(MBEDTLS_SSL_PROTO_DTLS)
3590 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3591 {
3592 /* Buffer future message */
3593 ret = ssl_buffer_message( ssl );
3594 if( ret != 0 )
3595 return( ret );
3596
3597 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3598 }
3599#endif /* MBEDTLS_SSL_PROTO_DTLS */
3600
Hanno Becker90333da2017-10-10 11:27:13 +01003601 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3602 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003603
3604 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003605 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003606 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003607 return( ret );
3608 }
3609
Hanno Becker327c93b2018-08-15 13:56:18 +01003610 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003611 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003612 {
3613 mbedtls_ssl_update_handshake_status( ssl );
3614 }
Simon Butcher99000142016-10-13 17:21:01 +01003615 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003616 else
Simon Butcher99000142016-10-13 17:21:01 +01003617 {
Hanno Becker02f59072018-08-15 14:00:24 +01003618 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003619 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003620 }
3621
3622 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3623
3624 return( 0 );
3625}
3626
Hanno Becker40f50842018-08-15 14:48:01 +01003627#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003628static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003629{
Hanno Becker40f50842018-08-15 14:48:01 +01003630 if( ssl->in_left > ssl->next_record_offset )
3631 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003632
Hanno Becker40f50842018-08-15 14:48:01 +01003633 return( 0 );
3634}
3635
3636static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3637{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003638 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003639 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003640 int ret = 0;
3641
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003642 if( hs == NULL )
3643 return( -1 );
3644
Hanno Beckere00ae372018-08-20 09:39:42 +01003645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3646
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003647 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3648 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3649 {
3650 /* Check if we have seen a ChangeCipherSpec before.
3651 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003652 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003653 {
3654 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3655 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003656 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003657 }
3658
Hanno Becker39b8bc92018-08-28 17:17:13 +01003659 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003660 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3661 ssl->in_msglen = 1;
3662 ssl->in_msg[0] = 1;
3663
3664 /* As long as they are equal, the exact value doesn't matter. */
3665 ssl->in_left = 0;
3666 ssl->next_record_offset = 0;
3667
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003668 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003669 goto exit;
3670 }
Hanno Becker37f95322018-08-16 13:55:32 +01003671
Hanno Beckerb8f50142018-08-28 10:01:34 +01003672#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003673 /* Debug only */
3674 {
3675 unsigned offset;
3676 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3677 {
3678 hs_buf = &hs->buffering.hs[offset];
3679 if( hs_buf->is_valid == 1 )
3680 {
3681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3682 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003683 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003684 }
3685 }
3686 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003687#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003688
3689 /* Check if we have buffered and/or fully reassembled the
3690 * next handshake message. */
3691 hs_buf = &hs->buffering.hs[0];
3692 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3693 {
3694 /* Synthesize a record containing the buffered HS message. */
3695 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3696 ( hs_buf->data[2] << 8 ) |
3697 hs_buf->data[3];
3698
3699 /* Double-check that we haven't accidentally buffered
3700 * a message that doesn't fit into the input buffer. */
3701 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3702 {
3703 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3704 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3705 }
3706
3707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3708 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3709 hs_buf->data, msg_len + 12 );
3710
3711 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3712 ssl->in_hslen = msg_len + 12;
3713 ssl->in_msglen = msg_len + 12;
3714 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3715
3716 ret = 0;
3717 goto exit;
3718 }
3719 else
3720 {
3721 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3722 hs->in_msg_seq ) );
3723 }
3724
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003725 ret = -1;
3726
3727exit:
3728
3729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3730 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003731}
3732
Hanno Beckera02b0b42018-08-21 17:20:27 +01003733static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3734 size_t desired )
3735{
3736 int offset;
3737 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003738 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3739 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003740
Hanno Becker01315ea2018-08-21 17:22:17 +01003741 /* Get rid of future records epoch first, if such exist. */
3742 ssl_free_buffered_record( ssl );
3743
3744 /* Check if we have enough space available now. */
3745 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3746 hs->buffering.total_bytes_buffered ) )
3747 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003748 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003749 return( 0 );
3750 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003751
Hanno Becker4f432ad2018-08-28 10:02:32 +01003752 /* We don't have enough space to buffer the next expected handshake
3753 * message. Remove buffers used for future messages to gain space,
3754 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003755 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3756 offset >= 0; offset-- )
3757 {
3758 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3759 offset ) );
3760
Hanno Beckerb309b922018-08-23 13:18:05 +01003761 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003762
3763 /* Check if we have enough space available now. */
3764 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3765 hs->buffering.total_bytes_buffered ) )
3766 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003767 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003768 return( 0 );
3769 }
3770 }
3771
3772 return( -1 );
3773}
3774
Hanno Becker40f50842018-08-15 14:48:01 +01003775static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3776{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003777 int ret = 0;
3778 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3779
3780 if( hs == NULL )
3781 return( 0 );
3782
3783 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3784
3785 switch( ssl->in_msgtype )
3786 {
3787 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003789
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003790 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003791 break;
3792
3793 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003794 {
3795 unsigned recv_msg_seq_offset;
3796 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3797 mbedtls_ssl_hs_buffer *hs_buf;
3798 size_t msg_len = ssl->in_hslen - 12;
3799
3800 /* We should never receive an old handshake
3801 * message - double-check nonetheless. */
3802 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3803 {
3804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3805 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3806 }
3807
3808 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3809 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3810 {
3811 /* Silently ignore -- message too far in the future */
3812 MBEDTLS_SSL_DEBUG_MSG( 2,
3813 ( "Ignore future HS message with sequence number %u, "
3814 "buffering window %u - %u",
3815 recv_msg_seq, ssl->handshake->in_msg_seq,
3816 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3817
3818 goto exit;
3819 }
3820
3821 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3822 recv_msg_seq, recv_msg_seq_offset ) );
3823
3824 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3825
3826 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003827 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003828 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003829 size_t reassembly_buf_sz;
3830
Hanno Becker37f95322018-08-16 13:55:32 +01003831 hs_buf->is_fragmented =
3832 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3833
3834 /* We copy the message back into the input buffer
3835 * after reassembly, so check that it's not too large.
3836 * This is an implementation-specific limitation
3837 * and not one from the standard, hence it is not
3838 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003839 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003840 {
3841 /* Ignore message */
3842 goto exit;
3843 }
3844
Hanno Beckere0b150f2018-08-21 15:51:03 +01003845 /* Check if we have enough space to buffer the message. */
3846 if( hs->buffering.total_bytes_buffered >
3847 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3848 {
3849 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3850 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3851 }
3852
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003853 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3854 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003855
3856 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3857 hs->buffering.total_bytes_buffered ) )
3858 {
3859 if( recv_msg_seq_offset > 0 )
3860 {
3861 /* If we can't buffer a future message because
3862 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3864 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3865 " (already %" MBEDTLS_PRINTF_SIZET
3866 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003867 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003868 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003869 goto exit;
3870 }
Hanno Beckere1801392018-08-21 16:51:05 +01003871 else
3872 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3874 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3875 " (already %" MBEDTLS_PRINTF_SIZET
3876 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003877 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003878 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003879 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003880
Hanno Beckera02b0b42018-08-21 17:20:27 +01003881 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003882 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3884 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3885 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3886 " (already %" MBEDTLS_PRINTF_SIZET
3887 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003888 msg_len,
3889 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003890 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003891 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003892 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3893 goto exit;
3894 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003895 }
3896
Paul Elliottd48d5c62021-01-07 14:47:05 +00003897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003898 msg_len ) );
3899
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003900 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3901 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003902 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003903 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003904 goto exit;
3905 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003906 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003907
3908 /* Prepare final header: copy msg_type, length and message_seq,
3909 * then add standardised fragment_offset and fragment_length */
3910 memcpy( hs_buf->data, ssl->in_msg, 6 );
3911 memset( hs_buf->data + 6, 0, 3 );
3912 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3913
3914 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003915
3916 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003917 }
3918 else
3919 {
3920 /* Make sure msg_type and length are consistent */
3921 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3922 {
3923 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3924 /* Ignore */
3925 goto exit;
3926 }
3927 }
3928
Hanno Becker4422bbb2018-08-20 09:40:19 +01003929 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003930 {
3931 size_t frag_len, frag_off;
3932 unsigned char * const msg = hs_buf->data + 12;
3933
3934 /*
3935 * Check and copy current fragment
3936 */
3937
3938 /* Validation of header fields already done in
3939 * mbedtls_ssl_prepare_handshake_record(). */
3940 frag_off = ssl_get_hs_frag_off( ssl );
3941 frag_len = ssl_get_hs_frag_len( ssl );
3942
Paul Elliottd48d5c62021-01-07 14:47:05 +00003943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
3944 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01003945 frag_off, frag_len ) );
3946 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
3947
3948 if( hs_buf->is_fragmented )
3949 {
3950 unsigned char * const bitmask = msg + msg_len;
3951 ssl_bitmask_set( bitmask, frag_off, frag_len );
3952 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
3953 msg_len ) == 0 );
3954 }
3955 else
3956 {
3957 hs_buf->is_complete = 1;
3958 }
3959
3960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
3961 hs_buf->is_complete ? "" : "not yet " ) );
3962 }
3963
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003964 break;
Hanno Becker37f95322018-08-16 13:55:32 +01003965 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003966
3967 default:
Hanno Becker360bef32018-08-28 10:04:33 +01003968 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003969 break;
3970 }
3971
3972exit:
3973
3974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
3975 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003976}
3977#endif /* MBEDTLS_SSL_PROTO_DTLS */
3978
Hanno Becker1097b342018-08-15 14:09:41 +01003979static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003980{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003981 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01003982 * Consume last content-layer message and potentially
3983 * update in_msglen which keeps track of the contents'
3984 * consumption state.
3985 *
3986 * (1) Handshake messages:
3987 * Remove last handshake message, move content
3988 * and adapt in_msglen.
3989 *
3990 * (2) Alert messages:
3991 * Consume whole record content, in_msglen = 0.
3992 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01003993 * (3) Change cipher spec:
3994 * Consume whole record content, in_msglen = 0.
3995 *
3996 * (4) Application data:
3997 * Don't do anything - the record layer provides
3998 * the application data as a stream transport
3999 * and consumes through mbedtls_ssl_read only.
4000 *
4001 */
4002
4003 /* Case (1): Handshake messages */
4004 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004005 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004006 /* Hard assertion to be sure that no application data
4007 * is in flight, as corrupting ssl->in_msglen during
4008 * ssl->in_offt != NULL is fatal. */
4009 if( ssl->in_offt != NULL )
4010 {
4011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4012 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4013 }
4014
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004015 /*
4016 * Get next Handshake message in the current record
4017 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004018
Hanno Becker4a810fb2017-05-24 16:27:30 +01004019 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004020 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004021 * current handshake content: If DTLS handshake
4022 * fragmentation is used, that's the fragment
4023 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004024 * size here is faulty and should be changed at
4025 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004026 * (2) While it doesn't seem to cause problems, one
4027 * has to be very careful not to assume that in_hslen
4028 * is always <= in_msglen in a sensible communication.
4029 * Again, it's wrong for DTLS handshake fragmentation.
4030 * The following check is therefore mandatory, and
4031 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004032 * Additionally, ssl->in_hslen might be arbitrarily out of
4033 * bounds after handling a DTLS message with an unexpected
4034 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004035 */
4036 if( ssl->in_hslen < ssl->in_msglen )
4037 {
4038 ssl->in_msglen -= ssl->in_hslen;
4039 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4040 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004041
Hanno Becker4a810fb2017-05-24 16:27:30 +01004042 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4043 ssl->in_msg, ssl->in_msglen );
4044 }
4045 else
4046 {
4047 ssl->in_msglen = 0;
4048 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004049
Hanno Becker4a810fb2017-05-24 16:27:30 +01004050 ssl->in_hslen = 0;
4051 }
4052 /* Case (4): Application data */
4053 else if( ssl->in_offt != NULL )
4054 {
4055 return( 0 );
4056 }
4057 /* Everything else (CCS & Alerts) */
4058 else
4059 {
4060 ssl->in_msglen = 0;
4061 }
4062
Hanno Becker1097b342018-08-15 14:09:41 +01004063 return( 0 );
4064}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004065
Hanno Beckere74d5562018-08-15 14:26:08 +01004066static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4067{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004068 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004069 return( 1 );
4070
4071 return( 0 );
4072}
4073
Hanno Becker5f066e72018-08-16 14:56:31 +01004074#if defined(MBEDTLS_SSL_PROTO_DTLS)
4075
4076static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4077{
4078 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4079 if( hs == NULL )
4080 return;
4081
Hanno Becker01315ea2018-08-21 17:22:17 +01004082 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004083 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004084 hs->buffering.total_bytes_buffered -=
4085 hs->buffering.future_record.len;
4086
4087 mbedtls_free( hs->buffering.future_record.data );
4088 hs->buffering.future_record.data = NULL;
4089 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004090}
4091
4092static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4093{
4094 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4095 unsigned char * rec;
4096 size_t rec_len;
4097 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004098#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4099 size_t in_buf_len = ssl->in_buf_len;
4100#else
4101 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4102#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004103 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4104 return( 0 );
4105
4106 if( hs == NULL )
4107 return( 0 );
4108
Hanno Becker5f066e72018-08-16 14:56:31 +01004109 rec = hs->buffering.future_record.data;
4110 rec_len = hs->buffering.future_record.len;
4111 rec_epoch = hs->buffering.future_record.epoch;
4112
4113 if( rec == NULL )
4114 return( 0 );
4115
Hanno Becker4cb782d2018-08-20 11:19:05 +01004116 /* Only consider loading future records if the
4117 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004118 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004119 return( 0 );
4120
Hanno Becker5f066e72018-08-16 14:56:31 +01004121 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4122
4123 if( rec_epoch != ssl->in_epoch )
4124 {
4125 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4126 goto exit;
4127 }
4128
4129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4130
4131 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004132 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004133 {
4134 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4135 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4136 }
4137
4138 memcpy( ssl->in_hdr, rec, rec_len );
4139 ssl->in_left = rec_len;
4140 ssl->next_record_offset = 0;
4141
4142 ssl_free_buffered_record( ssl );
4143
4144exit:
4145 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4146 return( 0 );
4147}
4148
Hanno Becker519f15d2019-07-11 12:43:20 +01004149static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4150 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004151{
4152 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004153
4154 /* Don't buffer future records outside handshakes. */
4155 if( hs == NULL )
4156 return( 0 );
4157
4158 /* Only buffer handshake records (we are only interested
4159 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004160 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004161 return( 0 );
4162
4163 /* Don't buffer more than one future epoch record. */
4164 if( hs->buffering.future_record.data != NULL )
4165 return( 0 );
4166
Hanno Becker01315ea2018-08-21 17:22:17 +01004167 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004168 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004169 hs->buffering.total_bytes_buffered ) )
4170 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004171 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4172 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4173 " (already %" MBEDTLS_PRINTF_SIZET
4174 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004175 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004176 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004177 return( 0 );
4178 }
4179
Hanno Becker5f066e72018-08-16 14:56:31 +01004180 /* Buffer record */
4181 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004182 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004183 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004184
4185 /* ssl_parse_record_header() only considers records
4186 * of the next epoch as candidates for buffering. */
4187 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004188 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004189
4190 hs->buffering.future_record.data =
4191 mbedtls_calloc( 1, hs->buffering.future_record.len );
4192 if( hs->buffering.future_record.data == NULL )
4193 {
4194 /* If we run out of RAM trying to buffer a
4195 * record from the next epoch, just ignore. */
4196 return( 0 );
4197 }
4198
Hanno Becker519f15d2019-07-11 12:43:20 +01004199 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004200
Hanno Becker519f15d2019-07-11 12:43:20 +01004201 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004202 return( 0 );
4203}
4204
4205#endif /* MBEDTLS_SSL_PROTO_DTLS */
4206
Hanno Beckere74d5562018-08-15 14:26:08 +01004207static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004208{
Janos Follath865b3eb2019-12-16 11:46:15 +00004209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004210 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004211
Hanno Becker5f066e72018-08-16 14:56:31 +01004212#if defined(MBEDTLS_SSL_PROTO_DTLS)
4213 /* We might have buffered a future record; if so,
4214 * and if the epoch matches now, load it.
4215 * On success, this call will set ssl->in_left to
4216 * the length of the buffered record, so that
4217 * the calls to ssl_fetch_input() below will
4218 * essentially be no-ops. */
4219 ret = ssl_load_buffered_record( ssl );
4220 if( ret != 0 )
4221 return( ret );
4222#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004223
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004224 /* Ensure that we have enough space available for the default form
4225 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4226 * with no space for CIDs counted in). */
4227 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4228 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004229 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004230 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004231 return( ret );
4232 }
4233
Hanno Beckere5e7e782019-07-11 12:29:35 +01004234 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4235 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004236 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004237#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004238 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004239 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004240 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4241 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004242 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004243 if( ret != 0 )
4244 return( ret );
4245
4246 /* Fall through to handling of unexpected records */
4247 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4248 }
4249
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004250 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4251 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004252#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004253 /* Reset in pointers to default state for TLS/DTLS records,
4254 * assuming no CID and no offset between record content and
4255 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004256 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004257
Hanno Becker7ae20e02019-07-12 08:33:49 +01004258 /* Setup internal message pointers from record structure. */
4259 ssl->in_msgtype = rec.type;
4260#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4261 ssl->in_len = ssl->in_cid + rec.cid_len;
4262#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4263 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4264 ssl->in_msglen = rec.data_len;
4265
Hanno Becker2fddd372019-07-10 14:37:41 +01004266 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004267 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004268 if( ret != 0 )
4269 return( ret );
4270#endif
4271
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004272 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004273 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004274
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004275 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4276 "(header)" ) );
4277 }
4278 else
4279 {
4280 /* Skip invalid record and the rest of the datagram */
4281 ssl->next_record_offset = 0;
4282 ssl->in_left = 0;
4283
4284 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4285 "(header)" ) );
4286 }
4287
4288 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004289 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004290 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004291 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004292#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004293 {
4294 return( ret );
4295 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004296 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004298#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004299 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004300 {
Hanno Beckera8814792019-07-10 15:01:45 +01004301 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004302 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004303 if( ssl->next_record_offset < ssl->in_left )
4304 {
4305 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4306 }
4307 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004308 else
4309#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004310 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004311 /*
4312 * Fetch record contents from underlying transport.
4313 */
Hanno Beckera3175662019-07-11 12:50:29 +01004314 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004315 if( ret != 0 )
4316 {
4317 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4318 return( ret );
4319 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004320
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004321 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004322 }
4323
4324 /*
4325 * Decrypt record contents.
4326 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004327
Hanno Beckerfdf66042019-07-11 13:07:45 +01004328 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004329 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004330#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004331 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004332 {
4333 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004334 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004335 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004336 /* Except when waiting for Finished as a bad mac here
4337 * probably means something went wrong in the handshake
4338 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4339 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4340 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4341 {
4342#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4343 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4344 {
4345 mbedtls_ssl_send_alert_message( ssl,
4346 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4347 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4348 }
4349#endif
4350 return( ret );
4351 }
4352
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004353 if( ssl->conf->badmac_limit != 0 &&
4354 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4357 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004358 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004359
Hanno Becker4a810fb2017-05-24 16:27:30 +01004360 /* As above, invalid records cause
4361 * dismissal of the whole datagram. */
4362
4363 ssl->next_record_offset = 0;
4364 ssl->in_left = 0;
4365
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004366 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004367 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004368 }
4369
4370 return( ret );
4371 }
4372 else
4373#endif
4374 {
4375 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004376#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4377 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004378 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004379 mbedtls_ssl_send_alert_message( ssl,
4380 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4381 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004382 }
4383#endif
4384 return( ret );
4385 }
4386 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004387
Hanno Becker44d89b22019-07-12 09:40:44 +01004388
4389 /* Reset in pointers to default state for TLS/DTLS records,
4390 * assuming no CID and no offset between record content and
4391 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004392 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004393#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4394 ssl->in_len = ssl->in_cid + rec.cid_len;
4395#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004396 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004397
Hanno Becker8685c822019-07-12 09:37:30 +01004398 /* The record content type may change during decryption,
4399 * so re-read it. */
4400 ssl->in_msgtype = rec.type;
4401 /* Also update the input buffer, because unfortunately
4402 * the server-side ssl_parse_client_hello() reparses the
4403 * record header when receiving a ClientHello initiating
4404 * a renegotiation. */
4405 ssl->in_hdr[0] = rec.type;
4406 ssl->in_msg = rec.buf + rec.data_offset;
4407 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004408 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004409
Simon Butcher99000142016-10-13 17:21:01 +01004410 return( 0 );
4411}
4412
4413int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4414{
Janos Follath865b3eb2019-12-16 11:46:15 +00004415 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004416
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004417 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004418 * Handle particular types of records
4419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004420 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004421 {
Simon Butcher99000142016-10-13 17:21:01 +01004422 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4423 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004424 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004425 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004426 }
4427
Hanno Beckere678eaa2018-08-21 14:57:46 +01004428 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004429 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004430 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004431 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004433 ssl->in_msglen ) );
4434 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004435 }
4436
Hanno Beckere678eaa2018-08-21 14:57:46 +01004437 if( ssl->in_msg[0] != 1 )
4438 {
4439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4440 ssl->in_msg[0] ) );
4441 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4442 }
4443
4444#if defined(MBEDTLS_SSL_PROTO_DTLS)
4445 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4446 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4447 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4448 {
4449 if( ssl->handshake == NULL )
4450 {
4451 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4452 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4453 }
4454
4455 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4456 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4457 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004458#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004459
4460#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
4461 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4462 {
4463#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4464 MBEDTLS_SSL_DEBUG_MSG( 1,
4465 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4466 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4467#else
4468 MBEDTLS_SSL_DEBUG_MSG( 1,
4469 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4470 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4471#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4472 }
4473#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004474 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004476 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004477 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004478 if( ssl->in_msglen != 2 )
4479 {
4480 /* Note: Standard allows for more than one 2 byte alert
4481 to be packed in a single message, but Mbed TLS doesn't
4482 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004484 ssl->in_msglen ) );
4485 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4486 }
4487
Paul Elliott9f352112020-12-09 14:55:45 +00004488 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004489 ssl->in_msg[0], ssl->in_msg[1] ) );
4490
4491 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004492 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004494 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004495 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004497 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004498 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004499 }
4500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004501 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4502 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4505 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004506 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004507
4508#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4509 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4510 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4511 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004512 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004513 /* Will be handled when trying to parse ServerHello */
4514 return( 0 );
4515 }
4516#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004517 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004518 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004519 }
4520
Hanno Beckerc76c6192017-06-06 10:03:17 +01004521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004522 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004523 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004524 /* Drop unexpected ApplicationData records,
4525 * except at the beginning of renegotiations */
4526 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4527 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4528#if defined(MBEDTLS_SSL_RENEGOTIATION)
4529 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4530 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004531#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004532 )
4533 {
4534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4535 return( MBEDTLS_ERR_SSL_NON_FATAL );
4536 }
4537
4538 if( ssl->handshake != NULL &&
4539 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4540 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004541 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004542 }
4543 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004544#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004545
Paul Bakker5121ce52009-01-03 21:22:43 +00004546 return( 0 );
4547}
4548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004550{
irwir6c0da642019-09-26 21:07:41 +03004551 return( mbedtls_ssl_send_alert_message( ssl,
4552 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4553 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004554}
4555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004556int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004557 unsigned char level,
4558 unsigned char message )
4559{
Janos Follath865b3eb2019-12-16 11:46:15 +00004560 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004561
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004562 if( ssl == NULL || ssl->conf == NULL )
4563 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004566 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004569 ssl->out_msglen = 2;
4570 ssl->out_msg[0] = level;
4571 ssl->out_msg[1] = message;
4572
Hanno Becker67bc7c32018-08-06 11:33:50 +01004573 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004574 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004575 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004576 return( ret );
4577 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004579
4580 return( 0 );
4581}
4582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004583int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004584{
Janos Follath865b3eb2019-12-16 11:46:15 +00004585 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004587 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004588
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004589 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004590 ssl->out_msglen = 1;
4591 ssl->out_msg[0] = 1;
4592
Paul Bakker5121ce52009-01-03 21:22:43 +00004593 ssl->state++;
4594
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004595 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004596 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004597 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004598 return( ret );
4599 }
4600
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004602
4603 return( 0 );
4604}
4605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004606int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004607{
Janos Follath865b3eb2019-12-16 11:46:15 +00004608 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004609
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004610 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004611
Hanno Becker327c93b2018-08-15 13:56:18 +01004612 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004614 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004615 return( ret );
4616 }
4617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004618 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004619 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004620 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004621 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4622 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004623 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004624 }
4625
Hanno Beckere678eaa2018-08-21 14:57:46 +01004626 /* CCS records are only accepted if they have length 1 and content '1',
4627 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004628
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004629 /*
4630 * Switch to our negotiated transform and session parameters for inbound
4631 * data.
4632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004634 ssl->transform_in = ssl->transform_negotiate;
4635 ssl->session_in = ssl->session_negotiate;
4636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004638 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004639 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004641 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004642#endif
4643
4644 /* Increment epoch */
4645 if( ++ssl->in_epoch == 0 )
4646 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004648 /* This is highly unlikely to happen for legitimate reasons, so
4649 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004651 }
4652 }
4653 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004654#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004655 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004656
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004657 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004658
Paul Bakker5121ce52009-01-03 21:22:43 +00004659 ssl->state++;
4660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004662
4663 return( 0 );
4664}
4665
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004666/* Once ssl->out_hdr as the address of the beginning of the
4667 * next outgoing record is set, deduce the other pointers.
4668 *
4669 * Note: For TLS, we save the implicit record sequence number
4670 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4671 * and the caller has to make sure there's space for this.
4672 */
4673
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004674static size_t ssl_transform_get_explicit_iv_len(
4675 mbedtls_ssl_transform const *transform )
4676{
TRodziewiczef73f012021-05-13 14:53:36 +02004677 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004678 return( 0 );
4679
4680 return( transform->ivlen - transform->fixed_ivlen );
4681}
4682
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004683void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4684 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004685{
4686#if defined(MBEDTLS_SSL_PROTO_DTLS)
4687 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4688 {
4689 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004690#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004691 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004692 ssl->out_len = ssl->out_cid;
4693 if( transform != NULL )
4694 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004695#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004696 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004697#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004698 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004699 }
4700 else
4701#endif
4702 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004703 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004704#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004705 ssl->out_cid = ssl->out_len;
4706#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004707 ssl->out_iv = ssl->out_hdr + 5;
4708 }
4709
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004710 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004711 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004712 if( transform != NULL )
4713 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004714}
4715
4716/* Once ssl->in_hdr as the address of the beginning of the
4717 * next incoming record is set, deduce the other pointers.
4718 *
4719 * Note: For TLS, we save the implicit record sequence number
4720 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4721 * and the caller has to make sure there's space for this.
4722 */
4723
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004724void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004725{
Hanno Becker79594fd2019-05-08 09:38:41 +01004726 /* This function sets the pointers to match the case
4727 * of unprotected TLS/DTLS records, with both ssl->in_iv
4728 * and ssl->in_msg pointing to the beginning of the record
4729 * content.
4730 *
4731 * When decrypting a protected record, ssl->in_msg
4732 * will be shifted to point to the beginning of the
4733 * record plaintext.
4734 */
4735
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004736#if defined(MBEDTLS_SSL_PROTO_DTLS)
4737 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4738 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004739 /* This sets the header pointers to match records
4740 * without CID. When we receive a record containing
4741 * a CID, the fields are shifted accordingly in
4742 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004743 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004744#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004745 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004746 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004747#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004748 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004749#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004750 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004751 }
4752 else
4753#endif
4754 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004755 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004756 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004757#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004758 ssl->in_cid = ssl->in_len;
4759#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004760 ssl->in_iv = ssl->in_hdr + 5;
4761 }
4762
Hanno Becker79594fd2019-05-08 09:38:41 +01004763 /* This will be adjusted at record decryption time. */
4764 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004765}
4766
Paul Bakker5121ce52009-01-03 21:22:43 +00004767/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004768 * Setup an SSL context
4769 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004770
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004771void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004772{
4773 /* Set the incoming and outgoing record pointers. */
4774#if defined(MBEDTLS_SSL_PROTO_DTLS)
4775 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4776 {
4777 ssl->out_hdr = ssl->out_buf;
4778 ssl->in_hdr = ssl->in_buf;
4779 }
4780 else
4781#endif /* MBEDTLS_SSL_PROTO_DTLS */
4782 {
Hanno Becker12078f42021-03-02 15:28:41 +00004783 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004784 ssl->out_hdr = ssl->out_buf + 8;
4785 ssl->in_hdr = ssl->in_buf + 8;
4786 }
4787
4788 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004789 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4790 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004791}
4792
Paul Bakker5121ce52009-01-03 21:22:43 +00004793/*
4794 * SSL get accessors
4795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004796size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004797{
4798 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4799}
4800
Hanno Becker8b170a02017-10-10 11:51:19 +01004801int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4802{
4803 /*
4804 * Case A: We're currently holding back
4805 * a message for further processing.
4806 */
4807
4808 if( ssl->keep_current_message == 1 )
4809 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004810 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004811 return( 1 );
4812 }
4813
4814 /*
4815 * Case B: Further records are pending in the current datagram.
4816 */
4817
4818#if defined(MBEDTLS_SSL_PROTO_DTLS)
4819 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4820 ssl->in_left > ssl->next_record_offset )
4821 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004822 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004823 return( 1 );
4824 }
4825#endif /* MBEDTLS_SSL_PROTO_DTLS */
4826
4827 /*
4828 * Case C: A handshake message is being processed.
4829 */
4830
Hanno Becker8b170a02017-10-10 11:51:19 +01004831 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4832 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004833 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004834 return( 1 );
4835 }
4836
4837 /*
4838 * Case D: An application data message is being processed
4839 */
4840 if( ssl->in_offt != NULL )
4841 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004842 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004843 return( 1 );
4844 }
4845
4846 /*
4847 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004848 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004849 * we implement support for multiple alerts in single records.
4850 */
4851
4852 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4853 return( 0 );
4854}
4855
Paul Bakker43ca69c2011-01-15 17:35:19 +00004856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004858{
Hanno Becker3136ede2018-08-17 15:28:19 +01004859 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004860 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004861 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004862
Hanno Becker5903de42019-05-03 14:46:38 +01004863 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4864
Hanno Becker78640902018-08-13 16:35:15 +01004865 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004866 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004868 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004869 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004870 case MBEDTLS_MODE_GCM:
4871 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004872 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004874 transform_expansion = transform->minlen;
4875 break;
4876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004877 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004878
4879 block_size = mbedtls_cipher_get_block_size(
4880 &transform->cipher_ctx_enc );
4881
Hanno Becker3136ede2018-08-17 15:28:19 +01004882 /* Expansion due to the addition of the MAC. */
4883 transform_expansion += transform->maclen;
4884
4885 /* Expansion due to the addition of CBC padding;
4886 * Theoretically up to 256 bytes, but we never use
4887 * more than the block size of the underlying cipher. */
4888 transform_expansion += block_size;
4889
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004890 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004891 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004892#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004893 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004894#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004895
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004896 break;
4897
4898 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004899 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004900 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004901 }
4902
Hanno Beckera0e20d02019-05-15 14:03:01 +01004903#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004904 if( transform->out_cid_len != 0 )
4905 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004906#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004907
Hanno Becker5903de42019-05-03 14:46:38 +01004908 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004909}
4910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004912/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004913 * Check record counters and renegotiate if they're above the limit.
4914 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004915static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004916{
Hanno Beckerdd772292020-02-05 10:38:31 +00004917 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004918 int in_ctr_cmp;
4919 int out_ctr_cmp;
4920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004921 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4922 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004923 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004924 {
4925 return( 0 );
4926 }
4927
Andres AG2196c7f2016-12-15 17:01:16 +00004928 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08004929 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08004930 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004931 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
4932 &ssl->conf->renego_period[ep_len],
4933 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00004934
4935 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004936 {
4937 return( 0 );
4938 }
4939
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004941 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004942}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004943#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004944
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004945/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004946 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004947 * may only be sent for the purpose of initiating renegotiations.
4948 *
4949 * This function is introduced as a separate helper since the handling
4950 * of post-handshake handshake messages changes significantly in TLS 1.3,
4951 * and having a helper function allows to distinguish between TLS <= 1.2 and
4952 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
4953 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00004954static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004955{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01004956 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004957
4958 /*
4959 * - For client-side, expect SERVER_HELLO_REQUEST.
4960 * - For server-side, expect CLIENT_HELLO.
4961 * - Fail (TLS) or silently drop record (DTLS) in other cases.
4962 */
4963
4964#if defined(MBEDTLS_SSL_CLI_C)
4965 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4966 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
4967 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
4968 {
4969 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
4970
4971 /* With DTLS, drop the packet (probably from last handshake) */
4972#if defined(MBEDTLS_SSL_PROTO_DTLS)
4973 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4974 {
4975 return( 0 );
4976 }
4977#endif
4978 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4979 }
4980#endif /* MBEDTLS_SSL_CLI_C */
4981
4982#if defined(MBEDTLS_SSL_SRV_C)
4983 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4984 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
4985 {
4986 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
4987
4988 /* With DTLS, drop the packet (probably from last handshake) */
4989#if defined(MBEDTLS_SSL_PROTO_DTLS)
4990 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4991 {
4992 return( 0 );
4993 }
4994#endif
4995 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4996 }
4997#endif /* MBEDTLS_SSL_SRV_C */
4998
4999#if defined(MBEDTLS_SSL_RENEGOTIATION)
5000 /* Determine whether renegotiation attempt should be accepted */
5001 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5002 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5003 ssl->conf->allow_legacy_renegotiation ==
5004 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5005 {
5006 /*
5007 * Accept renegotiation request
5008 */
5009
5010 /* DTLS clients need to know renego is server-initiated */
5011#if defined(MBEDTLS_SSL_PROTO_DTLS)
5012 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5013 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5014 {
5015 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5016 }
5017#endif
5018 ret = mbedtls_ssl_start_renegotiation( ssl );
5019 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5020 ret != 0 )
5021 {
5022 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5023 ret );
5024 return( ret );
5025 }
5026 }
5027 else
5028#endif /* MBEDTLS_SSL_RENEGOTIATION */
5029 {
5030 /*
5031 * Refuse renegotiation
5032 */
5033
5034 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5035
TRodziewicz0f82ec62021-05-12 17:49:18 +02005036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005037 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5038 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5039 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005040 {
TRodziewicz345165c2021-07-06 13:42:11 +02005041 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005042 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005044 }
5045
5046 return( 0 );
5047}
5048
Paul Bakker48916f92012-09-16 19:57:18 +00005049/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005050 * Receive application data decrypted from the SSL layer
5051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005052int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005053{
Janos Follath865b3eb2019-12-16 11:46:15 +00005054 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005055 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005056
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005057 if( ssl == NULL || ssl->conf == NULL )
5058 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005062#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005063 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005064 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005065 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005066 return( ret );
5067
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005068 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005069 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005070 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005071 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005072 return( ret );
5073 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005074 }
5075#endif
5076
Hanno Becker4a810fb2017-05-24 16:27:30 +01005077 /*
5078 * Check if renegotiation is necessary and/or handshake is
5079 * in process. If yes, perform/continue, and fall through
5080 * if an unexpected packet is received while the client
5081 * is waiting for the ServerHello.
5082 *
5083 * (There is no equivalent to the last condition on
5084 * the server-side as it is not treated as within
5085 * a handshake while waiting for the ClientHello
5086 * after a renegotiation request.)
5087 */
5088
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005089#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005090 ret = ssl_check_ctr_renegotiate( ssl );
5091 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5092 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005093 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005094 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005095 return( ret );
5096 }
5097#endif
5098
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005099 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005100 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005101 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005102 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5103 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005104 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005106 return( ret );
5107 }
5108 }
5109
Hanno Beckere41158b2017-10-23 13:30:32 +01005110 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005111 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005112 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005113 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005114 if( ssl->f_get_timer != NULL &&
5115 ssl->f_get_timer( ssl->p_timer ) == -1 )
5116 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005117 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005118 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005119
Hanno Becker327c93b2018-08-15 13:56:18 +01005120 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005121 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005122 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5123 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005124
Hanno Becker4a810fb2017-05-24 16:27:30 +01005125 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5126 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005127 }
5128
5129 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005130 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005131 {
5132 /*
5133 * OpenSSL sends empty messages to randomize the IV
5134 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005135 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005136 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005138 return( 0 );
5139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005140 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005141 return( ret );
5142 }
5143 }
5144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005145 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005146 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005147 ret = ssl_handle_hs_message_post_handshake( ssl );
5148 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005149 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005150 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5151 ret );
5152 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005153 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005154
Hanno Beckerf26cc722021-04-21 07:30:13 +01005155 /* At this point, we don't know whether the renegotiation triggered
5156 * by the post-handshake message has been completed or not. The cases
5157 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005158 * 1) The renegotiation is complete. In this case, no new record
5159 * has been read yet.
5160 * 2) The renegotiation is incomplete because the client received
5161 * an application data record while awaiting the ServerHello.
5162 * 3) The renegotiation is incomplete because the client received
5163 * a non-handshake, non-application data message while awaiting
5164 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005165 *
5166 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005167 * - For 1), the next iteration will read a new record and check
5168 * if it's application data.
5169 * - For 2), the loop condition isn't satisfied as application data
5170 * is present, hence continue is the same as break
5171 * - For 3), the loop condition is satisfied and read_record
5172 * will re-deliver the message that was held back by the client
5173 * when expecting the ServerHello.
5174 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005175
Hanno Becker90333da2017-10-10 11:27:13 +01005176 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005177 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005178#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005179 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005180 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005181 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005182 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005183 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005184 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005185 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005186 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005187 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005188 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005189 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005190 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005191#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005193 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5194 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005195 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005196 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005197 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005198 }
5199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005200 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005201 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005202 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5203 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005204 }
5205
5206 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005207
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005208 /* We're going to return something now, cancel timer,
5209 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005210 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005211 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005212
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005213#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005214 /* If we requested renego but received AppData, resend HelloRequest.
5215 * Do it now, after setting in_offt, to avoid taking this branch
5216 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005217#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005218 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005219 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005220 {
Hanno Becker786300f2020-02-05 10:46:40 +00005221 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005222 {
Hanno Becker786300f2020-02-05 10:46:40 +00005223 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5224 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005225 return( ret );
5226 }
5227 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005228#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005229#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005230 }
5231
5232 n = ( len < ssl->in_msglen )
5233 ? len : ssl->in_msglen;
5234
5235 memcpy( buf, ssl->in_offt, n );
5236 ssl->in_msglen -= n;
5237
gabor-mezei-arma3214132020-07-15 10:55:00 +02005238 /* Zeroising the plaintext buffer to erase unused application data
5239 from the memory. */
5240 mbedtls_platform_zeroize( ssl->in_offt, n );
5241
Paul Bakker5121ce52009-01-03 21:22:43 +00005242 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005243 {
5244 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005245 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005246 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005247 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005248 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005249 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005250 /* more data available */
5251 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005252 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005254 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005255
Paul Bakker23986e52011-04-24 08:57:21 +00005256 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005257}
5258
5259/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005260 * Send application data to be encrypted by the SSL layer, taking care of max
5261 * fragment length and buffer size.
5262 *
5263 * According to RFC 5246 Section 6.2.1:
5264 *
5265 * Zero-length fragments of Application data MAY be sent as they are
5266 * potentially useful as a traffic analysis countermeasure.
5267 *
5268 * Therefore, it is possible that the input message length is 0 and the
5269 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005270 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005271static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005272 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005273{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005274 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5275 const size_t max_len = (size_t) ret;
5276
5277 if( ret < 0 )
5278 {
5279 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5280 return( ret );
5281 }
5282
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005283 if( len > max_len )
5284 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005285#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005286 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005287 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005288 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005289 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5290 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005291 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005292 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005293 }
5294 else
5295#endif
5296 len = max_len;
5297 }
Paul Bakker887bd502011-06-08 13:10:54 +00005298
Paul Bakker5121ce52009-01-03 21:22:43 +00005299 if( ssl->out_left != 0 )
5300 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005301 /*
5302 * The user has previously tried to send the data and
5303 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5304 * written. In this case, we expect the high-level write function
5305 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005307 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005308 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005309 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005310 return( ret );
5311 }
5312 }
Paul Bakker887bd502011-06-08 13:10:54 +00005313 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005314 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005315 /*
5316 * The user is trying to send a message the first time, so we need to
5317 * copy the data into the internal buffers and setup the data structure
5318 * to keep track of partial writes
5319 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005320 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005321 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005322 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005323
Hanno Becker67bc7c32018-08-06 11:33:50 +01005324 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005325 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005326 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005327 return( ret );
5328 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005329 }
5330
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005331 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005332}
5333
5334/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005335 * Write application data (public-facing wrapper)
5336 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005337int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005338{
Janos Follath865b3eb2019-12-16 11:46:15 +00005339 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005340
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005341 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005342
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005343 if( ssl == NULL || ssl->conf == NULL )
5344 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5345
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005346#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005347 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5348 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005349 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005350 return( ret );
5351 }
5352#endif
5353
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005354 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005355 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005356 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005357 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005358 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005359 return( ret );
5360 }
5361 }
5362
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005363 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005364
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005365 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005366
5367 return( ret );
5368}
5369
5370/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005371 * Notify the peer that the connection is being closed
5372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005373int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005374{
Janos Follath865b3eb2019-12-16 11:46:15 +00005375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005376
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005377 if( ssl == NULL || ssl->conf == NULL )
5378 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005380 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005381
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005382 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005385 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005386 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005387 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5388 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5389 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005390 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005392 return( ret );
5393 }
5394 }
5395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005396 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005397
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005398 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005399}
5400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005401void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005402{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005403 if( transform == NULL )
5404 return;
5405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005406 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5407 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005408
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005409#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 mbedtls_md_free( &transform->md_ctx_enc );
5411 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005412#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005413
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005414 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005415}
5416
Jerry Yuc7875b52021-09-05 21:05:50 +08005417void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5418 mbedtls_ssl_transform *transform )
5419{
Jerry Yuc7875b52021-09-05 21:05:50 +08005420 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005421 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005422}
5423
5424void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5425 mbedtls_ssl_transform *transform )
5426{
5427 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005428 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005429}
5430
Hanno Becker0271f962018-08-16 13:23:47 +01005431#if defined(MBEDTLS_SSL_PROTO_DTLS)
5432
Hanno Becker533ab5f2020-02-05 10:49:13 +00005433void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005434{
5435 unsigned offset;
5436 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5437
5438 if( hs == NULL )
5439 return;
5440
Hanno Becker283f5ef2018-08-24 09:34:47 +01005441 ssl_free_buffered_record( ssl );
5442
Hanno Becker0271f962018-08-16 13:23:47 +01005443 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005444 ssl_buffering_free_slot( ssl, offset );
5445}
5446
5447static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5448 uint8_t slot )
5449{
5450 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5451 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005452
5453 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5454 return;
5455
Hanno Beckere605b192018-08-21 15:59:07 +01005456 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005457 {
Hanno Beckere605b192018-08-21 15:59:07 +01005458 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005459 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005460 mbedtls_free( hs_buf->data );
5461 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005462 }
5463}
5464
5465#endif /* MBEDTLS_SSL_PROTO_DTLS */
5466
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005467/*
5468 * Convert version numbers to/from wire format
5469 * and, for DTLS, to/from TLS equivalent.
5470 *
5471 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005472 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005473 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005476 unsigned char ver[2] )
5477{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005478#if defined(MBEDTLS_SSL_PROTO_DTLS)
5479 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005480 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005482 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5483
5484 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5485 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5486 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005487 else
5488#else
5489 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005490#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005491 {
5492 ver[0] = (unsigned char) major;
5493 ver[1] = (unsigned char) minor;
5494 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005495}
5496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005498 const unsigned char ver[2] )
5499{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500#if defined(MBEDTLS_SSL_PROTO_DTLS)
5501 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005502 {
5503 *major = 255 - ver[0] + 2;
5504 *minor = 255 - ver[1] + 1;
5505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005507 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5508 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005509 else
5510#else
5511 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005512#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005513 {
5514 *major = ver[0];
5515 *minor = ver[1];
5516 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005517}
5518
Jerry Yue7047812021-09-13 19:26:39 +08005519/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005520 * Send pending fatal alert.
5521 * 0, No alert message.
5522 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5523 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005524 */
5525int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5526{
5527 int ret;
5528
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005529 /* No pending alert, return success*/
5530 if( ssl->send_alert == 0 )
5531 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005532
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005533 ret = mbedtls_ssl_send_alert_message( ssl,
5534 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5535 ssl->alert_type );
5536
Jerry Yu3bf1f972021-09-22 21:37:18 +08005537 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5538 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005539 */
5540 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5541 {
5542 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005543 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005544
5545 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005546 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005547
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005548 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005549}
5550
Jerry Yu394ece62021-09-14 22:17:21 +08005551/*
5552 * Set pending fatal alert flag.
5553 */
5554void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5555 unsigned char alert_type,
5556 int alert_reason )
5557{
5558 ssl->send_alert = 1;
5559 ssl->alert_type = alert_type;
5560 ssl->alert_reason = alert_reason;
5561}
5562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005563#endif /* MBEDTLS_SSL_TLS_C */